VoltScript Components
VoltScript comprises multiple components delivered via different methods. This can be confusing. This page aims to demystify what comes from where, for which audience, for what purpose.
Download / Retrieval Locations
| Location | Artefact | Purpose |
|---|---|---|
| My HCLSoftware | Windows installer | Develop VoltScript on Windows Run standalone VoltScript code on Windows |
| My HCLSoftware | Mac installer | Develop VoltScript on any Mac Run standalone VoltScript code on Intel/ARM Mac |
| Harbor | Linux Container Image | Develop VoltScript on any platform using VS Code Dev Containers |
| Harbor | Volt Foundry Container Image | Upload or code VoltScript integration services on Volt Foundry |
| Volt MX Marketplace | VoltScript Extensions | Provides closed-source low-level functionality Add via build management Import into VoltScript integration service zip |
| HCL GitHub org | VoltScript Library Modules | Provides open source helpers Add via build management Download from Releases and upload to VoltScript integration service zip |
For Volt Foundry, see the Volt Foundry documentation, paying special notice to the Enable VoltScript in Volt Foundry how-to guide in the Volt MX Go documentation.
Audience
Administrators
Administrators will only require Volt Foundry. For more information, see the Enable VoltScript in Volt Foundry how-to guide in the Volt MX Go documentation.
Developers
Developers' starting point will depend on their development approach:
- For developers wishing to develop VoltScript code locally:
- On Windows, download the Windows installer and follow instructions in the relevant tutorial.
- On any Mac, download the Mac installer and follow instructions in the relevant tutorial.
- On any platform, download the Linux dev container image and follow instructions in the relevant tutorial.
- For developers wishing to write their code directly into a Volt Foundry, see the Enable VoltScript in Volt Foundry how-to guide in the Volt MX Go documentation.
Note
- VoltScript integration service projects can be coded locally and uploaded into Volt Foundry, or they can be coded directly into Volt Foundry. Better IDE integration is currently possible with local development on Visual Studio Code, plus the ability to write and run unit tests. If you know the APIs and are willing to accept that compile-time errors are only exposed at runtime, developing directly on Volt Foundry may be quicker.
- A container image is not currently available for ARM-based Mac. The Linux container image for Intel Mac may work, but is unsupported.
- As with Volt MX Go early access program, only a containerized image of Volt Foundry is provided.
VoltScript Extensions
Developers should not download the VoltScript extensions from the Volt MX Marketplace. However, you will need credentials for Volt MX Marketplace, see Volt MX Marketplace how-to.
For locally-based development, the Archipelago build management system should be used to pull down extensions.
For development directly on Volt Foundry, you can import directly from the Volt MX Marketplace. You will prompted for the username and password for Volt MX Marketplace.
VoltScript Library Modules
For locally-based development, the Archipelago build management system should be used to pull down VoltScript Library Modules. This will automatically pull in downstream dependencies.
For development directly on Volt Foundry, you will need to download the scripts from the Releases area of the relevant repo, then upload to Volt Foundry. You will need to ensure you pull in the relevant dependencies, which can be confirmed by looking at the relevant atlas.json.