Skip to Main Content
Return to Navigation

Configuring and Working With The Upgrade Environment

Before you begin performing an upgrade using Change Assistant, you must define your upgrade environment, which consists of all of the databases used to perform the upgrade and any Process Scheduler servers you intend to use. Change Assistant uses your configuration information to:

Selecting Application Upgrade Option

In order to perform an Application Upgrade, you must be in the Application Upgrade mode. To select the Application Upgrade Mode:

  1. Select Tools, Change Actions.

  2. Select Application Upgrade and click Next.

  3. On the General Options page, specify the high-level settings for your current environment. and click Next.

  4. On the Additional Options page, enter your optional email notifications settings.

  5. Click Finish.

General Options

The General Options will be used for as the default options for all of the various databases in the upgrade process.

Image: General Options - Upgrade

This example illustrates the fields and controls on the General Options - Upgrade. You can find definitions for the fields and controls later on this page.

General Options - Upgrade
Maximum Concurrent Processes

Specifies the maximum number of processes that can be executed concurrently on the local machine. The default is 1.

PS Home

Enter the full path in which you installed PeopleTools.

Note: Specify the PS_HOME location that is the same version of PeopleTools that the target database is running on. For PeopleTools scripts and executable to run successfully against a database, they must be at equivalent versions. The PeopleTools version of the PS_HOME does not necessarily need to be the same version as the Change Assistant session you are running. Change Assistant may be at a higher version.

PS App Home

Enter the location for PS_APP_HOME.

PS Cust Home

nter the location for PS_CUST_HOME.

Staging Directory

Enter the directory in which you would like to stage all the Change Assistant upgrade files. This is the location that Change Assistant will store files to be used during the upgrade job..

Output Directory

Enter the directory in which you want the log files generated by the upgrade job.

Additional Options

Image: Additional Options - Upgrade

This example illustrates the fields and controls on the Additional Options - Upgrade. You can find definitions for the fields and controls later on this page.

Additional Options - Upgrade
Send Email Notifications

Select this check box to receive email notifications if there are errors in the update process. Change Assistant also sends you a completion message when it encounters a Stop in the update process.

SMTP Server

Enter the SMTP mail server from which you receive the error or completion messages.

Port

Enter the port from which you want to access the email.

Send To

Enter the address to which you want the email sent.

Return Address

Enter the email address of the sender. Use this to identify who sent the notification.

Test

Validates that email is sent to the designated recipients and is working correctly.

Specifying Upgrade Environment Database Settings

An upgrade environment includes these database types:

  • Source

  • Target

  • Copy of Current Demo

  • Production

Which database types you specify in your environment depends on the type of upgrade you are performing and the types of steps that need to be run.

Database Type

Required/Optional

Used in PeopleTools Upgrade?

Used in Application Upgrade?

Source

Required (for Application Upgrades)

No

Yes

Target

Required

Yes

Yes

Copy of Current Demo

Optional

No

Yes

Production

Optional

No

Yes

Creating a New Upgrade Environment

To create a new upgrade environment:

  1. Select File, New.

    The Database Configuration Wizard will guide you through the set up pages.

    Note: You must be in the action mode Application Upgrade.

  2. The Database Wizard will guide you through the pages to configure your environment. Some pages are optional and only displayed when the corresponding check box is selected. Refer to the table below for a listing of all the pages in the Database Wizard.

  3. Complete all of the Database Wizard pages by entering the values and clicking Next for the next page.

  4. Click Save.

Page

Description

Target Database

Configure the target database.

Values selected for products and languages will be carried forward to all databases configurations to ensure the integrity of the upgrade and provide the correct filtering for the upgrade job.

See Setting Target Database Configuration

Target Database — Optional PeopleSoft Test Framework Settings

This page is displayed when Enable PeopleSoft Test Framework is selected on the Target Database page.

See Specifying PeopleSoft Test Framework Settings

Target Database — Optional App. Server and Process Scheduler Settings (for Process Scheduler requests).

This page is displayed when Enable Process Scheduler is selected on the Target Database page.

See Specifying Upgrade Environment Process Scheduler Settings

Target Database — Optional Process Scheduler Settings (for Process Scheduler requests).

This page is displayed when Enable Process Scheduler is selected on the Target Database page.

See Specifying Upgrade Environment Process Scheduler Settings

Source Database

Configure the source database. The source database will take the information entered for the target database.

See Setting Source Database Configuration

Source Database — Optional PeopleSoft Test Framework Settings

This page is displayed when Enable PeopleSoft Test Framework is selected on the Source Database page.

See Specifying PeopleSoft Test Framework Settings

Source Database — Optional App. Server and Process Scheduler Settings (for Process Scheduler requests).

This page is displayed when Enable Process Scheduler is selected on the Source Database page.

See Specifying Upgrade Environment Process Scheduler Settings

Source Database — Optional Process Scheduler Settings (for Process Scheduler requests)

