Pega Survey category — My Surveys tab

Access

The Survey Management landing page is part of the PegaSurvey framework. This page is available to those who have access to the PegaSurvey RuleSet. See Understanding surveys.

The My Surveys tab facilitates your work with surveys. For a high-level view of surveys, see Understanding surveys. For details on creating a survey, see below. For using a survey, see How to include a survey in a flow.

On My Surveys tab you can create surveys, question pages, and questions. You can also browse or search for existing surveys, pages, and questions; and edit, copy, or delete survey assets you find.

The Type field

At the top of the tab is the Type field. Select the type of survey asset with which you want to work. This populates the tab with all existing instances of the type you select and also sets what controls are available. The options are

• Survey
• Question Page
• Question
• Complex Question

See below for details of work with each type.

Advanced Search

You can filter a long list of survey assets by specifying in the Advanced Search area one or more of:

• the name or ID of the survey you want.
• a date range within which the survey you are looking for was last updated.
• the operator ID of the team member who last updated it.

Click Filter to see a more focused list of assets.

Specify your own operator ID in the Updated By field and click Filter to see only assets of the selected type that you updated most recently.

Working with surveys

To work with surveys, select Survey in the Type selector at the top of the tab. In the grid below, a list of all surveys, or all surveys that match the search criteria you have set, appears.

Click one of the buttons to the right of a survey listing to perform the following functions:

• Preview – Click to see a preview of the survey in its own window.
• Edit – Click to open the survey for editing. See “Editing an existing survey”, below.
• Delete – Click to delete a survey. Deleting a survey does not delete survey assets such as questions and question pages that the survey may contain.
• Copy – Click to copy the survey so you have a copy you can edit without changing the original survey. See “Copying a survey”, below.

Creating a new survey

Click Create Survey to display the Survey Builder.
Fill in the required fields and, if you wish, the optional fields, and add at least one question page to the survey. You can then click the Create button to create the survey.

After you have filled in the required fields, the Add Page button becomes active. Click it to add the first page to the new survey.
The Add form appears. At the top, the New radio button is selected by default. If you want to add an existing question page, select the Existing button.

• To create and add a new question page, make sure the "New" radio button is selected.
  • Provide a name for the page, and specify the RuleSet and RuleSet version to add it to.On the Instructions tab, provide any guidance the end user may need when working with the questions on this page.
  • The Advanced tab has optional settings. You can opt to:
    • tag this page as belonging to one of the categories you have established.
    • hide the page label and/or the page instructions by checking the appropriate checkboxes.
    • select the validation rule to use. To create a new validation rule, click the icon beside the field.
    • Specify a pre-action the system takes before displaying the page, by choosing from one of the available pre-actions listed. To create a new pre-action as a pre-action, click the icon to the right of the field. Click Get Params to display a modal dialog where you can provide the pre-action requires.
• On the Display Logic tab, optionally specify any logic that governs whether the current question page appears, or whether answers on this page govern the appearance of some other question page. To create a new question page or When rule, click the icon to the right of the relevant field.
• On the Questions tab, specify the questions that appear on this page. Add additional question rows by clicking the + "add" button. Note that the questions appear to the end user in the order that establish in this form.
  
  For each question:
  • Specify whether the current question is Simple or Complex.
  • In the Label field provide the text the end user sees with the question.
  • in the Question Name field, select the question to include. To create a new question, click the icon to the right of the field and complete the form that appears. See Creating a new question, below.
  • Click the Refresh checkbox to refresh the display and call server side display processing when the question is answered.
  • Click the Default Hidden checkbox to not display this question unless display logic directs it to appear.
  • Click the Blank Hidden checkbox to not display this question if the answer is blank.
  • Click the Required checkbox to make answering the question required.
  • Click the edit link to set or update the display logic governing this question.
    To delete a question, click the trash-can icon at the right end of its row.

Click the Check for Property Conflicts button to have the system validate the questions on the page to make sure that two questions are not mapped to the same property. If the system finds multiple questions mapped to the same property, it displays an error message identifying the questions, so you can correct the issue.

• On the History tab, provide a full description of the question and any usage information, to aid in survey maintenance.
• Click OK to create the page; click Cancel to close the form without saving your work.

• To add an existing question page, Make sure the "Existing" radio button is selected.
  • In the Name field, select the question page to add from the available options.
  • You can only change the display logic of an existing question page. On the Display Logic tab, optionally specify any logic that governs whether the current question page appears, or whether answers on this page govern the appearance of some other question page. To create a new question page or When rule, click the icon to the right of the relevant field.
  • Click OK to create the page; click Cancel to close the form without saving your work.

