integrating agile studio with other applications€¦ · introduction agile studio is integrated...

Tech Note 1

Integrating Agile Studio with Other Applications

Agile Studio 7.3

July 2017

Introduction Agile Studio is integrated with Pega Platform 7.3 to allow teams to change their application’s records in Designer Studio and link them to tasks, bugs, or user stories in Agile Studio.

Agile Studio also offers many SOAP services that you can use to query Agile Studio for information or to push information into Agile Studio. You can use these services as a starting point to create a custom integration with a third-party application.

Agile Studio 7.3 introduces a new set of REST APIs. These services enable users to retrieve, create, and update products, releases, user stories, and bugs to manage their projects from an external application.

Alternatively, you can create your own customer services and/or connectors in Agile Studio to either push or pull the information between Agile Studio and the external application.

Agile Studio integration with Pega 7.3 Designer Studio Agile Studio can be integrated with your Pega 7.3 instance from the Integration & security tab of your application.

For more information about connecting a Pega 7.3 development system to Agile Studio 7.3, see Integrating Agile Workbench with Pega Agile Studio.

For more information about associating record changes in Designer Studio with tasks, bugs, and user stories from Agile Studio 7.3, see Tracing development changes to work items.

For more information about integrating with development systems on prior Pega Platform releases, see Working with Development Systems on Previous Pega Platform Releases on the Agile Studio product page.

Agile Studio SOAP Services Agile Studio includes several SOAP services that can be used to integrate Agile Studio with an external application. These services allow you to query Agile Studio for information about cases or to push information into Agile Studio to create or update cases.

Agile Studio SOAP Service Package The SOAP Services in Agile Studio are in the ProjMgmtStatelessIntegrator service package. The service package specifies which access group is used by the services in that package. If you have made any customizations to Agile Studio, reference your custom access group in the service package rather than the provided Agile Studio access group (AgileStudio:SysAdmin).

https://pdn.pega.com/sites/pdn.pega.com/files/help_v73/procomhelpmain.htm#project%20delivery/agile-workbench/proj-integrating-proj-mgmt-app-tsk.htm

https://pdn.pega.com/sites/pdn.pega.com/files/help_v73/procomhelpmain.htm#project%20delivery/agile-workbench/proj-tracing-changes-workitems-tsk.htm

https://pdn.pega.com/node/1339756

Tech Note 2

To access this Service Package instance:

1. Log in to Agile Studio as someone with Designer Studio access (for example, PMSysAdmin).

2. In the Records explorer, expand Integration-Resources and click Service Package.

3. In the list of Service Package instances, type ProjMgmtStatelessIntegrator in the Key Contains field and click Run.

4. From the filtered list, click ProjMgmtStatelessIntegrator to open that instance.

Note: If you need to change the access group used by the service, do so on the Context tab of the Service Package. You can also specify custom authentication on this tab, if needed.

The services included in a Service Package are listed in the Methods section of the Context tab.

Simulating a SOAP Service Using tools in Pega 7.3 Designer Studio, you can simulate one of the Agile Studio SOAP Services to get a better understanding of their behavior and the values that will be returned.

To use the simulator:

Tech Note 3

1. Log in to Agile Studio as a user with Designer Studio access (example: AgileStudioSysAdmin).

2. Open one of the Agile Studio SOAP service rules. A list of these service rules is available in the Available Agile Studio SOAP Services section of this document.

− Open the service using search or by clicking on it in the Methods section on the Service Package.

3. Click Actions in the header of the SOAP service form and click Run. 4. The SOAP service execution simulator opens. The SOAP Request Envelope section

displays the XML input expected by the service. Within the <SOAP: Body> tag you will find the various parameters that can be passed into the service.

5. Between the start and end tags, type values for the parameters you want to enter. For example: <BacklogID>BL-1</BacklogID>

6. After you have filled out all of the parameters that you want to set, click Execute.

7. A new window will display that shows the SOAP Service Simulation Results. The SOAP Response Envelope on this screen shows all return values for the service. Check the Return Code and Return Message to determine if the service executed correctly.

Tech Note 4

Available Agile Studio SOAP Services The ProjMgmtStatelessIntegrator service package contains many services that can be used to integrate Agile Studio with external applications. For more details, see the individual sections about each of these SOAP services later in this document.

Service name Purpose CreatePMFItemSync63 Creates an Agile Studio work item of one of the

following types: user story, epic, task, issue, bug, feedback, product, or backlog.

