Skip to main content

Workflow

Description

Workflow executes a previously defined workflow from within the current process. Use this process entry to run data transformation and processing logic — workflows handle row-level data operations like reading, transforming, and writing data, while the parent process orchestrates the sequence with activities such as checking conditions, managing files, and sending notifications. A single process can contain multiple Workflow entries to chain different data operations together.

Configurations

Field NameDescription
Workflow Specification Tab
Name of Process EntrySpecify a unique name for the process entry, on the workspace area. A process entry can be placed on the canvas several times; and each instance of the entry must have a unique name.
Workflow FilenameSpecify your workflow filename by entering in its path or clicking Browse.If you select a workflow that has the same root path as the current workflow, the variable ${Internal.Entry.Current.Directory} will automatically be inserted in place of the common root path.For example, if the current workflow ‘s path is /home/admin/ workflow.psw and you select a workflow in the folder /home/admin/path/sub.psw then the path will automatically be converted to ${Internal.Entry.Current.Directory}/path/sub. psw.
Specify by Name and DirectoryIf you are working in the PS Repository, (or database repository) specify the name of the workflow to start. Click the Browse In processes button to browse through the repository. This feature is currently not available.
Specify by ReferenceIf you specify a workflow or process by reference, you can rename or move it around in the repository. The reference (identifier) is stored, not the name and directory. This is enabled when working with the PS or database repository. This feature is currently not available.
Advanced tab:
Copy previous results to argsThe results from a previous workflow can copied as arguments of the workflow using the "Copy rows to result" step. If Execute for every input row is enabled then each row is a set of command line arguments to be passed into the workflow, otherwise only the first row is used to generate the command line arguments.
Copy previous results to parametersThe results from a previous workflow can copied as parameters of the workflow using the "Copy rows to result" step.
Execute for every input rowAllows a workflow to be executed once for every input row (looping)
Clear the list or result rows before executionChecking this makes sure that the list or result rows is cleared before the workflow is started.
Clear the list of result files before executionChecking this makes sure that the list or result files is cleared before the workflow is started.
Run this workflow in a clustered modeAllows you to execute the process or workflow in a clustered environment. See Running a Workflow for more details on how to execute a workflow in a clustered environment.

This feature is currently not available.

Log remote execution locallyIf enabled, transfer the log lines from the cluster nodes to the local node. This feature is currently not available.
Remote slave serverSpecifies the slave server where the workflow will be run. This feature is currently not available.
Wait for the remote workflow to finishIf enabled, the process is blocked until the workflow has completed on the slave server. This feature is currently not available.
Follow local abort to remote workflowIf enabled, an abort signal sent locally will also be sent remotely. This feature is currently not available.
Logging settings Tab:
By default, if you do not set logging, Process Studio will take log entries that are being generated and create a log record inside the process. For example, suppose a process has three workflows to run and you have not set logging. The workflows will not output logging information to other files, locations, or special configuration. In this instance, the process executes and puts logging information into its master process log.

In most instances, it is acceptable for logging information to be available in the process log. For example, if you have load dimensions, you want logs for your load dimension runs to display in the process logs. If there are errors in the workflows, they will be displayed in the process logs. If, however, you want all your log information kept in one place, you must set up logging.

Field NameDescription
Specify logfileEnable to specify a separate logging file for the execution of this workflow
Append logfileEnable to append to the logfile as opposed to creating a new one
Name of log fileThe directory and base name of the log file (for example C:\logs)
Create parent folderEnable to create a parent folder for the log file it does not exist.
Extension of logfileThe file name extension; for example, log or txt
Include date in filenameAdds the system date to the filename with format YYYYMMDD.
Include time in filenameAdds the system time to the filename with format HHMMSS.
Logging levelSpecifies the logging level for the execution of the workflow. See also the logging window in Logging.
Argument Tab
ArgumentsSpecify which command-line arguments will be passed to the workflow.
Parameters Tab:Specify which parameters will be passed to the workflow
Pass all parameter values down to the sub- workflowEnable this option to pass all parameters of the process down to the sub-workflow.
ParametersSpecify the parameter name that will be passed to the workflow.
Stream column nameAllows you to capture fields of incoming records of a result set as a parameter.
ValueAllows you to specify the values for the workflow’s parameters. You can do this by: Manually typing a value or use a parameter to set the value Ex: ${Internal.process.Name} Using a combination of manually specified values and parameter values (Ex: ${FILE_PREFIX}_${FILE_DATE}.txt)