Skip to content
HCL Volt MX Documentation V9.2
Properties
Initializing search
HCL-TECH-SOFTWARE/volt-mx-docs
HCL Volt MX Documentation V9.2
HCL-TECH-SOFTWARE/volt-mx-docs
Introducing Volt MX
Introducing Volt MX
Introducing Volt MX
What's New
What's New
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
App Platform
App Platform
Overview
Tutorials
Tutorials
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
Iris
Iris
Fundamentals
Installing Iris
Installing Iris
Overview
Volt MX Iris Supported OSes, Devices, and Browsers
Volt MX Iris Supported OSes, Devices, and Browsers
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)
Installing Volt Iris V9 on Macintosh
Installing Volt Iris V9 on Macintosh
Introduction
Prerequisites
Install Volt MX Iris
Post Installation Tasks
Update Volt MX Iris
FAQs
Installing Volt Iris V9 on Windows
Installing Volt Iris V9 on Windows
Introduction
Prerequisites
Install Volt MX Iris
Post Installation Tasks
Update Volt MX Iris
FAQs
Iris tutorials
Iris tutorials
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
Iris User Guide
Iris User Guide
Introduction
Supported Digital Channels
Hikes
Third-Party Licenses
Configuring Your Computer
Configuring Your Computer
Overview
Hardware and Software Requirements
Install Volt MX Iris
Install platform SDKs and their emulators
Install platform SDKs and their emulators
Platform SDKs
iOS SDK and simulator
Android SDK
Android SDK
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
The Volt MX Iris default perspective
The Volt MX Iris default perspective
Overview
Quick Launch Bar
Project Explorer
Iris Canvas
Properties Editor
Account Information
Library Explorer
Console
Check for Updates
Collab
Version Control
Designing an Application
Designing an Application
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
Create, Migrate, or Import a Project
Create, Migrate, or Import a Project
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
Integration with Design Tools
Integration with Design Tools
Overview
Integration with Sketch
Import a Volt MX Iris Project
Export a Volt MX Iris Project
Create the Storyboard of your App
Export and Import Resources
Export and Import Resources
Overview
Export Internationalization Resources
Import Internationalization Resources
Export and Import Themes
Export and Import Fonts
Create Wearables Screens
Create Wearables Screens
Overview
Apple Watch
Apple Watch
Overview
Forms
Notifications
Glances
Android Wear
Populate Screens with Widgets
Populate Screens with Widgets
Overview
Container Widgets
Container Widgets
Overview
FlexContainer
FlexScrollContainer
TabPane
Tab
Basic Widgets
Basic Widgets
Overview
Button
Calendar
CheckBoxGroup
DataGrid
Image
Label
ListBox
RadioButtonGroup
RichText
Slider
TextArea2
TextBox2
Advanced Widgets
Advanced Widgets
Overview
Browser
Cordova Browser
Camera
Map
Phone
PickerView
Segment2
Switch
Video
Add Watch Widgets
Add Watch Widgets
Overview
Watch Container Widget
Group Widget
Watch Basic Widgets
Watch Basic Widgets
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
Watch Advanced Widgets
Watch Advanced Widgets
Overview
Map Widget for Watch
Switch Widget for Watch
Using the Native UI Container
Using Custom Widgets
Using Custom Widgets
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
Using Native Function APIs and Widgets
Using Native Function APIs and Widgets
Overview
Add or Import Native Function APIs
Using the Native UI Container
Add Actions
Add Actions
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
Understanding Skins
Understanding Skins
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
Fork a Skin
Fork a Skin
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
Understanding Themes
Understanding Themes
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
Add and Manage Images and Other Media
Add and Manage Images and Other Media
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
Time and Effort Savers
Time and Effort Savers
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
Creating Applications with Components
Creating Applications with Components
Working with Components
Components Overview
Using Components
Creating a Component
Adding Functionality
Adding Functionality
Overview
Connect to Services
Connect to Services
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
Connect to Back-End Services by using Data & Services Panel
Connect to Back-End Services by using Data & Services Panel
Overview
Use Data & Services Panel Features
Search Engine Optimization for Web Apps
Publish a Project to Volt MX Foundry
Apply Application Security
Apply Application Security
Overview
Build Runtime Security in the Application
Certificate Pinning
Public Key Pinning
Protect the Application Binaries
Protect the Application Binaries
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
Building and Viewing an Application
Building and Viewing an Application
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
Testing and Debugging an Application
Testing and Debugging an Application
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
Appendix A: Internationalization
Appendix A: Internationalization
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
Application Design and Development Guidelines
Application Design and Development Guidelines
Overview
Preface
Design Guidelines Overview
UI Guidelines
UI Guidelines
Overview
List of UI elements
Guidelines for Application Icon
Guidelines for Splash Screen
Guidelines for App Menu
Guidelines for App Menu
Overview
iOS
Android
BlackBerry
Windows
General Guidelines for App Menu
Configure an App Menu
App Menu Examples
Guidelines for Fonts
Guidelines for Fonts
Overview
For Rich Client Applications
For Mobile Web Applications
Guidelines for Title Bar or Navigation Controls
Guidelines for Title Bar or Navigation Controls
Overview
iOS
Android
Configure a Title Bar on a Form (iPhone
Configure Device Back on a Form (Android / BlackBerry
Title Bar Examples
Guidelines for Progress Indicators (Rich Clients
Guidelines for Progress Indicators (Rich Clients
Overview
Create a Progress Indicator
Create a Blocking Indicator
Progress Indicator or Blocking UI Examples
Guidelines for Pop-Ups or Alerts
Guidelines for Alignments (Margins & Paddings
Guidelines for Alignments (Margins & Paddings
Overview
Proper Margins and Padding Examples
Guidelines while using Images
Guidelines while using Segment Widget
Guidelines while using Segment Widget
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
Guidelines while using Map Widget
Guidelines while using Map Widget
Overview
Map Widget Examples
Guidelines while using Browser Widget
Guidelines for Calendar Widget
Landscape vs. Portrait View
Landscape vs. Portrait View
Overview
Achieve a Uniform UI in both Orientation
Configure a Screen for Both Portrait and Landscape
Mobile Web Apps Only
General UI guidelines
General UI guidelines
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
Coding Guidelines
Coding Guidelines
Overview
Foreign Function Interface (FFI)
Foreign Function Interface (FFI)
Overview
iPhone
Andorid
BlackBerry
Performance Management Guidelines
Memory Management Guidelines
Memory Management Guidelines
Overview
form.destroy
Global Variables
Device-side Security Guidelines
Pre/Post Processors and URL Provider Guidelines
Application Development Guidelines
Application Development Guidelines
Overview
Coding Standards
Basics of JavaScript
Accessibility (508 Compliance)
Accessibility (508 Compliance)
Overview
Importance of Accessibility
Accessibility Compliance Guidelines for Web
Enable Accessibility in Iris
Widget Navigation
Accessibility: Platform Specific Limitations
Flex Layout Guidelines
Flex Layout Guidelines
Overview
Animation & Flex Layout Limitations
Flex Backwards Compatibility
Flex Pseudocode Examples
Flex Layout Animation
Platform Specific Limitations
App Submission Guidelines
Common UI Issues
Volt Iris APIÂ Developers Guide
Volt Iris APIÂ Developers Guide
Introduction
Accelerometer API
Accelerometer API
Overview
voltmx.accelerometer Namespace
Action Sheet API for iOS
Action Sheet API for iOS
Overview
ActionItem Object
ActionItem Object Properties
ActionItem Function
ActionSheet Object
ActionSheet ObjectMethods
ActionSheet Function
Alert API
Alert API
Overview
voltmx.ui.Alert Function
Animation API
Animation API
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
App Extension API for iOS
App Extension API for iOS
Overview
voltmx.actionExtension Namespace
voltmx.iMessageExtensions Namespace
voltmx.intentExtension Namespace
voltmx.notificationContentExtension Namespace
voltmx.shareExtensions Namespace
voltmx.todayExtension Namespace
Application API
Application API
Overview
voltmx.application Namespace
Application Settings API
Application Settings API
Overview
voltmx.application.settings Namespace
Automation API
Automation API
Overview
voltmx.automation Namespace
Background Agent API
Background Agent API
Overview
voltmx.backgroundtasks Namespace
Badge API
Badge API
Overview
Functions
Battery API
Battery API
Overview
Constants
Functions
Beacon API
Beacon API
Overview
com.voltmx.Beacon
com.voltmx.BeaconManager
BeaconRegion Object
com.voltmx.PeripheralManager
Bookmark and Refresh API
Caching API
Caching API
Overview
voltmx.net.cache namespace
Camera API
Camera API
Overview
voltmx.camera Namespace
Charm Setting API
Charm Setting API
Overview
Functions
Client Authentication API
Core Haptics
Core Haptics
Overview
voltmx.haptics Namespace
Communication API for React Native App
Communication API for React Native App
Overview
voltmx.reactNative Namespace
React Native APIs
Cryptography APIs
Cryptography APIs
Overview
voltmx.crypto Namespace
Drag and Drop API
Drag and Drop API
Overview
voltmx.dragDrop Namespace
ForceTouch API
ForceTouch API
Overview
voltmx.forcetouch Namespace
Functional Modules API
Functional Modules API
Overview
voltmx.modules Namespace
GeoLocation API
GeoLocation API
Overview
voltmx.location Namespace
Gesture API
Gesture API
Overview
Functions
Google Mobile Services APIs
Google Mobile Services APIs
Overview
SafetyNet APIs
Security Provider APIs
Update and Error Handling APIs
voltmx.gms Namespace
Image API
Image API
Overview
Image Object
Filter Object
voltmx.filter Namespace
voltmx.image Namespace
Image Classification API
Image Classification API
Overview
ImageClassifier Object
voltmx.ml Namespace
In-App Updates API
In-App Updates API
Overview
Constants and Functions
Input and Output API
Input and Output API
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
Internationalization API
Internationalization API
Overview
voltmx.i18n Namespace
Keychain API
Keychain API
Overview
voltmx.keychain Namespace
Language API
Language API
Overview
voltmx.lang Namespace
Live Tiles API
Live Tiles API
Overview
Functions
Local Authentication API
Local Authentication API
Overview
voltmx.localAuthentication Namespace
Map API
Map API
Overview
voltmx.map Namespace
Map Styling API
Math API
Math API
Overview
math Namespace
Media API
Media API
Overview
voltmx.media Namespace
media Object
media Object
Overview
Methods
Properties
record Object
record Object
Overview
Methods
voltmx.screenrecorder Namespace
Network API
Network API
Overview
Network Calls
Asynchronous Network Calls
voltmx.net Namespace
Notifications API
Notifications API
Overview
Local Notifications
Local Notifications
Overview
voltmx.localnotifications Functions
voltmx.localnotifications Properties
Push Notifications
Push Notifications
Overview
voltmx.push Namespace
Notification Settings
Notification Settings
Overview
voltmx.notificationsettings Namespace
Offline Data Access API
Offline Data Access API
Overview
voltmx.store Namespace
voltmx.db Namespace
voltmx.ds Namespace
Operating System API
Operating System API
Overview
voltmx.os Namespace
Objects
DeviceInfo
Passbook API
Passbook API
Overview
PassLibrary Object
Pass Object
AddPassesViewController Object
Payment API
Payment API
Overview
voltmx.payment Namespace
Phone API
Phone API
Overview
voltmx.contact Namespace
voltmx.phone Namespace
Request App Review API
Request App Review API
Overview
requestReviewFlow Function
requestReview Function
Runtime Permission API
Runtime Permission API
Overview
Functions
Shared App Group Container API for iOS
SignInWithApple API
SignInWithApple API
Overview
Functions
Standard Volt MX API
Standard Volt MX API
Overview
voltmx Namespace
String API
String API
Overview
voltmx.string Namespace
Sync API
Sync API
Overview
sync Namespace
Sync Object
Theme API
Theme API
Overview
voltmx.theme Namespace
Threading API
Threading API
Overview
Functions
Timer API
Timer API
Overview
voltmx.timer Namespace
Toast API
Toast API
Overview
Functions
Toast Object
UI API
UI API
voltmx.ui Namespace
Worker Thread API
Worker Thread API
Overview
voltmx.worker Namespace
WorkerThread Object
Deprecated/Unsupported APIs
Appendix: Exceptions
Appendix: General FAQ
Appendix: JavaScript FAQ
Appendix: Preprocessor Directives
Appendix: SQLite
Appendix: Background Jobs in iOS 7
Appendix: Background Jobs in iOS 7
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
Long Running Network Tasks
Long Running Network Tasks
suspend
resume
getTaskState
getSession
Native Function API Developers Guide
Native Function API Developers Guide
Overview
Introducing the Native Function API
Native Function APIs for iOS
Native Function APIs for iOS
Overview
Updating Old Apps to Work with iOS 12 Security Enhancements
iOS Quick Start Guide
Using the Native Function API for iOS
Native Function API for iOS Reference
Native Function API for iOS Reference
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
iOS Examples
iOS Examples
Overview
Battery Status - Application Walkthrough
Using the Native Container Widget to Display iOS Controls
Generator
HealthKit
Apple Pay
ZipUnzip
Native Function APIs for Android
Native Function APIs for Android
Overview
Android Quick Start Guide
Using the Native Function API for Android
Native Function API for Android Reference
Native Function API for Android Reference
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
Android Examples
Android Examples
Overview
Battery Status - Application Walkthrough
Toast
JobScheduler
Near Field Communication
Speech
ZipUnzip
Iris Widget Programmer Guide
Iris Widget Programmer Guide
Overview
Widgets and API reference
Gesture Methods and 3D Touch
Widget Skins
Dynamic Skinning
Application Initialization Events
Widget Animation Using Flex Forms
Widget Animation Using Flex Forms
Overview
Example and Sample App
API Simplification
Masters
Widget Common Properties
Platform Specific Capabilities
Platform Specific Capabilities
iOS
Tool and Navigation bars for iOS
Platform Specific Limitations
Alert Widget
Alert Widget
Alert Widget Basics
Events
Methods
Properties
App Menu Widget
App Menu Widget
AppMenu Widget Basics
Methods
Properties
ARRenderer Widget
ARRenderer Widget
ARRenderer Widget Basics
Events
Methods
Properties
BottomSheet Widget
BottomSheet Widget
BottomSheet Widget Basics
Events
Methods
Properties
Browser Widget
Browser Widget
Browser Widget Basics
Events
Methods
Properties
Button Widget
Button Widget
Button Widget Basics
Events
Methods
Properties
Calendar Widget
Calendar Widget
Calendar Widget Basics
Events
Methods
Properties
Camera Widget
Camera Widget
Camera Widget Basics
Event
Methods
Properties
Canvas Widget
Canvas Widget
Canvas Widget Basics
Event
Methods
Properties
CheckBoxGroup Widget
CheckBoxGroup Widget
CheckBoxGroup Widget Basics
Events
Method
Properties
CollectionView Widget
CollectionView Widget
CollectionView Widget Basics
Events
Methods
Properties
CordovaBrowser Widget
CordovaBrowser Widget
CordovaBrowser Widget Basics
Events
Methods
Properties
DataGrid Widget
DataGrid Widget
DataGrid Widget Basics
DataGrid Templates
Events
Methods
Properties
FlexContainer Widget
FlexContainer Widget
FlexContainer Widget Basics
Flex Layout Rules
Flex Container Sample Code
Events
Methods
Properties
FlexForm Widget
FlexForm Widget
FlexForm Widget Basics
Flex Layout Rules
Example and Sample App
Using the Navigation Drawer
Events
Methods
Properties
FlexScrollContainer Widget
FlexScrollContainer Widget
FlexScrollContainer Widget Basics
Creating a FlexScrollContainer Using a Constructor: voltmx.ui.FlexScrollContainer
FlexScrollContainer Example
Events
Methods
Properties
Image Widget
Image Widget
Image Widget Basics
Events
Methods
Properties
Label Widget
Label Widget
Label Widget Basics
Events
Methods
Properties
ListBox Widget
ListBox Widget
ListBox Widget Basics
Events
Methods
Properties
Map Widget
Map Widget
Map Widget Basics
Templates
Events
Methods
Properties
Objects
MLCamera Widget
MLCamera Widget
MLCamera Widget Basics
Events
Methods
Properties
NativeContainer Widget
NativeContainer Widget
NativeContainer Widget Basics
Events
Methods
Properties
PDFView Widget
PDFView Widget
PDFView Widget Basics
Events
Methods
Properties
Properties
On this page
Syntax
Type
Read/Write
Remarks
Android limitations
SPA/Desktop Web limitations
Example 1
Example 2
Platform Availability
Syntax
Read/Write
Remarks
Example
Platform Availability
Syntax
Type
Read/Write
Remarks
Example
Platform Availability
Syntax
Type
Read/Write
Remarks
Example
Platform Availability
Syntax
Type
Read/Write
Remarks
Example
Platform Availability
Syntax
Read/Write
Remarks
Example
Platform Availability
Syntax
Read/Write
Remarks
Example
Platform Availability
Syntax
Read/Write
Remarks
Example
Platform Availability
Syntax
Read/Write
Remarks
Example
Platform Availability
Syntax
Read/Write
Remarks
Example
Platform Availability
Syntax
Read/Write
Remarks
Example
Platform Availability
Syntax
Read/Write
Remarks
Example
Platform Availability
Syntax
Type
Read/Write
Remarks
Example
Platform Availability
Syntax
Type
Read/Write
Example
Platform Availability
Syntax
Type
Read/Write
Remarks
Example
Platform Availability
Syntax
Read/Write
Remarks
Example
Platform Availability
Syntax
Type
Read/Write
Remarks
Example
Platform Availability
Syntax
Type
Read/Write
Remarks
Example
Platform Availability
Syntax
Type
Read/Write
Example
Platform Availability
Syntax
Read/Write
Example
Platform Availability
Syntax
Type
Read/Write
Example
Platform Availability
Syntax
Type
Read/Write
Example
Platform Availability
Syntax
Read/Write
Example
Platform Availability
Syntax
Type
Read/Write
Example
Platform Availability
Syntax
Type
Read/Write
Remarks
Example
Platform Availability
Syntax
Read/Write
Remarks
Example
Platform Availability
Syntax
Read/Write
Example
Platform Availability
Syntax
Read/Write
Example
Platform Availability
Syntax
Type
Read/Write
Remarks
Example
Platform Availability
Syntax
Read/Write
Example
Platform Availability
Syntax
Type
Read/Write
Example
Platform Availability
Syntax
Type
Read/Write
Remarks
Example
Platform Availability
Syntax
Type
Read/Write
Remarks
Example
Platform Availability
Syntax
Type
Read/Write
Remarks
Platform Availability
Syntax
Type
Read/Write
Remarks
Example
Platform Availability
Syntax
Type
Read/Write
Remarks
Example
Platform Availability
Phone Widget
Phone Widget
Phone Widget Basics
Events
Methods
Properties
PickerView Widget
PickerView Widget
PickerView Widget Basics
Events
Methods
Properties
RadioButtonGroup Widget
RadioButtonGroup Widget
RadioButtonGroup Widget Basics
Events
Method
Properties
ReactNativeContainer Widget
ReactNativeContainer Widget
ReactNativeContainer Widget Basics
Properties
RichText Widget
RichText Widget
RichText Widget Basics
Events
Method
Properties
SegmentedUI Widget
SegmentedUI Widget
SegmentedUI Widget Basics
Events
Methods
Properties
Objects
SignatureCapture Widget
SignatureCapture Widget
SignatureCapture Widget Basics
Events
Methods
Properties
SigninWithApple Widget
SigninWithApple Widget
SigninWithApple Widget Basics
Events
Properties
Slider Widget
Slider Widget
Slider Widget Basics
Creating a Progress Bar Using a Slider
Events
Methods
Properties
SlidingContainer Widget
SlidingContainer Widget
SlidingContainer Widget Basics
Events
Properties
Switch Widget
Switch Widget
Switch Widget Basics
Events
Method
Properties
TabPane Widget
TabPane Widget
TabPane Widget Basics
Events
Methods
Properties
TextArea2 Widget
TextArea2 Widget
TextArea2 Widget Basics
Events
Methods
Properties
TextBox2 Widget
TextBox2 Widget
TextBox2 Widget Basics
Events
Methods
Properties
Toolbar Widget
Toolbar Widget
ToolBar Widget Basics
Tool and Navigation bars for iOS
Constructor
Methods
Properties
Video Widget
Video Widget
Video Widget Basics
Events
Methods
Properties
Deprecated Widgets
Glossary
Iris Wearables Developer Guide
Iris Wearables Developer Guide
Introduction
Wearables
Wearables
Overview
Supported Platforms and Devices
Prerequisites
Apple Watch
Apple Watch
Overview
iOSÂ WatchKit Application Architecture
Creating Apple Watch Applications in Volt MX Iris
Apple-Specific Limitations
Deprecated
Deprecated
Overview
Configuring Your Xcode Project
VoltMXWatchKitRequestUtil
VoltMXDataMapper
VoltMXDataCache
Android Wear
Android Wear
Introduction
Overviews
References
References
Overview
voltmx.wearable Namespace
voltmx.wearable Namespace
Overview
Constants
Functions
Using the Volt MX App
Using the Volt MX App
Introduction
Preview and Collaborate on a Project
Preview and Collaborate on a Project
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 Reference Architecture Guide
Volt MX Reference Architecture Guide
Volt MX Iris Reference Architecture API Programmers' Guide
Overviews
Overviews
Overviews
Volt MX Reference Architecture: Decoded
Advantages of Using Volt MX Reference Architecture
A Deeper Look at Volt MX Reference Architecture
A Deeper Look at Volt MX Reference Architecture
A Deeper Look at VoltMX Reference Architecture
Views
Controllers
Models
Views and Controllers
Models and Controllers
Volt MX Reference Architecture Features
Volt MX Reference Architecture Features
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
Create an App with Volt MX Reference Architecture
Create an App with Volt MX Reference Architecture
Build Your Front-End Client App
Build Your Front-End Client App
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
References
References
FormController Object
FormController Object
FormController Object
FormController Events
FormController Events
FormController Events
getModel Event
onCreateView Event
onDestroy Event
onNavigate Event
setModel Event
FormController Methods
FormController Methods
FormController Methods
getCurrentForm Method
getCurrentFormFriendlyName Method
getPreviousForm Method
getPreviousFormFriendlyName Method
pauseNavigation Method
resumeNavigation Method
FormController Properties
FormController Properties
FormController Properties
view Property
voltmx.model Namespace
voltmx.model Namespace
voltmx.model Namespace
voltmx.model Constants
voltmx.model Constants
voltmx.model Constants
voltmx.model.ExceptionCode Constants
voltmx.model.ValidationType Constants
voltmx.model Objects
voltmx.model Objects
voltmx.model Objects
voltmx,model.Exception Object
voltmx,model.Exception Object
voltmx.model.Exception Object
voltmx.model.Exception Properties
voltmx.model.Exception Properties
voltmx.model.Exception Properties
code Property
message Property
name Property
voltmx.model.VoltMXApplicationContext Object
voltmx.model.VoltMXApplicationContext Object
voltmx.model.VoltMXApplicationContext Object
voltmx.model.VoltMXApplicationContext Methods
voltmx.model.VoltMXApplicationContext Methods
voltmx.model.VoltMXApplicationContext Methods
createModel Method
login Method
logout Method
voltmx.mvc Namespace
voltmx.mvc Namespace
voltmx.mvc Namespace
voltmx.mvc Functions
voltmx.mvc Functions
voltmx.mvc Functions
Navigation Function
voltmx.mvc.registry Namespace
voltmx.mvc.registry Namespace
voltmx.mvc.registry Namespace
voltmx.mvc.registry Functions
voltmx.mvc.registry Functions
voltmx.mvc.registry Functions
add Function
getViewName Function
getControllerName Function
remove Function
Navigation Object
Navigation Object
Navigation Object
Navigation Methods
Navigation Methods
Navigation Object Methods
getModel Method
navigate Method
setModel Method
TemplateController Object
TemplateController Object
TemplateController Object
TemplateController Events
TemplateController Events
TemplateController Events
onCreateView Event
onDestroy Event
onViewCreated Event
TemplateController Methods
TemplateController Methods
TemplateController Methods
executeOnParent Method
getCurrentView Method
TemplateController Properties
TemplateController Properties
TemplateController Properties
view Property
Deprecated
Deprecated
Deprecated
voltmx.sdk.mvvm Namespace
voltmx.sdk.mvvm Namespace
voltmx.sdk.mvvm Namespace
voltmx.sdk.mvvm Constants
voltmx.sdk.mvvm Constants
voltmx.sdk.mvvm Constants
voltmx.sdk.mvvm.OperationType Constants
voltmx.sdk.mvvm Objects
voltmx.sdk.mvvm Objects
voltmx.sdk.mvvm Objects
voltmx.sdk.mvvm.VoltMXApplicationContext Object
voltmx.sdk.mvvm.VoltMXApplicationContext Object
voltmx.sdk.mvvm.VoltMXApplicationContext Object
voltmx.sdk.mvvm.VoltMXApplicationContext Methods
voltmx.sdk.mvvm.VoltMXApplicationContext Methods
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
Foundry
Foundry
Fundamentals
Installing Foundry
Installing Foundry
Overview
Volt MX Foundry - Supported OS, Application Servers, and Databases Guide
Volt MX Foundry - Supported OS, Application Servers, and Databases Guide
Overview
Volt MX Overview
Volt MX Foundry V9 SP2 Software Requirements
Volt MX Foundry Supported Browsers
Volt MX Foundry Installation Guide - Linux
Volt MX Foundry Installation Guide - Linux
Overview
Prerequisites
Prerequisites
Overview
Database Prerequisites
Application Servers Prerequisites
Volt MX Foundry Topology and Components
Installation on Single Node and Multinode
Preinstallation Tasks
Installation Modes
Installation Modes
Overview
Installing Volt MX Foundry - Console-mode
Installing Volt MX Foundry on Tomcat
Installing Volt MX Foundry on JBoss
Installing Volt MX Foundry on JBoss
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
Upgrading Volt MX Foundry
Upgrading 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
FAQs and Troubleshooting
FAQs and Troubleshooting
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
Volt MX Foundry Installation Guide - Windows
Volt MX Foundry Installation Guide - Windows
Overview
Prerequisites
Prerequisites
Overview
Database Prerequisites
Application Servers Prerequisites
Volt MX Foundry Topology and Components
Volt MX Foundry Installation on Single Node and Multinode
Pre-Installation Tasks
Pre-Installation Tasks
Overview
Application Servers Pre-Installation Tasks
Installation Modes
Installation Modes
Overview
Installing Volt MX Foundry on Windows
Installing Volt MX Foundry on Windows
Overview
Installing Volt MX Foundry on Tomcat
Installing Volt MX Foundry on JBoss
Installing Volt MX Foundry on JBoss
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
Upgrading Volt MX Foundry
Upgrading 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
Install Logs on Windows
Install Logs on Windows
Overview
Log Location for Single Node Installation
Log Location for Multinode Installation
How to Change Log Levels
FAQs and Troubleshooting
FAQs and Troubleshooting
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
Volt MX Foundry Manual Installation Guide
Volt MX Foundry Manual Installation Guide
Overview
Volt MX Foundry Topology and Components
Volt MX Foundry Installation on Single Node and Multinode
Prerequisites
Prerequisites
Overview
Database Prerequisites
Required Setup Files
Encrypt Passwords
Preinstallation Tasks - Database - Configuring Flyway Command-line Tool
Preinstallation Tasks - App Servers
Set up Middleware Home
Configuring Installation Mode - App Servers
Configuring Installation Mode - App Servers
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
How to Install Volt MX Foundry on Tomcat
How to Install Volt MX Foundry on Tomcat
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
How to Install Volt MX Foundry on JBoss
How to Install Volt MX Foundry on JBoss
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
How to Install Volt MX Foundry on WebSphere Liberty
How to Install Volt MX Foundry on WebSphere Liberty
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
How to Upgrade Volt MX Foundry
How to Upgrade Volt MX Foundry
Overview
How to Upgade Volt MX Integration
How to Upgade Engagement Services
Post-Installation Tasks
FAQs and Troubleshooting
FAQs and Troubleshooting
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
Volt Foundry Command Line Installer
Volt Foundry Command Line Installer
Introduction
Prerequisites
Using the Volt Foundry Command Line Installer
Inputs in the userInputs.properties file
Supported Installer Actions
Troubleshooting and FAQs
Volt MX Foundry on Amazon EKS
Volt MX Foundry on Amazon EKS
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
Volt MX Foundry on Red Hat OpenShift
Volt MX Foundry on Red Hat OpenShift
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
Volt MX Foundry Single Container Solution (On-Premises)
Volt MX Foundry Single Container Solution (On-Premises)
Introduction
Overview
Volt MX Foundry Installation Guide - Containers Solution
Volt MX Foundry Installation Guide - Containers Solution
Overview
Installation
Post Installation Tasks
Appendices
FAQs and Troubleshooting
Prerequisites
Volt MX Foundry User Guide
Volt MX Foundry User Guide
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
APIs in API Management
APIs in API Management
Overview
How to Configure CORS and Identity Session Timeout in APIs
How to Configure CORS and Identity Session Timeout in APIs
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
Identity
Identity
Overview
Configure the Identity Service
Configure the Identity Service
Overview
Microsoft Active Directory
Salesforce
Open LDAP
Security Assertion Markup Language (SAML)
Siteminder
Volt MX SAP Gateway
Volt MX User Repository (Deprecated)
User Repository
User Repository
Overview
Reset Password
Sign-Up for a User Repository
Using Groups in an App
Facebook
Volt MX Custom Identity Service
Volt MX Custom Identity Service
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
Legacy Services
Legacy Services
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
Integration
Integration
Introduction
Configure the Integration Service
Configure the Integration Service
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
Advanced Configurations
Advanced Configurations
Overview
Preprocessor and Postprocessor
Rules for Pre and Post Processors
Custom Code for Invoking an Integration service from Preprocessor or Postprocessor
Sample Code for Preprocessor and Postprocessor
Sample Code for Preprocessor and 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
Orchestration
Orchestration
Overview
Importing and Exporting Services
Test an Orchestration Service Operation
Object Services
Object Services
Overview
Stage 2:Â Configuring a Data Model
Stage 2:Â Configuring a Data Model
Overview
Enumeration Data Type
Stage 3: Mapping Operations to Back-end Methods
Stage 3: Mapping Operations to Back-end Methods
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
File Service Adapters
File Service Adapters
Overview
AWS S3 Adapter
Cloudian Adapter
File Storage Adapter
Offline Enablement
Advanced Configurations Object Services
Advanced Configurations Object Services
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
Manage Client App Assets
Manage Client App Assets
Overview
Uploading Client Binaries
Uploading Client Binaries
Overview
Uploading Native Client Binaries
Uploading Web Client Binaries
Publishing Client Binaries
Publishing 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
Publish
Publish
Overview
Asynchronous Publish
Synchronous Publish
Separate App Key/App Secret for Web and Native Channels
Reconfiguration at Publish
Reconfiguration at Publish
Overview
App Reconfiguration
Service Reconfiguration
Managing Service Profiles
Promoting a Deployment Package
Volt MX Foundry Command Line Utility - Continuous Integration
Volt MX Foundry Command Line Utility - Continuous Integration
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
SDKs
SDKs
Overview
Volt MX Iris SDK
Volt MX Iris SDK
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
Invoking an Object Service
Invoking an Object Service
Overview
getObjectService Method
OnlineObjectService Class
OfflineObjectService Class
Data Transfer Objects
Data Transfer Objects
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
JavaScript SDK
JavaScript SDK
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
Cordova (PhoneGap) SDK
Cordova (PhoneGap) SDK
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
Invoking an Object Service
Invoking an Object Service
Overview
getObjectService Method
OnlineObjectService Class
OfflineObjectService Class
Data Transfer Objects
Data Transfer Objects
Overview
voltmx.sdk.dto.Column Class
voltmx.sdk.dto.DataObject Class
iOS SDK
iOS SDK
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
Invoking an Object Service
Invoking an Object Service
Overview
getObjectService Method
OnlineObjectService Class
Invoking a Metrics Service
Android SDK
Android SDK
Overview
Prerequisites
Downloading Volt MX Android SDK
Configuring the Volt MX Android SDK
Configuring the 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
Invoking an Object Service
Invoking an Object Service
Overview
getObjectService Method
OnlineObjectService Class
Invoking a Metrics Service
.NET (Visual Studio) SDK
.NET (Visual Studio) SDK
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
Invoking an Object Service
Invoking an Object Service
Overview
Creating an ObjectService Object
ObjectService Class
DataObject Class
Settings - Cloud
Settings - On-premises
Reports
Support
Telemetry
Tutorials
Appendix - Sync Strategy
Appendix - App Services
Appendix - App Services
Overview
Log Services
Appendix - Frequently Asked Questions (FAQs
Limitations
OAuth Sample App Guide
OAuth Sample App Guide
Overview
Volt MX Foundry OAuth Sample App
Integration Services
Integration Services
Overview
Offline Objects
Offline Objects
Overview
Offline Objects API Developer's Guide
Offline Objects API Developer's Guide
Overview
Introduction
Application-level APIs
Application-level APIs
Overview
HCLFoundry.OfflineObjects.drop
HCLFoundry.OfflineObjects.executeSelectQuery
HCLFoundry.OfflineObjects.incrementalSetup
HCLFoundry.OfflineObjects.reset
HCLFoundry.OfflineObjects.rollback
HCLFoundry.OfflineObjects.setup
HCLFoundry.OfflineObjects.startSync
Object Service-level APIs
Object Service-level APIs
Overview
< objectService >.cancelSync
< objectService >.clearOfflineData
< objectService >.getSdkObjectByName
< objectService >.rollback
< objectService >.startSync
Object-level APIs
Object-level APIs
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
Offline Objects Getting Started Guide
Offline Objects Getting Started Guide
Introduction
Configuration of Offline Objects
Configuration of Offline Objects
Overview
Configuring Volt MX Foundry Server
Configuring Client Application
Offline Objects Support in Windows 10
Offline Objects Support in Windows 10
Overview
Offline Objects Support in Windows 10 (Beta)
Application Level APIs
Object Level APIs
Sample Apps
Volt MX Offline Objects User Guide
Volt MX Offline Objects User Guide
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
Advanced Features
Advanced Features
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
PetStore Management Sample
PetStore Management Sample
Overview
Preface
PetStore Management Sample
Engagement Services
Engagement Services
Overview
Introduction to Volt MX Engagement Services
Introduction to Volt MX Engagement Services
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
Volt MX Foundry Engagement Services JPush QuickStart Guide
Volt MX Foundry Engagement Services JPush QuickStart Guide
Introduction
Overview
Creating a JPush Account and an Android Application in the JPush Console
Configuring JPush in Volt MX Foundry Engagement Services Console
Volt MX Foundry Engagement Services Demo App QuickStart Guide - Apple iOS
Volt MX Foundry Engagement Services Demo App QuickStart Guide - Apple iOS
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
Volt MX Foundry Engagement Services (Campaign Management)
Volt MX Foundry Engagement Services (Campaign Management)
Introduction
Overview
Creating Geofences and Beacons to use with Segments
Creating Geofences and Beacons to use with Segments
Overview
Adding a Beacon
Adding a Segment to Use with a Campaign
Configuring and Executing a Campaign
Volt MX Foundry Engagement Services Console User Guide
Volt MX Foundry Engagement Services Console User Guide
Overview
Introduction
Introduction
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
Use Case Scenarios
Use Case Scenarios
Overview
Use Case Scenario: One
Use Case Scenario: Three
Use Case Scenario: Four
Use Case Scenario: Five
Apps Overview
Apps Overview
Overview
Dashboard
Apps
Apps
Overview
Adding an Application
Adding an Application
Overview
Adding App Info
Adding Platforms
Adding Platforms
Overview
Apple
Apple
Overview
Generating an Apple Push Notification Service (APNS) Certificate
Renew the Apple Push Notification Service (APNS) Certificate
Android
Android
Overview
Generating FCM Server Key and Sender ID
Creating a JPush API Key and Master Secret
Windows
Web
Web
Overview
Generating FCM Server Key and Sender ID for Web
App API Key
Migration from GCM to FCM
Publishing an Application
Viewing an Application
Modifying an Application
Modifying an Application
Overview
Modifying Basic Details
Modifying Platform Details
Deleting an Application
Subscribers
Subscribers
Overview
Devices
Devices
Overview
Viewing a Device
Activating or Inactivating a Subscription from a Device
Deleting a Subscription
Users
Users
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
Engagement
Engagement
Overview
Campaigns
Campaigns
Overview
Adding Campaigns
Adding Campaigns
Overview
Push Message
Push Message
Overview
iOS Platform
Android Platform
Windows
Web
Modifying a Push Message
Deleting a Push Message
SMS Text
SMS Text
Overview
Email
Email
Overview
Entering Attribute Values
Passbook
Passbook
Overview
Pending Campaigns
Pausing Campaigns
Resuming Campaigns
Setting Message Priority
Modifying Campaigns
Stopping/Terminating Campaigns
Restarting Campaigns
Viewing Campaign Reports
Deleting Campaigns
Events
Events
Overview
Adding Events
Adding Events
Overview
Push Message
Push Message
Overview
iOS Platform
Android Platform
Windows
Web
Modifying a Push Message
Deleting a Push Message
Email
Email
Overview
SMS
SMS
Overview
Passbook
Passbook
Overview
API Payload
Setting Message Priority
Activating Events
Modifying Events
Reactivating Modified Events
Exporting Events
Importing Events
Viewing Events Reports
Deleting Events
Adhoc
Adhoc
Overview
Push Message
Push Message
Overview
User
iOS Platform
Android Platform
Windows
Web
Segment
Upload Users CSV File
Send Message
Email Message
Email Message
Overview
Segment
Send Message
SMS Message
SMS Message
Overview
Segment
Send Message
PassBook Message
PassBook Message
Overview
User
Segment
Send Message
Segments
Segments
Overview
Adding Segments
Modifying Segments
Deleting Segments
Attribute type - Date (Dynamic User Attribute
Attribute type - Date (Dynamic User Attribute
Overview
Use Case Scenario: One
Use Case Scenario: Two
Last Active Date
Location
Location
Overview
Geofencing
Geofencing
Overview
Adding Geofences
Importing Geofences
Exporting Geofences
Modifying Geofences
Deleting Geofences
Beacons
Beacons
Overview
Adding Beacons
Modifying Beacons
Deleting Beacons
Settings
Settings
Overview
Templates
Templates
Overview
Push Template
Push Template
Overview
Adding Push Templates
Modifying Push Templates
Exporting Push Templates
Importing Push Templates
Deleting Push Templates
Passbook Template
Passbook Template
Overview
Adding Passbook Templates
Modifying Passbook Templates
Exporting Passbook Templates
Importing Passbook Templates
Deleting Passbook Templates
Email Template
Email Template
Overview
Adding Email Templates
Modifying Email Templates
Exporting Email Templates
Importing Email Templates
Deleting Email Templates
SMS Template
SMS Template
Overview
Adding SMS Templates
Modifying SMS Templates
Exporting SMS Templates
Importing SMS Templates
Deleting SMS Templates
Configuration
Configuration
Overview
General
User Attributes
User Attributes
Overview
Adding User Attributes
Modifying User Attributes
Audit Trail
Health Check
Logging
Job Monitor
Email Configuration
SMS Configuration
Pass Configuration
Status
Status
Overview
Push Queue
Email Queue
SMS Queue
Pass Queue
File Upload
Inbound SMS
API Help
Admin Access
Admin Access
Overview
Members
Members
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
Groups
Groups
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
Engagement Demo App QuickStart Guide (for Android Devices)
Engagement Demo App QuickStart Guide (for Android Devices)
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
Engagement Campaigns and Events
Engagement Campaigns and Events
Overview
Overview
Introduction
Objective
Introduction to Events and Event Invocation
Introduction to Location Based Segment Creation
Introduction to Campaigns using Segments
Next Steps
Introduction to Engagement Geoboundary Monitoring
Introduction to Engagement Geoboundary Monitoring
Homepage
Objective
Geoboundary Creation and Monitoring
Geoboundary Creation and Monitoring
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
Demo App for Geoboundary Monitoring
Demo App for Geoboundary Monitoring
Installing Engagement Demo Application
Geoboundary Monitoring
Next Steps
Volt MX Foundry Engagement Services API Programming Guide
Volt MX Foundry Engagement Services API Programming Guide
Overview
Introduction
Volt MX Foundry Engagement Services APIs
Volt MX Foundry Engagement Services APIs
Overview
Authentication
REST API
REST API
Overview
Access Management
Access Management - Group (On-Premises only
Access Management - Group (On-Premises only
Overview
Get Group Details by Pagination
Get Group Details by ID
Get All Group Details
Create Group
Modify Group
Delete Group
Access Management -User (On-Premises only
Access Management -User (On-Premises only
Overview
Get User Details by Pagination
Get User Details by ID
Get All User Details
Create User
Modify User
Delete User
Administration
Administration
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
Applications
Applications
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
Beacon
Beacon
Overview
Get All Beacons
Get Beacon by ID
Create Beacon
Modify Beacon by ID
Delete Beacon
Update List of Beacons for a Device
Campaign
Campaign
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
Email
Email
Overview
Email APIs
Email API with Segments
Fetch All Email API
Get Full Content
Cancel Email
Status of Email Delivery
Email Template
Email Template
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
Event
Event
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
GeoLocation
GeoLocation
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
Misc
Misc
Overview
Android
Web
Test JPush Connectivity
Apple
BlackBerry
Windows 8 Credentials Validation
Update Windows MPNS Cert details
Delete Windows MPNS Cert Details
Health Check
Pass Certificates
Pass Certificates
Overview
Get All Pass Certificates
Get Pass Certificate by ID
Create Pass Certificate
Modify Pass Certificate by ID
Delete Pass Certificate
Apple Pass Intermediate Certificates
Apple Pass Intermediate Certificates
Overview
Get Apple WWRD certificate
Update Apple WWRD Certificate
Pass Devices
Pass Devices
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
Pass Distribution
Pass Distribution
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
Pass Template
Pass Template
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
Push Message
Push Message
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
Push Message Template
Push Message Template
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
Segment
Segment
Overview
Get All Segments by Pagination
Get Segment by ID
Create Segment
Modify Segment
Delete Segment
Validate Segment Criteria
Create Segment with Beacon Criteria
SMS
SMS
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
SMS Template
SMS Template
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
Subscribers
Subscribers
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
Users
Users
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
JSON Files for Import and Export
JSON Files for Import and Export
Overview
Deprecated APIs
Deprecated APIs
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
Invoking REST APIs in Java
Invoking REST APIs in Java
Overview
pom.xml File
Volt MX Client-side JavaScript Functions
Volt MX JavaScript APIs
Volt MX Foundry Engagement Event Management QuickStart Guide
Volt MX Foundry Engagement Event Management QuickStart Guide
Introduction
Overview
Creating an Event
Push Message
Setting Event Message Priority
API Payload
Introduction to Engagement Services 2-Way SMS
Introduction to Engagement Services 2-Way SMS
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
Administering Foundry
Administering Foundry
Overview
Settings and Configuration
Settings and Configuration
Overview
Volt MX Licensing Guide
Volt MX Licensing Guide
Introduction
Preface
License Activations
License Activations
Overview
Volt MX Foundry
License Activation Guidelines
License Deactivation
License Validity
Volt Foundry Roles Access Control Guide
Volt Foundry Roles Access Control Guide
Overview
Preface
Console Access Control
Working with Reports
Working with Reports
Overview
Volt MX Analytics Standard Reports Guide
Volt MX Analytics Standard Reports Guide
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
Custom Metrics and Reports Guide
Custom Metrics and Reports Guide
Overview
Custom Metrics
Implementing Custom Metrics
Implementing Custom Metrics
Overview
Implementing Custom Metrics in Volt MX Iris
Implementing Custom Metrics in Volt MX Server
Custom Metrics APIs
Custom Reports
Custom Reports
Overview
Creating a Report (Table, Chart, and Crosstab)
Creating a Report (Table, Chart, and Crosstab)
Overview
DataSets Dictionary
DataSets Dictionary
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
Custom Dashboards
Custom Dashboards
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
Volt MX Analytics and Reporting Installation Guide
Volt MX Analytics and Reporting Installation Guide
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
Post-Installation Tasks
Post-Installation Tasks
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
Analytics Mobile App Guide
Analytics Mobile App Guide
Overview
Volt MX Foundry Analytics Mobile App
User Journey - App Events and APM Guide
User Journey - App Events and APM Guide
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
App Services Console User Guide
App Services Console User Guide
Overview
Launching App Services
Web Apps
Monitoring
Monitoring
Overview
Service
Environment
Server Events
Integration Services
Object Services
Orchestration Services
Workflow Services
Rules
Jobs
Jobs
Overview
Scheduling Job APIs
Health Check
Logs
Logs
Overview
Standard Logs
Trace Logs
Settings
Settings
Overview
Configurable Parameters
Runtime Configuration
Environment Details
SSL Certificates
Downloads
Reports
Reports
Overview
Using Basic Reports
Using Legacy Reports
Configuring Report Settings
App Factory User Guide
App Factory User Guide
Introduction
DevOps
App Factory CI/CD Runtime
Getting Started
Getting Started
Prerequisites
Additional Requirements
Accessing the App Factory console
Creating an App Factory Project
Custom Hooks
External Authentication
Project Settings
Microservice Projects
Microservice Projects
Microservice Projects in App Factory
Scheduling a Microservice job
Running the ConfigureMS job
Build on Push for Microservice jobs
Iris Projects
Iris Projects
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
Custom Hooks for Iris jobs
Custom Hooks for Iris jobs
Overview
Environment Variables
Troubleshooting
Micro Apps - Best Practices
Foundry Projects
Foundry Projects
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
Foundry Tasks
Foundry Tasks
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
Database Projects
Database Projects
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)
Volt MX Foundry Deployment Guide
Volt MX Foundry Deployment Guide
Introduction
Overview
Software Requirements
Deployment Topology
Development Topology
App Server Sizing
Database Growth Sizing
Session Management
Security Hardening
Security Hardening
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
Deployment Checklist and Example Case Studies
Deployment Checklist and Example Case Studies
Checklist for Volt MX Foundry Deployment
Case Study I
Case Study II
FAQs and Troubleshooting
Volt MX Analytics & Reporting Cloud FAQs
Integration Services Troubleshooting Guide
Integration Services Troubleshooting Guide
Introduction
Troubleshooting
Troubleshooting
Overview
Properties in Volt MX Foundry Integration Service
Other Features
Java Messaging Service Issues
Volt MX Foundry Integration Error Codes
On this page
Syntax
Type
Read/Write
Remarks
Android limitations
SPA/Desktop Web limitations
Example 1
Example 2
Platform Availability
Syntax
Read/Write
Remarks
Example
Platform Availability
Syntax
Type
Read/Write
Remarks
Example
Platform Availability
Syntax
Type
Read/Write
Remarks
Example
Platform Availability
Syntax
Type
Read/Write
Remarks
Example
Platform Availability
Syntax
Read/Write
Remarks
Example
Platform Availability
Syntax
Read/Write
Remarks
Example
Platform Availability
Syntax
Read/Write
Remarks
Example
Platform Availability
Syntax
Read/Write
Remarks
Example
Platform Availability