Create Automation Tasks Library#

AutomationTasksLibrary.Create

Overview#

This operation allows creating a new Automation Tasks Library in the system.

Setup#

The necessary library packages from which the Automation Tasks Library will load the tasks need to be configured and available in the system.

Preconditions#

• The Connect IoT module is properly licensed in the system.

Sequence of Steps#

Step 1: General Data#

1. Enter a unique Name.
2. Provide a Description.
3. Select a package to feed the tasks into the Automation Tasks Library. The packages can be filtered using the configuration entry /Cmf/System/Configuration/ConnectIoT/TasksLibraryPackageNameFilter/. For more information, see System Configuration Entries.

4. Specify whether the version of the Automation Tasks Library should be set as default for any Automation Controller that uses that library (defaults to True).

   Info

   There can only be one Automation Tasks Library matching the combination of package name and version.

   Info

   There can only be one default Automation Tasks Library for each combination of package and its respective version. When you create a new Automation Tasks Library and set it as default, the previously default library will reset the default flag.

5. Select Next to continue the operation.

Step 2: Parameters#

If the package defined in the previous step has been created specifically as an Automation Tasks Library, the fields can be pre-filled according to the specification of the package. However, you can override all values in this panel:

• Library Name - the name of the Automation Tasks Library that will be shown in the Automation Workflow editor
• Depends on Protocol - A list of Automation Protocols that will enable the Automation Tasks Library when creating an Automation Controller. If the Automation Protocol is not configured in the Automation Protocol associated with the Automation Driver Definitions available in the Automation Controller, this Automation Tasks Library will not be available when editing the Automation Workflow.
• Mandatory for Protocol - A list of Automation Protocols that will not only show the library but will be set as mandatory (uneditable and automatically selected) in the Automation Controller tasks selection panel. For more information, see Create Automation Controller.
• Depends on Scope - A list of scopes that will show the Automation Tasks Library when creating an Automation Controller. When the scope of an Automation Controller doesn't match the list of scopes defined for this Automation Tasks Library, the tasks library will not be available for selection.
• Mandatory For Scope - A list of scopes that will not only show the Automation Tasks Library when creating an Automation Controller but will be set as mandatory (uneditable and automatically selected) in the Automation Controller tasks selection panel.

Step 3: Metadata#

The metadata definition contained in the Automation Tasks Library will be displayed. This is shown as a text box with JSON-formatted content loaded directly from the package, which can be edited at will and have any change to the JSON file reflected directly in the Automation Tasks Library when it is used in the system.

Select Create to complete the operation.