Scripts

Scripts #

Scripts work the same as Script Components - they allow you to run a custom Python script. The difference is that the Script Modifier does not need to have a Python Pandas DataFrame passed as input or output.

When you create a new Script, a new form will open. You will have to fill in the following fields:

  1. Name - the name of the Script,
  2. Description - the description for the Script (Optional),
  3. Step - the Process Step on which the Script will be run,
  4. Code - the code to be executed by the Script.

Script run logs #

When you click on the small Status icon in the upper right corner of the Script, a popup for the Script run log will present details of the latest log entry:

  1. the name of the Process in which this Script is used,
  2. the name of this Script,
  3. the Status of the last execution,
  4. the Task id ,
  5. the Parent task id,
  6. when the Script entered the queue to be run,
  7. the date this Script was last executed,
  8. the Duration how long this Script has been running; only available if the Script Status is SUCCESS or ERROR,
  9. a table of errors that occured during the execution (if there were any):
    • Error Class (A) - the class of the error,
    • Error message (B) - the error message returned,
  10. the Stack trace generated by the error (if there was any).

Clicking the Show whole history button will navigate you to the list of all of this Script’s logs. At the top you will see the name of the Process in which this Script is used, the step it is used in and the name of this Script. There you will see a list of all logs of previous Script executions. Each element on the list consists of:

  1. its ID,
  2. the date it was queued to be run,
  3. its start date,
  4. its duration (only available if the Script Status is SUCCESS or ERROR),
  5. the Celery task id the log refers to,
  6. the Celery parent task id the log refers to,
  7. its Status; click it to view the log details.

At the bottom you will find navigation tools (8) if there are more recorded logs.

Export Scripts #

You can export Scripts by clicking Export Script in the Script actions (accessible by clicking the icon on the Script).

This will navigate you to the Export Script section where you need to provide:

  1. a Filename for the exported Script,
  2. a Password for the file (Optional),

After clicking the Check content button, you will be navigated to the confirmation view.

Clicking the Cancel button will return you to the Export Script section.

Clicking the Save button, you will download a file containing the exported Script. The file can be then imported to any Process.

Example scripts #

In Examples section there are short example scripts.