ProcessMaker API Documentation
Script Central

Configure a Script

Edit the configuration for a ProcessMaker Script.

Configure a ProcessMaker Script

Your ProcessMaker user account or group membership must have the following permissions to configure a ProcessMaker Script unless your user account has the Make this user a Super Admin setting selected:

  • Scripts: Edit Scripts

  • Scripts: View Scripts

See the ProcessMaker Scripts permissions or ask your ProcessMaker Administrator for assistance.

Follow these steps to configure a ProcessMaker Script:

  1. View your ProcessMaker Scripts. The Scripts page displays.

  2. Click the Configure iconfor your ProcessMaker Script. The Edit Configuration page displays.

  3. Edit the following information about the ProcessMaker Script as necessary:

    • In the Name setting, edit the ProcessMaker Script name. This is a required setting.

    • From the Category drop-down menu, select one or more Script Categories to associate with this ProcessMaker Script. In doing so, Script Categories may be sorted from the Scripts page. To remove a Script Category that is currently selected, click the icon for that selection or press Enter when the drop-down is visible. This is a required setting.

    • From the Run script as drop-down menu, select which ProcessMaker user's API client token to use with the ProcessMaker REST API. Ensure that the selected ProcessMaker user's account has the appropriate API permissions to access the ProcessMaker REST API. This is a required setting.

    • From the Script Executor drop-down menu, select which ProcessMaker Script Executor to run this Script. This setting only displays ProcessMaker Script Executors that this Script has been developed using. Your ProcessMaker Administrator may have created custom ProcessMaker Script Executors using ProcessMaker-supported languages to run sanctioned custom third-party code and/or Docker commands that allow Scripts to successfully call third-party Application Program Interfaces (APIs) and Software Development Kits (SDKs). Below are the ProcessMaker Script Executors ProcessMaker provides, though some require packages that are not available in the ProcessMaker open-source edition:

      • csharp - C# Executor: This is the default ProcessMaker Script Executor to run Scripts developed using C#. Note that if the C# package is not installed in your ProcessMaker instance, this ProcessMaker Script Executor is not available.

      • java - Java Executor: This is the default ProcessMaker Script Executor to run Scripts developed using Java. Note that if the Java package is not installed in your ProcessMaker instance, this ProcessMaker Script Executor is not available.

      • javascript - Node Executor: This is the default ProcessMaker Script Executor to run Scripts developed using JavaScript.

      • lua - LUA Executor: This is the default ProcessMaker Script Executor to run Scripts developed using Lua.

      • python - Python Executor: This is the default ProcessMaker Script Executor to run Scripts developed using Python. Note that if the Python package is not installed in your ProcessMaker instance, this ProcessMaker Script Executor is not available.

      • r - R Executor: This is the default ProcessMaker Script Executor to run Scripts developed using R. Note that if the R package is not installed in your ProcessMaker instance, this ProcessMaker Script Executor is not available.

      This is a required setting.

    • In the Description setting, edit the description of the ProcessMaker Script. This is a required setting.

    • In the Timeout setting, use the slider control or enter how many seconds the ProcessMaker Script is allowed to run before it times out. Use 0 to indicate that the ProcessMaker Script never times out. The default timeout is 60 seconds. This setting requires an integer.

  4. Click Save.

Related Topics