Adding and editing survey questions


About survey questions

Displaying the Search Survey Questions page

Adding or editing a survey question

Providing basic question information

Configuring available answers for dropdown questions

Selecting the list to use for list value questions

Configuring the maximum number of values in a list value dropdown

Configuring the default answer for short answer questions

Saving the question

Configuring access to the survey question


About survey questions

Survey questions allow you to request additional information from users when they perform specific functions.

The survey question maintenance function allows you to create questions to associate with those functions.

Displaying the Search Survey Questions page

You manage survey questions from the Search Survey Questions page. To display the page:

  1. On the Administration menu, click Site maintenance.
  2. On the Site Maintenance menu, click the Customization tab.
  3. On the Customization tab, click Survey questions.

To display a list of survey questions, provide search criteria, then click Search.

Adding or editing a survey question

To add a survey question, on the Search Survey Questions page, click Add Survey Question.

To edit a survey question, click the Edit link for the question you want to edit.

The Survey Question Maintenance form displays.

Providing basic question information

Pub ID In the Pub ID field, type a unique identifier for the question.

This identifier is used whenever the survey question is sent using XML.

Style From the Style dropdown for a new question, select how the question is asked. You can create either:
  • A dropdown. To answer the qustion, the user selects the answer from a dropdown. You create the list of available values. For activation questions, when the user selects an answer, you can also display additional questions.
  • A date. Used for report criteria and order entry questions only.To answer the question, the user enters or selects a date.
  • A list value. To answer the question, the user selects the answer from a dropdown. Instead of creating a new set of values, you select an existing Poetic list to use for the available values.
  • A list value multiple selection. Used for report criteria questions only.
  • A product find single selection. Used for report criteria questions only. Allows users to search for and select a single product number.
  • A product find multiple selection. To answer the question, the user searches for and selects a single product number.
  • A company find question. Used for report criteria questions only. To answer the question, the user searches for and selects a company name.
  • A text area. Used for activation survey questions only. To answer the question, the user types text (up to 2000 characters) into a text area.

Once a new question is saved, the style cannot be changed.

Type From the Type dropdown for a new question, select the function for which the question can be used. Note that date questions can only be used for custom report criteria and order entry questions.

Once a new question is saved, the type cannot be changed.

Question In the Question field, type the text of the question as it displays to users.

To localize the question, you use the list value maintenance function. Survey questions are copied to the SURVEY_QUESTION list for localization.

Active To make the question available for use, check the Active check box. You can only set this when editing existing questions. New questions are always active.

If the question is active for a function, then you are able to select that question to be asked.

If you make a question inactive, you cannot select it and it is not asked, although all existing answers to the question remain in the database.

Answer required To make the question required for the function you selected, check the Answer required check box.

Configuring available answers for dropdown and multiple check box questions

If the question is a dropdown question or a multiple check box question, then the form includes a table for you to create and manage the available answers. Each line in the table represents a possible answer. Each dropdown question must have at least one active answer.

For each answer:

ID In the ID column, type a unique identifier for the answer.

Because the ID is used as a list value code, it is subject to the same restrictions. The ID can only contain:

  • Letters (A-Z). If you type lowercase letters, they will be saved as uppercase.
  • Numbers (0-9)
  • Underscores (_)

You can also use plus signs, asterisks, and pound signs.

When the survey answer is sent in an XML document, this is used as the valueCode attribute.

Name In the Name column, type the text of the answer as it displays in the dropdown.
Active To make the answer available for selection, check the Active check box.

If you make the answer inactive, it no longer displays in the dropdown. If the answer was selected previously, it remains in the database.

Custom 1 In the Custom 1 column, type the Custom 1 value for the list value created for this option.
Custom 2 In the Custom 2 column, type the Custom 2 value for the list value created for this option.
Custom 3 In the Custom 3 column, type the Custom 3 value for the list value created for this option.

If this is a dropdown question being asked during activation, then you can use the Custom 3 value to provide a comma-separated list of identifiers of questions to display if the user selects this answer.

For example, if a survey question asks the method the user used to purchase the software, then if the user selects Physical store, a dropdown could display to prompt the user to select the store. If the user selects Web site, a field could display to prompt the user to enter the web site name.

Display Seq In the Display Seq column, type the order in which to display the answer. By default, the answers display in the order in which they are added.

To add more lines in which to specify answers, click Add More Rows.

To localize the answers, you must use the list value maintenance function. The list for each question uses the question ID as the list name and the question text as the description. See Editing and localizing list values.

Selecting the list to use for list value questions

If the question is a list value or list value multiple selection question, then you must select the list to use for the available options.

To search for and select the list, click the find icon next to the List name field.

After you select the list, depending on how the list is configured, links display below the List name field to allow you to:

Any changes here affect the list values wherever they are displayed. For example, if you are using the existing list of platforms for the available options, and you change the name of a platform from the Survey Question Maintenance form, the platform name will change wherever the platform values are used.

Configuring the maximum number of values in a list value dropdown

For single selection list value survey questions, a resource flag in ApplicationResources.properties determines the maximum number of values that can be displayed in a dropdown.

poetic.flag.maxListValuesForSurveyDropdown=50

If the number of available values in the selected list is less than or equal to this number, then the question displays as a dropdown.

If the number of available values is greater than this number, then the question displays as a field with a find icon. Users must use the list value search to select the answer.

Configuring the default answer for short answer questions

If the question is a short answer question, you can specify a default answer for the question.

In the Default answer field, type the default answer to display for the question. If you do not specify a default answer, the answer field is blank when users first see it.

Saving the question

When you are finished editing the question, click Save.

On the Search Survey Questions page, click Reset Cache.

Configuring access to the survey question

When you create a new survey question, Poetic automatically creates a corresponding security setting to control who is allowed to answer the question. The security setting is named using the survey question ID. The survey questions are added to a separate Survey Questions category.

By default, the setting is configured to allow all users to see the question. To restrict access to the question, use the security setting maintenance function. See Assigning security settings to security roles for details.

Note that the security settings are currently only enforced for order-related questions. Entitlement creation and activation questions are not restricted.

If the question is required, but a user is not able to see the question, then the answer is determined as follows: