Command Execution › Run Program Operator › Input Parameters

Input Parameters

Program name

• UNIX target: The program must be either a binary file or a shell script following UNIX conventions (the first line of the file must have the full path of the shell, as in #!/bin/ksh).
• Windows target: The program must be an executable file or a script. The file is typically specified by:
  • The name of the file to execute in the working directory for the operator

    Or

  • In one of the directories specified by the PATH environment variable on the target host.

The path relative to the Working directory specified for the UNIX Command Execution operators.

Profile

UNIX

Specifies a host system profile to be “sourced” to define parts of the execution context of the process.

For example:

"/home/username/appli_1_profile"

If no profile is specified here, the profile specified in the UNIX Command Execution property settings (at the category level) is used. If no profile is specified in either the operator or operator settings, then only the user profile that runs the process is used.

Windows

Specifies the path to a batch (.bat) file in Windows that sets environment variables to run by the process.

The variable settings that are defined by the batch file specified here are in addition to any variable settings defined for the user profile that runs the process. If no file is specified for this option, the operator uses the settings defined by the Shell profile parameter set for the Windows process service.

Working directory

Typically, this field specifies the folder that contains the program file or some related files required by the program. Any file that is specified without an explicit path is created or looked for in this directory.

The default if you do not specify a working directory is the home or working directory for the user account that runs the operator.

UNIX

Specifies the working directory for the operator.

For example: "/home/user1"

User ID

Specifies the system user name under which to run the program. The user must have execute permissions on the file.

If you leave this field blank, the default is the default user specified in the configuration settings at the category level.

User names and passwords can be specified at the category level, or stored in named dataset variables so they can be updated centrally without changing process values.

Password

Specifies the current password for the specified user ID.

Specifying the password as a literal string value is considered a bad practice. A much better method is to have the password kept in a dataset variable of type password and to pass that variable.

Parameters

Specifies parameters to pass to the process.

The parameters are passed to the process in the same order that they are listed here. Use the buttons to add, remove, or reorder parameters.

Program parameters are passed individually to the program on startup.

Standard out file

Specifies the file to capture text that the program writes to STDOUT.

For example:

/tmp/trace.log 

You can specify the same file for both the standard error and standard out files. However, no order is maintained for the different types of output.

Standard error file

Specifies the file to capture text that the program writes to STDERR.

For example:

/tmp/trace.err

You can specify the same file for both the standard error and standard out files. However, no order is maintained for the different types of output.

Post output to logs

Logs process output to the global log files.

Post output to dataset variable

Copies output of an operation (stdout and stderr) to the operator dataset variable processOutput.

Truncate log file used for standard out

Replaces an existing log file with the same name every time new output is written. Clear this check box to append output to an existing error log file with the same name.

This check box also replaces an existing file even if it is also used for standard error and the Truncate log file used for standard error check box is not selected.

Truncate log file used for standard error

Replaces an existing error file with the same name every time new output is written. Clear this check box to append output to an existing error file with the same name.

This check box also replaces an existing file even if it is also used for standard output and the Truncate log file used for standard out check box is not selected.

Load OS user profile

Loads the operating system (typically Windows) profile that is associated with the user account. The User ID specifies the profile (in addition to the profile specified by Profile, which specifies environment variables). Typically this profile is not used except to establish associations and similar Windows registry-based constructs for a particular user. A performance penalty is associated with downloading user information from a Domain server.

Kill process on flow end

The OS process running the specified program is killed (if it has not already terminated) once the CA Process Automation process completes.