Working with Steps

This section discusses how to:

  • Set step properties.

  • Set filter queries.

  • View step status.

PeopleSoft delivers update templates with default settings and steps to perform updates. If needed, you can modify the steps, or create new steps, based on 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 double-click on the step or select Edit > Step Properties. After making any changes to step properties, click OK, and save your template.

Note: Depending on what mode you are in, some of the fields may be disabled.

Note: Under normal circumstances, it is recommended that you do 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.

Image: Step Properties dialog box

This example illustrates the fields and controls on the Step Properties dialog box. You can find definitions for the fields and controls later on this page.

Step Properties dialog box

Field or Control


Step Description

This field displays the current step.


Enter the name of the script, procedure, project, or program name to which you want to assign the properties of the step. For example, enter SYSAUDIT.

This field is required for all step types except manual stop.


Select a step type. This selection defines the type of action to be performed by the step. For example, if you are running the SYSAUDIT SQR report, select SQRReport.

Detailed information related to each step type appears elsewhere in this PeopleBook.

See Step Types


Enter additional parameters that you may need to run the step. For example, for SQL commands, you enter the actual SQL command in this field. In other cases, you use this edit box to override various environment settings or other parameters so that the step completes successfully.

Detailed information related to the parameter options for each step type appears elsewhere in this PeopleBook.

See Step Parameters

From Tools Release

Specify the PeopleTools releases to which a step applies. Use the associated operator dropdown list to indicate ranges of releases. The default values are All with the = operator.

The operator dropdown list enables you to express greater than, less than, equal to, and 'in' relationships.

The in operator enables you to specify more specific ranges, such as 'in' 8.48 and 8.49, as opposed to 'greater than' 8.48. When adding multiple release numbers, separate the values with a comma (,). For example:


Note: If you enter more than one From Tools Release value, the system assumes the 'in' operator.

Change Assistant uses these values to filter the steps when creating the upgrade job so that only the steps necessary for a particular environment remain.

Run Location

Select one of these run location options:

  • Local: runs a step's process on the local machine: the Windows workstation where Change Assistant is running. For Application updates and PeopleTools-only upgrades, steps run locally. However, for full upgrades, steps can run locally or remotely.

  • Remote Agent: runs the step on a remote server. During a full upgrade, some steps are data intensive and, for performance reasons, can be run on a remote server. If you select Remote Agent, before running the step you need to configure the Remote Agent options on the Change Assistant Options dialog.

    See Specifying Database Process Scheduler Settings.


Specify which database the step needs to be run against. Options will vary based on the action selected, but may include:

  • Source

  • Target

  • Copy of Current Demo

  • Production

  • Not Applicable

    Note: This orientation is used for Manual Stops or a task that does not use an orientation.

Step type and type of upgrade determine valid orientation settings.

See Source and Target Databases.


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: You must select at least one product.

Apply Type

Specify the type of upgrade to which this step applies:

  • Initial Pass: refers to the initial application of a change package or new release to your Copy of Production database.

  • Move to Production: refers to the upgrade between your Copy of Production database and your test or production system.

  • Both: refers to steps that need to be run in both apply types.

Note: When the job is created, the system filters the template steps to be executed by the apply type specified. For example, if Move to Production is specified as the apply type, only steps in the template specified as Move to Production or Both will be included in the job.

Allow for Errors

Indicates how the system should react to any errors that may arise during a step run. If set to Yes, if the step encounters errors the system does not perform any error handling and continues on to the next step.

Default is set to No.

Run Concurrently

Enables you to set multiple steps (programs, processes, and so on) to run simultaneously.

If you select this option for two or more consecutive steps, Change Assistant starts those processes concurrently, until the job reaches:

  • a step with Run Concurrently set to No.

  • a step type of Manual Stop.

  • the Maximum Concurrent Processes value, as set on the Change Assistant Options dialog box.

By setting Run Concurrently to Yes, you are indicating to Change Assistant that this step can run concurrently with the following step. The total number of processes that can run concurrently is determined by the Maximum Concurrent Processes setting on the Change Assistant Options dialog box.

