Versions Compared

Key

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

...

ParameterTypeDefaultDescription
rc

int, optional

0

This parameter represents the return code of the extension_start operation. The associated Universal Task instance in the Controler can use this value to determine the completion status of the Extension instance. The value is implementation defined and therefore left up to the extension developer.

messagestr, optionalEmpty string

This parameter allows the extension to pass a completion message back to the Controller. If rc is set to 0, the message will be considered informational and will be logged by the Controller.
If rc is non-zero, the message will be considered an error message and will be displayed to the user on the task instance form.

output_fieldsdict, optionalNone

Dictionary containing output fields. 

unv_outputstr, optionalNone

The value for this parameter is considered the payload of the task execution. It appears on the task instance Output tab as Universal output type.

call_frame

frame, optional

NoneFrame of a function call where previous activity of interest occurred.

ExtensionLogger class

Class for providing logging functionality for Universal Extensions. Do not instantiate this class directly. UniversalExtension instantiates this class via a call to the logging.getLogger API call. See the example above for instructions on obtaining the logger instance.

The following log levels are officially supported:

  • CRITICAL
  • ERROR
  • WARNING
  • INFO
  • DEBUG
Note

In addition to the levels listed above, there is another level, TRACE, which is used by the Universal Extension internal API. It is NOT available for use in developing Extensions.