Actions YAML Reference
Actions YAML Format

How to compile an ActionGroup or an array that has a list of actions

Specify an ActionGroup object, such as the following:

ActionGroup:
Name: MyActionGroup
Description: A group of actions to run immediately.
Actions:
- PrintBTWAction:
...
- SendNetworkSocketAction:
...
- WriteMessageToLogAction:
...

Specify an array of actions, such as the following:

- PrintBTWAction:
...
- SendNetworkSocketAction:
...
- WriteMessageToLogAction:
...

Print actions

Action Description
PrintBTWAction Prints a BarTender document.
PrintBTXMLScriptAction Prints one or more BarTender documents by using BTXML script.
PrintCommandScriptAction Prints a BarTender document by using a combination of command lines and data.

Transform actions

Action Description
SearchAndReplaceAction Searches for specific text or characters in the contents and replaces it with the specified text.
SearchAndInsertBeforeAction Searches for specific text or characters in the contents and inserts it before the specified text.
SearchAndInsertAfterAction Searches for specific text or characters in the contents and inserts it after the specified text.
SearchAndDeleteAction Searches for specific text or characters in the contents and deletes it.
SearchAndDeleteEverythingBeforeAction Searches for specific text or characters in the contents and deletes everything before it.
SearchAndDeleteEverythingAfterAction Searches for specific text or characters in the contents and deletes everything after it.
InsertBeforeStartAction Inserts specific text or characters before the contents starts.
InsertAfterEndAction Inserts specific text or characters at the end of the contents.
TransformXMLUsingXSLTAction Transforms a custom or proprietary XML format by using an XSLT stylesheet.
OraclePrintRequestToBTXMLAction Transforms an incoming Oracle XML request to BTXML script.
SAPAIIToBTXMLAction Transforms the incoming SAP AII XML to BTXML script.
BTXMLPrintResponseToIBMWebSphereAction Transforms the BTXML script response that was received from the last BarTender command that was run to IBM WebSphere Sensor Events.
IBMWebSphereToBTXMLAction Transforms incoming IBM WebSphere Sensor Events to BTXML script.
IBMWebSphereToBTXMLWithPrintStatusAction Transforms incoming IBM WebSphere Sensor Events to BTXML script that contains the print status.

Input actions

Action Description
ReadFromNetworkSocketAction Reads from a TCP or UDP socket for incoming data.
ReadFromSerialPortAction Reads from a serial port for incoming data.
ReadFileAction Reads the content of a file on any supported file system, including FTP, web, and cloud storage.
WaitForFileAction Waits for a file to appear in a specified folder before running subsequent actions.

Output actions

Action Description
SendWebServiceRequestAction Sends an HTTP request to a web service (REST or SOAP).
SendEmailAction Sends an email message.
SendToNetworkSocketAction Sends data over a TCP or UDP socket.
SendToSerialPortAction Writes information to a serial port.
SendToMessageQueueAction Sends a message to the Microsoft Message Queuing (MSMQ) service.
WriteFileAction Writes content to a file.
WriteMessageToLogAction Sends information to the message log.

Execute actions

