Extensions

Extensions
This namespace holds top-level commands and queries related to ACT.

InstallExtension

This command install an extension identified by its filename.

If this extension already exists, the user can force to install the extension by setting the variable "ForceInstall" to true.

Required Arguments

ExtensionFileName    ExtensionFileName argument containing the file name of the extension.
    Type    string

Optional Arguments

ForceInstall    Indicates whether the extension will be installed even if this extension already exists.
    Type    bool
    Default Value    False
Example

To install an extension: 

    Extensions.InstallExtension(ExtensionFileName=r"c:\my_extensions_repository\my_extension.wbex")

To install an extension and force installation if the extension already exists: 

    Extensions.InstallExtension(ExtensionFileName=r"c:\my_extensions_repository\my_extension.wbex",ForceInstall=True)

LoadExtension

This command load an installed extension.

Required Arguments

Id    Id argument containing the GUID of the extension.
    Type     string

Optional Arguments

Format    Format argument containing the format of the extension (Scripted or Binary).
    Type     string
Version    Version argument containing the version of the extension.
    Type     string
Example

To load an extension: 

    Extensions.LoadExtension(Id="7FD4DE83-39D0-4252-859B-2393C67F8EC8")
    Extensions.LoadExtension(Id="7FD4DE83-39D0-4252-859B-2393C67F8EC8", Version="1.0")
    Extensions.LoadExtension(Id="7FD4DE83-39D0-4252-859B-2393C67F8EC8", Version="1.0", Format="Binary")

UninstallExtension

This command uninstall an extension.

Required Arguments

Id    Id argument containing the GUID of the extension.
    Type     string

Optional Arguments

ForceUninstall    Indicates whether the extension will be uninstalled silently.
    Type     bool
    Default Value    False
Format    Format argument containing the format of the extension (Scripted or Binary).
    Type     string
Version    Version argument containing the version of the extension.
    Type     string
Example

To uninstall an extension: 

    Extensions.UninstallExtension(ExtensionFileName=r"c:\my_extensions_repository\my_extension.wbex")

UnloadExtension

This command unload a loaded extension.

Required Arguments

Id    Id argument containing the GUID of the extension.
    Type     string

Optional Arguments

Format    Format argument containing the format of the extension (Scripted or Binary).
    Type     string
Version    Version argument containing the version of the extension.
    Type     string
Example

To unload an extension: 

    Extensions.UnloadExtension(Id="7FD4DE83-39D0-4252-859B-2393C67F8EC8")
    Extensions.UnloadExtension(Id="7FD4DE83-39D0-4252-859B-2393C67F8EC8", Version="1.0")
    Extensions.UnloadExtension(Id="7FD4DE83-39D0-4252-859B-2393C67F8EC8", Version="1.0", Format="Binary")