Agile Studio IMPLEMENTATION GUIDE 7.3.1

Transcription

1 Agile Studio IMPLEMENTATION GUIDE 7.3.1

2 2017 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: (617) DOCUMENT: Agile Studio Implementation Guide SOFTWARE VERSION: PUBLISHED: Friday, December 01, 2017 Feedback If you have suggestions or comments for how we can improve our materials, send an to AppDocBug@pega.com.

3 CONTENTS Introduction 5 Post-install setup tasks 6 Update the account 6 Updating the account 6 Enable the work object search index 7 Set up a connection to a development system 7 Configuring settings 9 Build your organization structure 9 Creating the structure 9 Option 1 10 Option 2 10 Add rulesets and an application rule 10 Adding a customization ruleset 10 Adding a reporting ruleset 11 Temporarily add the customization ruleset to your access group 11 Adding the application rule 12 Remove the customization ruleset from the access group 13 Creating the access groups 14 Updating operators 15 Add project resources 15 Removing operator access to Agile Studio 16 Operator privileges 17 Operator privileges by user 17 Create menu 17 Agile Studio menu 18 Actions and privileges by work type 18 Products (PRD) 18 Releases (RLS) 19 Goals (GOAL) 19 Epics (EPIC) 20 Agile Studio Implementation Guide 3

4 Project Teams (PROJ) 20 Sprints (SPR) 21 User Stories (US) 22 Backlogs (BL) 22 Tasks (TASK) 23 Bugs (BUG) 23 Issues (ISSUE) 24 Feedback (FDBK) 25 Integration 26 Integrating with external systems 26 Agile Studio Implementation Guide 4

5 Introduction Introduction This guide provides system administrators with detailed instructions about how to perform postinstallation setup and configuration tasks that should be completed before users begin working in the Agile Studio application. It is not intended to describe all Agile Studio capabilities. Agile Studio Implementation Guide 5

6 Post-install setup tasks Post-install setup tasks User: System Administrator After installation, the following setup tasks are required to prepare Agile Studio for acceptance testing and general use. These tasks allow you to fully demonstrate and run through the various features, functions, and processes supported in the application. Update the account Enable the work object search index Set up a connection to a development system When you have completed these setup tasks, perform the configuration tasks outlined in Configuring settings on page 9. Update the account User: System Administrator Agile Studio uses an Account instance named PegaProjMgmt-Work to define the server and account it uses to send notifications to resources when new work is assigned to them and when work for their project team is updated. To enable this function, update the instance with your organization's outgoing account host, address, and sender information. Updating the account 1. Log in to Agile Studio as the AgileStudioSysAdmin operator using the password install. 2. Select the Designer Studio > Integration> > Outbound landing page option. 3. In the PegaProjMgmt-Work Work Pool row, click the gear icon to edit the account details. 4. Update the following fields: Full Name - enter text that you want to appear as the full name of the sender. Agile Studio Implementation Guide 6

7 Post-install setup tasks From - enter the address associated with this account using the format recognized by your (SMTP) host. Typically, the format is address@mydomain.com. If your SMTP host requires authentication, include character. Host (SMTP) - enter the Internet IP address or the domain name of your SMTP host. For example: your server.mydomain.com 5. Click Submit. Agile Studio also supports Pulse notifications. For more information, see Configuring Pulse notifications. Enable the work object search index User: System Administrator The Agile Studio Search Tool, located on the header of the user portal, provides full text search capability. Users can enter text strings to search for, locate, and display project work objects such as projects, sprints, user stories, tasks, and more. We recommend that you enable search indexing for work, data, and rules. For information on enabling search indexing, see Enabling and disabling classes for search indexing. Set up a connection to a development system User: System Administrator You can skip this step if your development system is not built on Pega Platform or you are not planning to connect to a system. You can establish a connection between Agile Studio and one or more Pega Platform development systems built on Pega This connection allows users to create, view, and update user stories and bugs within the Agile Workbench feature of their Pega Platform development system and allows developers to associate rule changes with their Agile Studio user stories and bugs. Agile Studio Implementation Guide 7