UpdatePMFItemSync63 Updates the specified Agile Studio work item as identified by item ID (example: BUG-1234).

GetPMFItemDetails Returns the details for a specific Agile Studio item as identified by item ID (Example: BUG-1234).

GetPMFWork63 Retrieves the list of child items associated to the specified parent item and filters.

AddDevelopmentInfo Associates code changes or Pega Platform rule changes with Agile Studio cases.

GetMultiplePMFItemDetails Returns the details for a set of Agile Studio items as identified by item ID (Example: BUG-1234).

GetPMFAssignments622 Retrieves the list of tasks and bugs for a specific user. AddAttachmentsToPMFItem Adds attachments to any valid Agile Studio work

object.

Tech Note 5

Service: CreatePMFItemSync63

This service is used to create the specified Agile Studio item type. The supported item types are user stories, epics, tasks, bugs, issues, feedback items, products, and backlogs.

Input parameter Required? Format and valid values

Usage

Item Type Yes US User story EPIC Epic TASK Task ISSUE Issue BUG Bug FDBK Feedback PRD Product BL Backlog

Case type that will be created. Pass in a value such as “US”.

pyLabel Yes 64 character string Short name of item. Backlog ID Yes – for user stories,

bugs, tasks, issues

No – for epics, feedback, products, and backlogs

A valid Agile Studio backlog ID (example: Bl-1).

Identifies the backlog that the new item should be associated with.

BacklogRank No ReportedByEmail Yes Email address. Email address for the

person who originated the item.

Sprint ID No A valid Agile Studio sprint ID (example: SPR-1).

Identifies the sprint that the item should be added to (if any); only stories, bugs, and issues can be associated with sprints.

User Story ID No A valid Agile Studio user story ID (example: US-123).

Identifies the user story that the item should be added to. Only tasks, bugs, and issues can be associated with a user story.

Project ID No A valid Agile Studio project team ID (example PROJ-12).

Identifies the team that the item should be added to. Only bugs, user stories, issues, and tasks can be associated with a team.

Tech Note 6


Usage

Product ID Yes – for backlogs, feedback items, and epics

No - for all other item types

A valid Agile Studio product ID (example PRD-4).

Identifies the product that the item should be added to.

Product Version ID No A valid Agile Studio release ID (example RLS-2).

Identifies the release that the item should be associated with.

Epic ID No A valid Agile Studio epic ID (example Epic-3).

Identifies the epic that the item should be associated with.

Goal ID No A valid Agile Studio Goal ID (example Goal-3).

Identifies the goal that the item should be associated with.

EstimatedSize No Decimal value. Category No See the drop-down on the

item entry screen in Agile Studio for a list of valid values.

Type of bug or category of task or user story.

Priority No Integer in the range from 1-100.

100 is the highest priority (indicating the item should be worked on soonest).

Severity No Integer in the range from 1-4.

1 corresponds to critical and 4 corresponds to low. Used only on bugs and issues.

Description No Text Longer descriptive detail of the item.

Steps to Reproduce No Text Details regarding how to recreate. Used only on bugs and issues.

AssignToResource No Valid Agile Studio user ID Assigns the new item to this resource. If left blank, the item will be assigned to a workbasket.

AssignToWorkbasket No Valid Agile Studio workbasket ID

Assigns the new item to this workbasket. If left blank, the item will be assigned to the default workbasket as defined in Agile Studio.

Tech Note 7


Usage

System of Origin No Text Name of the system that is registered in the environment list in Agile Studio. (Example: Customer Service Dev OR Requirements Repository).

Contact ID No Valid Agile Studio user ID Name of the person within the organization who should be contacted if more information is needed for the bug. Used only on Bug items. Is added as contact party on the bug.

Customer ID, Customer name

No ID and Name of the customer (not validated against anything in Agile Studio).

Name of the customer who reported the bug (if any). Used only on bug items. Is added as Customer party on the bug.

External Item ID No ID of the related item from the external application.

If populated, shown on bug’s Details tab.

External Item Created Date No Date the related item was created on the external application.


External Status No Status of the related item from the external application.


External Index No Number – can be used for any number/index value for the related item from the external application.


ConfirmationEmailAddress No CreatedBy No

InitialVersionNumber No AlphaNumeric value to be used while creating release work object.

RelatedContentURL No

RelatedContentURLTitle

Story Points No Decimal value.

Tech Note 8


Usage

