HCL Volt MX Documentation

https://help.hcl-software.com/voltmx/v9.5/
Admin
HCL Volt MX is an industry-leading low-code app-dev platform for professional developers, low-code...
Tokens:3,044,433
Snippets:14,506
Trust Score:10
Update:1 year ago
Show doc for...
Tokens:
Raw
### Volt MX Getting Started

Source: https://help.hcl-software.com/voltmx/v9.5/Foundry/engagement_api_guide/Content/REST_API__SMS/Get_SMS_Config

Guide for new users to get started with HCL Volt MX, covering initial setup and basic concepts.

```APIDOC
Getting Started:
  ../../Introducing_Volt_MX.html
  - Initial setup and basic concepts for new users.
```

--------------------------------

### HCL Volt MX - Installation Guides

Source: https://help.hcl-software.com/voltmx/v9.5/Iris/iris_widget_prog_guide/Content/RichText_Method

Links to installation guides for HCL Volt MX, covering setup and configuration for various components.

```APIDOC
Installation Guides:
  ../../../Foundry/installationGuides.html
    - Resources for installing Volt MX components.
```

--------------------------------

### Volt MX Foundry Installation Guide - Windows

Source: https://help.hcl-software.com/voltmx/v9.5/Foundry/voltmx_foundry_manual_install_guide/Content/Installing_VoltMX_Integration_on_JBoss

Detailed guide for installing Volt MX Foundry on Windows operating systems. Includes setup, configuration, and verification procedures.

```Installation Guide
Volt MX Foundry Installation Guide - Windows:
  1. Prerequisites:
     - Supported Windows versions.
     - Required software (Java JDK, Maven).
     - Database server setup.

  2. Installation Steps:
     - Obtaining the Windows installer.
     - Executing the setup wizard.
     - Specifying installation directories.
     - Configuring the application server (e.g., Tomcat).

  3. Configuration:
     - Database credentials and connection strings.
     - Network port assignments.
     - SSL/TLS configuration.

  4. Verification:
     - Checking service status.
     - Launching the Foundry dashboard.
     - Testing core functionalities.
```

--------------------------------

### VoltMX Incremental Setup Example (Objective-C)

Source: https://help.hcl-software.com/voltmx/v9.5/Foundry/offline_objectsapi_reference_guide/Content/incrementalSetup

Provides a practical example of how to implement the incrementalSetup method in Objective-C for VoltMX applications. It shows the setup of client, handlers, and the actual call to the incrementalSetup method.

```Objective-C
NSError _ error;
VMXClient _ client = [VMXClient sharedClient];
VMXApplicationSync * applicationSync = [client getOfflineObjects];

VMXSuccessCompletionHandler onSuccess = ^ void(id object) {
NSLog(@"incremental Setup successful");
};

VMXFailureCompletionHandler onFailure = ^ void(id object) {
NSLog(@"incremental Setup failed");
};

NSDictionary < NSString _ , id > _ options = nil;

[applicationSync incrementalSetup: options
onSuccess: onSuccess
onFailure: onFailure
];
```

--------------------------------

### Volt MX Foundry Installation Guide

Source: https://help.hcl-software.com/voltmx/v9.5/Iris/iris_user_guide/Content/AddLocalHTMLContent

Instructions and prerequisites for installing the Volt MX Foundry platform. This includes setup for various environments.

```APIDOC
Volt MX Foundry Installation:
  - Prerequisites for installation.
  - Step-by-step installation procedures.
  - Configuration options post-installation.
```

--------------------------------

### Volt MX Foundry Installation Guide

Source: https://help.hcl-software.com/voltmx/v9.5/Iris/iris_widget_prog_guide/Content/PDFView_Methods

Provides instructions and guidance for installing Volt MX Foundry. This includes prerequisites, setup steps, and configuration details for a successful deployment.

```APIDOC
Volt MX Foundry Installation Guide:

This guide details the process of installing Volt MX Foundry. It covers system requirements, installation procedures for different environments, and post-installation verification steps.

Key aspects:
- Prerequisites (hardware, software)
- Installation steps for server components
- Configuration of databases and other services
- Troubleshooting common installation issues

Consult the guide for a step-by-step installation process.
```

--------------------------------

### Volt MX Foundry Command Line Install Guide

Source: https://help.hcl-software.com/voltmx/v9.5/Foundry/installing_foundry

Provides instructions and examples for installing Volt MX Foundry using its command-line interface (CLI). This guide details the commands and options available for automated or script-based installations.

```bash
# Example command structure for Volt MX Foundry CLI installation
# installer_cli.sh --install --type <installation_type> --config <config_file.yml>
```

--------------------------------

### Volt MX Foundry Preinstallation Tasks

Source: https://help.hcl-software.com/voltmx/v9.5/Foundry/voltmx_foundry_manual_install_guide/Content/Configuring_Transactions_Identity_Tomcat

Lists essential preinstallation tasks required before installing Volt MX Foundry, including database setup, Flyway configuration, app server preparation, and middleware home setup.

```APIDOC
Volt MX Foundry Preinstallation Tasks:

- Database Prerequisites.
- Required Setup Files.
- Encrypt Passwords.
- Configure Flyway Command-line Tool.
- Prepare App Servers.
- Set up Middleware Home.
- Configure Installation Mode for App Servers.
```

--------------------------------

### Start Volt MX Foundry Installer

Source: https://help.hcl-software.com/voltmx/v9.5/Foundry/voltmx_foundry_linux_install_guide/Content/Upgrading_VoltMX_Foundry_SP1

Executes the Volt MX Foundry installer binary on Linux to begin the installation or upgrade process.

```shell
./VoltMXFoundryInstaller-GA.bin
```

--------------------------------

### Install and Start Memcached Server

Source: https://help.hcl-software.com/voltmx/v9.5/Foundry/voltmx_foundry_windows_install_guide/Content/Pre-installation_Tasks

Commands to install, start, and configure Memcached server on Windows. Includes registry modification for memory allocation to run as a service.

```shell
memcached.exe -d install
```

```shell
memcached.exe -d start
```

```shell
net start memcached Server
```

```shell
C:/memcached/memcached.exe -d runservice -m 2048
```

--------------------------------

### Installing Foundry Guide

Source: https://help.hcl-software.com/voltmx/v9.5/Iris/iris_api_dev_guide/content/accelereometer_apis