Editing an existing survey

To edit an existing survey, click the Edit button to the right of the survey name. The Survey Builder appears, displaying a series of command buttons. Note that the Check out button is disabled and that, in the Survey Settings display, the survey belongs to your personal RuleSet. This is because the Survey Builder automatically checks out the survey so you can edit it.
In the Survey Settings field you can update the following fields:

• Instructions — Provide instructions an end user may need. For instance, the survey may be embargoed before a certain date, or apply only to clients who fit a certain profile.
• Validation — Select the validation rule to use. To create a new validation rule, click the icon beside the field.
• Pre-Action - Select an activity to run before the user proceeds with the survey. To create a new pre-action, click the icon to the right of the field. Click the Get Params button to display a modal dialog where you can provide the parameters the pre-action requires.

The control buttons allow you to

• Add Page — you can create and add a new question page or select an existing page to add.
• Save — Save your changes without checking in the survey.
• Check In — Save your changes and check the survey in to source control.
• Check Out — If this button is enabled, click it to check the survey out of source control so you can edit it.
• Delete Checked Out — Delete the checked-out version of the survey. All your changes since the last time you checked the survey in will be lost.

Click the Refresh button to make sure you are seeing the latest list of pages in the survey.
The grid displays the pages already in the survey. Click the + icon to the left of a page name to expand the tree display and see the questions on that page.

• Click the View/Edit button in a page listing to open the page for review and editing.
• Click the Remove button to remove the page from the survey. The page is not removed from the survey but not deleted, and is available for reuse in this or some other survey.
• Right-click a page to display its context menu. The menu provides options to:
  • Add a question: choose "Simple" or "Complex" and whether you are creating a new question or adding an existing one.
  • Reorder Questions: reset the order in which the question appear on the page.
  • View/Edit: to review or edit the page.
  • Remove: remove the page from the survey.

Copying a survey

You can copy an existing survey to create a version you can edit or repurpose without changing the original survey.
Click Copy beside a survey listing; the Copy Survey form appears:

• The Applies To class entry cannot be edited. If you want to create a survey for a different class, cancel out of this form and click the Create Survey button to create a fresh survey.
• Provide a unique name for the survey in the “Survey” field, and identify the RuleSet and version in which to save it.
• Optionally identify any validation and pre-action associated with the survey.
• Update the Instructions field now, or after you have made your changes to the survey copy.
• Click Copy to create a copy of the survey, or Cancel to abandon your changes and close the form.
  

Working with question pages

To work with question pages, select Question Page in the Type selector at the top of the tab.

You can also select Survey as the Type and click Edit beside any survey to create a page in that survey, or to edit a page already included in the survey.

Creating a new question page

To create a new question page, display your surveys in the Survey Management tab, select a survey, and click Add Page. The rule form for the question page appears.

• On the Instructions tab:
  • Select a Category for the page from the options offered.
  • Hide the page label and/or the page instructions by checking the appropriate checkboxes.
  • Provide any guidance the end user may need when working with the questions on this page in the Instructions field.
  • Select the validation rule to use. To create a new validation rule, click the icon beside the field.
  • Specify a pre-action the system takes before displaying the page, by choosing from one of the available pre-actions listed. To create a new pre-action, click the icon to the right of the field. Click Get Params to display a modal dialog where you can provide the parameters the pre-action requires.
• On the Questions tab, specify the questions that appear on this page. Add additional question rows by clicking the + "add" button. Note that the questions appear to the end user in the order that establish in this form.
  
  For each question:
  • Specify whether the current question is Simple or Complex.
  • In the Label field provide the text the end user sees with the question.
  • in the Question Name field, select the question to include. To create a new question, click the icon to the right of the field and complete the form that appears. See Creating a new question, below.
  • Click the Refresh checkbox to have the section refresh when the question is answered.
  • Click the Default Hidden checkbox to not display this question unless display logic directs it to appear.
  • Click the Blank Hidden checkbox to not display this question if the answer is blank.
  • Click the Required checkbox to make answering the question required.
  • Click the edit link to set or update the display logic governing this question.
  To delete a question, click the trash-can icon at the right end of its row.
  
  Click the Check for Property Conflicts button to have the system validate the questions on the page to make sure that two questions are not mapped to the same property. If the system finds multiple questions mapped to the same property, it displays an error message identifying the questions, so you can correct the issue.
