Skip to content

Enable VoltScript in Volt Foundry

VoltScript is a BASIC link image scripting language that has been extended for use with Volt MX Go as a server-side scripting language running within the Volt Foundry middleware layer. It's now available as a custom code technology adapter for Volt Foundry Integration Service.

Note

The information in this topic applies starting with the Volt MX Go v10 release.

About this task

This guide explains how to install the VoltScript Plugin Installer using the VoltScript Installation Tool, and how to use the VoltScript Plugin Installer to add VoltScript plugins to Volt Foundry. It also covers enabling VoltScript in Volt Foundry, which is deployed through Helm charts on a supported Kubernetes platform.

For Volt Foundry installed using installers

Before your begin

  • You have downloaded and installed the supported version of Volt Foundry that's licensed with a Volt MX Go entitlement. The minimum supported version of Volt Foundry is v10.0.1.

    Note

    VoltScript is only supported on Volt Foundry using a Tomcat non-clustered application server.

  • You have downloaded the VoltScript Installation Tool.

For more information, see Download HCL Volt MX Go installers.

Procedure

Install VoltScript Plugin Installer

The procedure guides your through the installation of the VoltScript Plugin Installer, installs the VoltScript plugins in Volt Foundry.

  1. Open terminal, navigate to the directory containing the installer file, and extract the installer from the tar file.
  2. Navigate to the directory containing the .bin file to ensure that you are in the right location to execute the installation commands for the .bin file.

  3. Enter the following command to grant executable permissions to the .bin file and press Enter.

    For example:

    sudo chmod +x <installerfilename>.bin

    Using the chmod command with sudo ensures administrative privileges.

  4. Run the .bin file to start the installation using the following command and press Enter.

    For example:

    ./<installerfilename>

  5. Follow the installation instructions. The binary file will initiate the installation process and may prompt you with on-screen instructions. Follow these instructions carefully to complete the installation.

    Note

    If you have a graphical terminal associated with your Linux deployment, the VoltScript Installation Tool window opens. Otherwise, installation is via the command line.

  1. Navigate to the folder containing the downloaded installer file.
  2. Double-click the installer file. The VoltScript Installation Tool window opens.

  3. On the Introduction, read the details and instructions, and then click Next.

    Introduction

  4. On the License Agreement, read the agreement details, select the I accept the terms of the License agreement checkbox, and then click Next.

    License Agreement

  5. On the Choose Install Folder, click Next if you agree with the indicated default location.

    Choose Install Folder

    Tip

    • If you want a different installation location, click Choose to select your preferred installation location or directly enter your preferred installation location in the text box, and then click Next.
    • If you selected a different installation location and decided to revert to the default location, click Restore Default Folder and then click Next.

  6. On the Pre-Installation Summary, review the details and then click Install.

    Pre-Installation Summary

  7. On the Installing, see the installation status.

    Installing

  8. On the Install Complete, click Done.

    Install Complete

Install VoltScript plugins

The procedure guides you in installing the VoltScript plugins in Volt Foundry.

  1. Open Terminal.
  2. Go to the directory where you installed the VoltScript Plugin Installer.

  3. Run the VoltScript Plugin Installer by entering the following command and press Enter.

    ./<installerfilename>

    The installation tool opens on the Terminal showing the available options as can be seen from the following example:

    Installation options

  4. Enter 1 to install VoltScript plugins in Volt Foundry and press Enter.

  5. Specify the Tomcat WebApps directory by entering the number corresponding to your installation or enter the full path to your Tomcat WebApps directory, and then press Enter.

    You get a confirmation statement that the plugins have been installed.

  6. Enter 7 and press Enter to exit the installation tool.

  1. Select Start, scroll through the alphabetical list, and select VoltScript Plugin Installer. Depending on your OS, you might need to select All apps, scroll through the alphabetical list, and click VoltScript Plugin Installer.

    OR

    Double-click the VoltScript Plugin Installer shortcut on your desktop if available.

    A Command Prompt window opens showing the available options as can be seen from the following example:

    Installation options

  2. Enter 1 to install VoltScript plugins and press Enter.

  3. Specify the Tomcat WebApps directory by entering the number corresponding to your installation, or enter the full path to your Tomcat WebApps directory, then press Enter.

    You get a confirmation statement that the plugins have been installed.

  4. Press Enter to close the Command Prompt window.

Tip

Make sure to restart Volt Foundry after completing the installation of the VoltScript plugins.

Expected result

You have now installed the VoltScript plugins in Volt Foundry. You can now configure a VoltScript Integration Service in Volt Foundry. For more information, see the VoltScript documentation link image.

For Volt Foundry installed using Helm charts

Before you begin

Make sure you have downloaded the Volt Foundry Helm charts. The minimum supported version is v10.0.1. For more information, see Download HCL Volt MX Go installers.

Procedure

  1. Extract the downloaded installer zip file.

  2. Update the voltmx-foundry-ingress.yaml file in the apps/templates directory.

    1. Open the voltmx-foundry-ingress.yaml file with your preferred editor.

    2. Locate the Ingress controller configuration for integration part in the voltmx-foundry-ingress.yaml file.

      Ingress controller configuration for integration

    3. Add the following code snippet to be one of the Integration paths.

      - path: /voltscript
    pathType: Prefix
    backend:
      service:
        name: voltmx-foundry-integration
        port:
          number: 8080

      Make sure to follow the correct indentation when adding the code snippet. Refer to the folowing image showing the part of the voltmx-foundry-ingress.yaml file after adding the code snippet.

      code snippet

    4. Save your changes and close the file.

  3. Update the values.yaml file.

    1. Open the values.yaml file with your preferred editor.
    2. Locate the line containing the imageRegistry: key and make sure that its value is "hclcr.io/voltmxgo".
    3. Locate the line containing the foundryBuildVer: key and update its value to "10.0.0_GA".
    4. Save your changes and close the file.

  4. Proceed to installing Volt Foundry using Helm charts on a supported Kubernetes platform.

Expected result

After updating the voltmx-foundry-ingress.yaml, values.yaml file, and completing the Volt Foundry installation using Helm charts, you can now configure a VoltScript Integration Service in Volt Foundry installed using Helm charts. For more information, see the VoltScript documentation link image.

Additional information

You can install VoltScript Runtime using the Install VoltScript Runtime Zip option in the VoltScript Plugin Installer. The VoltScript Runtime files will be saved in the following locations:

  • For Linux: /usr/local/voltscript
  • For Windows: C:\Program Files\HCL\voltscript

For more information on VoltScript Runtime, see the VoltScript documentation link image.