Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Panel

Table of Contents
maxlevel2

...

The Universal Extension developer will create a new Universal Extension-based Universal Template, declaring:

  • Task fields required for defining and launching the process through the Universal Extension.

  • Task Instance fields required for capturing data coming back throughout the life-cycle of the Universal Extension process.

  • Task Instance commands, and their supported status(es), that can be executed through the Universal Extension.

...

To create a Universal Extension, see Creating a Universal Template.

Agent Registration

All communication between the Universal Controller and the Universal Extension is managed through UAG; therefore, any registering agent that meets the release criteria can be a Universal Extension provider.

...

If on-demand deployment of an extension is required, the task instance will transition to the Queued Status with the Deploy Extension Status Attribute.

Upon successful deployment, the Deploy Extension Status Attribute will be cleared and the task instance will transition to the Running Status.

If the deployment is unsuccessful, the the Deploy Extension Status Attribute will be cleared and the task instance will transition to the Start Failure Status.

If an extension cannot be deployed to the destination agent due to the extension not being an accepted extension, the task instance will transition to Undeliverable Status.

Once the agent configuration has been updated, and the agent restarted, on-demand deployment can commence and the task instance will transition to Running Status upon successful deployment, as described above.

...

Name

Unique command name, adhering to the same naming convention as a Universal Template field name.

Label

User friendly display name for the command, to be displayed within the client.

Supported Status(es)

Specifies the task instance status (or statuses) that the dynamic command should be enabled for.

Dependent Fields

The administrator can select zero or more Universal Template fields that are required by the command. The values of those fields will be included in the command request.

Timeout

Specifies an optional command timeout, in seconds, if the command requires longer than the System-level default of 60 seconds.

If the Controller (server) does not receive a command response from the Extension prior to the timeout being reached, a timeout message will be sent to the client (user interface), and displayed in the Console:

Command "command-name" on task instance "instance-name" with id instance-uuid timed out.

Execution Option

Specification for whether the command runs out-of-process execution or in-process execution.

AsynchronousIf Execution Option is in-process; Specification for whether the command runs synchronously or asynchronously.

...

During the upload process, the extension.yml metadata will be parsed and made available from the Universal Template Metadata fields.

Import/Export Template

...

Export

To export an existing Universal Template as a zip file, click the Export Template button in the Universal Template Details.

(You can also click Export Template in the Action menu that displays for that Universal Template record.)

The exported Universal Template has the following filename format:

{distribution}-{version}(-{build tag})?-{python tag}-{abi tag}-{platform tag}.whl

ImportTo import a Universal Template zip file, click the Import Template… button on the Universal Templates list.

...