Technical Details No

Test Process No

TestScenarioID No

pyDescription No

pyStatusWork No

AcceptanceCriteriaList: Criteria:

pxCreateDateTime:

pxCreateOpName:

pxCreateOperator:

pxCreateSystemID:

ApplicationInfoList:

AppName:

ApplicationUpdated:

ApplicationVersion:

SpecificationSync:

SystemName:

BuildData:

ApplicationName:

ApplicationVersion:

BuildDate:

BuildID:

Released:

Status:

TestRun:

Tech Note 9


Usage

ReportedBy

ReportedByAccessGroup

ReportedByDivision

ReportedByOrg

ReportedByOrgUnit

ReportedBySystemID

ReportedByUserID

ReportedByUserName

ReportedByWorkgroup

SpecApplicationName

SpecCaseType

SpecKey

SpecName

Expected outcome

A work item is created using the values specified in the SOAP parameters.

Returned values

ItemID

ItemInsKey

ReturnMessage

ReturnCode

Return codes

1: Successfully Created Work Item

2: Error in Processing: You must supply a type of item to create

3: Error in Processing: Creation of specified item type is not supported by this service

4: Error in Processing: Generic Messages

5: You must supply a label/name

7: Contact ID does not have a valid Operator ID

8: Please enter both Customer Name and Customer ID

Tech Note 10

10: Choose either an Operator or Workbasket but not both to transfer the assignment to

12: Product ID <<ProductID>> not found in Agile Studio system

13: Release ID <<ProductVersionID>> not found in Agile Studio system

14: Goal ID <<GoalID>> not found in Agile Studio system

15: Epic ID <<EpicID>> not found in Agile Studio system

16: Project ID <<ProjectID>> not found in Agile Studio system

17: Sprint ID <<SprintID>> not found in Agile Studio system

18: User Story ID <<UserStoryID>> not found in Agile Studio system

19: Backlog ID <<BacklogID>> not found in Agile Studio system

20: Please provide value for ReportedByEmail

21: Reported By Email does not have a valid Operator ID

22: Product ID <<ProductID>> is Resolved. Please select a non-resolved parent

23: Product Version ID <<ProductVersionID>> is Resolved. Please select a non-resolved parent

24: Goal ID <<GoalID>> is Resolved. Please select a non-resolved parent

25: Epic ID <<EpicID>> is Resolved. Please select a non-resolved parent

26: Project ID <<ProjectID>> is Resolved. Please select a non-resolved parent

27: Sprint ID <<SprintID>> is Resolved. Please select a non-resolved parent

28: User Story ID <<UserStoryID>> is Resolved. Please select a non-resolved parent

29: Backlog ID <<BacklogID>> is Resolved. Please select a non-resolved parent

30: Invalid Test Process value provided

31: Invalid category for Bug. It should be one of these - Cosmetic OR Documentation OR Enhancement OR Exception Error OR Incorrect Results Or Installation OR Javascript Error OR Performance OR Security OR Upgrade Or Usability

32: Please Enter either Backlog or Project

36: Invalid category for Issue. It should be one of these - General OR Budget OR Documentation OR Environment OR Infrastructure Or Installation OR Legal OR Performance OR Quality Risk OR Question OR Resources OR Scheduling

37: Please provide valid issue status

38: Please provide product for creating backlog

39: Please provide either Backlog ID or Project ID or Sprint ID for creating Issue

41: Invalid category for task. It should be one of these - General OR Development OR Testing OR Documentation

46: Invalid category for Feedback. It should be one of these - General OR Information Request OR Enhancement Request OR Issue OR Bug Or Usability OR User Interface OR Process Improvement OR Policy Decision

Tech Note 11

51: Invalid category for user story. It should be one of these - General OR Spike or Technical Debt

52: Please provide a valid user story status

53: Backlog Rank cannot be less than 1

54: ApplicationName is not associated with the provided BacklogID's product

SpecApplicationName is not associated with the provided BacklogID's product

55: Providing application name is mandatory to create a user story

Providing System Of Origin is mandatory to create a user story

Provided System Of Origin does not exist at Agile Studio Environment details. Adding valid Environment details is mandatory for creating user story

56: You must supply InitialVersionNumber for creating a Product

57: You must supply a category for product. It should be either one of these categories - Application or Component or Framework

58: Please provide valid Category for Product. It should be either one of these categories - Application or Component or Framework

59: Product already exists with name - <<pyLabel>>

61: Invalid Priority Value. Priority should be between 0 to 100

62: You must supply a Product ID or Goal ID to add this epic

63: Please provide a valid epic status

64: Provided Goal ID <<GoalID>> does not belong to product <<ProductID>>

154: This application has been disabled from creating a user story in Agile Studio. Please contact the Agile Studio administrator for more information.

155: Providing Case type is mandatory to create a user story

158: Invalid application version supplied for one of the application. Please provide valid value

159: Providing system name is mandatory

Invalid spec sync value supplied for one of the applications. Please enter Boolean value.

This environment has been disabled from creating a user story in Agile Studio. Please contact the Agile Studio administrator for more information.

Invalid system name supplied for one of the applications. Please provide valid value.

This environment has been disabled from creating a product in Agile Studio. Please contact the Agile Studio administrator for more information.

Invalid application version supplied for one of the applications. Please provide valid value.

Service: UpdatePMFItemSync63

This service is used to update a specific Agile Studio work item.

Tech Note 12


Usage

Item ID Yes Valid Agile Studio item ID (example: US-123).

Identifies the case that should be updated.

pyLabel No 64-character string. Short name of item. Backlog ID No A valid Agile Studio backlog ID

(example: Bl-1). Identifies the parent backlog that the item should be associated with.

Project ID No A valid Agile Studio project team ID (example: PROJ-2).

Identifies the parent project that the item should be associated with.

Sprint ID No A valid Agile Studio sprint ID (Example: SPR-1).

Identifies the sprint that the item should be associated with. Valid only for user stories, bugs, and issues.

User Story ID No A valid Agile Studio user story ID (example: US-12).

Identifies the parent user story that the item should be associated with. Valid only for tasks, bugs, and issues.

Product ID No A valid Agile Studio product ID (example: PRD-1).

Identifies the parent product that the item should be associated with.

Product Version ID No A valid Agile Studio release ID (example: RLS-2).

Identifies the parent release that the item should be associated with.

Goal ID No A valid Agile Studio goal ID (example: GOAL-1)

Identifies the parent goal that the item should be associated with. Valid only for epics.

Epic ID No A valid Agile Studio epic (example: EPIC-3).

Identifies the parent epic that the item should be associated with. Valid only for user stories.

Type/Category No A valid category/type for the item type - you can see the full list for each item type on an

Tech Note 13


Usage

entry screen for that item type in Agile Studio.

Priority No Integer in the range from 1-100

100 is the highest priority (indicating the item should be worked on soonest).

Severity No Integer in the range from 1-4 1 corresponds to critical and 4 correspond to low. Used only on bugs and issues.

pyDescription No Text Longer descriptive detail of the item.

Steps to Reproduce No Text Details regarding how to recreate. Used only on bugs and issues.

AssignToResource No Valid Agile Studio user ID Assigns the new item to this resource. If left blank, the item will get assigned to a workbasket.

AssignToWorkbasket No Valid Agile Studio workbasket ID

Assigns the new item to this workbasket. If left blank, the item will get assigned to the default workbasket as defined in Agile Studio.

Contact ID No Valid Agile Studio user ID Name of the person within the organization who should be contacted if more information is needed for the bug. Used only on Bug items. Is added as contact party on the bug.

Customer ID, Customer name

No ID and Name of the customer (not validated against anything in Agile Studio)

Name of the customer who reported the bug (if any). Used only on bug items. Is added as Customer party on the bug.

Story Points System Of Origin pyStatusWork

Tech Note 14


Usage

AcceptanceCriteriaList

Criteria:

pxCreateDateTime:

pxCreateOpName:

pxCreateOperator

pxCreateSystemID:

Date in <<YYYY-MM-DD>> format.

Text entered in criteria gets appended to acceptance criteria.

ApplicationInfoList

AppName:

ApplicationUpdated:

ApplicationVersion:

SpecificationSync:

SystemName:

SpecApplicationName SpecCaseType SpecKey SpecName ExternalItemID ExternalItemCreatedDate

ExternalItemStatus ExternalItemIndex

Expected outcome

The item is updated with the new values specified in the parameters.

Returned values

ReturnMessage

ReturnCode

Tech Note 15

Return codes

1: Successfully updated the work object

2: You must supply an item ID

3: The item ID is not a valid open Agile Studio item

4: Unable to get lock on work item

5: Validation Failed: << Error thrown from Agile Studio will be shown to the user >>

