Create a New Script

Create a new Script to automate or add functionality to any Process.

Create a New Script

Follow these steps to create a new Script:

1. View your Scripts. The Scripts page displays.

2. Click the +Script button. The Create Script screen displays.  

   

3. From the Choose an Executor section, select a programming language to use for creating your script. Your Administrator may have created custom Script Executors using ProcessMaker Platform-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). To know more about the available executors, see What is a Script Executor?. This setting is required.

4. In the Name setting, enter the name of the Script. Script names must be unique and can only use apostrophe characters (') and spaces. This is a required setting.

5. In the Description setting, enter the description of the Script. This is a required setting.

6. From the Project drop-down menu, optionally select the Project(s) for this script. This setting only displays Projects of which you are a member. To remove a Project that is currently selected, click the icon for that selection or press Enter when the drop-down is visible.

7. From the Category drop-down menu, select one or more Script Categories to associate with this 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.

8. At the bottom right, click the Advanced Options link. Advanced options display.

   

   Click the Less Options link to hide advanced options.

9. From the Run Script As drop-down menu, select which user's API client token to use with our REST API. Ensure that the selected user's account has the appropriate API permissions to access our REST API. By default Administrator user is selected. This is a required setting.

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

11. In the Retry Attempts setting, configure how many times to re-run the Script if the Script fails. Enter 0 for no retry attempts.

12. In the Retry Wait Time setting, configure how many seconds to wait before attempting a retry . Enter 0 for no wait time.

13. Click Save. Script Editor displays so you can develop your Script. See Script Editor.