Guide for installing and setting up Volt MX Foundry.

```APIDOC
Installing Foundry:
  Step-by-step instructions for installing and configuring Volt MX Foundry.
  Covers prerequisites, installation process, and initial setup.
```

--------------------------------

### Engagement Demo App QuickStart Guide (for Android Devices)

Source: https://help.hcl-software.com/voltmx/v9.5/Foundry/vms_console_user_guide/Content/Apps/Modifying_Platform

A quick start guide for the Volt MX Foundry Engagement Services Demo App on Android Devices. It provides instructions for setting up and running the demo application on Android.

```APIDOC
Engagement Demo App QuickStart Guide (for Android Devices):
  - Instructions for setting up and running the demo app on Android.
  - Related: Volt MX Foundry Engagement Services Demo App QuickStart Guide - Apple iOS, Volt MX Foundry Engagement Services JPush QuickStart Guide
```

--------------------------------

### Volt MX Foundry Installation Guides

Source: https://help.hcl-software.com/voltmx/v9.5/Foundry/voltmx_foundry_manual_install_guide/Content/Foundry_in_WebSphere_Liberty

Provides installation documentation for Volt MX Foundry on Linux and Windows operating systems, detailing supported environments and setup procedures.

```APIDOC
Volt MX Foundry - Supported OS, Application Servers, and Databases Guide:
  - Details the compatibility matrix for Volt MX Foundry.
  - Covers supported operating systems, application servers, and databases.

Volt MX Foundry Installation Guide - Linux:
  - Step-by-step instructions for installing Volt MX Foundry on Linux.
  - Includes prerequisites, configuration, and post-installation steps.

Volt MX Foundry Installation Guide - Windows:
  - Step-by-step instructions for installing Volt MX Foundry on Windows.
  - Includes prerequisites, configuration, and post-installation steps.
```

--------------------------------

### Volt MX Foundry Installation Guide - Linux

Source: https://help.hcl-software.com/voltmx/v9.5/Foundry/voltmx_foundry_manual_install_guide/Content/Installing_VoltMX_Integration_on_JBoss

Step-by-step instructions for installing Volt MX Foundry on Linux operating systems. Covers prerequisites, configuration, and post-installation steps.

```Installation Guide
Volt MX Foundry Installation Guide - Linux:
  1. Prerequisites:
     - Supported Linux distributions (e.g., Ubuntu, CentOS).
     - Required software packages (Java, Maven, etc.).
     - Database setup (e.g., MySQL, PostgreSQL).

  2. Installation Steps:
     - Downloading the installer.
     - Running the installation script.
     - Configuring environment variables.
     - Setting up the application server (e.g., Tomcat).

  3. Configuration:
     - Database connection details.
     - Server port configurations.
     - Security settings.

  4. Post-Installation:
     - Verifying the installation.
     - Starting and stopping Foundry services.
     - Accessing the Foundry console.
```

--------------------------------

### Installing Foundry Guide

Source: https://help.hcl-software.com/voltmx/v9.5/Iris/iris_api_dev_guide/content/drag_and_drop_api

Guide for installing and setting up Volt MX Foundry.

```APIDOC
Installing Foundry:
  Step-by-step instructions for installing and configuring Volt MX Foundry.
  Covers prerequisites, installation process, and initial setup.
```

--------------------------------

### Volt MX Foundry Start and Stop Operations

Source: https://help.hcl-software.com/voltmx/v9.5/Foundry/voltmx_foundry_manual_install_guide/Content/Configuring_Transactions_Identity_Tomcat

Instructions on how to start and stop the Volt MX Foundry Console service.

```APIDOC
Volt MX Foundry Start/Stop:

- How to Start Volt MX Foundry Console.
- How to Stop Volt MX Foundry Console.
```

--------------------------------

### Volt Foundry Installer Console Output

Source: https://help.hcl-software.com/voltmx/v9.5/Foundry/voltmx_foundry_linux_install_guide/Content/Patch_Installer_-_Linux

Example output from the Volt Foundry patch installer running in console mode. It shows the initialization and preparation stages before user input is required.

```shell
[root@mbaastest11 ~]# chmod +x VoltFoundryPatchInstaller-9.5.x.QA.bin
[root@mbaastest11 ~]# ./VoltFoundryPatchInstaller-9.5.x.QA.bin
Preparing to install...
Extracting the installation resources from the installer archive...
Configuring the installer for this system's environment...

Launching installer...
====================================
Volt Foundry (created with InstallAnywhere)
------------------------------------
Preparing CONSOLE Mode Installation...

```

--------------------------------

### Manage JBoss Server (Windows/Linux)

Source: https://help.hcl-software.com/voltmx/v9.5/Foundry/voltmx_foundry_manual_install_guide/Content/Starting_VoltMX_Foundry_Console

Details how to stop and start the JBoss server for Volt MX Foundry. Includes commands for Linux and instructions for Windows service management and starting the standalone server.

```batch
Restart Windows service from services.msc
{AppServer Location}/jboss/bin > standalone.bat
```

```shell
Kill running Volt Foundry on JBoss service using command in Linux
[/root/Foundry83JBOSSSINGLE/jboss/bin]# ./startjboss.sh
```

--------------------------------

### Volt MX Foundry Engagement Services Demo App QuickStart Guide - Apple iOS

Source: https://help.hcl-software.com/voltmx/v9.5/Foundry/vms_console_user_guide/Content/Apps/Modifying_Platform

A quick start guide for the Volt MX Foundry Engagement Services Demo App on Apple iOS. It guides users through setting up and running the demo application on iOS devices.

```APIDOC
Volt MX Foundry Engagement Services Demo App QuickStart Guide - Apple iOS:
  - Instructions for setting up and running the demo app on iOS.
  - Related: Volt MX Foundry Engagement Services JPush QuickStart Guide, Engagement Demo App QuickStart Guide (for Android Devices)
```

--------------------------------

### Volt Foundry Pre-Installation Summary

Source: https://help.hcl-software.com/voltmx/v9.5/Foundry/voltmx_foundry_linux_install_guide/Content/Patch_Installer_-_Linux

Example output showing the Pre-Installation Summary screen from the Volt Foundry patch installer. This screen lists the components that will be updated by the applied patch.

```shell
====================================
Pre-Installation Summary
------------------------

This patch will update the following components : <List of components>

Please refer to release notes.

```

