HCL Volt MX

https://help.hcl-software.com/voltmx/v10/
Admin
HCL Volt MX is a low-code app development platform that enables professional developers, citizen...
Tokens:3,166,561
Snippets:42,355
Trust Score:10
Update:2 months ago
Show doc for...
Tokens:
Raw
### Start Installer Command

Source: https://help.hcl-software.com/voltmx/v10/Foundry/voltmx_foundry_linux_install_guide/Content/Upgrading_VoltMX_Foundry_SP1.html

Command to execute the binary installer file.

```bash
./VoltMXFoundryInstaller-GA.bin
```

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

### startRecording Example

Source: https://help.hcl-software.com/voltmx/v10/Iris/iris_api_dev_guide/content/record_methods.html

Example demonstrating the initialization of a record object and starting the recording process.

```javascript

function errorcallback(errorMessage) {
    var errorMesg = "Reason for the failure is: " + errorMessage;
    alert(errorMesg);
}

function successcallback(fileobj) {}

var fileObj = new voltmx.io.file("recording");

var config = {
    onSuccess: successCallback,
    onFailure: failureCallback
};

var recordObj = voltmx.media.record(fileobj, config);
recordObj.startRecording();

```

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

### Start Installer with Windows Authentication

Source: https://help.hcl-software.com/voltmx/v10/Foundry/voltmx_foundry_windows_install_guide/Content/Installing_Foundry_JBoss_existing.html

Use this command to initiate the installation process with SQL Server Windows Authentication support enabled.

```bash
VoltMXFoundryInstaller-9.x.x.x_GA.exe -Dprop.java.library.path=< location of sqljdbc_auth.dll >
```

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

### Initialize Offline Objects Setup

Source: https://help.hcl-software.com/voltmx/v10/Foundry/offline_objectsapi_reference_guide/Content/OfflineObjectSetup.html

This example demonstrates how to define success and failure callbacks and invoke the setup function with an encryption key.

```JavaScript
function successCallback(status) {
voltmx.print("Application setup successful");
}

function failureCallback(error) {
voltmx.print("Application setup failed with error:" + error.code);
}
//Encrypt the device database using a passphrase
var options = {
"deviceDbEncryptionKey": "myencryptionpa$$phrase1"
};
VMXFoundry.OfflineObjects.setup(options, successCallback, failureCallback);
```

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

### On-Premise Export Example

Source: https://help.hcl-software.com/voltmx/v10/Foundry/voltmx_foundry_user_guide/Content/ServiceConfigProfile.html

A concrete example of the export-config command for an on-premise installation.

```bash
java -jar mfcli.jar export-config -u abc@voltmx.com -p password -au http://10.10.24.79:8080 -cu http://10.10.24.78:8081 -f "C:\\tmp\\Sample.json" -a MyApp_23 -v 1.0 -e MyCloudEnvironment \-x 2.0 -y delta
```

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

### Example ANDROID_HOME Path

Source: https://help.hcl-software.com/voltmx/v10/Iris/iris_user_guide/Content/SUG_Android.html?q=

An example of the directory path format for the Android SDK installation on Windows.

```text
C:\Android\android-sdk
```

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

### Offline Objects Setup Implementation

Source: https://help.hcl-software.com/voltmx/v10/Foundry/offline_objectsapi_reference_guide/Content/OfflineObjectSetup.html

Example demonstrating how to initialize Offline Objects with database encryption.

```java

VoltMXClient sdk = new VoltMXClient();

IVoltMXApplicationSync appSync = sdk.getOfflineObjects();
//Encrypt the device database using a passphrase
HashedMap < String, object > options = new HashMap < String, object > ();
options.put("deviceDbEncryptionKey", "myencryptionpa$$phrase1");
appSync.setup(options, new VMXCallback() {
@Override
public void onSuccess(Object object) {
Log.d("Application Setup", "Application setup successful");
}
@Override
public void onFailure(Object error) {
OfflineObjectsException e = (OfflineObjectsException) error;
Log.e("Application Setup", "Application setup failed with error:" + e.getMessage() + "callstack: " + e.getStackTrace());
}
});

```

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

### Perform Incremental Setup in Objective-C

Source: https://help.hcl-software.com/voltmx/v10/Foundry/offline_objectsapi_reference_guide/Content/incrementalSetup.html?q=

This example demonstrates how to invoke the incrementalSetup method on the OfflineObjects instance.

```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
];
```

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

### Install and Start Memcached Server

Source: https://help.hcl-software.com/voltmx/v10/Foundry/voltmx_foundry_linux_install_guide/Content/Pre-installation_Tasks.html

Commands to extract, compile, install, and run the Memcached server as a daemon.

