SDKConsole utility parameters
Common parameters
name
Name of your app.
web_resources_path
Path to the directory that contains the resources used in the app, i.e., the logo and background image on the login page.
tasks
Actions the utility executes. This is a string array where you can specify a combination of tasks.
Available values
prepare | Prepares and rebrands of your Android/iOS project. This step makes all the necessary changes. You will get a finished project you can publish in App Store and Google Play. |
build | Builds the project. You will get an assembled *.ipa iOS app file and/or *.apk Android app file. |
deploy | Publishes the app to TestFlight. iOS only. |
use_extended_logging
Displays detailed logs in the terminal when the utility is running. The recommended value is "true." If set to "false," the terminal displays only the currently executed step without details.
server_url
Default server. The server URL will be automatically specified on the login page when you log in to the app for the first time.
repository_path
Path to the GitLab repository that hosts the original Android/iOS project.
source_path
Path to the local Windows/Mac directory where the original Android/iOS project is located. If you specify this parameter the utility uses it in place of the repository_path parameter.
google_service_info_file
Path to the "GoogleService-Info.plist" (iOS) or "google-services.json" (Android) file downloaded from the Firebase project. Required to connect to the Firebase push notification service.
version_number
App version in the following format: "0.0.1."
build_number
Build number (string). Always update the build number before performing the "deploy" task.
launch_storyboard_image_path
Path to the image displayed when the app starts (2732x2732 px). iOS only.
app_identifier
A unique app ID, for example, "com.myapp.mobile." This is the Bundle ID specified when you registered the app in App Store Connect. iOS only.
app_icon_path
Path to the app icon (1024x1024 px). This is a master image the utility uses to generate the required icons for current iOS devices. iOS only.
app_store_login
Account (Apple ID) required to connect to App Store Connect/TestFlight. iOS only.
certificate_path
Path to the distribution certificate required when publishing to TestFlight. iOS only.
certificate_password
Certificate password. To restore the password, contact the certificate author. iOS only.
apple_2FA_specific_password
App-specific password. iOS only.
Currently, all Apple accounts support two-factor authentication. To enable third-party services to connect to Apple services, get the app-specific password. To do this:
- Open the Apple ID page while signed in to your Apple account.
- Open the Security section → Generate password... command.
- Follow the instructions to get a new password generated.
testflight_changelog
Description of the changes published to TestFlight (what's new). The description is published for the primary app language set in App Store Connect. iOS only.
app_provision_name
Distribution provisioning name to sign the Creatio app target.
callerid_app_provision_name
Distribution provisioning name to sign the CallerId target in the Creatio project.
build_type
Build type. Android only.
The build_type parameter determines the format of the generated Android package and how it can be distributed. The available build outputs and distribution specifics are as follows:
- APK (*.apk) — standard Android installation package that can be installed directly on a device.
- AAB (*.aab) — Android App Bundle required by Google Play. Google Play generates optimized APK files for each device configuration.
- Unsigned APK (*.apk) — cannot be installed or published until it is signed with a valid certificate.
- Intune build (*.apk) — typically produces an APK file that is wrapped or integrated with Microsoft Intune.
Available values
debug | Build for development and debugging. Signed with a debug key. Typical file extension: *.apk. |
release | Production release build signed with a release key. Typical file extension: *.apk. |
bundleRelease | Release build for the Google Play platform (Android App Bundle). Typical file extension: *.aab. |
release-unsigned | Release build without signing. Cannot be installed or published until signed. Typical file extension: *.apk. |
intuneRelease | Release build for Microsoft Intune integration. Typically used with the Intune App SDK or the Intune App Wrapping Tool. Typical file extension: *.apk. |
package_name
A unique app ID, for example, "com.myapp.mobile." Android only.
native_resources_path
Path to app resources, such as the app icon and startup image. Learn more: official vendor documentation.
Structure the contents of this directory similarly to the "res" directory in an Android project. The directory can contain subdirectories for drawable, drawable-xhdpi, and other icons. Android only.
key_file
Path to the key file (keystore) required to sign the app. Learn more: official vendor documentation. Android only.
store_password
Password for the keystore required to sign the app. Android only.
key_alias
The key alias. Android only.
key_password
The password of the alias from the key_alias parameter in the keystore. Android only.
Microsoft Intune parameters
intune_config
Configuration for building wrapped or integrated Intune app. The list of parameters is based on the mobile OS.
Available values (Android only)
app_wrapping_tool_script_path | Path to the directory that includes the Intune App Wrapping Tool. |
build_tools_path | Path to the Android build tools usually installed with Android Studio. Learn more: Launch the mobile app emulator created in Android Studio. |
Available values (iOS only)
intune_mam_packager_path | Path to the Intune wrapping tool. |
intune_app_provision_file_path | Path to the distribution provisioning file. |
intune_callerid_app_provision_file_path | Path to the |
intune_sha1 | SHA1 fingerprint of the Apple/iOS Distribution certificate. Instructions: official macOS and Windows vendor documentation. |