Modules
...
Getting Started
App Builder (Android)
11 min
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 help\@signzy com