• On the History tab, provide a full description of the question and any usage information, to aid in survey maintenance.

Editing an existing question page

Note: when you edit an existing question page, the changes you make affect the question page in every survey in which it currently appears.

There are two routes to editing an existing question page. Both routes allow you to edit the question page; but they display the fields for editing in different user interfaces and provide slightly different user experiences:

• Starting from a survey: In the Survey Management tab, select "Survey" as the type. Select a survey in which the page to edit appears, and click its Edit button. In the Survey Builder display of the pages in the survey you selected, click the View/Edit button related to the page you want to edit. The Edit Page form appears. See the discussion above for information on filling in the fields.
  
  Right-click a page to display its context menu. The menu provides options to:
  • Add a question: choose "Simple" or "Complex" and whether you are creating a new question or adding an existing one.
  • Reorder Questions: reset the order in which the question appear on the page.
  • View/Edit: to review or edit the page.
  • Remove: remove the page from the survey.
• Starting from the list of question pages: In the Survey Management tab, select "Question Page" as the type. In the list of question pages, double-click the ID of the page you want to edit. The rule form for the question page appears. See the discussion above for information on filling in the fields.

Copying a question page

1. Select an existing question page by one of the methods described above.
2. Click the “Save as” icon at the top of the rule form to save a copy of the page.
3. Provide a unique name for the page; optionally adjust the Applies To, RuleSet and Version information; and click Save As.

Working with questions

Pega Survey supports two types of questions:

• Simple questions (or simply "questions") — the questions can be of the following types:
  • Radio button — the user responds to the question by clicking one of the available radio buttons to select the answer option beside it.
  • Freeform — the user enters a word or phrase.
  • Dynamic Dropdown Menu — the system presents a series of possible answers based on some logical setting, and the user chooses from among the presented options.
  • Repeat — this option is available in versions of PegaSurvey previous to 6.3 SP1. See the "freeform" type for complex questions.
  • Show Display Text Only — the "question" does not get an answer. This allows the survey designer to enter explanatory blocks of text within the survey page.
  • File — the user is invited to upload a file, as in "Attach your resume".
  • Checkbox — the user can check or leave unchecked a box in response to the question, as in "Check to receive a copy of the report".
  • Custom section — select the custom section which displays the controls the end user works with to respond to the question.
• Complex questions are generally questions that allow for multiple answers, such as a list of symptoms in which the end user can make multiple selections. Complex questions can be of the following types:
  • Checkboxes — The question provides multiple statements and the user checks the boxes beside the statements that apply.
  • Radio buttons — The question provide multiple statements and the end user clicks the radio button of the statement that best applies.
  • Free form — the question could be of the form "How often do you do each of the following?", and the free-form rows provide options such as swimming, biking, hiking, partying, and so on. The end user enters a number or a phrase to respond to each row. You can provide a fixed set of answer rows, or let the user dynamically add rows to adequately answer a question for which the number of required rows is not known in advance. 6.3 SP1 US-20055 12-12-12 wetma

To see existing questions, select Question or Complex Question in the Type selector at the top of the tab.

Creating a new question

To create a new question, display your surveys in the My Surveys tab and select a survey. Right-click any of the question pages in the survey and select Add Question or Add Complex Question in the context menu.
In the form that appears:

• Top Section — fill in the following fields:
  • Name — Provide a name for the question.
  • RuleSet — Select a RuleSet into which to save the question.
  • Version — Select a RuleSet version into which to save the question.

The Applies To field inherits its value from the Survey in which you are creating the question.

• Question tab — Provide the question the end user sees, using one of the layout options:
  • Plain Text — enter the text the user sees.
  • Rich Text — enter and format the text the user sees.
  • Custom HTML — select the custom HTML rule that presents the question text. To create a new HTML rule, click the icon beside the field.
  • Section — select the custom section that presents the question text. Click the Get Params button to display a modal dialog where you can provide the parameters the section requires.
