Patch Installation - PeopleSofthosteddocs.ittoolbox.com/BV011415.pdf · • Data Mover Scripts ......

Patch Installation - PeopleSoft

White Paper

By

B [email protected]

December 2004

Abstract

This document starts with a description of methods/tools available to load a typicalcustom/peoplesoft patch release in a peoplesoft implementation. It discusses indetail an automated method of loading patches using available peoplesoft tools.

Patch Installation - Peoplesoft

Table of contents

1 PREFACE ....................................................................................................................................................1

2 STANDARD PEOPLESOFT PATCH INSTALLATION PROCESS ....................................................2

2.1 PATCH CONTENTS ...................................................................................................................................22.2 PATCH INSTALLATION PROCESS ..............................................................................................................22.3 DISADVANTAGES WITH THE ABOVE PROCESS ..........................................................................................2

3 AUTOMATED PEOPLESOFT PATCH INSTALLATION PROCESS ................................................3

3.1 INTRODUCTION TO UPGRADE ASSISTANT ................................................................................................33.2 PRE-REQUISITES......................................................................................................................................33.3 UPGRADE TEMPLATES .............................................................................................................................4

3.3.1 Creating Custom Templates.............................................................................................................43.3.2 Creating New Chapters....................................................................................................................43.3.3 Creating New Tasks .........................................................................................................................43.3.4 Creating New Steps..........................................................................................................................53.3.5 Modifying Step Properties ...............................................................................................................5

3.4 UPGRADE JOBS ......................................................................................................................................103.5 ADDING CUSTOM DOCUMENTATION FOR CUSTOM CHAPTERS, TASKS AND STEPS................................123.6 ADVANTAGES WITH THE AUTOMATED PROCESS ....................................................................................20REFERENCES................................................................................................................................................21


1

1 Preface

This paper summarizes the patch delivery process from peoplesoft. Later it suggests anautomated method using peoplesoft delivered tools.

Disclaimer

Though the author has tested the method, there is no guarantee that this will work in yourenvironment as is. Slight modification and testing needs to be performed for eachenvironment you want to use the process suggested in this paper.


2

2 Standard P eopleSoft Patch Installation Process

2.1 Patch Contents

The objects delivered in a patch or application update may include changes to batch files, datachanges, database code revisions and objects, record structures, and PeopleCode. In general theupdate contains one or more of the following:

• Project Files• Data Mover Scripts• Installation Instruction Document• Delivered Resolution description document• Delivered Code Details Document

2.2 Patch Ins tallation Process

This section summarises the common steps involved in applying the update contents to yourPeople Soft application environment.

• Perform Database auditing and verify the results.• Application of Project Files using Application Designer• Building of Project Files using Application Designer• Application of DataMover Scripts using DataMover• Any Post update steps of running application engine.

2.3 Disadvantages with the above process

• These instructions are intended for the expert technical user who is responsible for applyingapplication changes to your PeopleSoft system. This user should have a basic understandingof PeopleSoft systems Familiarity with PeopleSoft Upgrade Assistant, PeopleSoft Data Mover,PeopleSoft Application Designer, COBOL compilers, and structure query language (SQL)tools may also be necessary.

• The steps for loading the release is largely manual which may increase the chances of humanerrors.

• Installation time is more in case the content of the update is huge. E.g. multiple projects, datamover scripts or a big release.


3

3 Automate d PeopleSoft Patch Installation Process

To achieve automatic loading of objects, this process would use PeopleSoft Upgrade Assistanttool. The below sections details out how the automation would be achieved using the mentionedtool.

3.1 Introduction to Upgrade Assistant

PeopleSoft Upgrade Assistant helps to assemble and organize all of the steps necessary tocomplete your upgrade. Upgrade Assistant can run some of the steps automatically, while othersmay require you to make changes manually. To run an upgrade using Upgrade Assistant, youmust have an Upgrade Template and an Upgrade Job.

To learn more about Upgrade Assistant features please refer “Peoplesoft Upgrade Assistant”PeopleBook.

3.2 Pre-Requ isites