```bash
tar xfz memcached-1.2.6.tar.gz
cd memcached-1.2.6
./configure
make
make install
memcached -d -m 1024 -u root -l 127.0.0.1 -p 11211
```

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

### Launch Volt MX Foundry installer

Source: https://help.hcl-software.com/voltmx/v10/Foundry/voltmx_foundry_linux_install_guide/Content/Installing_VoltMX_Foundry_Tomcat.html?q=

Execute the binary file to start the installation process in console mode.

```bash
./VoltMXFoundryInstaller-x.x.x.x_GA.bin
```

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

### Start Installation with Windows Authentication

Source: https://help.hcl-software.com/voltmx/v10/Foundry/voltmx_foundry_windows_install_guide/Content/Installing_Foundry_on_JBoss1.html

Command to initiate the Volt MX Foundry installer with Windows Authentication support enabled for SQL Server.

```bash
VoltMXFoundryInstaller-9.x.x.x_GA.exe -Dprop.java.library.path=
```

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

### Server Startup Configuration Prompt

Source: https://help.hcl-software.com/voltmx/v10/Foundry/voltmx_foundry_linux_install_guide/Content/Installing_Foundry_JBoss_existing.html

Prompt to choose whether to start the server automatically after installation.

```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::
```

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

### Install and Start Memcached on Windows

Source: https://help.hcl-software.com/voltmx/v10/Foundry/voltmx_foundry_manual_install_guide/Content/Install_Memcached_Server.html

Commands to install the Memcached service and start it via command prompt.

```bash
memcached.exe -d install
```

```bash
c:/memcached/memcached.exe -d install
```

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

```bash
net start memcached Server
```

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

### Get Battery Level Example

Source: https://help.hcl-software.com/voltmx/v10/Iris/iris_api_dev_guide/content/voltmx.os_functions_batteryapi.html

Example demonstrating how to register a service, get the battery level, and unregister the service.

```javascript
getBatteryLevel: function() {
    voltmx.os.registerBatteryService(this.batterySuccessCallback);
    var battery = voltmx.os.getBatteryLevel();
    voltmx.os.unregisterBatteryService();
    this.view.lblDisplay.text = battery + "%";
},
```

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

### getAppInstance Method Example

Source: https://help.hcl-software.com/voltmx/v10/Iris/voltmx_ref_arch_api/Content/voltmx.sdk.mvvm.VoltMXApplicationContext_Methods.html

Example usage of the getAppInstance method.

```javascript
var appContext = voltmx.sdk.mvvm.VoltMXApplicationContext.getAppInstance();
```

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

### Play Method Usage

Source: https://help.hcl-software.com/voltmx/v10/Iris/iris_widget_prog_guide/Content/Video_Method.html?q=

Starts video playback.

```JavaScript
play()
```

```JavaScript
//Sample code to invoke play method by using a Video widget.
frmVideo.myVideo.play();
```

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

### Select Installation Type

Source: https://help.hcl-software.com/voltmx/v10/Foundry/voltmx_foundry_linux_install_guide/Content/Multi-Node_Installation.html

Choose between a new installation or upgrading an existing instance.

```text
=================
Installation Type  
-----------------

Please select whether to perform a new installation or upgrade an existing installation.

->1- New Installation  
  2- Upgrade an existing installation

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

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

### Run Installation Scripts

Source: https://help.hcl-software.com/voltmx/v10/Foundry/voltmx_analytics_reporting/Content/Deploy_JasperWAR_using_js-install_Scripts.html

Commands to execute the installation script with or without sample data.

```bash
> js-install.bat
$ ./js-install.sh
```

```bash
> js-install.bat minimal
$ ./js-install.sh minimal
```

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

### play Method

Source: https://help.hcl-software.com/voltmx/v10/Iris/iris_widget_prog_guide/Content/Video_Method.html?q=

Starts playback of the video.

```APIDOC
## play()

### Description
The method plays the video.

### Example
```javascript
frmVideo.myVideo.play();
```
```

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

### startSync Implementation Example (Objective-C)

Source: https://help.hcl-software.com/voltmx/v10/Foundry/offline_objectsapi_reference_guide/Content/OfflineObjectstartSync.html?q=

Example demonstrating how to configure sync options and invoke the startSync method with success, failure, and progress callbacks.

```Objective-C
NSError * error;
VMXClient * sdk = [VMXClient sharedClient];
OfflineObjects * applicationSync = [sdk getOfflineObjects];