8 Post-install setup tasks All connection setup tasks are performed in your development system. Repeat the setup process in each development system where you are planning to track and monitor project work. For information on connecting a Pega Platform development system to Agile Studio from the Integration & security tab of your application, see Integrating Agile Workbench with Pega Agile Studio. For information on connecting development systems on earlier versions of Pega Platform to Agile Studio, see Working with Development Systems on Previous Pega Platform Releases on the Agile Studio product page. Agile Studio to Pega Platform integration provides an operator for authentication. For the SOAP Services, this operator ID is PM_ SOAPOper and for REST it is AS_RESTOper. For added security, before you put Agile Studio into production, you may want to change the password on this operator ID in Agile Studio and in the authentication profiles in the development environment. The authentication profile used by SOAP is PM_Integration_AuthProfile and REST uses PM_AgileStudio_ AuthProfile. To enable an OAuth 2.0 connection for the REST connections, add a client registration data instance and update the service package as specified in Accessing the Pega API by using OAuth 2.0. On the Pega development side, create an OAuth provider and delete and recreate the PM_ AgileStudio_AuthProfile Authentication Profile as specified in Accessing protected API resources by using OAuth 2.0. Agile Studio Implementation Guide 8

9 Configuring settings Users: System Administrator, Senior Project Manager, Project Manager After you complete the post-install setup, there are several configuration tasks that you perform to complete the typical configuration setup before users begin to access the system for testing and start to customize it as a production environment. Although these tasks can be performed at a later time, it is a recommended practice to perform them after you have completed the post install setup tasks. Build your organization structure Add rulesets and an application rule Add project resources Operator privileges Build your organization structure User: System Administrator Agile Studio includes a basic organizational structure that provides a working sample for demonstration and learning purposes. To configure and prepare for production use, you can build a structure that emulates your corporation and its divisions and departments. When pulled into reports, this structure enables you to view work that is complete or in-process by the units in your organization. As an administrator, you can view a tree of the installed organization and its branches by selecting the Designer Studio > Org & Security > Organization> Organizational Chart landing page option. Creating the structure You can create your structure using one of two options. Agile Studio Implementation Guide 9

10 Option 1 Update the Organization tree directly in Designer Studio. For more information, see Organization landing page. Option 2 Integrate Agile Studio with the Pega Single Sign-on features that synchronize the organization chart with your LDAP directory. For more information about this option, see Authentication Services or talk to your Pega Platform implementation team. Add rulesets and an application rule User: System Administrator Adding new rulesets and an Application rule enables you to store and package the configuration and rules you create when you customize Agile Studio without impacting your installed rule base. It also allows users to create and save custom reports using the Report Wizard and Report Browser tools. This process entails: Adding two rulesets - one for configuration customization and one for reporting Adding an Application Rule that references the rulesets Creating Access Groups Updating operators Adding a customization ruleset This ruleset is intended to hold your Agile Studio configuration customizations and its extension points separating them from the installed PegaRULES database. 1. From the Records Explorer, expand the Sysadmin category. Right-click RuleSet and select New. Do not create the ruleset using a Save As option on an existing ruleset such as PegaProjectMgmt. These are password protected. The Save As function carries over the protection into the new ruleset. Before you use this ruleset in a production environment, you should lock it. You can then increment the version and create new unlocked versions for additional customization. Agile Studio Implementation Guide 10

