VoltScript Volt MX Middleware

Libraries for integrating with Volt MX Foundry.

Using 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-voltmx-middleware",
            "version": "1.0.0",
            "module": "VoltMXObjects.vss",
            "repository": "hcl-github"
        }

VoltMXObjects

VoltMXObjects is used for parsing the JSON object sent by a Foundry integration service (also also used behind the scenes in pre/postprocessors). The key objects are exposed as global properties. The JSON object will be passed as the context and accessed via ContextVSE:

Dim ctx as New Context()
data = ctx.context

The extractObjects() function will then parse the JSON object and populate the variables.

Error Handling and Returning Context

The return output should be a JSON object and only the JSON object. This should be VoltMxResult.toJson(). Errors should be passed by call VoltMxResult.setError().

Contributing

See CONTRIBUTING.md.

## Code of Conduct

See CODE_OF_CONDUCT.md.

Issues and discussions

Let's chat on OpenNTF Discord.

For long-running discussions, use Discussions area in GitHub. For bugs and feature requests specific to VoltScript VoltMX Middleware use, Issues area.