Application Specifications
|
|
The Details tab describes how a specification is processed and provides supporting information such as business objectives, actors, and related requirements. For ease of use, the fields on this tab are organized into the following sections:
The following fields are found at the top of the form and are always visible (never collapsed):
Field |
Description |
Status |
Optionally capture the specification's current development state. Choose from the list of standard values:
Or define custom status values for your project team to use. |
Type |
Indicate how this specification will be fulfilled. For example, if you are using a flow action, choose the Standard values include:
|
Complexity |
Specify the estimated level of effort to implement the specification. If no value is specified, the complexity level will be set to blank. Choose from: |
[Specification Text] |
Describe the specification's expected behavior and steps required to complete it. Do not enter information about exception paths; those are defined by other specifications in the application. Use the rich text editor to format the specification text. |
View/Edit in Microsoft Word |
Click to edit your specification's text externally in Microsoft Word (you will need to close any other PRPC initiated Word sessions first). Once you have saved your edits and closed Word, a "Description" document is attached to the specification. The rich text editor is replaced with the message "Specification description was last modified using MS Word on [date]". All future edits must be made in Word unless you delete the "Description" attachment or disable the Use as Description? checkbox in the Attachment section of this form. |
Fields in the Comments section give you access to Pega Pulse. This section is collapsed by default; click the section name to expand it.
Enter
key.
Specification Attachments are typically reference material such as Word files, 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 display 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. When enabled, this checkbox includes the attachment in documentation generated by the Application Document Wizard. In most cases, the system inserts the attachment using Microsoft Word's OLE capabilities. Otherwise, this checkbox is disabled. |
Use as Description? |
Read only. When enabled, this checkbox uses the contents of the attachment as the description for the specification. This option is only available for attachments of Microsoft Word format (.doc or .docx extension). Note: When you select this checkbox, the contents of the Word document overwrite the original [Specification Text]. |
To create new attachments and edit existing ones simultaneously, click the Add/Edit Attachments button:
The following fields are available once you expand the Advanced 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. Choose from: |
Format |
Choose a format for the specification based on your application's Project Methodology:
Additional fields become available in the Advanced section of this form based on your selection. |
Protocol |
Appears when the specification Type is set to Choose the service or connector protocol the specification will use to communicate with the system. |
# Interchanges |
Appears when the specification Type is set to Specify the expected number of communication cycles, or interchanges, the specification will use. |
Data Source Exists? |
Appears when the specification Type is set to When enabled, this checkbox indicates there is another, external system with which this specification communicates. |
Additionally, these embedded sections are available in the Advanced section of the form:
Section name |
Description |
Acceptance Criteria |
Appears when the specification Format is set to Specify the criteria a user story must meet in order to complete it. Add an remove rows from the list as needed. |
Actors | Specify the primary actors that process the work to complete the specification. If no actors are specified, a default value of Any is used. |
Requirements |
Displays the list of requirements linked to this specification. Expand a row to review details on the requirement or click on the to open it directly. Click the Add/Edit Requirements button to create a new requirement, link an existing requirement, or disassociate a requirement from this specification. Note: new requirements are automatically created in the specification's case type and ruleset version. |
Subject Matter Experts | Specify the names of people or resources who are experts on this specification and how it is implemented. |
Pre-Conditions |
Appears when the specification Format is set to 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." |
Post-Conditions |
Appears when the specification Format is set to 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." |