Using a Change Assistant Template

Appendix: Using a Change Assistant Template

The Change Assistant template comprises four sections: template tree, step details, documentation, and activity. A template is a blueprint of a job and can be found in a change package that you download from PeopleSoft Customer Connection.

Understanding the Update Template

When applying a change package, Change Assistant uses the update template embedded in the PeopleSoft provided change package. You can use the update template to automate the majority of the job steps. The primary difference between a template and a job is that a template is a composite of the update process, whereas a job is a set of filtered steps for a given target environment within a template.

Common Elements in This Section

Open Template	Opens a template from the Change Assistant storage (internal database).
Save Template	Saves your template into the Change Assistant storage (internal database).
Save Template As	Saves your template as a new template name that you specify.
Close	Closes the current template.
Import Template	Imports an existing template into Change Assistant. Note. Any modifications to the current template will not affect the original template that you imported. If you want others to obtain a copy of your modified template, you need to export it out of Change Assistant.
Delete Template	Removes the template from Change Assistant. When you delete a template, you also delete all the jobs associated with the template.
Export Template	Exports a copy of the template out of Change Assistant so others can use it.
Delete Job	Removes a job associated with the current template.
Exit	Exits Change Assistant.
Change Assistant	(Options menu) Enables you to specify general options, advanced options, the download and apply directory for the updates, the staging directory, and the output directory.
Web Services	(Options menu) Enables you to configure the URLs to access PeopleSoft Customer Connection and related servers.
Environment Management Hub	(Options menu) Enables you to view and edit the URL to the Environment Management hub.
Upload Environment	(Tools menu) Uploads environment data from Environment Management hub to PeopleSoft so that PeopleSoft Customer Connection can use the information to determine what patches and fixes are applicable for your updates.
Go to Customer Connection	(Tools menu) Accesses the PeopleSoft Customer Connection update search page.
Download Change Package	(Tools menu) Downloads the change packages into Change Assistant based on the update IDs that you specify. You can obtain a list of update IDs by downloading a Microsoft Excel file from PeopleSoft Customer Connection.
Apply Change Packages	(Tools menu) Launches the process to apply change packages that you downloaded from PeopleSoft Customer Connection.

Using the Change Assistant Templates

PeopleSoft delivers update templates for each update in PeopleSoft change packages. When you apply updates by using the Apply Change Packages option, Change Assistant automatically loads the template into the Change Assistant internal storage system. You can add additional chapters, tasks, and steps to the template.

Note. Any changes that you make to the imported template won't affect the original template that you downloaded from PeopleSoft Customer Connection. If you want to overwrite the original template with your changes, save the template and select File, Export to export it to the directory from which you downloaded it. You can also use the export function to make this modified template available to others.

Exporting Templates

In order for others to use the template that you create or modify, you need to export it from Change Assistant. If you want to overwrite an existing template file, enter the name of the original template.

To export a template:

Open the template in Change Assistant by selecting File, Open Template.
Select File, Export Template.

The Export Template dialog box appears.
Navigate to the folder in which you want to save the template.
Enter the name of the template.

Note. If you want to overwrite the original template that you downloaded from PeopleSoft Customer Connection, enter the original name of the template.
Click Save.

Editing Templates

You may want to add steps, modify existing steps, or delete existing steps from the templates. To edit a template, you must be in the Template mode (Options, Change Assistant Options, General tab, Advanced Options button, Template).

Note. Under normal circumstances, you don't need to modify the template delivered by PeopleSoft. However, if you choose to edit a template, take special care.

Creating New Chapters in Templates

You can add a chapter to an existing update template. A chapter is a section heading for a group of tasks.

To insert a chapter:

Highlight the location where you want to add the chapter.

If you want to add a chapter above the existing first chapter in the template, highlight the top node (template name) at the top of the template tree. Otherwise, put your cursor on the chapter below which you want to insert the new chapter.
Select Edit, Insert Chapter on the Change Assistant toolbar.
Enter a unique name for your new chapter.

Note. Each chapter in the update template must have a unique name.
Click OK.

Creating New Tasks in Templates

You can add a task to a new or existing update template. A task is a section heading for a group of steps.

To insert a task:

Highlight the chapter or task below which you want to insert the new task.
Select Edit, Insert Task on the Change Assistant toolbar.
Enter a unique name for your new task.

Note. Each task within a chapter must have a unique name.
Click OK.

Adding Steps to Templates