Action Description
ActionGroup / GroupActions Manages and runs a group of actions.
WhileLoopActions Continues to run the actions in the group as long as the condition is satisfied.
ForLoopActions Runs the actions in the group for the specified loop by incrementing or decrementing the variable.
ForEachFileInFolderActions Runs a group of one or more actions for all files in a folder that match a specified filter.
ForEachFileInArchiveActions Runs a group of one or more actions for all files in an archive folder that match a specified filter.
RunAsUserActions Runs a group of actions by using the credentials that are specified.
ConditionActions Runs either actions for true or actions for false based on the result of the condition.
SelectCaseAction Evaluates which Case subactions to run, according to their specified conditions.
GoToAction Jumps to a specific action to continue processing.
StopAction Stops all actions in the current integration.
ShellCommandAction Runs a shell command that can be used to run operating system commands or third-party utilities.
PowerShellCommandAction Runs a Windows PowerShell command (script).
SetVariableAction Sets the value of one variable.
SetMultipleVariablesAction Sets the value of one or more variables.
IncrementVariableAction Increments the variable by a specified value.
DecrementVariableAction Decrements the variable by a specified value each time the action is run.
WaitAction Specifies a time period that elapses before the action finishes. You can use this action to create a pause in sequential actions.
WaitForFileAction Waits for a file to appear in a specified folder before running subsequent actions.
PrintBTWAction Prints a BarTender document.
PrintBTXMLScriptAction Prints one or more BarTender documents by using BTXML script.
BarTenderProcessAction Runs a process file that was created in BarTender Process Builder.
PrintCommandScriptAction Prints a BarTender document by using a combination of command lines and data.
BarTenderCommandLineAction Prints a BarTender document by using the command-line interface.
WorkflowTransitionAction Move the librarian file from one state to another in its workflow by the specified transition.

File actions

Action Description
ReadFileAction Reads the content of a file on any supported file system, including FTP, web, and cloud storage.
WriteFileAction Writes content to a file.
CopyFileAction Copies one or more files from one location to another.
MoveFileAction Moves one or more files from one location to another.
RenameFileAction Renames a file.
DeleteFileAction Deletes one or more files.
ForEachFileInFolderActions Runs a group of one or more actions for all files in a folder that match a specified filter.
CreateFolderAction Creates a folder.
CopyFolderAction Copies a folder to another folder location.
MoveFolderAction Moves a folder from one location to another.
RenameFolderAction Renames a folder.
DeleteFolderAction Deletes a folder.
ForEachFileInArchiveActions Runs a group of one or more actions for all files in an archive folder that match a specified filter.
AddFilesToArchiveAction Adds one or more files from a folder to an archive.
ExtractFilesFromArchiveAction Extracts one or more files from an archive to a specified folder.
WorkflowTransitionAction Move the librarian file from one state to another in its workflow by the specified transition.

Database actions

Action Description
ForEachDatabaseRecordActions Runs actions for each record in a database query.
TransformTextToRecordSetAction Transforms text or a text file to a record set.
InsertDatabaseRecordAction Inserts a database record into a connected database.
UpdateDatabaseRecordsAction Updates one or more database records.
DeleteDatabaseRecordAction Deletes one or more records from a connected database.
ExecuteSQLAction Runs an SQL script.

All actions

