Skip to content

Project Settings in Volt MX Iris

Note: Volt MX 9.2 does not support the building of Windows native applications. Please disregard all references to Windows in this topic.

The project settings in Volt MX Iris are categorized into the following broad sections:

Application Settings

Application properties are specific to the application. Using application settings, you can configure details about the Application ID, Version, Company name; set Accessibility configuration, Internationalization; configure Cordova settings, App preview security, and Map widget key fields.

Click to view the image

The following table describes all the fields in Application settings.

Section NameField NameDescription
General SettingsIDName of the application. It is auto populated.
VersionA number that represents version of the application. It is auto-populated.
Company NameName of the company is auto-populated.
Accessibility ConfigEnables assistive technologies such as TalkBack and VoiceOver. It assists visually-impaired users to navigate through various UI controls.
Enable Server Events APIs 
CordovaEnable Cordova SettingsConfigures the settings related to Cordova version.
VersionSets the Cordova version.
Use globally installed Cordova versionEnables the globally-installed Cordova version.
Internationalization (i18n)EnableSets various locales to the Iris project.
Enable i18n Layout ConfigConfigures layout properties.
Default LocaleSets a default locale to the Iris project.
App Preview SecurityUser Defined PasswordEnhances app preview security. While performing a cloud publish, you can set a password. To preview the app, you must enter the same password.
Show PasswordUnmasks the password.
Map WidgetStatic Map Widget KeyMap key enables application to display Google maps through the map widgets within the applications. Generate and enter the Static Map Widget key. For more information on generating Map API keys, refer Generating and Configuring Map API keys.
Android Map Widget KeyFor the applications using Version 1 of Google Maps API, enter the generated Android Map Widget key.
Android Map Widget Key 2For the applications using version 2 of Google Maps API, enter the generated Android Map Widget key.
Bing Map Widget KeyEnter Bing Map Widget key.

Volt MX Foundry Settings

Using Volt MX Foundry settings, you can configure the Cloud Account, Environment details, Runtime App version, and the Enterprise App Store settings.

Click to view the image

The following table describes all the fields in Volt MX Foundry settings.

Section NameField NameDescription
Volt MX Foundry DetailsCloud AccountConfigures a cloud account.
EnvironmentConfigures an environment in the selected cloud.
Runtime App VersionSelect the version of the Foundry app for which the service document must be fetched and bundled during the build process (runtime). Default: The app version that you set as the default app version on Volt MX Foundry. This option is selected, by default. Linked: The Volt MX Foundry app version that you associate with your project. If you have the 1.0 version of the app linked, but select the 2.0 version as the Runtime App Version, the service document of the 2.0 version of the app is bundled during the build process.
My App Store DetailsAutomatically check for App UpgradesEnable this setting to check whether an app upgrade is available on the Enterprise App Store when the app is launched. Based on the policy configured on the EAS, users are prompted to update the app. For more information on how to enable Version Check for Apps on EAS, refer Upgrade Mechanism for App Versions on Enterprise App Store. Note: You must configure the Upgrade Policy for all the versions of the app.

Native Settings

Native app properties are divided into two categories: those that are common to all platforms and those that are platform-specific. These properties include: the logo image that your app displays, the types of screens and SDKs that the app supports, and how certificates are handled.

The following platforms are categorised based on their platform-specific properties:

  • iPhone / iPad
  • Watch
  • Android Mobile / Tablet
  • Android Wear
  • Windows

General Settings

General Settings contain properties that are common to all platforms. Using General Settings, you can configure Application name, logo, Test automation as well as set offline object for Windows 10 mobile, tablet, and Windows Desktop.

Click to view the image

The following table describes all the fields in General settings.

Section NameField NameDescription
GeneralNameName of the Native channel version of the application. If no name is specified, the name specified under Application Properties is used.
Application LogoSets an image as the application logo.
Test AutomationExpose widget IDsExposes the widget IDs.
Windows 10 (Mobile & Tablet), Windows Desktop (Kiosk)Enable Offline ObjectsConfigures Offline objects for Windows 10 Mobile and Tablet, Windows Desktop (kiosk).

iPhone/ iPad

Using iPhone/ iPad settings, you can configure iOS Build Settings, Certificates; set Deep link URL Scheme; configure Target Versions, iPad Settings, and App Icons.

