Pega Agile Studio. Upgrade Guide 7.4

Transcription

1 Pega Agile Studio Upgrade Guide 7.4

2 2018 Pegasystems Inc., Cambridge, MA. All rights reserved. Trademarks For Pegasystems Inc. trademarks and registered trademarks, all rights reserved. All other trademarks or service marks are property of their respective holders. For information about the third-party software that is delivered with the product, refer to the third-party license file on your installation media that is specific to your release. Notices This publication describes and/or represents products and services of Pegasystems Inc. It may contain trade secrets and proprietary information that are protected by various federal, state, and international laws, and distributed under licenses restricting their use, copying, modification, distribution, or transmittal in any form without prior written authorization of Pegasystems Inc. This publication is current as of the date of publication only. Changes to the publication may be made from time to time at the discretion of Pegasystems Inc. This publication remains the property of Pegasystems Inc. and must be returned to it upon request. This publication does not imply any commitment to offer or deliver the products or services described herein. This publication may include references to Pegasystems Inc. product features that have not been licensed by you or your company. If you have questions about whether a particular capability is included in your installation, please consult your Pegasystems Inc. services consultant. Although Pegasystems Inc. strives for accuracy in its publications, any publication may contain inaccuracies or typographical errors, as well as technical inaccuracies. Pegasystems Inc. shall not be liable for technical or editorial errors or omissions contained herein. Pegasystems Inc. may make improvements and/or changes to the publication at any time without notice. Any references in this publication to non-pegasystems websites are provided for convenience only and do not serve as an endorsement of these websites. The materials at these websites are not part of the material for Pegasystems products, and use of those websites is at your own risk. Information concerning non-pegasystems products was obtained from the suppliers of those products, their publications, or other publicly available sources. Address questions about non-pegasystems products to the suppliers of those products. This publication may contain examples used in daily business operations that include the names of people, companies, products, and other third-party publications. Such examples are fictitious and any similarity to the names or other data used by an actual business enterprise or individual is coincidental. This document is the property of: Pegasystems Inc. One Rogers Street Cambridge, MA , USA Phone: Fax: Document: Pega Agile Studio Upgrade Guide 7.4 Feedback If you have comments for how we can improve our materials, send an to AppDocBug@pega.com.

3 Contents Contents Prerequisites...4 Backing up your system... 5 Pre-upgrade database preparation... 6 Upgrading the application... 7 Importing the application bundle...7 Restarting the application server... 7 Verifying the installation of rulesets... 8 Verifying the upgrade of the application...9 Completing post-upgrade tasks...10 Upgrading from PMF Converting existing notes to Pulse posts...10 Updating related item counts...11 Updating task efforts Upgrading from any supported release Enabling epic status change notifications...13 Converting owner subscripts to Product Owner subscripts...13 Updating the backlog story rank...14 Updating Open-InProgress stories Initializing team scheduler data Adding existing sprints to the team scheduler Converting data in existing properties to a rich text editor...15 Configuring the default backlog for existing products...16 Configuring a backlog and rank for existing epics Ranking epics in your backlog based on epic stories Converting story work items to stage based Initializing stages for specific user stories Implementing Pega Agile Studio Pega Agile Studio Upgrade Guide June 28, 2018 iii

4 Prerequisites Before you Upgrade Guide the application, make sure that you complete all of the following tasks. 1. Upgrade to Pega Platform 7.4, and then verify your installation as described in the Platform Upgrade Guide for your environment, available on the Deployment Guides page. 2. Apply any required hotfixes to the Pega Platform before proceeding with the Pega Agile Studio application upgrade. For a list of required hotfixes for Pega Platform, see the Pega Agile Studio Hotfix page. 3. Update the Pega Platform online help to the latest version from the Online Help Files section on the Pega Platform Update page. After you download the latest prhelp.war file, deploy it in your Pega Platform installation before continuing. For deployment information, see the Pega Platform Installation Guide for your application server.