This page is displayed when Enable Process Scheduler is selected on the Source Database page.

See Specifying Upgrade Environment Process Scheduler Settings

Copy of Current Demo Database

This page is displayed when Configure Copy of Current Demo is selected on the Target Database page.

Production Database

This page is displayed when Configure Production Database is selected on the Target Database page.

Confirm Selections

Displays a summary of your selections.

Setting Target Database Configuration

 

The settings on the Target Database Configuration page are:

Database

Enter a name of up to 8 characters for the database.

Database Type

Select a database platform from the list. Based on signon requirements for the database platform that you select in this field, other fields will be disabled or become available for entry.

Database Server Name

Only applies to Informix, Microsoft SQL Server and Sybase.

If applicable, enter a name of up to 256 characters for the database server name.

Owner ID

(Used for DB2 z/OS only). Enter the owner ID used for the tables.

Unicode

Select Yes if you use a Unicode database. Select No if you use an ANSI database.

User ID and Password

Enter the PeopleSoft user ID and password for the database that will be used to perform the upgrade. Examples of user IDs are VP1 and PS.

Access ID and Password

The access ID has full access to all objects in the database.

Your access ID is not a PeopleSoft user ID, such as VP1 or PS. Examples of access IDs are sa or sysadm.

Note: For Microsoft SQL Server the access ID must also have System Administrator privileges.

Note: The IDs and passwords are case-sensitive.

Note: The access ID is often the database owner. It is not normally the same value as the connect ID, which has limited access to the database.

See Access IDs.

Test Connection

Click to confirm the database connection information you have entered.

SQL Query Executable

Select the correct executable for the database platform. Valid SQL query executables for each platform are:

  • DB2: db2cmd.exe

  • Informix: dbaccess.exe

  • Microsoft SQL Server: sqlcmd.exe

  • Oracle: sqlplus.exe

  • Sybase: isql.exe

Note: Change Assistant uses the command line version of the .exe, not the GUI version. For example, sqlplus.exe is used for an Oracle database, rather than sqlplusw.exe.

Important! Oracle Database Customers: For systems running on the Oracle database, by default, Change Assistant copies the generated SQL script files to the location specified as the TEMP User variable on the Environment Variables dialog box. So, on Oracle, the generated SQL script files will actually exist in two locations: the specified Change Assistant output directory, and the TEMP directory. This behavior is in place because some versions of Oracle SQL Plus do not support pathnames longer than 79 characters. It is recommended that you ensure that the value specified for the TEMP User variable is set to a path short enough so that the string comprising the path and generated SQL file will not exceed 79 characters.

Products

Browse and select all installed products affected by this upgrade.

Languages

Browse and select all languages that apply to this upgrade.

Current Environment PS_Home

Enter the location of your current PS_HOME (the PS_HOME of the application to which you are upgrading).

Note: Oracle recommends using a mapped drive.

Current Environment PS_App_Home

Enter the location of your current PS_APP_HOME (the PS_APP_HOME of the application to which you are upgrading).

Note: Oracle recommends using a mapped drive.

Current Environment PS_Cust_Home

Enter the location of your current PS_CUST_HOME (the PS_CUST_HOME of the application to which you are upgrading).

Note: Oracle recommends using a mapped drive.

Old Environment PS_Home

Enter the location of your previous PS_HOME.

Note: Oracle recommends using a mapped drive.

Old Environment PS_App_Home

Enter the location of your previous PS_APP_HOME.

Note: Oracle recommends using a mapped drive.

Old Environment PS_Cust_Home

Enter the location of your previous PS_CUST_HOME.

Note: Oracle recommends using a mapped drive.

Configure Copy of Current Demo

Enables a third database, Copy of Current Demo, to be specified in the environment, in addition to Source and Target.

In some cases, during application upgrades only, templates contain steps to be run against the Copy of Current Demo database. The database orientation of Copy of Current Demo is available only for select step types, such as compare and Data Mover steps.

Note: This option is applicable for upgrades to PeopleSoft Financials and Supply Chain 8.9 and above and PeopleSoft applications 9.0 and above.

Note: This check box applies only to application upgrades.

Configure Production Database

Configure Production Database is not valid for any existing upgrade. It is reserved for future use. This option should normally be unselected.

Enable PeopleSoft Test Framework

Select this option if the upgrade contains PTF steps.

 

Enable Process Scheduler

Select this option to define up to two Process Scheduler servers to run ProcessScheduler steps during the upgrade job run.

This option applies only to Source and Target databases in an application upgrade environment.

Setting Source Database Configuration

The source database is the new Demo database for your application. The Source Database Configuration contains most of the same fields as the Target Database Configuration page, except that it only uses the current environment. The values entered for the target database are carried forward to the source database. Products and languages are display-only and can not be changed.

Image: Source Database page

This example illustrates the fields and controls on the Source Database page. You can find definitions for the fields and controls later on this page.

Source Database page

The differences in the fields are listed here:

Database Type