6: Committing Agile Studio item to Database failed: <<Error thrown from Agile Studio will be shown to the user>>

7: Contact ID does not have a valid Operator ID

8: Please enter both Customer Name and Customer ID

9: Could not add customer as a party

10: Choose either an Operator or Workbasket but not both to transfer the assignment to

11: Invalid operator given for AssignToResource

12: Invalid workbasket given for AssigntoWorkbasket

13: The item ID is invalid: Item ID not found in Agile Studio system

15: Spec association is successful. User story could not be updated at this moment

59: Connection for this application has been disabled in Agile Studio

159: Invalid system name supplied for one of the applications. Please provide valid value

This environment has been disabled from updating a product in Agile Studio. Please contact the Agile Studio administrator for more information

Invalid application version supplied for one of the applications. Please provide valid value

This application has been disabled from updating a user story in Agile Studio. Please contact the Agile Studio administrator for more information

Invalid system name supplied for one of the applications. Please provide valid value

This application has been disabled from updating a user story in Agile Studio. Please contact the Agile Studio administrator for more information

Invalid system name supplied for the specification. Please provide valid value

Providing specification name is mandatory. Please provide valid value

Service: GetPMFItemDetails

This service is used to get the details of a specific Agile Studio item

Input parameter Required? Format and valid values Usage Item ID Yes Valid Agile Studio item ID

(example: US-123).

Identifies the case that details should be returned for.

Tech Note 16

Returned values

pyID (ID of the case)

pzInsKey (key of the case)

pyStatusWork (status of the case)

LastUpdateDate

LastUpdateOperator

pyLabel (short name of case)

pyDescription

DuplicateItemID (returned only if the specified item has been marked as a duplicate of another)

ProjectID

BacklogID

SprintID

UserStoryID

ProductID

ProductVersionID

GoalID

EpicID

ImmediateParentTaskGroupID – Parent Task group ID of Task group/Task that are of SmartBPM project type

Category

Priority

Severity

AssignToResource

AssignToWorkbasket

StepsToReproduce

AcceptanceCriteria

SpunOffItemID

ReturnCode

ReturnMessage

Return codes

1: Successfully retrieved the data


Tech Note 17

3: The item ID is not a valid Agile Studio item

4: Could not get all the properties related to the entered Agile Studio item

Service: GetPMFWork63

This service is used to get a summary list of child items associated with the specified parent item. This service can return child item lists for the following parent item types: Product, Release, Backlog, Epic, Goal, Project Team, Sprint, or User Story.


Usage

Parent Item ID Yes Valid Agile Studio item ID (example: US-123) Should be a valid backlog ID, Epic ID, Goal ID, Product ID, Release ID, Project ID, Sprint ID, and user story ID.

Identifies the parent case that a list of child items should be returned for.

GetPMFWorkStatus Yes One of the following values: Resolved, Non-Resolved, ALL.

Indicates which status the child items returned should have. Used to filter the results before returning them using the service.

Get PMFWorkType Yes One of the following values: BUG, USERSTORY, SPRINT, EPIC, GOAL, BACKLOG, TASK, ISSUE, RELEASE, PRODUCT, PROJECT, FEEDBACK

Type of child items to be fetched.

GetPMFWorkCreatedSinceDate No <yyyy>-<mm>-<dd> (for example: 2015-12-30)

Filters returned case list to include only cases created on or after the specified date.

GetPMFWorkUpdatedSince No <yyyy>-<mm>-<dd> (for example: 2015-12-30)

Filters returned case list to include only cases updated on or after the specified date.

Expected outcome

A list with a maximum of 1000 child items should be returned. For each item in the list, a set of details are returned.

Tech Note 18

Returned values

ReturnMessage

ReturnCode

ReturnCount

ItemDetails (1 set for each item returned)

− AssignedToID (person/workbasket that the case is assigned to)

− AssignmentClass (indicates whether an item is assigned to a person or a workbasket)

− WorkCreateDateTime

− WorkCreateOperator

− WorkUpdateDateTime

− WorkUpdateOperator

− pxUrgencyWork (priority)

− pyDescription

− pyID

− pyLabel (short name of item)

− pyStatusWork (status of item)

Return codes

1: <<Result count>> items returned of type << GetPMFWorkType >>

2: You must supply a type of item to return a list of items

3: You must supply a Parent Item ID to return a list of items

4: You must supply a Parent Product ID to return a list of items for the work type you selected. This error code is returned if the work type is release, backlog, goal or feedback

