The Spotfire Action Mod manifest schema

version: string , must match ^(.*)$

Specifies the version of this Mod.

apiVersion: string 2.0 , must match ^(.*)$

Specifies the version of the Mod JavaScript API used by the code of this Mod. Set the lowest possible version number that the Mod requires to ensure best possible backward compatibility with older Spotfire systems. Using a newer API version than specified will result in runtime errors, even if the current Spotfire system includes that API.

name: string , must match ^(.*)$

Specifies the name of this Mod. The name will be shown to the user when this Mod is handled in Spotfire.

description: string , must match ^(.*)$

Specifies the description of this Mod. The description will be shown to the user of the mod.

icon: string icon.svg
id: string , must match ^[a-zA-Z0-9]+[a-zA-Z0-9-._]*(?<=[a-zA-Z0-9])$
type: string , x ∈ { action (default) } , must match ^(.*)$
capabilities: string[]

Any extended capabilities required by the scripts in the mod. The API documentation indicates if an API requires an extended capability.

string , x ∈ { LibraryRead , LibraryWrite } , must match ^(.*)$
files: string[]

All files of a mod will be saved into Spotfire. The files array lists all files so that Spotfire can save them.

string , must match ^(.*)$
scripts: []

All scripts which can be executed inside of Spotfire.

id: string script-id , must match ^[a-zA-Z0-9]+[a-zA-Z0-9-._]*(?<=[a-zA-Z0-9])$

The identifier of the script. This needs to be unique within the mod has must not change between versions of the mod.

name: string script-name , must match ^(.*)$

Specifies the display name of the script.

file: string script.js , must match ^(.*)$

Specifies the path of the script file relative to the mod manifest.

entryPoint: string scriptFunction , must match ^[$A-Za-z_][0-9A-Za-z_$]*$

Specifies the unique entry point of the script. The entry point has to be unique across all scripts included in the mod.

description: string Description of the script , must match ^(.*)$

A description of what this script does.

wrapInTransaction: boolean true , must match ^(true)(false)$

Flag indicating if the script should be wrapped in a transaction.

parameters: []

All parameters of the entry point function.

name: myParam

The JavaScript identifier for the parameter.

type: string , x ∈ { Boolean , Currency , DataTable , Date , DateTime , Integer , LongInteger , Real , SingleReal , String , Time , TimeSpan , Page , Visualization }

The Spotfire type of the parameter.

displayName: string Display name of the parameter. , must match ^(.*)$

A description of this parameter.

description: string Description of the parameter , must match ^(.*)$

A description of this parameter.