kappa_sdk.UserTask#

class kappa_sdk.UserTask(field_id, well_id, custom_workflow_id, user_task_id, name, user_task_instance_id, data_types_catalog, outputs, plots, files, field_api, processing_api, plot_dto_converter, user_task_dto_converter)[source]#

User task object.

Presents a KAPPA Automate user task information object.

Attributes

`UserTask.custom_workflow_id`	Get the custom workflow id of the `UserTask` object.
`UserTask.documents`	Gets the list of the documents under this `UserTask`.
`UserTask.files`	Gets the list of the files under this `UserTask`.
`UserTask.id`	Gets the id of the `UserTask` object.
`UserTask.inputs`	Retrieves the user task inputs.
`UserTask.name`	Gets the name of the `UserTask`.
`UserTask.outputs`	Gets the list of outputs of the `UserTask`.
`UserTask.plots`	Gets the list of the plot instances of the `UserTask`.
`UserTask.user_task_definition_name`	Gets the user task definition name of the `UserTask` object.
`UserTask.user_task_instance_id`	Gets the user task id (processing service) of the `UserTask` object.

Methods

`UserTask.create_plot`(plot_name[, pane_name, ...])	Create a Kappa Automate Plot instance under the user task
`UserTask.delete`()	Delete the User Task
`UserTask.rename`(new_name)	Rename the User Task

Parameters:

field_id (str)
well_id (str)
custom_workflow_id (str | None)
user_task_id (str)
name (str)
user_task_instance_id (str)
data_types_catalog (FieldDataTypesCatalog)
outputs (List[Data])
plots (List[Plot])
files (List[File])
field_api (FieldAPI)
processing_api (ProcessingAPI)
plot_dto_converter (PlotDtoConverter)
user_task_dto_converter (UserTaskDtoConverter)

__init__(field_id, well_id, custom_workflow_id, user_task_id, name, user_task_instance_id, data_types_catalog, outputs, plots, files, field_api, processing_api, plot_dto_converter, user_task_dto_converter)[source]#

Parameters:

field_id (str)
well_id (str)
custom_workflow_id (str | None)
user_task_id (str)
name (str)
user_task_instance_id (str)
data_types_catalog (FieldDataTypesCatalog)
outputs (List[Data])
plots (List[Plot])
files (List[File])
field_api (FieldAPI)
processing_api (ProcessingAPI)
plot_dto_converter (PlotDtoConverter)
user_task_dto_converter (UserTaskDtoConverter)

create_plot(plot_name, pane_name=None, square_log_cycles=False, stacked_bars=False, x_label='', is_x_log=False, labels=None)[source]#

Create a Kappa Automate Plot instance under the user task

Parameters:

plot_name (str) – Name of plot
pane_name (str | None) – Name of the pane
square_log_cycles (bool) – Whether or not use Square log cycles
stacked_bars (bool) – Whether or not use stacked bars
x_label (str) – x label
is_x_log (bool) – Whether or not use logarithmic scale for x values
labels (List[str] | None) – Add some labels to the plot

Returns:

Plot – The new Plot instance created under the task.

Return type:

Plot

property id: str#: Gets the id of the UserTask object.

property custom_workflow_id: str | None#: Get the custom workflow id of the UserTask object.

property name: str#: Gets the name of the UserTask.

property outputs: List[Data]#: Gets the list of outputs of the UserTask.

property plots: List[Plot]#: Gets the list of the plot instances of the UserTask.

property files: List[File]#: Gets the list of the files under this UserTask.

property documents: List[Document]#: Gets the list of the documents under this UserTask.

property user_task_instance_id: str#: Gets the user task id (processing service) of the UserTask object.

property user_task_definition_name: str#: Gets the user task definition name of the UserTask object.

rename(new_name)[source]#

Rename the User Task

Parameters:: new_name (str)
Return type:: None

delete()[source]#

Delete the User Task

Return type:: None

property inputs: List[Dict[str, bool | str | float]]#

Retrieves the user task inputs.

Returns:: List[Dict[str, Union[bool, str, float]]]: A list of dictionaries, each containing the name and value of a user task input. The value can be of type bool, str, or float.