5: You must supply a Parent Product ID or GoalID to return a list of Epics

6: You must supply a Project ID to return a list of Sprints

7: You must supply a Parent ID to return a list of User Stories

8: Product ID <<ProductID>> not found in Agile Studio system

9: Release ID <<ProductVersionID>> not found in Agile Studio system

10: Goal ID <<GoalID>> not found in Agile Studio system

11: Epic ID <<EpicID>> not found in Agile Studio system

12: Project ID <<ProjectID>> not found in Agile Studio system

13: Sprint ID <<SprintID>> not found in Agile Studio system

14: User Story ID <<UserStoryID>> not found in Agile Studio system

15: Backlog ID <<BacklogID>> not found in Agile Studio system

Tech Note 19

16: GetPMFWorkType US is not a valid value

17: Status should be Resolved or Non-Resolved or All

Service: AddDevelopmentInfo

This service is used to pass information back into Agile Studio during rule check-in from Designer Studio. The list of related rules gets associated with the specified bug, task, or user story in Agile Studio. The service can also be used to pass in code changes that are related to a bug, task, or user story.


Usage

Action Type Yes One of the following values: “Check-in”, “New”, or “Save As.”

Identifies which type of action the developer took on the rule/code that they associated with an Agile Studio item.

Item ID Yes A valid Agile Studio item ID (example: BUG-12).

Agile Studio item for which the rule/code changes were being made.

Operator ID Yes Valid Agile Studio operator ID.

Operator ID of the developer who made the code/rule changes.

Source system Yes System name that can be found in the Environment list in Agile Studio.

System on which the rule/code change was made.

Remaining Effort No Numerical value Remaining effort (in hours).

Hours Worked No Numerical Values Additional hours the user spent working on the rule change/bug/user story.

Check In Notes No Text Notes the developer added while checking in the rule/code change.

ModifiedDate No Work complete No Boolean (Y or N) Did this check-in

complete the work on the task or bug? A user story cannot be marked as complete using this service.

Rule Class Name No Class name of the rule.

Tech Note 20


Usage

Old Ruleset Name No Ruleset name that the rule was checked out from.

Old Ruleset Version No Ruleset version that the ruleset was checked out from.

OldRuleName No Name that the rule was saved as or checked out from.

OldRuleKey No Key of rule before checkout/save as.

New Ruleset Name No Ruleset name that the rule was saved to or checked out to.

New Ruleset Version No Ruleset version that the rule was saved to or checked out to.

New Rule Name No New rule instance name after save as/checkout.

New Rule Key No New rule key name after save as/checkout.

Repository Name No Name of the repository in which the code changes were made.

Repository Path No File Path No File Path in the

repository in which the code change was made.

File name No Name of the file in which the code changes were made.

File Project No File Revision Number No Revision number

issued by the repository.

Branch No Branch into which the code/rule is being checked in.

Code Set Name Code Set Version

Tech Note 21

Expected outcome

Specified work item is related to the rule/code changes. The list of related rule/code changes will be shown on the Related Updates display on the Agile Studio item.

Returned values

ReturnMessage

ReturnCode

Return codes

1: Executed Successfully.

2: Item ID, Operator ID, and Source System are minimum required input parameters.

3: The Action supplied must be either Check-in, Merged, New, Save As, Delete, or Add.

4: The operator ID <<OperatorID>> is invalid: OperatorID not found in Agile Studio system.

5: The item ID is invalid: Item ID <<ItemID>> not found in Agile Studio system.

6: Effort data or status cannot be updated for resolved items.

7: The remaining effort value is invalid: Enter a non-negative number.

8: The additional effort value is invalid: Enter a non-negative number.

9: The additional effort value is invalid: You have entered more than the maximum Additional Hours Worked allowed. Enter a value of 1000 or less.

10: The item ID is invalid: Item ID supplied must be a non-resolved User Story, Issue, Task, or Bug.

11: You have entered more than the maximum Remaining Effort allowed. Enter a value of 1000 or less.

12: Total Hours Worked exceeds the allowed value of 1000. Existing hours worked value is <<Already entered Actual Effort>>.

16: Received values pertained to both rule and code changes. Send in values for just one or the other.

17: Format for Code Set Version should match ##-##-## (e.g.: 01-01-01).

Service: GetMultiplePMFItemDetails

This service is used to get the details of work objects as a bulk. A maximum of 20 work object details can be retrieved.