VMXSuccessCompletionHandler onSuccess = ^ void(id object) {
//Operation to be performed on successful sync.
};
VMXFailureCompletionHandler onFailure = ^ void(id object) {
//Operation to be performed on sync failure.
};
VMXProgressCompletionHandler onProgress = ^ void(id object) {
//Operation to be performed on sync progress.
};
NSDictionary * uploadRequestQueryParams = @ {
"LocationID": @“32001”,
"SiteID": @"2"
};
NSDictionary * filters = @ {
"Employee": @"EmployeeID eq 2",
"Department": @"Name eq ‘Human Resource’"
};
NSDictionary * syncOptions = @ {
"uploadRequestQueryParams": uploadRequestQueryParams,
"filter": filters,
"downloadBatchSize": @"100",
"uploadBatchSize": @"200",
"getSyncStats": @"true",
"syncType": @"fullSync"
};
NSDictionary * objectServicesOptions = @ {
"Organization": syncOptions
}
[applicationSync startsync: @{
"syncMode": "parallel",
"objectServicesOptions": objectServicesOptions
}
onSuccess: onSuccess
onFailure: onFailure
onProgress: onProgress
];
```

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

### Start Library Method Invocation

Source: https://help.hcl-software.com/voltmx/v10/Iris/iris_api_dev_guide/content/start_library.html?q=

Example of how to invoke the start method within an iOS application.

```Objective-C
[VoltMXLibrary start:<libraryId> viewController:<viewController> libraryArgs:<libraryArgs>  
libraryConfig:<libraryConfig> delegate:<resultDelegate>];
```

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

### dismissLoadingScreen Method Example

Source: https://help.hcl-software.com/voltmx/v10/Iris/voltmx_ref_arch_api/Content/voltmx.sdk.mvvm.VoltMXApplicationContext_Methods.html

Example usage of the dismissLoadingScreen method on an application context instance.

```javascript
var appContext = voltmx.sdk.mvvm.VoltMXApplicationContext.getAppInstance();
appContext.dismissLoadingScreen();
```

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

### Start Sync with Options

Source: https://help.hcl-software.com/voltmx/v10/Foundry/offline_objectsapi_reference_guide/Content/OfflineObjectstartSync.html?q=

Demonstrates how to configure sync options such as syncMode and object-specific settings before calling startSync.

```JavaScript
var options = {};
var organizationUploadRequestQueryParams = {
"LocationID": "32001",
"SiteID": "2"
};
var organizationOptions = {
"getSyncStats": "true",
"uploadBatchSize": "200",
"uploadRequestQueryParams": organizationUploadRequestQueryParams,
"syncType": "uploadOnly"
};
options.syncMode = "parallel";
options.objectServicesOptions = {
" Organization": organizationOptions
};

VMXFoundry.OfflineObjects.startSync(options, onSuccess, onFailure, onProgress);

function onSuccess(response) {
voltmx.print("Application Sync success: " + JSON.stringify(response.successResponse));
}

function onFailure(error) {
voltmx.print("Application Sync failed with error: " + JSON.stringify(error.failureResponse));
}

function onProgress(object) {
voltmx.print("Application Sync progress event received" + JSON.stringify(object));
}
```

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

### Start Library API Usage

Source: https://help.hcl-software.com/voltmx/v10/Iris/iris_api_dev_guide/content/start_library.html?q=

Example of calling the start method within a try-catch block.

```java
try {
    VoltMXLibrary.start( < libraryId > , < activity > , < libraryArgs > , null, < resultListener > );
} catch (Exception ex) {}
```

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

### getAllFormControllers Method Example

Source: https://help.hcl-software.com/voltmx/v10/Iris/voltmx_ref_arch_api/Content/voltmx.sdk.mvvm.VoltMXApplicationContext_Methods.html

Example usage of the getAllFormControllers method.

```javascript
var appContext = voltmx.sdk.mvvm.VoltMXApplicationContext.getAppInstance();
var allControllers = appContext.getFormControllers();
```

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

### stopRecording Example

Source: https://help.hcl-software.com/voltmx/v10/Iris/iris_api_dev_guide/content/record_methods.html

Example showing the full lifecycle of a recording, including starting and stopping the process.

```javascript

function errorcallback(errorMessage) {
    var errorMesg = "Reason for the failure is: " + errorMessage;
    alert(errorMesg);
}

function successcallback(fileobj) {}

var fileObj = new voltmx.io.file("recording");

var config = {
    onSuccess: successCallback,
    onFailure: failureCallback
};

var recordObj = voltmx.media.record(fileobj, config);
recordObj.startRecording();

// More code goes here.

recordObj.stopRecording();

```

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

### VMXFoundry.OfflineObjects.setup

Source: https://help.hcl-software.com/voltmx/v10/Foundry/offline_objectsapi_reference_guide/Content/OfflineObjectSetup.html

Initializes the creation of the device database and sync environment.

```APIDOC
## VMXFoundry.OfflineObjects.setup

