• Home
  • Tutorials
  • Documentation
  • Articles
  • Software Academy
logo
HCL Volt MX Documentation V9.2
Introduction
Initializing search
    HCL-TECH-SOFTWARE/volt-mx-docs
    HCL-TECH-SOFTWARE/volt-mx-docs
      • Introducing Volt MX
        • All versions
        • What's new in V9 Service Pack 2
        • What's new in V9 Service Pack 1
        • What's new in V9
      • Release Notes
        • Overview
        • Overview
        • Action Editor
        • API Management
        • App Factory
        • Architecture
        • Build And Productivity
        • Components and Marketplace
        • Connecting to Backend
        • Designing For Web
        • Designing the Layout
        • Internationalization and Localization
        • Notification and Analytics
        • Offline Services
        • Programming and Extensibility
        • Volt MX Foundry Overview
      • Installation Guides
        • Fundamentals
          • Overview
            • Introduction
            • Volt MX Overview
            • Supported Operating Systems for Native Apps
            • Supported Devices for AppPlatform
            • Supported Development Languages
            • Supported Browsers for Desktop Web
            • Supported Versions for HTML5 Single Page Apps (SPA)
            • Introduction
            • Prerequisites
            • Install Volt MX Iris
            • Post Installation Tasks
            • Update Volt MX Iris
            • FAQs
            • Introduction
            • Prerequisites
            • Install Volt MX Iris
            • Post Installation Tasks
            • Update Volt MX Iris
            • FAQs
          • Introduction
          • Introduction to AppPlatform V8
          • Introduction to Marketplace
          • Private Marketplace
          • Introduction to Reference Architecture
          • Consuming a Data Adapter from Marketplace
          • Authoring a UI Component
          • Submitting a Component to Marketplace
          • Getting Started with Iris
          • Introduction to Forms and Widgets
          • Introduction to Action Editor
          • Working with Masters
          • Introduction to Flex Layout
          • Introduction to Volt MX JavaScript
          • Iris Enterprise
          • Understanding Skins
          • Photoshop Conversion Extension
          • Foundry Integration
          • Segment Widget - Introduction
          • Segment Widget - Advanced
          • Notes and Comments
          • Working with Named Actions
          • Working with the Browser Widget
          • Internationalization
          • Locale based layout
          • Volt MX APIs - Touch ID
          • Package Web Content Locally
          • Native Hybrid Communication
          • Embedding Cordova Application
          • Cordova Plugin Management
          • Native Function APIs iOS
          • Native Container iOS
          • Native Function APIs Android
          • Introduction
          • Supported Digital Channels
          • Hikes
          • Third-Party Licenses
            • Overview
            • Hardware and Software Requirements
            • Install Volt MX Iris
              • Platform SDKs
              • iOS SDK and simulator
                • Overview
                • Setting a New Android Environment in Windows
                • Android 9 Behavioral Changes
                • Android 10 Behavioral Changes
                • Android 11 Behavioral Changes
                • AndroidX Behavioral Changes
                • Android 13 Behavioral Changes
                • Deep Linking Guidelines for Android
              • Windows Phone and Tablet
            • Allow Anonymous Usage Data Collection
            • Use a Proxy Server
            • Modify Cloud Configuration
            • Workspaces: Repositories for Your Projects
              • Overview
              • Quick Launch Bar
              • Project Explorer
              • Iris Canvas
              • Properties Editor
              • Account Information
              • Library Explorer
              • Console
            • Check for Updates
            • Collab
            • Version Control
            • Overview
            • App User Interface
            • Data and Backend Integration
            • Web App Development
            • Types of Applications
            • Ensure You Have All the Resources You Need
            • Plan Your Mobile App
              • Overview
              • Types of Projects
              • Create a Project from Sample Applications and Components
              • Create a Volt MX Iris Reference Architecture Project
              • Create a Free-Form JavaScript Project
              • Migrate a Project from an Earlier Version
                • Overview
                • Integration with Sketch
              • Import a Volt MX Iris Project
              • Export a Volt MX Iris Project
            • Create the Storyboard of your App
              • Overview
              • Export Internationalization Resources
              • Import Internationalization Resources
              • Export and Import Themes
              • Export and Import Fonts
              • Overview
                • Overview
                • Forms
                • Notifications
                • Glances
              • Android Wear
              • Overview
                • Overview
                • FlexContainer
                • FlexScrollContainer
                • TabPane
                • Tab
                • Overview
                • Button
                • Calendar
                • CheckBoxGroup
                • DataGrid
                • Image
                • Label
                • ListBox
                • RadioButtonGroup
                • RichText
                • Slider
                • TextArea2
                • TextBox2
                • Overview
                • Browser
                • Cordova Browser
                • Camera
                • Map
                • Phone
                • PickerView
                • Segment2
                • Switch
                • Video
                • Overview
                • Watch Container Widget
                • Group Widget
                  • Overview
                  • Button Widget for Watch
                  • Date Widget for Watch
                  • Image2 Widget for Watch
                  • Label Widget for Watch
                  • Line Widget for Watch
                  • Slider Widget for Watch
                  • Timer Widget for Watch
                  • Overview
                  • Map Widget for Watch
                  • Switch Widget for Watch
              • Using the Native UI Container
                • Overview
                • Custom Widgets for iOS
                • Custom Widgets for Android
                • SPA and Desktop: Importing Custom Widgets
            • Organizing Application Elements
            • Add Custom CSS Code to an SPA App
            • Add Local HTML Content
            • Add a Local Database to an App
            • Create Cordova Applications
            • Set App Lifecycle Events
              • Overview
              • Add or Import Native Function APIs
              • Using the Native UI Container
              • Overview
              • Important Considerations
              • Add Watch Actions
              • Validate the Code of an Action
              • Invoke Sublime Text from Iris
              • Generate Code from an Action
              • Copy an Action Sequence
              • Disable an Action
              • Create a Condition Based on a Form's Orientation
              • General
              • Conditions
              • Functions
              • Widgets
              • Client
              • Network
              • Animation
              • Mapping
              • iOS Navigation Bar Properties
              • Overview
              • Importing Photoshop Styles and Colors
              • Use Default Skins
              • Create a New Skin
              • Configure a New Skin
              • Edit a Skin
              • Apply a Skin
              • Reuse Skins
                • Overview
                • Important Considerations in Forking
              • Delete a Skin
              • Impact of Upgrade to Volt MX Iris V8 on Skins in Widgets
              • Copy and Paste a Color or Gradient
              • Overview
              • What are themes and why would I want them?
              • Create a Theme
              • Rename a Theme
              • Duplicate the Current Theme
              • Delete a Theme
              • Rebrand a Project
            • Using Templates
            • Create and Use Form Templates
            • Responsive Grid Layout
            • Design a Responsive Web App
            • Design a Progressive Web App
              • Overview
              • Conventions for Using Images
              • Particulars for Managing Android Image Folders
              • Configure Splash Screens
              • Add a Favorite Icon for Use in a Browser
            • Refresh the Project
            • File Update Notification
            • Open an External File
            • Open Console Logs
            • Forking
            • Configuring Project Settings
            • Set Native App Properties
            • The Android Manifest File
            • Add Global Variables
            • Invoke Sublime Text from Iris
            • Find and Replace
            • Capture Product Requirements with Notes
            • Add Comments to Forms
              • Overview
              • Keyboard Shortcuts
              • Using Placeholder Text
              • Use Rulers and Guides for the Desktop Channel
              • Display Widget Command Handles
              • Select Multiple Items
              • Undo and Redo an Operation
              • Copy and Paste a Color or Gradient
              • Jump to the Definition of a Code Element
              • Open a Resource's Folder
              • Copy and Paste Forms and Actions across Channels
              • Display a List of JavaScript Code Elements
              • Expand and Contract the Iris Canvas
              • Go to the Most Recent Edit Location
              • Jump to a Specific Line of Code
            • Working with Components
            • Components Overview
            • Using Components
            • Creating a Component
            • Overview
              • Overview
              • Preprocessor/Post Processor
              • Data Provider
              • Response Encoding
              • Input and Output Parameters
              • Create an XML Service
              • Create a SOAP Service
              • Create a JSON Service
              • Create a Java Service
              • Create a Database Service
              • Create a SAP Service
              • Create a Salesforce Service
              • Create a Mulesoft Service
              • Create a Composite Service
              • Create a Looping Connector
              • Overview
              • Use Data & Services Panel Features
            • Search Engine Optimization for Web Apps
            • Publish a Project to Volt MX Foundry
              • Overview
              • Build Runtime Security in the Application
              • Certificate Pinning
              • Public Key Pinning
                • Overview
                • Protection Mechanisms Provided by Volt MX
                • RSA Key Pair Generation, Encryption, and Usage
                • Configure Project Settings in Volt MX Iris
              • Disable Screen Capture and Recording for Android
              • Disable Screen Capture and Recording for Windows Phone
              • Impact on App Performance
              • Application Security Guidelines
              • Jailbroken and Rooted Device Detection
            • Develop Offline Applications
            • Overview
            • Build and Publish
            • Build an iOS Application
            • Build an Android Application
            • Build a Universal Application
            • Build a Windows 10 Application
            • Build an Adaptive Web Application
            • Build a Progressive Web App
            • Secure your Web Application
            • Live Preview
            • Hot Reload
            • Build a Native App on a Local machine
            • Customize Volt MX App
            • Integrate React Native App into a Volt MX App
            • Disable Print Statements in Builds
            • Perform a Headless Build
            • Continuous Integration for Volt MX Iris
            • Build and Publish on Volt MX Iris
            • Publishing Apps to Enterprise App Store
            • Publish a Web App within Volt MX Iris
            • Preview an App on a Device
            • Monitor an App's Performance
            • iOS Build Automation
            • Open Webapp and Build Folders
            • Overview
            • Using TestNG Test Scripts
            • Using Jasmine Test Scripts
            • Debug JavaScript for iOS
            • Debug JavaScript for Android
            • Jasmine Test Automation
            • Android USB Debugging for Windows 10
            • Overview
            • Supporting Right-to-Left Languages
          • Appendix B: Android Build Environment and Configurations
          • Appendix C: Generating and Configuring Map API Keys
          • Appendix D: The App Service Event
          • Appendix E: Camera Access in Android Browser
          • Appendix F: Support for iPhone X
          • Appendix G: Universal Links iOS
          • Frequently Asked Questions
          • Overview
          • Preface
          • Design Guidelines Overview
            • Overview
            • List of UI elements
            • Guidelines for Application Icon
            • Guidelines for Splash Screen
              • Overview
              • iOS
              • Android
              • BlackBerry
              • Windows
              • General Guidelines for App Menu
              • Configure an App Menu
              • App Menu Examples
              • Overview
              • For Rich Client Applications
              • For Mobile Web Applications
              • Overview
              • iOS
              • Android
              • Configure a Title Bar on a Form (iPhone
              • Configure Device Back on a Form (Android / BlackBerry
              • Title Bar Examples
              • Overview
              • Create a Progress Indicator
              • Create a Blocking Indicator
              • Progress Indicator or Blocking UI Examples
            • Guidelines for Pop-Ups or Alerts
              • Overview
              • Proper Margins and Padding Examples
            • Guidelines while using Images
              • Overview
              • Avoid using Unnecessary Container Widgets
              • Avoid Complex View Hierarchy
              • Standards Around the Maximum Number of Rows within a Segment
              • Use Pagination
              • Setting Segment as Screen Level Widget
              • Do not use Hidden Widgets
              • Segment Widget Examples
              • Overview
              • Map Widget Examples
            • Guidelines while using Browser Widget
            • Guidelines for Calendar Widget
              • Overview
              • Achieve a Uniform UI in both Orientation
              • Configure a Screen for Both Portrait and Landscape
            • Mobile Web Apps Only
              • Overview
              • Text and Grammar across the Application
              • Container Widgets
              • Skins
              • Orientation Support
              • Headers and Footers
              • Copyright
              • Application Info
              • Application Icon in Phone Settings
              • Other Guidelines
            • Overview
              • Overview
              • iPhone
              • Andorid
              • BlackBerry
          • Performance Management Guidelines
            • Overview
            • form.destroy
            • Global Variables
          • Device-side Security Guidelines
          • Pre/Post Processors and URL Provider Guidelines
            • Overview
            • Coding Standards
            • Basics of JavaScript
            • Overview
            • Importance of Accessibility
            • Accessibility Compliance Guidelines for Web
            • Enable Accessibility in Iris
            • Widget Navigation
            • Accessibility: Platform Specific Limitations
            • Overview
            • Animation & Flex Layout Limitations
            • Flex Backwards Compatibility
            • Flex Pseudocode Examples
            • Flex Layout Animation
          • Platform Specific Limitations
          • App Submission Guidelines
          • Common UI Issues
          • Introduction
            • Overview
            • voltmx.accelerometer Namespace
            • Overview
            • ActionItem Object
            • ActionItem Object Properties
            • ActionItem Function
            • ActionSheet Object
            • ActionSheet ObjectMethods
            • ActionSheet Function
            • Overview
            • voltmx.ui.Alert Function
            • Overview
            • AnimationDefinition Object
            • Key Frame Animation
            • AnimationConfiguration Object
            • voltmx.anim Namespace
            • voltmx.ui.createAnimation Function
            • voltmx.ui.makeAffineTransform Function
            • transform Object
          • Android NFC Manifest Configuration
            • Overview
            • voltmx.actionExtension Namespace
            • voltmx.iMessageExtensions Namespace
            • voltmx.intentExtension Namespace
            • voltmx.notificationContentExtension Namespace
            • voltmx.shareExtensions Namespace
            • voltmx.todayExtension Namespace
            • Overview
            • voltmx.application Namespace
            • Overview
            • voltmx.application.settings Namespace
            • Overview
            • voltmx.automation Namespace
            • Overview
            • voltmx.backgroundtasks Namespace
            • Overview
            • Functions
            • Overview
            • Constants
            • Functions
            • Overview
            • com.voltmx.Beacon
            • com.voltmx.BeaconManager
            • BeaconRegion Object
            • com.voltmx.PeripheralManager
          • Bookmark and Refresh API
            • Overview
            • voltmx.net.cache namespace
            • Overview
            • voltmx.camera Namespace
            • Overview
            • Functions
          • Client Authentication API
            • Overview
            • voltmx.haptics Namespace
            • Overview
            • voltmx.reactNative Namespace
            • React Native APIs
            • Overview
            • voltmx.crypto Namespace
            • Overview
            • voltmx.dragDrop Namespace
            • Overview
            • voltmx.forcetouch Namespace
            • Overview
            • voltmx.modules Namespace
            • Overview
            • voltmx.location Namespace
            • Overview
            • Functions
            • Overview
            • SafetyNet APIs
            • Security Provider APIs
            • Update and Error Handling APIs
            • voltmx.gms Namespace
            • Overview
            • Image Object
            • Filter Object
            • voltmx.filter Namespace
            • voltmx.image Namespace
            • Overview
            • ImageClassifier Object
            • voltmx.ml Namespace
            • Overview
            • Constants and Functions
            • Overview
            • voltmx.io.File Namespace
            • voltmx.io.FileList Namespace
            • voltmx.io.FileSystem Namespace
            • voltmx.types Namespace
            • RawBytes Object
            • Secure Text Exchange between Native Android Code and JavaScript
            • Overview
            • voltmx.i18n Namespace
            • Overview
            • voltmx.keychain Namespace
            • Overview
            • voltmx.lang Namespace
            • Overview
            • Functions
            • Overview
            • voltmx.localAuthentication Namespace
            • Overview
            • voltmx.map Namespace
          • Map Styling API
            • Overview
            • math Namespace
            • Overview
            • voltmx.media Namespace
              • Overview
              • Methods
              • Properties
              • Overview
              • Methods
            • voltmx.screenrecorder Namespace
            • Overview
            • Network Calls
            • Asynchronous Network Calls
            • voltmx.net Namespace
            • Overview
              • Overview
              • voltmx.localnotifications Functions
              • voltmx.localnotifications Properties
              • Overview
              • voltmx.push Namespace
              • Overview
              • voltmx.notificationsettings Namespace
            • Overview
            • voltmx.store Namespace
            • voltmx.db Namespace
            • voltmx.ds Namespace
            • Overview
            • voltmx.os Namespace
            • Objects
            • DeviceInfo
            • Overview
            • PassLibrary Object
            • Pass Object
            • AddPassesViewController Object
            • Overview
            • voltmx.payment Namespace
            • Overview
            • voltmx.contact Namespace
            • voltmx.phone Namespace
            • Overview
            • requestReviewFlow Function
            • requestReview Function
            • Overview
            • Functions
          • Shared App Group Container API for iOS
            • Overview
            • Functions
            • Overview
            • voltmx Namespace
            • Overview
            • voltmx.string Namespace
            • Overview
            • sync Namespace
            • Sync Object
            • Overview
            • voltmx.theme Namespace
            • Overview
            • Functions
            • Overview
            • voltmx.timer Namespace
            • Overview
            • Functions
            • Toast Object
            • voltmx.ui Namespace
            • Overview
            • voltmx.worker Namespace
            • WorkerThread Object
          • Deprecated/Unsupported APIs
          • Appendix: Exceptions
          • Appendix: General FAQ
          • Appendix: JavaScript FAQ
          • Appendix: Preprocessor Directives
          • Appendix: SQLite
            • Background Fetch
            • Background Transfers
            • Background Fetch Workflow
            • Background Fetch and Background Transfers APIs
            • Supported Versions and Platforms
            • voltmx.backgroundjob.setBackgroundFetchInterval
            • voltmx.backgroundjob.setBackgroundFetchCompletionStatus
            • voltmx.backgroundjob.registerBackgroundFetch
              • suspend
              • resume
              • getTaskState
              • getSession
          • Overview
          • Introducing the Native Function API
            • Overview
            • Updating Old Apps to Work with iOS 12 Security Enhancements
            • iOS Quick Start Guide
            • Using the Native Function API for iOS
              • Overview
              • Accelerate
              • Accounts
              • AddressBook
              • AddressBookUI
              • AdSupport
              • AssetsLibrary
              • AudioToolbox
              • AudioUnit
              • AuthenticationServices
              • AVFoundation
              • AVKit
              • BackgroundTasks
              • BusinessChat
              • CallKit
              • CarPlay
              • CFNetwork
              • ClassKit
              • CloudKit
              • Contacts
              • ContactsUI
              • CoreAudioKit
              • CoreBluetooth
              • CoreData
              • CoreFoundation
              • CoreHaptics
              • CoreLocation
              • CoreMedia
              • CoreMIDI
              • CoreML
              • CoreMotion
              • CoreServices
              • CoreTelephony
              • CoreVideo
              • DeviceCheck
              • EventKit
              • EventKitUI
              • ExternalAccessory
              • FileProvider
              • FileProviderUI
              • Foundation
              • GameController
              • GameKit
              • GamePlayKit
              • GLKit
              • GSS
              • HealthKit
              • HealthKitUI
              • IdentityLookup
              • IdentityLookupUI
              • ImageCaptureCore
              • ImageIO
              • Intents
              • IntentsUI
              • JavaScriptCore
              • LinkPresentation
              • LocalAuthentication
              • MapKit
              • MediaAccessibility
              • MediaPlayer
              • MediaToolbox
              • Messages
              • MessageUI
              • Metal
              • MetalKit
              • MetalPerformanceShaders
              • MetricKit
              • MobileCoreServices
              • ModelIO
              • MultipeerConnectivity
              • NaturalLanguage
              • NetworkExtension
              • Network
              • NewsstandKit
              • NotificationCenter
              • PassKit
              • PDFKit
              • PencilKit
              • Photos
              • PhotosUI
              • PushKit
              • QuartzCore
              • QuickLook
              • QuickLookThumbnailing
              • ReplayKit
              • SceneKit
              • Security
              • Social
              • SoundAnalysis
              • Speech
              • SpriteKit
              • StoreKit
              • SwiftUI
              • SystemConfiguration
              • Twitter
              • UIKit
              • UserNotifications
              • UserNotificationsUI
              • VideoSubscriberAccount
              • VideoToolbox
              • Vision
              • VisionKit
              • WatchConnectivity
              • WebKit
              • Overview
              • Battery Status - Application Walkthrough
              • Using the Native Container Widget to Display iOS Controls
              • Generator
              • HealthKit
              • Apple Pay
              • ZipUnzip
            • Overview
            • Android Quick Start Guide
            • Using the Native Function API for Android
              • Overview
              • android.accessibilityservice
              • android.accounts
              • android.animation
              • android.annotation
              • android.app
              • android.app.admin
              • android.app.assist
              • android.app.backup
              • android.app.job
              • android.app.usage
              • android.appwidget
              • android.bluetooth
              • android.bluetooth.le
              • android.content
              • android.content.pm
              • android.content.res
              • android.database
              • android.database.sqlite
              • android.databinding
              • android.drm
              • android.gesture
              • android.graphics
              • android.graphics.drawable
              • android.graphics.drawable.shapes
              • android.graphics.pdf
              • android.hardware
              • android.hardware.camera2
              • android.hardware.camera2.params
              • android.hardware.display
              • android.hardware.fingerprint
              • android.hardware.input
              • android.hardware.usb
              • android.inputmethodservice
              • android.location
              • android.media
              • android.media.audiofx
              • android.media.browse
              • android.media.effect
              • android.media.midi
              • android.media.projection
              • android.media.session
              • android.media.tv
              • android.mtp
              • android.net
              • android.net.http
              • android.net.nsd
              • android.net.rtp
              • android.net.sip
              • android.net.wifi
              • android.net.wifi.p2p
              • android.net.wifi.p2p.nsd
              • android.nfc
              • android.nfc.cardemulation
              • android.nfc.tech
              • android.opengl
              • android.os
              • android.os.storage
              • android.preference
              • android.print
              • android.print.pdf
              • android.printservice
              • android.provider
              • android.renderscript
              • android.sax
              • android.security
              • android.security.keystore
              • android.service.carrier
              • android.service.chooser
              • android.service.dreams
              • android.service.media
              • android.service.notification
              • android.service.restrictions
              • android.service.textservice
              • android.service.voice
              • android.service.wallpaper
              • android.speech
              • android.speech.tts
              • android.support.v4
              • android.support.v4.accessibilityservice
              • android.support.v4.media
              • android.support.v4.media.session
              • android.support.v8.renderscript
              • android.system
              • android.telephony
              • android.telephony.cdma
              • android.telephony.gsm
              • android.test
              • android.test.mock
              • android.test.suitebuilder
              • android.test.suitebuilder.annotation
              • android.text
              • android.text.format
              • android.text.method
              • android.text.style
              • android.text.util
              • android.transition
              • android.util
              • android.view
              • android.view.accessibility
              • android.view.animation
              • android.view.inputmethod
              • android.view.textservice
              • android.webkit
              • android.widget
              • com.android.test.runner
              • java.awt.font
              • java.beans
              • java.io
              • java.lang
              • java.lang.annotation
              • java.lang.ref
              • java.lang.reflect
              • java.math
              • java.net
              • java.nio
              • java.nio.channels
              • java.nio.channels.spi
              • java.nio.charset
              • java.nio.charset.spi
              • java.security
              • java.security.acl
              • java.security.cert
              • java.security.interfaces
              • java.security.spec
              • java.sql
              • java.text
              • java.util
              • java.util.concurrent
              • java.util.concurrent.atomic
              • java.util.concurrent.locks
              • java.util.jar
              • java.util.logging
              • java.util.prefs
              • java.util.regex
              • java.util.zip
              • javax.crypto
              • javax.crypto.interfaces
              • javax.crypto.spec
              • javax.microedition.khronos.egl
              • javax.microedition.khronos.opengles
              • javax.net
              • javax.net.ssl
              • javax.security.auth
              • javax.security.auth.callback
              • javax.security.auth.login
              • javax.security.auth.x500
              • javax.security.cert
              • javax.sql
              • javax.xml
              • javax.xml.datatype
              • javax.xml.namespace
              • javax.xml.parsers
              • javax.xml.transform
              • javax.xml.transform.dom
              • javax.xml.transform.sax
              • javax.xml.transform.stream
              • javax.xml.validation
              • javax.xml.xpath
              • junit.framework
              • junit.runner
              • org.apache.http.conn
              • org.apache.http.conn.scheme
              • org.apache.http.conn.ssl
              • org.apache.http.params
              • org.json
              • org.w3c.dom
              • org.w3c.dom.ls
              • org.xml.sax
              • org.xml.sax.ext
              • org.xml.sax.helpers
              • org.xmlpull.v1
              • org.xmlpull.v1.sax2
              • Overview
              • Battery Status - Application Walkthrough
              • Toast
              • JobScheduler
              • Near Field Communication
              • Speech
              • ZipUnzip
          • Overview
          • Widgets and API reference
          • Gesture Methods and 3D Touch
          • Widget Skins
          • Dynamic Skinning
          • Application Initialization Events
            • Overview
            • Example and Sample App
          • API Simplification
          • Masters
          • Widget Common Properties
            • iOS
            • Tool and Navigation bars for iOS
          • Platform Specific Limitations
            • Alert Widget Basics
            • Events
            • Methods
            • Properties
            • AppMenu Widget Basics
            • Methods
            • Properties
            • ARRenderer Widget Basics
            • Events
            • Methods
            • Properties
            • BottomSheet Widget Basics
            • Events
            • Methods
            • Properties
            • Browser Widget Basics
            • Events
            • Methods
            • Properties
            • Button Widget Basics
            • Events
            • Methods
            • Properties
            • Calendar Widget Basics
            • Events
            • Methods
            • Properties
            • Camera Widget Basics
            • Event
            • Methods
            • Properties
            • Canvas Widget Basics
            • Event
            • Methods
            • Properties
            • CheckBoxGroup Widget Basics
            • Events
            • Method
            • Properties
            • CollectionView Widget Basics
            • Events
            • Methods
            • Properties
            • CordovaBrowser Widget Basics
            • Events
            • Methods
            • Properties
            • DataGrid Widget Basics
            • DataGrid Templates
            • Events
            • Methods
            • Properties
            • FlexContainer Widget Basics
            • Flex Layout Rules
            • Flex Container Sample Code
            • Events
            • Methods
            • Properties
            • FlexForm Widget Basics
            • Flex Layout Rules
            • Example and Sample App
            • Using the Navigation Drawer
            • Events
            • Methods
            • Properties
            • FlexScrollContainer Widget Basics
            • Creating a FlexScrollContainer Using a Constructor: voltmx.ui.FlexScrollContainer
            • FlexScrollContainer Example
            • Events
            • Methods
            • Properties
            • Image Widget Basics
            • Events
            • Methods
            • Properties
            • Label Widget Basics
            • Events
            • Methods
            • Properties
            • ListBox Widget Basics
            • Events
            • Methods
            • Properties
            • Map Widget Basics
            • Templates
            • Events
            • Methods
            • Properties
            • Objects
            • MLCamera Widget Basics
            • Events
            • Methods
            • Properties
            • NativeContainer Widget Basics
            • Events
            • Methods
            • Properties
            • PDFView Widget Basics
            • Events
            • Methods
            • Properties
            • Phone Widget Basics
            • Events
            • Methods
            • Properties
            • PickerView Widget Basics
            • Events
            • Methods
            • Properties
            • RadioButtonGroup Widget Basics
            • Events
            • Method
            • Properties
            • ReactNativeContainer Widget Basics
            • Properties
            • RichText Widget Basics
            • Events
            • Method
            • Properties
            • SegmentedUI Widget Basics
            • Events
            • Methods
            • Properties
            • Objects
            • SignatureCapture Widget Basics
            • Events
            • Methods
            • Properties
            • SigninWithApple Widget Basics
            • Events
            • Properties
            • Slider Widget Basics
            • Creating a Progress Bar Using a Slider
            • Events
            • Methods
            • Properties
            • SlidingContainer Widget Basics
            • Events
            • Properties
            • Switch Widget Basics
            • Events
            • Method
            • Properties
            • TabPane Widget Basics
            • Events
            • Methods
            • Properties
            • TextArea2 Widget Basics
            • Events
            • Methods
            • Properties
            • TextBox2 Widget Basics
            • Events
            • Methods
            • Properties
            • ToolBar Widget Basics
            • Tool and Navigation bars for iOS
            • Constructor
            • Methods
            • Properties
            • Video Widget Basics
            • Events
            • Methods
            • Properties
          • Deprecated Widgets
          • Glossary
          • Introduction
            • Overview
            • Supported Platforms and Devices
            • Prerequisites
              • Overview
              • iOS WatchKit Application Architecture
              • Creating Apple Watch Applications in Volt MX Iris
              • Apple-Specific Limitations
                • Overview
                • Configuring Your Xcode Project
                • VoltMXWatchKitRequestUtil
                • VoltMXDataMapper
                • VoltMXDataCache
              • Introduction
              • Overviews
                • Overview
                  • Overview
                  • Constants
                  • Functions
          • Introduction
            • Overview
            • Preview an App on a Device
            • Execute App Lifecycle Events
            • Notes in the Volt MX App
            • View logs on the Volt MX App
            • Clear the Publish Code for a Project's Preview
          • Reports and Analytics
          • Volt MX Iris Reference Architecture API Programmers' Guide
            • Overviews
            • Volt MX Reference Architecture: Decoded
            • Advantages of Using Volt MX Reference Architecture
              • A Deeper Look at VoltMX Reference Architecture
              • Views
              • Controllers
              • Models
              • Views and Controllers
              • Models and Controllers
              • VoltMX Reference Architecture Features
              • Models, Views, and Controllers in Action
              • Components and Volt MX Reference Architecture
              • Form Navigation
              • Dynamic Module Loading
              • Define Namespaces in Apps
              • Access Volt MX Foundry Services through Volt MX Reference Architecture
              • Use Volt MX Reference Architecture for Volt MX Wearables Apps
                • Build Your Front-End Client App
                • Application Group in Reference Architecture Extensions
                • Locking Feature in Reference Architecture Extensions
              • Build Your App&quo;s Data Model
              • Generate Controllers and Extensions
              • A Sample Form Controller
            • References
              • FormController Object
                • FormController Events
                • getModel Event
                • onCreateView Event
                • onDestroy Event
                • onNavigate Event
                • setModel Event
                • FormController Methods
                • getCurrentForm Method
                • getCurrentFormFriendlyName Method
                • getPreviousForm Method
                • getPreviousFormFriendlyName Method
                • pauseNavigation Method
                • resumeNavigation Method
                • FormController Properties
                • view Property
              • voltmx.model Namespace
                • voltmx.model Constants
                • voltmx.model.ExceptionCode Constants
                • voltmx.model.ValidationType Constants
                • voltmx.model Objects
                  • voltmx.model.Exception Object
                    • voltmx.model.Exception Properties
                    • code Property
                    • message Property
                    • name Property
                  • voltmx.model.VoltMXApplicationContext Object
                    • voltmx.model.VoltMXApplicationContext Methods
                    • createModel Method
                    • login Method
                    • logout Method
              • voltmx.mvc Namespace
                • voltmx.mvc Functions
                • Navigation Function
              • voltmx.mvc.registry Namespace
                • voltmx.mvc.registry Functions
                • add Function
                • getViewName Function
                • getControllerName Function
                • remove Function
              • Navigation Object
                • Navigation Object Methods
                • getModel Method
                • navigate Method
                • setModel Method
              • TemplateController Object
                • TemplateController Events
                • onCreateView Event
                • onDestroy Event
                • onViewCreated Event
                • TemplateController Methods
                • executeOnParent Method
                • getCurrentView Method
                • TemplateController Properties
                • view Property
              • Deprecated
                • voltmx.sdk.mvvm Namespace
                  • voltmx.sdk.mvvm Constants
                  • voltmx.sdk.mvvm.OperationType Constants
                  • voltmx.sdk.mvvm Objects
                    • voltmx.sdk.mvvm.VoltMXApplicationContext Object
                      • voltmx.sdk.mvvm.VoltMXApplicationContext Methods
                      • appServicesLogin Method
                      • dismissLoadingScreen Method
                      • getAllFormControllers Method
                      • getAppInstance Method
                      • getFactorySharedInstance Method
                      • getFormController Method
                      • getMetadataStore Method
                      • getModel Method
                      • getObjectService Method
                      • init Method
                      • logout Method
                      • showLoadingScreen Method
        • Fundamentals
          • Overview
            • Overview
            • Volt MX Overview
            • Volt MX Foundry V9 SP2 Software Requirements
            • Volt MX Foundry Supported Browsers
            • Overview
              • Overview
              • Database Prerequisites
              • Application Servers Prerequisites
            • Volt MX Foundry Topology and Components
            • Installation on Single Node and Multinode
            • Preinstallation Tasks
              • Overview
              • Installing Volt MX Foundry - Console-mode
              • Installing Volt MX Foundry on Tomcat
                • Overview
                • Standalone Mode (Single node installation in Bundled JBoss
                • Log Location for Single Node Installation
                • Standalone Mode (Single node installation in pre-configured JBoss
                • Domain Mode (Multinode installation in pre-configured JBoss Cluster
                • Log Location for Multinode Installation
              • Installing Volt MX Foundry - Silent-mode
            • How to Stop and Start Volt MX Foundry
              • Overview
              • Prerequisites for Upgrade from Foundry 7.x to Volt MX Foundry 8.x
              • Upgrading Foundry to V9
              • Upgrading the Custom Metrics Component
            • Installing Hotfix Archives for Volt MX Foundry - Linux
            • Uninstalling Volt MX Foundry
            • Post-Installation Tasks
              • Troubleshooting
              • Context Root-path Overview
              • Approach 1: Changing Context Root Path after the installation using the Installer
              • Approach 2: Changing Context Root using Manual Install Steps
            • Overview
              • Overview
              • Database Prerequisites
              • Application Servers Prerequisites
            • Volt MX Foundry Topology and Components
            • Volt MX Foundry Installation on Single Node and Multinode
              • Overview
              • Application Servers Pre-Installation Tasks
              • Overview
                • Overview
                • Installing Volt MX Foundry on Tomcat
                  • Overview
                  • Standalone Mode (Single Node installation in bundled JBoss
                  • Standalone Mode (Single Node Installation in pre-configured JBoss
                  • Domain Mode (Multi node Installation in pre-configured JBoss cluster
              • Installing Volt MX Foundry - Silent-mode
            • How to Start and Stop Volt MX Foundry
              • Overview
              • Prerequisites for Upgrade from Foundry 7.x to Volt MX Foundry 8.x
              • Upgrading Volt MX Foundry to V9
              • Upgrading the Custom Metrics Component
              • Foundry 9.2 upgrade documentation
            • Installing Hotfix Archives for Volt MX Foundry - Windows
            • Uninstalling Volt MX Foundry
            • Post-Installation Tasks
              • Overview
              • Log Location for Single Node Installation
              • Log Location for Multinode Installation
              • How to Change Log Levels
              • Troubleshooting
              • Context Root-path - Overview
              • Approach 1: Changing Context Root Path after the installation using the Installer
              • Approach 2: Changing Context Root using Manual Install Steps
              • Accessing Context Based Root Volt MX Foundry Instance through Iris
            • Overview
            • Volt MX Foundry Topology and Components
            • Volt MX Foundry Installation on Single Node and Multinode
              • Overview
              • Database Prerequisites
              • Required Setup Files
              • Encrypt Passwords
              • Preinstallation Tasks - Database - Configuring Flyway Command-line Tool
              • Preinstallation Tasks - App Servers
              • Set up Middleware Home
                • Overview
                • How to Install Tomcat
                • Configure Connectors - Tomcat
                • How to Install JBoss
                • Configure Connectors - JBoss
                • Update Listen Interfaces in host.xml for JBoss Cluster
                • Configure JBoss in Domain mode
                • How to Configure WebSphere Liberty Server
                • Install Memcached Server - Windows
              • How to Install Volt MX Foundry
                • Overview
                • Installing Console on Tomcat
                • Create and Configure a Database for Accounts
                • Accounts schema diagram
                • Create and Configure a Database for Workspace Services
                • Workspace schema diagram
                • Configure JNDI - Tomcat
                • Configuring Properties Files in WAR Files - Tomcat
                • Deploy updated WAR files to Tomcat
                • Installing Identity on Tomcat
                • Create and Configure a Database for Identity Services
                • Identity schema diagram
                • Configure JNDI - Tomcat
                • Configure Java Transactions API (JTA) - Tomcat
                • Configure Properties Files in WAR Files - Tomcat
                • Deploy updated WAR files to Tomcat
                • Installing Integration Services on Tomcat
                • Create and Configure a Database for Integration Services - Admin
                • Admin Server schema diagram
                • Create and Configure a Database for Integration Services - Reports
                • ReportsDB (Metrics) schema diagram
                • Configuring JNDI for Integration - Tomcat
                • Deploy updated WAR files to Tomcat
                • Installing Developer Portal on Tomcat
                • Configure Properties Files in Tomcat - Developer Portal
                • Installing Engagement Services on Tomcat
                • Create a database for Volt MX Engagement Services
                • Engagement Services schema diagram
                • Database Setup through Flyway
                • Set Up Engagement Services
                • Configure Engagement Services - Tomcat_Server
                • How to Configure Volt MX Foundry on Tomcat Multinode
                • Overview
                • Installing Console on JBoss
                • Create and Configure a Database for Accounts
                • Accounts schema diagram
                • Create and Configure a Database for Workspace Services
                • Workspace schema diagram
                • Configure Datasource for a Database - JBoss
                • Configuring Properties Files in WAR Files - JBoss
                • Deploying WAR Files to JBoss
                • Installing Identity on JBoss
                • Create and Configure a Database for Identity Services
                • Identity schema diagram
                • How to Configure Datasource for a Database - JBoss
                • Configure Properties Files in WAR Files for Identity - JBoss
                • Deploying WAR Files to JBoss
                • Installing Integration Services on JBoss
                • Create and Configure a Database for Integration Services - Admin
                • Admin Server schema diagram
                • Create and Configure a Database for Integration Services - Reports
                • ReportsDB (Metrics) schema diagram
                • How to Configure Datasource for a Database - JBoss
                • Configure Metrics.ear - JBoss
                • Deploying WAR Files to JBoss
                • Installing Developer Portal on JBoss
                • Configure Properties Files in JBoss - Developer Portal
                • Installing Engagement Services on JBoss
                • Create a database for Engagement Services
                • Engagement Services schema diagram
                • Database Setup through Flyway
                • Set Up Engagement Services
                • Configure Engagement Services - JBoss_Server
                • Overview
                • Installation of Foundry on WebSphere Liberty Profile
            • How to Start and Stop Volt MX Foundry
            • How to Log in to Volt MX Foundry Console
              • Overview
              • How to Upgade Volt MX Integration
              • How to Upgade Engagement Services
            • Post-Installation Tasks
              • Troubleshooting
              • How to Change Log Levels
              • Context Root-path - Overview
              • Approach 1: Changing Context Root Path after the installation using the Installer
              • Approach 2: Changing Context Root using Manual Install Steps
              • Accessing Context Based Root Volt MX Foundry Instance through Iris
            • Introduction
            • Prerequisites
            • Using the Volt Foundry Command Line Installer
            • Inputs in the userInputs.properties file
            • Supported Installer Actions
            • Troubleshooting and FAQs
            • Installation Guide for Volt MX Foundry on Amazon EKS
            • Volt MX Foundry on Amazon EKS
            • Configuration and Setup for Foundry on Amazon EKS
            • Deployment Debug Tool for Volt MX Foundry
            • Upgrade Volt MX Foundry on Amazon EKS
            • Additional Considerations
            • Installing Foundry on Red Hat OpenShift
            • Volt MX Foundry on Red Hat OpenShift
            • Configuration and Setup for Foundry on OpenShift
            • Upgrade Volt MX Foundry on OpenShift
            • Additional Considerations
            • Introduction
            • Overview
            • Overview
            • Installation
            • Post Installation Tasks
            • Appendices
            • FAQs and Troubleshooting
            • Prerequisites
          • Overview
          • Preface
          • Foundry SDKs
          • Accessing Volt MX Foundry Console - Volt MX Cloud
          • Environments - Volt MX Cloud
          • Default Access Control Lists (ACLs) on New Apps and Services
          • Volt MX Foundry Updates on Cloud
          • Accessing Volt MX Foundry Console - On-Premises
          • Environments - On-Premises
          • Viewing Applications Published to a Runtime Environment
          • Features
          • Apps - How to Add Applications
          • Console Access Control
            • Overview
              • Overview
              • Publishing Individual Services
          • API Versioning
          • Application Versioning
          • Custom Data Adapters on Volt MX Foundry
          • Managing JAR Files
          • Analytics for Third-party Client App Binaries
          • Exporting and Importing an Application
            • Overview
              • Overview
              • Microsoft Active Directory
              • Salesforce
              • Open LDAP
              • Security Assertion Markup Language (SAML)
              • Siteminder
              • Volt MX SAP Gateway
              • Volt MX User Repository (Deprecated)
                • Overview
                • Reset Password
                • Sign-Up for a User Repository
              • Using Groups in an App
              • Facebook
                • Overview
                • How to Configure a Custom Identity Service by using an Integration Service
              • Volt MX Foundry OAuth 2.0
              • OAuth Provider
              • Social Identity Providers
              • Groups Support in Identity Services
            • Managing Existing Identity Services
            • How to Configure Identity Session Timeout and HTTP Message Body Integrity
            • How to Enable Multi-Factor Authentication
            • Support to MAP Public URLs - Reverse Proxy (on-premises
            • Single Sign-On
            • Configuring Concurrent User Sessions
            • Overview
            • Migrate an app from an earlier version of Volt MX Studio (6.5 or lower versions) to Volt MX Foundry
            • Migrate a Consolidated Service Definition (CSD) to Volt MX Foundry
            • Introduction
              • Overview
              • XML Adapter
              • SOAP Adapter
              • JSON Adapter
              • Java Adapter
              • JavaScript Adapter
              • API Proxy Adapter
              • Volt MX Mock Data Adapter
              • Volt MX SAP Gateway Adapter
              • MuleSoft Adapter
              • AWS API Gateway Adapter
              • Database Adapter
              • MongoDB Adapter
              • RAML Adapter
              • Salesforce Adapter
              • IBM MQ Adapter
              • SAP JCO Adapter
              • Email Adapter
              • AWS S3 Adapter
              • Cloudian Adapter
              • File Storage Adapter
              • Foundry Admin Adapter
              • Red Hat PAM Adapter
              • Text Adapter
              • Open API (Swagger) Adapter
              • Volt MX Customer 360
              • Overview
              • Preprocessor and Postprocessor
              • Rules for Pre and Post Processors
              • Custom Code for Invoking an Integration service from Preprocessor or Postprocessor
                • Overview
                • JavaScript Sample Code for Preprocessor and Postprocessor
              • Override API Throttling Configuration
              • How to Develop Apps based on a Stubbed Service
              • Enhanced Identity Filters
              • Collection Support
              • How to Configure Custom Front End URLs
              • XPath
              • Test a Service Operation
              • How to Use Custom Servlets, Filters, and Listeners
              • Test the Login for an OAuth 2.0 Identity Service
              • Server Events
              • Manage Existing Integration Services
            • Overview
            • Importing and Exporting Services
            • Test an Orchestration Service Operation
            • Overview
              • Overview
              • Enumeration Data Type
              • Overview
              • Creating a Mapping by using Visual Mapper
              • Enhancing the Mapping by using XML Mapper for Advanced Scenarios
            • Stage 4: Integrating Objects Services in an Application
            • Object Metadata for Controlling Client-side Logic
            • Context Based Options
            • Enhanced Identity support in Object Services
            • Mapper Example Reference
            • Storage Object Services
              • Overview
              • AWS S3 Adapter
              • Cloudian Adapter
              • File Storage Adapter
            • Offline Enablement
              • Overview
              • Custom Code for Invoking Object service from Preprocessor or postprocessor
          • Offline Sync (Offline Objects
          • Legacy Sync
          • Developer Portal
          • Logic
          • Rules as a Service
          • Engagement
            • Overview
              • Overview
              • Uploading Native Client Binaries
              • Uploading Web Client Binaries
              • Overview
              • Publishing Native Client Binaries
              • Publishing Web Client Binaries
            • Upgrading Client Binaries
          • Volt MX Enterprise App Store Service for Digital App Distribution
          • Sending Push Notification to EAS
          • Checking App Versions in EAS
          • Walk-through of Volt MX Enterprise App Store (EAS) Source Application
          • Known Issues - EAS
            • Overview
            • Asynchronous Publish
            • Synchronous Publish
            • Separate App Key/App Secret for Web and Native Channels
              • Overview
              • App Reconfiguration
              • Service Reconfiguration
              • Managing Service Profiles
          • Promoting a Deployment Package
            • Continuous Integration with Volt MX Foundry
            • Headless and Continuous Integration Build
            • Continuous Integration with Foundry APIs
            • CI_NativeBinary Upload and Publish
            • CI Cloud Build
            • Support for Multi-Factor Authentication from MFCLI
            • Export and Import Custom Reports and Custom Dashboards through MFCLI
            • Export and Import Configurable Parameters for App Services through MFCLI
            • Configuring Read-only Fields for Object Services through MFCLI
            • Merge Templates using MFCLI
            • Overview
              • Overview
              • Downloading Volt MX IDE SDK
              • Initializing the Volt MX SDK Client SDK
              • Setting User ID
              • HTTP Message Body Integrity
              • Server Event APIs
              • Invoking an Identity Service
              • Invoking an Integration Service
              • Invoking an Integration Service with Response Passthrough
              • Invoking a Configuration Service
              • Invoking a Logic Service
              • Invoking a Messaging Service
              • Invoking a Metrics Service
              • Invoking Offline Objects APIs
                • Overview
                • getObjectService Method
                • OnlineObjectService Class
                • OfflineObjectService Class
                  • Overview
                  • voltmx.sdk.dto.Column Class
                  • voltmx.sdk.dto.DataObject Class
              • Cache Service Response for Integration and Object Service
              • File Service Adapter APIs
              • Using Log SDK
              • Binary APIs
              • API Reference
              • Overview
              • Prerequisites
              • Downloading Volt MX Plain JS SDK
              • Initializing the JS Client SDK
              • Invoking an Identity Service
              • Invoking an Integration Service
              • Invoking a Configuration Service
              • Invoking a Logic Service
              • Invoking a Metrics Service
              • Overview
              • Creating a Cordova App
              • Initializing the Cordova Client SDK
              • Setting UserID
              • Invoking an Identity Service
              • Invoking an Integration Service
              • Invoking a Configuration Service
              • Invoking a Messaging Service
              • Invoking a Reporting Service
              • Invoking a Metrics Service
                • Overview
                • getObjectService Method
                • OnlineObjectService Class
                • OfflineObjectService Class
                  • Overview
                  • voltmx.sdk.dto.Column Class
                  • voltmx.sdk.dto.DataObject Class
              • Overview
              • Prerequisites
              • Downloading Volt MX iOS SDK
              • Configuring the Framework to your Project
              • Initializing the iOS Client SDK
              • Invoking an Identity Service
              • Invoking an Integration Service
              • Invoking a Messaging Service
                • Overview
                • getObjectService Method
                • OnlineObjectService Class
              • Invoking a Metrics Service
              • Overview
              • Prerequisites
              • Downloading Volt MX Android SDK
                • Overview
                • Configuring voltmx-sdk.jar to Project - Android Studio
              • Initializing the Android Client SDK
              • Invoking an Identity Service
              • Invoking an Integration Service
              • Invoking a Messaging Service
              • Invoking a Sync Service
                • Overview
                • getObjectService Method
                • OnlineObjectService Class
              • Invoking a Metrics Service
              • Overview
              • Prerequisites
              • Downloading the .NET (Visual Studio) SDK
              • Initializing the .NET (Visual Studio) SDK
              • Invoking an Identity Service
              • Invoking an Integration Service
              • Invoking a Metrics Service
                • Overview
                • Creating an ObjectService Object
                • ObjectService Class
                • DataObject Class
          • Settings - Cloud
          • Settings - On-premises
          • Reports
          • Support
          • Telemetry
          • Tutorials
          • Appendix - Sync Strategy
            • Overview
            • Log Services
          • Appendix - Frequently Asked Questions (FAQs
          • Limitations
          • Overview
          • Volt MX Foundry OAuth Sample App
          • Overview
            • Overview
              • Overview
              • Introduction
                • Overview
                • HCLFoundry.OfflineObjects.drop
                • HCLFoundry.OfflineObjects.executeSelectQuery
                • HCLFoundry.OfflineObjects.incrementalSetup
                • HCLFoundry.OfflineObjects.reset
                • HCLFoundry.OfflineObjects.rollback
                • HCLFoundry.OfflineObjects.setup
                • HCLFoundry.OfflineObjects.startSync
                • Overview
                • < objectService >.cancelSync
                • < objectService >.clearOfflineData
                • < objectService >.getSdkObjectByName
                • < objectService >.rollback
                • < objectService >.startSync
                • Overview
                • < object >.cancelSync
                • < object >.clearOfflineData
                • < object >.create
                • < object >.delete
                • < object >.deleteByPK
                • < object >.get
                • < object >.getBinary
                • < object >.getBinaryStatus
                • < object >.getPendingRecordsForUpload
                • < object >.markForUpload
                • < object >.rollback
                • < object >.startSync
                • < object >.update
                • < object >.updateByPK
              • Appendix
              • Platform-Specific-Error-Message
              • Introduction
                • Overview
                • Configuring Volt MX Foundry Server
                • Configuring Client Application
              • Overview
              • Offline Objects Support in Windows 10 (Beta)
              • Application Level APIs
              • Object Level APIs
              • Sample Apps
              • Introduction
              • Overview
              • Architecture
              • Prerequisites
              • How to Configure Offline Objects
              • Sample Apps
              • Offline Objects with Generated Object Models
              • Setting Up the Sync Environment
              • CRUD API
              • Supported Synchronization Levels
              • Background Sync
              • Request Params
              • Filter Support
              • Hierarchical Uploads and Downloads
              • Clear Offline Data
              • Drop, Reset and Rollback
              • Conflict Resolution Policy
              • Binary Download
              • Cascade Delete
              • Device Database Encryption
              • Sync Stats and Progress Callback
                • Overview
                • Batching
                • Cancel Sync
                • Sync Configuration Policies
                • Incremental Setup
                • Mark for Upload
                • Track Changes
                • Track Intermediate Changes
                • Upload Cache
              • Best Practices
              • Performance Tuning
              • Limitations of Offline Objects
              • Troubleshooting
              • Overview
              • Preface
              • PetStore Management Sample
            • Overview
              • Overview
              • Objective
              • Volt MX Engagement Services Terminology and Console
              • Navigating Volt MX Engagement Services Console
              • Creation and Configuration of the Test App
              • Configuration of Email and SMS Channels in the Engagement Server
              • Installation of the Engagement Demo App
              • Introduction
              • Overview
              • Creating a JPush Account and an Android Application in the JPush Console
              • Configuring JPush in Volt MX Foundry Engagement Services Console
              • Introduction
              • Overview
              • Generating an Apple Push Notification Service (APNS) Certificate
              • Generating the Provisioning Profile
              • Downloading and Configuring the Engagement Services Demo Client Application
              • Installing the Configured Engagement Services Demo Client Application on an iOS Device
              • Configuring the Engagement Services Demo Application using Engagement Services Console
              • Configuring Email and SMS Providers using Engagement Services Console
              • Subscribing to Ad hoc Notifications using Engagement Services Demo Application
              • Sending Ad hoc Email, SMS and Push Notifications
              • Introduction
              • Overview
                • Overview
                • Adding a Beacon
              • Adding a Segment to Use with a Campaign
              • Configuring and Executing a Campaign
              • Overview
                • Overview
                • Searching Data in Volt MX Foundry Engagement Services
                • Engagement Services using Mobile Backend as a Service (MBaaS
                • Foundry App Versioning with Engagement Artifacts
              • Log in to Volt MX Foundry Engagement Services
                • Overview
                • Use Case Scenario: One
                • Use Case Scenario: Three
                • Use Case Scenario: Four
                • Use Case Scenario: Five
                • Overview
                • Dashboard
                  • Overview
                    • Overview
                    • Adding App Info
                      • Overview
                        • Overview
                        • Generating an Apple Push Notification Service (APNS) Certificate
                        • Renew the Apple Push Notification Service (APNS) Certificate
                        • Overview
                        • Generating FCM Server Key and Sender ID
                        • Creating a JPush API Key and Master Secret
                      • Windows
                        • Overview
                        • Generating FCM Server Key and Sender ID for Web
                      • App API Key
                  • Migration from GCM to FCM
                  • Publishing an Application
                  • Viewing an Application
                    • Overview
                    • Modifying Basic Details
                    • Modifying Platform Details
                  • Deleting an Application
                  • Overview
                    • Overview
                    • Viewing a Device
                    • Activating or Inactivating a Subscription from a Device
                    • Deleting a Subscription
                    • Overview
                    • Adding a User
                    • Adding Dynamic User Attribute Types
                    • Viewing a User
                    • Modifying a User
                    • Deleting a User
                    • Importing Users
                    • Activating or Inactivating a User
                    • Subscribing or Unsubscribing a Channel
                • Overview
                  • Overview
                    • Overview
                      • Overview
                      • iOS Platform
                      • Android Platform
                      • Windows
                      • Web
                      • Modifying a Push Message
                      • Deleting a Push Message
                      • Overview
                      • Overview
                    • Entering Attribute Values
                      • Overview
                  • Pending Campaigns
                  • Pausing Campaigns
                  • Resuming Campaigns
                  • Setting Message Priority
                  • Modifying Campaigns
                  • Stopping/Terminating Campaigns
                  • Restarting Campaigns
                  • Viewing Campaign Reports
                  • Deleting Campaigns
                  • Overview
                    • Overview
                      • Overview
                      • iOS Platform
                      • Android Platform
                      • Windows
                      • Web
                      • Modifying a Push Message
                      • Deleting a Push Message
                      • Overview
                      • Overview
                      • Overview
                    • API Payload
                    • Setting Message Priority
                  • Activating Events
                  • Modifying Events
                  • Reactivating Modified Events
                  • Exporting Events
                  • Importing Events
                  • Viewing Events Reports
                  • Deleting Events
                  • Overview
                    • Overview
                    • User
                    • iOS Platform
                    • Android Platform
                    • Windows
                    • Web
                    • Segment
                    • Upload Users CSV File
                    • Send Message
                    • Overview
                    • Segment
                    • Send Message
                    • Overview
                    • Segment
                    • Send Message
                    • Overview
                    • User
                    • Segment
                    • Send Message
                  • Overview
                  • Adding Segments
                  • Modifying Segments
                  • Deleting Segments
                    • Overview
                    • Use Case Scenario: One
                    • Use Case Scenario: Two
                    • Last Active Date
                  • Overview
                    • Overview
                    • Adding Geofences
                    • Importing Geofences
                    • Exporting Geofences
                    • Modifying Geofences
                    • Deleting Geofences
                    • Overview
                    • Adding Beacons
                    • Modifying Beacons
                    • Deleting Beacons
                • Overview
                  • Overview
                    • Overview
                    • Adding Push Templates
                    • Modifying Push Templates
                    • Exporting Push Templates
                    • Importing Push Templates
                    • Deleting Push Templates
                    • Overview
                    • Adding Passbook Templates
                    • Modifying Passbook Templates
                    • Exporting Passbook Templates
                    • Importing Passbook Templates
                    • Deleting Passbook Templates
                    • Overview
                    • Adding Email Templates
                    • Modifying Email Templates
                    • Exporting Email Templates
                    • Importing Email Templates
                    • Deleting Email Templates
                    • Overview
                    • Adding SMS Templates
                    • Modifying SMS Templates
                    • Exporting SMS Templates
                    • Importing SMS Templates
                    • Deleting SMS Templates
                  • Overview
                  • General
                    • Overview
                    • Adding User Attributes
                    • Modifying User Attributes
                  • Audit Trail
                  • Health Check
                  • Logging
                  • Job Monitor
                  • Email Configuration
                  • SMS Configuration
                  • Pass Configuration
                  • Overview
                  • Push Queue
                  • Email Queue
                  • SMS Queue
                  • Pass Queue
                  • File Upload
                  • Inbound SMS
                • API Help
                  • Overview
                    • Overview
                    • Adding a Member
                    • Adding a Member from Volt MX Foundry Console
                    • Inactivating Members
                    • Modifying a Member
                    • Assigning or Unassigning Groups to a Member
                    • Assigning or Unassigning Permissions to a Member
                    • Resetting a Member Password
                    • Deleting a Member
                    • Overview
                    • Adding a Group
                    • Modifying a Group
                    • Assigning or Unassigning Users to a Group
                    • Assigning or Unassigning Permissions to a Group
                    • Deleting a Group
              • Provisioning Engagement Server in starter version of Volt MX Foundry
              • Purging Script for Engagement Services
              • Best practices for Push Notifications in the Engagement Server
              • Important Considerations for Windows Phone
              • Introduction
              • Overview
              • Configuring Email and SMS Service Providers Using Engagement Services Console
              • Configuring the Security Settings of Engagement Server
              • Configuring the Demo Application using Engagement Console
              • Downloading and Configuring the Demo Client Application on an Android Device
              • Sending Adhoc, Email, SMS and Push Notifications
              • Configuration of the Geoboundaries in the Engagement Sever
              • Geoboundary Monitoring and Receiving Notifications
                • Introduction
                • Objective
                • Introduction to Events and Event Invocation
                • Introduction to Location Based Segment Creation
                • Introduction to Campaigns using Segments
                • Next Steps
              • Homepage
              • Objective
                • Geoboundary Creation and Monitoring
                • Introduction to Geoboundary Terminology
                • Geoboundaries in the Engagement Server
                • Geoboundary Monitoring Flow
                • Engagement API Support for Geoboundary Monitoring
                • Demo App for Geoboundary Monitoring
                • Installing Engagement Demo Application
                • Geoboundary Monitoring
              • Next Steps
              • Overview
              • Introduction
                • Overview
                • Authentication
                  • Overview
                  • Access Management
                    • Overview
                    • Get Group Details by Pagination
                    • Get Group Details by ID
                    • Get All Group Details
                    • Create Group
                    • Modify Group
                    • Delete Group
                    • Overview
                    • Get User Details by Pagination
                    • Get User Details by ID
                    • Get All User Details
                    • Create User
                    • Modify User
                    • Delete User
                    • Overview
                    • Get Details(General
                    • Modify Details(General
                    • Get Campaign Types by Pagination
                    • Get CampaignType by ID
                    • Create Campaign Type
                    • Modify CampaignType
                    • Delete Campaign Type
                    • Get Event Types by Pagination
                    • Get Event Types by ID
                    • Create Event Type
                    • Modify Event Type
                    • Delete Event Type
                    • Get All Audience Attributes by Pagination
                    • Get Audience Attribute by ID
                    • Create Audience Attribute
                    • Modify Audience Attribute
                    • Get All File Upload Statuses
                    • Get File Upload Status by ID
                    • Get File Errors by Pagination
                    • Get Basic Details
                    • Create/Modify Basic Details
                    • Create Mail Configuration
                    • Test Mail Configurations
                    • Get Mail Configurations
                    • Create SMS Configurations
                    • Get SMS Config
                    • Get Voice SMS Configuration Details
                    • Update SMS Config
                    • Update Voice SMS Configuration
                    • Get All Config
                    • Update Config Resources
                    • Overview
                    • All App Details by Pagination
                    • Add App API Key
                    • Create App
                    • Delete App
                    • Delete App API Key
                    • Download Windows MPNS Certificate
                    • Get App API Key(s
                    • Get App API Key Details
                    • Get App Details by ID
                    • Get Certificate Expiration
                    • Modify Android Details
                    • Modify Web Details
                    • Modify App
                    • Modify App API Key
                    • Modify Apple Details
                    • Modify BlackBerry Details
                    • Modify Windows Details
                    • Publish App
                    • Unpublish App
                    • Overview
                    • Get All Beacons
                    • Get Beacon by ID
                    • Create Beacon
                    • Modify Beacon by ID
                    • Delete Beacon
                    • Update List of Beacons for a Device
                    • Overview
                    • Get All Campaigns by Pagination
                    • Get Campaign Details by ID
                    • Create Campaign
                    • Modify Campaign
                    • Delete Campaign
                    • Start Campaign
                    • Terminate Campaign
                    • Validate Campaign Criteria
                    • Create Campaign with Upload Images
                    • Modify Campaign with Upload Images
                    • Pause Campaign
                    • Resume Campaign
                    • Overview
                    • Email APIs
                    • Email API with Segments
                    • Fetch All Email API
                    • Get Full Content
                    • Cancel Email
                    • Status of Email Delivery
                    • Overview
                    • Create Email Template
                    • Delete Email Template
                    • Export Email Templates
                    • Get Email Template Details by ID
                    • Get Email Templates by Pagination
                    • Import Email Templates
                    • Update Email Template
                    • Overview
                    • Activate Event
                    • Create Event
                    • Create Pass Event with Upload Images
                    • Deactivate Event
                    • Delete Event
                    • Event Message Request Payload with Audience Properties
                    • Event Message Request Payload with Common Properties
                    • Event Payload
                    • Event Push Message
                    • Export Events
                    • Get All Event Details by Pagination
                    • Get Event Details by ID
                    • Import Events
                    • Modify Event
                    • Modify Pass Events with Upload Images
                    • Overview
                    • Create Geolocation
                    • Delete All Geolocations
                    • Delete Geolocation by ID
                    • Delete Selected Geolocations
                    • Export All Geolocations
                    • Find Nearest Location
                    • Get All Geolocations
                    • Get Geolocation by ID
                    • Import Bulk Geolocation
                    • Modify Geolocation by ID
                    • Update Geolocation of a Device
                    • Overview
                    • Android
                    • Web
                    • Test JPush Connectivity
                    • Apple
                    • BlackBerry
                    • Windows 8 Credentials Validation
                    • Update Windows MPNS Cert details
                    • Delete Windows MPNS Cert Details
                    • Health Check
                    • Overview
                    • Get All Pass Certificates
                    • Get Pass Certificate by ID
                    • Create Pass Certificate
                    • Modify Pass Certificate by ID
                    • Delete Pass Certificate
                      • Overview
                      • Get Apple WWRD certificate
                      • Update Apple WWRD Certificate
                    • Overview
                    • Getting the All Serial Numbers for a Pass Associated with a Device
                    • Getting the Latest Version of a Pass
                    • Registering a Device to Receive Push Notifications for a Pass
                    • Unregistering a Device for not to Receive Push Notifications for a Pass
                    • Logging Errors
                    • Overview
                    • Get Pass Request Meta Data
                    • Get Pass Status
                    • Get Pass Content
                    • Get Pass Request Meta Data of an Audience
                    • Pass Distribution
                    • Pass Distribution with Image Upload
                    • Pass Distribution with Import pkPass
                    • Update Pass
                    • Update Pass API with Image Uploads
                    • Update Pass API with pkPass Import
                    • Cancel Pass API
                    • Overview
                    • Create Pass Template
                    • Create Pass Template with Upload Images
                    • Delete Pass Template
                    • Export Pass Templates
                    • Get All Pass Templates
                    • Get Pass Template by ID
                    • Import Pass Templates
                    • Modify Pass Template by ID
                    • Modify Pass Template by ID with Upload Images
                    • Overview
                    • Get Message Status by Request ID
                    • Push Message
                    • Update Push Open Status to Volt MX Foundry Messaging
                    • Broadcasting
                    • Broadcast Push Message with Filters
                    • Bulk Push
                    • Get Rich Content
                    • Send Rich Push
                    • Fetch Message Content from Volt MX Foundry Engagement Services
                    • Fetch All Messages from Volt MX Foundry Engagement Services
                    • Fetch Push Messages
                    • Fetch Push Status
                    • Fetch Push Sent Payload
                    • Cancel Scheduled Messages from Volt MX Foundry Engagement Services – First Method
                    • Cancel Scheduled Messages from Volt MX Foundry Engagement Services - Second Method
                    • Overview
                    • Create Push Message Template
                    • Delete Push Message Template
                    • Export Message Templates
                    • Get All Push Message Templates
                    • Get Push Message Template by ID
                    • Import Message Templates
                    • Modify Push Message Template
                    • Overview
                    • Get All Segments by Pagination
                    • Get Segment by ID
                    • Create Segment
                    • Modify Segment
                    • Delete Segment
                    • Validate Segment Criteria
                    • Create Segment with Beacon Criteria
                    • Overview
                    • Send SMS API using Audience ID
                    • Send SMS API without Audience Member Registration
                    • Send SMS API using Mobile Number
                    • Fetch All SMS API with Mobile Number
                    • Fetch All SMS API with Audience ID
                    • Get SMS Config
                    • Get Voice SMS Configuration Details
                    • Update SMS Config
                    • Update Voice SMS Configuration
                    • Get Full Content
                    • Cancel Message
                    • Engagement Services Inbound Format
                    • Inbound Status API
                    • Add Inbound Number
                    • Modify Inbound Number
                    • Get Inbound Number
                    • Get All Numbers
                    • Delete Inbound Number
                    • Add Inbound Command
                    • Modify Inbound Command
                    • Get Inbound Command
                    • Get All Commands
                    • Fetch SMS Status
                    • Delete Inbound Command
                    • Overview
                    • Create SMS Template
                    • Delete SMS Template
                    • Export SMS Templates
                    • Get SMS Template Details by Id
                    • Get SMS Templates by Pagination
                    • Import SMS Templates
                    • Modify SMS Template
                    • Overview
                    • Get Subscriber Details by Page
                    • Get Subscriber Details by ID
                    • Create / Modify Subscriber
                    • Activate Subscriber
                    • Inactivate Subscriber
                    • Delete Subscriber
                    • JPush Subscription
                    • Get All Subscriber Details using Combinations of Data
                    • Overview
                    • Create Users
                    • Delete Users
                    • Get All Users by Pagination
                    • Get File Errors by Pagination
                    • Get User Details by ID
                    • Get User Details by Subscription ID
                    • Import Users
                    • Modify Users
                    • Subscribe Users (Create or Update
                    • Unsubscribe Users or Delete Users
                    • Update User using a New Patch
                    • Overview
                    • Overview
                    • Subscription
                    • Unsubscription
                    • Events Push Payload
                    • Fetch Message Content from Engagement Services
                    • Fetch All Messages from Engagement Services
                    • Cancel Scheduled Messages from Engagement Services
                    • Update Geo Location of Device to Engagement Services
                    • Update Push Open Status to Engagement Services
                    • Bulk Message Upload
                    • Broadcasting
                    • Event Message Request Payload with Common Properties
                    • Event Message Request Payload with Audience Properties
                    • Send Rich Push (legacy
                • Overview
                • pom.xml File
              • Volt MX Client-side JavaScript Functions
              • Volt MX JavaScript APIs
              • Introduction
              • Overview
              • Creating an Event
              • Push Message
              • Setting Event Message Priority
              • API Payload
              • Introduction
              • Overview
              • Configuring the Engagement Server to send 2way SMS
              • Initiating an Outbound 2 way SMS via Adhoc Messaging
              • Responding to the 2 way SMS Request of the User
          • Overview
            • Overview
              • Introduction
              • Preface
                • Overview
                • Volt MX Foundry
                • License Activation Guidelines
              • License Deactivation
              • License Validity
              • Overview
              • Preface
              • Console Access Control
            • Overview
              • Overview
              • Standard Reports Configuration
              • Reports Filter Criteria
              • Application Activity Reports
              • User Activity Reports
              • Location Reports
              • Server Requests and Performance Reports
              • Sync Services Reports
              • Events and User Journey Reports
              • API Management Reports
              • Offline Objects Reports
              • Analytics Dashboard
              • Overview
              • Custom Metrics
                • Overview
                • Implementing Custom Metrics in Volt MX Iris
                • Implementing Custom Metrics in Volt MX Server
              • Custom Metrics APIs
                • Overview
                  • Overview
                    • Overview
                    • Standard Metrics V8.0 - DataSets Dictionary
                    • Standard Metrics V7.2 - DataSets Dictionary
                    • Standard Metrics and Events - DataSets Dictionary
                    • Standard Metrics - DataSets Dictionary
                    • Custom DataSets Dictionary
                  • Table Report User Interface
                  • Chart Report User Interface
                  • Crosstab Report User Interface
                • Saving Custom Reports and Ad Hoc Views
                • Running Custom Reports
                • Editing Ad Hoc Views
                • Advanced Actions in Custom Reports
                • Overview
                • Overview of Dashboard Designer
                • Dashboard Designer Interface
                • Dashlets and Dashboard Elements
                • Dashboard Properties
                • Dashlet Properties
                • Working with Custom Dashboards
            • Volt MX Analytics & Reporting On-Premises FAQs
              • Overview
              • Preface
              • Prerequisites
              • How to Set Up the JasperReports Server
              • How to Install JasperReports Server WAR file using js-install Scripts
              • How to Upgrade the JasperReports Server
                • Overview
                • How to Download and Import a Package to the JasperReports Server
                • How to Set Up JNDI Data Sources
                • How to Configure PhantomJS and RequireJS in JasperReports Server
                • How to Start or Stop JasperReports Server
                • How to Run Reports
              • How to Configure Volt MX Foundry in the JasperReports Server
              • Overview
              • Volt MX Foundry Analytics Mobile App
              • Overview
              • Preface
              • Types of Application Events
              • Application Performance Monitoring
              • Tracking User Journey
              • Enabling Auto Event Capture
              • Tuning Auto Event Capture
              • Reporting on Events
              • Funnel Reports
              • APM Extension/Third Party APM Integration
          • Overview
          • Launching App Services
          • Web Apps
            • Overview
            • Service
            • Environment
            • Server Events
          • Integration Services
          • Object Services
          • Orchestration Services
          • Workflow Services
          • Rules
            • Overview
            • Scheduling Job APIs
          • Health Check
            • Overview
            • Standard Logs
            • Trace Logs
            • Overview
            • Configurable Parameters
            • Runtime Configuration
            • Environment Details
            • SSL Certificates
          • Downloads
            • Overview
            • Using Basic Reports
            • Using Legacy Reports
            • Configuring Report Settings
          • Introduction
          • DevOps
          • App Factory CI/CD Runtime
            • Prerequisites
            • Additional Requirements
            • Accessing the App Factory console
            • Creating an App Factory Project
            • Custom Hooks
            • External Authentication
          • Project Settings
            • Microservice Projects in App Factory
            • Scheduling a Microservice job
            • Running the ConfigureMS job
            • Build on Push for Microservice jobs
            • Overview
            • Versioning an Iris project in SCM
            • Building an Iris App
            • Scheduling an Iris build
            • Build on Push for Iris apps
            • Configuring Device Pools
            • Testing an App - TestNG
            • Testing an App - Jasmine
              • Overview
              • Environment Variables
            • Troubleshooting
            • Micro Apps - Best Practices
            • Overview
            • Versioning a Foundry project in SCM
            • Building a Foundry App
            • Building Java Dependencies
            • Scheduling a Foundry build
            • Build on Push for Foundry apps
            • Custom Hooks for Foundry jobs
            • Testing a Foundry app with the Cucumber Framework
              • Overview
              • Export a Foundry app
              • Import a Foundry app
              • Publish a Foundry app
              • Migrate a Foundry app
              • Publish a Web App
              • Triggering a Foundry Task
            • Overview
            • Running Flyway jobs
            • Scheduling a Flyway job
            • Build on Push for Flyway jobs
          • Upgrading a Project
          • Managing Credentials
          • Results
          • Known Issues
          • Limitations
          • Configuration
          • Frequently Asked Questions (FAQs)
          • Introduction
          • Overview
          • Software Requirements
          • Deployment Topology
          • Development Topology
          • App Server Sizing
          • Database Growth Sizing
          • Session Management
            • Overview
            • Volt MX Foundry Components Covered
            • Secure Server Checklist
            • Use a Hardened database for Volt MX Foundry
            • Users and Account roles
            • Default Services and Apps Permissions
            • Operation Security Level for Integration and Orchestration services
            • Verb Security Level for Object Services
            • Backend Credentials and Session Security
            • User Credential Security
            • Idle Session Timeout for Volt MX Foundry App
            • Password Policy for Volt MX Foundry users
            • Hardening Volt MX Foundry Integration (Middleware
            • Hardening Volt MX Foundry Identity
            • Preventing Tomcat Version from Error Pages
            • Disable Concurrent Session
            • Protection against automated attacks
            • Restrict Tomcat Manager to Localhost
            • Secure your Cookies (Secure and HttpOnly flags
            • Redirect Traffic from Non-Secure Protocol (HTTP) to Secure Protocol (HTTPS
            • Enabling Secure flag for CacheID Cookie
            • Configuring OWASP secure headers for SPA/Desktop apps
            • Disable Caching for Sensitive Middleware Services
            • Security Fixes for the External App Servers
            • Checklist for Volt MX Foundry Deployment
            • Case Study I
            • Case Study II
          • FAQs and Troubleshooting
        • Volt MX Analytics & Reporting Cloud FAQs
          • Introduction
            • Overview
            • Properties in Volt MX Foundry Integration Service
            • Other Features
            • Java Messaging Service Issues
          • Volt MX Foundry Integration Error Codes

    Introduction

    • Prerequisites
      • System Requirements
      • Download Volt MX Iris
    • Install Volt MX Iris
      • Configuring Volt MX Iris to use a Proxy server
        • Basic Proxy
        • NTLM Proxy
        • Custom NTLM Proxy
        • White-list Essential Domains
    • Post Installation Tasks
      • Launching Volt MX Iris
    • Update Volt MX Iris
    • FAQs

    Copyright © 2021 - 2024, HCL America, Inc. | Privacy Statement | Terms of Use
    Made with Material for MkDocs
    • Facebook
    • LinkedIn
    • Twitter
    • Youtube
    Please report problems with this documentation by opening issues in Github. Can't find a topic? Check the legacy documentation here.