Click to view the image

The following table describes about all the fields in iPhone/ iPad settings.

Section NameField NameDescription
iOS Build SettingsBundle IdentifierA Unique name that identifies the application bundle. It usually consists of three parts and follows the convention of com.voltmx.<appname>
Bundle VersionA number that identifies the version of the application bundle.
Glossy Effect keySpecifies if the glossy effect must be applied to the app icon. The default value is false.
Load indicator keyConfigures the load indicator in an application.
Hide status barHides the status bar in an application.
Protected ModeEnsures that your app is not run on a rooted/jail-broken device. Note: Note: This option works only if the application is built in Release mode.
CertificatesDevelopment MethodRefer the article to know about Development Method.
Mobile ProvisionRefer the article to know about Mobile Provision.
.P12Refer the article to know about .P12
P12 PasswordRefer to the article to know about P12 Password.
Deeplink URL SchemeURL SchemeSpecifies a URL to which the application will deep-link to. For more information about deep-linking, Appendix E: the App Service Event.
Target VersionsiOS VersionConfigures your iOS version.
iPad SettingsApplication Launch ModeSpecifies the default mode of launching the application on iPad. Portrait is the default value.
Supported OrientationsSpecifies the supported orientations for the iPad. This depends on the launch mode.
App IconsApp Store 1x (iOS 1024 pt)Each app in the App store can have an icon. Provide the image that you want displayed next to your app in the App Store. The default size of the icon should be 1024 pt.
Notification iOS 7-11 20pt (iPhone and iPad)Apps that support notifications should provide a small icon to display in notifications. Provide an image that you want displayed in notifications for iOS 7-11.
Spot Light-Ios 5,6 Settings-iOS 5-11 29 Pt (iPhone)Every app should provide a small icon that iOS can display when the app name matches the name in a Spotlight search. Provide an image that you want displayed during spotlight search for iPhone 5,6.
Spot Light-Ios 7-11 40 Pt (iPhone and iPad)Provide an image that you want to display during spotlight search for iOS 7-11.
App-iOS 7-11 60 Pt (iPhone)Provide an image that represents your app for iOS 7-11.
Settings-Ios 5-11 29 PtApps with settings should provide a small icon to display in the built-in Settings app. Provide an image to display your app for iOS 5-11.
App-iOS 7-11 76 PtProvide an image that represents your app for iOS 7-11.
Platform SettingsGeneric exception alertWhen enabled, generic exception alerts like "system error" are fired and when disabled, detailed exception messages appear as alerts. The best practice is to keep the setting enabled for the release mode and disabled for the debug mode.
Exception alertWhen enabled, the system displays an exception alert. When disabled, the app crashes without displaying any exception or alert. The best practice to follow is to enable the feature for both release and debug modes.
Paste Board TypeIt will allow the user to copy paste content from the app to external writable area like message etc. system level - it will allow to copy paste into other applications. Applevelpersistent - it will allow to copy paste within the app and the messages are persistent will be available across the app restarts. Applevelnonpersistent - it will allow to copy paste within the app and the messages are Not persistent and will not be available across the app restarts. Nopasteboard - it will not allow paste anywhere.
Allow Self Signed CertificateBy default it is false, if true, it allows self signed certificate for development. Note: Self Signed Certificate option is only applicable if you use Network APIs in your application.
Input Accessory View TypeThe input accessory view type for widgets like text box, calendar, grouped widgets etc where you have next previous cancel buttons. This can be overridden by form level Input Accessory View Type.
Anti Aliased DrawingIf enabled, allows smoother widgets and layout without any jagged edges.
Backward_compatibility_modeIt is disabled, by default, If enabled, it will allow the application feature to behave as it would have behaved on earlier version (if there is any behavioral change in the latest version)
extendTopLets you extend the top
extendBottomLets you extend the bottom
statusBarHiddenLets you show or hide the status bar.
statusBarStyleLets you set a style for the status bar.
backgroundmodesAllows you to choose the backgroud mode.
Camera Cancel IconAllows to set images to the icons which appear on the camera cancel icon, tap anywhere.
Camera Settings IconAllows to set images to the icons which appear on the camera settings icon, tap anywhere.

For information on more configurations, refer Native App Properties for iPhone.

Watch

