Using the Upgrade Workspace

This section provides an overview of using the upgrade workspace.

When you perform an upgrade with PeopleSoft Application Designer, select the Upgrade tab at the bottom of the project workspace to switch to the upgrade view.

Image: Records (Upgrade Definition Type)

The upgrade view of the project workspace shows all of the definition types in the project that are available for upgrade—not only those that PeopleSoft Application Designer can modify, as in the development view. The upgrade definition window displays the definitions in the project and their upgrade settings. One definition type appears at a time.

Displayed here are the upgrade attributes for all record definitions in the selected project.

Records (Upgrade Definition Type)

To view the upgrade attributes by definition type in a project:

  1. Open a project.

  2. Select the Upgrade tab at the bottom of the project workspace.

  3. Double-click a folder to open the upgrade definition window.

    With the exception of PeopleCode, the folders in the upgrade view are not expandable. The upgrade definition window contains a grid with definitions in the project that are of the selected type. For example, if you double-click the Records folder in the upgrade view, the upgrade definition window displays the records in the project.

    You can view only one upgrade definition window—and one definition type—at a time. When you double-click another definition type in the upgrade view, the upgrade definition window is refreshed with the new definitions of that type.

    Note: You can filter which definitions are displayed in this window. By default, no filtering is applied.

The columns in the upgrade definition window display various information about each definition.

Field or Control

Definition
Key

Displays the name of the definition, plus any other key values. The number and titles of the key columns vary, depending on the definition type.
Source

Displays the definition status in the source (current) database.
Target

Displays the definition target database status.
Action

Displays the action that is performed if the definition is copied into the target database.
Upgrade

Select to upgrade the definition during a copy.
Done

Is selected when the definition has been copied. You can't select Done check boxes yourself—PeopleSoft Application Designer does this after a copy—but you can clear them. Only definitions that have Upgrade selected and Done cleared are copied during an upgrade.
Execute

Only applies to file references and Application Engine definitions. Allows file references and Application Engine definitions to be executed when applying a change package.

The key columns on the left-hand side of the grid are frozen; they do not scroll horizontally. When you use the horizontal scroll bar, only the upgrade columns scroll, enabling you to see the key information about the definitions at all times. The various definition types have different numbers of key columns. For example, fields have only one column (Field Name), while translates have four (Field Name, Field Value, Language Code, and Effective Date).

When viewing definition types with a large nonscrolling region, the horizontal scroll bar is disabled unless at least one scrolling column is displayed.

To enlarge the window enough so that you can scroll through the upgrade columns:

  • Maximize the upgrade definition window.

  • Maximize PeopleSoft Application Designer.

  • Hide the project workspace.

To display all of the grid columns at one time when the preceding options don't enable you to see every column, use the zooming commands in the View menu. With each Zoom Out command, the grid size is reduced. To restore the normal view, select 100%.

You can also resize individual columns by dragging the column border to the appropriate size. If you resize the upgrade columns, save the sizing and use it for every project. Custom key column sizing is not preserved after you close a project; these columns reset to their default size.

To access the pop-up upgrade menu, right-click anywhere in the grid in the upgrade definition window.

This table describes the upgrade menu actions and the actions they perform:

Menu Item

Action

View Definition

Opens multiple definitions in the upgrade grid.

View PeopleCode

Opens the PeopleCode Editor. This is enabled for PeopleCode definition types.

Find Definition References

Finds all references to the selected definition.

Merge Definition

Enables you to compare and merge text definitions between two sources, either a file or another database. Text definitions are PeopleCode, SQL, XSLT, and HTML.

Diff / Merge Page

Enables you to compare (side-by-side) page definitions between two sources, either a file or another database, and merge the definitions.

Filtering

Opens a cascading menu with filtering options that you can apply to the upgrade grid. These same options are also in the View menu.

Refresh View

Updates the information in the upgrade definition window.

Set Action

Enables you to select and tag definitions for copying and deleting.

Set Action for Project

Enables you to select and tag all definitions in a project for copy or delete.

Tag for Upgrade

Enables you to tag a group of definitions for upgrade.

Untag for Upgrade

Enables you to remove the tag on a group of definitions for upgrade.

