Skip to content

Execute Script Rule

The Execute Script rule allows you to run a script that has been written in the BizzStream script editor.

By default, scripts run synchronously, meaning BizzStream will wait for the script to finish before moving on to the next rule in the action. A script has a maximum execution time of 3 minutes per document; exceeding this limit will result in a 'Script timed out' error in the logs.

How to Add and Configure the Execute Script Rule

  1. Open the desired action in the workflow.
  2. Navigate to the Rules section and click the button.
  3. In the rule configuration pane, select Execute Script from the Type dropdown.
  4. Enter a descriptive Label and Description.
  5. Configure the properties as outlined in the table below.
  6. Click Save to confirm the rule configuration.
  7. Click Save in the action properties pane to finalize the changes.

Rule Properties

Field Required Purpose
Script Yes Select a script that has been created and saved in the script editor.
Execute Asynchronously No If enabled, the script will run in the background. BizzStream will not wait for the result and will immediately proceed to the next rule in the user action.

Asynchronous Execution

Enabling Execute Asynchronously can improve user performance, but it's important to be aware of the following limitations:

  • Notifications and Go to URL statements cannot be used within the script.
  • Subsequent rules should not depend on the outcome of the asynchronous script, as the output may not be available in time.
  • The log may not always display console output or a "success" or "error" status. It might show "Script is executing asynchronously."
  • If the asynchronous script updates the document a user is currently editing, a notification may appear asking the user to reload the document.

Note: A log for the Execute Script rule will be created, including an elapsed time field that shows the total processing time of the script.