11 2. Enter a RuleSet Name for the ruleset and move to the next field. The system provides default values in the Version and Description fields. 3. Click Create and open. Then click Save. Adding a reporting ruleset This ruleset is intended to hold the custom categories and reports created by users using the Report Browser. If you choose not to add this ruleset and reference it in the access group of users who can access the Report Browser tab, those users will be unable to add a new report or report category. An error message displays, preventing them from completing the action. To add the reporting ruleset, complete the following steps: 1. From the Records Explorer, expand the Sysadmin category. Right-click RuleSet and select New. Do not create the ruleset using a Save As option on an existing ruleset such as PegaCustFoundation or PegaProjectMgmt. These are password-protected rulesets. The Save As function carries over the protection into the new ruleset. This ruleset should remain unlocked with Check-Out disabled in your production environment to allow users to customize reports. 2. Enter a RuleSet Name for the ruleset and tab to the next field. The system provides default values in the Version and Description fields. 3. Click Create and open. 4. On the Security tab, clear the Use Check-out? check box. 5. Click Save. Temporarily add the customization ruleset to your access group In order to add a custom application to Agile Studio, you must add the ruleset to your current Access Group, which is the Agile Studio system administration access group installed with the product. 1. From your name in the header of the portal, select the Access Group menu option to open the access group you are currently using. 2. On the Advanced tab of the Access Group, add your customization ruleset to the PRODUCTION Agile Studio Implementation Guide 11

12 RULESETS list. 3. Click Save. The rule form will display a warning due to the production ruleset. Adding the application rule 1. From the Records Explorer, expand the Application Definition category. Right-click Application and select Create. 2. Enter a Label and Version. In the Context section, select the customization ruleset you created. 3. Click Create and open. 4. Enter the following information on the Definition tab: a. In the Built on Application field, select AgileStudio and its highest version. b. Add the customization and reporting rulesets you created to the APPLICATION RULESETS list. c. Set the skin to AgileStudio. 5. Click Save. 6. Set up the Cases & data tab as shown below: Agile Studio Implementation Guide 12

13 7. Click Save. Remove the customization ruleset from the access group 1. From your name in the header of the portal, select the Access Group menu option to open the access group you are currently using. 2. On the Advanced tab of the Access Group, click the trash icon to delete the customization ruleset from the PRODUCTION RULESETS list. 3. Click Save. Agile Studio Implementation Guide 13

14 Creating the access groups Agile Studio is installed with five preconfigured access groups that you can copy, rename,and set up to reference the custom application you created while maintaining the access and privileges that have already been associated with the groups. 1. Select the Designer Studio > Org & Security > Security > Access Groups landing page option. 2. Select one of the AgileStudio access groups and click Save as. 3. Give it an Access Group Name that represents access to your custom development application and the user's role. The following screenshot provides a best practice example of naming an access group using the sample Agile Studio:SrProjManager access group where the application name is followed by the user role separated by a colon (:). 4. On the Definition tab, select the custom Application Name and Version you created. 5. On the Advanced tab, add your reporting ruleset and Version to the PRODUCTION RULESETS and DESIGN TIME CONFIGURATION lists. This allows users to create custom reports. 6. Click Save. 7. Repeat these steps for each access group. Agile Studio Implementation Guide 14

15 Updating operators Agile Studio is also installed with sample operators that you can use to create your own operators. You can update them to reference the access groups you created in the previous step and then use these operators to create your project resources. 1. Select the Designer Studio > Org & Security > Organization > Operators landing page option. 2. Select an operator. 3. In the APPLICATION ACCESS section of the Profile tab, click the plus icon to add a row to the ACCESS GROUP list. Select the radio button next to the custom access group you created to make the application the default application. 4. Click Save. 5. Repeat these steps for each operator you want to update. Add project resources Users: System Administrator, Senior Project Manager, Project Manager Project resources are operators that are assigned to create, manage, and complete project work. Agile Studio is installed with five sample operators that represent the typical project administrative and team roles with different levels of security and privilege associated with their project role and function. Agile Studio Implementation Guide 15

