Script Task

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

• Processes: Edit Processes

• Processes: View Processes

See the Process permissions or ask your Administrator for assistance.

An object name is a human-readable reference for a process object. Process Modeler automatically assigns the name of a Process object with its object type. However, an object's name can be changed.

Follow these steps to edit the name for a Script Task object:

1. Select the Script Task object from the Process model in which to edit its name.

2. Ensure that the Configuration panel displays. If not, show it. The Name setting displays. This is a required setting.

   

3. In the Name setting, edit the selected object's name and then press Enter.

Since Script Task objects are designed to run a Script, specify which Script a selected Script Task object uses. A Script must already exist before it can be selected for use in a Script Task object.

See the following topics for more information:

• What is a Script?

• Script Editor

Ensure to select a Script for each Script Task object in your Process model. If a Script is not specified and Requests are started for that Process, a placeholder Script displays when that Script Task object triggers.

The placeholder Script allows the Request without causing it to pause indefinitely.

This functionality also allows Process Designers to place the basic Process objects into a Process model and then evaluate it during development.

Follow these steps to select a Script for a Script Task object:

1. Select the Script Task object from the Process model in which to specify its Script.

2. Ensure that the Configuration panel displays. If not, show it. Panels to configure this object display.

3. Expand the Configuration panel if it is not presently expanded, and then locate the Script setting.  

   

4. Do one of the following:

   • From the Script drop-down menu, select which Script that Script Task object references. After a Script is selected, the Open Script link displays.

   • Click the Create a new script link. A new browser window opens to create a new Script.  After creating the Script, the Script drop-down menu automatically populates with the created Script. Otherwise, be sure to select the new Script in the Script drop-down menu.

5. Optionally, click the Open Script link to view and/or edit your Script. Note that your user account must have appropriate Script category permissions or be a Project member in which this Script is an asset.

If no Scripts exist, the Script drop-down menu contains no options. Ensure to select and configure a Script for every Script Task object in the Process model before deploying your Process.

After selecting the Script for the Script Task object, optionally provide a JSON object that configures variable values for the selected Script. Providing a JSON script from the Script Task is identical to providing JSON configuration script in the Script Config JSON panel in Scripts Editor for a Script.

See the following topics for more information:

• What is a Script?

• Script Editor, including the Reference a Request Variable from a Script Configuration Setting section

• Example Script Executor Use Case, specifically the Import the Process section how a JSON object is used to configure a Script for a Script Task object

If a JSON script exists in the Script Task object, that script is used for the Script. An existing JSON configuration script displays in the Script Configuration option for a selected Script Task object.

The JSON script in the Script Task object overrides any JSON script entered in the Script Config JSON panel in Scripts Editor for the associated Script.

Follow these steps to enter or edit a JSON configuration script for a Script Task object:

1. Select the Script Task object from the Process model in which to specify its Script.

2. Ensure that the Configuration panel displays. If not, show it. Panels to configure this object display.

3. Expand the Configuration panel if it is not presently expanded, and then locate the Script Configuration option.  

   

4. Select the Script this Script Task object runs.

5. Click the iconbeside the Script Configuration option. The Script Config Editor displays.  

   

6. Enter your JSON configuration script. Use the scroll panel to the right of the Script to scroll to different sections of the Script if necessary. This is useful especially when you are editing a long Script.

7. Click Close or the Close icon.

You can enter your JSON configuration script directly into the Script Configuration option instead of using the Script Config Editor.

The Slideshow Mode makes it easy for process designers to share the design of a process with all stakeholders, regardless of whether they have access to the ProcessMaker Platform. For more information on how to create slideshows for a process, see Slideshow Mode.

Follow these steps to add a placeholder image for the Slideshow Mode:

1. Select the Form Task object from the Process model.

2. Click the icon to view the Configuration panel.

3. From the Placeholder for Slideshow section, click on the +Drag or click here button to upload an image.

   

4. A preview of the image will display, and the configuration will be auto-saved.

   

5. The uploaded image will be shown for this task the next time the slideshow is viewed.

Notes:

• Size of a placeholder image for slideshows must less than 2 MB.

• Image files with PNG, JPG, JPEG, and GIF extensions are supported.

