General

General



General

Start

Description

Start is an entry in the General Plugin of Process Studio Processes. Start is the starting point for process execution. Every process must have one Start. Only unconditional process hops are generated from Start.


Dummy

Description

Dummy is an entry in the General Plugin of Process Studio Processes. The Dummy process entry does nothing. It is just an entry point or placeholder on the canvas; Dummy performs no evaluation. It can be useful in handling loops in workflows by branching to the Dummy step on a certain condition. It makes drawing clearer for looping. 



Process 

Description

Process is an entry in the General Plugin of Process Studio Processes. The ‘Process’ process entry refers to already existing processes. One or more process entries in a Process may perform different functional tasks. Hence, a process can be broken into smaller processes for the sake of organizational and visual simplicity. 

Configurations

Process Specification Tab

No.

Field Name

Description

1

Process Entry name

Specify 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. 

2

Process filename

Specify your process by entering in its path or clicking Browse.

If you select a process that has the same root path as the current process, the variable ${Internal.Entry.Current.Directory} will automatically be inserted in place of the common root path. For example, if the current process‘s path is /home/admin/workflow.psp and you select a process in the folder /home/admin/path/sub.psp than the path will automatically be converted to ${Internal.Entry.Current.Directory}/path/sub.psp.

3

Repository: specify by name

If you are working in the Process Studio (PS) Repository or database repository, specify the name of the workflow to start. Click the button to browse through the PS Repository.

This feature is currently not enabled.

4

Repository: specify by reference

If you specify a workflow or process by reference, you can rename or move it around in the DI Repository. The reference (identifier) is stored, not the name and directory

This feature is currently not enabled.


Advanced Tab

No.

Field Name

Description

1

Copy previous results to args?

The results from a previous workflow can be copied as arguments of the process 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 process, otherwise only the first row is used to generate the command line arguments.

2

Copy previous results to parameters?

If Execute for every input row is enabled then each row is a set of command line process arguments to be passed into the process, otherwise only the first row is used to generate the command line arguments.

3

Execute for every input row?

Implements looping; if the previous process entry returns a set of result rows, the process executes once for every row found. One row is passed to the process at every execution. 

For example, you can execute a process each row in an excel sheet or for each file found in a directory.

4

Remote slave server

The slave server on which to execute the process. This feature is currently not enabled.

5

Pass process export to slave?

Pass the complete process (including referenced sub- process and sub-workflows) to the remote server. This feature is currently not enabled.

6

Wait for the remote process to finish?

Enable to block until the process on the slave server has finished executing. This feature is currently not enabled.

7

Follow local abort to remote process?

Enable to send the abort signal to the remote process if it is called locally. This feature is currently not enabled.

8

Expand child processes and workflow on the server

When the remote process starts child processes and workflows, they are exposed on the slave server and can be monitored. This feature is currently not enabled.


Logging settings Tab

No.

Field Name

Description

1

Specify logfile

Specifies a separate log file for running this process.

2

Name

The directory and base name of the log file, for example, 'C:\logs'.

3

Extension

The file name extension, for example, '.log' or '.txt'.

4

Log level

Specifies the logging level for running the process. See Enable Logging for more details.

5

Append logfile?

Appends the log file instead of creating a new one.

6

Create parent folder

Creates the parent folder for the log file if it does not already exist.

7

Include date in logfile

Adds the system date to the file name with the format 'YYYYMMDD', for example '_20051231'.

8

Include time in logfile

Adds the system time to the file name with the format 'HHMMSS', for example, '_235959'.


Argument Tab

No.

Field Name

Description

1

Arguments 

Specify which command-line arguments that will be passed to the process. 


Parameters Tab: Enter the following information to pass parameters to the process: 

No.

Field Name

Description

1

Pass all parameter values down to the sub- process

Enable check box to pass all parameters of the process down to the sub- process. 

2

Parameter

Specify the parameter name passed to the process.

3

Stream Column Name 

Specify the field of an incoming record from a previous process as the parameter.

4

Value 