5 Backing up your system Backing up your system Back up the database, your application files, and Pega Platform in case you need to restore your system. Note: The deployment process modifies both the data schema and the rules schema. Use a backup procedure that preserves both schemas. 1. Verify that all rules are checked in. 2. Shut down the Pega Platform application server. 3. Use your database utilities to complete an offline back up of the Pega database. 4. Back up the configuration and environment files. If you edited any of the following Pega Platform configuration files in the APP- INF\classes directory of an EAR deployment or the WEB-INF\classes directory of a WAR deployment, include these files in the backup: prbootstrap.properties prconfig.xml logging file: prlogging.xml or prlog4j2.xml web.xml pegarules.keyring or any other.keyring files 5. Back up any third-party or custom JAR files that you installed. Redeploying the Pega Platform applications might delete these from your application server. Pega Agile Studio Upgrade Guide June 28,

6 Pre-upgrade database preparation Database administrators must use Pega-provided scripts to update the existing database schema before Pega administrators can update the system to Pega Agile Studio 7.4. These scripts can be used on all Pega Platform supported databases. 1. Using your preferred database administration tool, log in to the database with database administrator credentials. 2. Browse to the PreUpgrade folder of the Pega Agile Studio release media and run the following scripts, depending on the current version Pega Agile Studio. For upgrades from Project Management Framework 6.3.1, run SchemaUpdate711.sql. For all supported upgrades, including Project Management Framework 6.3.1, run SchemaUpdate74.sql. After the database schema is updated, you are ready to import the application bundle to upgrade to Pega Agile Studio 7.4.

7 Upgrading the application Upgrading the application The following are the steps to upgrade the application. Importing the application bundle 1. Log in to the Pega Platform ( by entering the administrative ID that you set up when you installed Pega Platform, such as and the password that you specified. 2. Click Designer Studio > Application > Distribution > Import. 3. Click Choose File, browse for the Rulesets\RAP\AgileStudio_74.zip file from your distribution media, and follow the wizard instructions. To ensure that you import all components, do not select the Enable advanced mode to provide granular control over the import process check box. The wizard identifies differences between the database schema of your current system and the schema of Pega Agile Studio Based on the review of the database policies and application permissions that are used by your Pega Platform upgrade ( Prerequisites ), perform the appropriate step: Select the Automatic check box and complete the wizard. Select Manual and complete the following steps: a) Click View/Download DDL SQL to produce a text file containing Data Definition Language (DDL) statements for the needed changes. b) Save the DDL file and deliver it to a database administrator to make the required changes. Database administrators must review identified differences in the generated DDL file. They must then determine updates to DDL mappings to the implementation database in order to accommodate new functionality. This can require some time. c) After the database administrator has applied the DDL, repeat the Import wizard steps; the screen (above) does not reappear. Select the 'Enable new operators and overwrite existing operators on import' check box. If there are errors that you cannot resolve, post your questions to the Pega Product Support Community. When upgrading from prior versions of Pega Agile Studio to Pega Agile Studio 7.3 and higher, the Import aged screen will appear. Select all the check boxes on this page and click Next. 5. Optional: For best performance and initial user experience, you can pre-assemble the rules in the application by running the Static Assembler utility. For more information, see Preassembling rules in an application by using the Static Assembler utility. 6. Apply any required hotfixes. For the list of required Pega Agile Studio hotfixes, see the Pega Agile Studio Hotfix page. Restarting the application server The following steps clear the existing generated java files and then pre-assemble and cache the application rules, which improves response time after system startup. You need access to the application server's temp directory to complete this step. 1. Stop the application server. Pega Agile Studio Upgrade Guide June 28,

8 2. Clear the cache by emptying the server temporary directory. Do this for each application node. 3. Start the application server. 4. When the application has started successfully, log in to the application by using the following credentials: User Name: AgileStudioSysAdmin Password: install 5. Select Designer Studio > System > Assembly > Static Assembler. 6. In the Application Name field, select your application. The application list can take a few seconds to populate. 7. Click Start Assembly. This process can take several minutes. For additional details, see the help topic about temporary files and temporary files directories. Verifying the installation of rulesets Perform this procedure to ensure that the upgrade correctly placed the required application rulesets. 1. Log in to your application with the administrator operator ID. 2. In Designer Studio, click Application > Structure > RuleSet Stack. 3. Verify that the following ruleset versions are listed: PegaProjectMgmt: PegaLike: PegaProjectSched:

9 Verifying the upgrade of the application Verifying the upgrade of the application 1. Log in to your application with the administrator operator ID. 2. Verify that your initial view looks similar to the screen below. The verification is complete. Pega Agile Studio Upgrade Guide June 28,