Select the No Loop Mode option to perform this object's Task only once.

Follow these steps to specify characteristics to perform multiple instances of the Task:‌

1. Select the Task from the Process model. Panels to configure this object display.

2. Expand the Loop Activity panel. By default, the Loop Mode setting is set to No Loop Mode and the function is performed only once.

   

Select the Loop option to sequentially repeat this Task's function multiple times until an exit condition is True. This is useful when a function should be performed multiple times with the same set of data, such as, processing a credit card payment. This loop mode has the following characteristics:

• The Task's function is repeated until the exit condition is True or the maximum iterations limit is reached.

• At any given time, only one instance of the Task is active. The subsequent instance does not begin until the current instance completes.

• The same exit condition evaluates at the end of each instance; however, value(s) of the Request variable(s) used in the exit condition can change during an instance resulting in the exit condition to eventually evaluate as True.

• If any one instance of that function does not complete, workflow pauses.

• All active instances are terminated if an interrupting boundary-type event object triggers. An object configured in this mode shows the Loop icon in Process Modeler.

Follow these steps to specify characteristics to perform multiple instances of the Task:‌

1. Select the Task from the Process model in which to specify multiple instance characteristics. Panels to configure this object display.

2. Expand the Loop Activity panel to display the Loop Mode Setting.

3. From the Loop Mode setting, select the Loop option. The settings for this loop mode display:

   

4. In the Maximum Iterations setting, enter an integer value representing the maximum number of times this Task should be performed.

5. In the Exit Condition setting, enter a condition in FEEL syntax. When this condition is True the loop activity is halted.

Select the Multi-instance (Parallel) option to perform this Task's Task multiple times in parallel a fixed number of times. This is useful when performing any action in bulk, such as sending an email to several people. This loop mode has the following characteristics:

• Instances of the Task are governed by the size of an array-type Request variable where a new instance is created for each item in this variable. For example, an array with 10 items will create 10 parallel instances of this function that each contains data from its respective array index.

• All instances begin simultaneously when this Task triggers; however, they perform their function independently of each other.

• The function as a whole completes when all instances are complete.

• The output from each instance can either be saved in the source Request variable or a new array-type Request variable.

• All active instances terminate if an interrupting boundary-type event object triggers.

• A Task configured in this mode shows the Multi-instance (Parallel) icon in Process Modeler.

Follow these steps to specify characteristics to perform multiple instances of the Task:‌

1. Select the Task from the Process model in which to specify multiple instance characteristics. Panels to configure this object display.

2. Expand the Loop Activity panel to display the Loop Mode Setting.

3. From the Loop Mode setting, select the Multi-instance (Parallel) option. The settings for this loop mode display:

   

4. In the Request Variable Array setting, enter the name of an array-type Request variable. The size of this array will determine how many times this loop iterates.

5. In the Output Data Variable setting, enter the name of an array-type Request variable in which to store the results of all instances. Each instance of the loop saves to a separate JSON object within the array of the specified Request variable. If the Output Data Variable setting is not configured, then the output data replaces the source data in the Request Variable Array.

Select the Multi-instance (Sequential) option to perform this Task's function multiple times sequentially a fixed number of times or until an exit condition is True. This is useful when sequentially repeating a function multiple times but with a different set of data each time. This loop mode has the following characteristics:

• Instances of the function are governed by the size an array-type Request variable where a new instance is created for each item in this variable. For example, an array with 10 items will create 10 parallel instances of this function that each contains data from its respect array index.

• At any given time, only one instance of the function is active. The subsequent instance does not begin until the current instance completes.

• At the end of each instance an exit condition evaluates and the loop activity halts if the exit condition is True.

• The function as a whole completes when all instances are complete.

• The output from each instance can either be saved in the source Request variable or a new array-type Request variable.

• All active instances terminate if an interrupting boundary-type event object triggers.

• A Task configured in this mode shows the Multi-instance (Sequential) iconin Process Modeler.

Follow these steps to specify characteristics to perform multiple instances of the Task:‌

1. Select the Task from the Process model in which to specify multiple instance characteristics. Panels to configure this object display.

2. Expand the Loop Activity panel to display the Loop Mode Setting.

3. From the Loop Mode setting, select the Multi-instance (Sequential) option. The settings for this loop mode display:

   