### Description
Initializes the creation of the device database and sync environment. After successful setup, the database structure is created. Subsequent calls initialize the sync environment.

### Signature
VMXFoundry.OfflineObjects.setup(options, successCallback, failureCallback)

### Parameters
- **options** (JSON) - Required - Setup options such as device database, encryption passphrase, and boolean handling.
- **successCallback** (Function) - Required - Invoked on successful setup.
- **failureCallback** (Function) - Required - Invoked on setup failure with the cause of failure as an argument.

#### Setup Options
- **deviceDbEncryptionKey** (String) - Optional - Encryption passphrase (at least six characters). Not applicable for Mobile Web and Desktop Web.
- **treatBooleanFieldValuesAsNumeric** (Boolean) - Optional - If false, boolean values are converted to boolean type. If true (default), values are treated as numeric.

### Return Type
void

### Error Codes
- **106**: Claims token is unavailable.

### Example
```javascript
function successCallback(status) {
  voltmx.print("Application setup successful");
}

function failureCallback(error) {
  voltmx.print("Application setup failed with error:" + error.code);
}

var options = {
  "deviceDbEncryptionKey": "myencryptionpa$$phrase1"
};

VMXFoundry.OfflineObjects.setup(options, successCallback, failureCallback);
```
```

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

### Initialize ServicesManager

Source: https://help.hcl-software.com/voltmx/v10/java_docs_apis/MiddlewareAPI/com/hcl/middleware/api/ServicesManager.html

Examples for obtaining a ServicesManager instance in different execution contexts.

```java
 ServicesManager servicesManager = request.getServicesManager();
```

```java
 ServicesManager servicesManager = ServicesManagerHelper.getServicesManager();
```

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

### Remove widget from Box example

Source: https://help.hcl-software.com/voltmx/v10/Iris/iris_widget_prog_guide/Content/VBox_Methods.html

Example showing the creation of a Box and the removal of a child widget.

```javascript
//Defining the properties for a Box properties.
var basicConfBox = {id:"boxRemoveMethodTest", isVisible:true, 
orientation:constants.BOX_LAYOUT_VERTICAL, skin:"gradroundbox"};

var layoutConfBox = {containerWeight:100};

//Creating the Box.
var boxRemoveMethodTest = new voltmx.ui.Box(basicConfBox, layoutConfBox, {});

//Removing label widget from the box .
//Here label should be created already and added inside the box.  
boxRemoveMethodTest.remove(lbl);
```

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

### Get Visible Items Example

Source: https://help.hcl-software.com/voltmx/v10/Iris/iris_widget_prog_guide/Content/CollectionView_Methods.html

Example usage of getVisibleItems to retrieve visible items in a CollectionView.

```javascript
var arr = form.gv.getVisibleItems();
```

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

### Installation Complete Summary

Source: https://help.hcl-software.com/voltmx/v10/Foundry/voltmx_foundry_linux_install_guide/Content/Installing_Foundry_JBoss_existing.html

Displays the final installation status and service URLs.

```text
=========================
Installation Complete
-----------------------------------------

Congratulations. Volt MX Foundry has been successfully installed to:

/home/user1/VoltMXFoundry

Console URL: https://00.00.00.00:port/mfconsole
Identity Service URL: https://00.00.00.00:port/authService
Integration Service URL: https://00.00.00.00:port/admin
Engagement Services URL: http://00.00.00.000:port/vpns

PRESS <ENTER> TO EXIT THE INSTALLER: [user1@cnt6-01c downloads]$
```

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

### Configure Installation Directory

Source: https://help.hcl-software.com/voltmx/v10/Foundry/voltmx_foundry_linux_install_guide/Content/Multi-Node_Installation.html

Example of setting the absolute path for the Volt MX Foundry installation folder.

```text
================
Install Folder
----------------
Please choose a destination folder for this installation.

NOTE: The installation path should not contain any special characters.

Default Install Folder: /home/user1/VoltMXFoundry

ENTER AN ABSOLUTE PATH, OR PRESS <ENTER> TO ACCEPT THE DEFAULT
: : /root/mfdomainmode

INSTALL FOLDER IS: /root/mfdomainmode

IS THIS CORRECT? (Y/N): y


```

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

### void <OfflineObjects>.setup(final HashMap<String, object> options, final VMXCallback callback)

Source: https://help.hcl-software.com/voltmx/v10/Foundry/offline_objectsapi_reference_guide/Content/OfflineObjectSetup.html

Initializes the Offline Objects framework with the provided configuration options and a callback for handling success or failure.

```APIDOC
## void <OfflineObjects>.setup(final HashMap<String, object> options, final VMXCallback callback)

### Description
Initializes the Offline Objects framework. This method must be called to configure the local device database and encryption settings.

