Skip to main content

Collecting data

For the Creative Content team, each new Content Request Case begins with a request to create a brochure, slide deck, or video.

Ren outlines the information the team needs to receive to facilitate a new request.

Each request should include the following information:

  • The name of the individual submitting the request, also considered the "create operator" of the Case.
  • The requester’s email address (for the confirmation email).
  • The requester’s department (for reporting purposes).
  • The content request type - brochure, slide deck, or video.
  • A detailed description of the project.

Ren's task is to design a form inside the Case Type that collects this information and stores it for reference during the processing and review stages.

Ren’s first step is to add a field for each piece of data that his team must collect. These fields are defined in the Data Model of the Content Request Case Type.

The Data Model

In a Case Type, the Data Model contains the list of fields that collect and retain information relevant to the case. To access the Data Model, Ren performs the following steps:

  1. In the navigation pane of App Studio, click Case Types, and then click the Content Request Case Type.
  2. Select the Data Model tab.

Next, Ren adds fields to the Data Model.

Adding Fields

In Pega Platform™, each field corresponds to a data element that stores a single value associated with a specific case. Fields fall into two basic categories: system fields and custom fields.

System fields

System fields are automatically generated by Pega Platform™.  System fields are standard with the Pega Platform and appear as choices for every Case Type. Examples of system fields are Case ID, Create Date/Time, and Create operator name. To view the system fields associated with a Case Type do the following:

  1. In the Data model, click the Show system fields checkbox.

Custom fields

Custom fields are fields that are unique to the application or Case Type. Custom fields are created by clicking the Add field button in the Data Model view.

Clicking the Add Field button opens a modal window with text entry boxes for Field name and a Type.

Each Field name is entered in a text box. Field names should be short and descriptive.

The Field Type identifies the type of information stored in the system for the data element. By assigning a Field Type, a developer ensures that users provide valid data for that field and that the system displays the data in the correct format.

Some of Pega’s field types include:

  • Text (single line) – A single line of text.
  • Text (paragraph) – A large text box that accepts multiple lines of text.
  • Email – A text box that validates the format for an @ symbol.
  • Picklist – A short, predefined set of values.
  • Attachment – Adding a document or file to a case.

Based on the idea process flow, the custom fields required by the Content Request Case Type are as follows:

Field name Field Type
Requester email Email
Requester department   Picklist (Choices: Sales, Marketing, Product)
Request type Picklist (Choices: Brochure, Slide deck, Video)
Request details Text (paragraph)
Completed project Attachment
Project notes Text (paragraph)

Primary Fields

In Pega Platform, fields that are important to a Case can be designated as Primary. Fields with a Primary designation are automatically included on certain Case views to reduce the amount of UI configuration necessary.

Note: To learn more about Primary fields, see Configuring primary fields.

Pega automatically designates the Label and Description fields as Primary. Makers can designate additional Primary fields by performing the following steps:

  1. In the Data model view, click the Primary fields button.
  2. In the Primary field configuration window, click the + Add button.
  3. Click the check box next to the field name(s) of those fields to be designated as Primary.
  4. Click Add.
  5. Fields can be removed from the Primary field configuration list by clicking the trash icon associated with the field name.
  6. Click Submit.

Ren designates the Request details and Request type fields as Primary. Ren removes the Description field from the Primary field configuration list.

Review the following video to see Ren add the fields to the Content Request data model:

Note: The user interface depicted in the videos associated with this mission might differ slightly from your own due to alternate versions of the Pega Platform. This video has no audio and no closed captions.

Additional fields

Pega Platform offers many additional Field Types beyond those that Ren uses in this application. They include:

  • Integer: Allows input of positive and negative whole numbers including the value zero (0).
  • Currency: Allows for input of an amount. Currency symbol and decimal places based on localized format.
  • Date only: The calendar date displayed in a localized format.
  • Phone: Digits of a phone number displayed in a localized format.
Tip: An integer field stores only the value that begins at the first non-zero digit. For values that do not require arithmetic calculations, use a Text field type.
Note: For more information on the different field types that are available in Pega Platform, see the Pega Academy topic Fields.

Configuring a Form View

In Pega Platform applications, a View is what the end-user sees when they access the live application. A Form is a View that collects information that is to be retained in order to process a case.

Once the relevant fields have been added to the Case Type Data Model, Ren can configure the Form for each Step that requires information to be collected and retained.

Ren completes the following Steps create the form for the Enter request details Step:

  1. In the navigation pane of App Studio, click Case Types, and then click the Content Request Case Type.
  2. Select the Workflow tab.
  3. Click on the Enter request details step to open the contextual properties pane.
  4. Click the Configure View button.
  5. Click the + Add button located under the Fields section.
  6. Open the Fields dropdown menu.
  7. Click the checkbox for each field that is being added to the View/Form.
  8. Click Add.
  9. Click Submit.
  10. Click Save.

Ren adds the following fields to the Enter request details form:

  • Create operator name
  • Requester email
  • Requester department
Tip: Because Ren is using the Create Step, he does not need to add the Request type and Request details fields to the Content Request Form as they are automatically included because of their designation as Primary fields.

Editing fields

Now that fields have been added to the Enter request details Form, Ren is able to update fields for characteristics such as Edit mode and Required. Users must input data into required fields before a form can be submitted. By updating Edit mode, a field can be designated as Read-only.

To characterize the Requester email field as Required, Ren complete the following steps:

  1. In the view, Enter request details form, click the Gear icon located on the right side of the Requester email row.
  2. Scroll down to the Conditions section.
  3. In the Required box, click the dropdown arrow and select Always.
  4. Click Save to close the Edit field window.
Tip: Required fields are designated by a red asterisk next to the field name in the view.

Ren follows similar steps to update the Create operator name field’s Edit mode to Read-only.

In the following figure, slide the center vertical line to compare the Enter request details form's configuration view with the Enter request details view that is displayed to the requester in the Web portal:

Note: The Web portal is the environment, or Channel, in which the user interacts with the application. In development, Ren simulates the behavior of his application by running test cases in the Web portal.

Ren follows the same procedure to add two fields to the Submit content Step of the Processing Stage.

Stage Step Fields Conditions
Processing Submit content Completed project  Required
    Project notes  

 Review the following video to see Ren add the fields Enter request details and Submit content Steps:

Note: The user interface depicted in the videos associated with this mission might differ slightly from your own due to alternate versions of the Pega Platform. This video has no audio and no closed captions.

Check your knowledge with the following interaction:

In your environment

In your own Pega environment, add fields to your data model and then create forms in each Collect information Step.

Tip: A green clipboard icon is indicative of a Collect information step.

Be sure to designate fields that are important to the case as Primary in the Data Model. In the form, fields that must have data entered should be designated as Required.

You can recreate the fields that Ren added to his application or add fields that are necessary to collect data for your own process.

This Topic is available in the following Module:

If you are having problems with your training, please review the Pega Academy Support FAQs.

Did you find this content helpful?

Want to help us improve this content?

We'd prefer it if you saw us at our best.

Pega Academy has detected you are using a browser which may prevent you from experiencing the site as intended. To improve your experience, please update your browser.

Close Deprecation Notice