Fields
Fields
Configurable parameters can be updated in the macro editor: Edit the page, click the macro you want to update, and click Edit button to launch the Macro editor.
Survey/Vote columns:
If checked, indicates availability in either/both Survey or Vote macros
If crossed out, indicates field is not available for either Survey or Vote macro, depending on the column
Required - Indicates this is a required field for that macro
Field | Default | Survey | Vote | Description |
---|---|---|---|---|
Survey/Ballot Title | none | Required | Currently, in the Survey macro, the title is optional but the Actions dropdown will not be available if the title is not configured. Titles must be unique across multiple uses of the macros on the same page. Failure to maintain unique titles may result in unexpected behavior. In the future, surveys without titles may not be supported. | |
HTML header level for title | 2 | The HTML header level of the title. 1 for h2, 2 for h2, etc. 0 renders as regular text, and will not show up in the TOC macro that uses HTML headers for TOC items. | ||
Override default choices | 5-Outstanding, 4-More Than Satisfactory, 3-Satisfactory, 2-Less Than Satisfactory, 1-Unsatisfactory | Surveys only. This is a comma-separated list of choices that will override the defaults. Each choice must indicate a number value and name, separated by a hyphen. Example: 5-Best The numerical part should be in ascending OR descending order. You must also set the "Value of the last choice" and "Iteration step" fields to match. For example: to use the order 1, 2, 3, 4, 5 instead of 5, 4, 3, 2, 1
The default order of 5, 4, 3, 2, 1 uses an Iteration step of 1 and a "Value of the last choice" of 1. | ||
Changeable votes | false | If true this will allow the users to change their responses until the survey is locked. Recommended, as this will improve voter experience: (No one likes accidentally clicking the wrong choice and not being able to change it.) | ||
Summary location | Top | Surveys only. Where the location of the results summary table will appear. Top: Above the choices Bottom: Below the choices None: No results displayed! | ||
Allow/Show comments | Survey: true Vote: false | Allow users to comment on choices | ||
Value of the last choice | 1 | Surveys only If you have updated Override defaults choices, make certain this field matches that configuration. Example: for the default series of choices with numerical values: 5,4,3,2,1, the Value of the Last Choice should be set to: 1 | ||
Iteration step | 1 | Surveys only If you have updated Override defaults choices, make certain this field matches that configuration. Examples:
The purpose of iteration step is to support calculation for the summary average numbers. As the first options in surveys usually are the highest priority the calculation is reversed. | ||
List of manager groups | all groups | Surveys only | ||
List of managers | all users | Surveys only | ||
List of voter groups | all groups | This is a comma-separated list of GROUPS who are allowed to cast a vote. See Permissions for more details. | ||
List of voters | all users | This is a comma-separated list of USERS who are allowed to cast a vote. See Permissions for more details. | ||
List of result viewer groups | all groups | This is a comma-separated list of GROUPS who are allowed to see the summary table results. See Permissions for more details. | ||
List of result viewers | all users | This is a comma-separated list of USERS who are allowed to see the summary table results. See Permissions for more details. | ||
Always show results | false | Show results immediately, ignoring the list of result viewers and the need to have voted first. | ||
Show list of users who voted | false | Shows the list of users who have voted. | ||
Pending voters | false | Show the list of users who still need to vote. Requirement: either one of these must be set in order for Pending voters to be displayed:
| ||
Username style | plain login name | When users are listed (pending voters list, show list of users who voted, commenting interface, etc), they can be rendered in one of 4 ways:
| ||
Email delimiter | , | Some features offer email buttons. Example: pending voters will provide an email button to facilitate reminding users that haven't voted yet. Some email clients will handle different delimiters more gracefully than others. Outlook may behave better with semi-colon, so if you're organization requires the use of Outlook for internal emails, configure this field to semi-colon: | ||
Condensed view | false | Surveys only Each question is one row of a table. Many other features are disabled including comments, list of voted users and statistics | ||
Locked | false | Locks the macro, and no further votes may be submitted. For survey macros, Clear all Votes is not available when the survey is locked. Locking can be undone at any time. Either uncheck the Locked parameter in the macro editor. Or, for surveys with titles, survey managers will be allowed to Lock or Unlock the survey from the Actions dropdown. See Permissions for more details. |
Related content
Need support? Create a request with our support team.
Copyright © 2005 - 2025 Appfire | All rights reserved.