Reset Done Flag

Enables you to reset Done check boxes for a group of definitions.

Reset Project Done Flags

Enables you to reset all Done check boxes.

Insert Definitions into Project

Opens the Insert Definitions into Project dialog box.

Remove from Project

Removes the selected definitions from the current project. You can also use the Delete key.

Project Properties

Opens the Project Properties dialog box, in which you define properties for the project, like description.

This section discusses how to:

  • Access the upgrade options.

  • Set general options.

  • Set compare options.

  • Set report options.

  • Set report filter options.

  • Set copy options.

Accessing the Upgrade Options

To access the upgrade options:

  1. Select Tools > Compare and Report.

  2. Sign in to an upgrade target database.

  3. On the Compare and Report dialog box, click Options, and select the appropriate upgrade option tab.

Preserving Project Item Status

Access the Compare and Report dialog box and view the Project Item Status/Child Definitions group box.

Setting General Options

Image: Upgrade Options dialog box: General Options tab

This screenshot is an example showing how to set values in Upgrade Options dialog box as in the General Options tab. . You can find definitions for the fields and controls later on this page.

Upgrade Options dialog box: General Options tab

Use the Upgrade Options dialog box to set general options for the Compare or Copy process.

Field or Control

Definition
Commit Limit

Set the commit limit.

Start with the default of 50. If the Copy process seems slow and there is sufficient log file space, try increasing the commit limit. You can modify the initial project default commit limit on the PeopleTools Options page.

Very large commit limits, however, can cause more work if something goes wrong during the copy. For example, if the commit limit is set to 1,000 and the Copy process stalls on the 999th definition, none of the previous definitions are copied. The Copy process must be performed again.

Audit Flags on Records

Select one:

  • Keep Target Audit Flags: Select to preserve all of the enabled target flags. This is the default. Audit flags that are enabled in the source are also retained. Differences between the source and target audit flags are not shown on the compare report.

  • Set Target Audit Flags from Source: Select to copy audit flag settings from the source to the target database.

DDL on Records and Indexes

Select one:

  • Keep Target DDL: Select to preserve the target DDLs. This is the default. Differences between the source and target DDL are not shown on the compare report.

  • Take DDL from Source: Select to copy the DDL from the source to the target database.

Note: For Oracle customers using partitioning on records and indexes, the partitioning is not migrated with the record or index. To migrate the partitioning use Data Migration Workbench and create a project containing the data set definition PTTBLIDXPART. See Maintaining Partition Definitionsand Defining ADS Project.
Portal Structures Permission List

Select one:

  • Keep Target References: Select to preserve the target portal structures permission list references. This is the default.

  • Set References from Source: Select to copy the portal structures permission list references from the source to the target database.
Chartfield Options

Set the Display Size Page Property:

  • Keep Target Display Size: Does not copy any display changes to a ChartField on the source database (the target values are saved). If this is set for a Compare process, no differences between the source and target in the named fields are displayed. If the only differences on the page are the ChartField display properties, then the page compares as the same for both.

  • Set Display Size from Source: Copies the position, as well as the size and type attributes, from the source to the target database.

Set the Database Field Format:

  • Keep Target Field Format: Does not copy any changes to the field format values for a database field that is a ChartField on the source database, and preserves the target field format values. If this is set for a Compare process, any changes to the ChartField field format attributes are not displayed. If these attributes are the only changes for a field, then the definition compares as the same for both.

  • Set Field Format from Source: Copies the ChartField field format attributes from the source to the target database.
Permission List, Roles, Menus

If Roles, Menus or Permission Lists are renamed or cloned, this information is tracked in tables that store the original name. This information is used by PUM Security Automation when change packages are created to apply updates.

Select one:

  • Keep Target Origin

    Select to preserve the tracking tables for these definitions.

    Note: This option is primarily used for PUM updates.

  • Set Origin from Source

    Select to overwrite the tracking tables for these definitions on the target. This is the default.

    Note: This option is primarily used for project copies executed in Application Designer, such as development to test.

Note: Roles are not copied in projects. Roles are only copied in Data Mover scripts. For PUM updates, the PUM Security Automation will create these data Mover scripts.

