logo
HCL Mosaic MVP Help Center
Overview
Initializing search
    hcl-software/mosaic-doc
    • HCL Mosaic
    • HCL Mosaic Digital Experience
    • HCL Mosaic Volt MX
    • HCL Mosaic Leap
    hcl-software/mosaic-doc
    • HCL Mosaic
        • What is HCL Mosaic
        • HCL Mosaic Deployment Regions
        • HCL Mosaic Environments
        • The Onboarding Process
        • Getting Started
        • Accessing Environments
        • Initial Administrative Access
        • Security Integration
          • Common Identity Federation / Brokering Scenarios
          • Single OIDC-Based Identity Provider
          • Multiple OIDC-Based Identity Providers
          • HCL Software Okta Identity Provider
        • Configuring Your Security Realm(s)
        • Using the Observability Stack
        • Accessing the Grafana Stack
        • Observability Dashboards
        • Viewing Log Information
      • DX
      • Manage DX
        • Product Overview
          • Site building
          • Application integration
          • Content management
          • Digital Asset Management (DAM)
          • Form application builder
          • Personalization
          • Role-based access control
          • API access
          • Accessibility features
        • Portal administration tools
          • Portal administration portlets
            • Administration portlets overview
            • Working with administration portlets
          • Portal user interface
          • Language support
            • Selecting and changing the language
            • Changing the character set for a language
            • Dynamically changing the language during the user session
            • How to control the behavior of the language fallback filter
            • Enabling presentation of Locales in friendly URLs
            • Supported languages
        • Staging to production
          • Overview of staging to production
            • Staging to production process
            • Tools for staging to production
            • Staging a virtual portal overview
            • Staging to production list
          • Creating and deploying the initial release
            • Creating the initial release
            • Preparing the servers for initial staging
            • Deploying the initial release
            • Deploying the initial release in a multiple cluster
          • Creating and deploying a differential release
            • Creating the differential release
            • Deploying the differential release
          • Parameters to customize the release
          • Updates with syndication
            • Syndication and staging
            • Staging artifacts that are not transferred by syndication
            • Creating a syndication relationship from the command line
          • Staging and external security managers
          • Manual staging to production process
            • Copying the JCR database
            • Exporting from source
            • Using copy of source JCR database domain
            • Importing in target
            • Validating the environment
          • troubleshooting
            • HCL Web Content Manager Support Tools
            • Browser behavior and scenarios
              • Back button behavior
              • Back button limitations
      • Build Sites
        • Building Sites
          • Website building blocks
            • Portlets
            • Pages
              • System content associations
              • Best practices for pages
              • Troubleshooting pages
              • Known issues for pages
            • Site Content
              • Content stored in Web Content Manager
              • External content
              • Social Content
            • Themes
              • JavaScript libraries
              • Understanding the Portal 8.5 modularized theme
              • Roadmap: Creating and customizing themes
          • Creating reusable assets
            • Page templates
            • An overview of authoring templates
            • Presentation templates
              • Page layout
              • Page style
            • Template mappings
            • Content items
            • Components
          • Building the website
            • Content Template
            • Content libraries
              • Creating libraries
              • Web content library default items
            • Setting up access
            • Taxonomy
            • Navigation
              • Creating links and navigation
              • Adding page-level navigation
              • Hiding and displaying pages in the navigation
            • Setting up search for site visitors
            • Hiding content
            • Static content
              • Static resources
              • Dynamic page metadata
            • Dynamic content
            • URLs
          • Authoring tools
            • Site toolbar and site manager
            • Authoring portlet
            • Edit mode
          • Preparing for content authors
            • Adding content - Site Toolbar or Site Manager
            • Generate author-ready templates
            • Enabling and disabling segments in the Add Segments view
            • Preparing the site toolbar
              • Configuring the behavior of toolbar tabs
              • Configuring display options in the primary and secondary toolbar frames
              • Disabling the toolbar logo
              • Implementing portlets for the site toolbar
              • Customizing the More menu of the action bar
              • Customizing toolbar layouts
              • Customizing site manager User Interface
              • Removing the site toolbar on a production server
              • Deleting pages and their contents
              • Disabling the language switcher
            • Creating custom icons for the Page Components palette and Web content authoring interface
              • Creating custom icons by referencing a file component
              • Creating custom icons by adding an image element
            • Customizing site manager
            • Creating project templates
          • Adding pages, content, and more
            • Exploring the Site Toolbar and Site Manager
            • Projects - Organizing and coordinating changes to your site
              • Creating a project
              • Creating a project template
              • Adding site updates to your project
              • Sending content for publishing approval in your project
            • Creating pages with page templates
            • Creating content with content templates
            • Viewing your content from the content explorer
            • Adding reusable page components to your page
            • Adding applications to your page
            • Moving, copying, and pasting pages and content items
            • Editing page settings
              • Friendly URL name
              • Changing page style
          • Configure your content spot
            • Specified content
            • Contextual content
            • Targeted Content
              • Adding targeted content to a spot
          • Developing and managing content
            • Blogs
              • Learn about the template libraries used by blogs and blog libraries
              • Adding a blog or blog library to a page
              • Adding existing blogs or blog libraries to a page
              • Assigning blog access to users
              • Viewing blogs and blog posts
              • Deleting blogs or blog libraries
            • wikis
              • Learn about the template libraries used by wikis
              • Adding a wiki to a page
              • Adding existing wikis to a page
              • Assigning wiki access to users
              • Deleting wikis
              • Purging deleted wiki pages
            • Installed portlets
            • Comments in WCM
          • URL Addressability
        • Themes and Skins
          • Roadmap - Creating and customizing themes | HCL Digital Experience
          • Getting started with Themes
            • Theme components and resources
            • Granting access to theme development tools
            • Theme Manager
            • Manage Theme Properties
            • Creating a theme
          • The module framework
            • Basic artifacts and their relation
            • Contribution types
            • Deferred and non-deferred modules
            • Resource Aggregator overview
            • Module dependencies in portlets
            • Change the auto-loading of portlet capabilities
              • Changing the auto-loading of portlet capabilities with WebDAV
              • Changing the auto-loading of portlet capabilities with XMLAccess
            • Response rendering for themes
            • Writing modules
              • Defining theme modules
              • Module schema definition
              • Profile schema definition
              • Dynamically extending an existing menu item from a module
            • Theme Optimization Analyzer
              • Examine page profiles
              • Examine modules
              • Examine contributions
              • Examine capabilities
            • Troubleshooting modular themes
              • Turning off aggregation and compression in client-side debug mode
              • Reloading the profile and module in development mode without caching
              • Debugging your module systematically
              • Verifying JSON file Syntax
              • Syntax in modules and profile definitions
            • Specify profiles
              • Included profiles
              • Specify profiles with metadata
              • Specifying profiles with the user interface
              • Changing the theme default profile
            • Modules that are provided with the modularized theme
              • Module capabilities
              • Dojo classes provided by the Dojo modules
            • Modules that add features to a theme
            • Adding or removing a module from a profile
              • Adding or removing a capability from a portlet
            • ConfigEngine tasks for creating a new profile based on a template and an existing profile in the system
          • Understanding the Simple Theme
            • Theme templates
              • Adding static content to theme.html
              • Adding server-side dynamic content to theme.html
            • Dynamic content spots
              • Adding a status bar to the Simple Theme
            • Changing the theme logo in the Simple Theme
            • Changing the favicon
            • Stylesheets
            • Modules and profiles
            • Layouts
            • Creating and deploying skins
            • Simple menu
            • Adding a message module
            • Globalization
              • Adding support for RTL locales
          • Understanding the Portal 8.5 modularized theme
            • Static resources
            • Dynamic content (jsp) resources
          • Managing theme capabilities
            • Deploying themes with cacheable resources
          • Customizing the theme
            • Theme Editor Portlet
            • Editing static theme resources and connecting with WebDAV
            • Copying your theme
              • Creating a copy of your theme
            • Dynamic content spots
              • Creating custom dynamic content spots
            • Layouts
              • Working with layout templates
              • Adding a layout to the toolbar
              • Default layouts
            • Skins
              • Skin templates
              • Default skins
            • Menus
              • Adding a link to the resource permissions administration portlet in a menu
              • Updating the content menu to open on click instead of on hover
            • Theme templates
              • Setting inherited theme templates
              • Renaming Theme Templates
            • Changing the theme logo
              • Changing the logo action
            • Customizing navigation
              • Creating a dynamic content spot for navigation
              • Adding a level of navigation
              • Removing a level of navigation
            • Styles
              • Creating a theme style
              • Applying alternate styles
            • Configuring the portal theme and modules
              • Changing theme metadata
              • Changing resource environment provider custom properties
              • Adding resource environment provider properties
              • Configuration for resource aggregation
              • Using your configuration properties
              • Configuration settings for capability filters
            • Expression language beans for accessing programming models
              • wp.clientProfile
              • wp.identification
              • wp.metadata
              • wp.publicRenderParam
              • wp.publicRenderParamValues
              • wp.themeConfig
              • wp.user - User
              • Expression language beans for accessing programming models
            • Drag-and-drop
              • Customizing drop targets on the page
              • Custom drag sources and drop targets
            • Displaying messages in the status bar module
            • Displaying the draft page ribbon
            • Adding jQuery to a theme
              • Defining tooltips with PowerTip
            • Tags used by the portal JSPs
              • <portal-core/> tags
              • <portal-dynamicui/> tags
              • <portal-fmt/> tags
              • tags
              • Macro Syntax Error
          • Developing themes for a production portal
            • Development and operations overview
          • Device classes
            • Device classes overview
            • Additional information about device classes for developers
            • mvc:URI scheme
            • Creating and deleting device classes
            • Assigning device classes
              • Assigning a device class manually to a client
              • XML sample for assigning a device class
            • Device class equations
          • Responsive Web Design
            • Mobile navigation
            • Standard portal pages and mobile devices
            • Relative width CSS classes for theme layouts
              • Creating your own layout
              • Creating portlets and page elements
        • Practitioner Studio
          • Working with Practitioner Studio
            • How to enable Practitioner Studio
            • Configuring Practitioner Studio
            • How to disable Practitioner Studio
          • Web content
          • Site templates
          • Themes
          • Personalization
          • Portal administration
          • Registration/Edit my profile
        • Manage site settings
          • Managing global settings
            • Specifying the default portal language
            • Specifying how to handle portlets that the user is not authorized to view
            • Specifying what users see initially when they log in to the portal
            • Specifying the search engine that opens when users select Find
          • Managing custom unique names
            • Viewing portal resources and custom unique names in the table
            • Creating or editing a custom unique name
            • Looking up the custom unique name for a resource
            • Searching
            • Configuring the Manage Custom Unique Names portlet
            • Field descriptions for the Manage Custom Unique Names portlet
            • Icon descriptions for the Manage Custom Unique Names portlet
          • Managing markup languages
            • Creating a new markup
            • Editing a markup
            • Activating or deactivating a markup
            • Displaying information about a markup
            • Deleting a markup
          • Managing client devices
            • Creating a new client
            • Editing a client
            • Deleting a client
            • Displaying client information
            • Setting the order of the client in the registry
            • Overriding the default HTML client
          • Importing an XML configuration file
        • Site Builder
          • Site Builder overview
          • Installing and removing Site Builder
          • Deploying Site Builder
            • Removing a previous version of Site Builder
            • Setting up Site Builder administrators
            • How to import the Site Builder library onto a new virtual portal | HCL Web Content Manager
            • Setting up Site Builder website creators
            • Limiting the number of pages for new sites or sections
            • Configuring application polling
            • Restoring the original Site Builder Template library
            • Making Site Builder visible
          • Building a site with Site Builder
            • Adding sites and sections
            • Next steps after using Site Builder
          • Site development with Site Builder
            • Site and section templates
            • Creating sites and adding sections
              • Page templates
              • Content seeding
            • Selecting libraries in Site Builder
              • Required libraries in Site Builder
              • Content libraries for site templates
              • Content libraries for sites created with Site Builder
              • Hiding libraries in Site Builder
          • Exporting Site Builder templates to other servers
            • Exporting a Site Builder template to a file
            • Exporting a Site Builder template to a virtual portal
            • Exporting a Site Builder template to a file
              • Importing a Site Builder template from a file
              • Importing a Site Builder template from a file by using Solution Installer
          • Troubleshooting issues with Site Builder
        • Blueprint
        • Nex Haven
        • Woodburn Studio
          • Filtering the Results of a WCM Navigator Component
          • Preventing automatic update of Woodburn Studio pages
        • Tagging and Rating
          • Introduction to tagging and rating
          • What is new in tagging and rating
          • How tagging and rating works in the portal
            • How public and private tags and ratings work in the portal
            • Tagging and rating with anonymous users
            • Grouping tags and ratings via resource categorization
            • Normalizing tags
            • Type-ahead feature for the deprecated tag widget
            • Filtering content for tagging
          • The tagging and rating user interface
            • The tag and rating widgets
            • The portal Tag Center
            • The portal tag cloud
            • Browsing tags
          • Tagging and rating for static pages
          • Enabling your own custom content for tagging and rating
          • Federating tags
            • Administering tag federation
              • Importing federated tags and resources
              • Cleaning up federated tags and resources
              • Redirecting to an HCL Connections site
              • Specifying an icon for a federated resource
          • Configuration reference for tagging and rating
            • Parameter reference for the tag and rating widgets
              • Tag widget parameter reference
              • Rating widget parameter reference
            • CSS classes for tagging and rating
            • Enabling and disabling the tag and rating widgets for additional profiles
            • Enabling and disabling the Dojo tagging and rating options for additional profiles
          • Security for tagging and rating
          • Using the XML configuration interface to administer tags and ratings
          • Hints and tips for tagging and rating
            • Hints and tips for developers and portal administrators
            • Hints and tips for portal users
          • Extending tagging and rating by using service APIs
            • The Java API
            • The REST API
              • Basic addressing
              • Adding query parameters
              • Querying models in correlation to each other
              • Using the Rest API to add, update, and delete tags and ratings
        • Virtual Portal
          • Deciding about virtual portals
            • Scenarios with multiple portals for your business requirements
            • Alternative concepts for virtual portals on HCL Digital Experience
            • Usage scenarios for virtual portals
          • Planning for virtual portals
            • Separating and sharing resources between virtual portals
            • Managing the user population for virtual portals
            • Virtual portal roles and their capabilities
              • The master administrator
              • Portal Access Control with virtual portals
              • Sub-administrators of a virtual portal and their access roles and permissions
              • Users of a virtual portal and their access roles and permissions
            • Content of a virtual portal
            • Shaping the user experience
              • Human readable URL mappings for virtual portals
              • Individual themes and skins for each virtual portal
          • Managing virtual portals
            • Creating a virtual portal
            • Re-initializing a virtual portal
            • Editing a virtual portal
            • Deleting a virtual portal
          • Virtual portals and managed pages
          • Administering virtual portals
            • Administering the portal content and resources for virtual portals
            • Tasks for administering virtual portals
              • Filling a virtual portal with content
              • Configuring the sub administrators for virtual portals
              • Modifying a virtual portal
              • Deleting a virtual portal
          • Working with the Virtual Portal Manager portlet
            • Preconfiguring virtual portals
              • Preconfiguring the default content for virtual portals
              • Preconfiguring the sub-administrators for virtual portals
            • Using the Virtual Portal Manager administration portlet
          • Virtual portals reference
            • Virtual portals command reference
              • Using the XML configuration interface to work with virtual portals
              • Known limitations for virtual portals
              • Change of theme for virtual portal might not take effect
              • Using a new host name for an existing virtual portal
              • Scope of virtual portals
            • Hints and tips for working with virtual portals
        • Mobile
          • HCL DX Mobile Experience
          • Progressive Web Applications
          • Mobile Preview
          • Integrating HCL Discover with HCL DX
            • Installing the Discover module for Digital Experience integration
        • Social Rendering
          • Roadmap: How to work with social rendering
          • Working with lists of social objects
            • Concept of the lists of social objects provided with the social rendering feature
              • Social object resolution
            • Using the view definitions provided with social rendering on your portal pages
            • Using social lists with your own custom theme
            • Configuring a page with lists of social objects for Tag Cloud support
            • Using the portal Tag Cloud with lists of social objects
              • Configuring the portal Tag Cloud for social rendering
          • Configuring global settings for social rendering
            • Configuring the HCL Connections server type
            • Configuring the maximum number of items loaded from HCL Connections
            • Configuring portal user ID conversion based on directory service
            • Configuring the tags transmission limit
            • Configuring globally how social object data is served
            • Configuring globally how social object links are resolved
            • Configuring file type icon mappings
              • File type mappings reference
          • Administering social lists
            • Adding the social rendering theme module to a theme profile
            • Performance tuning for lists of social objects
            • How to enable social rendering in a virtual portal
            • Using Social Rendering with Tivoli Access Manager and WebSEAL
            • Removing the previous version of social rendering
          • Customizing view definitions for portal site visitors
            • Customizing social list definitions by using inline editing
            • Customizing forum topic details view definitions by using inline editing
            • Request attributes for changing search queries dynamically
            • Customizing the visual design of your view definitions
              • Using the business card
            • Creating custom authoring templates for list definitions
            • Implementing interactions with social objects
              • Interacting with forums
              • Creating a reply
              • Deleting a reply
          • Adding widgets to a community
          • Extending social lists by using the digital data connector
            • The social rendering Digital Data Connector plug-in
            • Implementing custom HCL Connections queries
            • Dynamic HCL Connections source URL construction
            • Organizing your custom HCL Connections queries
        • Search V2
          • Accessing Search V2
          • Using Search V2
          • Limitations of Search V2
            • None
            • None
            • None
          • Customizations for Search V2
        • Search V2 Authoring
          • Accessing Search V2 Authoring
          • Using Search V2 Authoring
          • Limitations of Search V2 Authoring
      • Manage Content
        • Author Web Content
          • inline_editing
            • Examples of using the Site Manager in Woodburn Studio
            • Enabling inline editing for content items
            • Updating sample template items for inline editing after an upgrade installation | HCL Web Content Manager
          • content_composer
            • Installation
              • Install Content Composer
              • Enable or Disable in Virtual Portals
            • Configuration
              • Access to non-admin Users
              • Access for Authors and Editors
            • Usage
              • Access Content Composer
              • Content Versioning
            • Limitations
          • presentation_designer
            • Access Presentation Designer
            • Usage
              • User elements
              • Styling options
              • Edit presentation template
              • Canvas settings
              • Default and Override stylesheet
              • Handle multiple stylesheets
            • Limitations
          • authoring_portlet
            • Access Web Content Authoring
            • navigation
              • Your Home Page
              • Favorite Items or Locations
              • Filtering Displayed Items
              • Searching for Items
              • Editing User Profiles
              • Batch Editing Access Control
            • web_content_libraries
              • Create Content Library
              • Set up access to libraries
              • Define Roles in a Library
              • Copying / Moving Items Between Libraries
              • Setting root access for all web content libraries
              • Unlocking a library
              • Deleting a web content library
              • Disabling a web content library
            • content_management_artifacts
              • Web Content Folders
              • Components
              • Presentation templates
              • Categories
              • Site areas
            • change_management
              • Work with Drafts
              • Manage Published Items
              • Manage Expired Items
              • Delete Items
              • Locked and Draft Items
              • Managing References
              • Manage Item Versions
              • Restoring an Item
              • View References
              • Labeling a set of items in a library
              • Restoring items in a library
            • Accessibility Features
            • auth_portlet_settings
              • Selecting web content libraries
              • Defining preview options
              • Defining user interface options
              • Editor options
              • Customizing the Web Content Authoring portlet
          • dcs
            • Supported Operating Systems
            • Configure DCS
              • For Systems Other than Windows
              • Images for OS Other than Windows
            • Set File Type Definitions
            • Back Up DCS Files
            • Stellent as DCS
            • Disable Oracle DCS
            • Remote DCS
            • File Types Supported
          • content_reporting
            • Installation
            • Access Content Reporting
            • Usage
              • Generating a content report
              • Exporting a report
              • Performing a bulk update
              • Bookmarking
            • Limitations
          • dx_picker
            • None
            • None
            • None
            • None
            • None
          • multi_lingual
            • Framework for multilingual site management
            • Overview of a multilingual site
            • Deployment, installation, and configuration
              • Multilingual deployment
              • How to Switch the languages in the Digital Experience theme
              • Configuring a multilingual system
              • Multilingual presentation layer
              • Capacity planning for multilingual sites
              • Changing the multilingual solution context root
            • How to use the multilingual solution
              • Multilingual authoring
              • Lifecycle and synchronization
              • Localized rendering
              • Creating more multilingual sites
              • Advanced options
            • Extensions for multilingual sites
              • Installing the multilingual extensions
              • Edit-time navigation creation extension
              • Optimizing the performance of the extensions
              • Update notification extension
              • Publishing synchronization extension
              • Expiry synchronization extension
              • Deletion synchronization extension
              • Servlet render-time navigation extension
              • Domain locale redirection extension
              • Library copy portlet extension
              • Portlet Render-time navigation extensions
              • Uninstalling the multilingual solution extensions
          • renditions
            • Set Rendition Properties on Images
            • Disable Renditions
            • Enable Renditions
            • Video Start and End Points
          • wci
            • Example feeds
            • Feed Format Overview
            • Embedded links
            • Processing Images
            • rss_for_feed
              • The Handshake Protocol
              • Results Feeds
              • Channel-level Elements
              • Item-level Elements
            • rss_for_web_content
              • Adding the Custom Namespace Definition
              • Process Control Elements
              • Location Control Elements
              • Identity Control Elements
              • Profile Control Elements
              • Authoring Template Element
              • Element Control Element
              • Workflow control elements
              • Security control elements
              • Association Control Element
            • webcontentfeed_mgmt
              • Creating a Feed Configuration
              • Creating a Feed Job
              • Managing Feeds
        • Deliver Web Content
          • Rendering modes for web content
          • Delivering web content on a DX page
            • Getting started with delivering web content on a DX page
              • Web Content Viewers
              • Web content pages and templates
              • Web content associations
              • Link examples for Web Content Viewers
            • Displaying content with Web Content Viewers
              • Adding a Web Content Viewer Portlet
              • Creating a web content page
            • editing_wcm_viewer_setting
              • Locking configuration settings
              • Setting default values
              • Content settings
              • Profiling settings
              • Portlet settings
              • Advanced options
            • Customizing web content delivery
              • Creating web content page templates
              • Creating web content when you add a web content viewer to a page
              • Customizing error messages for Web Content Viewers
              • Setting up a web content fallback page
              • Enabling page-based access control for web content pages
              • Previewing content on web content pages
              • Adding HTML meta tags for Search Engine Optimization
            • Enabling remote rendering with WSRP and the Web Content Viewer
              • CORS and remote web content rendering with WSRP and the Web Content Viewer
              • OpenAjax security and remote web content rendering with WSRP and the Web Content Viewer
            • Advanced administrative examples
              • Creating a web content page with the XML configuration interface
              • Dynamic web content page selection
            • Web Content Viewer best practices and limitations
          • Access web content by using a servlet
          • Content as a Service Pages
            • Technical concepts
            • Setting up Content as a Service
            • Accessing Content as a Service pages
            • Select data format based on MIME type
            • Removing Content as a Service
          • Pre-rendered delivery
            • Pre-render methods
            • How to access the pre-rendered site
          • WebDAV
            • Web content items in the WebDAV tree
            • Metadata and access control for web content items in WebDAV
            • Creating taxonomies and categories with WebDAV
            • Managing content with site areas in WebDAV
            • Creating components with WebDAV
            • Creating presentation templates in WebDAV
            • Managing metadata and access control settings for authoring templates with WebDAV
            • Using WebDAV with HCL Portal
              • Configuring the WebDAV file store
              • Using WebDAV file store
              • Serving HTTP OPTIONS requests to the server context root by WebDAV clients
              • Working with WebDAV clients
              • Task webdav-deploy-zip-file
          • Social Media Publisher
            • Social Media Publisher - Overview
            • Installing the Social Media Publisher
            • Social network configuration
              • Global configuration settings
              • Adding the social information table to an authoring template | HCL Web Content Manager
            • The social network information table
            • Social Media Workflow Actions
            • Publishing content directly to a Facebook page
            • Social media for users
            • Social media certificates
            • Uninstalling the Social Media Publisher
            • Known issues with the Social Media Publisher
          • Previewing as Another User
            • Disabling the preview option
            • Disabling the More menu
          • Vanity URLs
            • Viewing and creating vanity URLs
            • How vanity URLs work
            • Administering vanity URLs
              • Enabling vanity URL support
              • Providing short vanity URLs
              • Configuring the vanity URL preview link
              • Synchronizing the vanity URL database
              • Setting an error URI for undefined vanity URLs
          • Syndication
            • Roadmap: Syndication
            • Syndication relationships
            • Syndication properties
            • Staging-server topology for Web Content Manager
              • How to configure a web content staging environment
            • How to manage syndicators and subscribers
              • Creating a syndication relationship by using the Administration view
              • Syndicator settings
              • Subscriber settings
              • Manually syndicating items
              • Monitor syndication
              • Syndicator settings
              • Allowing delegated access for syndication
              • Manually syndicating items
              • Creating a syndication relationship by using the Administration view
            • Syndication tuning
            • Syndication troubleshooting
            • Creating a syndication relationship from the command line
            • Syndication
        • Configure Web Content Manager
          • Web content administration tools
            • Web content maintenance
            • Configuring Web content cleanup tasks
            • The web content member fixer task
              • How to use the member fixer task
              • Member fixer with syndication
              • Member fixer task frequently asked questions
            • Running the profile enablement tool
            • The update keyword tool
            • Managing workflows by using the workflow checker tool
            • Updating workflows by using the workflow update tool
            • Clearing item history
            • Clearing version history
            • Resetting the web content event log
            • The export cache settings task
            • How to manage plug-in tag usage
            • Exporting and importing web content libraries
              • Exporting and importing a web content library
              • Exporting and importing a web content library copy
            • Deleting libraries by using the delete libraries tool
            • How to clone a web content repository
              • Cloning preparation
              • Cloning data
          • cfg_webcontent_auth_env
            • How to install the authoring portlet
            • Further authoring portlet configuration options
            • Web content authoring options
            • Enhanced rich text editor configuration options
            • How to configure authoring portlet search
            • Importing large files and images
            • Increase timeouts to prevent save errors
            • Configuring remote server access for links
            • Setting up support for federated documents
              • Configuring access to remote systems for federated documents
              • Configuring the federated documents feature
              • Cache tuning for federated documents
          • cfg_webcontent_delivery_env
            • Setting up site analysis for the Web Content Viewer
              • Enabling the Web Content Viewer logger
              • Site analysis example for the Web Content Viewer
            • XML configuration interface parameters for the Web Content Viewer
            • Caching options
              • Web content cache types
              • Caching versus pre-rendering
              • Strategies for expiring content
              • Web content cache configuration
              • Data cache configuration
            • Pre-rendering options
          • Custom Caching
            • Cache parameters
            • Cache expire parameters
            • Caching HCL Web Content Manager elements
          • Service Configuration
            • Web Content Manager configuration service
            • Web Content Manager messaging service
            • Web Content Manager pre-rendering service
            • Web Content Manager search service
            • Controlling access to hosts specified in a URL
            • Defining alternative administrators for multi-realm configurations
            • Changing the login or redirect page used for servlet rendering
            • Enabling connect tags
            • Disabling Workflow Actions
            • Setting scoped configuration settings for virtual portals
            • Enabling email
            • Web content substitution variables
            • Remove authoring configuration task
          • Cleaning up WCM items
        • Extend Web Content Manager
          • HCL Web Content Manager API
            • How to use the Web Content Manager API
            • The Query API
            • Web Content Manager JSP tags
            • Web Content Library Management APIs
            • Syndication APIs
            • Web Content Manager Multilingual Solution API
            • wcm_dev_api_urlgen
              • Example 1: Append a prefix to a content URL
            • Deploying custom plug-in applications
            • Using remote action plug-ins
          • REST service for Web Content Manager
            • Getting started with the REST service for Web Content Manager
            • How to use REST with Web Content Manager items
            • How to Use REST to Work with Deleted Content Items
              • Macro Syntax Error
              • How to use REST with Web Content Manager to Purge Deleted Content Items
              • How to use REST with Web Content Manager to Restore Deleted Content Items
            • REST content formats for components and elements
            • REST Query service for web content
              • Defined query Service
              • Query parameters
              • CSV Export of REST query results
            • How to manage web content items by using REST
              • How to use REST on virtual portals
              • How to use REST with libraries
              • How to use REST with content items
              • How to use REST with components
              • How to use REST with elements with version 8.5 CF03 or higher
              • How to REST with presentation templates
              • How to use REST with site areas
              • How to use REST with managed pages
              • How to use REST with drafts and workflows
              • How to use REST with workflow items
              • How to use REST with workflow stages
              • How to use REST with projects
              • How to use REST with folders
              • How to use REST with taxonomies
              • How to use REST with categories
              • How to use REST to work with item identity controls
              • How to use REST with access controls
              • How to use REST to work with author and owner parameters
              • How to use REST with versions
              • Using REST to work with recent items
              • How to use REST to work with favorite items
              • REST: Attachments
              • Generic reading by using REST services for Web Content Manager
            • How to manage web content image renditions interactions by using REST
            • Web Content Manager Lock/Unlock API
            • Updating references
            • Creating a content item
            • Creating a content item from a skeleton
            • Web Content Manager Syndication REST APIs
            • Web Content Manager Find Rendering and Script Portlet References
            • Web Content Manager Find References from WCM Artifacts
            • Support for library components in content and authoring templates
            • Reference material for the Web Content Manager REST service
              • Response codes for the Web Content Manager REST service
              • Link relations
              • Supported media types
              • REST Item Types
          • REST service for Web Content Manager
            • Getting started with the REST service for Web Content Manager V2
            • Differences between V1 and V2 APIs
          • Determining the current web content context
          • Displaying data from external sources
          • Taxonomies, categories, and keywords
          • Using remote actions
          • Storing translated text in a content item or site area
          • Java messaging services for web content
          • wcm_rest_v2_ai_analysis
            • Using the AI analyzer API for content
        • Digital Asset Management
          • Configuration
            • Sharing and Staging DAM Assets
              • Sharing the DAM repository between environments
              • Staging DAM to rendering environments
              • DAM Staging Mismatch and Resync
            • Configure Digital Asset Management with a CDN
            • DAM Indexing
              • Configuring DAM Indexing
              • Using DAM Indexing
          • Usage
            • Accessing DAM
            • Digital Asset Search
            • DX Content Picker for DAM
            • Managing DAM
              • Upload Media Assets
              • Manage Media Assets
              • Export or Import DAM
              • DAM schemas
              • Manage Collections
              • Access Control Management
          • Limitations
        • Personalization
          • Targeted content and Portal Personalization
          • personalization
            • Content that you personalize
            • Creating a business rule
            • Link the rule to a content spot on your site
            • Publish your rules to production
            • Personalization
              • Personalization objects
              • Types of rules
              • Rule elements
              • Access control for personalization objects
              • Creating and editing personalization campaigns
              • Creating personalization content spots
              • Creating a rule
              • Creating a rule event
              • Creating and editing a rule mapping
              • Creating and editing resource collections
              • Creating and editing application objects
              • Exporting and importing Personalization objects
          • How a site is personalized
          • Personalization terms
            • Resources, resource instances, and resource collections
            • User resources
            • Attribute Based Administration
              • Assigning attribute based administration rules to pages and portlets
              • Changing the error condition behavior
            • Rules
              • Recommend Content
              • Email action or promotion
              • Email administration
            • Content spots
            • Rule spot mappings
            • Campaigns
            • Application object
            • Request Context
            • Query framework
            • Content resources
          • The Personalization interface
          • Publishing personalization rules
            • Publishing considerations
            • Publishing personalization rules
            • Publishing and deleting personalization rules using a script
            • Publishing personalization rules over SSL
            • Monitoring the status of publishing
          • The Web Content resource collection
          • The Portal User resource collection
          • Personalization programming reference
            • Preparing your personalized application
            • Programming model
            • User and content models
            • How the rules engine works
            • Workload management
            • Using the Personalization APIs
              • Resource interface
              • APIs for multivalue properties
              • General tips
              • Personalization jar files that use public API
            • generic_query_framework
              • Using the Generic Query Framework
            • Request Context
            • Content spot exits
            • resource_cache
              • Automatically clearing your cache entry
            • Programmatically starting rules
            • Rule Exception Handling in the run-time environment
          • Personalization APIs
            • Personalization REST API explorer
              • Personalization folder APIs
          • Staging Personalization rules to production
              • Classes and APIs for writing custom listeners
              • ResourceInfo class
              • RuleInfo class
      • Extend DX
        • Integrating Applications
          • HCL Commerce
          • Integrate HCL Connections
            • Installation
              • Installation options
            • Configuration
              • Configure HCL Portal to work with HCL Connections
                • Configuring the HCL Connections integration
                • Set up single sign-on
              • Import SSL certificate to set up trust association
              • Configuring HCL Connections features
                • Integrating HCL Connections profile
              • Configuring community pages
                • Automatically grant page access to community members
                • Overriding access control integration during community page instantiation
                • Configure limits for propagation of community associations
                • Configuring the number of retrieved communities
              • Managing community pages
                • Managing community associations
                • Community associations and APIs
          • Integrate HCL Leap
            • Installation
            • Configuration
            • Sample integrations
          • Integrate HCL Volt MX Foundry
            • Installation
            • Configuration
              • Configuring the Access Layer for HCL DX and Volt MX Foundry
              • Macro Syntax Error
            • Sample integrations
              • Integrating Volt MX data and applications into HCL DX
              • Using HCL DX APIs in HCL Volt MX Foundry
              • Deploying HCL Volt MX portlets into HCL DX
            • Considerations
        • Development Tools
          • DXClient
            • Installing DXClient
            • Configuring DXClient
            • DXClient commands
            • DXClient artifact types
              • Applications
              • Credential Vault Slot
              • DX Core server
              • LiveSync
              • Personalization rules
              • Portlets
              • Resource environment provider
              • Script Application
              • Shared library
              • Themes
              • Version Compatibility
              • Virtual Portal Management
              • Web Content - Exporting and importing libraries
              • Web Content - Managing Syndicators and Subscribers
              • Web Content - Translating library content
              • XML Access
            • Sample pipeline settings using DXClient
            • Troubleshooting DXClient
            • Limitations
            • DXConnect
          • Creating and deploying Script Applications
          • HCL DX Extensions
            • Reference documents
        • Script Applications
          • build_app_with_script_application
            • script_app_editor
              • Importing Script Applications
              • Exporting Script Applications
              • CSS best practices
            • Script Application improvements
            • Generate unique namespace IDs
            • js_libraries
              • Import applications that include links to JavaScript frameworks
            • script_app_editor_actions_menu_overview
              • Render parameter tags
            • Combine local JavaScript files
            • Add an existing Script Application to a page
            • Update an existing Script Application from CLI
            • Generating a URL map
            • JavaScript API for spHelper
          • script_application_security
            • User Access to Script Applications
            • Editor and reviewer Access to the Script Application Library and Script Applications Site Area
              • Granting access to the Script Application Library
              • Granting access to the Script Applications Site Area
            • Imported Archive Security
            • Custom Configuration Properties for Script Applications
          • scriptapps
            • Prerequisites
            • common-setup
            • site_integration
              • import_export_site
                • How to Deploy Theme
                • How to Import WCM library
                • How to import DX Site Page Hierarchy
                • Manually exporting your Theme via Practitioner Studio
                • Manually exporting the your DX Site Page Hierarchy
                • Exporting your theme from your system
                • Exporting the DX Site Page Hierarchy xml from your system
                • Exporting your WCM library
              • Use of Cookies
              • Code-Splitting
              • Styling (CSS and SCSS)
            • how_to
              • Deploy a ReactJS App as a Script Application
              • Deploy JavaScript Libraries/Dependencies as a DX Module
              • Deploy A Script Application Without Its Dependencies
              • Deploy Multiple Script Applications with Shared Dependencies
              • Deploy Multiple Script Applications with Different Dependency Versions
              • Deploy Multiple Script Applications that Use Shared Components From Themes
            • samples
          • Limitations
          • Troubleshooting
        • Portlet Development
          • Sample portlets
          • Portlet concepts
          • Creating a simple portlet
          • Standard Portlet API
            • Using two-phase rendering with JSR 286 portlets
              • Enabling two-phase rendering for a portlet
              • Setting headers for a JSR 286 portlet
              • Setting cookies for a JSR 286 portlet
              • Modifying the HTML head section of a JSR 286 portlet
              • Setting portlet caching values for a JSR 286 portlet
          • Portlet Services
            • Accessing portlet services
            • Creating your own portlet service
          • Web 2.0 User Interface
            • The client side portlet programming model
              • Getting started with the client-side programming model for portlets
              • Handling portlet preferences on the client
              • Changing portlet mode and window state on the client side
              • JavaScript namespacing - observing good practice
            • Outbound HTTP connection
              • The programming model for the outbound HTTP connection service
              • HTTP proxy for Ajax applications
              • Configuring outbound HTTP connections
              • Authenticating outbound HTTP connections
                • Providing user credentials for authenticated connections
                • Establishing a basic authenticated HTTP connection
                • Establishing a digest authenticated HTTP connection
                • Establishing a form-based authenticated HTTP connection
                • Establishing SSO connections through LTPA token
                • Establishing SSO connections through SPNEGO token
                • Adding or changing endpoint URL settings
              • Using dynamic elements in outbound HTTP connection settings
              • Using programmatic extensions for outbound HTTP connections
              • Migration
            • Live text for click-to-action
              • Live text formats
              • Integrating click-to-action targets with the person menu
              • Relation to cooperative portlet wiring
              • Comparison of the new features with click-to-action in HCL Digital Experience portlets
          • Client-side Aggregation
            • Programming model guidelines for server-side mode
          • Portlet Communication
            • Public render parameters
            • Advanced URL generation for data exchange
            • Standard portlets publish and subscribe mechanisms
              • Define portlet communication capabilities
                • JSR 286 portlet events based communications
                • Interoperability between JSR 286 portlet events and JSR 168 cooperative portlets
              • Triggering communication
                • Communication with dynamic menus
                • Runtime behavior
            • Known issues and restrictions related to standard portlets publish and subscribe mechanisms
            • Special purpose techniques for data exchange
            • Shared portlet sessions
          • Dynamic User Interfaces
            • Overview: Developing a dynamic UI configuration
          • Collaborative Services API and the Person Tag
            • Integrating the Business card and online status in a custom portlet
            • Customizing Person card actions through the theme
            • Setting display duration for the Person card
            • Customizing the look of the Person card
            • Making business card fields expand and collapse
            • Logging for Collaborative Services
          • Portlet API
            • Converting HCL Digital Experience portlets (AIX, Linux, Windows) to the Java Standard API
              • Converting portlet instances and settings from the HCL DX API to the standard API
          • Managing portlets, portlet applications, and iWidgets
            • Installing a portlet
            • Disabling anchors in portlet URLs
            • Deploying Java Platform, Enterprise Edition resources
            • Activating and deactivating portlet applications or portlets
            • Copying portlet applications
            • Deleting Web modules, portlet applications, or portlets
            • Updating Web modules, portlet applications, and portlets
            • Web modules, portlet applications, and portlets
            • Copying portlets
            • managing_iwidgets
              • Task register-iwidget-definition
              • Task refresh-iwidget-definitions
            • modifying_portlet_app_and_portlets
              • Configuring portlet applications or portlet parameters
              • Switching from HCL Digital Experience 9.5 Practitioner Studio to the HCL Digital Experience 8.5 and 9.0 Login interface
            • portlet_management
              • Managing Web modules
                • Installing a Web module
                • Consuming a remote portlet
                • Activating a Web module
                • Viewing properties of a Web module
                • Updating a Web module
                • Deleting a Web module
                • Assigning access to a Web module
                • Viewing portlet applications for a Web module
                • Configuring the Manage Web Modules portlet
                • Field descriptions for the Manage Web Modules portlet
              • Managing portlet applications
                • Making a copy of a portlet application
                • Modifying portlet application settings
                • Deleting a portlet application
                • Assigning permissions to a portlet application
                • Viewing a list of portlets for a portlet application
                • Configuring the Manage Applications portlet
                • Field descriptions for the Manage Applications portlet
              • Checking the availability of a portlet
              • Providing a portlet through WSRP
              • Withdrawing a portlet
              • Copying a portlet
              • Blocking or unblocking requests to a portlet
              • Modifying portlet settings
              • Deleting a portlet
              • Assigning access to a portlet
              • Configuring the Manage Portlets portlet
              • Fields for the Manage Portlets portlet
              • Configuring your portal for Web services
                • About Web Service Configuration
                • Editing a Producer definition
                • Setting language-specific titles and descriptions for a Producer definition
                • Deleting a Producer definition
                • Assigning access permission to users on a web service Producer definition
                • Configuring the Web Service Configuration portlet
                • Field descriptions for the Web Service Configuration portlet
                • Icon descriptions for the Web Service Configuration portlet
          • Portlet Development Reference
            • Markup guidelines
            • Building .ear and .war files
            • Accessing the portlet session on the anonymous page
            • Deployment descriptors
            • JSP tags for standard portlets
            • Handling and visibility of request parameters in portlets
            • Detailed descriptions of the Struts WML tags
            • Application extension registry
          • Predefined Public Render Parameters
            • Predefined public render parameters representing portal state
            • To register predefined public render parameters in portlet.xml
            • To use predefined public render parameters in your portlet
            • jsf
              • JavaServer Faces implementation
              • Support for JavaServer Faces 2.2
            • wsrp
              • What is new in WSRP
              • Learning about WSRP
                • WSRP Producer
                • WSRP Consumer
                • How Producer and Consumer portals communicate
                • Abbreviations
              • Planning for WSRP
                • Supported portlet APIs
                • Exchanging the required information between Producer and Consumer portals
                • Security for WSRP services
                • How you work with WSRP in your portal
              • Using your portal as a WSRP Producer
                • How to access the Producer WSDL
                • Exporting customized WSRP portlet instances by using the XML configuration interface
                • Changing the WSRP Producer context root
              • Using your portal as a WSRP Consumer
              • Using handlers for WSRP web services
                • WSRP Producer portal
                • WSRP Consumer portal
              • Reference for using WSRP with the portal
                • WSRP markup caching
                • Cookie support
                • WSRP two-phase rendering
                • Handling HTTP headers
                • Hints and tips for using WSRP with the portal
                • Troubleshooting WSRP
                • What is new in WSRP
        • APIs
          • HCL Experience API
            • OpenAPI Prerequisites
            • OpenAPI Configuration
            • Getting Started
            • REST API Explorers
            • DAM Friendly URLs
            • Sample API Calls
            • Sample Content UI
              • Prerequisites
              • Getting Started
          • Controller SPI
            • Controller SPI Packages
            • Working with Controllers
              • Controller for Working with Resources
              • Committing and Persisting Modifications
            • Modifications Using Controller SPIs
              • Modify Portal Resources and Topologies
                • Delete Nodes
              • Modify Properties
                • Set Titles and Descriptions
                • Set Unique Name
                • Set Metadata
                • Set Markups
                • Set Orientation for Layouts
                • Set Flags
                • Set Themes
              • Confirm Modifications
            • Hints and Tips
          • Model SPI overview
            • Sub-packages of Model SPI
            • Obtain Model from Portal
            • Obtain the Object ID
            • Filter Content Model
            • Model SPI Samples
            • Remote Model SPI REST services
              • Feeds for REST services
                • Elements of a Model Feed
            • Remote Model API REST services
          • Portal Access Control Interfaces
            • Portal Access Control SPI
            • Portal Access Control REST API
          • User and Group Management
            • Remote REST service for PUMA
              • Structure of the remote REST service for PUMA
                • Interface operations
                • Payload description
                • PUMA REST service XML schema document
                • Error codes
                • Data types for attributes
              • How the portal implements the remote PUMA REST service
                • URL path segment for virtual portals
                • Identifiers used in the Portal Implementation
                • Access Control Checks
                • Using ATOM/APP as input and output format
                • Switch for tunneling of HTTP methods
                • HTTP caching
                • Context root and authentication mechanism
                • Lookup facility in the portal
              • DX User and Groups REST API explorer
          • URL Generation
            • URL generation by using the Navigational State SPI
              • Object Model
              • Accessor SPI
              • URL generation services
            • Creating custom links to portlets and pages
      • Guide Me
        • How-to
          • API
            • None
          • Content
            • How to get the UUID and Path of WCM content objects using a command Line
          • Web Content Manager Library Management
        • Troubleshooting
          • Web-browser
            • How to collect a Fiddler trace (HAR-file)
        • Glossary
          • Tips for searching the Help Center
        • Disclaimers
        • Notices
    • HCL Mosaic 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
        • 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
        • 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
              • Overview
              • 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 iOS
            • 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
              • Overview
              • 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 Volt MX Reference Architecture
              • Views
              • Controllers
              • Models
              • Views and Controllers
              • Models and Controllers
              • Volt MX 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 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
          • Preface
          • Foundry SDKs
          • Environments - Volt MX Cloud
          • Default Access Control Lists (ACLs) on New Apps and Services
          • 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 a Project from an Earlier Version
            • 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 Enablement
          • 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
              • Logic
              • Invoking a Messaging Service
              • Invoking a Metrics Service
              • Overview
                • 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
              • Logic
              • 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 - 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)
        • 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
    • HCL Mosaic Leap
      • What's New?
        • Overview
        • What is HCL Leap, and how is it used?
        • Release Notes
          • Accessibility overview { #experiencebuilderaccessibility .concept }
          • Accessibility features for application designers
          • Accessibility features for application users
        • Guide Me
          • Tutorials for app design
          • Video -- Creating and deploying an application using Leap
            • Building a Survey application { #buildingasurveyapplication .learningOverview}
            • Building a survey with Leap
            • Tutorial summary
            • Adding tables and workflow elements to a Leap form { #addingworkflowtoaform .learningOverview}
            • Adding tables to forms
            • Adding workflow Stages to a form
            • Applying access control through Roles
            • Tutorial summary
        • Administering Leap { #administering_leap .concept }
        • Admin Configuration Page
        • Admin Application Dashboard
          • Integrating with HCL Volt MX Foundry { #Foundry_integration_leap .concept}
          • Use integration services defined in HCL Volt MX Foundry
          • User Tracking
          • Configuring { #configtocdita .concept }
          • Troubleshooting Leap
        • Building Apps { #creatingandmanagingapplicationstoc .concept }
          • Application Management { #applicationoperations .concept }
          • Creating an application
          • Creating an application from an excel spreadsheet
          • Deploying an application
          • Launching an application
          • Viewing submitted responses
          • Viewing application history
          • Upgrading an application design
          • Updating and stopping a deployment
          • Duplicating an application
          • Using the Editor
          • Basic Concepts
          • Palette items
          • Copying items
          • Moving items on a form
            • Creating an accessible application { #creatinganaccessibleapplication .concept }
            • Using a Text item as a label
          • Enabling dynamic layout
            • Adding specialized form items { #introductiontospecializedwidgets .concept}
            • Echoing text with a Text item
            • Adding tables to a form
            • Adding HTML fragments to a form
            • Managing the files associated with your application { #managingthefilesassociatedwithyourapplication .concept}
            • Uploading files for use in your application
          • Adding dynamic behavior to Leap applications { #addingdynamicbehavior .concept }
            • Adding formulas to your application { #addingformulastoyourapplication .concept }
            • Creating a Formula from the Properties side panel
            • Creating a formula from the Settings tab
            • Running a formula from an event
            • Creating rules in your application
            • Setting rules on form items
            • Setting rules on pages in an application
            • Setting rules on Stages
            • Incorporating web services into your applications { #usingapplicationsasservices .concept }
            • Adding and configuring a service
            • Service Oriented Architecture – Exposing a service to Leap
            • Triggering a service from a button
            • Using a service to populate form items
            • Cancelling user submit event
            • Integrating your application with existing Leap applications
            • Adding stages to an application { #configuringwhatusersseeaftersubmittingaform .concept}
            • Editing the message a user sees upon form submission
            • Redirecting users after form submission
            • Sending an email after a user submits a form
            • Populating information upon form submission using a web service
            • Assigning users to a role after submission
            • Configuring behavior of a form on submission
            • Saving work as a draft
            • Scenario -- hidden or read-only form items in Stages
            • None
            • Sample Functions
          • Adding Custom Behaviour
          • Working with attachments
          • Working with application data { #danaanalysisandexportingdata .concept }
          • Changing the Saved Value of a form item
          • Adding Data Labels to form items
            • Exporting data from your application { #exportingdatafromyourapplication .task }
            • Controlling data available for export
          • Importing data in View Data
          • Securing { #securitytoc .concept}
          • Defining basic security roles for users
          • Assigning users or groups to roles
          • Setting Stage permissions
          • Defining permissions to share data with other applications
          • Assigning users to maintain the application
          • Setting up security for anonymous access
          • Styling your application
          • Styling your application with a custom theme
            • Using CSS files { #usingcssfiles .concept }
            • Adding customized CSS to your application
            • Removing a custom style sheet
          • Globalization features { #experiencebuilderglobalization .concept }
          • Setting a language
          • Leap document integration { #generatingfillablepdfs .concept }
          • Adding a PDF to Leap
          • Mapping form items to PDF fields
          • Mapping form items to PDF fields and storing the filled PDF
          • Creating the PDF trigger
          • Document integration usage details
          • Saving a PDF to a file location
        • Performance Recommendations
        • Reference { #reference .reference }
          • REST API reference { #restapireference .reference }
            • Data access REST API { #ref_rest_public_REST_API .reference }
              • List
              • Filtering Data REST API results
            • Retrieve
            • Create
            • Update
            • Delete
            • Retrieve Attachment
            • Create Attachment
          • Application management REST API
          • Application statistics REST API
          • My tasks REST API
          • User Actions REST API
          • Swagger UI
          • JavaScript API { #ref_jsapi .reference }
            • Running Custom JavaScript – Events { #runningcustomjavascriptevents .reference }
            • Application Events
            • Form Events
            • Page Events
            • Item Events
          • Running Custom JavaScript Files
            • Reference Objects and Functions { #referenceobjectsandfunctions .reference }
              • Interface objects { #userinterfaceobjects .reference }
              • Application objects
              • Form objects
              • Page and App Page objects
              • Item objects
              • Other objects
            • Data objects
          • JavaScript Security
          • Services { #servicesoverview .reference }
          • Basic Credentials Provider
          • Cookie Credentials Provider
          • Header Credentials Provider
          • Java 2 Connector (J2C) Authentication Credentials Provider
            • Service Description
            • Localizing Service Descriptions
            • Mapping Data for a Service Description
            • Deploying a Service Description
            • Troubleshooting a service description
          • HTTP Service Transport
        • Embedding items in an iframe
        • Embedding API
        • Creating customized Cascading Style Sheets
          • Custom Widget API { #customwidgetapi_landing .concept }
          • Data Widgets vs Display Widgets
          • Data Types
          • Rules
          • Built-In Properties
          • Custom Properties
          • Widgets with Options
          • Widget Instantiation
          • Aggregation Widgets
          • Validation
          • Internationalization
          • Usage of JavaScript API
          • Versioning
          • Upgrading
          • Security Considerations
          • Incorporating third-party libraries
          • Known limitations
          • Examples

    Overview

    These topics show you how to create offline-enabled applications.

    • Offline Objects API Developer's Guide
    • Offline Objects Getting Started Guide
    • Offline Objects Support in Windows 10
    • Offline Objects User Guide
    • PetStore Management Sample (VoltMX Foundry)
    Made with Material for MkDocs