Using Watch settings, you can configure Target Versions, App Icons, and Notification icons for 38mm and 42 mm Apple Watches.

Click to view the image

The following table describes all the fields in Watch settings.

Section Name Field Name Description
Target Versions Watch OS Version Configures the OS version number.
^^ Swift Version Swift version number that the app is compatible with.
App Icons Apple Watch App Store 1x 1024 pt Each app in the Apple watch App store can have an icon. Provide the image that you want displayed next to your app in the App Store.
^^ Home Screen (All) (40 x 40) Provide an image that represents your app on home screen.
^^ Companion Settings 2x Configures companion app settings 2x.
^^ Companion Settings 3x Configures companion app settings 3x.
Watch 38 mm Notification Centre Icon Apps that support notifications should provide a small icon to display in notifications for smart watches. Provide an image that you want displayed in notifications for watch 38 mm.
^^ Short- Look Notification Icon Short-Look icon appears briefly, giving the wearer just enough time to scan a notification. Provide an image for the app icon in short look notifications for watch 38 mm.
Watch 40 mm and 42 mm Notification Center Icon Provide an image for app icon to display notifications in the center.
^^ Long-Look Notification Icon Long-Look notifications display more information on screen from an app, such as message text and action buttons. Provide an image for app icon in long look notifications for 42 mm watch.
^^ Short-Look Notification Icon Short-Look icon appears briefly, giving the wearer just enough time to scan a notification. Provide an image for app icon in short look notification for 42 mm watch.
Watch 44mm Short-Look Notification Icon Short-Look icon appears briefly, giving the wearer just enough time to scan a notification. Provide an image for app icon in short look notification for 42 mm watch.

Android Mobile/ Tablet

Using Android Mobile/ Tablet Settings you can configure General Settings, SDK versions, and Android signing.

Click to view the image

The following settings describe all the fields in Android Mobile/ Tablet settings.