--------------------------------

### Execute Volt MX Foundry Console Installer

Source: https://help.hcl-software.com/voltmx/v9.5/Foundry/voltmx_foundry_manual_install_guide/Content/Installing_VoltMX_Foundry_on_Linux

Launches the Volt MX Foundry Console installer binary to begin the installation process. This executable handles the guided installation of the console and its components.

```shell
./VoltMXFoundryConsoleInstaller-6.0.1.GA.bin
```

--------------------------------

### Volt MX Foundry Tomcat Installation Steps

Source: https://help.hcl-software.com/voltmx/v9.5/Foundry/voltmx_foundry_manual_install_guide/Content/Configuring_Transactions_Identity_Tomcat

Details the steps for installing Volt MX Foundry components on Tomcat, including database configuration, JNDI setup, property file configuration, and WAR file deployment for Console, Identity, Integration, Developer Portal, and Engagement Services.

```APIDOC
Volt MX Foundry Tomcat Installation:

1.  **Console Installation**:
    - Create and Configure Database for Accounts.
    - Configure JNDI for Tomcat.
    - Configure Properties Files in WAR Files.
    - Deploy updated WAR files to Tomcat.

2.  **Identity Installation**:
    - Create and Configure Database for Identity Services.
    - Configure JNDI for Tomcat.
    - Configure Java Transactions API (JTA) for Identity Services.
    - Configure Properties Files in WAR Files.
    - Deploy updated WAR files to Tomcat.

3.  **Integration Services Installation**:
    - Create and Configure Database for Integration Services (Admin).
    - Create and Configure Database for Integration Services (Reports).
    - Configure JNDI for Integration Services.
    - Deploy updated WAR files to Tomcat.

4.  **Developer Portal Installation**:
    - Configure Properties Files in Tomcat.

5.  **Engagement Services Installation**:
    - Create a database for Volt MX Engagement Services.
    - Database Setup through Flyway.
    - Set Up Engagement Services.
    - Configure Engagement Services on Tomcat Server.

6.  **Multinode Tomcat Installation**:
    - How to Configure Volt MX Foundry on Tomcat Multinode.
```

--------------------------------

### Installing Volt MX Foundry

Source: https://help.hcl-software.com/voltmx/v9.5/Iris/iris_api_dev_guide/content/gestures

A guide on the process of installing Volt MX Foundry.

```APIDOC
Installing Foundry

Content:
  Installation steps for Volt MX Foundry.
```

--------------------------------

### Execute Volt Foundry Patch Installer

Source: https://help.hcl-software.com/voltmx/v9.5/Foundry/voltmx_foundry_linux_install_guide/Content/Patch_Installer_-_Linux

Runs the Volt Foundry patch installer binary to begin the patching process. This command initiates the installation wizard.

```shell
./VoltFoundryPatchInstaller-9.5.x.QA.bin
```

--------------------------------

### Volt MX Foundry CLI Installer Reference

Source: https://help.hcl-software.com/voltmx/v9.5/Foundry/voltmx_foundry_manual_install_guide/Content/Configuring_Transactions_Identity_Tomcat

Documentation for the Volt MX Foundry Command Line Interface (CLI) installer.

```APIDOC
Volt MX Foundry CLI Installer:

- Volt Foundry Command Line Installer.
```

--------------------------------

### Start Memcached Server on Windows

Source: https://help.hcl-software.com/voltmx/v9.5/Foundry/voltmx_foundry_manual_install_guide/Content/Install_Memcached_Server

Commands to start the Memcached service on Windows. You can use either the command prompt or the 'net start' command.

```Shell
c:/memcached/memcached.exe -d start
```

```Shell
net start memcached Server
```

--------------------------------

### Volt MX Installation Guides

Source: https://help.hcl-software.com/voltmx/v9.5/Foundry/engagement_api_guide/Content/REST_API__SMS/Get_SMS_Config

Central hub for all Volt MX installation guides, covering different components and environments.

```APIDOC
Installation Guides:
  ../installationGuides.html
  - Comprehensive guides for installing Volt MX components.
```

--------------------------------

### Volt MX Foundry Installation Guide

Source: https://help.hcl-software.com/voltmx/v9.5/Iris/iris_user_guide/Content/SUGWindows_Mobile

Instructions for installing and setting up Volt MX Foundry, including prerequisites and configuration steps for various environments.

```APIDOC
Installing Foundry:
  Provides step-by-step instructions for the installation process of Volt MX Foundry.
```

--------------------------------

### Application Submission Guidelines

Source: https://help.hcl-software.com/voltmx/v9.5/Iris/iris_user_guide/Content/BuildApplicationsForWindows10

References for creating app packages and submitting applications to the Windows Store. These links provide detailed guidance from Microsoft MSDN on the packaging and submission process.

```APIDOC
API: Windows Store Application Submission

Description: Guidelines and procedures for packaging and submitting applications to the Windows Store.

References:
- Create app packages: https://msdn.microsoft.com/en-us/library/hh454036.aspx
- Windows hardware development: https://msdn.microsoft.com/en-us/library/windows/hardware/dn265142%28v=vs.85%29.aspx
```

--------------------------------

### Volt MX Tutorials Overview

Source: https://help.hcl-software.com/voltmx/v9.5/Foundry/vms_console_user_guide/Content/Subscribers/Adding_a_User

This section lists various tutorials available for HCL Volt MX, covering a wide range of development and platform functionalities. It serves as a central point for learning about specific features and best practices.

```APIDOC
Tutorials:
  - Overview: Provides a general introduction to tutorials.
  - Action Editor: Guide on using the Action Editor for application logic.
  - API Management: Documentation on managing APIs within Volt MX.
  - App Factory: Information on the App Factory service.
  - Architecture: Details on Volt MX architecture.
  - Build And Productivity: Tips for efficient development.
  - Components and Marketplace: Using and developing components.
  - Connecting to Backend: How to integrate with backend services.
  - Designing For Web: Guidelines for web application design.
  - Designing the Layout: Principles for UI layout.
  - Internationalization and Localization: Support for multiple languages.
  - Notification and Analytics: Implementing notifications and analytics.
  - Offline Services: Working with offline data synchronization.
  - Programming and Extensibility: Advanced programming concepts.
  - Volt MX Foundry Overview: Introduction to Volt MX Foundry.
```