The table below describes the preparation steps required to load the update/release usingupgrade assistant.

TaskNumber

Task Description

1 Install the Upgrade Assistant in your client PC. Use Peoplesoft Delivered InstallDocument. To install local administrator rights are needed on the workstation

2 Install the Oracle client on the installer's workstation. The Oracle client installationmust include SQLPLUS Executable (SQLPLUS.EXE) file.

3 Update the TNSNAMES.ORA file on the installer's workstation (located in theORA_HOME\...\network\admin folder) to include the TNS information of the targetdatabase

4 Turn off the automatic locking of the workstation on the installer's workstation.

5 Verify the Oracle client installation and the TNS information by executingSQLPLUS.EXE and then signing on to the target database with the database userid. IfPassword is not known then please arrange the database password.

6 Signon to the installer’s workstation with a user id that has local administrator rights onthe workstation.


4

TaskNumber

Task Description

8 (Applicable if you are using Non-English Regional Setting)Change installer’s workstation to use the U.S. English keyboard as follows.Set the windows regional settings to US from German:1. Navigate to Start - Settings – Control Panel – Regional Options2. Write down the existing setting and then make the following change. On theGeneral tab change the 'Your locale (location)' setting to English (United States)3. Write down the existing setting and then make the following change. On the InputLocales tab change the input locale properties for the EN keyboard to US. (This willchange some of the key mapping of the keyboard. For example the keys for the lettersZ and Y and interchanged. Double check what is typed on the screen)

3.3 Upgrade Templates

PeopleSoft Upgrade Assistant uses an upgrade template for each update/release. The upgradetemplate contains the chapters, tasks, and steps for the upgrade and consists of SQL scripts, DataMover scripts, SQR processes, Application Engine processes, and Application Designerprocedures.

The examples in this section describe how to create a custom chapter, steps and tasks. It furtherexplains what parameters needs to be configured for each type of peoplesoft object.

3.3.1 Creating Cu stom TemplatesTo create a custom template:

1. Select the Upgrade Template view.2. Select File, New Upgrade Template.3. Enter the name of the new template and click OK.

PeopleSoft Upgrade Assistant displays the name of your new template in the TemplateTree.

3.3.2 Creating New ChaptersA chapter is a section heading for a group of tasks.To insert a chapter:

1. Highlight the location where you want to add the chapter. If this is the first chapter in thetemplate, highlight the top node (template name) at the top of the Template Tree. If youare adding a task to an existing template, put your cursor where you want to insert thetask.

2. On the Upgrade Assistant toolbar, select Edit, Insert Chapter.3. Enter a unique name for your new chapter and click OK.

3.3.3 Creating New TasksA task is a section heading for a group of steps.To insert a task:

1. Highlight the location where you want to add the task. If you are adding a task to anexisting template, put your cursor where you want to insert the task.

2. On the Upgrade Assistant toolbar, select Edit, Insert Task.3. Enter a unique name for your new task and click OK.


5

3.3.4 Creating New StepsA step can be any process needed to perform the upgrade.To insert steps:

1. Highlight the task where you want to add the new step.2. From the Upgrade Assistant toolbar, select Edit, Insert Step.3. Enter a unique name for your new step and click OK.4. PeopleSoft Upgrade Assistant displays the Step Properties dialog box.5. You must define the step properties for the new step.

3.3.5 Modifying S tep Properties

The examples below consider copying a project, building a project, running build, SQL and data-mover scripts.

Loading of a Project

Here are the values used in the step property.

Script Procedure: Enter the script or procedure, if one is associated with the current step. Thisfield is used for SQL scripts, Data Mover scripts, SQRs, and Application Engine Processes.Type: Copy of a project from File.Parameters: #Project - Name of the Project to be copied #Directory – Path of the Directory where the object is lying.Upgrade Options: Retain same options, as you would use while using Application Designer.


6

Building a Project


Script Procedure: Enter the script or procedure, if one is associated with the current step. Thisfield is used for SQL scripts, Data Mover scripts, SQRs, and Application Engine Processes.Type: Build Project.Parameters: #Project - Name of the Project to be builtBuild Options: Retain same options, as you would use while using Application Designer.


