Python Module
  • 27 Feb 2025
  • 3 Minutes to read
  • Dark
    Light

Python Module

  • Dark
    Light

Article summary

Module Details

Core or Github ModuleCore
Restart Required No 
Steps ExposedYes
Step Location Integration > Python
Settings Location System > Settings Python Module Settings
Prerequisites
  • A version of Python installed on the Decisions environment
  • Access to the file path to the Python directory after installation

The Python Module allows custom scripts written in Python to be created and used as steps inside a Flow. In order to utilize the module the file path must contain the Python executable to be run. For example, C:\Program Files\Python\python.exe will be entered in Python Module Settings.










Settings

Security Risk
This add-on module provides scripting capability.  Administrators acknowledge and accept full responsibility for securing the environment before installing and using it.

Navigate to System > Settings. Click on Python Module Settings and enter the full file path to the Python executable. Click SAVE once the file path has been configured. In order to update the file path, Decisions must be restarted.


Feature Details
Introduced in Version8.10
Modified in Version9.6
LocationSystem > Settings > Python Module Settings

Python Module in Container

In order to use the Python Module in containers, Decisions has included Python in the container image. The container will have the most up-to-date version of Python installed. The default path for Python in containers is at /usr/bin/python3.

After installing the Python Module, users need to point the Python Module Settings path to /usr/bin/python3.

Using Python Scripts in Flow Designer

Two primary methods exist for utilizing Python scripts within the Decisions Flow Designer:

1. Creating Script Projects

Script Projects house Python Scripts that will be generated as steps. They are mainly used for organization, as the name of the Python Script Project will appear as a sub-category under Integrations > Python in the step Toolbox.

  1. Navigate to [Project Name] > Manage > Integrations > Scripting > Python. Right-click Python and select Add Script Project. Name the project and click SAVE. This action is not available in v9.0 or v9.1.
  2. Right-click on the newly created Python Script Project and select Add Script. A dialog box will appear where you can enter a name for your Custom Python Script and upload your custom `.py` script file under the File field.
  3. In the Inputs field, specify the number of input parameters that your Script will accept. These parameters will be visible when the Script is added as a step in the Decision Flow. After defining your inputs, click SAVE. This Script can now be used as a Flow step.
  4. Create a Flow and navigate to Integration > Python > [ Python Script Project ] > [ Custom Python Script ] (which will now function as a Flow step ). Drag and drop this step to the Flow designer. In the properties panel, you will see each declared input parameter listed as an individual input field.
Note
All input parameters will be of type String.

2. Execute Python Script Step

The Execute Python Script step allows Python Scripts to be executed without the need to create a Python Script Project. However, only parameter values can be passed to the script; the values cannot be defined in the Flow.

InputDescription
Parameter(s)The parameter inputs to the Script.
Script FileSimilar to the File input when configuring a Script as a Flow step, this will be the file containing the Python script. 
Working DirectoryThe input controls the first location used to search for the Python executable, along with being the location custom files will be outputted from the script.


System Level

Scripts can also be created at the System level. After being created, the Script folder can be moved to a specific Project. Right-click the folder and select Manage | Move to Project.


Feature Changes

DescriptionVersionRelease DateDeveloper Task
Added the right click action "Add Script Project" to the Python folder.9.2August 2024[DT-041379]
Script folders now have a delete action.9.6January 2025[DT-042782]
Script folders at the System level can be moved to a Project.9.6January 2025[DT-042781]


For further information on Modules, visit the Decisions Forum.

Was this article helpful?