--------------------------------

### Volt Foundry Installer Input Prompts

Source: https://help.hcl-software.com/voltmx/v9.5/Foundry/voltmx_foundry_linux_install_guide/Content/Patch_Installer_-_Linux

Example of the interactive prompts presented by the Volt Foundry patch installer during a console installation. Users must provide the location of the patch file and the existing installation directory.

```shell
====================================
Introduction
------------

Thank you for choosing to upgrade Volt Foundry!

Please provide the below details to proceed with the upgrade.
Please provide the location of the patch file : (Default: ): /root/sample.zip
Please provide the location of existing installation : (Default: ): /root/MFJB6525132

```

--------------------------------

### Install Volt MX Foundry Console

Source: https://help.hcl-software.com/voltmx/v9.5/Foundry/voltmx_foundry_linux_install_guide/Content/Installing_VoltMX_Foundry_Tomcat

Starts the Volt MX Foundry Console installer in console mode. This script guides the user through the installation process, including accepting prerequisites and license agreements.

```shell
Preparing to install
Extracting the JRE from the installer archive...
Unpacking the JRE...
Extracting the installation resources from the installer archive.
Configuring the installer for this system's environment...

Launching installer...

========================
Volt MX  Foundry
(created with InstallAnywhere)
-------------------------------
Preparing CONSOLE Mode Installation...
======================================
Introduction
------------

This installer will install a new or upgrade an existing instance of Foundry.

Volt MX  Foundry is a set of enterprise-grade mobile infrastructure services

that makes it easy to build amazing apps that integrate and support all of

your backend systems. With open, standards-based development, scalable and

secure services, and exceptional agility, enterprises can dramatically reduce

the cost and complexity of enterprise mobility projects.

To proceed with installation, please confirm that the following prerequisites
have been met -

a. Database server with admin user for installation. MySQL, MariaDB, Oracle
and MS SQL Server are the supported Database servers. MariaDB is supported for
Tomcat/JBoss only

b. Corresponding database user should exist and that user should have all
required privileges as per the documentation.

c.If you want to use your existing SSL certificate then please have the SSL
certificate mapped to the domain name you want to use.

d. If you want to install with JBoss as an option for application server, then
have the application server preconfigured. Please note that single node JBoss
is also bundled as part of the installer, in case you want to install afresh.

To change input, type 'back' to go back to the previous step.

To cancel the installation, type 'quit' at any time.

For troubleshooting & help on the installation, use
https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Foundry/installationGuides.html.

For getting started on Volt MX Foundry, refer
https://opensource.hcltechsw.com/volt-mx-docs/95/docs/documentation/Foundry/voltmx_foundry_user_guide/Content/Introduction.html.

If you have more questions or feedback, you can join our
community at https://support.hcltechsw.com/community?id=community_forum&sys_id=1cdf6e1a1bf31898beab64e6ec4bcbae or raise a support ticket at https://support.hcltechsw.com/csm.

->1- Continue with Installation.
  2- Abort Installation.

ENTER THE NUMBER OF THE DESIRED CHOICE, OR PRESS  TO ACCEPT THE DEFAULT:

```

--------------------------------

### Download Flyway Command Line Tool

Source: https://help.hcl-software.com/voltmx/v9.5/Foundry/voltmx_foundry_manual_install_guide/Content/VPNS/DB_Setup_VMS_Flyway

Provides the URL to download the Flyway command-line tool, which is a prerequisite for performing database setup and migrations.

```URL
https://flywaydb.org/getstarted/download
```

--------------------------------

### Volt MX Iris Installation Guide

Source: https://help.hcl-software.com/voltmx/v9.5/Foundry/engagement_api_guide/Content/REST_API__SMS/Get_SMS_Config

Instructions for installing the Volt MX Iris component, ensuring a proper setup for development environments.

```APIDOC
Iris:
  Installing Iris:
    ../../Iris/installing_iris.html
    - Instructions for installing the Volt MX Iris component.
```

--------------------------------

### Installer Error: Invalid Hostname/IP Address

Source: https://help.hcl-software.com/voltmx/v9.5/Foundry/voltmx_foundry_linux_install_guide/Content/Installing_VoltMX_Foundry_Tomcat

Displays an error message when an invalid hostname or IP address is provided during the installation setup, guiding the user to re-enter valid details or abort.

```text
===============================================================================
Invalid Hostname/IP Address
---------------------------

Please enter a valid hostname/IP address.

 ->1- Go back to give valid details.
   2- Abort Installation.

ENTER THE NUMBER OF THE DESIRED CHOICE, OR PRESS <ENTER> TO ACCEPT THE DEFAULT:

```

--------------------------------

### HCL Volt MX Documentation Navigation

Source: https://help.hcl-software.com/voltmx/v9.5/Foundry/engagement_api_guide/Content/REST_API_Administration/Create_Audience_Attribute

This snippet outlines the main navigation structure for HCL Volt MX documentation, categorizing content into core modules like Introduction, Getting Started, What's New, Release Notes, App Platform, Tutorials, Installation Guides, Iris, and Foundry.

```APIDOC
HCL Volt MX Documentation:
  - Introducing Volt MX
  - Getting Started
  - What's New
    - All versions
    - V9 Service Pack 5 Fix Pack 15
    - V9 Service Pack 5
    - V9 Service Pack 2
    - V9 Service Pack 1
    - V9
  - Release Notes
  - App Platform
    - Overview
  - Tutorials
    - Overview
    - Action Editor
    - API Management
    - App Factory
    - Architecture
    - Build And Productivity
    - Components and Marketplace
    - Connecting to Backend
    - Designing For Web
    - Designing the Layout
    - Internationalization and Localization
    - Notification and Analytics
    - Offline Services
    - Programming and Extensibility
    - Volt MX Foundry Overview
  - Installation Guides
  - Iris
    - Fundamentals
    - Installing Iris
    - Iris tutorials
    - Iris User Guide
    - Application Design and Development Guidelines
    - Volt Iris API Developers Guide
    - Native Function API Developers Guide
    - Iris Widget Programmer Guide
    - Iris Wearables Developer Guide
    - Using the Volt MX App
    - Volt MX Reference Architecture Guide
  - Foundry
    - Fundamentals
    - Installing Foundry
    - Volt MX Foundry User Guide
    - OAuth Sample App Guide
    - Integration Services
      - Overview
```