Some examples are shown here, these examples use 3 AE steps and CA concurrency set to 2:

  • Example 1


    • AE1 Concurrent=Yes

    • AE2 Concurrent=Yes

    • AE3 Concurrent=No

    • Manual Stop

    In this example, AE1 and AE2 will run in parallel. When both finished, AE3 will then run.Job will stop when ManualStop is encountered.

  • Example 2:


    • AE1 Concurrent=Yes

    • AE2 Concurrent=Yes

    • AE3 Concurrent=Yes

    • Manual Stop

    In this example, AE1 and AE2 will run in parallel, when either AE1 or AE2 finish, AE3 will run. Job will stop when ManualStop is encountered.

  • Example 3


    • AE1 Concurrent=Yes

    • AE2 Concurrent=Yes

    • Manual Stop

    • AE3 Concurrent=No

    In this example, AE1 and AE2 will run in parallel, the job will stop when ManualStop is encountered. AE3 will run after the user completes the ManualStop.

  • Example 3


    • AE1 Concurrent=Yes

    • AE2 Concurrent=No

    • AE3 Concurrent=Yes

    • Manual Stop

    In this example, AE1 will run, when AE1 finishes, AE2 will run, when AE2 finishes AE3 will run. Job will stop when ManualStop is encountered.

Running steps concurrently is a strategy reserved for application upgrades to save time when running the following step types on a remote host through a remote EMF agent or Process Scheduler:

  • Application Engine

  • SQL

  • Data Mover

Concurrent processing is not enabled in any circumstances for these step types:


  • Load Base Data

  • Upgrade PeopleTools

  • Manual Stop

Note: If a step is dependent on a previous step, it is not recommended to set it to run concurrently with that step.

Note: Steps set to run concurrently can span across multiple consecutive tasks or chapters, and can be of different step types.

Note: In an application upgrade, do not run the "Update PeopleTools System Tables" step concurrently, and, unless specifically instructed to do so, do not run any of the steps in the "Apply PeopleTools Changes" chapter concurrently.

See the upgrade documentation for your specific upgrade for recommendations on specific steps within that upgrade that can be run concurrently.

Filter queries provide the ability to add ad-hoc step filtering criteria to a template to further improve applicability of job to the customer and where possible remove unnecessary manual steps.

See Adding Filter Queries

When working with templates and jobs, you see these status icons to the left of steps:

Field or Control


Run Run

Indicates that Change Assistant runs this step or process automatically without manual intervention.

Stop Stop

Indicates that Change Assistant stops on this process. It also indicates that there may be manual steps to perform for this step. Review the documentation window for further instructions. After completing the work described in a manual step, you must set the status to Complete.

Restart Restart

Indicates a restart process. If a step failed and you corrected the problem, you can set the step to restart from the point of failure.


Indicates that the process is running.

Failure Failure

Indicates a failure has occurred that needs immediate attention. This appears if a Data Mover script, SQL script , or project copy step fails. Resolve the error before continuing with processing.


Indicates a warning for this step which does not need immediate attention. The job continues processing with no adverse affects. After the job completes, review the steps in a warning state and evaluate for further action.

Complete Complete

Indicates that the step was completed by the system.

Manually Completed Manually Complete

Indicates this step was completed manually.

Filter Filter

Indicates this step is filtered at the job level.

Steps filtered at the job level will not execute and are equivalent to Complete. To hide these steps, select View, and deselect Steps Filtered at the Job Level.

Filter QueryFilter Query

Indicates this step is filtered by a filter query.

Steps filtered by filter query will not execute and are equivalent to Complete. To hide these steps, select View, and deselect Steps Filtered by Filter Query.

Beginning with PeopleTools 8.56 multiple instances of Change Assistant can run in parallel, however you can not run multiple instances against the same target database. This CA functionality is available independent of the Tools Release of the Target Databases, however, some calls on some older Tools Releases do not support parallel processing and therefore locking will occur. If locking occurs, a message will be displayed in Change Assistant showing the lock.

Image: Change Assistant Lock message

This is an example of a Change Assistant lock message.