16 System Administrator - performs technical and operational tasks; has access to the Agile Studio developer portal Senior Project Manager - performs a combination of administrative, product management and project management functions Project Manager - performs day-to-day project management functions to create, oversee, track, and manage projects Lead Architect - oversees and leads the application development effort; performs development tasks and bug fixes System Architect - performs development tasks and bug fixes This table lists the operators configured in Agile Studio and their associated access groups, access roles, and portal. Passwords are set to install. You can use them as models and starting points to assess your resource needs and add your own project resources. If you are connecting Agile Studio to a 5.5, 6.1, or 6.2 development environment, the operator IDs must be identical in Agile Studio and the development system in order to correctly pull the user s Agile Studio worklist into Designer Studio. Operator ID Access Group Access Role Portal AgileStudioSysAdmin AgileStudio:SysAdmin PegaProjectMgmt:SrProjectManager Developer SrProjectManager AgileStudio:SrProjManager PegaProjectMgmt:SrProjectManager WorkManager ProjectManager AgileStudio:ProjManager PegaProjectMgmt:ProjectManager WorkManager AgileStudioLeadArchitect AgileStudio:LeadArchitect PegaProjectMgmt:TechMgr WorkUser AgileStudioSysArchitect AgileStudio:SysArchitect PegaProjectMgmt:User1 Work User Removing operator access to Agile Studio If a user leaves your organization and you no longer want them to access Agile Studio or appear in the list of resources, the best practice is to not delete their operator ID from Agile Studio but to instead create and associate the ID with an access group with a name that includes the word terminated. Agile Studio automatically filters operators with an access group containing this word from the various resource selection lists. Example: Change the operator access group from CustomApplication:ProjManager to CustomApplication:Terminated. Agile Studio Implementation Guide 16

17 Operator privileges Sample operators are configured with a set of privileges that are associated with their access role. The privileges define the processing actions that type of operator has security to perform and correspond to actions that display in the Agile Studio menu on the operator's portal and the Actions menu associated with the processing of project work. Example: All project resources can view a project and add tasks, but only a Project Manager can create a project. To see a list of the actions and privileges for processing functions by operator role, see Operator privileges by user. Operator privileges by user Users: System Administrator, Senior Project Manager, Project Manager The following tables list the menu actions and privileges that are configured for the sample Agile Studio users: Senior Project Manager (SPM), Project Manager (PM), Lead Architect (LA), and System Architect (SA). There is also a separate Access Group and Access Role configured for each user. Use the tables in this topic to help determine the access group and roles you want to assign your resources based upon the functionality you want them to have the security to perform. Operator privileges are associated with the actions that display on the menus accessed by the user. Create menu When a privilege or action is available, the option displays on the Create menu of the user portal. Action Category Create Product AddProduct x Project CreateProject x x Epic AddEpic x x x x Bug Item AddBug x x x x Issue AddIssue x x x x Feedback AddFeedback x x x x Backlog CreateBacklog x x User story AddUserStory x x x x Agile Studio Implementation Guide 17

18 Agile Studio menu When a privilege or action is available, the option displays on the Agile Studio menu of the user portal. Action Category Tools Maintain Resources Maintain Environment Data Bulk Processing tab on Resources & Workbaskets option MaintainResources x x MaintainEnvironmentData x x BulkProcessAssignments x x View Products x x x x Releases x x x x Goals x x x x Epics x x x x Projects x x x x Backlogs x x x x Feedback x x x x Resources & Workbaskets x x x x Actions and privileges by work type When a privilege or action is available for a work type, the option displays in the Create andagile Studio menus and in the list on the Actions tab of the work item. The following tables lists the flow and local action privileges assigned to the Agile Studio work types, as well as the sample operators who have been given the security to perform those actions. Products (PRD) Add product AddProduct x Agile Studio Implementation Guide 18