--------------------------------

### Volt MX Foundry Deployment Guide

Source: https://help.hcl-software.com/voltmx/v9.5/Iris/app_design_dev/Content/General_UI_guidelines

Provides instructions and best practices for deploying Volt MX Foundry environments, including on-premises and cloud setups.

```APIDOC
Volt MX Foundry Deployment Guide:
  Deployment Options:
    - On-Premises: Deploying Foundry on your own infrastructure.
    - Cloud: Deploying Foundry on cloud platforms (e.g., AWS, Azure, GCP).
    - Containerization: Using Docker and Kubernetes for scalable deployments.

  Prerequisites:
    - Supported operating systems and databases.
    - Required Java Development Kit (JDK) version.
    - Network configuration for accessibility.

  Deployment Steps:
    1. Download the Foundry installer or container images.
    2. Configure environment variables and database connections.
    3. Run the installer or deploy containers.
    4. Verify the deployment by accessing the Foundry Console.

  High Availability and Disaster Recovery:
    - Configure load balancing and failover mechanisms.
    - Implement backup and restore strategies for data and configurations.
```

--------------------------------

### Volt MX Foundry Server Startup Prompt

Source: https://help.hcl-software.com/voltmx/v9.5/Foundry/voltmx_foundry_linux_install_guide/Content/Upgrading_VoltMX_Foundry_SP1

Asks the user if the Volt MX Foundry server should be started automatically after a successful installation or upgrade.

```text
================================================================ תח=
Volt MX Foundry server startup details
\----------------------------------

Do you want to start the Volt MX Foundry server after successful installation of Volt MX Foundry

\->1- Yes
2- No

ENTER THE NUMBER FOR YOUR CHOICE, OR PRESS
<ENTER> TO ACCEPT THE DEFAULT::
```

--------------------------------

### Volt MX Foundry Initial User Setup Commands

Source: https://help.hcl-software.com/voltmx/v9.5/Foundry/voltmx_foundry_linux_install_guide/Content/Troubleshooting

Sets up the initial user context and grants essential privileges for Volt MX Foundry operations. This includes selecting a database, creating a user, and assigning broad permissions.

```Shell
use <prefix>idconfigdb<suffix>
GO
create user userId from LOGIN loginId;
GO
GRANT CREATE TABLE,CREATE TYPE,CREATE PROCEDURE,SELECT,UPDATE,DELETE,INSERT,EXECUTE,REFERENCES,CREATE VIEW,ALTER TO userId
GO
```

--------------------------------

### Volt MX Foundry Fundamentals and Installation

Source: https://help.hcl-software.com/voltmx/v9.5/Iris/iris_user_guide/Content/C_CreatingComponent

Overview of Volt MX Foundry, its core concepts, installation procedures, and user guides for administration and integration.

```APIDOC
Foundry Fundamentals:
  - Introduces the core concepts and architecture of Volt MX Foundry.

Installing Foundry:
  - Step-by-step guide for setting up Volt MX Foundry in a development or production environment.

Volt MX Foundry User Guide:
  - Comprehensive guide covering the usage and features of the Foundry platform.

OAuth Sample App Guide:
  - Demonstrates the implementation of OAuth authentication flows within Foundry services.

Integration Services:
  - Details on creating, configuring, and managing integration services to connect with backend systems.

Administering Foundry:
  - Information on managing Foundry users, roles, security, and overall platform administration.

App Services Console User Guide:
  - Guide for using the console to manage and monitor application services built with Foundry.

App Factory User Guide:
  - Documentation for using App Factory for application build, deployment, and lifecycle management.

Volt MX Foundry Deployment Guide:
  - Instructions and best practices for deploying Foundry environments.

Volt MX Analytics & Reporting Cloud FAQs:
  - Frequently asked questions related to Foundry's analytics and reporting capabilities.

Integration Services Troubleshooting Guide:
  - Guidance on diagnosing and resolving common issues encountered with integration services.
```

--------------------------------

### Full Notification Setup Example

Source: https://help.hcl-software.com/voltmx/v9.5/Iris/iris_api_dev_guide/content/voltmx.notificationssettings_functions

A comprehensive example showing the creation of multiple notification actions, a category, and then registering the category with the system.

```javascript
/*************************************************************************************
 * Function:registerActions()
 * Description: Creates Actions and a Category.
 * Author: Volt MX
 ************************************************************************************/
function registerActions() {
    var accept = voltmx.notificationsettings.createAction({
        "id": "Accept",
        "label": "Accept",
        "pspConfig": {
            "authenticationRequired": true,
            "destructive": true,
            "activationMode": voltmx.notificationsettings.ACTIVATION_MODE_FORWARDS,
            "visibleOn": voltmx.notificationsettings.BOTH
        }
    });

    var reject = voltmx.notificationsettings.createAction({
        "id": "Reject",
        "label": "Reject",
        "pspConfig": {
            "authenticationRequired": false,
            "destructive": false,
            "activationMode": voltmx.notificationsettings.ACTIVATION_MODE_FORWARDS,
            "visibleOn": voltmx.notificationsettings.BOTH
        }
    });

    var decline = voltmx.notificationsettings.createAction({
        "id": "Decline",
        "label": "Decline",
        "pspConfig": {
            "activationMode": voltmx.notificationsettings.ACTIVATION_MODE_BACKWARDS,
            "authenticationRequired": true,
            "destructive": false,
            "visibleOn": voltmx.notificationsettings.BOTH
        }
    });

    var defaultActionContextArr = [accept, reject, decline];
    var minimalActionContextArr = [accept, reject];

    var categoryObj = voltmx.notificationsettings.createCategory({
        "categoryId": "invitation",
        "actions": defaultActionContextArr,
        "pspConfig": {
            "minimalActions": minimalActionContextArr
        }
    });

    //Using voltmx.notificationsettings.registerCategory

    var categoryArr = [categoryObj];

    var registerCategory = voltmx.notificationsettings.registerCategory({
        "categories": categoryArr,
        "pspConfig": {
            "types": [0, 1, 2]
        }
    });

}

```

--------------------------------

### Volt MX Tutorials Overview

Source: https://help.hcl-software.com/voltmx/v9.5/Iris/iris_user_guide/Content/BuildUniversalApp