4. In the Request Variable Array setting, enter the name of an array-type Request variable. The size of this array will determine how many times this loop iterates.

5. In the Exit Condition setting, enter a condition in FEEL syntax. When this condition is True the loop activity is halted.

6. In the Output Data Variable setting, enter the name of an array-type Request variable in which to store the results of all instances. Each instance of the loop saves to a separate JSON object within the array of the specified Request variable. If the Output Data Variable setting is not configured, then the output data replaces the source data in the Request Variable Array.

Follow these steps to edit the description for an object:

1. Select the object from the Process model in which to edit its description.

2. Ensure that the Configuration panel displays. If not, show it. Panels to configure this object display.

3. Expand the Documentation panel if it is not presently expanded. The Description setting displays.

4. In the Description setting, edit the information to display when viewing documentation for this object and then press Enter. Alternatively, use the What-You-See-Is-What-You-Get (WYSIWYG) rich text editor to stylize your text by clicking the More icon.

   

   Follow these guidelines to use the WYSIWYG rich text editor to stylize your text:

   • Undo changes: Click on theicon to undo the last action.

   • Redo changes: Click on theicon to redo the last undone action.

   • Insert/Edit Link: Click on theicon to convert the selected text into a hyperlink. Follow these steps to create a hyperlink:

     1. Select the required text from the Rich Text control.

     2. Click on theicon. The Insert/Edit Link screen displays.  

     3. In the URL setting, enter the destination URL.

     4. In the Text to display setting, edit or enter the text displayed in the Rich Text control.

     5. In the Title setting, enter the text to display when a user hovers over the displayed text.

     6. From Open link in… drop-down menu, select one of these options:

        • New window: Select this option to open the destination page in a new browser window.

        • Current window: Select this option to open the destination page in the current browser window.

   • Insert/Edit Image: Click on the Insert/Edit Image iconto insert an image. Follow these guidelines:

     1. Click on the Insert/Edit Image icon.

     2. The Insert/Edit Image screen displays:  

     3. In the Source setting, enter a URL for the image.

     4. In the Alternative Description setting, enter the text to display if the source URL of the image is not accessible.

     5. In the Width setting, enter the maximum width for the image.

     6. In the Height setting, enter the maximum height for the image.

     7. Toggle the Constrain Proportions iconto maintain the width-height ratio of the image to its original proportion.

     8. Click Save.

   • Insert Page Break for PDF: Click on the Insert Page Break for PDF iconto insert a page break when a PDF document is created for this documentation if your browser supports this feature.

   • Format text: Follow these guidelines to format text:

     • Headings: From the Paragraph/Formats menu, select Headings and then select a heading size.

     • Bold: Do one of the following:

       • From the editor toolbar, select theicon.

       • From the Paragraph/Formats menu, select Inline and then Bold.

     • Italics: Do one of the following:

       • From the editor toolbar, select theicon.

       • From the Paragraph/Formats menu, select Inline and then Italic.

     • Underline: From the Paragraph/Formats menu, select Inline and then Underline.

     • Strikethrough: From the Paragraph/Formats menu, select Inline and then Strikethrough.

     • Superscript: From the Paragraph/ Formats menu, select Inline and then Superscript.

     • Subscript: From the Paragraph/Formats menu, select Inline and then Subscript.

     • Code: From the Paragraph/Formats menu, select Inline and then Code.

     • Paragraph: From the Paragraph/Formats menu, select Blocks and then Paragraph.

     • Blockquote: From the Paragraph/Formats menu, select Blocks and then Blockquote.

     • Division: From the Paragraph/Formats menu, select Blocks and then Div.

     • Preformatted:  From the Paragraph/Formats menu, select Blocks and then Pre.

     • Change text color: Use the Text Color drop-down to change text color. Click on theicon. The color palette displays. Do one of the following:

       • Select one of the color swatches from the color palette. The selected text changes to that color.

         • Click theicon to select a custom color from the Color Picker.

         • Click theicon to reset the text to its default color.

     • Align text: Follow these guidelines to align text:

       • Left align: Do one of the following:

         • From the editor toolbar, use theicon to left-align text.

         • From the Paragraph/Formats menu, select Align and then Left.

       • Center align: Do one of the following:

         • From the editor toolbar, use theicon to center-align text.

         • From the Paragraph/Formats menu, select Align and then Center.

       • Right align: Do one of the following:

         • From the editor toolbar, use theicon to right-align text.

         • From the Paragraph/Formats menu, select Align and then Right.

       • Justify: Do one of the following:

         • From the editor toolbar, use theicon to justify text.

         • From the Paragraph/Formats menu, select Align and then Justify.

     • Insert a bullet list: Use theicon to format text as a bulleted list.

     • Insert a numbered list:  Use theicon to format text as a numbered list.

     • Indent text: Click on theicon to increase text indenting.

     • Outdent text: Click on theicon to decrease text indenting.

