Creating a parent alternative set

The parent set defines how the answers can be used in surveys, such as in a dropdown or choice option. It also defines how the data for the child alternatives (options) are stored in the database, such as an Integer or Enumeration field. These properties define alternative set parents:

AlternativeSetId

A unique identifier for the Alternative set.

Name

The name of the Alternative set, which appears only in configuration screens.

Priority

Determines where in the list this Alternative set appears, lesser numbers above greater numbers.

Company

Select a company to set the scope of the Alternative set.

ContentKind

Data type; instructs the database to expect values of the selected type.

Important: This is a partial list of the commonly used ContentKind; others are available depending on the configuration of your instance.

• AUTOINDEX_TEXT — You can use this option to filter on a text field in reporting. There is a DO NOT EXCEED limit of 600,000 values; but in practice, performance degrades around 200,000 values. Additionally, performance of these fields depends heavily on how the field is being used, not solely by the number of values. For example, doing a split on an auto-indexed text field with lots of values in an report is generally a bad idea, but including one with lots of values in filters should be fine. If you intend to implement Weighting using the field, limit the number of auto-indexed text field values to 75,000. Indexed text fields can be configured using Medallia Setup to support a maximum of 2,000,000 values with the High cardinality for auto indexed... property.

• COMMENT — Similar to TEXT, but with some additional characteristics. When used in custom reports, COMMENT Alternative sets are displayed on a separate line when included in a record-field-split element, and are the only Alternative sets you can use in asknow-record-split elements. There is no character limit for comments unless specified in the Character Limit

  .
  Tip: While COMMENT Alternative sets can be translated, they cannot be machine translated. Best practice is to use TRANSLATABLE_COMMENT which has the same characteristics as COMMENT, and can be machine translated. For more information about machine translation of comments, see Translating comments.

• COUNTRY — Stores a country code. Must be a valid ISO country name or code.

• DATE — Date without the time.

• DATETIME — Date and time.

• DYNAMIC_ALT_SET — Do not use; for internal-use only.

• EMAIL — Stores an email address as text. Some validation is applied.

• ENCRYPTED — Unsopported, do not use.

• ENUMERATION — The most frequently used alternative set type, which maps a number to every value. For example, in a Yes/No alternative set Yes might be mapped to 1 and No mapped to 2.

• FRACTIONAL — This option is like a generalization of MONETARY_CENT, but instead of using a resolution of 1/100 you can use 1/n where n is the multiplier. For example, by setting the multiplier to 10 you get resolution of 0.1, by setting the multiplier to 100 you get 0.01, and by setting the multiplier to 3000 you get resolution of 0.0003333333 and so on. The multiplier must be less than 2^31 (21474836).

  When calculating composite scores, consider using a multiplier of 120, which provides accuracy to 1/120th of a point. Using normal floating point numbers can accurate to more decimal places, but they also have a much greater impact on the amount of system memory used. Multiplying by 100 (2 digits of accuracy) or 128 (y bits) might seem more natural, but note that 120 is divisible by 2, 3, 4, 5, and 6, which allows for perfect accuracy for calculations on less than 7 questions.

  Use this option instead of REAL_NUMBER if you need Slug indexing. The number of bits used is log2((max-min)*multiplier) for the field to be available through the Data API.

• HYPERLINK — Stores URL type information and automatically displays a hyperlink on reports. This type of Alternative set can be used with Q-fields, E-fields, and R-fields. Your hyperlink must begin with http. If you use a field with a HYPERLINK Alternative set in comments box, it appears as in the image below, with the hyperlink fields displayed after the comment field (in sorted order):

  

• INTEGER — For storing numbers with no decimals. The maximum number is 2,147,483,647.

• JAVAENUM — Do not use; for internal-use only.

• MONETARY_CENT — For storing numbers with two decimals. You must specify a maximum number that can be stored, up to 2,147,483,647. That limit affects the number of bits used in the Slug index.

• PHONE — Store a telephone number. Same limits as TEXT.

• REAL_NUMBER — The first choice you should consider for storing real numbers because it provides full precision. However, Slug cannot index such fields, so you cannot use it for Slug calculations in reports. These fields are still displayed where Slug is not required, such as the Responses Form. Note that REAL_NUMBER fields are not available through the Data API. Use FRACTIONAL (fixed-precision) if you need the field to be available in the Data API.