Lists various tutorials available for HCL Volt MX, covering different aspects of development and functionality.

```APIDOC
Volt MX Tutorials

Overview:
  A comprehensive list of tutorials designed to help users learn and master HCL Volt MX development.

Tutorial Categories:
  - Action Editor: Learn to use the Action Editor for defining application logic.
  - API Management: Understand how to manage and integrate APIs within Volt MX applications.
  - App Factory: Tutorials on using App Factory for build and deployment automation.
  - Architecture: Guides on understanding and designing Volt MX application architecture.
  - Build And Productivity: Tips and techniques to enhance build processes and developer productivity.
  - Components and Marketplace: Learn about creating and using components, and leveraging the marketplace.
  - Connecting to Backend: Instructions on integrating Volt MX applications with backend services.
  - Designing For Web: Guidance on designing effective web interfaces.
  - Designing the Layout: Tutorials on creating user interface layouts.
  - Internationalization and Localization: Learn to support multiple languages and regions.
  - Notification and Analytics: Implement notification systems and analytics tracking.
  - Offline Services: Develop applications with offline capabilities.
  - Programming and Extensibility: Explore advanced programming concepts and extensibility options.
  - Volt MX Foundry Overview: Introduction to Volt MX Foundry for backend integration and services.
```

--------------------------------

### Example: Publish Native Client Binaries to On-Premise

Source: https://help.hcl-software.com/voltmx/v9.5/Foundry/voltmx_foundry_user_guide/Content/CI_NativeUploadPublish

Example usage for publishing native client binaries to an on-premise installation, demonstrating the command with sample values for user, Identity URL, Console URL, app, version, environment, and client binary metadata.

```java
java -jar mfcli.jar native-publish -u abc@voltmx.com -p password -au http://10.10.24.79:8080 -cu http://10.10.24.78:8081 -a MyApp -v 2.0 -e MyEnv -cbmeta "{\"ios_phone\" : 1.2.1, \"android_phone\" : 1.2.0}"
```

--------------------------------

### Volt MX Engagement Event Management

Source: https://help.hcl-software.com/voltmx/v9.5/Foundry/engagement_api_guide/Content/REST_API_Audience_Member/Get_File_Upload_Status_by_Id

QuickStart guide for Engagement Event Management within Volt MX, detailing setup and usage for event-driven functionalities.

```APIDOC
Volt MX Engagement Event Management QuickStart Guide:
  - Introduction to Engagement Services
```

--------------------------------

### Provisioning Engagement Server in starter version of Volt MX Foundry

Source: https://help.hcl-software.com/voltmx/v9.5/Foundry/vms_console_user_guide/Content/Apps/Modifying_Platform

Guide on provisioning the Engagement Server in the starter version of Volt MX Foundry. It provides steps for initial setup and configuration.

```APIDOC
Provisioning Engagement Server in starter version of Volt MX Foundry:
  - Steps for initial setup and configuration of the Engagement Server.
  - Related: Purging Script for Engagement Services, Best practices for Push Notifications
```

--------------------------------

### Manage Tomcat Server (Windows/Linux)

Source: https://help.hcl-software.com/voltmx/v9.5/Foundry/voltmx_foundry_manual_install_guide/Content/Starting_VoltMX_Foundry_Console

Provides commands to stop and start the Tomcat server on both Windows and Linux operating systems. These commands are essential for applying configuration changes after Volt MX Foundry installation.

```batch
{AppServer Location}tomcat\bin > shutdown.bat
{AppServer Location}tomcat\bin > startup.bat
```

```shell
{AppServer Location}tomcat/bin > shutdown.sh
{AppServer Location}tomcat/bin > startup.sh
```

--------------------------------

### Example: Publish Native Client Binaries to Cloud

Source: https://help.hcl-software.com/voltmx/v9.5/Foundry/voltmx_foundry_user_guide/Content/CI_NativeUploadPublish

Example usage for publishing native client binaries to a Cloud environment, demonstrating the command with sample values for user, account, app, version, environment, and client binary metadata.

```java
java -jar mfcli.jar native-publish -u abc@voltmx.com -p password -t 100054321 -a MyApp -v 2.0 -e MyEnv -cbmeta "{\"ios_phone\" : 1.2.1, \"android_phone\" : 1.2.0}"
```

--------------------------------

### Volt MX Iris SDK - Overview and Initialization

Source: https://help.hcl-software.com/voltmx/v9.5/Foundry/voltmx_foundry_user_guide/Content/VoltMXStudio/Binary_APIs

Provides an overview of the Volt MX Iris SDK and guides on its initialization. This includes setting up the client SDK for use in applications.

```APIDOC
Volt MX Iris SDK:
  Overview: Guides on using the Volt MX Iris SDK.
  Downloading: Instructions for downloading the Volt MX IDE SDK.
  Initializing the Volt MX SDK Client SDK: Steps to initialize the client SDK for application integration.
```

--------------------------------

### VoltMX Java Service: Get and Delete with OData Parameters

Source: https://help.hcl-software.com/voltmx/v9.5/Foundry/voltmx_foundry_user_guide/Content/Custom_Code_for_Invoking_ObjectService_from_pre-post-java

Illustrates using HCL VoltMX Java services to perform 'get' and 'delete' operations, specifically demonstrating the use of OData parameters for filtering in 'get' operations. The 'delete' operation example shows a simplified invocation.

