This appendix discusses:
Step types.
Step parameters.
Note. In most situations, you do not need to modify steps delivered in an a change package or upgrade.
When creating custom steps, select one of these step types.
Note. When creating step types that Application Designer executes, such as Build Project or Compare and Report, if there are specific settings that need to be set for Application Designer, make sure to specify those using the Build, Upgrade, or Object Types buttons that appear to the right of the Step Type dropdown list. Use these buttons to save any necessary settings to the Change Assistant template. At run time, any Application Designer settings saved in the template override the current settings for Application Designer on the machine where an Application Designer process runs.
Step Type |
Definition |
Application Engine |
Runs the Application Engine process indicated by the Script/Procedure value under Step Properties. |
Build Project |
Builds the project specified in the step properties parameter as #Project= (for example, #Project=ALLTABS). The project is built through the PeopleTools command line. Use the Build button to select options based on the instructions in the update documentation for your product and path. Note. The Build dialog box that appears displays identical options to Application Designer. |
Compare And Report |
Runs the project compare (which produces compare reports) process using the project specified in the step properties parameter as #Project= (for example, #Project=ALLTABS). The compare is performed through the PeopleTools command line. For the Compare and Report and all Copy ... step types, use the Upgrade button to select the appropriate options, which are identical to those provided for Upgrade Options in Application Designer. |
Copy Database |
Copies a project from the source database to the target database as specified under the Step Properties. The project used is the one specified in the step properties parameter as #Project= (for example, #Project=ALLTABS). The copy is performed through the PeopleTools command line. |
Copy from file |
Copies a project from a file. This is used in conjunction with the Copy To File. It uses the project specified in the Step Properties parameter as #Project= (for example #Project=ALLTABS). |
Copy to file |
Copies a project to a file. This is used in conjunction with the Copy From File option. It uses the project specified in the Step Properties parameter as #Project= (for example #Project=ALLTABS). |
Create project |
Creates a project within Change Assistant. Use the Object Type button to launch the Create Project dialog box where you can select any combination of definition types to include in the project, such as pages, records, fields and so on. Note. If you select Pages, the system inserts all the page types into the project, including pages, subpage and secondary pages. |
Merge project |
Merges two project definitions. For example, this is used in upgrades during the "Merge IB Project" step, which merges pre and post-PeopleTools 8.48 Integration Broker metadata. |
Data Mover-Bootstrap |
Runs Data Mover scripts as the access ID specified in the credentials panel in the Apply Wizard (bootstrap mode). |
Data Mover-User |
Runs Data Mover scripts as the user ID specified in the credentials panel in the Apply Wizard (non-bootstrap mode). |
DBTSFIX |
(Applies to DB2 z/OS, DB2 UDB, Oracle, and Informix). Change Assistant determines the source and target releases of the databases defined under Step Properties as Source and Target. Once this is completed, Change Assistant determines which release scripts need to be generated by the DBTSFIX sqr to produce release scripts for your environment. |
Deploy file |
Deploys files in change packages to different servers. |
Execute process |
Enables you to include custom processes, such as bat files, that you can run as part of a Change Assistant job. Enter the file path to the file in the Parameters edit box. For example, if you want to run backup.bat, enter the following in the Parameters edit box: c:\bat\backup.bat Note. Your custom file needs to be able to close without needing human interaction. Change Assistant does not officially recognize the step as being successfully completed until the processes ran by the bat file have been closed. |
Load Base Data |
Change Assistant determines the source and target releases when running either the DBTSFIX or UpgradePeopleTools steps (depending on your database type). Once these are determined, Change Assistant will dynamically define which Load Base Data scripts need to be run for the original target release and the languages that you have installed. |
Manual Stop |
Defined as a step you must run manually. Change Assistant automatically sets the run status to Stop. After you have manually completed the step, you must change the Job Status to Complete. |
ProcessScheduler |
Runs the specified upgrade process through Process Scheduler. To further define the step, you use these required parameters: #USE_PRCS_SERVER= #PROCESS_TYPE= #PROCESS_NAME= #RUNCONTROLID= #NUM_INSTANCES= Note. If you don't specify the value to each parameter correctly, the step will fail. Example: To run one instance of an Application Engine program on SERVER1, specify parameters as: #USE_PRCS_SERVER=SERVER1 #PROCESS_TYPE=Application Engine #PROCESS_NAME=MYAE #RUNCONTROLID=TEST #NUM_INSTANCES=1 Example: To run three instances of an SQR report (XRFWIN) on SERVER2, specify parameters as: #USE_PRCS_SERVER=SERVER2 #PROCESS_TYPE=SQR Report #PROCESS_NAME=XRFWIN #RUNCONTROLID=MYID #NUM_INSTANCES=3 See Step Parameters. |
SQL Command |
Runs the SQL command defined in the Parameters value under the Step Properties. Change Assistant runs the command using the SQL Query tool specified in the Database Configuration dialog box. For most SQL Query Tools, Change Assistant stops on an error. |
SQL Script |
Runs the SQL script defined in the Script/Procedure value under the Step Properties. Change Assistant runs the script using the SQL Query tools specified on the Database Configuration. For most SQL Query Tools, Change Assistant stops on an error. |
SQR Report |
Runs SQRs using the pssqr command line. If parameters are included in the Parameters section of the step properties, Change Assistant will obtain the SQR settings from Configuration Manager for the Profile selected in the Job Database Configuration. |
UpgradePeopleTools |
Change Assistant determines the source and target releases of the databases defined under Step Properties as Source and Target. Once this is completed, Change Assistant then determines which Release scripts to run in order to upgrade your PeopleTools release from the original source release to the new target release. |
Note. There is no limitation to the number of steps you can add to a template.
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,
|
#Directory= |
Used when you need to run a script that is not located in the <PS_HOME>\scripts directory, for example, STOREPT. In this case, you could enter:
|
#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:
|
#PS_HOME= |
Used to specify the PS_HOME variable that is defined on the Directory tab of the Change Assistant options (for Updates) or the Environment Configuration Wizard (for Upgrades) (Options, Change Assistant, Directories tab). |
#SOURCE_HOME= |
Used to specify the <PS_HOME> variable that is defined on the Environment Configuration Wizard (for Upgrades). Change Assistant will use the Source <PS_HOME> instead of the targets per the value specified under Step Properties. |
#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. |
#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. Change Assistant appends 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. |
#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. |