Panel | |
---|---|
|
Universal Extension
...
Package
UniversalExtension class
Base class for Stonebranch Universal Extension module implementations
...
Input | Parameters:
|
Output | None |
ExtensionResult class
class ExtensionResult
(**kwargs)
...
Parameter | Type | Default | Description |
rc | int, optional | 0 | This parameter represents the return code of the Dynamic Command operation and determines whether the command is perceived as completing with success or failure by the Controller. A value of 0 indicates success. All other values indicate an error condition and the command result will not be added to the Controller's Output tab. However, the Controller will log the command response. The non-zero value used to represent the error condition is implementation defined and therefore left up to the extension developer. |
message | str, optional | Empty string | The message parameter specifies a short status string (error message or success message) that will be logged by the Controller. |
output | bool, optional | False | This parameter is a Boolean value that specifies if the command produced output that should be persisted and displayed under the task instance Output tab in the Controller task instance associated with the dynamic command invocation. The default value is False. This flag allows distinguishing between a command that does not produce output and a command that produces output but the output returned was empty. |
output_data | str, optional | None | This parameter specifies the data that will be returned to the Controller for the command execution. It is interpreted as a UTF-8 encoded text object. If the output attribute is True, the output_data will be persisted in the Controller as a record under table ops_exec_output, and appearing as Universal Command output type from the task instance Output tab. The default value is None. |
output_name | str, optional | None | This parameter is used to provide a custom name for the associated output data. The output_name (if provided) will be used in the presentation of the output_data by the Controller. |
ExtensionLogger class
class ExtensionLogger
(name)
...
Input | Parameters:
|
Output | ExtensionResult |
Universal Extension 1.1.0 API
UniversalExtension class
Base class for Stonebranch Universal Extension module implementations
Methods
extension_cancel(self)
Implement in derived class.
extension_start(self, fields)
Implement in derived class.
update_extension_status(self, fields)
Propagate state changes back to the associated extension instance in the Controller.
- Can be called at any time by an Extension instance.
- Any/all output fields defined in the associated Extension Template can be updated using this method.
Parameters
fields : dict. The fields parameter expects a dictionary of output fields to be sent back to the controller for the associated Extension instance. Field names are implementation dependent and correlate with the Universal Template field names in the Controller's Template definition for the associated task.
Returns: None
Examples:
Panel >>> my_ext = MyExt() # my_ext is an instance of a (derived) extension class called MyExt >>> fields = {"foo": "bar"} >>> my_ext.update_extension_status(fields)
ExtensionResult(**kwargs) class
Depending on the context of the initialization, different parameters need to be passed to the constructor. See the notes below.
...
...
ExtensionResult |
...
Constructor Signature
(rc = 0, message = '', output = False, output_data = None, output_name = None, call_frame = None, **kwargs)
...
int, optional
...
This parameter represents the return code of the Dynamic Command operation and determines whether the Extension task instance is perceived as completing as Success or Failed by the Controller.
A value of 0 indicates success. All other values indicate an error condition and result in a status of Failed in the Controller. The non-zero value used to represent the error condition is implementation defined and therefore left up to the extension developer.
...
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
...
bool, optional
...
False
...
This parameter specifies if the command produced output that should be persisted and displayed under the task instance Output tab in the Controller task instance associated with the dynamic command invocation.
...
output_data
...
str, optional
...
None
...
This parameter specifies the data that will be returned to the Controller for the command execution. It is interpreted as a UTF-8 encoded text object.
If the output attribute is True, the output_data will be persisted in the Controller as a record under table ops_exec_output, and appearing as Universal Command output type from the task instance Output tab.
...
output_name
...
str, optional
...
None
...
This attribute is used to provided a custom name for the associated output data. The output_name (if provided) will be used in the presentation of the output_data by the Controller.
...
frame, optional
...
Choice Command
The form of the ExtensionResult constructor when instantiated in the context of Choice Command, is as follows:
Constructor Signature
(rc = 0, message = '', values = None, call_frame = None, **kwargs)
...
int, optional
...
This parameter represents the return code of the 'choice' operation and determines whether the command is perceived as completing with success or failure by the Controller. A value of 0 indicates success. All other values indicate an error condition and will be ignored by the Controller for form field population. However, the Controller will log the commnd response. The non-zero value used to represent the error condition is implementation defined and therefore left up to the extension developer.
...
This parameter allows the extension to pass a completion message back to the Controller. The message will be logged by the Controller.
...
This parameter specifies a list of string values to be returned to the Controller and used to populate the associated dynamic choice field on the Extension task form.
...
frame, optional
...
Extension Start
The form of the ExtensionResult constructor when instantiated in the context of Extension Start, is as follows:
Constructor Signature
(rc = 0, message = '', output_fields = None, unv_output = None, call_frame = None, **kwargs)
int, optional
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.
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.
Dictionary containing output fields.
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.
frame, optional