```Java
package com.hcl.voltmx.javaService.test;

import java.util.HashMap;
import java.util.Map;

import javax.servlet.http.HttpServletResponse;

import com.google.gson.JsonObject;
import com.hcl.voltmx.middleware.api.ObjectServiceInvoker;
import com.hcl.voltmx.middleware.api.ObjectServiceInvokerBuilder;
import com.hcl.voltmx.middleware.api.OperationData;
import com.hcl.voltmx.middleware.api.ServicesManager;
import com.hcl.voltmx.middleware.common.DataPostProcessor2;
import com.hcl.voltmx.middleware.common.DataPreProcessor2;
import com.hcl.voltmx.middleware.common.JavaService2;
import com.hcl.voltmx.middleware.controller.DataControllerRequest;
import com.hcl.voltmx.middleware.controller.DataControllerResponse;
import com.hcl.voltmx.middleware.dataobject.Result;
import com.hcl.voltmx.middleware.exceptions.MiddlewareException;

public class IntegrationPrePostProcessorWithJavaService
    implements DataPostProcessor2, JavaService2 {

  // Placeholder for getServiceInvokerFromJavaServiceORPREPOST method
  private ObjectServiceInvoker getServiceInvokerFromJavaServiceORPREPOST(DataControllerRequest request, String serviceName, String objectName, String operationName, Object payload, Map<String, String> oDataParam) {
      // Mock implementation for demonstration
      return null;
  }

  @Override
  public Object execute(Result result, DataControllerRequest request,
      DataControllerResponse response) throws Exception {
    Map<String, String> oDataParam = new HashMap<>();
    oDataParam.put("$filter", "id eq 2");
    //create record by passing payload
    ObjectServiceInvoker storageInvoker = getServiceInvokerFromJavaServiceORPREPOST(
        request, "RetailBanking", "Account", "get", null, oDataParam);
    result = storageInvoker.invokeServiceAndGetResult();
    System.out.println("result : " + result);
    return result;
  }

  @Override
  public Object invoke(String methodID, Object[] objectArray, DataControllerRequest request,
      DataControllerResponse response)
      throws Exception {
    Map<String, String> oDataParam = new HashMap<>();
    oDataParam.put("$filter", "id gt 2");
    ObjectServiceInvoker storageInvoker = getServiceInvokerFromJavaServiceORPREPOST(
        request, "RetailBanking", "Account", "delete", null, null);
    return storageInvoker.invokeServiceAndGetResult();
  }
}
```

--------------------------------

### Volt MX Foundry Engagement Services JPush QuickStart Guide

Source: https://help.hcl-software.com/voltmx/v9.5/Foundry/vms_console_user_guide/Content/Apps/Modifying_Platform

A quick start guide for integrating Volt MX Foundry Engagement Services with JPush. It provides step-by-step instructions for setting up push notifications using JPush.

```APIDOC
Volt MX Foundry Engagement Services JPush QuickStart Guide:
  - Focuses on integrating JPush for push notifications.
  - Related: Volt MX Foundry Engagement Services Demo App QuickStart Guide - Apple iOS, Engagement Services
```

--------------------------------

### Volt MX Tutorials - Overview

Source: https://help.hcl-software.com/voltmx/v9.5/Iris/iris_widget_prog_guide/Content/RichText_Method

Provides an overview of the tutorials available for HCL Volt MX, covering various aspects of development and functionality.

```APIDOC
Tutorials Overview:
  ../../../tutorials/Tutorials.html
    - General introduction to Volt MX tutorials.
```

--------------------------------

### Volt MX Foundry Pre-Installation Summary

Source: https://help.hcl-software.com/voltmx/v9.5/Foundry/voltmx_foundry_linux_install_guide/Content/Upgrading_VoltMX_Foundry_SP1

Presents a summary of the installation configuration before proceeding, including install type, components, folder, application server details, and database information.

```text
Pre-Installation Summary
------------------------
Please review the following before continuing:

Install Type:
Upgrade Installation

Install Components:
Console, Identity Services and Integration
Services

Install Folder:
/root/UP652TO70

Application Server:
<App Server, Installation Mode>

Application Server Details:
<Hostname/IP Address>

Database Choice:
<database>

Database Details:
<IP Address>

Database Names:
voltmxxxxx1, voltmxxxxx1, voltmxxxxx1 &
voltmxxxxx1

PRESS <ENTER> TO CONTINUE:
```

--------------------------------

### Response Mapper Example for GET Variants

Source: https://help.hcl-software.com/voltmx/v9.5/Foundry/offline_objects_user_guide/Content/Conflict_Resolution

An XML snippet representing a response mapper for VoltMX Foundry's GET variants. This mapper is used to transform the backend service response into the format expected by the client application.

```XML
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<mapper xmlns="http://www.voltmx.com/ns/mapper">
  <!-- Response mapping logic would be defined here -->
</mapper>
```

--------------------------------

### VoltMX Incremental Setup in Java

Source: https://help.hcl-software.com/voltmx/v9.5/Foundry/offline_objectsapi_reference_guide/Content/incrementalSetup

Demonstrates how to initiate an incremental setup for offline objects in a VoltMX application using Java. It utilizes VoltMXClient to get offline objects and calls the incrementalSetup method with a callback to handle success or failure.

```Java
try {

    VoltMXClient client = new VoltMXClient();
    HashMap < String, Object > options = null;
    IVoltMXApplicationSync appSync = client.getOfflineObjects();
    appSync.incrementalSetup(options, new VoltMXSyncCallback() {
        @Override
        public void onSuccess(Object object) {
            Log.d("Incremental Setup", "Incremental Setup Succeeded");
            //operation to be performed on successful incremental setup.
        }

        @Override
        public void onFailure(VoltMXException voltmxException) {
            Log.d("Incremental Setup", "Incremental Setup failed with Exception :" + voltmxException.getMessage());
            voltmxException.getStackTrace();
            //operation to be performed on failed incremental setup.
        }

    });

} catch (Exception e) {
Log.d("Exception in incremental setup" + e.getMessage());
}
```

--------------------------------

### Volt MX Tutorials Overview

Source: https://help.hcl-software.com/voltmx/v9.5/tutorials/notificationAndAnalytics

Lists various tutorials available for HCL Volt MX, covering different aspects of application development and platform features.

```APIDOC
Tutorials:
  - Overview: General introduction to tutorials.
  - Action Editor: Guide to using the Action Editor for defining application logic.
  - API Management: Documentation on managing APIs within Volt MX.
  - App Factory: Information on using the App Factory for build and deployment.
  - Architecture: Explains the architectural components of Volt MX applications.
  - Build And Productivity: Tips and features for efficient development.
  - Components and Marketplace: Using pre-built components and the marketplace.
  - Connecting to Backend: How to integrate Volt MX apps with backend services.
  - Designing For Web: Guidelines for creating web applications.
  - Designing the Layout: Best practices for UI/UX layout design.
  - Internationalization and Localization: Implementing multi-language support.
  - Notification and Analytics: Integrating notification and analytics services.
  - Offline Services: Developing applications with offline capabilities.
  - Programming and Extensibility: Advanced development and customization.
  - Volt MX Foundry Overview: Introduction to the Volt MX Foundry platform.
```

--------------------------------

### VoltMXLibrary.start Method

