Project Management Framework

Transcription

1 Project Management Framework UPGRADE GUIDE

2 Copyright 2015 Pegasystems Inc., Cambridge, MA All rights reserved. This document describes products and services of Pegasystems Inc. It may contain trade secrets and proprietary information. The document and product are protected by copyright and distributed under licenses restricting their use, copying, distribution, or transmittal in any form without prior written authorization of Pegasystems Inc. This document is current as of the date of publication only. Changes in the document may be made from time to time at the discretion of Pegasystems. This document remains the property of Pegasystems and must be returned to it upon request. This document does not imply any commitment to offer or deliver the products or services provided. This document may include references to Pegasystems product features that have not been licensed by your company. If you have questions about whether a particular capability is included in your installation, please consult your Pegasystems service consultant. PegaRULES, Process Commander, SmartBPM and the Pegasystems logo are trademarks or registered trademarks of Pegasystems Inc. All other product names, logos and symbols may be registered trademarks of their respective owners. Although Pegasystems Inc. strives for accuracy in its publications, any publication may contain inaccuracies or typographical errors. This document or Help System could contain technical inaccuracies or typographical errors. Changes are periodically added to the information herein. Pegasystems Inc. may make improvements and/or changes in the information described herein at any time. This document is the property of: Pegasystems Inc. 1 Rogers Street Cambridge, MA Phone: (617) Fax: (617) Document: Project Management Framework Software Version: Updated: February 2015

3 Contents Overview 1 Intended Audience 1 1. Database 1 2. Pega 7 1 Prerequisites 2 1. Database 2 2. Pega Hot Fixes 2 Pre-Upgrade Steps 3 1. Schema Update for PMF Execution 3 Verification 3 Upgrade the Framework 5 1. Import the Application Bundle 5 2. Restart the Application Server 7 3. Verify Upgraded Rulesets 8 Test the Upgrade 9 Post-Upgrade Steps PMF to PMF Convert existing notes to PegaPulse posts 10 Execution 10 Verification 12 Convert Owner role to Product Owner role 13

4 Execution 14 Verification 14 Update Related Item Counts 15 Execution 15 Verification 15 Update Task Efforts 16 Execution 16 Verification Any Previous Version to PMF Epic Status Change Notifications 17 Execution 17 Verification 18 Convert Owner subscript to Product Owner subscript. 19 Execution 19 Verification 19 Update Backlog Story Rank 20 Execution 20 Verification 21 Update Open-InProgress Stories 22 Execution 22 Verification 22 Initialize Team Scheduler Data 23 Execution 23 Verification 24

5 Add Existing Sprints To Team Scheduler 25 Execution 25 Verification 25 Convert to Rich Text Editor 26 Execution 26 Verification 26 Establish Connectivity to a Development System 28 Process Commander 6.2 or later 28 Process Commander 6.1 SP2 or earlier:install Communication Links Verify Prerequisites Import a Ruleset and Configure the System Verify the Communication RuleSet 31

6 Overview This document provides instructions for upgrading Project Management Framework (PMF ) Version To perform a new installation of the framework, use the document titled Installation Guide. Intended Audience This document assumes the installer has the following administration skills and capabilities: 1. Database Perform basic SQL tasks, such as running database scripts in the database management system used for your Pega 7 database 2. Pega 7 Find and update rule forms Use Pega 7 Import/Export utilities Optionally, work with Windows BAT or Unix SH scripts Optionally, use the System Management Application 1

7 Project Management Framework Version Prerequisites Before you begin the PMF upgrade process, verify that the following prerequisites have been met. 1. Database Oracle SQL Server DB2 PostgreSQL Note: All customers who are installing on a UTF-8 encoded database should perform the steps described in the PDN article referenced below before proceeding with the installation. Ensure that a backup copy of the PegaRULES database has been created. Because the upgrade process is not reversible and may overwrite existing rules and data, creating a database backup will provide you the means to restore the system to a pre-upgrade state in the event of a failed or incomplete upgrade. 2. Pega 7 Pega is installed and verified. The highest Pega 7 Ruleset Version is To upgrade Pega 7, use the Pega Upgrade Guide 5.x to Hot Fixes Apply the following hot fixes to Pega 7 before proceeding with the framework upgrade. Hotfixes\DL zip 2

