Skip to content

VoltScript Extensions

VoltScript Extensions are closed-source C/C++ binaries, .dll files on Windows, and .so files on Linux. The are hosted on Volt MX Marketplace. Some leverage other C/C++ libraries, for example libcurl. The following VoltScript Extensions are available:

Note: Click the links to view the API Docs.

  • ContextVSE provides access to command line --context argument.
  • StreamVSE provides utilities for reading/writing files and STDIO.
  • OSUtilVSE provides utilities for integrating with the operating system.
  • ZipVSE provides utilities for reading/writing zip files. This can't read / write .tar.gz files.
  • JsonVSE provides utilities for manipulating JSON.
  • WebVSE provides utilities for making HTTP(s) calls via libcurl.
  • ZuluVSE provides utilities for reading/writing UTC date/times.
  • HashVSE provides hashing and cryptographic utilities.
  • KeepVSE: provides a layer for making calls to Domino REST API.
  • CouchVSE provides a layer for integrating with CouchDB.
  • XMLVSE provides utilities for manipulating XML.

You can also access aggregated API Docs.

Dependency management

VoltScript Extensions for dependency management are hosted in Volt MX Demo Marketplace. You'll need three parts:

Logon

You'll need a username and password for Volt MX Marketplace. Make sure you've tested successfully logging into the web interface before using it for dependency management. You'll then need to add this to the JSON object in your atlas-settings.json, in the .vss directory of your user home directory:

    "volt-mx-marketplace": {
        "type": "marketplace",
        "username": "YOUR_USERNAME",
        "password": "YOUR_PASSWORD",
        "authUrl": "https://accounts.auth.demo-hclvoltmx.net/login"
    }

Repository

You'll need to add to your repositories object in the atlas.json of your project:

        {
            "id": "volt-mx-marketplace",
            "type": "marketplace",
            "url": "https://community.demo-hclvoltmx.com/marketplace/asset"
        }

Dependency

You'll need the relevant dependency to add to your vseDependencies object in the atlas.json of your project:

        "ContextVSE": {
            "library": "25276",
            "version": "1.0.1",
            "module": "25880/20848",
            "repository": "volt-mx-marketplace"
        }

        "CouchVSE": {
            "library": "25292",
            "version": "1.0.1",
            "module": "25881/20849",
            "repository": "volt-mx-marketplace"
        }

        "HashVSE": {
            "library": "25278",
            "version": "1.0.1",
            "module": "25882/20850",
            "repository": "volt-mx-marketplace"
        }

        "JsonVSE": {
            "library": "25265",
            "version": "1.0.1",
            "module": "25877/20841",
            "repository": "volt-mx-marketplace"
        }

        "KeepVSE": {
            "library": "25280",
            "version": "1.0.1",
            "module": "25844/20851",
            "repository": "volt-mx-marketplace"
        }

        "OSUtilsVSE": {
            "library": "25282",
            "version": "1.0.1",
            "module": "25886/20852",
            "repository": "volt-mx-marketplace"
        }

        "StreamVSE": {
            "library": "25284",
            "version": "1.0.1",
            "module": "25878/20842",
            "repository": "volt-mx-marketplace"
        }

        "WebVSE": {
            "library": "25286",
            "version": "1.0.1",
            "module": "25888/20853",
            "repository": "volt-mx-marketplace"
        }

        "ZipVSE": {
            "library": "25288",
            "version": "1.0.1",
            "module": "25890/20854",
            "repository": "volt-mx-marketplace"
        }

        "ZuluVSE": {
            "library": "25290",
            "version": "1.0.1",
            "module": "25891/20855",
            "repository": "volt-mx-marketplace"
        }

        "XmlVSE": {
            "library": "25893",
            "version": "1.0.0",
            "module": "25892/20856",
            "repository": "volt-mx-marketplace"
        }

Troubleshooting

If the VoltScript Dependency Manager fails, review the information printed to the console. An atlas-settings.json will be required for dependencies pulled from GitHub or from a web server that requires authentication. The dependencies will be downloaded to the .vss directory in the user's home before being copied to the project. If using a dev container, this will be the user's home in the container.