7

Running the Build Script

Here you run the build script generated by the previous step.


Script Procedure: Enter the script or procedure, if one is associated with the current step. Thisfield is used for SQL scripts, Data Mover scripts, SQRs, and Application Engine Processes.Type: SQL ScriptParameters: #Directory - Name of the directory where the SQL file is present #OutputDirectory – Variable pointing to Upgrade Assistant output directory.


8

Running the Custom SQL Script


Script Procedure: Enter the script or procedure, if one is associated with the current step. Thisfield is used for SQL scripts, Data Mover scripts, SQRs, and Application Engine Processes.Type: SQL ScriptParameters: #Directory - Name of the directory where the SQL file is present or #OutputDirectory – Variable pointing to Upgrade Assistant output directory.


9

Running the DataMover Import Script


Script Procedure: Enter the script or procedure, if one is associated with the current step. Thisfield is used for SQL scripts, Data Mover scripts, SQRs, and Application Engine Processes.Type: Data Mover – User or Data Mover - BootstrapParameters: #Directory - Name of the directory where the SQL file is present or #OutputDirectory – Variable pointing to Upgrade Assistant output directory.

Note: In the Data Mover script don’t use absolute path in the SET LOG statement.


10

3.4 Upgrade J obs

Upgrade jobs are used to run automated upgrade steps and monitor the progress of the upgrade.

Creating the Upgrade Job1. Select the Job Status tab on PeopleSoft Upgrade Assistant.2. Select File, New Upgrade Job. The Create New Job File dialog box appears.3. Enter a name for your Upgrade Job, for example, the name of your database.4. Select Save. The Database Configuration dialog box appears:

Note: If the update does not contain any copy from database step, values in the Source are nottaken into account.

Configuring and Editing Options

1. Open the Job2. Select Options, Database Configuration.3. PeopleSoft Upgrade Assistant displays the Database Configuration dialog box.4. Modify your selected options, click OK.5. The Upgrade Template reappears in Job Status view.6. Save your template.


11

Directory Configuration

In this screen PS_HOME, output and staging directories are configured.

Products

In this screen


12

3.5 Adding C ustom Documentation for Custom Chapters, Tasksand Steps

If you have added Chapters, Tasks and/or Steps to a delivered upgrade template or a customtemplate, you may want to add documentation for those items. To do this you will have to edit orcopy existing .htm files which comprise the delivered upgrade documentation.

The examples in this section uses the PeopleTools Only Upgrade template, which is available onCustomer Connection. Similar changes can be made to delivered Application templates.

Upgrade Documentation Overview

Each Chapter within a PeopleSoft delivered template has a corresponding .htm file:

Chapter 1 = Plan Your UpgradeChapter 2 = Prepare Your DatabaseChapter 3 = Install The SoftwareChapter 4 = Apply PeopleTools ChangesChapter 5 = Complete Database Changes

The following .htm files appear in the directory where you installed the upgrade documentation:

Open ch01.htm in an html editor to view the html associated with this chapter. As you scrollthrough the file, you will see the documentation text associated with the chapter, tasks and steps.Notice how the items are tagged

Chapter label: <H1>Chapter 1</H1>Chapter level names: <H2>Plan Your Upgrade</H2>Task level names: <H3>Task Overview</H3>Step level names: <H4>Review DB Orientation Property</H4>

Also notice the use of <a name=>. When clicking on an item in the template, UA searches the.htm files for <a name="itemname"> (note that spaces and commas are stripped from the name.)

To familiarize yourself with how the .htm file corresponds to a particular item in the UA template,open the template in UA and select View -> Documentation. As you click on an item in thetemplate and see its corresponding documentation text appear, locate that item and text in the


13

corresponding .htm file. (You can have the .htm file open in an html editor while UA is accessingit.) Also notice the html used to draw tables and reference .jpg files.

Adding documentation for Custom Steps, Tasks and Chapters.

