How to include a survey in a flow

Surveys are available to those having access to the PegaSurvey RuleSet.. See Understanding surveys.

You can add a survey or a survey group to a flow. PegaSurvey includes a section and sample subflows to handle both individual surveys and survey groups.

Add a survey to a flow

There are three ways to add a survey to a flow:

1. Add the survey to a flow action

You can add a survey, or a specific page of a survey, to a flow action by adding the section SurveySection to the flow action and specifying the survey it is to display. You also need have the flow action reference the activity SetupQuestionnaire and pass it the survey name as a parameter.

2. Add the SurveyDriver flow as a sub-flow

Locate the SurveyDriver flow. When you call it as a sub-flow from your process flow, it requires the following values:

• The name of the survey to include
• The status of the current work item. You can set it to Pending-Survey or some similar value
• The routing once the survey is done (to an operator or to a workbasket)

Optionally:

• Set RunAsScreenFlow to True to have the pages of a multi-page survey each appear as a single screen.
• Set IsBreadCrumbReqd to True to display “breadcrumb” navigation hints to help users understand where they are in the survey.
• Select the service-level agreement (SLA) that applies to this survey.
• Adjust the NavigationType setting. By default, this is set to Plain. The options are
  • Plain: The questions appear on a single page, grouped by their question pages.
  • Tree:  The questions appear page by page. A navigation tree appears at the upper left so the user can move forward or back in the survey.
  • Ultimate Table: The questions appear as rows in a grid, as if the survey were a spreadsheet.
    

When the survey is complete, the survey driver routes the work item to an Operator or Workbasket for further processing, with an SLA assigned to that step and the status of the work item updated. The sub-flow then hands control back to the main flow.

Add SurveyDriverScrFlow to present the survey in a screen flow

To add a multi-page survey as a screen flow, call the flow SurveyDriverScrFlow. Configure it as for SurveyDriver, above. Each page of the survey appears as a single screen as the user navigates through it.

Add a survey group to a flow

Locate the SurveyGroupDriver flow. When you call it as a sub-flow from your process flow, it requires the following values:

• The name of the survey group to include
• The status of the current work item. You can set it to “Pending-Survey” or some similar value
• The routing once the survey is done (to an operator or to a workbasket)
• Optionally, service-level agreement (SLA) information

When the surveys are complete, the survey driver routes the work item to an operator or workbasket for further processing, with an SLA assigned to that step and the status of the work item updated. The subflow then hands control back to the main flow.

	Flow Screen Flow
	Understanding surveys

...

Open topic with navigation