Workflow scripts allow you perform actions programmatically on one or multiple objects within RED. For example, you can create a workflow script that exports the DDL for one or multiple objects or for performing GIT operations like Check-in or Check-out on a set of objects. You can launch scripts from the context menu of one or multiple selected objects.
Note
The Worflow context menu only shows when you have created a Workflow Host Script.
Adding a Workflow script
This section provides examples on how to create Workflow scripts.
Before Creating a Workflow, you first need to add a Workflow host script language type. For instructions on adding a new language type refer to Adding a Host Script Language Type.
Export the context of an object
This example shows how to export the context of an object as a JSON structured file.
Adding the script
- Create a language type called ps workflow, set the file extension to ps1, set the command to PowerShell -ExecutionPolicy Bypass -File "$SCRIPT_NAME$" and assign it a Workflow category.
- Add a new Metadata Object Type called Print Context and set the type to Host Script.
- In the configuration window, set the type to ps workflow script, set the appropriate Owner and Connection Name for your data.
- The new script should appear on the Host Script node.
- Right click on Print Context and select Edit the Script. This will open the script on a new tab.
- On the edit script tab enter the following code:
Running the Script
To run the script, right click on an object, go to Workflows, and select Print Context.
Verify the script ran successfully.
To check the output files, go the temp folder