Below is a screen shot of a template, which contains a custom Chapter, a custom Task and Stepwithin an existing Chapter, and a custom Step within an existing Task. In order to proceed with thisexample, add these items to your template and save the template. Be sure to add the Customitems in the exact locations as shown in this screen capture. You can set the step properties toManual - Stop for the custom steps.

StepFirst we will address Custom Step2 within the existing Task, 'Performing Script Modifications'.Using an html editor, open the .htm file which corresponds to the 'Apply PeopleTools Changes'chapter, ch04.htm. Search the file for the step name which follows the new Custom Step, 'Run aDBTSFIX Report':

<a name="RunaDBTSFIXReport"></a><H4>Run a DBTSFIX Report</H4>

We want to insert custom documentation above this step since our new custom step was addedabove this step. At a minimum you will need to add two lines: one to tag the step name, the otherto contain its assocatiated text. You can copy the existing text and customize as appropriate:

<a name="CustomStep2"></a><H4>Custom Step2</H4><P>This is documentation for a custom step under Performing ScriptModifications. </P>

Note that the space has been removed from the step name for the <a name=> tag. Since we areadding documentation for a step, the <H4> tag is used.

Save the .htm file.

To view the newly added custom documentation, click on this step within the UA template. Youshould see the following:


14

TaskYou will use this same approach to add custom documentation for Custom Task and CustomStep1. Edit the ch04.htm file and locate the task, 'Performing Script Modifications'. Thedocumentation for Custom Task and Custom Step1 will be added directly above this line since thisis where they was added in the template:

<a name="PerformingScriptModifications"></a><H3>Performing ScriptModifications</H3>

The easiest approach is to copy and paste the html associated with the task, Performing ScriptModifications, and the step we added in the example above. You can then simply edit the namesand text content:

<a name="CustomTask"></a><H3>Custom Task</H3><p>This is the documentation for a custom task.</P><a name="CustomStep1"></a><H4>Custom Step1</H4><p>This is documentation for a custom step under Custom Task. </P>

Again, be sure to remove spaces and commas from the <a name=> tags.Save the .htm file.

To view the newly added custom documentation, click on the task and step within the UAtemplate. Verify that the custom documentation appears.


15

ChapterIn order to add documentation for the Custom Chapter, a new .htm file will need to be created. Theeasiest way to do this is to make a copy of an existing .htm file. Make a copy of ch01.html andname it customchapter.htm. Open customchapter.htm in an html editor and edit it so that the textcorresponds with the newly added chapter. In our example, you will need to modify the Chaptertags and associated text, delete the Task/Step tags and text which are not needed. The simplestfile would appear like this:

<html><head><META http-equiv="Content-Type" content="text/html; charset=iso-8859-1"><SCRIPT LANGUAGE="JavaScript" SRC="commonvars.js"></SCRIPT><SCRIPT LANGUAGE="JavaScript" SRC="booklist.js"></SCRIPT><LINK REL="StyleSheet" HREF="content.css"><title>Custom Chapter</title>


16

</head><BODY onLoad="CheckPrint()" onFocus="AfterPrint()">

<P><A NAME="topofpage"></A> <a name="CustomChapter"></a><H1>CustomChapter</H1> <a name="FirstHeading"></a><H2>First Heading</H2> <p>Customchapter text. </P>

</body></html>

Save the .htm file.

To view the newly added custom documentation, click on the custom chapter within the UAtemplate. Verify that the custom documentation appears:

Adding Tables and Graphics

The examples shown above are very simplistic in that only custom text is added. It is possible thatyou may want to add tables and graphics as part of your custom documentation. You can look inthe delivered .htm files for sample code to use.

TablesIn UA, click on the task, 'Updating Statistics' located in the chapter, 'Prepare Your Database'. Thefollowing table appears in the documentation window:


17

To view the html associated with this task, open ch02.htm in an html editor. Search for '<aname="UpdatingStatistics">'.The following html block appears for this task:

<table border=1 cellspacing=0 WIDTH=100%> <tr> <td WIDTH="20%" valign=top style='background:navy;padding:6.0pt 2.0pt6.0pt 2.0pt'> <P CLASS=TABLEHEAD><b>DB Orientation</b></P> </td> <td WIDTH="20%" valign=top style='background:navy; padding:6.0pt 2.0pt 6.0pt 2.0pt'> <P CLASS=TABLEHEAD><b>Initial/MTP</b></P> </td> <td WIDTH="20%" valign=top style='background:navy; padding:6.0pt 2.0pt 6.0pt 2.0pt'> <P CLASS=TABLEHEAD><b>Products</b></P> </td> <td WIDTH="20%" valign=top style='background:navy; padding:6.0pt 2.0pt 6.0pt 2.0pt'> <P CLASS=TABLEHEAD><b>Platforms</b></P> </td> <td WIDTH="20%" valign=top style='background:navy; padding:6.0pt 2.0pt 6.0pt 2.0pt'> <P CLASS=TABLEHEAD><b>Languages</b></P> </td> </tr> <tr> <td WIDTH="20%" valign=top style='padding:6.0pt 2.0pt 6.0pt 2.0pt'> <P CLASS=TABLE>Target</P> </td> <td WIDTH="20%" valign=top style='padding:6.0pt 2.0pt 6.0pt 2.0pt'> <P CLASS=TABLE>Both</P> </td> <td WIDTH="20%" valign=top style='padding:6.0pt 2.0pt 6.0pt 2.0pt'> <P CLASS=TABLE>All</P> </td> <td WIDTH="20%" valign=top style='padding:6.0pt 2.0pt 6.0pt 2.0pt'> <P CLASS=TABLE>All</P>


18

</td> <td WIDTH="20%" valign=top style='padding:6.0pt 2.0pt 6.0pt 2.0pt'> <P CLASS=TABLE>All</P> </td> </tr></table>

You can copy this block of html code and modify it as needed to create your own table.

GraphicsIn UA, click on the step, 'Run the Initial Alter Audit, located in the chapter, 'Prepare YourDatabase', under task, 'Running Initial Audit Reports'.Scroll down to step 12 in the documentation window.

Click on the 'Build dialog box' icon.The following graphic, ch02_0002.jpg, appears:


19

To view the html associated with this step, open ch02.htm in an html editor. Search for'ch02_0002.jpg'.The following html block appears for this task:<P CLASS=EXHIBIT><SCRIPT LANGUAGE="JavaScript">PopupLogic('<imgsrc=ch02_0002.jpg WIDTH=369 HEIGHT=350>','','popup')</SCRIPT> <PCLASS=CAPTION>Build dialog box</P>

You can copy this block of html code and modify it to reference a custom .jpg file.

Additional ResourcesCreating and testing custom documentation is very straightforward, as the above examplesindicate. If your custom Chapters, Tasks and/or Steps require more complex documentation thanthe examples provided in this document, you may want to consult an HTML reference guide.


20

3.6 Advantages with the automated process

• The installer need not be an expert technical user. The instructions are simple and easy tofollow.

• The steps for loading the release are largely automatic which will decrease the occurrence ofhuman errors.

• Reduced installation time

In the tests conducted, on an average 70% reduction in installation time was achieved. Theprocessing time for loading the project and run time of the data mover scripts remained thesame as the manual approach. This approached greatly reduced the time taken by theinstaller to read and execute the instructions manually.

In a typical test scenario, a large update was prepared with the following contents:

• Loading and Building of 10 Projects in Sequence. The Build options were different foreach project.

• Loading of 8 Datamover Scripts• Running 4 Data Migration SQL scripts

Same target environments were used.

In the manual approach, the installation was completed in 45 MinsIn the automatic approach with upgrade assistant, installation completed in 12 mins.


21

References

• Upgrade Assistant PeopleBook• Peoplesoft Customer Connection Knowledge-base• Application Designer PeopleBook

Patch Installation - PeopleSofthosteddocs.ittoolbox.com/BV011415.pdf · • Data Mover Scripts ......

Documents

Transcript of Patch Installation - PeopleSofthosteddocs.ittoolbox.com/BV011415.pdf · • Data Mover Scripts ......