10 Completing post-upgrade tasks Completing post-upgrade tasks The following sets of tasks are required for Pega Agile Studio users to complete before they can take advantage of the latest features in Pega Agile Studio 7.4. Perform the sets of tasks that are appropriate to the current version of the existing PMF application. When upgrading from a version prior to Pega Agile Studio 7.3 to Pega Agile Studio 7.3.1, you need to install any required hotfixes to enable the test management features. For the list of required hotfixes, see the Pega Agile Studio Hotfix page. These required configuration and testing tasks require that you log on to Pega Agile Studio using the following credentials: User Name Password AgileStudioSysAdmin install Upgrading from PMF Upgrading from any supported release Upgrading from PMF These steps are only necessary when upgrading from PMF When upgrading from later PMF versions, skip these steps. Converting existing notes to Pulse posts Updating related item counts Updating task efforts Converting existing notes to Pulse posts Pega Agile Studio 7.4 uses the Pulse feature to discuss and add comments to Agile Studio cases. You now use Pulse in place of notes. In order to view existing notes after you upgrade to Pega Agile Studio 7.4, you must run this utility to convert them to Pulse posts. The utility allows you to choose to convert all, some, or none of your existing notes. Pulse posts are only visible to users that are in the same application and the same workgroup as the user who created it. To configure PegaPulse, complete the following steps: 1. Create an operator ConvertNotesOperator, which has the same application and workgroup as production operators and has access to Designer Studio. 2. Log on as ConvertNotesOperator. 3. Open the activity PegaProjMgmt-Work.ConvertNotesToSocial. 4. Click Actions > Run. The following three execution modal parameters allow you to customize the note conversion: 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. Pega Agile Studio Upgrade Guide June 28,

11 Completing post-upgrade tasks 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 in which their 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 Select to process notes on only product and release work items. Leaving this unselected will cause notes to be converted to other work types in addition to products and releases. To customize the note conversion using any of these parameters, update the parameter; otherwise, leave the default values to convert all existing notes in the system. 5. 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. During internal testing, it was observed that the system processed about 500 notes per minute. On completion, the Operation completed screen displays. 6. Ensure that the following information displays: The progress of the process can be viewed in the PegaRULES log. A message displays on the log for each batch of 1,000 records processed. Error messages and final status also display in the log. Any work item notes included in the conversion based on the parameters selected are now displayed on the work item as a Pulse post. Updating related item counts Pega Agile Studio uses the PPM_RELATEDITEMCOUNTS. table to store a count of the attachments, tags, dependencies, related updates, and notes for each Pega Agile Studio work object. When upgrading from PMF 6.3.1, you must manually set the initial counts for pre-existing work items using the stored procedure RefactorCounts to process and display related item counts correctly. The procedure RefactorCounts is available for all supported databases and is located in the PostUpgrade folder of the release media. To use it, database administrators should compile it and use the database administration program of their choice to execute it on the database used by Pega Agile Studio. To verify, 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. Pega Agile Studio Upgrade Guide June 28,

12 Updating task efforts Pega Agile Studio improves the capturing and processing of task efforts. After an upgrade, you must update existing task efforts to the new format. To update task efforts, complete the following steps: 1. Create an operator PreUpgradeEffortOp, which has the same access group as operator PMSysAdmin. 2. Log on as PreUpgradeEffortOp. 3. Open activity PegaProjMgmt-Work.UpgradeActualEffort. 4. Click Actions > Run. 5. On the execution modal, leave the default values unchanged, and then click Run. On completion, the Operation completed screen displays. The number of tasks and bugs processed displays in the log. Total Hours Spent in the Effort Tracking section of various case types reflects the hours entered prior to the upgrade. If you need to rerun activity PegaProjMgmt-Work.UpgradeActualEffort, database administrators can use the database administrator tool of choice to run the following database script prior to rerunning in order to avoid creating duplicate effort records: DELETE FROM PPM_RESOURCEEFFORTTRACKING; COMMIT;