Usage

ItemID Yes Any valid Agile Studio work object ID

Tech Note 22

To retrieve details for more than one work object, specify the IDs as shown below.

Returned values

ReturnMessage

ReturnCode

ItemDetails (1 set for each item returned)

− pyID

− pzInsKey

− pyStatusWork

− LastUpdateDate

− LastUpdateOperator

− pyLabel

− pyDescription

− DuplicateItemID - If the current item is a duplicate of another work item

− ProjectID

− BacklogID

− SprintID

− UserStoryID

Tech Note 23

− ProductID

− ProductVersionID

− GoalID

− EpicID

− ImmediateParentTaskGroupID - Parent Task group ID of Task group/Task that are of SmartBPM project type

− Category

− Priority

− Severity

− AssignToResource - Operator name to whom the work object is assigned

− AssignToWorkbasket - Name of workbasket to which the work object is assigned

− StepsToReproduce - Steps to reproduce for bugs

− AcceptanceCriteriaList

- Criteria – Acceptance Criteria for user stories

Return codes

1: Successfully retrieved the data


3: <<ItemID>> is not a valid Agile Studio item

4: Could not get all the properties related to the entered Agile Studio item

5: Number of Items reached max length; user can fetch details up to 20 items

Service: GetPMFAssignments622

This service is used to return a list of tasks and bugs on a specified user's worklist.


Usage

OperatorID Yes

Returned values

ReturnMessage

ReturnCode

Assignment Details (1 set for each item returned)

− AssignedToID – ID of the operator

− AssignmentClass – Class of the assignment. Assign-Worklist/Assign-Workbasket

− AssignmentCreateDateTime

Tech Note 24

− AssignmentKey

− RemainingEffort

− WorkClass – Obj Class of the work object

− WorkCreateDateTime – Create date time of the work object

− WorkInsKey – pzInsKey of the work object

− pxUrgencyWork - Priority

− pyDescription

− pyID

− pyLabel

− pyStatusWork

− ResultCount – Number of items assigned to the given operator

Return codes

1: Successfully retrieved data

2: OperatorID must have a value

3: OperatorID not found in Agile Studio

Service: AddAttachmentsToPMFItem

This service is used to add attachments to any valid Agile Studio work object.


Usage

ItemID Yes pxUpdateOperator ID of an operator who

is adding an attachment

pyDescription Text that describes the attachment

To add attachments via the SOAP service, all the attachment details should be made available on pyRequestAttachmentPage page, which is used by Pega 7.3 to add the attachment to the work object.

Below is the sample code to send attachments using SOAP:

Create an activity to set the required data.

Tech Note 25

Returned values

ReturnMessage

ReturnCode

Return codes

1: Successfully appended the attachments to a work item

2: Item ID is mandatory

3: The item ID is invalid: Item ID not found in Agile Studio system

4: Unable to acquire lock on work item. The attachment will be added upon obtaining lock. Kindly retry.

5: Providing AttachClass and AttachStream is mandatory

Agile Studio REST services Agile Studio 7.3 introduces REST APIs. These services enable users to retrieve, create, and update products, releases, user stories, and bugs to manage their projects from an external

Tech Note 26

application. Agile Studio’s REST API documentation is available in the product using the Help center menu.

Custom integration If your organization requires you to have an Agile Studio integration that cannot use the above set of SOAP services, you can build a custom integration using the Pega 7.3 Service or Connector Wizards.

If you want to pull data from Agile Studio, create a service. If you want to push data out of Agile Studio, create a connector.

Pega 7.3 provides wizards that will walk you through creating new services and/or connectors. To access these wizards:

1. Log into Designer Studio.

2. From the Designer Studio menu, click Integration. 3. Click Connectors or Services and the type of integration that you want to create (for

example: SOAP integration).

See Tools for integration development tasks for more information on running these wizards.

https://pdn.pega.com/sites/pdn.pega.com/files/help_v73/procomhelpmain.htm#tools/index/toolsintegration.htm

Tech Note 27

© 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 information is the property of:

Pegasystems Inc. One Rogers Street Cambridge, MA 02142-1209 USA Phone: (617) 374-9600 Fax: (617) 374-9620 www.pega.com

Agile Studio

Document: Integrating Agile Studio with Other Applications

Software Version: 7.3

Updated: July 2017

integrating agile studio with other applications€¦ · introduction agile studio is integrated...

Documents