Section NameField NameDescription
General SettingsPackage NamePackage Name is the name used to search for an application in Google Play.Google Play is an online software store developed by Google for Android mobile devices. A software program called Market is pre-installed on most Android mobile devices. This software allows the users to browse and download third-party applications.Note: The name you specify for Android Package must contain at least two segments.A segment is a valid Java package name. The following are a few examples of valid Android Package names:com.hcl.<ApplicationName>com.voltmx.<ApplicationName>_Android
Version CodeAn internal version number, which is used to determine whether the application is a recent version. This version number is not shown to users. The value must be an integer. You can increase each version by one to indicate a newer version.
SDK VersionsMinimum SDKSelect the Minimum SDK Version that needs to be supported for the application.Note: The application must be built with a minimum version matching the device SDK version. For example, a device with 5.0 version of SDK cannot run an application built on 4.0.  
Target SDKSelect the Target SDK Version that needs to be supported for the application.Note: The Target SDK Version must be greater than or equal to the Minimum SDK Version.
Maximum SDKSelect the Maximum SDK Version that needs to be supported for the application.
Android SigningKey AliasUsed to sign the android binary automatically during the build process. Enter the alias of the key.
Key PasswordEnter the password for the key.
Store PasswordEnter the password for the store.
Store FileLocate and configure the store file.
SSOEnable SSOSelect this option to enable the Single-Sign-On option for your app.
Support for Margin in PixelsTrueSupports margin in Pixels.
FalseDisables the support for margin in pixels.
Android Architectures SupportSupport x86 Devices (Will increase app binary size)Select this option to support any Android-x86 devices. Enabling this option increases the size of the binary that is generated.
Support 32-bit DevicesSelect this option to build an Android APK with 32-bit support.
Supported ScreensAny DensityIf this option is enabled, the application can accommodate any screen density for a resource.
Small ScreensIf this option is enabled, the application supports smaller screen form-factors.
Normal ScreensIf this option is enabled, the application supports normal screen form-factors.
Large ScreensIf this option is enabled, the application supports larger screen form-factors.
Extra Large ScreensIf this option is enabled, the application supports extra large screen form-factors.
ResizableIf this option is enabled, the application is resizable for different screen sizes.
Install LocationUse Location PreferenceThis property defines the location where the application is deployed.
MiscellaneousEnable Local NotificationsSelect this option to enable notifications scheduled by an app and delivered on the same device.
Enable Payment APISelecting this option enables online transactions in applications.
Use Google Play Location ServicesSelect this option to enable location service based on the Google Play Location Service API.
Support SQL DB Encryption (FIPS)If you select this option, Volt MX Iris automatically bundles Federal Information Processing Standard (FIPS) compliant SQL Cipher third-party library with the application that is used in SQL DB encryption.
Bundle OpenSSL LibraryIf you select Bundle OpenSSL Library option, Volt MX Iris automatically bundles a third-party OpenSSL native library along with the application that supports additional hashing algorithms that are not supported by the native Android PBKDF2 and HMAC cryptography APIs.
Disable Application ScreenshotThis option specifies whether the user can take a screenshot of your application.
Enable File UploadAdds the Apache HTTP Library that supports the upload of files to a remote sever by using the HttpRequest API.
ActionBarEnabled only if target SDK is 3.0 or above. Use this option to enable Action Bar feature.
Network Trust ConfigUsing this option, you can control the certificates that are used by your app for secure network communication.For information on more configurations, refer Network Trust Config for Android.
Splash Screen Orientation ModeSet the orientation mode of the Splash Screen.
Communication APIsUse Watch Communication APIsEnables communication between the mobile/tablet and a watch.
Add Watch Background Listener To Receive Data PayloadEnables DataItem reception form the watch when the app is in the background.
Add Watch Background Listener To Receive Message PayloadEnables message payload reception form the watch when the app is in the background.
Push NotificationGCM/FCMSelect this option to enable Push Notifications for the application. This option copies the libraries required for push notification into the project during build time.
Manifest Permissions, Tags and Gradle Build EntriesPermissionsSets the permissions to true or false based on the application requirements. Set the appropriate permissions for Android Manifest file. For more information, refer The Android Manifest File.To enable permissions, select the permissions from the left pane and click Add >. To disable permissions, select the permissions from the right pane and click < Remove.
TagsAdds tags to the Android manifest file directly from Volt MX Iris by specifying tag entries and attributes on the Tags tab. You can specify child tag entries and attributes for <manifest> and <application> tags and the Main Launcher <activity> tag. For more information on the tags you can add with the manifest or application tags, refer http://developer.android.com/guide/topics/manifest/manifest-intro.html.
Gradle EntriesImports additional gradle packages, applies external plugins, or specifies build-related configuration information, build dependencies, or the location of any external repositories or modules used by your Android application. For information on more configurations, refer Android Gradle entries.

For information on more configurations, refer Native App Properties for Android.

Android Wear

Using Android Wear Settings you can configure General Settings, SDK versions, and Android signing.

Click to view the image

The following settings describe all the fields in Android Wear settings.