19 Update product UpdateProduct x Withdraw product Withdraw Product x Retire product RetireProduct x Add backlog for product Add Backlog x Add release for product AddRelease x Add product goal AddGoal x Add note AddNote x x x x Update team UpdateTeam x x Add epic AddEpic x x Associate tags AssociateTags x x x x Reopen resolved product WorkReopen x Add an attachment AddAttachment x x x x Bulk process feedback items FeedbackBulkProcess x x x x Releases (RLS) Add release AddProductVersion x Update release UpdateProductVersion x Withdraw release WithdrawProductVersion x Retire release RetireProductVersion x Manage setting ManageSettings x Add note AddNote x x x x Update trendline Rebaseline x Update team UpdateTeam x Associate tags AssociateTags x x x x Reopen resolved release WorkReopen x Add an attachment AddAttachment x x x x Add release goal AddGoal x Add an epic AddEpic x x Goals (GOAL) Add goal AddGoal x Resolve goal Resolve x Edit goal Edit x Add note AddNote x x x x Agile Studio Implementation Guide 19

20 Enter status update TrackStatus x Reopen a resolved goal WorkReopen x Add epic AddEpic x x Update team UpdateTeam x x Associate tags AssociateTags x x x x Add an attachment AddAttachment x x x x Epics (EPIC) Add epic AddEpic x x x x Resolve epic Resolve x x x x Edit epic Edit x x x x Add note AddNote x x x x Add/import user stories ImportStoriesFromExcel x x x x Enter status update TrackStatus x x x x Add user story AddUserStory x x x x Update priority UpdatePriority x x x x Associate tags AssociateTags x x x x Reassign ReAssign x x x x Reopen a resolved epic WorkReopen x x x x Add a dependency AddDependency x x x x Remove a dependency RemoveDependency x x x x Add an attachment AddAttachment x x x x Update team UpdateTeam x x x x Quick edit QuickEdit x x x x Project Teams (PROJ) Approve project ApproveProjects x x Add/import task groups AddTaskGroups x x Complete project CompleteProject x x Manage resources ManageResources x x Withdraw project ResolveProject x x Update project UpdateProject x x Create project CreateProject x x Copy project CopyProject x x Agile Studio Implementation Guide 20

21 Add/import bugs ImportBugsFromExcel x x x x Add note AddNote x x x x Update trendline Rebaseline x x Add issue AddIssue x x x x Add bug AddBug x x x x Enter a status update TrackStatus x x x x Add a sprint AddSprint x x x Add an attachment AddAttachment x x x x Update team UpdateTeam x x x Bulk process bugs BulkProcessBugs x x x x Bulk process issues BulkProcesIssues x x x x View definition of done ViewDefinitionOfDone x x x x Update definition of done UpdateDefinitionOfDone x x Sprints (SPR) Edit Edit x x x x Add/import bugs ImportBugsFromExcel x x x x Add note AddNote x x x x Update trendline Rebaseline x x x Get additional stories from backlog MoveAdditionalChildItems x x x x Bulk process user stories BuilProcessUserStories x x x x Plan sprint PlanSprint x x x Start sprint StartSprint x x x View definition of done ViewDefinitionOfDone x x x x Resolve sprint ResolveSprint x x x Add user story AddUserStory x x x x Document sprint stories DocumentSprintStories x x x x Document sprint status DocumentSprintStatus x x x x Add a bug item AddBug x x x x Withdraw sprint Withdraw x x x x Add an attachment AddAttachment x x x x Update sprint team UpdateTeam x x x x Bulk process issues BulkProcessIssues x x x x Bulk process bugs BulkProcessBugs x x x x Associate tags AssociateTags x x x x Reopen a resolved sprint WorkReopen x x x x Agile Studio Implementation Guide 21

