Skip to content

VoltScript Library Modules

VoltScript Libraries are .vss files with provided classes, subs, and functions for use in the main and test scripts. They shouldn't have a Sub Initialize.

For documentation on HCL-developed VoltScript Libraries, see:

  • VoltScript Testing provides classes for unit-/integration-testing and validation.
  • VoltScript JSON Converter provides classes for configured deserialization / serialization of JSON.
  • VoltScript Collections provides Collection, Map and Pair classes.
  • VoltScript Console Colors provides constants for changing the console colors when printing to a terminal that supports this functionality.
  • VoltScript Volt MX Middleware provides classes for interacting with context and updating results for Volt Foundry.

Within this documentation you can access aggregated API Docs as of Early Access 2.

Dependency management

Dependency management is available in the documentation for each project, but also aggregated here:

Authentication

You'll need a Personal Access Token to use GitHub REST APIs. 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:

    "hcl-github": {
        "type": "github",
        "token": "${env.TOKEN}"
    }

Repository

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

        {
            "id": "hcl-github",
            "type": "github",
            "url": "https://api.github.com/repos/HCL-TECH-SOFTWARE"
        }

Dependency

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

        {
            "library": "voltscript-testing",
            "version": "1.0.1",
            "module": "VoltScriptTesting.vss",
            "repository": "hcl-github"
        }

        {
            "library": "voltscript-json-converter",
            "version": "1.0.2",
            "module": "VoltScriptJsonConverter.vss",
            "repository": "hcl-github"
        }

        {
            "library": "voltscript-collections",
            "version": "1.0.2",
            "module": "VoltScriptCollections.vss",
            "repository": "hcl-github"
        }

        {
            "library": "voltscript-console-colors",
            "version": "1.0.1",
            "module": "VoltScriptConsoleColors.vss",
            "repository": "hcl-github"
        }

        {
            "library": "voltscript-voltmx-middleware",
            "version": "1.0.0",
            "module": "VoltMXObjects.vss",
            "repository": "hcl-github"
        }

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.