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
- Volt MX Foundry
- Native
- Adaptive Web (Mobile Web)
- Responsive Web
- Protected Mode
- Metrics APM
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 Name | Field Name | Description |
---|---|---|
General Settings | ID | Name of the application. It is auto populated. |
Version | A number that represents version of the application. It is auto-populated. | |
Company Name | Name of the company is auto-populated. | |
Accessibility Config | Enables assistive technologies such as TalkBack and VoiceOver. It assists visually-impaired users to navigate through various UI controls. | |
Enable Server Events APIs | ||
Cordova | Enable Cordova Settings | Configures the settings related to Cordova version. |
Version | Sets the Cordova version. | |
Use globally installed Cordova version | Enables the globally-installed Cordova version. | |
Internationalization (i18n) | Enable | Sets various locales to the Iris project. |
Enable i18n Layout Config | Configures layout properties. | |
Default Locale | Sets a default locale to the Iris project. | |
App Preview Security | User Defined Password | Enhances app preview security. While performing a cloud publish, you can set a password. To preview the app, you must enter the same password. |
Show Password | Unmasks the password. | |
Map Widget | Static Map Widget Key | Map 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 Key | For the applications using Version 1 of Google Maps API, enter the generated Android Map Widget key. | |
Android Map Widget Key 2 | For the applications using version 2 of Google Maps API, enter the generated Android Map Widget key. | |
Bing Map Widget Key | Enter 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 Name | Field Name | Description |
---|---|---|
Volt MX Foundry Details | Cloud Account | Configures a cloud account. |
Environment | Configures an environment in the selected cloud. | |
Runtime App Version | Select 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 Details | Automatically check for App Upgrades | Enable 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 Name | Field Name | Description |
---|---|---|
General | Name | Name of the Native channel version of the application. If no name is specified, the name specified under Application Properties is used. |
Application Logo | Sets an image as the application logo. | |
Test Automation | Expose widget IDs | Exposes the widget IDs. |
Windows 10 (Mobile & Tablet), Windows Desktop (Kiosk) | Enable Offline Objects | Configures 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 Name | Field Name | Description |
---|---|---|
iOS Build Settings | Bundle Identifier | A Unique name that identifies the application bundle. It usually consists of three parts and follows the convention of com.voltmx.<appname> |
Bundle Version | A number that identifies the version of the application bundle. | |
Glossy Effect key | Specifies if the glossy effect must be applied to the app icon. The default value is false. | |
Load indicator key | Configures the load indicator in an application. | |
Hide status bar | Hides the status bar in an application. | |
Protected Mode | Ensures 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. | |
Certificates | Development Method | Refer the article to know about Development Method. |
Mobile Provision | Refer the article to know about Mobile Provision. | |
.P12 | Refer the article to know about .P12 | |
P12 Password | Refer to the article to know about P12 Password. | |
Deeplink URL Scheme | URL Scheme | Specifies a URL to which the application will deep-link to. For more information about deep-linking, Appendix E: the App Service Event. |
Target Versions | iOS Version | Configures your iOS version. |
iPad Settings | Application Launch Mode | Specifies the default mode of launching the application on iPad. Portrait is the default value. |
Supported Orientations | Specifies the supported orientations for the iPad. This depends on the launch mode. | |
App Icons | App 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 Pt | Apps 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 Pt | Provide an image that represents your app for iOS 7-11. | |
Platform Settings | Generic exception alert | When 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 alert | When 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 Type | It 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 Certificate | By 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 Type | The 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 Drawing | If enabled, allows smoother widgets and layout without any jagged edges. |