PeopleSoft delivers update templates with all of the steps included to perform the update. While performing the update, you may need to add steps (for example, you may add steps for dropping and adding indexes or running a backup of the target database).

To add a step:

Highlight the task or step below which you want to insert the new step.
Select Edit, Insert Step on the Change Assistant toolbar.
Enter a unique name for your new step.

Note. Each step within a task must have a unique name.
Click OK.

Change Assistant displays the Step Properties dialog box.
Enter the step properties for the new step.
Continue creating steps until the template is complete.
Save the template.

Editing Steps in Templates

PeopleSoft delivers update templates with default settings to perform updates. You can modify the default settings by changing the step properties. Setting these properties determines the conditions that apply when you run the update process.

To modify the step properties, highlight the step for which you want to modify the step properties, then select Edit, Step Properties.

Note. Depending on whether you are in Job mode or Template mode, some of the fields may be disabled. Also, the step status grid only appears when you are in Job mode.

Verify that the step description corresponds to the step you selected.
Modify the step properties.
Click OK on the Step Properties dialog box to display the Change Assistant dialog box.
Save the template.

The step properties that you defined for the current step are displayed in the Task Details section of the dialog box.

Deleting Chapters, Tasks, or Steps from Templates

To delete a chapter, task, or step:

Access Change Assistant and select Template view from the Advanced Options screen.
Select File, Open Template to select your template.
Highlight the chapter, task, or step that you want to delete.

Warning! If you delete a chapter, Change Assistant deletes all the tasks and steps within the chapter. If you delete a task, Change Assistant deletes all the steps within the task.
Select from the following:
1. If you want to delete a chapter, select Edit, Delete Chapter.
2. If you want to delete a task, select Edit, Delete Task.
3. If you want to delete a step, select Edit, Delete Step.
Change Assistant deletes the chapter, task, or step and updates the template.
Save the template.

Modifying Step Properties

Step properties are set by default in PeopleSoft-delivered templates. However, you may want to modify or edit step properties in your own templates or for steps that you add to PeopleSoft-delivered templates.

Note. Under normal circumstances, it is recommended that you not modify or edit the step properties in your delivered template.

This section describes fields and options on the Step Properties dialog box. You can modify step properties for a step when adding or editing steps in the template.

Step Description	This field displays your current step.
Script/Procedure	This field is required for all step types except manual stop.
Type	Select a step type. This selection defines the type of action to be performed by the step. Step types are listed in the following table:

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.
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.
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	This type enables you to select the type of records to insert into a project.
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	(Only used for 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 the user's environment.
Deploy file	Deploys files in change packages to different servers.
Execute process	Enables you to include custom processes, such as batch files, that you can run in Change Assistant. You need to start this process with cmd /c for the process to run; for example: Cmd /c c:\backup.bat
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.
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 target release to the new source release. Configuration.

Note. If you select Create Project from the Type drop-down list box, you must set a #Type parameter and a #Project parameter. For a list of parameters, see the next topic. When you select Build Project from the Type drop-down list box, a Build options button appears. You select options based on the instructions in the update documentation for your product and path.

Parameters

Enter additional parameters that you may need to run the step. For SQL commands, you enter the actual SQL command in this field.

The additional parameters are:

Parameter	Description
#Project=	Used primarily for functions that require a project name; for example, Build Project.
#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: #Directory=#PTPS_HOME\src\cbl\base\
#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
#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 specifed 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.
#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.

Products

Click the Products icon. Change Assistant displays the Select Products dialog box, which enables you to select the product line, the industry, and the products to which your step should be run against (for example, FIN/SCM, Commercial, Asset Management).

Note. This feature is used primarily for data conversion processes. You must select at least one product.

Note. Run Location and Database Configuration are not used at this time.

Platforms

Click the Platforms icon on the Step Properties dialog box. Change Assistant enables you to select the platforms to which you want to run this update step against. You must select at least one platform.

Language

Click the Language icon on the Step Properties dialog box, and Change Assistant enables you to select the languages you want this update step to run against. You must select at least one language.

Note. Type of Update Step , Language Type, Allow for Errors, and Run Concurrently options are not used at this time.

Viewing the Template Tree

The template tree section displays the chapter, tasks, and steps for your selected update product and uses the following structure:

Chapters are section dividers that display the tasks within the chapter.
Tasks are section levels that contain one or more steps.
Steps are the actual update steps that you select to set up and run your update job.

Note. When you run your update job, you assign properties at the step level, not the task level.