Chapter 8 Using Scripts

This chapter describes how to use the scripts available in Process Builder. It also briefly discusses creating your own scripts.

• Overview of Scripts
• Predefined Scripts
• Creating Scripts
• Using Client-side Scripts

Table 8.1 Available JavaScript scripts

Kind of Script	Purpose	Return Value
Assignment	Assigns a user or users to perform a work item.	Returns an array containing the distinguished names (DNs) of the users to whom this work item is assigned.
Automation	Performs an automated activity. It is executed when the process reaches the automated activity.	Returns true if the activity is successful, otherwise returns false.
Completion	Executes when a work item is completed.	Returns true if the activity is successful, otherwise returns false.
Expiration Setter	Sets the expiration date of a work item.	Returns a Date object.
Expiration Handler	Runs when a task has not been completed before its expiration date is reached.	Returns true if the expiration is successfully handled, otherwise false.
Email Address in Notification	Specifies an email address to which a notification will be sent, either in the To: line or Cc: line.	Returns a valid email address, or a comma-delimited list of valid email addresses. Values can be passed as a string or as a JavaScript array.
Email Subject in Notification	Specifies the subject of an email message.	Returns a string specifying the subject of the email message.
Email Body in Notification	Specifies the body content of an email message.	Returns a string specifying the body of the email message.
Decision point or automation script condition	Specifies a condition that is used to determine which path to follow in the process.	Returns true if the condition is met otherwise false
Initialization script	Specifies tasks to perform when the application first starts.	Returns true if the initialization is successful, otherwise false
Shutdown script	Specifies tasks to perform when the application shuts down.	Returns true if the shutdown is successful, otherwise false
Toolkit script	A library function. It can be called by other functions or used as the value of any script for which it returns the appropriate kind of value.	Returns whatever is appropriate.

• Assignment Scripts
• Completion Scripts
• Email Notification Scripts
• Initialization and Shutdown Scripts

• defaultNotificationHeader()
• defaultNotificationSubject()
• emailByDN(DN)
• emailById(userId)
• emailOfAssignees()
• emailOfCreator()
• emailOfRole(role)

1. From the Insert menu, choose Script. The Create a New Script dialog box appears, as shown in Figure 8.1.
2. Name the script. The name must contain only alphanumeric characters.
3. Choose the type of script you want to create:

• Assignment Script
• Automation Script
• Expiration Setter Script
• Expiration Handler Script (also known as an Expire script or an On Expire script)
• Completion Script
• Toolkit Script

Figure 8.1    The Create a New Script dialog box



4. Click a radio button to choose how you want to create the script.

• "Create from a blank window" lets you type your script into a blank window, without basing it on an existing script. If you choose this radio button, go to Step 5.
• "Create from a template function" lets you base your script on another script of the same type which you have previously designated as a template. If you choose this radio button, choose a template from the drop-down list, and go to Step 5.
• "Create from an imported file" lets you import an existing script from outside the application, or copy one from within the application. If you choose a script from outside the application, you can save the script with the same name. If you choose a script from the current application, you must give the script a unique name. Click Browse to navigate to the .js file you want, and then click Open. Then go to Step 5.
5. Click Create. Your new script appears in the Script Editor Window.

The Script Editor Window
The script editor window appears when you are creating a new script or editing an existing script. If you are creating a new script from a blank window, the script editor appears with comments in the window pertaining to the type of script you are creating.

OK. Saves changes to the script and closes the window.

Revert. Rolls back any changes you've made since the last time you saved the script. The window remains open.

Close. Closes the window without saving changes.

Help. Launches a web page containing help about this script.

Goto. Lets you specify a line number to go to in the script.

Find. Lets you specify a text string to search for in the script.

Check Syntax. Checks the syntax of the script you've created, and displays an error message if there is an error.

1. In the application tree view, right click on the script name.
2. From the menu, choose "Set as template".

• Embedded client-side scripts. These are attached by using Process Builder's Insert menu, then the HTML element submenu, and then choosing the Client JavaScript menu command.
• Event handlers for form elements. Event handlers include scripts such as onValueChange and onClick.

var budget = document.forms[0].budget.value;

Every data field represented on a form has an associated form element of the same name. For example, if the AuthorName field is represented on the form, then the form contains a form element whose name is AuthorName. In some cases, this form element is hidden, but in all cases, such a form element exists.

var budget = document.forms[0].budget.value;

var amountSpent = document.forms[0].amountSpent.value;

var amountLeft = budget - amountSpent;

document.write("<B><FONT COLOR='#CC55BB'> $" + amountLeft + " </FONT></B> ");

Figure 8.3 shows the definition of this embedded script in Process Builder, and Figure 8.4 shows the results of this embedded script in Process Express.