• SHORTINT — For storing numbers with no decimals. The maximum number is 32,767. For larger values, use INTEGER instead.

• TIME — Stores time information, with no date.

• TEXT — Stores information as plain text. The maximum character limit is 100,000.

• TRANSLATABLE — Used when creating Unit group data fields or Unit data fields that you want to appear on the Translations screen.

• TRANSLATABLE_COMMENT — Similar to COMMENT, but with the ability to be machine translated. Best practice is to use TRANSLATABLE_COMMENT instead of COMMENT.

• UNIT_GROUP — Do not use; for internal-use only.

FormKind

Defines how you want the Alternative set to appear to survey takers in surveys. Options available for this property depend on the ContentKind of the alternative set. Text-based types allow you to select from SHORT_TEXT, MED_TEXT, and LONG_TEXT options, which determine the visible size of the field displaying the Alternative set. Other types allow you to select a dropdown field or a series of radio buttons.

Important: Multi-valued field Alternative sets must use the Dropdown FormKind instead of the default value of Radio button. If the FormKind remains Radio button, form choices intended to be multiple selection are instead single selection.

Encoding

Specifies the field type used to store survey answers for the alternative set, such as Text or Enumerated. Text fields can be used only in Responses List reports with no sorting, Responses Form reports, and exports. To put a field in a dropdown or on a Responses List report with sorting, it must be non-text.

MagicId

This property has values for very specific and unusual workarounds. Do not set a MagicId unless instructed to do so by another procedure in the Experience Cloud documentation.

StdRange

Check this property if you are not using a standard satisfaction range (such as Satisfaction range or Likelihood), and need a new range type Alternative set (such as Scale 0-10). This enables the range to be displayed horizontally on the grid. Also, check this property if you want to use alert logic to create a trigger based on a range of scores.

ForAskNow

When checked, the Alternative set will be available in the Ask Now feature. If you check this property, ensure that the RI properties of the child alternatives are configured properly.

Export value is numeric

When checked, the Export value property of each alternative must be numeric.

DefaultAlternative

Sets a default value for fields that use the Alternative set.

MaxWordLength

If this is an Enumerated Alternative set and will be used in survey grids, you can set a MaxWordLength so the translations are not crowded in grid headers. If a translation exceeds this value, it produces a warning message with an explanation.

UsedByCompanies

Lists the companies on this instance that use the Alternative set.

Creating alternatives

Alternatives, also know as Answer options, Choice set items, Choices, are the options of the parent Alternative set: they represent the possible answers respondents can enter for questions. To add items to an Alternative set, select the parent in the list and then click New AlternativeDb.

If you add an item to an existing Alternative set (one that already has been used in surveys), click Sync version for each survey version that references that Alternative set, otherwise the item is not available. If the Alternative set is used by Event fields, it's even more important to click Sync version on every survey version that uses that field, as otherwise invitations are set to the incorrect status (ready_for_se). For more information on how to sync versions, see Survey versions.

These properties define alternatives:

Parent

The name of the parent Alternative set.

In survey

The text value that appears for this alternative in web surveys. For example, Yes. If more than one alternative in the set have the same In survey value, both columns share the same header.

This is known as Context in Translations. For more information, see Translations screen.

In mobile survey

The text value that appears in mobile surveys.

This is known as Context in Translations. For more information, see Translations screen.

Employee report

The text value that appears in Employee reports when using Employee programs.

This is known as Context in Translations. For more information, see Translations screen.

In report

The text value that appears in reports, such as Profiler and in filters.

This is known as Context in Translations. For more information, see Translations screen.

Short form

The text value that appears in report column headers.

This is known as Context in Translations. For more information, see Translations screen.

Description

Appears in grid description areas of surveys.

Visibility

Determines whether the alternative is visible in surveys and reports. You can select from the following options:

• SURVEY_AND_REPORTING_REQUIRED — This is the standard options, which makes the alternative visible in surveys and reports.

• SURVEY_AND_REPORTING_OPTIONAL — If you do not want the alternative to appear in surveys, select this option and check the Hide Optional Alts property on the Profiler/Segment Groups screen. This option still shows the alternative in Feedback Detail tab in reports.