• Answers tab — Provide the structure the for the end user to respond to the question. Depending on the question mode (described above) you select, various fields appear where you configure the answer:
  • Freeform (Simple Question) — The following optional fields are available:
    • Property Name — Use SmartPrompt to locate and select the property name this answer represents.
    • Default — Select the property to provide the default value for this answer. To create a new property to provide the default, click the icon beside the field.
    • Format — Select the format in which the user provides the response. The options are
      • Text — a text entry field
      • TextArea — a multi-line text input field for providing a longer answer. Additional fields appear where you specify the number of rows and columns in the control.
      • Date — a control for selecting a date.
      • DateTime — a control for selecting a date and time.
    • Edit Validate — Select the Edit-Validate rule with which to validate the answer. To create a new Edit-Validate rule, click the icon beside the field.
    • Validation — select the validation rule to use. To create a new validation rule, click the icon beside the field.
  • Radio Buttons (Simple Question) — The following optional fields are available:
    • Property Name — Use SmartPrompt to locate and select the property name this answer represents.
    • Direction — Select "Horizontal" or "Vertical".
    • Number of Items Before Wrap — Enter the number of radio buttons in a row (horizontal) or column (vertical) in the display.
    In the grid, add a row for each radio button that appears. Set the values for each item:
    • When — Optional. Select a When rule that governs whether this answer appears.
    • Display Value — The radio button label.
    • Value — the value of this option. This is the value that gets copied to the clipboard when the button is clicked.
    • Score — If you have established a scoring system for the survey's questions, the value for this answer goes here.
    • Selected — Select this option to have the radio button selected when the user reaches this question. Only one radio button in the group can be selected.
  • Dropdown Menu — Use SmartPrompt to locate and select the property name this answer represents. In the grid, add a row for each item in the dropdown menu. Set the values for each item:
    • When — Optional. Select a When rule that governs whether this answer appears.
    • Display Value — The radio button label.
    • Value — the value of this option. This is the value that gets copied to the clipboard when the button is clicked.
    • Score — If you have established a scoring system for the survey's questions, the value for this answer goes here.
  • Dynamic Dropdown Menu — The system dynamically creates the entries in the menu, depending on the settings you specify:
    • Property Name — Use SmartPrompt to locate and select the property name this answer represents.
    • Method For Generating Dynamic Select — depending on the option you select, further fields appear to allow you to configure it:
      • List View — in the fields that appear, specify the applies-to part of the List View rule that provides the data for the control, and the name (or "purpose") of the report.
      • Activity — in the fields that appear, specify the applies-to part of the Activity rule that provides the data for the control, the Activity Name, and the class of results returned by the activity. Click an icon beside one of the fields if you want to create a new class or Activity.
      • Cascading Dynamic Select — this option is not yet available.
    • Common Dynamic Select Information — in the fields in this section, provide:
      • Select ID — the name of this control.
      • Default Caption — the value or hint that appears by default.
      • Property for Option Display — the property in the data source that provides the caption for each option.
      • Property for Option Value — the property in the data source that provides the value for each option.
      • Enable Caching — set this to Yes (the default) to cache results during a session; set it to No to re-run the report or Activity each time the question is used.
  • List — This option is not available in PegaSurvey 6.3 SP1 and newer.6.3 SP1 US-20055 12-12-12 wetma
  • Checkbox (Simple Question) — Select the property that this option represents. Checking the checkbox selects this property. If you have established a scoring system for the survey's questions, provide a value for this answer.
  • File — The user sees an option to upload a file from the local computer. You do not need to configure anything.
  • Show Display Text Only — You do not need to configure anything.
  • Custom Section — Select the custom section that provides the answer mode for this question. To create a new custom section, click the icon beside the field.
  • Checkboxes (Complex Question) — In the Display Header field provide text that appears above the checkbox display.
    
    You can optionally specify the Property Type as Single Value, Value List, or Value Group. If you select Value List or Value Group, select in the field that appears the Value List or Value Group to use with this answer.
    
    In the grid below, add a row for each checkbox option, providing the following information for each:
    • Answer ID — The ID of this option.
    • When — Optional. Select a When rule that governs whether this answer appears.
    • Display Value — The label for this checkbox.
    • Value — The value for this option.
    • Property name — Select the property to connect to this option. To create a new property, click the icon beside the field.
    • Score — If you have established a scoring system for the survey's questions, the value for this answer goes here.
    • Selected — Select this option to have the checkbox checked when the user reaches this question. You can have as many options checked in this section as you wish.
  • Radio Buttons (Complex Question) — You can optionally specify the Property Type as Single Value, Value List, or Value Group. If you select Value List or Value Group, select in the field that appears the Value List or Value Group to use with this answer.
    
    The Header Details are the statements or questions the user sees ("Were you satisfied with your treatment?") and the second grid formats the radio buttons that appear under each header (Very Satisfied, Satisfied, Not Satisfied, and so on). Provide the following details for the radio button headers:
    • Label — The label the user sees.
    • Value — The value of the question.
    • Score — If you have established a scoring system for the survey's questions, the value for this answer goes here.
    In the grid, add a row for each radio button that appears. Set the values for each item:
    • Answer ID — the ID of this answer option.
    • When — Optional. Select a When rule that governs whether this answer appears.
    • Display Value — The radio button label.
    • Value — the value of this option. This is the value that gets copied to the clipboard when the button is clicked.
    • Default — Choose "Select" to have the radio button selected when the user reaches this question. Only one radio button in the group can be selected.
  • Freeform (Complex Question) — in the "Display Header" field, provide the text the user sees, such as "Top Five Preferences".
    
    You can optionally specify the Property Type as Single Value, Value List, or Value Group. If you select Value List or Value Group, select in the field that appears the Value List or Value Group to use with this answer.
    
    Add rows to the grid for the number of free-form answers you want the user to provide. For each answer, set:
    • Answer ID — the ID of this answer option.
    • When — Optional. Select a When rule that governs whether this answer appears.
    • Display Value — The field label.
    • Value — the value of this option. This is the value that gets copied to the clipboard when the button is clicked.
    • Data Type — Select "Text" or "Date".
    Optionally set the answer type to "dynamic". The user can then add additional rows in order to answer adequately questions for which the correct number of rows is not known in advance (for instance, "list your children's names").6.3 SP1 US-20055 12-12-12 wetma