Section NameField NameDescription
General SettingsPackage NamePackage Name is the name used to search for an application in Google Play.Google Play is an online software store developed by Google for Android mobile devices. A software program called Market is pre-installed on most Android mobile devices. This software allows the users to browse and download third-party applications.Note: The name you specify for Android Package must contain at least two segments.A segment is a valid Java package name. The following are a few examples of valid Android Package names:com.hcl.<ApplicationName>com.voltmx.<ApplicationName>_Android
Version CodeAn internal version number, which is used to determine whether the application is a recent version. This version number is not shown to users. The value must be an integer. You can increase each version by one to indicate a newer version.
SDK VersionsMinimum SDKSelect the Minimum SDK Version that needs to be supported for the application. Note: The application must be built with a minimum version matching the device SDK version. For example, a device with 5.0 version of SDK cannot run an application built on 4.0.  
Target SDKSelect the Target SDK Version that needs to be supported for the application.Note: The Target SDK Version must be greater than or equal to the Minimum SDK Version.
Maximum SDKSelect the Maximum SDK Version that needs to be supported for the application. The maximum SDK value is 9.
Android SigningKey AliasUsed to sign the android binary automatically during the build process. Enter the alias of the key.
Key PasswordEnter the password for the key.
Store PasswordEnter the password for the store.
Store FileLocate and configure the store file.
Android Wear Architectures SupportSupport x86 Devices (Will increase app binary size)Select this option to support any Android-x86 devices. Enabling this option increases the size of the binary that is generated.
Support 32-bit DevicesSelect this option to build an Android APK with 32-bit support.
Communication APIsUse Watch Communication APIsEnables communication between the mobile/tablet and a watch.
Add Watch Background Listener To Receive Data PayloadEnables DataItem reception form the mobile/tablet device when the app is in the background.
Add Watch Background Listener To Receive Message PayloadEnables message payload reception form the mobile/tablet device when the app is in the background.
Push NotificationGCM/FCMSelect this option to enable Push Notifications for the application. This option copies the libraries required for push notification into the project during build time.
MiscellaneousEnable Local NotificationsSelect this option to enable notifications scheduled by an app and delivered on the same device.
Use Google Play Location ServicesSelect this option to enable location service based on the Google Play Location Service API.
Support SQL DB Encryption (FIPS)If you select this option, Volt MX Iris automatically bundles Federal Information Processing Standard (FIPS) compliant SQL Cipher third-party library with the application that is used in SQL DB encryption.
Bundle OpenSSL LibraryIf you select Bundle OpenSSL Library option, Volt MX Iris automatically bundles a third-party OpenSSL native library along with the application that supports additional hashing algorithms that are not supported by the native Android PBKDF2 and HMAC cryptography APIs.
Disable Application ScreenshotThis option specifies whether the user can take a screenshot of your application.
Enable File UploadAdds the Apache HTTP Library that supports the upload of files to a remote sever by using the HttpRequest API.
Network Trust ConfigUsing this option, you can control the certificates that are used by your app for secure network communication.For information on more configurations, refer Network Trust Config for Android.
Manifest Permissions, Tags and Gradle Build EntriesPermissionsSets the permissions to true or false based on the application requirements. Set the appropriate permissions for Android Manifest file. For more information, refer The Android Manifest File.To enable permissions, select the permissions from the left pane and click Add >. To disable permissions, select the permissions from the right pane and click < Remove.
TagsAdds tags to the Android manifest file directly from Volt MX Iris by specifying tag entries and attributes on the Tags tab. You can specify child tag entries and attributes for <manifest> and <application> tags and the Main Launcher <activity> tag. For more information on the tags you can add with the manifest or application tags, refer http://developer.android.com/guide/topics/manifest/manifest-intro.html.
Gradle EntriesImports additional gradle packages, applies external plugins, or specifies build-related configuration information, build dependencies, or the location of any external repositories or modules used by your Android application. For information on more configurations, refer Android Gradle entries.

For information on more configurations, refer Native App Properties for Android.

Windows

Using Windows Settings, you can configure General Application UI Settings and Capabilities for a Windows app.

Click to view the image

The following table describes all the fields in Windows Phone Settings.

Section NameField NameField Name
Application UIPWA URLIf you want to generate a windows native application from a PWA app, specify the URL of the published Progressive Web App.
Display nameSpecifies the display name of the application visible in the applications list.
DescriptionSpecifies the description to be displayed on the tile i.e in the Set Default Programs UI. For example a tile on finance can contain a generic description about stocks.
Package nameA unique name to identify a specific application. It is generally in the format domain.company.application
Package display nameThe name with which the application is submitted to the Microsoft Store. This name is used to search the application in the Microsoft Store.
Publisher nameThe publisher of the app. This name specifies the Subject field of the Signing certificate that is used to authenticate the package. The default value is the name of the project. This attribute is required for certain types of apps, such as push-enabled apps.
Publisher display nameSpecifies the name that is displayed on the Publisher Name field on the Developer Website.
VersionInternal version number of the package.
Windows signing certificateIf you have a certificate to publish an app to the Microsoft store, you can upload the certificate in this field.
Capabilities Set the permissions to true or false based on the application's requirements. For more information about each of the permissions refer Capabilities and requirements.To enable permissions, select the permissions that are currently false and click Add >.To disable permissions, select the permissions that are currently true and click < Remove.

Adaptive Web (Mobile SPA)

Adaptive Web (Mobile SPA) is the browser on the device. Adaptive Web (Mobile SPA) properties define the properties of the application on Adaptive Web (Mobile SPA) for various platforms. You can set the Shortcut icons for the application, configure Async mode, and define Base fonts.

Click to view the image

The following table describes all the fields in Mobile Web settings.