• SURVEY_ONLY — Select this option if you want to provide an option on the survey, but do not need to use it in calculations (such as with N/A alternatives).

• HIDDEN — Select this option to hide the alternative completely, such as when it is no longer needed. Hidden alternatives do not appear in Filters and Control panel. Hiding an alternative does not disrupt the integrity of your historical data, even in Feedback Detail tab.

SequenceNumber

The unique, immutable identifier for the alternative.

NumericValue

An integer value assigned to the option, and which is used for numerical calculations on the option.

Leave this property blank unless it will be used in numeric calculations (such as in Satisfaction and Ranker reports) or in a calculated reporting field. For example, a "Yes/No" answer is not generally used in calculations, so there is no need to assign a numeric value to the two options. Note that "counting" calculations do not need numeric values for the options.

However, an answer set that is a scale of 0 to 10 might need calculations on the answers, in which case each option value needs a numeric value (e.g., 0 to 10). This allows AVERAGE or SUM calculations and aggregations to be made on the answers. Only options with a numeric values are included in calculations; options that do not have numeric values are ignored.

Note: For Medallia Mobile survey grid nodes, empty Numeric Values show as "other" as the answer choice.

Export value

Value to use in survey exports. This can be either text or numeric if the Export value is numeric property is checked for the Alternative set.

PriorityRaw

Sort order for display.

RIColumn

Note: This property is used by legacy standard reports only, and has no affect on Alchemy Experience Reporting reports.

Determines the column in which the alternative will be shown on the Responses Form report. If you want to create a space between alternatives, skip a number. (For example, 1, 2, 3, and 5 for four alternatives in an alternative set. You must set this property if you want the answer (to questions that use alternatives) to be displayed on the Responses Form report. (You must also add to the report the relevant question using the alternative set.)

RIColSpan

Note: This property is used by legacy standard reports only, and has no affect on Alchemy Experience Reporting reports.

Sets the width of the column in the Responses Form report. Start with 2. You must set this property if you want the alternate to appear in the Responses Form report.

BoxColor

The HTML color for the Responses Form table cell that appears when this alternative is selected by the survey taker. If it is not set, Experience Cloud uses a default color.

FontColor

The text color on Responses Form table cells. If it is not set, Experience Cloud uses a default color.

Is Other Option

When checked, the alternative is considered an other option, usually associated with another question.

TranslationExplanation

Used in translations, this property provides translation instructions to the translator.

Modifying alternative sets

You can modify an Alternative set, even after it has been associated with a field. Examples include:

• Adding or modifying one of the possible values in an ENUMERATION Alternative set, such as adding Red to the Color alternative set.
• Removing one of the values in an ENUMERATION Alternative set. Note that you cannot delete a value. If a value is no longer needed, change the Visibility of the value to HIDDEN so it is no longer displayed in surveys. Historical data continues to be available in reports.
• Changing the Alternative set that is assigned to a field. For example, you can change the ContentKind of an alternative set from COMMENT to TRANSLATED_COMMENT. The selections available to you are determined by the original ContentKind you chose for that Alternative set. For example, ENUMERATION Alternative sets cannot be changed to a different type. However, COMMENT Alternative sets can be changed to several different types.

Before changing the Alternative set associated with a field, consider the scope of your proposed change. For major changes, such as converting from a 0-10 scale Alternative set to a 0-10 scale with N/A Alternative set, create a completely new field, and then use the Re-push selected survey spec button for each survey using those fields. For more information, see Push surveys.

If you change the ContentKind for an Alternative set that is being used by a field, you must run a backfill after making the change. For more information, see Backfill. The following table lists the ContentKind types that can be converted into another kind:

For minor changes, complete the following steps:

1. On the Alt Sets and Fields screens, use the Bulk menu to export your Alternative sets and fields, preserving the original values. in case you need to restore them later.

2. On the Fields screen, select the new Alternative set for the AlternativeSet property, and then click Save.

3. Re-push any survey specs that use the field, as described in Push surveys.

ParseException while transferring surveys for [Company yourCompany], will NOT retry later, debug: common.parse.ParseException: Value 'XX' is not a valid option for 'e_yourcompany_field_alt' (options are: [a, b, c, e, ...etc] (XX more elems)) (strategies: [MAP_BY_SEQUENCE])