Setting Compare Options

Image: Upgrade Options dialog box: Compare Options tab

Access the Upgrade Options dialog box and select the Compare Options tab to complete setting compare options. You can find definitions for the fields and controls later on this page

Upgrade Options dialog box: Compare Options tab

Field or Control

Definition
Compare Type

Select Project to compare only the definitions of the specified definition type in the current project. The contents of the project do not change.

Select Database to compare all definitions of the specified definition type. If you select Database, the contents of the current project are deleted and replaced with definitions that are found during the comparison.
Target Orientation

Determines how the Upgrade check boxes in the upgrade definition window are set for definitions that were last modified by the customer in one database and last modified by PeopleSoft in the other database.
Comparison

Select Release to compare databases by the highest release that the two databases have in common. Use the drop-down list box to select from lower common releases. The Compare process labels definitions as Changed or Custom/Changed if they have been changed since the date and time stamp for that release level. This is the default.

Select Date to have the Compare process label definitions as Changed or Custom/Changed if they have been modified since the date that you specify.

Use LastUpdDttm (last update date and time) and LastUpdOprid (last user to update definition) to improve the performance of the compare process for larger compare projects. If these options are selected, Application Designer uses only these values to assess differences between PeopleCode definitions. If it is determined that the LastUpdDttm and/or LastUpdOprid are the same, Application Designer assumes that the rest of the attributes are the same and moves on to the next definition in the project. If it is determined that the PeopleCode definitions are different, Application Designer proceeds to compare all attributes of the definition as normal.

Note: LastUpdDttm and LastUpdOprid apply only to PeopleCode definitions.
Compare Languages

Select the languages of definitions that you want to compare, and select COMMON, which specifies basic definition characteristics and parameters in the architecture that are not language-sensitive. Language options specify label-oriented characteristics of a definition, such as page names, labels, and messages. If you do not select COMMON, basic definition characteristics are omitted.

If you need specific languages and basic definition characteristics, also select COMMON. However, to compare only language attributes of a definition, you do not need COMMON.

Clicking Select All is the recommended default.

Press the Ctrl key and your mouse to clear unwanted languages.
Checkboxes for Compare by LastUpdDttm and Compare by LastUpdOprid

Since Compare by LastUpdDttm and Compare by LastUpdOprid are a customization bypass, the process will skip the comparison if LastUpdOprid = PPLSOFT or if the LastUpdDttm has the same value on both the source and target databases.

Setting Report Options

Image: Upgrade Options dialog box: Report Options tab

The following screenshot is an example showing how to set values in report options. Access the Upgrade Options dialog box and select the Report Options tab. You can find definitions for the fields and controls later on this page

Upgrade Options dialog box: Report Options tab

Field or Control

Definition
Report Output

  • Directory: Displays the compare report output directory. To change the output directory path, select Tools > Options from the PeopleSoft Application Designer toolbar, and select the General tab.

  • Font and Size: Displays the font type and size that will appear in the compare report output. Click Font to select a different font or to change the font size.

  • Generate Traditional Reports: Select this option to create traditional workspace (PRN) reports that are displayed in Application Designer.

    See Working With Workspace Reports

  • Generate Browser Reports: Select to generate HTML reports that you can view in a browser in addition to the reports that appear in the Application Designer workspace.

    See Working with Browser Reports.

  • Generate Output to Tables: Select this option to write the compare output to database tables. This enables you to keep a historical record of your compares in your database, and it also provides you the flexibility of being able to design custom queries for analyzing specific definitions, attributes, and so on. The following PeopleTools tables store compare data:

    • PSCOMPSESSION: Contains high-level information related to the compare, such as project name, target database name, source database name, session type, and so on.

    • PSCOMPOBJDIFF: Contains data related to the individual definitions that are being compared, including definition type, definition name, source status, target status, and so on, as well as specific data for the individual attributes compared.

  • Include values that are same: This checkbox only applies to the compare results that are written to tables (generate output to tables option).

    If selected that definitions with same-same will be written to the tables. Any values that are same-same for the source and target are not displayed on compare reports.

  • Generate PrintProject Reports: Select this option to create PrintProject style compare report definition.

    See Working With PrintProject Reports

  • Generate Composite Reports: Select to generate a composite report, which is a subset of information showing only the definitions customized at your site that were also modified in the most recent PeopleSoft release.

    • Old Release Report Output Directory: Enter the directory containing the compare reports run on the database for your previous PeopleSoft installation: the database from which you are upgrading.

    • Old Release Source Database Name: Enter the source database name you specified when running the compare reports on your previous PeopleSoft installation. This enables the system to identify the appropriate database definitions listed within the compare reports.

      See Working with Composite Reports.

