Maximo API Client - v0.9.21
    Preparing search index...

    Interface ClusterInstallOptions

    Options accepted by ClusterService.installScript.

    interface ClusterInstallOptions {
        scriptName?: string;
        source?: string;
        description?: string;
        status?: "Active" | "Inactive" | "Draft";
        scriptlanguage?: "jython" | "python";
        verify?: boolean;
        objectStructure?: string;
    }
    Index

    Properties

    scriptName?: string

    Override the autoscript name. Defaults to ClusterService.scriptName (which is initialised from MaximoClientConfig.clusterScriptName, ultimately MAXIMOMIZE.CLUSTER). When this differs from CLUSTER_SCRIPT_NAME, a source override is required — we ship a bundled .py only for the default name.

    source?: string

    Override the autoscript source. Defaults to the bundled Jython at resources/autoscripts/MAXIMOMIZE.CLUSTER.py. Required when scriptName is something other than the bundled default.

    description?: string

    Override the autoscript description. Defaults to a standard Maximo-aware blurb.

    status?: "Active" | "Inactive" | "Draft"

    Maximo autoscript status. Active makes the script immediately invokable.

    scriptlanguage?: "jython" | "python"

    Script language. The bundled script is Jython so the default is jython.

    verify?: boolean

    When true, performs a ?action=ping after install to confirm the script loaded.

    objectStructure?: string

    Object structure used for the bulk request. Defaults to the autoscriptObjectStructure configured on MaximoClientConfig, or mxapiautoscript when no override is set.