Project Settings in Volt MX Iris
The project settings in Volt MX Iris are categorized into the following broad sections:
- Application
- Volt MX Foundry
- Native
- Mobile Web
- Desktop Web
- Protected Mode
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.
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. | |
| 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. | |
| 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 FoundrySettings
Using Volt MX Foundry settings, you can configure the Cloud Account and Environment details.
The following table describes all the fields in Volt MX Foundry settings.
| Section Name | Field Name | Description |
| VoltMX Foundry Details | Cloud Account | Configures a cloud account. |
| Environment | Configures an environment in the selected cloud. |
Native
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 categorized based on their platform-specific properties:
-
iPhone / iPad
-
Watch
-
Android Mobile / Tablet
-
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 platform.
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 | Enable Offline Objects | Configures Offline objects for Windows platform. |
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.
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. To use this option, you must patch Xcode with the Finalizer utility. For information on patching Xcode with Finalizer, refer Install Finalizer Package. Note: This option works only if the application is built with Build Mode as Protected Mode. To know more about protecting your application, refer Applying Application Security. | |
| 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. |
Watch
Using Watch settings, you can configure Target Versions, App Icons, and Notification icons for 38mm and 42 mm Apple Watches.
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 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. |
Android Mobile/ Tablet
Using Android Mobile/ Tablet Settings you can configure General Settings, SDK versions, and Android signing.
The following settings describe all the fields in Android Mobile/ Tablet settings.
| Section Name | Field Name | Description |
| General Settings | Package Name | Package 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> |
| Version Code | An 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. | |
| Protected Mode | Ensures that your app is not run on a rooted/jail-broken device. Note: This option works only if the application is built with Build Mode as Protected Mode. To know more about protecting your application, refer Applying Application Security. | |
| SDK Versions | Minimum SDK | Select the Minimum SDK Version that needs to be supported for the application. The default minimum SDK value is 4.0. Notes: VoltMX Iris does not support SDK Versions earlier than 4.0. You must keep the minimum SDK value between 4.0 and 4.4. The SDK values of 5.0 and above results in a build error(technical limitation). 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 SDK | Select 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 SDK | Select the Maximum SDK Version that needs to be supported for the application. | |
| Android Signing | Key Alias | Used to sign the android binary automatically during the build process. Enter the alias of the key. |
| Key Password | Enter the password for the key. | |
| Store Password | Enter the password for the store. | |
| Store File | Locate and configure the store file. | |
| Support for Margin in Pixels | True | Supports margin in Pixels. |
| False | Disables the support for margin in pixels. | |
| Manifest Permissions, Tags and Gradle Build Entries | Permissions | Sets 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. Important: Add the WRITE_EXTERNAL_STORAGE setting if you need to save images in an external storage such as an SD Card. |
| Tags | Adds tags to the Android manifest file directly from VoltMX 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 Entries | Imports 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. build.gradle entries to Prefix imports additional Gradle packages, or specifies external plugins to use in the build. build.gradle entries to Suffix customizes build logic. For example, you can add compilation dependencies such as Google and Android support repositories, local library modules, or local and remote repository paths. For more information, see Organizing Build Logic. gradle.properties entries configures project-wide Gradle settings, such as the Gradle daemon's maximum heap size or proxy settings. For more information, see The Build Environment. settings.gradle entries specifies external modules (Gradle-based third-party Android libraries) to include when building your application. For more information, see Configure Your Build. |
Windows
Using Windows Settings, you can configure the DP Scale Factor and Reference Width for a Windows phone.
Click to view the image
The following table describes all the fields in Windows Settings.
| Section Name | Field Name | Field Name |
| Windows | DP Scale Factor | The factor by which you should multiply the dp units to get the actual pixel count for the current windows screen. Enable DP Scale factor to modify Reference width. |
| Reference Width | Configures the width to which the Windows screen should scale. |
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.
The following table describes all the fields in Mobile Web settings.
| Section Name | Field Name | Description |
| Shortcut Icons | Web Browser | Configures an icon to represent the app in a web browser. |
| iPhone Shortcut | Configures an icon to represent the app on an iPhone screen. | |
| Title | Configures title of the application in a web browser. | |
| Async Mode | Enable Async Mode | All the network calls will be in asynchronous mode when enabled. |
| Base Fonts | iPhone (px) | Configures the base font of iPhone in pixel. |
| Android | Configures the base font of Android 240, Android 320, Android 360, Android 400, Android 440, Android 480, and Android 640 in pixel. | |
| SPA iPad | Configures the base font of SPA iPad in pixel. | |
| SPA Android Tablet | Configures the base font of SPA Android Tablet 800, Android Tablet 1024, Android Tablet 1280 in pixel. | |
| SPA Windows Tablet | Configures 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.
The following table describes all the fields in Desktop Web settings.
| Section Name | Field Name | Description |
| General Settings | Enable Responsive Web | Activates the Responsive Web Design for your desktop application. |
| Enable Embedding Iframe | Sets 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 Mode | All the network calls will be in asynchronous mode when enabled. | |
| Web browser (favicon.ico) | Configures appropriate icon for an application in the Desktop Web Browser. | |
| Title | Sets the title of an application in the Desktop Web Browser. | |
| Base Font (px) | Configures appropriate base font size in pixel. | |
| Alignment | Defines the alignment of the application in the Desktop Web browser. The possible values are center, left, and right. | |
| Screen Width | Specifies the width that the application occupies in the Desktop Web browser. The Screen width value can be in percentage or pixel. | |
| No JavaScript Message | The message to be displayed when your browser does not support JavaScript. | |
| Progressive Web App | Enable PWA | Builds a Progressive Web App. |
Protected Mode
Protected mode 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 with Build Mode as Protected Mode. To know more about protecting your application, refer Applying Application Security.
The following table describes all the fields in Protected Mode settings.
| Section Name | Field Name | Description |
| Encryption Keys | Public Key | Configures the public key. |
| Private Key | Configures the private key. |