Note: If no output options are selected, traditional reports will be produced. You can select multiple output options.
PeopleCode Report

Specify the PeopleCode report options.

For PeopleCode compare reports, specify whether to show the entire program on the report (the default setting) or only the code differences between the source and target. If you select the latter, you can specify the number of code lines to show above and below the difference for context. The values for the number of lines to show are 0 to 99. A value of 0 shows only the difference line. A value greater than 0 shows that many lines above and below the difference line.

Note: The PeopleCode report options are global across all projects. Changing settings for one project changes all subsequent PeopleCode compares, regardless of project.
Report Data Color

Select the report data color.

Use the Browse button to display the standard color dialog box. Choose a color that is not included in the drop-down list box or create a custom color.

  • Additions: Select a color for additional data values on the source database. These are also source-only values. The default value is dark green.

  • Deletions: Select a color for data values that are deleted from the source database. These are target-only values. The default value is red.

  • Differences: Select a color for changed values, which are both source and target values. The default value is blue.

Setting Report Filter Options

Image: Upgrade Options dialog box: Report Filter tab

The following screenshot shows how to set up report filter options. Access the Upgrade Options dialog box and select the Report Filter tab.

Upgrade Options dialog box: Report Filter tab

When you perform a comparison, the system generates a report for each definition type compared. These reports provide detailed information about how each definition in the source differs from its counterpart in the target.

Before performing a comparison, you can select the definition status combinations with which you generate reports by using report filter options. For example, during an upgrade to a new PeopleSoft release, you might decide that if a definition that was last changed in the target by PeopleSoft is found in the source and it hasn’t changed since the last upgrade, you don’t need to see information about the definition differences (because you intend to accept the new PeopleSoft version). In this case, you want to filter the compare reports so that a report is not generated if:

  • The source is any status.

  • The target is unchanged.

Note: Filtering comparison reports does not affect which definitions are added to a project during a database comparison, only which definitions are reported. Definitions that are defined differently in the two databases are always added to the project.

Select the check boxes corresponding to the definition status combinations that you want to report.

Each row in the matrix corresponds to the definition status in the source database. Each column corresponds to the definition status in the target.

The default settings for report filtering show conflicting configured definitions only.

  • To reset your selections to the default setting, click the Default button.

  • To select all definition status combinations, click the Select All button.

  • If you don't want to generate any reports, click the Deselect All button to clear all of the check boxes.

Setting Copy Options

Image: Upgrade Options dialog box: Copy Options tab

The following screenshot shows the significance of setting copy options. Access the Upgrade Options dialog box and select the Copy Options dialog box.

Upgrade Options dialog box: Copy Options tab

Field or Control

Definition
Copy Languages

Select a specific language for label-oriented characteristics of a definition, such as page names, labels, and messages.

COMMON, specifies basic definition characteristics and parameters in the architecture that are not language-sensitive. Select COMMON when you select English. Do not select COMMON when you select a language other than English.

If you do not select COMMON, basic definition characteristics are omitted.

Make sure that the enabled languages in the source and target databases match. Otherwise, you might overwrite translations in the target. Use the Ctrl key and your mouse to clear unwanted languages.

When you save the project, the copy settings that you made are saved and remain set unless you change them again.

This table lists translation scenario examples:

Selection

Reason

COMMON and English

The source database does not include translations, but the target database has translations that you do not want to overwrite.

Languages (omit COMMON)

You sent the database out for translations and want to avoid copying inadvertent changes that were made by the translators to the definitions.

COMMON (omit languages)

You want to copy the source without translations to the target.