### Parameters
- **options** (HashMap<String, Object>) - Required - Setup options such as device database, encryption passphrase and so on.
- **callback** (VMXCallback) - Required - The application must implement onSuccess and onFailure methods of VMXCallback interface.

#### Setup Options
- **deviceDbEncryptionKey** (String) - Optional - Encryption passphrase must be a string with at least six characters long.
- **treatBooleanFieldValuesAsNumeric** (Boolean) - Optional - If set to false, boolean field values are converted to boolean type. If set to true, fallbacks to default implementation (numeric). Default is True.

### Return Type
void

### Error Codes
- **106**: Claims token is unavailable.

### Example
```java
VoltMXClient sdk = new VoltMXClient();
IVoltMXApplicationSync appSync = sdk.getOfflineObjects();
HashMap < String, object > options = new HashMap < String, object > ();
options.put("deviceDbEncryptionKey", "myencryptionpa$$phrase1");
appSync.setup(options, new VMXCallback() {
    @Override
    public void onSuccess(Object object) {
        Log.d("Application Setup", "Application setup successful");
    }
    @Override
    public void onFailure(Object error) {
        OfflineObjectsException e = (OfflineObjectsException) error;
        Log.e("Application Setup", "Application setup failed with error:" + e.getMessage() + "callstack: " + e.getStackTrace());
    }
});
```
```

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

### Get Indices for Visible Items Example

Source: https://help.hcl-software.com/voltmx/v10/Iris/iris_widget_prog_guide/Content/CollectionView_Methods.html

Example usage of getIndicesForVisibleItems to print section and item indices.

```javascript
var object = form.gv.getIndicesForVisibleItems();
voltmx.print(object[sectionIndex]);
voltmx.print(object[itemIndex]);
```

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

### Prepare Installation Directory

Source: https://help.hcl-software.com/voltmx/v10/Foundry/voltmxfoundry_containers_helm/Content/Installing_Containers_With_Helm.html

Create a dedicated directory and extract the Helm chart files.

```bash
$ mkdir ~/Foundry-9.5.n.n_GA
$ cd ~/Foundry-9.5.n.n_GA
$ unzip ~/Downloads/HelmChart-9.5.n.n_GA.zip
```

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

### Get Installer Source Information

Source: https://help.hcl-software.com/voltmx/v10/Iris/iris_api_dev_guide/content/voltmx.application_functions.html?q=

Identifies the source or market from which the application was installed, useful for security validation.

```javascript
var devInfo = voltmx.os.deviceInfo();  
var installSourceInfoDetails = voltmx.application.getInstallerSourceInfo();  
if(devInfo.APILevel >= 30){  
  var originatingPackageName = installSourceInfoDetails.originatingPackageName;  
  var initiatingPackageName = installSourceInfoDetails.initiatingPackageName;  
  var installingPackageName = installSourceInfoDetails.installingPackageName;  
  alert("originatingPackageName: "+originatingPackageName +  
        "initiatingPackageName: "+initiatingPackageName +  
        "installingPackageName: "+installingPackageName);  
} else {
  var installerPackageName = installSourceInfoDetails.installerPackageName;
  alert("installerPackageName: "+installerPackageName);  
}
```

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

### getBinary Implementation Example

Source: https://help.hcl-software.com/voltmx/v10/Foundry/offline_objectsapi_reference_guide/Content/ObjectgetBinary.html

A complete example demonstrating how to initialize a VMXObj, define options, and implement the required callback functions for the getBinary method.

```javascript
var media = new voltmx.sdk.VMXObj("media");
var options = {};
options.primaryKeys = {
    "id": "2"
};
options.columnName = "picture";
options.fileId = "pic1";

function onFileDownloadStartedApp(response) {
    voltmx.print("Object onFileDownloadStarted" + JSON.stringify(response));
}

function onStreamDownloadCompletedApp(response) {
    //Not Supported in the current version
}

function onChunkDownloadCompletedApp(response) {
    //Not Supported in the current version
}

function onFileDownloadCompletedApp(response) {
    voltmx.print("Object onFileDownloadCompleted" + JSON.stringify(response) + ", file path = " + response.filePath);
}

