The Details tab describes how a specification is processed and provides supporting information such as business objectives, actors, and related requirements.
Guidance on top level fields
The following fields are found at the top of the form and are always visible (never collapsed):
Field
|
Description
|
| Status
|
The current development state of the specification. Select from the list of standard options:
New, Pending-Details, Pending-Blocked, Pending-Deferred, Pending-Development, InProgress, Complete, Withdrawn
You can define custom status values for your project team to use.
|
| Type
|
An indication of how this specification is implemented. For example, select Human based step for a flow action or Decision for a decision shape in a flow.
Standard options include:
Alternate Path, Automated Step, Correspondence, Decision, DSM, Entire flow, Human based step, Integration, Primary Path, Report , Starting screen, and Sub Process.
|
| Complexity
|
The estimated level of effort to implement the specification. If you do not specify a value, the complexity level is set to blank.
Standard options include: Low, Medium, and High.
|
| Release
|
The ID of the target release that implements this specification.
The text you enter in this field appears next to the specification in worksheets generated by the Sizing wizard. Specifying a target release facilitates accurate project sizing.
|
| Iteration
|
The version of the specified Release that implements this specification.
The text you enter in this field appears next to the specification in worksheets generated by the Sizing wizard. Specifying an iteration facilitates accurate project sizing.
|
| [Specification Text] |
The expected behavior of the specification and required steps to complete it.
Use the rich text editor to format the specification text.
Do not enter information about exception paths. These are defined by other specifications in the application.
|
| View/Edit in Microsoft Word
|
Click to externally edit the specification text in Microsoft Word. Close any other PRPC-initiated Word sessions first.
After you save and close the Word document, a "Description" file is attached to the specification. The rich text editor is replaced with the message "Specification description was last modified using MS Word on [date]".
 Make all future edits externally in Word until you delete the "Description" attachment or clear the Use as Description? check box in the section of the form.
|
Guidance on DSM fields
The section is visible for DSM type specifications. Select a value from the Subtype drop-down list to indicate how this specification is implemented. Each subtype maps to a tab in the worksheet generated by the Sizing wizard.
Based on your selected subtype, a set of dynamic fields appear. The values you enter in these fields are used to populate the worksheet.
Keep the default Unknown subtype if you do not know how this specification is implemented. Specifications of an Unknown subtype do not appear in the worksheet.
You must have access to Decision Management rulesets to create DSM specifications. You can add these rulesets directly or specify "PegaDM" as a built on application on the Definition tab of the Application form.
Guidance on Comments fields
Fields in the section give you access to Pega Pulse. This section is collapsed by default; click the section name to expand it.
- Use the Message, File, and Link tabs to enter text, upload a document or image, or add a URL to your post
- Click Share to make your post visible
- Use the Show: filter to quickly narrow down posts
- Respond to posts by typing in the text input and using the
Enter key.
Guidance on Attachments fields
Specification attachments are typically reference materials, such as Word documents, UML diagrams, PowerPoint presentations, informal sketches, or files from external systems.
This section is collapsed by default. Click the section name to expand it.
If your specification has existing attachments, they appear as a list in the following format:
Field
|
Description
|
| [File name]
|
The name specified when the attachment was first uploaded. Click to download or open the file directly.
|
| Include in Documentation?
|
Read-only.
This check box is automatically selected or cleared, based on the state of Use as Description?. When selected, the attachment is included in documentation generated by the Application Document Wizard.
In most cases, the system inserts the attachment using Microsoft Word's OLE capabilities.
|
| Use as Description?
|
Read-only.
When selected, this check box uses the contents of the attachment as the description for the specification. This option is available only for attachments of Microsoft Word format (.doc or .docx extension).
Note: When you select this check box, the contents of the Word document overwrite the original [Specification Text].
|
Expand the section and click Add/Edit attachments to maintain the library of reference materials for the specification.
To add file attachments:
-
Click Select file(s) to browse to a directory on your local system.
-
Select a single file, or press the CTRL key to select multiple files.
-
Click Open.
-
Review the list of pending new attachments.
You can update the values in the Description field.
-
Click Submit to save your changes and close the modal.
Alternatively, you can drag and drop files from an open directory or your desktop to the Drag and Drop Files section of the modal.
To add link attachments:
-
Enter a URL.
-
Enter a Description (optional). The Description defaults to the URL if the Description field is left blank.
-
Click Add Link.
-
Review the list of pending new attachments.
You can update the values in the Description field.
-
Click Submit to save your changes and close the modal.
To edit file attachments:
-
Click the name of an attachment to download it to your local file system.
-
Edit, save, and close the file.
-
Click the Delete icon to remove the existing attachment from the list.
-
Follow the instructions for creating an attachment to upload your edited file.
To edit link attachments:
-
Click the Delete icon to remove the existing attachment from the list.
-
Follow the instructions for adding a link attachment to add your edited link.
Guidance on Advanced fields
The following fields are available once you expand the section.
Field
|
Description
|
| Business Objective
|
Specify a business objective that is met by this specification.
Business objectives are defined on the Application rule and are also accessible from the Application Overview landing page.
|
| Trigger
|
Specify an event or access method (how an actor interacts with the system) that triggers the specification.
Standard options include: Email, External Service Call, Image, Letter, Phone, SWIFT, or Web Browser.
|
| Format
|
Select a format for the specification based on your application's Project Methodology:
- For Pega BPM or other implementation methodologies, select
Use Case.
- For Pega Scrum, select
User Story.
Additional fields become available in the section of this form, based on your selection.
|
| Protocol
|
Select the service or connector protocol the specification uses to communicate with the system.
This field appears when the specification Type is set to Integration.
|
| # Interchanges
|
Specify the expected number of communication cycles, or interchanges, the specification uses.
This field appears when the specification Type is set to Integration.
|
| Data Source Exists?
|
Select this check box to indicate there is another, external system with which this specification communicates.
This field appears when the specification Type is set to Integration.
|
Additionally, these embedded sections are available in the section of the form.
Section name
|
Description
|
|
|
Specify the criteria a user story must meet in order to complete it. Add and remove rows from the list as needed.
This section appears when the specification Format is set to User Story.
|
|
|
Specify the primary actors that process the work to complete the specification.
If you do not specify an actors, a default value of Any is used.
|
|
|
Review the list of requirements linked to this specification.
Expand a row to review details on the requirement or click the requirement name to open it directly.
Click Add/Edit Requirements to create a new requirement, link an existing requirement, or disassociate a requirement from this specification.
Note: New requirements automatically use the same case type and ruleset version as the linked specification.
|
|
|
Specify the names of people or resources who are experts on how this specification is implemented. |
|
|
Specify the events, criteria, or circumstances that must occur before the steps in the specification can be executed.
For example, "The Customer Service Representative must be logged into the system."
This section appears when the specification Format is set to Use Case.
|
|
|
Specify the events, criteria, or circumstances that must occur as part of the specification's successful completion.
For example, "The Customer's account is updated to reflect their change of address."
This section appears when the specification Format is set to Use Case.
|
About Application Specifications
Open topic with navigation
Adding file and link attachments