• Advanced tab — configure the following optional features:
  • Warning — In certain circumstances you want the user to see a warning based on an answer given, time having expired, or some other reasons. In this section, provide the When rule that governs the warning and the section that presents the message. To create new rules for either field, click the icon beside the field.
  • Smart Info Reference — Select the section that populates the Smart Info display when the user hovers the mouse cursor over this question. To create a new section, click the link beside the field.
  • Supporting Reference — To provide a citation or supporting documentation, fill out the fields in this section:
    • Supporting Label — The label the user sees.
    • Supporting Type — Choose "File" or website "URL":
      • If you choose "File", a field appears where you can browse for the supporting file. When you have found it, click Upload File to upload it to the server.
      • If you choose "URL", provide the complete URL to the supporting document or site in the field that appears.
• Display Logic — Configure the following optional display logic features:
  • Top section — Check the checkboxes of the behavior you want to include in the question:
    • Required — the question must be answered before the user can continue.
    • Refresh — The section display refreshes when the user completes this question and tabs to the next question or page.
    • Hide on load of page — the question does not appear when the user first arrives at the page.
    • Clear answer when hidden — if display logic causes the question to be hidden, any answer that has been provided is removed.
  • Current Question Display Logic — Select the When rule that governs whether the question displays. To create a new When rule, click the icon beside the field. The When rule operates as soon as the user answers the question.
  • Other Questions Display Logic (Only appears for simple questions) — You can set one or more logical statements that, depending on the response to the current question, govern the appearance of other questions in the survey. The When rule operates as soon as the user answers the current question.
• History tab — provide a full description of the question and any usage information, to aid in question maintenance.

Editing an existing question

Note: when you edit an existing question page, the changes you make affect the question page in every survey in which it currently appears.
There are two ways to select a question to edit:

• In the My Surveys tab, select Survey as the type. Select a survey which contains the question to edit, expand the tree display so the question appears, and click its View/Edit button. The Edit Question form appears. See the discussion of creating a new question, for information on filling in the fields.
• In the My Surveys tab, select Question as the type. In the list of questions that appears, click the ID of the question you wish to edit. It appears in the Edit Question form. See the discussion of creating a new question for information on filling in the fields.
  

Copying a question

1. Select an existing question.
2. Click the “Save as” icon at the top of the rule form to save a copy of the question.
3. Provide a unique name for the question; optionally adjust the Applies To, RuleSet and Version information.
4. Click Save As.

You can create and update survey rules directly in the Designer Studio; see:

• About Survey rules
• About Question Page rules
• About Simple Question rules
• About Complex Question rules
  

However, Pega recommends starting from the controls in the landing page as they facilitate managing your survey assets. See the "Creating a new..." subsection in the relevant section above.

	current application, landing page
	Understanding surveys How to include a survey in a flow

Designer Studio — About Landing Pages

Help Home