function onDownloadFailureApp(error) {
    voltmx.print("Object onDownloadFailure:" + JSON.stringify(error));
}
media.getBinary(options, onFileDownloadStartedApp, onStreamDownloadCompletedApp,
    onChunkDownloadCompletedApp, onFileDownloadCompletedApp, onDownloadFailureApp);
}
```

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

### Input Parameter Table Setup

Source: https://help.hcl-software.com/voltmx/v10/Iris/iris_api_dev_guide/content/voltmx.net_deprecated.html?q=

Example of constructing the input parameter table for a synchronous service call.

```lua
local myhttpheaders={authkey=  
"myauthkey",authtoken="myauthtoken"}  
local inputParamTable={appID="SampleApp",  
serviceID="accountLogin",  
httpheaders=myhttpheaders}; 
```

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

### Initialize GUIDs for New Deployment

Source: https://help.hcl-software.com/voltmx/v10/Foundry/voltmxfoundry_containers_helm/Content/Installing_Containers_With_Helm.html

Run this script to generate new GUIDs and an upgrade.properties file for a fresh installation.

```bash
./init-guids.sh --new
```

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

### Get Battery State Example

Source: https://help.hcl-software.com/voltmx/v10/Iris/iris_api_dev_guide/content/voltmx.os_functions_batteryapi.html

Example showing how to check the battery state and handle different charging statuses.

```javascript
//This code is used to obtain your device battery state
getBatteryState: function() {
    voltmx.os.registerBatteryService(this.batterySuccessCallback);
    var batteryState = voltmx.os.getBatteryState();
    if (voltmx.os.BATTERY_STATE_CHARGING == batteryState) {
        alert("The Device is charging");
        voltmx.os.unregisterBatteryService();
    } else if (voltmx.os.BATTERY_STATE_DISCHARGING == batteryState) {
        alert("The Device is discharging");
        voltmx.os.unregisterBatteryService();
    } else if (voltmx.os.BATTERY_STATE_FULL == batteryState) {
        alert("The Device is completely charged");
        voltmx.os.unregisterBatteryService();
    } else if (voltmx.os.BATTERY_STATE_UNKNOWN == batteryState) {
        alert("The Device charging state is unkonwn");
        voltmx.os.unregisterBatteryService();
    }
},
```

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

### Build with Proxy Configuration

Source: https://help.hcl-software.com/voltmx/v10/Iris/iris_user_guide/Content/CI_BUILD_VoltMX_Iris.html

Example command demonstrating how to run a build with specific versioning and proxy server credentials.

```bash
node build.js --clean --irisversion 9.0.3 --proxy http://user_name:password@proxy.server.com:proxy_port
```

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

### Camera Widget Implementation Example

Source: https://help.hcl-software.com/voltmx/v10/Iris/iris_api_dev_guide/content/voltmx.ui_functions.html

Example showing how to define configurations and instantiate a Camera widget, including a capture callback.

```JavaScript
function onCameraCaptureAPI(eventobject)
{
    var  cameraRawBytes = camera1.rawBytes;
    Form06900dd40fc7842.Image0e7a54b01924146.rawBytes=cameraRawBytes;

    alert("camera raw bytes");
    if( null !== cameraRawBytes)
    {
        voltmx.camera1.releaseRawBytes(cameraRawBytes);
        cameraRawBytes = null;
    }
}

var basicConfig = {
    "height": "50dp",
    "id": "camera1",
    "isVisible": true,
    "left": "60dp",
    "onCapture": onCameraCaptureAPI,
    "skin": "slCamera",
    "text": "Camera",
    "top": "405dp",
    "width": "260dp",
    "zIndex": 1
};

var LayoutConfig = {
    "contentAlignment": constants.CONTENT_ALIGN_CENTER,
    "padding": [0, 0, 0, 0],
    "paddingInPixel": false
};

var PSPConfig = {
    "accessMode": constants.CAMERA_IMAGE_ACCESS_MODE_PUBLIC,
    "enableOverlay": false,
    "enablePhotoCropFeature": false
};

var camera1 = new voltmx.ui.Camera(basicConfig,LayoutConfig,PSPConfig );
CameraForm.add(camera1);
```

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

### Get All Users by Pagination URL

Source: https://help.hcl-software.com/voltmx/v10/Foundry/engagement_api_guide/Content/REST_API_Audience_Member/Get_AudienceMemebrs_By_pagination.html

The HTTP URL structure for the GET request, including start and pageSize query parameters.

```http
http://<host>:<port>/api/v1/audience?start=0&pageSize=20
```

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

### Example 1: Basic Acceleration Monitoring

Source: https://help.hcl-software.com/voltmx/v10/Iris/iris_api_dev_guide/content/accelerometerfunctions.html

Demonstrates setting up success and failure callbacks and starting the monitoring process with a specific frequency.

```javascript
//Start monitoring acceleration

// onSuccessCallback
// This function accepts an 'accelerometerdata' object, which contains the current device acceleration values 
function onSuccessCallback(accelerometerdata) {
    voltmx.print("X: " + accelerometerdata.x + "Y: " + accelerometerdata.y + "Z:" + accelerometerdata.z + "Timestamp: " + accelerometerdata.timestamp);
}

//onFailureCallback callback 
function onFailureCallback(error) {
    voltmx.print("code: " + error.code + "message: " + error.message);
}

