Skip to main content

Module Installation

Each Istari Digital Agent can have any number of modules installed on it. Repeat the steps below for each module to be installed on an agent.

Installers​

These instructions assume that you have access to the module installers.

The module installers can be downloaded from Artifactory.

The installers for version X.Y.Z of module example_module are available directly at https://istaridigital.jfrog.io/ui/native/release-istari-modules-local/example_module/X.Y.Z/.

Reach out to Istari Digital if you do not have access to the module installers in Artifactory.

Download Commands​

Windows​

Set the following environment variables:

  • Set $artifactory_username to your Artifactory username
  • Set $artifactory_token to your Artifactory login token
  • Set $module_name to the name of the module to download (eg open_pdf)
  • Set $module_version to the version of the module to download (eg 1.1.1)
  • Set $module_installer to the filename for the module installer you want to download (eg open_pdf-1.1.1-windows.zip)

For example:

$artifactory_username = "you@example.com"
$artifactory_token = "abcedfghijklmnopqrstuvwxyz0123456789"
$module_name = "open_pdf"
$module_version = "1.1.1"
$module_installer = "open_pdf-1.1.1-windows.zip"

Then run the following commands:

$authentication = [Convert]::ToBase64String([System.Text.Encoding]::ASCII.GetBytes($artifactory_username+":"+$artifactory_token))
$headers = @{ Authorization = "Basic $authentication"}
Invoke-WebRequest -Uri "https://istaridigital.jfrog.io/artifactory/release-istari-modules-local/$module_name/$module_version/$module_installer" -Headers $headers -OutFile $module_installer -MaximumRedirection 5

RHEL / Ubuntu​

Set the following environment variables:

  • Set ARTIFACTORY_USERNAME to your Artifactory username
  • Set ARTIFACTORY_TOKEN to your Artifactory login token
  • Set MODULE_NAME to the name of the module to download (eg open_pdf)
  • Set MODULE_VERSION to the version of the module to download (eg 1.1.1)
  • Set MODULE_INSTALLER to the filename for the module installer you want to download (eg open_pdf-1.1.1-linux.tar.gz)

For example:

ARTIFACTORY_USERNAME="you@example.com"
ARTIFACTORY_TOKEN="abcedfghijklmnopqrstuvwxyz0123456789"
MODULE_NAME="open_pdf"
MODULE_VERSION="1.1.1"
MODULE_INSTALLER="open_pdf-1.1.1-linux.tar.gz"

Then run the following command:

curl -u$ARTIFACTORY_USERNAME:$ARTIFACTORY_TOKEN -L -O "https://istaridigital.jfrog.io/artifactory/release-istari-modules-local/$MODULE_NAME/$MODULE_VERSION/$MODULE_INSTALLER"

Module Publishing​

The module releases includes a module_manifest.json. Each manifest must be published to the Module registry in the Istari Digital Platform before it can be made available to users.

Modules​

See the linked pages below for details on each module and its most recent version:

Compatibility​

Many modules work only on certain operating systems. Consult the documentation for each module for guidance.

Modules Registry​

Publishing the Module Manifest​

You can publish a module's manifest using the Istari Digital Python SDK calls. Follow these instructions to create a PAT or JWT.

Please note that the manifest file that you publish must be an "inlined" manifest that contains the function schemas in the manifest file. Contact support@istaridigital.com for assistance if you do not have a inlined manifest available for a module.

If you are unable to use the SDK, you can instead make a direct API request to the Registry. Using your PAT, make the following API request to the Istari Digital Platform:

Windows​

$module_manifest = Get-Content "</path/to/module_manifest.json>"
$istari_headers = @{
  "Content-Type" = "application/json";
  "Authorization" = "Bearer <USER_TOKEN>";
}
Invoke-WebRequest -Uri "http://<API_URL>/api/v2/modules" -Method POST -Headers $istari_headers -Body $module_manifest

RHEL / Ubuntu​

curl -X 'POST' \
  'http://<API_URL>/api/v2/modules' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer <USER_TOKEN>' \
  -d @</path/to/module_manifest.json>

Managing Module Function access​

To ensure compliance with each tool's EULA, each user on the platform must be explicitly granted access to the modules through the Istari Platform's Admin Panel.

