Actions YAML Reference for BarTender Cloud
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:
...
- ReadFileAction:
...
- WriteMessageToLogAction:
...

Specify an array of actions, such as the following:

- PrintBTWAction:
...
- ReadFileAction:
...
- WriteMessageToLogAction:
...

Print actions

Action Description
PrintBTWAction Prints a BarTender document.
PrintBTXMLScriptAction Prints one or more BarTender documents by using BTXML script.

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.

Input actions

Action Description
ReadFileAction Reads the content of a file on any supported file system.

Output actions

Action Description
SendWebServiceRequestAction Sends an HTTP request to a web service (REST or SOAP).
SendEmailAction Sends an email message.
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.
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.
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.
PrintBTWAction Prints a BarTender document.
PrintBTXMLScriptAction Prints one or more BarTender documents by using BTXML script.

File actions

Action Description
ReadFileAction Reads the content of a file on any supported file system.
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.

All actions

Action Description
AddFilesToArchiveAction Adds one or more files from a folder to an archive.
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.
DeleteFileAction Deletes one or more files.
DeleteFolderAction Deletes a folder.
ExtractFilesFromArchiveAction Extracts one or more files from an archive to a specified folder.
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.
IncrementVariableAction Increments the variable by a specified value.
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.
PrintBTXMLScriptAction Prints one or more BarTender documents by using BTXML script.
PrintBTWAction Prints a BarTender document.
ReadFileAction Reads the content of a file on any supported file system.
RenameFileAction Renames a file.
RenameFolderAction Renames a folder.
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.
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.
StopAction Stops all actions in the current integration.
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.
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.

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.