App Builder (Android)

11min
Prerequisites
(Jenkins Trigger) Must have access to Jenkins Server for triggering build
This is optional if a user is building apk via admin panel integration
Must have minimum required data to provide input for the build generation
This is only for Android apk
Basic Details
Requestor: Requestor's name(the person who is requesting the APK for the app) is required
Email: Provide the email address(es) where the APK will be sent—separate multiple addresses with commas.
Tag: Enter the Build tag for which the app is to be generated (tag is case sensitive; eg: V-4.062.000)
Realm: Enter the name of the realm used in the app build. (case sensitive)
Namespace: Enter the name of the Namespace linked in the app build. (case sensitive)
Description: Enter the purpose for which this app build is being used.
GO Url: Enter the Endpoint URL for the GO-backend that will be used in the app for GO journey-related communications. Note: End the URL with (eg: https://go-preproduction.signzy.app/)
RM Url: Enter the Endpoint URL for the RM-backend that will be used in the app for GO journey-related communications. Note: End the URL with ‘/’ (eg: https://rm-admin-preproduction.signzy.app/api/)
Persist Url: Enter the Endpoint URL for Persist-Helper that will be used in the app for GO journey-related communications. Note: End the URL with ‘/’ (eg: https://go-preproduction.signzy.app/api/)
﻿
Customisation(Optional)
App Name: Name of the application displayed on the Home screen when installed.
Package Name: A unique identifier string used by the Android system to install the package & future updates. Example: com.signzy.generic_onboarding. [Ideally, the realm name is added at the end of the package name, eg, com.signzy.generic_onboarding.{realm name}, but in case it does not work 'qa' can be entered instead of the realm name, eg, com.signzy.generic_onboarding.qa]
App Logo: The image that will be displayed as the app's logo/icon is uploaded here. Dimensions: 512 x 512 or 1024 x 1024, or bigger with the same aspect ratio can be uploaded.
Splash Screen Image: The image that will be displayed on the splash screen is uploaded here. Dimensions: 640 x 960, or bigger with the same aspect ratio can be uploaded.
﻿
Note: Most of the app build configuration is satisfied from the 'Basic Details' and 'Customisation' section only, no additional data is required for a functioning app. 
App Settings(Optional)
Persists Authenticated: Enable/Disable Persist-Authentication for the app
RM Assisted: Enable/Disable RM-Assistance for the app, if disabled
the app build is considered a DIY app
Screenshot Prevention: Enable/Disable screenshot capturing when the app is open on the screen
SSL Pinning: Enable/Disable the SSL-Pinning. 
Skip Root Check: Skip/Enforce root check in the app
Note: 'Persist Authenticated' and 'RM Assisted' toggles are enabled by default.
﻿
SSO Configuration(Optional)
TenantID: SSO/ADFS configuration's TenantID value. Type: Hexadecimal string.
Client Id: SSO/ADFS configuration's ClientID value. Type: Hexadecimal string.
Client Secret: SSO/ADFS configuration's ClientSecret value. Type: Hexadecimal string.
Redirect URL: SSO/ADFS configuration's Redirect URL value. Type: A URL string.
Type: SSO/ADFS configuration's type value. Type: string.
Scope: SSO/ADFS configuration's Scope. Type: string.
Note: Keep these fields if not known
﻿
Advanced Options(Optional)
Proxy IP: Proxy IP to route all network activity to the provided ip, only for info-sec purposes (do not use this field for production builds).
Proxy Port: Proxy Port to route all network activity to the provided port, only for info-sec purposes (do not use this field for production builds).
Project Id: Firebase project ID used to configure the app's various Firebase-related services. If not provided default Signzy project will be used.
Firebase Session Token: The Firebase Session token is used to authenticate the configuration call from Firebase tools for this app. If not provided the build might fail if Firebase deems the configuration request as an expired session. Providing this token is only required if the Firebase project is created by a person not part of the signzy.com GCP organization.
App Version: The app version number. Only use this if there's a specific requirement to change the app version but not the source code.
App Version: App version code/build number. Only use this if there's a specific requirement to change the app version but not the source code.
﻿
Signing Options(Optional)
Key Store File: A keystore file contains one or more pairs of private keys and a signed certificate for its corresponding public key. The keystore should be strongly protected with a password, and stored (either on the file system or elsewhere) so that it is accessible only to administrators. Here the Keystore will be used for signing the build of the app.
Key Properties File: keystore.properties file is used to build a release APK, and change your build variants to debug mode. If the keystore is uploaded then key properties are also mandatory.
﻿
﻿
Execute Build
Go to the Jenkins dashboard and open this Project:
GO-Mobile-Android-Build Under Mobile section
Direct Link: https://jenkins.signzy.tech/view/mobile/job/GO-Mobile-Android-Build/
Select Build with Parameters Option
Fill the app data as required for the build you want
Click the 'Build' button at the bottom to start the build process
You can wait and check the logs on the Jenkins build console or close the window
Once the process is completed, The final build details will be sent to the email
Email will contain
a build detail summary
a link to a zip file that contains the apk and the build report
In case of failure, the email should contain:
a log file attached containing the Jenkins build logs
Getting help
Please feel free to contact us if you have any questions, require clarification, or have ideas for how to make the documents or any of our services better.

You can reach out to us at [email protected].
﻿
Updated 11 Oct 2024
Did this page help you?
Onboarding Labels
Untitled