22 User Stories (US) Edit Edit x x x x Resolve Resolve x x x x Manage resources ManageResources x x x x Add/import bugs ImportBugsFromExcel x x x x Add note AddNote x x x x Add issue to user story AddIssue x x x x Reassign ReAssign x x x x Copy user story CopyUserStory x x x x Spin off related work SpinOffRelatedWork x x x x Add bug to user story AddBug x x x x Move to different parents Move x x x x View definition of done ViewDefinitionOfDone x x x x Associate tags AssociateTags x x x x Add user story AddUserStory x x x x Withdraw Withdraw x x x x Add task to user story AddTask x x x x Reopen a resolved story WorkReopen x x x x Add an attachment AddAttachment x x x x Add a dependency AddDependency x x x x Remove a dependency RemoveDependency x x x x Bulk process a story's bugs BulkProcessBugs x x x x Bulk process a story's issues BulkProcesIssues x x x x Quick edit story from list QuickEdit x x x x Backlogs (BL) Edit Edit x x x x Resolve Resolve x x x x Add/import bugs ImportBugsFromExcel x x x Add/import user stories ImportStoriesFromExcel x x x x Add note AddNote x x x x Add issue to backlog AddIssues x x x x Import stories from application profile ImportFromAP x x x x Agile Studio Implementation Guide 22

23 Document backlog stories DocumentBacklogStories x x x x Add user story to backlog AddUserStory x x x x Copy bug CopyBug x x x x Add bug to backlog AddBug x x x x Bulk process bugs BulkProcessBugs x x x x Bulk process issues BulkProcessIssues x x x x Reopen a resolved backlog WorkReopen x x x x Update team UpdateTeam x x x x Associate tags AssociateTags x x x x Add an attachment AddAttachment x x x x Bulk process stories BulkProcessStories x x x x Export bugs to excel ExportBugsToExcel x x x x Tasks (TASK) Create/add task CreateNewTask x x x x Approve task ApproveTask x x x Complete task CompleteTask x x x x Reject task RejectTask x x x x Resolve task ResolveTask x x x Update task UpdateTask x x x x Verify task VerifyTask x x x x Withdraw task WithdrawTask x x x x Add note AddNote x x x x Add an attachment AddAttachment x x x x Reopen resolved task WorkReopen x x x x Associate tags AssociateTags x x x x Move to different parents Move x x x x Reassign ReAssign x x x x Bugs (BUG) Enter/add bug EnterBug x x x x Approve bug ApproveBug x x x x Resolve bug ResolveBug x x x x Agile Studio Implementation Guide 23

24 Verify bug VerifyBug x x x Add note AddNote x x x x Reassign ReAssign x x x x Spin off related work ActionSpinOffWorkItem x x x x Update parent user story UpdateUserStory x x x x Update priority UpdatePriority x x x x Update parent release UpdateRelease x x x x Request more information RequestMoreInfo x x x x Edit bug Edit x x x x Copy bug CopyBug x x x x Associate tags AssociateTags x x x x Reopen a resolved bug WorkReopen x x x x Add an attachment AddAttachment x x x x Add dependency AddDependency x x x x Remove dependency RemoveDependency x x x x Update team UpdateTeam x x x x Quick edit bug from list QuickEdit x x x x Issues (ISSUE) Enter/add issue EnterIssue x x x x Resolve issue ResolveIssue x x x x Add note AddNote x x x x Update issue UpdateIssue x x x x Reassign ReAssign x x x x Move to different parents Move x x x x Associate tags AssociateTags x x x x Update priority UpdatePriority x x x x Reopen a resolved issues WorkReopen x x x x Add an attachment AddAttachment x x x x Quick edit an issue from list QuickEdit x x x x Spin off related work ActionSpinOffWorkItem x x x x Agile Studio Implementation Guide 24

25 Feedback (FDBK) Enter/add feedback AddFeedback x x x x Update product association UpdateProductID x x x x Triage Triage x x Reject Reject x x Add note AddNote x x x x Edit Edit x Reassign ReAssign x x x x Reopen a resolved feedback WorkReopen x x x x Add an attachment AddAttachment x x x x Update team UpdateTeam x x x x Associate tags AssociateTags x x x x Agile Studio Implementation Guide 25

26 Integration Integration Integrating with external systems User: System Administrator Agile Studio contains a collection of SOAP and REST services that you can use to build and support integration with an external application to push and pull information to and from the application. For technical details on available Agile Studio services, see Integrating Agile Studio with Other Applications. Agile Studio Implementation Guide 26