function startMonitoringAcceleration() {
    // Start monitor acceleration.
    voltmx.accelerometer.startMonitoringAcceleration(onSuccessCallback, onFailureCallback, {
        frequency: 10,
        onchange: false
    });
}
```

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

### Import Service Profile to On-Premise Installation

Source: https://help.hcl-software.com/voltmx/v10/Foundry/voltmx_foundry_user_guide/Content/ServiceConfigProfile.html?q=

Syntax and example for importing a service profile into an on-premise Volt MX Foundry installation.

```bash
 java -jar mfcli.jar import-config -u <user> -p <password> -au <Identity URL> -cu <Console URL> [-f <file name>  [-a <app name>] [-v <app version>] [-e <environment name>]
```

```bash
java -jar mfcli.jar import-config -u abc@voltmx.com -p password -au http://10.10.24.79:8080 -cu http://10.10.24.78:8081 -f "C:\\tmp\\Sample.zip" -a MyApp_23 -v 1.0 -e MyCloudEnvironment
```

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

### Start a Live Activity

Source: https://help.hcl-software.com/voltmx/v10/Iris/iOS_Live_Activities_in_Volt_MX_Iris/Content/API_Reference.html?q=

Demonstrates how to define activity parameters and initiate a Live Activity with success and failure callbacks.

```javascript
var activityParams = {
    attributes: {
        airlineName: "Nimbus Airways"
    },
    state: {
        flightCode: "G89-AU",
        progress: 40.83,
        time: "Arriving in 30m",
        status: "5min delay",
        departure: "BLR",
        arrival: "HYD"
    },
    staleDatePeriod: 300.0,
    relevanceScore: 50.0,
    attributesName: "FlightAttributes",
    channelID: "channelIDhere"
};
var pushType = voltmx.liveActivity.PUSHTYPE_CHANNEL;

function onSuccessCallback(id) {
    voltmx.ds.save([id], "activityID_flight_01");
    alert("Success ActID: " + id);
}

function onFailureCallback(errorInfo) {
    var errorCode = errorInfo.errorCode;
    var errorMessage = errorInfo.errorMessage;
    var errorDescription = errorInfo.errorDescription;
    alert("Failure Details - start :\n" + "------------------\n" + "Error Code : " + errorCode + "\n" + "Error Message: " + errorMessage + "\n" + "Error Description: " + errorDescription);
}
voltmx.liveActivity.start(activityParams, pushType, onSuccessCallback, onFailureCallback);
```

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

### Tail live installation logs

Source: https://help.hcl-software.com/voltmx/v10/Foundry/voltmx_foundry_linux_install_guide/Content/Installing_Foundry_JBoss_existing.html?q=

Use this command to monitor the installation process in real-time by tailing the output log file.

```bash
tail -f lax-12347050814474460129-out.tmp
```

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

### Incremental Setup Implementation for Android

Source: https://help.hcl-software.com/voltmx/v10/Foundry/offline_objectsapi_reference_guide/Content/incrementalSetup.html?q=

Example implementation of the incrementalSetup method, including success and failure callbacks.

```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.e("Incremental Setup", "Incremental Setup failed with Exception :" + voltmxException.getMessage());
            voltmxException.getStackTrace();
            //operation to be performed on failed incremental setup.
        }

    });

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

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

### Initialize Account Details

Source: https://help.hcl-software.com/voltmx/v10/Foundry/voltmxfoundry_containers_helm/Content/Installing_Containers_With_Helm.html

Run the initialization script to generate required encryption and master keys.

```bash
$ ./init-guids.sh --new
ACCOUNTS_ENCRYPTION_KEY=b28e44b3-a5c6-8561-12cd-ef95b37f5f3c
WAAS_MASTER_KEY=a7d6b717-07f8-011a-8095-755c340dc976
WAAS_MASTER_KEY_ID=7d58a92c-e9db-1ebc-084f-6f0640fb5b42
AUTH_MASTER_KEY=84635bf0-bc1b-7139-bf95-f64afb1673a1
AUTH_MASTER_KEY_ID=ec376ad5-4b29-b013-d8d6-b1b7d6fd5559
useExistingDb=false
New keys have been saved to values.yaml, you may proceed with 'helm install'.
```

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

### Get Certificate Expiration Sample Responses

Source: https://help.hcl-software.com/voltmx/v10/Foundry/engagement_api_guide/Content/REST_API_Application/Get_Cert_Expiration.html

JSON response examples for the Get Certificate Expiration API, showing both filtered and unfiltered results.