This field will default to the database type of the target database, depending on your current platform this may not be the same database type as the target database.

Products

This field is display-only on the source database. The product values are carried forward from the target database.

Note: The source and target database will always have the same product list defined and the product list is always based on the target database.

Language

This field is display-only on the source database. The languages values are carried forward from the target database.

Note: The source and target database will always have the same languages defined and the language list is always based on the target database.

Current Environment

The current environment is taken from the General Options. If the source database is on a different platform than your target database, you will need to change these values to the correct directories.

Specifying Upgrade Environment Process Scheduler Settings

If you have selected the Enable Process Scheduler check box for an applicable database definition, you must enter the required information for the host machine and the Process Scheduler server definitions associated with that database that will be running the ProcessScheduler steps. You assign an existing Process Scheduler server to either the SERVER1 or SERVER2 slots. When defining a ProcessScheduler step type, you specify which server will run the step, SERVER1 or SERVER2.

Machine name or IP

Enter the host name or the IP address of the application server where the appropriate Process Scheduler server domain is running (PSPRCSRV.EXE and so on).

JSL Port

Enter the domain's JSL port (listener port).

Domain Connection Password

Enter the domain connection password for the application server.

Server Name

Enter the name of the Process Scheduler server definition, such as PSUNIX.

Method of retrieving Process Scheduler logs

You can download view the Process Scheduler logs from within Change Assistant so that you don't need to monitor the processes separately using Process Scheduler monitoring and logging. Similar to other Change Assistant log files, the downloaded Process Scheduler log files are saved to the Change Assistant output directory.

  • None: Disables the ability to view Process Scheduler log information from within Change Assistant.

  • FTP: Select if Process Scheduler is running on a UNIX server.

  • File Copy: Select if Process Scheduler is running on a Windows server.

Note: If you have configured multiple Process Scheduler servers within your upgrade environment, and they each run processes within the job, as needed, note that the log information will reside in two locations, with each location containing the log information associated with the processes run on that server.

Machine Name or IP

(Applies only to FTP option). Enter the machine name or IP address of the FTP server where the Process Scheduler logs are located.

Log/output Directory

(Applies to File Copy and FTP option). Enter the path to where the Process Scheduler logs are located on the server.

  • For the FTP option, enter the absolute path on the FTP server.

  • For the File Copy option, this is the (mapped) path on the Change Assistant workstation.

User ID andUser Password

(Applies only to FTP option). Enter the user ID and password required for connecting to the UNIX server (as if an FTP client were connecting).

Specifying PeopleSoft Test Framework Settings

If you selected the Enable PeopleSoft Test Framework option, you will need supply PTF connection settings.

Server:Port

Enter the server name and port for the environment. Contact your Integration Broker administrator or system administrator for the correct values.

The format for the Server:Port field is:

<machine_name>:<https_port>

For example:

rtdc79614.us.oracle.com:443

If the https port is the default 443 the port is optional.

You can also enter a complete https URL in this format:

https://<machine_name>:<https_port>/PSIGW/HttpListeningConnector

For example:

https://rtdc79614vmc.dsi-inet.peoplesoft.com:443/PSIGW/HttpListeningConnector
Node ID

This field is required if more than one database is connected to the server. Enter the name of the PeopleSoft node with which the integration gateway is to communicate.

Contact your Integration Broker administrator or system administrator for the correct values.

Execution Options

Specify the name of the Execution Options configuration to use.

Path to PTF Client

Specify the path to the PTF client executable.

The default location is C:\Program Files\PeopleSoft\PeopleSoft Test Framework.

Proxy Information

Select this option to enter details for the proxy server. When you select this option, the proxy information fields are enabled.

Enter the following information for the proxy server:

  • Server: Enter the server name

  • Port: Enter the server port.

  • User: Enter the user ID for the proxy server.

    If you use network authentication, use the DOMAIN\USER format.

  • Password: Enter the password.

Importing and Exporting Upgrade Environments

To save time when creating other jobs or if you are accessing Change Assistant from multiple machines, you can export the environment configuration to a file after you’ve saved it. Change Assistant generates an XML file to store the upgrade environment information.

To export an environment:

  1. Select select File, then select Export Environment.

  2. On the Environments screen, select the environment to export.

  3. On the Export Environments dialog box, navigate to the directory where you want to store the exported XML file.

    By default, the exported file assumes the name of the environment that you specified when you created it.

  4. Click Export.

To import an environment:

  1. Select select File, then select Import Environment.

  2. On the Import Environments dialog box, navigate to and select the XML file storing an exported upgrade environment.

  3. Click Import.

Deleting Upgrade Environments

If you decide to delete an upgrade environment, consider that all the job instances associated with that environment that you created will also be deleted.

To delete an upgrade environment:

  1. Select select File, then select Delete Environment.

  2. On the Delete Environment dialog box, select the name of the environment to delete, and click OK.

  3. Confirm that you are aware that all the jobs associated with the environment will also be deleted.