13 Upgrading from any supported release Upgrading from any supported release These steps are necessary for all supported upgrades, including PMF 6.3.1: Enabling epic status change notifications Converting owner subscripts to Product Owner subscripts Updating the backlog story rank Updating Open-InProgress stories Initializing team scheduler data Adding existing sprints to the team scheduler Converting data in existing properties to rich text editor Configuring the default backlog for existing products Configuring a backlog and rank for existing epics Ranking epics in your backlog based on epic stories Converting story work items to stage based Initializing stages for specific user stories Enabling epic status change notifications In Pega Agile Studio, operators can receive notifications when the status of a followed epic changes. Use the Pega-provided activity, PegaProjMgmt-Work. UpdateStatusWorkOldOnEpics, to enable epic status change notifications after an upgrade to use this feature. To enable epic status change notifications, complete the following steps: 1. Log on as an operator with access to the Designer Studio portal. 2. Open activity PegaProjMgmt-Work.UpdateStatusWorkOldOnEpics. On completion, the Operation completed screen displays. The progress of the process can be viewed in the PegaRULES log. Error messages and a final status are displayed in the log. You can view any open sprint containing open stories; the status of all stories will be Open-InProgress. Converting owner subscripts to Product Owner subscripts In Pega Agile Studio, the Owner role for epic team members was renamed to Product Owner. You must update owner subscripts after an upgrade using the Pega-provided activity, PegaProjMgmt- Work.UpdateWorkPartySubscriptOnEpics, in order to ensure that Product Owners are the epic owners. To update Owner roles, complete the following steps: Pega Agile Studio Upgrade Guide June 28,

14 Upgrading from any supported release 2. Open activity PegaProjMgmt-Work.UpdateWorkPartySubscriptOnEpics. On completion, the Operation completed screen displays. Updating the backlog story rank In Pega Agile Studio the processing of backlog story rank is improved. Use the Pega-provided activity, PegaProjMgmt-Work.UpdateApplicationBacklogCoveredItems, to update existing backlog stories to take advantage of this feature. To update the backlog story rank, complete the following steps: 2. Open the activity PegaProjMgmt-Work.UpdateApplicationBacklogCoveredItems. On completion, the Operation completed screen displays. The progress of the process can be viewed in the PegaRULES log. Error messages and a final status is displayed in the log. Updating Open-InProgress stories In Pega Agile Studio, open stories in an open sprint must have a status of Open-InProgress. You must use the Pega-provided activity, PegaProjMgmt-Work.UpdateOpenReadyStoriesForInProgressSprint, to update existing stories in any open sprints to the correct status. To enable sprint story status changes, complete the following steps: 2. Open activity PegaProjMgmt-Work.UpdateOpenReadyStoriesForInProgressSprint. On completion, the Operation completed screen displays. The progress of the process can be viewed in the PegaRULES log. Error messages and a final status is displayed in the log. You can view any open sprint containing open stories; the status of all stories will be Open-InProgress. Initializing team scheduler data In Pega Agile Studio 7.4, a new feature has been introduced that allows users to view and update the past and planned future work for sprint teams in a schedule view. You must use the Pega-provided activity, PegaProjMgmt-Work.UpdateUserStoryPrevSprIDForScheduler, to initialize data for existing teams and sprints. To enable enhanced schedule views, complete the following steps: Pega Agile Studio Upgrade Guide June 28,

15 Upgrading from any supported release 2. Open activity PegaProjMgmt-Work.UpdateUserStoryPrevSprIDForScheduler. On completion, the Operation completed screen displays. The progress of the process can be viewed in the PegaRULES log. Error messages and a final status is displayed in the log. Adding existing sprints to the team scheduler In Pega Agile Studio 7.4, a new feature has been introduced that allows user to view and update the past and planned future work for sprint teams in a schedule view. You must use the Pega-provided activity, PegaProjMgmt-Work.UpdateRealDataForScheduler, to add actual efforts for current and past sprints to team schedules. To enable enhanced views for sprint teams, complete the following steps: 2. Open activity PegaProjMgmt-Work.UpdateRealDataForScheduler. On completion, the Operation completed screen displays. The progress of the process can be viewed in the PegaRULES log. Error messages and a final status is displayed in the log. Converting data in existing properties to a rich text editor In Pega Agile Studio, several properties have been updated to make use of the rich text editor. You must use the Pega-provided activity, PegaProjMgmt-Work.UpgradeTextAreaToRTE, to convert existing data in these properties to the new format. To enable the use of a rich text editor, complete the following steps: 2. Open activity PegaProjMgmt-Work.UpgradeTextAreaToRTE. On completion, the Operation completed screen displays. The progress can be viewed in the PegaRULES log. Error messages and a final status is displayed in the log. You can view any open sprint containing open stories; the status of all stories will be Open- InProgress. The speed of the process varies, but internal testing showed that the utility converts approximately 1,000 cases per minute. The utility will process all existing bugs and user stories. Pega Agile Studio Upgrade Guide June 28,

