Skip to Main Content
Return to Navigation

Step Parameters

Depending on the step type, you may need to include additional parameters in the Parameter edit box of the Step Properties dialog box.

Parameter

Description

#Project=

Used primarily for functions that require a project name, like Build Project, Create Project, and Merge Project.

For the Merge Project step type, you can specify two projects separated by a comma. For example,

#PROJECT=PRJ656265,PRJ656265_IB_PRE848

#Directory=

Used when you need to run a script that is not located in the one of standard home directories defined for the environment. For example:

#Directory=#OutputDirectory

 

#RunLocation=

#FileLocation=

By default the scripts and processes are run on one of the current home directories defined for the environment. However if the script or process needs to run on the old release, you need to specify the old release home directories using the variable #ALL_OLD_PATHS_TGT. Example:

#RunLocation=#ALL_OLD_PATHS_TGT
#FileLocation=#ALL_OLD_PATHS_TGT

 

#P1= through #P5=

Used to pass parameters to SQR reports, for example, TEST.sqr. In this case, you would pass the necessary value, such as:

#P1=#OutputDirectory

#OutputDirectory=

Used to specify the Output Directory variable that is defined in the Options, Change Assistant, Directories screen.

#NT=

Used for DB2 Command Center, for Non-Terminated SQL Scripts.

Note: The #NT parameter applies to DB2 UDB only. It is ignored for DB2 zOS.

#Type=

Enables you to specify the type of record to insert into the project. Choose from the following record types:

All Records, Table, View/Query, View/Derived, SubRecord, Stored Procedure, Temporary Table, Dynamic View.

#RCID=

Enables the user to override the run control ID used for Application Engine processes.

#CI =

Connect ID (Used for Data Mover – Tools).

#CW =

Connect password (Used for Data Mover – Tools).

#EXTRACT_DMS=

Extracts DMS export script from file (Used for Data Mover – Tools).

#DBSETUP=

Extracts dbsetup DMS import script from file and database connectivity parameters (Used for Data Mover – Tools).

#UNICODE=

Generates DMS script for UNICODE database (default is NON-UNICODE) (Used for Data Mover – Tools).

#TABLESPACE=

Default tablespace (PTMINITS) (Used for Data Mover – Tools, DB2 UDB, Oracle and Informix only).

#DBSPACE=

Physical dbname.tablespace (PTMINIDB.TABLESPACE) ) (Used for Data Mover – Tools, DB2 z/OS only).

#STOGROUP_TS=

Storage group for tablespace (Used for Data Mover – Tools, DB2 z/OS only).

#STOGROUP_IDX=

Storage group for index (Used for Data Mover – Tools, DB2 z/OS only).

#TABLEOWNER=

Database owner ID (same as sqlid and tableowner) (Used for Data Mover – Tools, DB2 z/OS only).

#INDEXSPC=

Default tablespace (PTMINITS) (Used for Data Mover – Tools, Informix only).

#USE_PRCS_SERVER=

(Used only for ProcessScheduler step types).

Enter the name of the Process Scheduler server to run the step. Valid values are SERVER1 or SERVER2, which correlate to the Process Scheduler server definitions you have defined in your upgrade environment.

#PROCESS_TYPE=

(Used only for ProcessScheduler step types).

Enter the process type, as defined in Process Scheduler. For example, Application Engine, SQR Report, Data Mover, and so on.

Note: This parameter is case sensitive. That is, the value must appear in the exact case as the process type in Process Scheduler. For example, for an Application Engine program, the process type parameter should appear as PROCESS_TYPE=Application Engine, not PROCESS_TYPE=APPLICATION ENGINE.

#PROCESS_NAME=

(Used only for ProcessScheduler step types).

Enter the process name, such as DDDAUDIT.

#RUNCONTROLID=

(Used only for ProcessScheduler step types).

Enter the appropriate run control ID.

Note: If NUM_INSTANCES is greater than one, Change Assistant will append unique sequence numbers to the end of the Run Control ID before requests are submitted to the Process Scheduler. This is required for submitting multiple instances of the same process. If NUM_INSTANCES is equal to one, Change Assistant will NOT append unique sequence numbers to the end of the Run Control ID.

#NUM_INSTANCES=

(Used only for ProcessScheduler step types).

Used by Change Assistant to schedule multiple processes through Process Scheduler as individual process requests. However, the actual number of instances simultaneously executed on the Process Server is controlled by the Max Concurrent setting for the process type in the Process Scheduler server definition.

Variables for All Step Types that Use Path

The order by which the PeopleTools runtime will pick up objects from the file system is as follows:

  1. PS_CUST_HOME

  2. PS_APP_HOME

  3. PS-HOME

Change Assistant will loop through the paths in order of precedence until it finds the first instance of the file object at which time it will execute the step.

The following variables can be used for parameters requiring a path.

Variable

Description

#ALL_PATHS_TGT

Uses the path values defined for the target database current environment.

#ALL_PATHS_SRC

Uses the path values defined for the source database current environment.

#ALL_PATHS_ODMO

Uses the path values defined for the copy of demo database current environment.

#ALL_PATHS_PROD

Uses the path values defined for the production database current environment.

#ALL_OLD_PATHS_TGT

Uses the path values defined for the target database old environment.

Filter Query Variables

Filter query variables cab be used to determine the platform values (platform and server name).

Steps where the command line includes the platform are:

  • ApplicationEngine

  • ApplicationEngineWithRunControl

  • BuildProject

  • CompareAndReport

  • CopyDatabase

  • CopyfromFile

  • CopyToFile

  • CreateProject

  • MergeProject

  • DataMoverBootstrap

  • DataMoverUser

  • SQLCommand

  • SQLScript

  • SQRReport

This table lists the filter query variables.

Variable

Description

#PLATFORM_TGT

Uses the platform values defined for the target database current environment.

#PLATFORM_SRC

Uses the platform values defined for the source database current environment.

#PLATFORM_ODMO

Uses the platform values defined for the copy of demo database current environment.

#PLATFORM_PROD

Uses the platform values defined for the production database current environment.

Example: Compare and Report

In order to run a compare and report to a database, the databases must be on the same platform. A query filter can be set on the step to remove non-relevant steps, so only the applicable steps will run.

Step Set

Filter

CompareAndReport

Review Compares

CopyProject

#PLATFORM_SRC=#PLATFORM_TGT

CopyToFile

CompareFromFile

Review Compares

CopyFromFile

#PLATFORM_SRC!=#PLATFORM_TGT