Specify the values for the processes’ parameters by using one of the following methods: 

Manually typing a value or use a parameter to set the value, for example, '${Internal. process.Name}'.

Use a combination of manually specified values and parameter values, for example, '${FILE_PREFIX}_${FILE_DATE}.txt'.

5

Get Parameters

Get the existing parameters associated with the process.


Set Variables

Description

Set Variables is an entry in the General Plugin of Process Studio Processes. This process entry can set one or several variables in a process (at the root, parent or current process level) or in the virtual machine. 

Configurations

No.

Field Name

Description

1

Process entry name

Specify 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. 


Properties file:


2

Name of properties file

Provide the name of the properties file

3

Variable scope

Select the variable scope

  1. Valid in the Java Virtual Machine
  2. Valid in the current process
  3. Valid in the parent process
  4. Valid in the root process


Settings:


4

Variable substitution

Select checkbox to enable variable substitution. 


Variables:


5

Variable name

Select variable name

6

Value

Provide value to set for the variable

7

Variable scope type

Choose variable scope:

  1. Valid in the Java Virtual Machine
  2. Valid in the current process
  3. Valid in the parent process
  4. Valid in the root process

 

Success

Description

Success is an entry in the General Plugin of Process Studio Processes. This entry sets the status of the process to Success. Success entry clears any errors encountered in the process and sets the process status to Success.

Workflow 

Description

Workflow is an entry in the General Plugin of Process Studio Processes. Workflow entry refers to a previously defined workflow in a process. A process can act as a container for one or several workflows. Workflows are generally used for data transactions whereas the process can perform serialized activities such as sending mail, checking conditions, file management, executing workflows and processes etc. 

Configurations

Workflow Specification Tab

No.

Field Name

Description

1

Name of Process Entry

Specify 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. 

2

Workflow Filename

Specify 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.

3

Specify by Name and Directory

If 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.

4

Specify by Reference

If 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

No.

Field Name

Description

1

Copy previous results to args 

The 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.

2

Copy previous results to parameters 

The results from a previous workflow can copied as parameters of the workflow using the "Copy rows to result" step. 

3

Execute for every input row 

Allows a workflow to be executed once for every input row (looping)

4

Clear the list or result rows before execution 

Checking this makes sure that the list or result rows is cleared before the workflow is started. 

5

Clear the list of result files before execution 

Checking this makes sure that the list or result files is cleared before the workflow is started. 

6

Run this workflow in a clustered mode

Allows 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.

7

Log remote execution locally

If enabled, transfer the log lines from the cluster nodes to the local node. This feature is currently not available.

8

Remote slave server

Specifies the slave server where the workflow will be run. This feature is currently not available.

9

Wait for the remote workflow to finish

If enabled, the process is blocked until the workflow has completed on the slave server. This feature is currently not available.

10

Follow local abort to remote workflow

If 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.

No.

Field Name

Description

1

Specify logfile

Enable to specify a separate logging file for the execution of this workflow

2

Append logfile 

Enable to append to the logfile as opposed to creating a new one

3

Name of log file

The directory and base name of the log file (for example C:\logs)

4

Create parent folder

Enable to create a parent folder for the log file it does not exist.

5

Extension of logfile

The file name extension; for example, log or txt

6

Include date in filename 

Adds the system date to the filename with format YYYYMMDD.

7

Include time in filename 

Adds the system time to the filename with format HHMMSS. 

8

Logging level 

Specifies the logging level for the execution of the workflow. See also the logging window in Logging.


Argument Tab

No.

Field Name

Description

1

Arguments 

Specify which command-line arguments will be passed to the workflow. 


Parameters Tab: Specify which parameters will be passed to the workflow

No.

Field Name

Description

1

Pass all parameter values down to the sub- workflow

Enable this option to pass all parameters of the process down to the sub-workflow. 

2

Parameters

Specify the parameter name that will be passed to the workflow.

3

Stream column name 

Allows you to capture fields of incoming records of a result set as a parameter.

4

Value 

Allows 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)





      Links to better reach 

            Bot Store

             EPD