16 Upgrading from any supported release Configuring the default backlog for existing products In Pega Agile Studio, products should be assigned a default backlog. This default backlog will be used as a default when creating bugs at the product level. After an update, you must use the Pega-provided activity, PegaProjMgmt-Work.SetDefaultBacklogOnProducts, to enable the use of a default product backlog. To enable a default backlog for products, complete the following steps: 2. Open activity PegaProjMgmt-Work.SetDefaultBacklogOnProducts. On completion, the Operation completed screen displays. The progress of the process can be viewed in the PegaRULES log. Error messages and final status will also be displayed in the log. In case of failures (for example, when the default backlog was not updated on a few products), a message in the format shown below will appear. In such cases, set the default backlog on these products manually using "Update Product" available on the product's actions menu. Configuring a backlog and rank for existing epics In Pega Agile Studio, epics belong to specific backlogs and can be ranked within the backlog. After an upgrade, you must use the activity, PegaProjMgmt-Work.AssociateBLToEpic, to configure a backlog value on all non-resolved epics without backlogs in the system. To configure a backlog for existing epics, complete the following steps: 2. Open activity PegaProjMgmt-Work.AssociateBLToEpic. Verify the following steps: On completion, the Operation completed screen is displayed if all existing epics are successfully associated with a backlog. In cases where not all epics have been associated with a backlog successfully, a message in the format shown below will appear. In such cases, the system log will indicate which epics were not successfully initialized. These can be manually updated as needed. Pega Agile Studio Upgrade Guide June 28,

17 Upgrading from any supported release For any epic for which a backlog could not be set, a message is displayed as shown when the epic is opened, and the user will need to set the backlog manually when it is next edited. The report Epics Without Backlog, available in the Product Planning report category in the report browser, can be used to identify any epics that need a backlog assigned. Ranking epics in your backlog based on epic stories Pega Agile Studio 7.4 allows you to rank existing epics within your backlog. This feature ranks your epics based on the highest-ranked story from that epic in the backlog. Epics without any stories will be ranked at the bottom of the epic backlog. After an upgrade, you must use the activity PegaProjMgmt- Work.RerankEpicBasedOnUs to configure the ranking of epics in your backlog. To configure the ranking of epics in your backlog, complete the following steps: 2. Open activity PegaProjMgmt-Work.RerankEpicBasedOnUs. On completion, the Operation completed screen is displayed if all the Epics are associated with BL. In cases where not all epics have been ranked within their backlog successfully, a message in the format shown below will appear. In such cases, the system log will indicate which epics were not successfully initialized. These can be manually updated as needed. Pega Agile Studio Upgrade Guide June 28,

18 Converting story work items to stage based In Pega Agile Studio, user stories make use of stages in addition to statuses. After an upgrade, you must use the activity, PegaProjMgmt-Work.ConvertAllWOsToStageBased, to enable stages to present a status that is based on your existing user stories. To enable stages for stories, complete the following steps: 2. Open activity PegaProjMgmt-Work.ConvertAllWOsToStageBased. On completion, the Operation completed screen displays. The progress of the process can be viewed in the PegaRULES log. Error messages and final status will also be displayed in the log. The list of items that are not processed will be shown as comma separated values in the logs. You may use that list as input to ConvertSpecificIDsToStageBased to process them separately as described below. Initializing stages for specific user stories This step is only necessary if the previous step indicates that some stories were not successfully processed in the previous step. To initialize stages for specific user stories, complete the following steps: 2. Open activity PegaProjMgmt-Work.ConvertSpecificIDsToStageBased. 4. On the execution modal, provide the class of the work objects that are to be converted and the work objects as comma separated values, then click Run.

19 Implementing Pega Agile Studio 7.4 Implementing Pega Agile Studio 7.4 Complete implementation of your installed Pega Agile Studio 7.4 to enable ad hoc reporting, customization, and connecting Pega Agile Studio to your development environments. See the Pega Agile Studio 7.4 Implementation Guide for further information. Pega Agile Studio Upgrade Guide June 28,