Available Actions

Process Builder supports several different kinds of actions to help you create the process files that meet your unique needs.

You can use the Search box on the New Action dialog to find the action that you want to add. To do this, select an action category in the left pane and then enter the action that you want in the Search box. In the list that appears, double-click the action that you want.

ClosedPrint Actions

Select from actions that send a print request to BarTender to print a BarTender document. These actions include options to prompt for data input (with which you can print data to documents by using data entry forms) and to resend any failed print job.

Action

Description

Print BTXML Script

Specifies the BTXML script that is sent to BarTender, which processes the code and completes the tasks that are defined by the code.

Print Document

Directs the Integration Service to print a specific BarTender document each time the process file runs.

ClosedTransform Actions

Select from a wide variety of actions that manipulate data, such as searching and replacing, inserting content, transforming text to a record set, and more. The action can be as simple as renaming a file or as complex as using an XSLT stylesheet to transform XML into BTXML.

Action

Description

Insert After End of Source Text

Opens a specified source and inserts the provided text or characters at the end of the source text.

Insert Before Start of Source Text

Opens a specified source and inserts the provided text or characters at the beginning of the source text.

Search and Delete

Searches for and deletes text or characters in a specified source.

Search and Delete Everything After

Searches for text or characters in a specified source and deletes all the data after the found string.

Search and Delete Everything Before

Searches for text or characters in a specified source and deletes all the data before the found string.

Search and Insert After

Searches for text or characters in a specified source and inserts the provided content directly after it.

Search and Insert Before

Searches for text or characters in a specified source and inserts the provided content directly before it.

Search and Replace

Searches for text or characters in a specified source and replaces it with the provided content.

Transform Text to Record Set

Transforms an identified source of text into a record set for a specified database.

Transform XML using XSLT

Uses an XSLT stylesheet to transform another application's output XML from its original XML format into another XML format. The reformatted XML is then placed into an output variable.

ClosedInput Actions

Use input actions to specify a port, network socket, or file from which to receive data, or simply look for the existence of a file before the next action is processed.

Action

Description

Read File

Monitors a specified folder for a defined file type, reads the data that is contained in that file, and then saves the data to a variable.

Read from Network Socket

Reads from a network socket for incoming data.

Read from Serial Port

Reads from a serial port for incoming data.

Wait for File

Monitors a specified folder for a defined file type. When the file is detected, the action finishes and allows subsequent actions to run.

ClosedOutput Actions

Use output actions to direct Process Builder to send or write data to a specified output channel, such as email or a web service request.

Action

Description

Send Email

Sends an email message to the email accounts that you specify.

Send to Message Queue

Writes a message to the Microsoft Message Queue (MSMQ).

Send to Network Socket

Sends data on a TCP or UDP socket.

Send to Serial Port

Writes data to a serial port.

Send Web Service Request

Sends an HTTP request to a web service (REST or SOAP).

Write File

Writes a data string to a file.

Write Message to Log

Sends information to the message log.

ClosedExecute Actions

Use execute actions to group a subset of actions, send script commands, manipulate database records, and set variables for use by other actions.

Action

Description

BarTender Process

Prints multiple BarTender documents in a Process Builder process file or a legacy Batch Maker batch file.

Decrement Variable

Specifies a variable whose value you want to be decremented each time the action is run.

For Each Database Record

Runs a database query and actions for each record.

For Each File in Archive

Runs a group of one or more actions on every file in an archive folder that matches the specified criteria.

For Each File in Folder

Runs a group of one or more actions on every file in a folder that matches the specified criteria.

For Loop

Specifies that a group of one or more actions continues to run sequentially until a specified value is reached by either incrementing or decrementing an assigned variable value with each loop iteration.

Go To

Jumps to a specified action to continue the run operation.

Group

Specifies a subgroup of actions for a process. The actions in the group can be run repeatedly in sequence or in parallel.

Increment Variable

Specifies a variable whose value you want to be incremented each time the action is run.

Power Shell Command

Runs a Windows PowerShell command.

Print BTXML Script

Sends BTXML script to BarTender to process the code and complete the tasks that the code defines.

Print Document

Directs the Integration Service to print a specific BarTender document each time the process file runs.

Select Case

Creates one or more Case sub-actions and a single Default action, and specifies a variable that is evaluated to determine which of those actions to run.

Set Multiple Variables

Sets the values of one or more variables.

Set Variable

Sets the value of a single variable.

Shell Command

Runs a shell command that can be used to run operating system commands or third-party utilities.

Stop

Stops all actions for the process in which it is running.

Wait

Specifies a time period that elapses before the action finishes. You can use this action to create a pause in sequential actions.

Wait for File

Monitors a specified folder for a defined file type. When the file is detected, the action finishes and enables subsequent actions to run.

While Loop

Specifies that a group of one or more actions continues to run sequentially as long as the specified condition continues to be satisfied.

Workflow Transition

Causes a Librarian file that is assigned to a workflow to transition from one workflow state to another.

ClosedFile Actions

Use file actions to manipulate files or folders in supported file systems and locations. File systems or locations can include a path that is relative to the folder that contains the process file, a temporary storage folder, local file systems or network shares, Librarian, or a supported cloud storage location. For more information about supported cloud storage locations, refer to the Administration Console Cloud Storage Page.

Action

Description

Add Files to Archive

Adds one or more files from a folder to an archive.

Copy File

Copies a file from one location to another.

Copy Folder

Copies a folder.

Create Folder

Creates a folder.

Delete File

Deletes a file.

Delete Folder

Deletes a folder.

Extract Files from Archive

Extracts one or more files from an archive to a folder.

For Each File in Archive

Runs a group of one or more actions on every file in an archive folder that matches the specified criteria.

For Each File in Folder

Runs a group of one or more actions on every file in a folder that matches the specified criteria.

Move File

Moves a file from one location to another.

Move Folder

Moves a folder.

Read File

Monitors a specified folder for a defined file type, reads the data that is contained in that file, and then saves the data to a variable.

Rename File

Renames a file.

Rename Folder

Renames a folder.

Workflow Transition

Causes a Librarian file that is assigned to a workflow to transition from one workflow state to another.

Write File

Writes a data string to a file.

ClosedDatabase Actions

Use database actions to perform actions on a record set or create a record set from a text file.

Action

Description

Delete Database Record

Deletes one or more records from a connected database.

Execute SQL

Runs any kind of custom Structured Query Language (SQL) script.

For Each Database Record

Runs a database query and actions for each record.

Insert Database Record

Inserts a new record into a connected database.

Transform Text to Record Set

Transforms an identified source of text into a record set for a specified database.

Update Database Records

Updates one or more records in a connected database.