8 Pre-Upgrade Steps Pre-Upgrade Steps These steps are only necessary when upgrading from PMF to PMF They should not be run when upgrading from PMF 7.1 or PMF Schema Update for PMF Several existing columns have been modified to reduce the number of decimal places captured and displayed. Execution The script SchemaUpdate711 is available for all supported databases and is located in the PreUpgrade folder of the release media. It should be executed prior to importing the RAP. Verification Each of the following columns should be configured for 0 decimal places: ppm_remainingefforttrack.openbugcounthighpriority ppm_remainingefforttrack.openbugcountmediumpriority ppm_remainingefforttrack.openbugcountlowpriority Column ppm_work.totalactualdays should be configured for 2 decimal places 3

9 Upgrade the Framework Follow the steps below to upgrade the Framework. 1. Import the Application Bundle 1. Log in to your Process Commander system ( using the following user name and password: User Name Password install 2. From the DesignerStudio menu select Application > Distribution > Import. 3. Select Local Zip File as the Import Mode. 4. Browse for the following file and click Next>>: RuleSets/Upgrade/PegaProjectQualityMgmtAppUpgrade712 5

10 Project Management Framework Version After the file is uploaded, it is ready to be imported. From the Import wizard, select the file. Click Next>>. Note: Do not check the Enable advanced mode to provide granular control over the import process checkbox. 6. The Application Bundle contains information on the database schema needed for the framework. The wizard compares the database schema of your current system with the requirements of the framework, and identifies any differences. If any differences are found, the following screen appears: Under certain conditions, the wizard can apply the schema changes directly. The Operator ID has all the Process Commander privileges needed, but additional conditions must be met. For details. see PDN article PRKB How to set privileges to restrict database changes made by Process Commander tools. For DB2 databases only, the generated DDL cannot be applied automatically by PRPC. It must be downloaded and applied by a DBA, who may add REORG commands as needed. 6

11 Upgrade the Framework 7. Pegasystems recommends using the automatic option whenever possible. If possible, choose the Automatic option (as defaulted). Click Next>> to instruct the wizard to apply these changes automatically. Select Manual if you are installing into a production Process Commander system (production level 5), or your system or organization does not allow direct schema changes. Click View/Download DDL SQL to produce a text file containing Data Definition Language statements for the needed changes. Save the DDL file produced and deliver it to a database administrator. You cannot perform additional Wizard steps at this point. After a database administrator has applied the DDL, repeat the Import wizard steps; the screen (above) does not reappear. Note: The number of records shown may be different for the framework you are installing. 8. After automatically applying schema changes, click Next to complete the import. 9. When the final import is complete, click the red X on the tab to close. 10. Optionally, for best performance and initial user experience, run the static assembler to pre-assemble the rules in the framework applications. The static assembler does not change the function or results of your applications, but eliminates the one-time rules assembly processing that users experience after startup. This command-line facility uses a script included in the Process Commander installation media, and must be run at a time when the Process Commander system is down, not available to users. To prepare, identify the exact name of each application rule and a corresponding access group. For instructions, see PDN article PRKB How to use the static assembler to pre-assemble the rules in an application. 2. Restart the Application Server Logout of Pega 7. Clear the cache from Pega 7, stop and start the application server. 7

12 Project Management Framework Version Verify Upgraded Rulesets The following lists the highest level Ruleset versions loaded by the upgrade process. Verify that your system includes these Ruleset versions. Note: If your system does not contain the following Rulesets, the installation procedure was not successful. 1. Login to the system as: User Name Password PMSysAdmin install 2. From the DesignerStudio select Application > Structure > RuleSet Stack. 3. Verify that the following RuleSet versions are listed. PegaCustFoundation PegaProjectMgmt PegaProjectSched:

13 Test the Upgrade Test the Upgrade Complete the following steps to verify that the Project Management Framework upgrade process has completed successfully. 1. Login to the system as: User Name Password SrProjectManager install 2. Confirm that your portal display is similar to this image: # # # # # 9

14 Project Management Framework Version Post-Upgrade Steps 1. PMF to PMF These steps are only necessary when upgrading from PMF to PMF They should not be run when upgrading from PMF 7.1 or Convert existing notes to PegaPulse posts PMF makes use of the PegaPulse feature for commenting on and discussing PMF cases in place of notes. If you wish to see your existing notes after upgrading to PMF 7.1.2, you must run this utility to convert them to PegaPulse posts. You can choose to convert all, some, or none of your existing notes. Note that each PegaPulse post is only visible to users that are in the same application and the same workgroup as the user who created it. Execution 1. Create an operator ConvertNotesOperator which has the same application and workgroup as production operators, and which has access to the Designer Studio portal. 2. Login as ConvertNotesOperator. 3. Open activity PegaProjMgmt-Work.ConvertNotesToSocial. 10

15 Post-Upgrade Steps 4. Under the Actions menu, select Run. 5. On the execution modal, there are three parameters: workitemprefix Enter a work item prefix to process notes on only certain work types. For example, entering US would limit the conversion to only notes that are on user stories. This can be used to process only certain notes, or to process the conversion in several smaller groupings rather than all at once. Leaving this blank will cause notes to be converted regardless of the work item prefix of the work item the notes are on. Status Enter a status prefix to process notes on only work items of certain statuses. For example, entering Open- would limit the conversion to only notes that are on work items whose status begins with Open. This can be used to process only certain notes (for example to exclude notes on resolved items), or to process the conversion in several smaller groupings rather than all at once. Leaving this blank will cause notes to be converted regardless of the status of the work item the notes are on. PRD_and_RLSE_Only Check to process notes on only product and release work items. Leaving this unchecked will cause notes to be converted other work types in addition to products and releases. Leaving all parameters with their default values will cause all existing notes in the system to be converted. 6. Click Run. The time required for the conversion process to complete will depend on system attributes as well as the number of notes being converted. In our own conversion we processed about 500 notes per minute. On completion, the Operation completed screen displays. 11

16 Project Management Framework Version The progress of the process can be viewed in the PegaRULES log a message will be displayed on the log for each batch of 1000 records process. Verification 1. On completion, the Operation completed screen displays. 2. The progress of the process can be viewed in the PegaRULES log a message displays on the log for each batch of 1000 records process. Error messages and final status also displays in the log. 3. Any work item notes included in the conversion based on the parameters selected is now displayed on the work item as a PegaPulse post. 12

17 Post-Upgrade Steps Convert Owner role to Product Owner role In PMF 7.1.2, the Owner role for epic team members has been renamed to Product Owner. We have provided a utility activity to convert existing team members with the Owner role to the Product Owner role. 13

18 Project Management Framework Version Execution 1. Login as an operator with access to the Designer Studio portal. 2. Open activity PegaProjMgmt-Work-UserStory-Epic.ConvertRoleOwnerToProductOwner. 3. Under the Actions menu, select Run. 4. On the execution modal, leave all default values unchanged, and click Run. Verification 1. On completion, the Operation completed screen displays. 14

19 Post-Upgrade Steps 2. The progress of the process can be viewed in the PegaRULES log. Error messages and final status also display in the log. 3. Any epic team member previously in the Owner role is now assigned the Product Owner role instead. Update Related Item Counts A new table has been introduced in PMF PPM_RELATEDITEMCOUNTS. This table stores count of the attachments, tags, dependencies, related updates, notes, and likes for each PMF work object. When upgrading from PMF 6.3.1, the initial counts for pre-existing work items must be set using the stored procedure RefactorCounts in order for related item counts to be processed and displayed correctly. Execution The procedure RefactorCounts is available for all supported databases and is located in the PostUpgrade folder of the release media. It should be compiled and deployed in the PMF database and executed. Verification For any known existing work object with attachments, tags, or related updates run the query, replacing <work item ID> with the actual work object ID: SELECT ATTACHMENTSCOUNT, TAGSCOUNT, RELATEDUPDATESCOUNT FROM PPM_ RELATEDITEMCOUNTS where WORKITEMID = '<work item ID>'; The result shows the actual number of attachments, tags and related updates present on the work object. The bug shown below has two attachments, 1 tag, and 0 related updates. 15

20 Project Management Framework Version Update Task Efforts In PMF 7.1.2, we have improved the way we capture and process resource efforts. Existing task efforts must be upgraded to the new format. Execution 1. Create an operator PreUpgradeEffortOp which has the same access group as operator PMSysAdmin. 2. Login as PreUpgradeEffortOp. 3. Open activity PegaProjMgmt-Work.UpgradeActualEffort. 4. Under the Actions menu, select Run. 5. On the execution modal, leave all default values unchanged, and click Run. Verification 1. On completion, the Operation completed screen displays. 16

21 Post-Upgrade Steps 2. The number of tasks and bugs processed also displays in the log. 3. Total Hours Spent in the in the Effort Tracking section of various case types will reflect hours entered prior to the upgrade. NOTE: If this needs to be rerun for some reason, run the following DB script prior to rerunning to avoid creating duplicate effort records: DELETE FROM PPM_RESOURCEEFFORTTRACKING; COMMIT; 2. Any Previous Version to PMF These steps are necessary when upgrading from any previous PMF version to PMF 7.1. If you are upgrading from PMF 6.3.1, these steps should be run after the steps listed in the Post-Upgrade Steps PMF to PMF section above. Epic Status Change Notifications In PMF 7.1.2, we have provided an option to receive notifications when the status of a followed epic changes. Current epic status must be initialized for this feature to work correctly. Execution 1. Login as an operator with access to the Designer Studio portal. 17

22 Project Management Framework Version Open and run activity PegaProjMgmt-Work. UpdateStatusWorkOldOnEpics. 3. Under the Actions menu, select Run. 4. On the execution modal, leave all default values unchanged, and click Run. Verification 1. On completion, the Operation completed screen will be displayed. 18

23 Post-Upgrade Steps Convert Owner subscript to Product Owner subscript. In PMF 7.1.2, the Owner role for epic team members was renamed to Product Owner. This step will update the party subscripts in a corresponding manner. Execution 1. Login as an operator with access to the Designer Studio portal. 2. Open activity PegaProjMgmt-Work. UpdateWorkPartySubscriptOnEpics. 3. Under the Actions menu, select Run. 4. On the execution modal, leave all default values unchanged, and click Run. Verification 1. On completion, the Operation completed screen will be displayed. 19

24 Project Management Framework Version Update Backlog Story Rank In PMF changes have been made to the processing of backlog story rank to provide improved functionality and performance. We have provided an activity to update existing backlog stories to take advantage of this change. Execution 1. Login as an operator with access to the Designer Studio portal. 20

25 Post-Upgrade Steps 2. Open activity PegaProjMgmt-Work. UpdateApplicationBacklogCoveredItems. 3. Under the Actions menu, select Run. 4. On the execution modal, leave all default values unchanged, and click Run. Verification 1. On completion, the Operation completed screen will be displayed. 2. The progress of the process can be viewed in the PegaRULES log. Error messages and final status will also be displayed in the log. 21

26 Project Management Framework Version Update Open-InProgress Stories In PMF 7.1.2, open stories in an open sprint must have a status of Open-InProgress. We have provided a utility to update existing stories in any open sprints to the correct status. Execution 1. Login as an operator with access to the Designer Studio portal. 2. Open activity PegaProjMgmt-Work. UpdateOpenReadyStoriesForInProgressSprint. 3. Under the Actions menu, select Run. 4. On the execution modal, leave all default values unchanged, and click Run. Verification 1. On completion, the Operation completed screen will be displayed. 22

27 Post-Upgrade Steps 2. The progress of the process can be viewed in the PegaRULES log. Error messages and final status will also be displayed in the log. View any open sprint containing open stories the status of all stories will be Open-InProgress. Initialize Team Scheduler Data In PMF a new feature has been introduced to allow users to view and update the past and planned future work for sprint teams in a schedule view. We have provided an activity to initialize data for existing teams and sprints. Execution 1. Login as an operator with access to the Designer Studio portal. 23

28 Project Management Framework Version Open activity PegaProjMgmt-Work. UpdateUserStoryPrevSprIDForScheduler. 3. Under the Actions menu, select Run. 4. On the execution modal, leave all default values unchanged, and click Run. Verification 1. On completion, the Operation completed screen will be displayed. 2. The progress of the process can be viewed in the PegaRULES log. Error messages and final status will also be displayed in the log. 24

29 Post-Upgrade Steps Add Existing Sprints To Team Scheduler In PMF a new feature has been introduced to allow users to view and update the past and planned future work for sprint teams in a schedule view. We have provided an activity to add actual efforts for current and past sprints to team schedules. Execution 1. Login as an operator with access to the Designer Studio portal. 2. Open activity PegaProjMgmt-Work. UpdateRealDataForScheduler. 3. Under the Actions menu, select Run. 4. On the execution modal, leave all default values unchanged, and click Run. Verification 1. On completion, the Operation completed screen will be displayed. 25

30 Project Management Framework Version The progress of the process can be viewed in the PegaRULES log. Error messages and final status will also be displayed in the log. Convert to Rich Text Editor In PMF 7.1.2, several properties have been updated to make use of the Rich Text Editor. Existing data in these properties must be converted to the new format. Execution 1. Login as an operator with access to the Designer Studio portal. 2. Open activity PegaProjMgmt-Work. UpgradeTextAreaToRTE. 3. Under the Actions menu, select Run. 4. On the execution modal, leave all default values unchanged, and click Run. Verification 1. On completion, the Operation completed screen will be displayed. 26

31 Post-Upgrade Steps 2. The progress of the process can be viewed in the PegaRULES log. Error messages and final status will also be displayed in the log. Speed will vary, but in our tests, the utility converts approximately 1000 cases per minute. The utility will process all existing bugs and user stories. 27

32 Project Management Framework Version Establish Connectivity to a Development System To use PMF to manage activities for applications, you must perform some set up tasks to establish connectivity between the server hosting the Process Commander system running PMF and the separate Process Commander environments hosting the development system. Note: The development systems should be located on a Process Commander instance that is separate from the instance hosting PMF. The development system instances must be deployed on different servers than the PMF server in order for all PMF features to work as designed. Process Commander 6.2 or later If your development system is Process Commander 6.2 or later, you do not need to install files on your development instances in order to allow PMF connectivity. Reference the user guide on the PDN for instructions on how to enable PMF connectivity to your 6.2 or later development instances. Process Commander 6.1 SP2 or earlier: Install Communication Links If your development system is Process Commander 6.1 SP2 or earlier, you must import an updated PMF RuleSet and complete some configuration on the system to establish communication links to the Process Commander systems hosting the applications. Complete the following steps to configure the Process Commander system. To use PMF to manage development activity in more than one system, repeat the steps below for each system. 1. Verify Prerequisites Before installing the rules for the framework s communication links into a development system, verify that the following prerequisites have been met: PMF has been installed and verified in a Process Commander instance that is separate from the Process Commander system. The system is one of the following PegaRULES Process Commander versions: V6.1 SP2, V6.1 SP1, V5.5 SP1, V5.4 SP3, or V5.4 SP2. For a V6.1 SP1 or V6.1 SP2 system,verify that the installed Pega-ProcessCommander RuleSet version is not lower than For a V5.5 SP1 system, verify that the installed Pega-RULES RuleSet version is not lower than

33 Establish Connectivity to a Development System For a V5.4 SP2 or V5.4 SP3 system, verify that the installed Pega-RULES RuleSet version is not lower than Import a Ruleset and Configure the System This step describes how to import the RuleSet and supporting configuration that sets up the communication link between the framework and a system. Files for each of the supported versions are located in a zip file on your distribution media in the /Integration directory. Process Commander Version File Name Installation Method V6.1 SP2 V6.1 SP1 V5.5 SP1 V5.4 SP3 V5.4 SP2 PegaCESvcs_for_6_1.zip DL-4228.zip PegaCESvcs_for_6_1.zip DL-4228.zip PegaCESvcs_for_5_5.zip PRPC_PMF_TMF_Integration _hotfix.zip PegaCESvcs_for_5_4.zip PRPC_ zip PegaCESvcs_for_5_4.zip PegaProCom zip Import Utility Update Manager Import Utility Update Manager Import Utility Update Manager Import Utility Import Utility 1. If your development system environment is V5.5 SP1, V6.1 SP1, or V6.1 SP2, use the Update Manager to apply the appropriate hotfix first:. For information about how to download and use the Update Manager see the PDN article PRKB : What is the Update Manager utility? 2. Log into the development system as a Process Commander Administrator. 3. Import the RuleSet file according to the version of the system: If your development system version is V6.1 SP1 or V6.1 SP2, click the Pega icon and select Application > Import & Export > Import. Follow the procedure described above in Import the Application Bundle to import PegaCESvcs_for_6_1.zip from the directory Integration\6.1 Dev Server in the PMF distribution media. If your system version is V5.5 SP1, V5.4 SP2, or V5.4 SP3 select File > Import > Import Archive. 29

34 Project Management Framework Version a. In the Select Import Mode box, select Local Zip File. b. Click Browse to locate and select the zip file appropriate for this system (see the table above) and click Upload File. When the file has uploaded, the Import page displays: c. Select all the Import Options, for example, Compile Libraries, Overwrite Existing Rules, and Overwrite Existing Data, and click Import. The wizard displays a progress bar as the file is imported and reports number of 30

35 Establish Connectivity to a Development System records and errors when complete: 3. Verify the Communication RuleSet Verify that the communication RuleSet has been installed and that the essential pieces are in place. 1. Log in to the development system as a Process Commander Administrator. 2. Verify that the appropriate RuleSet for your system s Process Commander version has been loaded. Process Commander Version RuleSet V6.1 SP2 PegaCESvcs: V6.1 SP1 PegaCESvcs: V5.5 SP1 PegaCESvcs: V5.4 SP3 V5.4 SP2 PegaCESvcs: Verify that a service package named PegaCESvcsIntegrator was added to the system. 31