Notes​

  • Users must be an Admin in order to use the Function Access panel.
  • Users do not need to be added for each new version of a module. Permissions will be inherited from the previous module version.
  • Newly published modules will have the User who published it in the access list to start. Other users must be added manually.
Info for releases after July 2025

Note: This process has changed with the July 2025 release of the Istari Digital Platform. Select the links for your installed version to find instructions for managing function and tool access.

Managing Tool Access for versions after July 2025​

  1. Click on the users tile on the Admin page.

  2. Open the menu for a user and select Manage Tool Access
    Click on the three-dot menu next to the user whose function or tool access you wish to edit, then click on Manage Tool Access.

  3. Select the checkbox(es) for the tools for which you wish to give your user access
    In the tool access modal that displays for the user you selected, click on the checkbox(es) next to the tool(s) to which you wish to give your user access.

    If you recently migrated from a pre-July 2025 release

    If you have recently migrated from an earlier version of the Istari Digital Platform, all checkboxes for existing access will be partially checked, meaning your users only have access to existing functions for that tool and not any future ones that are added. You can uncheck and re-check the box to give them access to the tool, which gives access to all existing and future functions.

    Checkbox states

    Checkboxes for tools have three states with different meanings:

    • Checked (dark background): Access to the tool. User has access to all current functions and any future functions added for the same tool.
    • Partially checked (light background): Access only to existing, selected functions. User will have access to selected functions, but not any new functions added.
    • Unchecked (no checkmark): No access to the tool or its functions.

  4. Click the Save button to save your changes.

Managing Granular (Function) Access for versions after July 2025​

  1. Click on the users tile on the Admin page.

  2. Open the menu for a user and select Manage Tool Access
    Click on the three-dot menu next to the user whose function or tool access you wish to edit, then click on Manage Tool Access.

  3. Expand the tool for which you wish to manage granular access
    In the tool access modal that displays for the user you selected, click on the chevron next to the tool for which you wish to manage per-function access for your user. The chevron will expand the tool's section to show all existing functions under the tool.

  4. Select the functions to which you wish to give your user access.
    Tick the checkboxes next to the functions to which you wish to give your user access.
    Note: If you tick every checkbox, the tool checkbox will change from a partially checked to a fully checked state, and the user will have access to the tool, which includes access to all existing and future functions for the tool.

    If you recently migrated from a pre-July 2025 release

    If you have recently migrated from an earlier version of the Istari Digital Platform, the tool checkbox will be partially checked even if all functions are checked. If all functions are checked and you uncheck and re-check any of the functions and save your changes, the user will have access to the tool, which includes all existing and future functions.

  5. Click the Save button to save your changes.

Managing Function Access (releases before July 2025)​

  1. Click on the Admin Panel link in the side bar.
  2. Click on the Function Access tile.
  3. Open the edit window for the tool for which you wish to manage function access.
    Click on the three-dot menu for the tool whose function access you wish to edit, then click on Manage Function Access.
  4. Add and remove users from the access list.
    To add a user, search for their name in the text box and then press Add.
    To remove a user, click the Remove button next to their name in the list of users with access.
  5. Save your changes.
    Click the Save button at the bottom of the modal.

Agent's Modules Folder​

Create the Folder​

The Istari Digital Agent loads modules from the folder istari_modules. This folder is located in the directory the agent is installed into (%LOCALAPPDATA%\istari_agent\ on Windows; /opt/local/istari_agent/ on RHEL/Ubuntu).

Windows​

Create the folder %LOCALAPPDATA%\istari_agent\istari_modules if it does not already exist.

RHEL / Ubuntu​

Create the folder /opt/local/istari_agent/istari_modules if it does not already exist.

Install the Module​

  1. Copy the module installer to the host machine and unpack the ZIP or tar archive.

  2. Confirm that there is a module_manifest.json inside the folder unpacked from the archive.

  3. Move the folder unpacked from the archive to the istari_modules folder.

Example module structure:

 - istari_modules/
 | - dassault_cameo/
 | | - module_manifest.json
 | \ - …
 | - microsoft_office_word/
 | | - module_manifest.json
 | \ - …
 …

Configure the Module​

Some modules require module-specific configuration. Consult the documentation for the installed module for guidance.