```json
{
"appCertificates" : [ {
"appId" : "AppForAll1",
"certificates" : [ {
"expiryDate" : "07 Jan, 2018 11.41:02 AM IST",
"daysLeft" : 214,
"platform" : "iPhone",
"certificateType" : "Production"
}, {
"expiryDate" : "07 Jan, 2018 11.41:02 AM IST",
"daysLeft" : 214,
"platform" : "iPad",
"certificateType" : "Production"
} ]
} ]
}
```

```json
{
"appCertificates": [
{
"appId": "testAuto3005",
"certificates": [
{
"expiryDate": "07 Jan, 2018 11.41:02 AM IST",
"daysLeft": 214,
"platform": "iPhone",
"certificateType": "Production"
},
{
"expiryDate": "16 Nov, 2017 05.59:07 PM IST",
"daysLeft": 163,
"platform": "iPhone",
"certificateType": "Production"
}
]
},
{
"appId": "testAuto9116",
"certificates": [
{
"expiryDate": "07 Jan, 2018 11.41:02 AM IST",
"daysLeft": 214,
"platform": "iPad",
"certificateType": "Production"
}
]
}
],
"passCertificates": [
{
"expiryDate": "03 Mar, 2018 11.56:13 AM IST",
"daysLeft": 269,
"passTypeIdentifier": "pass.com.xxx.xxx",
"passTeamIdentifier": "passTeamIdentifier",
"passCertificateName": "admin"
},
{
"expiryDate": "07 Sep, 2017 03.48:31 PM IST",
"daysLeft": 93,
"passTypeIdentifier": "pass.com.xxx.xxx",
"passTeamIdentifier": "passTeamIdentifier",
"passCertificateName": "ServiceSuiteSetup261"
}
]
}
```

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

### Download Binary Data Example

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

Demonstrates how to initialize an object service and invoke the getBinaryData method with required callbacks.

```javascript
var downloadParams = {};

// Adapter specific parameters (Mentioned below)
var objSvc = voltmx.sdk.getCurrentInstance().getObjectService("serviceName");

var dataObject = new voltmx.sdk.dto.DataObject("binaryObjectName");
dataObject.setRecord(downloadParams);

objSvc.getBinaryData({
        "dataObject": dataObject
    },
    function(response) {
        voltmx.print("fileDownloadStartedCallback: " + JSON.stringify(response));
    },
    function(response) {
        voltmx.print("chunkDownloadCompleteCallback: " + JSON.stringify(response));
    },
    function(response) {
        voltmx.print("fileDownloadCompleteCallback: " + JSON.stringify(response));
    },
    function(response) {
        voltmx.print("fileDownloadFailureCallback: " + JSON.stringify(response));
    });
```

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

### GET /api/v1/accessmgmt/users

Source: https://help.hcl-software.com/voltmx/v10/Foundry/engagement_api_guide/Content/REST_API_User/Get_User_Details_By_Pagination.html?q=

Retrieves a paginated list of users. The start parameter defines the starting index, and pageSize defines the maximum number of users to return.

```APIDOC
## GET /api/v1/accessmgmt/users

### Description
Retrieves a paginated list of users. The start parameter defines the starting index, and pageSize defines the maximum number of users to return.

### Method
GET

### Endpoint
http://<host>:<port>/api/v1/accessmgmt/users

### Parameters
#### Query Parameters
- **start** (integer) - Optional - The starting position for the user list.
- **pageSize** (integer) - Optional - The maximum number of users to return.

### Response
#### Success Response (200)
- **total** (long) - The total number of users.
- **users** (array) - An array of user objects.
  - **id** (long) - A unique ID assigned to a user.
  - **email** (string) - Email ID of an user.
  - **displayName** (string) - Name of the user.
  - **mobileNo** (long) - Mobile number of the user.
  - **activeFlag** (Boolean) - Displays if the user is active or inactive.
  - **lastModifiedBy** (string) - Name of the user who last modified the user details.
  - **lastModifiedDate** (string) - Date on which the user details were last modified.
  - **createdDate** (string) - The date on which the user was created.
  - **createdBy** (string) - Displays a user name who created the group.
  - **userName** (string) - Name of the administrator.
  - **selectedPermissionIds** (array) - An array of selected permission IDs.
  - **selectedGroupIds** (array) - An array of selected groups IDs.

#### Response Example
{
  "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]
    }
  ]
}
```

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

### Pre-Installation Summary

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

Displays the components to be updated and the backup location for the current installation.

```text
====================================
Pre-Installation Summary
------------------------

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

Please refer to release notes.  


A copy of your installation will be placed in /root/<Previous-MobileFoundry-install-folder_PatchName>. To revert to the previous version of your installation, please replace the contents from the above mentioned folder.

If you accept terms and conditions,to proceed with the update, please press “Enter".

PRESS <ENTER> TO CONTINUE:
```
Tokens:
Raw