Skip to main content

K-A End User Help

User Task Script

User task script is a code to implement a user's workflow inside KAPPA-Automate. This is achieved by inserting the code block into the Scripts tab in the Create a New User Task dialog box.

Currently, K-A supports user task development in Python language.

User_task_definition_script_tab.png

Tip

To facilitate the task development in Python, an SDK provides a simplified access to the platform APIs. The Python SDK can be used to develop and run a code locally, and then migrate this code into a User task in K-A so that it can be executed by the platform automatically on selected triggers. The detailed information on the code development can be found in the KAPPA Automate Extension Guide.

When programming more elaborate tasks, it may be necessary to load external packages/libraries. These could be standard Python libraries e.g., Numpy, Scipy etc., or user modules. The packages to be used in the main script of a user task should be uploaded to the list of packages before creating the task. (see Uploading Packages for User Task Scripting below).

Uploading Packages for User Task Scripting

If certain packages to be used in the main script are not already available on the backend, they should be uploaded to the list of packages before/while creating the task.

Uploading a package before creating a user task
  1. Switch to Automation mode.

  2. Select User tasks in the hierarchy on the left.

  3. Switch to the Packages tab.

  4. Click on Create.

  5. Input the following information about the package:

    • Name: any combination of letters, numbers and symbols.

    • Scripting language: Python.

    • Package description: text information that helps managing the packages.

  6. Upload the package. This can be done in one of two ways:

    • Click on Select zip package. Or,

    • Drag and drop the zip file in the Drag and drop zip package area.

  7. Click on Create.

Uploading a package while creating a user task
  1. Under the Script tab, click on + next to the Package dropdown menu.

    User_task_definition_script_tab_upload_package.png
  2. Input the following information about the package:

    • Name: any combination of letters, numbers and symbols.

    • Scripting language: Python.

    • Package description: text information that helps managing the packages.

  3. Upload the package. This can be done in one of two ways:

    • Click on Select zip package. Or,

    • Drag and drop the zip file in the Drag and drop zip package area.

  4. Click on Create.