Follow these guidelines to set how to handle Script Task runtime errors:

• Set how many seconds to wait when an unexpected error occurs during runtime before displaying the error in that Script Task, thereby causing that Request to be in Error status.

• Set how many consecutive attempts to run the Script Task before displaying a runtime error.

Requests are going to wait the configured number of seconds and consecutive runtime attempts for an unresponsive Script Task before displaying the error.

Optionally, notify the Process Manager of the Script Task runtime error via an in-platform or email notification.

Follow these steps to edit the Error Handling settings:

1. Select the Script Task object from the Process model in which to edit the Error Handling.

2. Ensure that the Configuration panel displays. If not, show it. Panels to configure this object display.

3. Expand the Error Handling panel if it is not presently expanded. The Timeout setting displays.

4. In the Timeout setting, configure how many seconds to wait for an unresponsive Script Task before declaring a time-out as follows:

   • Enter the number of seconds. Use the up and down arrows to increase or decrease seconds.

   • Set 0 for no timeout.

   • Leave empty to use the Script Task default setting.

5. In the Retry Attempts setting, configure how many times to re-run the Script Task if the Script Task returns a runtime error as follows:

   • Enter a number. Use the up and down arrows to increase or decrease the number.

   • Set 0 for no retry attempts.

   • Leave empty to use the Script Task default setting.

6. In the Retry Wait Time setting, configure how many seconds to wait before attempting a retry as follows:

   • Enter the number of seconds. Use the up and down arrows to increase or decrease seconds.

   • Set 0 for no timeout.

   • Leave empty to use the Script Task default setting.

7. Enable the In-app Notification toggle to notify through the user interface to the Process Manager that there is a Script Task runtime error.

8. Enable the Email Notification toggle to notify through an email to the Process Manager that there is a Script Task runtime error.

Follow these steps to assign Vocabularies that validate Request data from a Script Task object:

1. Select the Script Task object from the Process model in which to assign Vocabularies that validate Request data prior to when this object completes.

2. Ensure that the Configuration panel displays. If not, show it. Panels to configure this object display.

3. Expand the Vocabularies panel if it is not presently expanded. The Assigned setting displays.

4. Click theicon to add a Vocabulary. The Assign Vocabulary setting displays.

5. From the Select Vocabulary drop-down menu, select a Vocabulary from which to validate Request data complies with its JSON schema.

   If no Vocabularies are configured, then the following message displays: List is empty. Create at least one Vocabulary. See Create a New Vocabulary.

6. Click Save.

7. Repeat Steps 3 through 6 as necessary for each Vocabulary required to validate Request data complies with its JSON schema.

Click the Remove iconfrom the Vocabularies setting to remove a Vocabulary from assignment to this object.

After one or more Vocabularies are assigned to a Script Task object, the Vocabulary icon displays in that object.

Process Modeler automatically assigns a unique value to each Process node added to a Process model. However, a node's identifier value can be changed if it is unique to all other nodes in the Process model, including the Process model's identifier value.

All identifier values for all nodes in the Process model must be unique.

Follow these steps to edit the identifier value for a Script Task object:

1. Select the Script Task object from the Process model in which to edit its identifier value.

2. Ensure that the Configuration panel displays. If not, show it. Panels to configure this object display.

3. Expand the Advanced panel if it is not presently expanded. The Node Identifier setting displays. This is a required setting.  

   

4. In the Node Identifier setting, edit the Script Task object's identifier to a unique value from all nodes in the Process model and then press Enter.