Source: https://help.hcl-software.com/voltmx/v9.5/Iris/iris_api_dev_guide/content/start_library

API for launching the VoltMX library UI. Requires prior initialization and careful parameter handling. Supports iOS (Objective-C) and Windows (C#) implementations.

```APIDOC
VoltMXLibrary.start

Launches the VoltMX library UI. Must be called after successful library initialization.

**iOS Signature:**
+ (void) start:(NSString *)libraryId 
         viewController:(UIViewController*) viewController
         libraryArgs:(NSDictionary*) libraryArgs
         libraryConfig:(NSDictionary*) libraryConfig 
         delegate:(id<VoltMXLibraryResultDelegate>) resultDelegate;

**Windows Signature:**
public static void Start(string libraryId,
                       Dictionary<string, Object> libraryArgs,
                       Dictionary<string, Object> libraryConfig,
                       ILibraryResultListener resultListener);

**Parameters:**
- libraryId (string, required): The name of the library (VoltMX Iris Application AppID) to launch. Cannot be null.
- viewController (UIViewController*, required for iOS): Native app's viewController reference to push the main UI controller.
- libraryArgs (NSDictionary* / Dictionary<string, Object>, optional): Key-value pairs for passing native app data to the library. Supports primitive data types. Passed to appService callback in library mode.
- libraryConfig (NSDictionary* / Dictionary<string, Object>, optional): Configures library launch. Currently ignored.
- resultDelegate / resultListener (id<VoltMXLibraryResultDelegate>* / ILibraryResultListener, required): Delegate/callback to receive acknowledgment (result) from the library. Cannot be null. Methods are called from the main/UI thread.

**Notes:**
- Avoid passing null to mandatory parameters.
- The library should publish keys of resultData for the Native app to handle.
```

--------------------------------

### Volt MX Foundry Deployment Guide Link

Source: https://help.hcl-software.com/voltmx/v9.5/Foundry/settings_and_configuration

Guide for deploying Volt MX Foundry.

```APIDOC
Guide: Volt MX Foundry Deployment Guide
URL: voltmx_Foundry_deployment_guide/Content/Introduction.html
Description: Comprehensive guide on deploying Volt MX Foundry environments.
```

--------------------------------

### Sample User Details Response

Source: https://help.hcl-software.com/voltmx/v9.5/Foundry/engagement_api_guide/Content/REST_API_User/Get_User_Details_By_Pagination

Example JSON response for the Get User Details by Pagination API, showing user data.

```JSON
{
"total" : 3,
"users" : [ {
"id" : 1,
"email" : "admin@hcl.com",
"displayName" : "Administrator",
"mobileNo" : "",
"activeFlag" : true,
"lastModifiedBy" : "",
"lastModifiedDate" : "06/15/2016 02:00:18 PM IST",
"createdDate" : "06/15/2016 02:00:18 PM IST",
"createdBy" : "admin",
"userName" : "admin",
"selectedPermissionIds" : [ ],
"selectedGroupIds" : [ 1 ]
}, {
"id" : 2,
"email" : "mobilefoundryadmin@hcl.com",
"displayName" : "Foundry Administrator",
"mobileNo" : "",
"activeFlag" : true,
"lastModifiedBy" : "",
"lastModifiedDate" : "06/15/2016 02:00:18 PM IST",
"createdDate" : "06/15/2016 02:00:18 PM IST",
"createdBy" : "mobilefoundryadmin",
"userName" : "mobilefoundryadmin",
"selectedPermissionIds" : [ ],
"selectedGroupIds" : [ 1 ]
}, {
"id" : 3,
"email" : "aron.hale@voltmx.com",
"displayName" : "Aron Hale",
"mobileNo" : "+919080706050",
"activeFlag" : true,
"lastModifiedBy" : "admin",
"lastModifiedDate" : "06/22/2016 05:51:39 PM IST",
"createdDate" : "06/22/2016 05:51:39 PM IST",
"createdBy" : "admin",
"userName" : "108",
"selectedPermissionIds" : [ ],
"selectedGroupIds" : [ ]
} ]
}
```

--------------------------------

### Request Mapper Example for GET Variants

Source: https://help.hcl-software.com/voltmx/v9.5/Foundry/offline_objects_user_guide/Content/Conflict_Resolution

An XML snippet demonstrating a request mapper configuration for VoltMX Foundry's GET variants (getbypk, getupdated, getbatch). It shows how input parameters like timestamps, IDs, and batch identifiers are mapped.

```XML
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<mapper xmlns="http://www.voltmx.com/ns/mapper">
  <map inputpath="request_in" outputpath="request_out">
    <set-param inputpath="../criteria/filter/LastModifiedDate" outputpath="from_timestamp"/>
    <set-param inputpath="../criteria/filter/Id" outputpath="Id"/>
    <set-param inputpath="/$batchsize" outputpath="batchsize"/>
    <set-param inputpath="/$batchid" outputpath="batchid"/>
  </map>
</mapper>
```

--------------------------------

### Volt MX Foundry Public URL Format

Source: https://help.hcl-software.com/voltmx/v9.5/Foundry/voltmx_foundry_windows_install_guide/Content/Multi-Node_Installation

Specifies the expected format for the Public URL configuration during the administrator account setup for Volt MX Foundry.

```APIDOC
Public URL Format:

<Hostname/IP address>:<port>

Example:
my-server.example.com:8080
192.168.1.100:9000

Description: This field defines the accessible URL for the Volt MX Foundry Console. Users can modify the default values if required.
```

--------------------------------

### Volt MX Iris Application Visual Studio Project Setup

Source: https://help.hcl-software.com/voltmx/v9.5/Iris/iris_user_guide/Content/BuildApplicationsForWindows10

Instructions for opening and configuring a Volt MX Iris application project in Visual Studio. This involves locating the project files, selecting the correct build configuration, and setting the project as the startup project.

```Visual Studio
1. Navigate to the build folder (\temp\build\windows10\Windows10) and find the VoltMXApp folder.
2. Open VoltMXApp.sln in Visual Studio.
3. Change the configuration to x86, x64, or ARM. The configuration must not be Any CPU.
4. Select the application to be deployed in Debug or Release mode.
5. Right-click VoltMXApp (Universal Windows) project and select Set as Startup Project.
6. Choose the right simulator/emulator/local machine to deploy the application.
```
Tokens:
Raw