Action Description
AddFilesToArchiveAction Adds one or more files from a folder to an archive.
BarTenderCommandLineAction Prints a BarTender document by using the command-line interface.
BarTenderProcessAction Runs a process file that was created in BarTender Process Builder.
BTXMLPrintResponseToIBMWebSphereAction Transforms the BTXML script response that was received from the last BarTender command that was run to IBM WebSphere Sensor Events.
CaseActions Defines the Case action group and runs the group of actions when the case condition is met.
For more information, see ActionGroup and SelectCaseAction.
CopyFileAction Copies one or more files from one location to another.
CopyFolderAction Copies a folder to another folder location.
CreateFolderAction Creates a folder.
DecrementVariableAction Decrements the variable by a specified value each time the action is run.
DeleteDatabaseRecordAction Deletes one or more records from a connected database.
DeleteFileAction Deletes one or more files.
DeleteFolderAction Deletes a folder.
ExecuteSQLAction Runs an SQL script.
ExtractFilesFromArchiveAction Extracts one or more files from an archive to a specified folder.
ForEachDatabaseRecordActions Runs actions for each record in a database query.
ForEachFileInArchiveActions Runs a group of one or more actions for all files in an archive folder that match a specified filter.
ForEachFileInFolderActions Runs a group of one or more actions for all files in a folder that match a specified filter.
ForLoopActions Runs the actions in the group for the specified loop by incrementing or decrementing the variable.
GoToAction Jumps to a specific action to continue processing.
ActionGroup / GroupActions Manages and runs a group of actions.
IBMWebSphereToBTXMLAction Transforms incoming IBM WebSphere Sensor Events to BTXML script.
IBMWebSphereToBTXMLWithPrintStatusAction Transforms incoming IBM WebSphere Sensor Events to BTXML script that contains the print status.
IncrementVariableAction Increments the variable by a specified value.
InsertDatabaseRecordAction Inserts a database record into a connected database.
InsertAfterEndAction Inserts specific text or characters at the end of the contents.
InsertBeforeStartAction Inserts specific text or characters before the contents starts.
MoveFileAction Moves one or more files from one location to another.
MoveFolderAction Moves a folder from one location to another.
OraclePrintRequestToBTXMLAction Transforms an incoming Oracle XML requests to BTXML script.
PowerShellCommandAction Runs a Windows PowerShell command (script).
PrintBTXMLScriptAction Prints one or more BarTender documents by using BTXML script.
PrintCommandScriptAction Prints a BarTender document by using a combination of command lines and data.
PrintBTWAction Prints a BarTender document.
ReadFileAction Reads the content of a file on any supported file system, including FTP, web, and cloud storage.
ReadFromNetworkSocketAction Reads from a TCP or UDP socket for incoming data.
ReadFromSerialPortAction Reads from a serial port for incoming data.
RenameFileAction Renames a file.
RenameFolderAction Renames a folder.
RunAsUserActions Runs a group of actions by using the credentials that are specified.
SAPAIIToBTXMLAction Transforms the incoming SAP AII XML to BTXML script.
SearchAndDeleteAction Searches for specific text or characters in the contents and deletes it.
SearchAndDeleteEverythingAfterAction Searches for specific text or characters in the contents and deletes everything after it.
SearchAndDeleteEverythingBeforeAction Searches for specific text or characters in the contents and deletes everything before it.
SearchAndInsertAfterAction Searches for specific text or characters in the contents and inserts it after the specified test.
SearchAndInsertBeforeAction Searches for specific text or characters in the contents and inserts it before the specified test.
SearchAndReplaceAction Searches for specific text or characters in the contents and replaces it with the specified text.
ConditionActions Runs either actions for true or actions for false based on the result of the condition.
SelectCaseAction Evaluates which Case subactions to run, according to their specified conditions.
SendEmailAction Sends an email message.
SendToMessageQueueAction Sends a message to the Microsoft Message Queuing (MSMQ) service.
SendToNetworkSocketAction Sends data over a TCP or UDP socket.
SendToSerialPortAction Writes information to a serial port.
SendWebServiceRequestAction Sends an HTTP request to a web service (REST or SOAP).
SetMultipleVariablesAction Sets the value of one or more variables.
SetVariableAction Sets the value of one variable.
ShellCommandAction Runs a shell command that can be used to run operating system commands or third-party utilities.
StopAction Stops all actions in the current integration.
TransformTextToRecordSetAction Transforms text or a text file to a record set.
TransformXMLUsingXSLTAction Transforms a custom or proprietary XML format by using an XSLT stylesheet.
WaitAction Specifies a time period that elapses before the action finishes. You can use this action to create a pause in sequential actions.
UpdateDatabaseRecordsAction Updates one or more database records.
WaitForFileAction Waits for a file to appear in a specified folder before running subsequent actions.
WhileLoopActions Continues to run the actions in the group as long as the condition is satisfied.
WriteFileAction Writes content to a file.
WriteMessageToLogAction Sends information to the message log.
WorkflowTransitionAction Move the librarian file from one state to another in its workflow by the specified transition.

Common components

Component Description
DataTarget Specifies the source or target of data. The source can be a variable, a template that contains variables, or an external file.
FileTarget Specifies the file system and path of the target file.
FolderTarget Specifies the file system and path of the target folder.
ActionTextEncoding Specifies the encoding scheme that is used in various IntegrationActions properties.