Section NameField NameDescription
Shortcut IconsWeb BrowserConfigures an icon to represent the app in a web browser.
iPhone ShortcutConfigures an icon to represent the app on an iPhone screen.
TitleConfigures title of the application in a web browser.
Async ModeEnable Async ModeAll the network calls will be in asynchronous mode when enabled.
GeneralDefault image while loadingSet the default image to display while the app is loading.
Phone format IndicatorHighlights a telephone number clearly in the browser.
Requires GPS functionalityEnables the application to use the GPS functionality.
Error MessagesThe message to be displayed to the user in case of an error. Error messages are pre-populated. If you want to display a different message, overwrite this message.
Base FontsiPhone (px)Configures the base font of iPhone in pixel.
AndroidConfigures the base font of Android 240, Android 320, Android 360, Android 400, Android 440, Android 480, and Android 640 in pixel.
SPA iPadConfigures the base font of SPA iPad in pixel.
SPA Android TabletConfigures the base font of SPA Android Tablet 800, Android Tablet 1024, Android Tablet 1280 in pixel.
SPA Windows TabletConfigures the base font of SPA Windows tablet in pixel.

Responsive Web

Responsive Web properties specify the properties of the application on Responsive Web for various platforms. You can configure Embedding Iframe, and Async Mode; set the Web Browser icon, application title, BaseFont, Alignment, Screen width; and enable Progressive Web App.

Click to view the image

The following table describes all the fields in Responsive Web settings.

Section NameField NameDescription
General SettingsEnable Desktop Web (Legacy)Activates the Desktop Web Design for your Responsive Web application. This feature is provided as a backward compatibility support for a legacy feature.
Enable Embedding IframeSets the SPA or Desktop Web application behavior in a sub window. Enabling Embedding Iframe allows an application to open in a sub window.
Enable Async ModeAll the network calls will be in asynchronous mode when enabled.
Enable JS Library mode (Legacy)Enables the JavaScript Library mode for the app. This feature is provided as a backward compatibility support for a legacy feature.
Web browser (favicon.ico)Configures appropriate icon for an application in the Desktop Web Browser.
TitleSets the title of an application in the Desktop Web Browser.
Base Font (px)Configures appropriate base font size in pixel.
Base TargetSpecifies the default target for all hyperlinks and forms in the page. The possible values are _blank, _parent, _self, and _top.Note: This setting is applied at the application level. If you set a target in the anchor tag of a hyperlink, it overrides the base target for that hyperlink.
AlignmentDefines the alignment of the application in the Desktop Web browser. The possible values are center, left, and right.
Screen WidthSpecifies the width that the application occupies in the Desktop Web browser. The Screen width value can be in percentage or pixel.
No JavaScript MessageThe message to be displayed when your browser does not support JavaScript.
Progressive Web AppEnable PWABuilds a Progressive Web App.
Push NotificationsEnable Push NotificationsEnables Push Notifications for the app.
SEOEnable SEOEnables Search Engine Optimization for the app.

Protected Mode

Protected mode is a Volt MX Foundry token validation method. A successful validation occurs when the public key matches with the private key. It ensures that your app is not run on a rooted/ jail-broken device. Using Protected mode settings, you can configure the public and private encryption keys.

Note: This option works only if the application is built in Release mode. The Protected Mode option works only if the application is built in Release mode. To know more about protecting your application, refer Applying Application Security.

Click to view the image

The following table describes all the fields in Protected Mode settings.

Section NameField NameDescription
Encryption KeysPublic KeyConfigures the public key.
Private KeyConfigures the private key.

Metrics APM

Metrics Application Performance Monitoring deals with the set of metrics acquired by tracing the events of user’s interaction with the application.

Click to view the image

The following table describes all the fields in Metrics APM settings.

Section NameField NameDescription
Automatic Event CaptureEnable automatic event captureCaptures each event and send the data to the backend server for reporting purpose.
NavigationFormEntryAllows automatic tracking for iOS native and android apps when a form in an application is opened.
TimeApplication loadThis event is invoked when the application is loaded and the first form is shown.
Application TransitionThis event is invoked when the application transits either from foreground to background and vice versa.
ServicesServiceResponseAllows automatic tracking when an HTTP response is received from the service request or network call in the application.
ExceptionErrorThis event is invoked when application ends up in an unhandled exception in JavaScript code that the global exception handler catches up.
CrashThis event is invoked when application crashes and resumes after crash.