Adding Voting Fields

The Voting field type allows users to rank a record in two ways. A Total Votes tally allows users to vote for or against a content record. Each vote is assigned a weight as determined by the field administrator. The field shows the total votes for the record. An Average Votes tally allows users to rate the record based on a range of 1 to 5. All votes are averaged to determine the overall rating, which the field reflects.

By configuring voting reset rules, you can determine when to reset the votes in the voting field, if at all. Both field options provide the ability for a defined set of users. You can allow Field Administrators to view a detailed report when each user voted on the content along with the rating provided. This field provides access to the Voting Field Detail report. This report lists the user, email address, date, and rating for the field.

On this page

Task 1: Create the field

  1. From your application, go to Designer tab > Layout tab > Objects panel > click Add new.
  2. Select the field type, enter a name, and click OK.

    3. Field name guidelines:

    • If possible, keep names under 20 characters. For example, use Description instead of Description of the Asset.
    • Capitalize the first letter of each word in the field name. For example, use Predicted Impact instead of Predicted impact.
    • Avoid redundant wording in field names. For example, using the word Asset is unnecessary in the following series of fields: Asset Name, Asset Type and Asset Value.
    • Use noun-based field names whenever possible. Avoid verb-based field names, for example, Set Asset Name.
    • Do not use the names: Version, Level ID, or Content ID for fields that you add to an application or questionnaire. Field do not display properly with these names.
  3. In the General Information section, enter a description.

    4. Note: When you save the field, the system strips any HTML tags <?xm>l, <form>, <textarea>, <option>, <select>, <meta>, and <body> that you may have inserted in the description because they may constitute vulnerabilities in the system. The following example shows how you can correct the cascading style sheet (CSS) syntax for the <body> tag so that it will function correctly:

    <html>
    <head>
    <style type="text/css">.c0 { font-family: 'Arial' } .c1 { margin: 0px; background-color: #ffe4e1 } </style>
    </head>
    <body class="c0">
    <p class="c1">This is a text field.</p>
    </body>
    </html>

    Note: Do not use absolute positioning in HTML content.

Task 2: Configure options

In the Options section, select all of the following options that apply to this field.

Option

Description

Make this a searchable field

Makes this field available for display in all search results.

Display this field in global search results

Makes this field available for display in global search results. This option is only available if this field is set as searchable.

Validate this field when any value changes in the record

Designates that a field is validated whenever any value changes in a record.

If this option is not selected, this field validates only when the value in this field has changed.

Task 3: Set configuration options

In the Configuration section, set the following options:

Option

Description

Vote Tally

Specifies whether the results should display a total number of votes cast or an average of the ratings provided by end users.

Vote Weight

Specifies how much each vote is worth. For example, if the Vote Weight is "10" and ten users have submitted a vote, the total value displayed would be "100."

Field administrators

Designates specific users and groups as field administrators for the sub-form or voting field. These specific users and groups can edit and delete any entry made in the field.

To select the users and groups, from the Field Administrators list, click , and then select the users and groups that you want to designate as field administrators for the sub-form field.

The create, read, update, and delete rights available to a field administrator are dependent on the rights that are in place for the parent object, such as an application or a questionnaire.

If the parent object has only create and read rights, for example, the sub-form field in that object is restricted to those same rights.

Task 4: Set voting reset rules

In the Voting Reset Rules section, enter the rules for purging recorded votes. If you do not set the voting reset rules, votes are never purged

The following table describes filter criteria. Each row represents one set of filter criteria.

Option

Description

Field name

Specifies values to create a condition by selecting the field to evaluate.

Operator

Provides the filter that evaluates the field in the creation of a condition. The available operators depend on the type of field selected in Field to Evaluate.

Value(s)

Opens the Record Lookup, which enables users to choose which value or values to add to the condition.

Relationship

Connects two or more conditions together. If you add more than one condition, you can apply advanced logic to your search criteria.

Actions

Removes all data inputted when Save is clicked.

Advanced Operator Logic

Forms relationships between two or more conditions.

Task 5: Configure help text

Field-level help provides additional guidelines and instructions to ensure users enter appropriate information in the field. This Help text displays for users when they add, edit, and view records in the application where the field resides.

Consider the following general guidelines when writing field-level Help:

  • Use short, concise instructions that direct the user to take a specific action. For example, "Enter your name" is preferable to "This field is used to enter your name."
  • Use complete sentences whenever possible.
  • Avoid jargon (unless terms are critical and are familiar to your users).
  • Consider the technical aptitude of your audience, and author your help text at a corresponding level.
  • Use “you” and “your” as if you are speaking directly to the user.
  • Consider posing Help text in the form of a question, for example, "What is your level of interest?"

In the Help text section, do the following:

  1. Select a display option for both edit and view modes.
    2. Option

    Description

    None

    Help text does not display.

    Tooltip Icon

    Help icon displays beside the field in edit and view modes. Click this icon to display the field Help. The application dynamically sizes of the Help box based on the number of characters in the text.

    Field information on help icon hover

    Below

    Help displays below the field in edit and view modes.

    Field information below field

  2. If you are using help text, use the Rich Text Editor to format the text as needed.

Task 6: Configure field access

Access rights determine whether all users or only select users or groups have access to the field.

In the Access section, do the following:

  1. Select Public or Private.

    2. Note: Key fields must be public.

  2. If you selected Private, maximize the pane and click Add to select the users and groups to whom you want to grant access.