E-fields

Reporting > Report Helpers > Fields > E-Fields

Important: E-fields are superseded by Event fields.

E-fields (also known as Event fields) describe either the actual customer or employee episode or event, or they track various aspects of the survey record as it moves through Medallia Experience Cloud.

The event information comes from the company as part of the data feed. That information always includes the ID of the Unit associated with the event, and usually includes information about the feedback respondent as well. Some of the default Event fields are:

  • Unit ID (e_unitid) is the Unit associated with the event and is required.

  • Email (e_email) is the email address of the respondent. It is required for feed-based surveys and Rapid Responses.

  • First name (e_firstname) and Last name (e_lastname) are the name of the individuals. Together, they populate the Full name (a_fullname) field.

  • Other default company-supplied fields include customer or employee address and telephone number.

Companies can also create their own custom E-fields, often called Company E-fields. In general, use the default E-fields whenever possible. However, you might use Company E-fields for additional tracking, such as customer ID and profile attributes, transaction details, and alert resolution details. Also consider Company E-fields for situations where a calculation will change the value, but the initial value is still needed.

System E-fields track the survey record as it is processed. Some of the notable default Experience Cloud fields are:

  • Status (e_status) indicates what state the record is in within Experience Cloud, such as waiting for the survey taker to take the survey, survey completed, and waiting for sampling.

  • Survey method (e_survey_method) is the type of survey, including personalized (feed-based), anonymous (feedless), telephone, etc.

  • Creation date (e_creationdate) is when the record was created in the Experience Cloud database. For Action plans, it indicates the date when the Action plan was created.
  • Record creation date (e_record_creationdate) is when a record has been fully processed after creation, and is now ready for sampling (and can be exported if not associated with a survey).
  • Delivered date (e_delivereddate) is when the Invitation email was sent.

  • Survey available date (e_survey_available_date) is when the record is first ready for a survey taker to take the survey (and can be exported with survey-ready information).

  • Response date (e_responsedate) is when the survey taker "finished" sending feedback.

  • Accepted date (e_accepteddate) is when the record was accepted for reporting.

For more information about when the timestamps are assigned to fields, see Feedback record events.

Note: A-fields are very similar to E-Fields in that they both track information about surveys. E-Fields record information about the record, while A-fields record information about the survey. The difference is subtle so, if an an A-field does not contain the relevant information, search for an E-field. For more information on event sequence, see Feedback record events.

For more information, see Default E-fields.

Important: In addition to the Experience Cloud default E-fields, there are additional common E-fields useful for company-specific content, which are not described in this topic.

E-field properties

Properties inherent to all E-Fields

Restriction: These properties have been superseded by Basic details and settings and Advanced settings.
Name
Required. Name of the field that appears in the editor, reports, and filters. This value can be changed after the field has been saved.
Restriction: Name can have a maximum of 63 characters.
Short
Name that appears in dropdown filters. Usually this is the same as Name. When the filter is too wide because of the E-field's name, use this field to provide a shorter name, such as Rate instead of Room Rate.
Keyname
Required. Name that uniquely identifies the field. It only suuports lowercase letters, numerals, and underscores only; must start with a letter, and has a maximum of 61 characters (63 after automatically prepending e_). A globally unique name. The label should start with the company name to ensure uniqueness across multi-tenant instances. This cannot be changed once saved.
Note: Follow the same convention for naming Q-fields (vertical + company abbreviation + keyname). Experience Cloud automatically prepends e_ to the name.
Priority
Order in which this appears in the Fields list; lower numbers towards the top, larger towards the bottom. If you omit this value, Experience Cloud automatically assigns a value 10 larger than the greatest value already in the list.
Description
Internal comments about this item. Best practice is to enter a description of the item, include the date it was added, who added the it, and its intended use.
Make multi-valued
Field is an array instead of a single value. To combine several values into an array, use the JavaScript list() function. Additionally
  • A multi-valued field cannot use Date or Date and time Alternative Sets.

  • Test thoroughly because Multi-Valued fields are not supported everywhere and can lead to errors visible to Users.

Required

Whether or not the field must have a value when the record is created. During import if a record does not have a value for a required field, that record is rejected and Survey status (e_status) is set to NOT_SAMPLED. For imported survey records, required fields must map to something, even if it's a dummy value.

Turning on Required does not affect existing records; it only affect records created when the option is on.

Used for duplicate checking
Whether or not to create an index for this column in the database. An index is required for Duplicate Checking, Cohort Tracking, Sampling Priority, Episode Conditions, and Quarantine Rules.
Warning: Most fields should not be indexed because indexes slow the import process.
Used for ACE
Whether or not the Anti Cheating Engine uses this field.
Internal
Indicates the field is for use by Experience Cloud and has limited availability in reporting.
  • Internal E-fields cannot be used in Profiler or segment groups (that is, Profiler reports or Guest Segment Filters).
  • They can be used to populated Standard reports (e.g., Standard Groups, Standard Reports, etc.).
  • Internal E-fields do not show up on the Manual Invite form, and cannot be populated by Manual Web Upload.
Note: To hide an E-field from the Manual Invite screen, use Sampling Field Setups.
Sticky
Whether or not to clear the field when a User resets the Invitation or Report screen.
Support high cardinality auto-indexed...
Restriction: This feature is inactive by default. Ask your Medallia expert to file a Feature activation request with Medallia Support.
Important: Enabling this property requires engineering approval.

Allows the number of values in auto-indexed text fields and lookup tables to exceed the system limit of 600,000 to a maximum of 2,000,000. Ranking reporting is limited to a subset of the field's values defined by report filters. If the cardinality in any single report is too high, an error message noting the limit is displayed instructing the user to add filters in order to show data.

SFGs affected
Survey Groups Affected. These are the Survey Field Groups that use this Field. Take extra caution when changing the Alternative set since it will affect the Survey Field Group.
Note: Changing the Alternative set affects the Survey Group Field.
Alternative Set
The type of data this field represents and which can be stored in this field.
  • Setup the Alternative Set before creating the E-field.
  • If the field will be used for a filter, the Alt-Set needs to be an ENUMERATED type.
  • When the result must be text, use the Text Alt-Set.
  • If the set needs to be sortable, it cannot be a Text data type.
Note: E-fields with a Date and time alternative set are always stored in Pacific time. For more information about how Experience Cloud uses timezone, see Time zones.
Company
Company that owns this field. For Default E-fields, this value is ROOT.
Client identifier
Name to use when querying this field as a Searchable Field. Exporters may chose to use this label for the field name (column heading) in the exported file. When this field is empty, queries and exports use the Keyname instead.

The identifier may only contain alphanumeric characters and underscores.

Export label

Name to use for the field name (column heading) in the exported file when exporting this field. When this field is empty, Keyname is used instead.

This label may only contain alphanumeric characters and underscores.

Personally Identifying Data
Indicates the field contains personally identifying data on customers. The data in this field may be deleted or purged per the company's data retention policy, or if the field's record is subject to a GDPR or equivalent deletion request. For more information, see
Encrypted
Indicates the field is encrypted in the database. This option is only available for TEXT fields when encryption is turned on. Once saved, this option cannot be turned off. See Encrypt sensitive data for details.
Restriction: This feature is inactive by default. Ask your Medallia expert to file a Feature activation request with Medallia Support.
Translation Explanation
An explanation of the field and its Alternative Set (data type) shown to users of the Translation Module to provide context for their task of translating the field and its values.

Creating an E-field

Restriction: This process has been superseded by Create and manage fields.

These are the general steps for creating an E-field:

  1. Determine the purpose of the E-field. Will the field be used in:
    • Reports?
      • If the data will populate a filter (such as Segment Groups), the Alternative Set must be an Enumerated type.
      • If it needs to be sortable, it cannot be a Text alternative set.
    • Exports?
      • The Export label might need to match the name the customer's import system expects.
  2. Verify the field needs to be created. There are dozens commonly-used E-fields available by default. You may be able to use some of them to hold the incoming data.
    • Default and internal E-field definitions cannot be changed.
  3. Create the Alternative sets.The Alt Set must exist before creating the E-field.
    • If the data will populate a filter (such as Segment Groups), create an Enumerated type.
    • If it needs to be sortable, it cannot be a Text alternative set.
  4. Configure the E-field and save it.
    • Some properties cannot be changed once the field is saved, most notably, Keyname and Alternative Set.
Warning: E-fields cannot be deleted from Experience Cloud.

Default E-fields

Detailed information about the default E-fields (Event fields), their functions, and application contexts.

e_accepteddate
Timestamp when the survey was last accepted for reporting. Unlike e_initialfinishdate (Initial finish date), this value can change due to automatic processing on the record. This field is updated any time Experience Cloud automatically sets or changes e_status to COMPLETED, such as after auto exclusion, alert processing, and text indexing.
Warning: This field value can be set in the imported file, but the value gets reset between the COMPLETION_PENDING and COMPLETED Survey status (e_status) states. However, if a record is imported already in the COMPLETED state (possibly as an external survey), the value is not changed.
e_bounce_category
The reason why an email was not delivered — why it bounced — as reported to the Broadcaster by an external mail system. For a list of the reasons and discussion about bounces, see Bounced email status.
e_bounce_category_resend_status
Bounce status of resent invitations. This field only contains a value when the latest invitation-resend resulted in a bounce, then the value is the bounce category (same codes as e_bounce_category).
Use this field to determine when resent invitations bounce. For example:
Actione_statuse_bounce_categorye_bounce_category_resend
Invitation bouncedDELIVERY_BOUNCEDBounce codenull
Invitation resent and bounced againINVITATION_RESENTBounce codeBounce code
Invitation resent and deliveredINVITATION_RESENTBounce codenull
e_city
City of the customer or employee, as provided in the feed file.
e_creationdate
Timestamp when the survey record was created in the Experience Cloud database. For invitation-based surveys, this is the time just before the record goes to Sampling. For Anonymous surveys, it happens after the first page is submitted. For Action Plans operations, this field indicates the date when the action plan was created. For more information about when this and other timestamp fields are set, see Feedback record events.

This field is used for invitation statistics.

Tip: For export operations, use e_record_creationdate instead because it is the time when the record is fully processed, not just when the record was created. However, if the export requires survey-ready information, like a URL to the survey, use e_survey_available_date instead.

For reporting operations, consider e_responsdate, which is when the respondent completed the survey. For more suggestions, see Feedback record events.

Note: Applications can overwrite and change this value via scripting.

This field is from the survey record and is different from the creation date used in Sampling: that timestamp is the time when the record-to-be imported was created, except the Quota system which uses this field for determining invitations sent in the historically stable period.

e_committed_survey_specid
ID for the survey specification associated with the record, if any. Records are assigned a survey specification when they leave Sampling. Records must have a specification to get an invitation; otherwise, Survey status (e_status) is set to NO_INVITE.
e_delivereddate
Timestamp when the Invitation email was passed to the SMTP (mail) server for delivery; null if no invitation was sent.
e_event_type
The type of event implemented by this record Event schema (if any).
e_event_timestamp
The value of the Timestamp attribute of the Event schema.
e_email
Email address of the customer or employee, as provided in the feed file. It is required for feed-based surveys and Rapid Responses. Note, per MIME standards, email values are case-insensitive.
e_expirationdate
Timestamp when the survey expires (or null if it does not). Survey takers that try to open a survey that has expired get an error message telling them the survey is no longer available. When a record is expired Survey status (e_status) is set to EXPIRED.

The expiration timestamp is set when the invitation is created. When the expiration setting for the invitation is a Time Delay, the expiration time is relative to the time when the record was created (e_creationdate). If later the record is updated, the expiration time is calculated relative to the existing e_expirationdate timestamp. Attempting to update a record with an initial expiration timestamp after the actual expiration time has expired will return an error. You can avoid this issue by setting the expiration time to a Specific Time.

e_firstname
First name of the customer or employee, as provided in the feed file.
e_initialfinishdate
Timestamp when the survey was first accepted for reporting; usually happens after testing for alerts. Once set, this value never changes, unlike e_accepteddate (Accepted for reporting on date) which can change.
e_invitationdate
Timestamp after which the invitation may be sent. When the value is null, the invitation may be sent at anytime. Note that the invitation is still sent even if the file comes after the invitation's e_invitationdate mapping is set for. For example, if e_invitationdate is sent for 8am PT for but the file doesn't arrive til 9am PT, the invitation is still sent.
e_lastname
Last name of the customer or employee, as provided in the feed file.
e_lastupdated
Timestamp when there is a meaningful and functional change to the survey record, including, but not limited to:
  • Updates to E-Fields and Q-Fields
  • Backfills
  • Running the record through an Auto Importer (even when the are no changes to th record)
  • Mapping to an A-field
  • Saving Case Management
  • Adding a note
  • Transitioning an Alert
e_optout
Whether or not an invitee has opted out of future surveys from this company.
e_quarantine_mode
Always set to 1. It bypasses the Sampling filters and Quarantine rules for Ad Hoc surveys. For more information, see Invitation analysis.
e_phone
The survey taker phone number. This is required if you want to call survey taker via Medallia Mobile.
e_record_creationdate
Timestamp when the record has been created, fully processed, added to Experience Cloud, and is ready for to be sampled, or exported for applications that create their own external survey. Similar to e_creationdate except that field is the timestamp when the record was created.
e_reminder_status
Whether or not a Reminder email has been sent.
e_remindeddate
Timestamp when a Reminder email was (last) passed to the SMTP (mail) server for delivery, based on e_delivereddate. If there were multiple reminders, this is the time of the last one. Value is null when reminders are not configured, the reminder has not been delivered, or the survey was completed before the reminder was sent.
e_responsedate
Timestamp when the survey taker completed the survey. For internal surveys, this is when the survey taker pressed the finish button on the survey. For external surveys, including social reviews, this time may be before e_creationdate (when the survey record is created in the database). This field may be null for imported external surveys, though it should be mapped to the e_creationdate for completeness.

This field is used for invitation statistics.

In Exports, do not use this field when Use Export Since is enabled. This field value is set before the survey record is processed, and as such, the record might not be ready for export. But the next time export runs, such a record would be missed.

e_status
Survey status field tracks the state of the survey record, such as whether or not it is waiting for a survey taker to complete the survey, or if a reminder email has been sent. For more information, see Survey status (e_status).

For Action plans, always set the status to 1.

e_survey_available_date

Timestamp when the record is first ready for a survey taker to take the survey. This happens after the record has been sampled, transferred to the Survey Engine, and an invitation created. The value is set the first time the record goes to the Survey Engine. The value is never updated, even if the record is later re-transferred back to the engine.

This value is null for records that

  • Do not go through sampling
  • Complete sampling, but do not get transferred to the Survey Engine (such as for companies that handle their own surveys).
Tip: Use this field to identify records to be exported after the invitation/survey has been created for the record. This is especially useful for companies that send their own invitations, but need the URL to the customer-specific survey.
e_survey_method
Method in which the survey was taken. Often used as a filter when the company has multiple survey types.

Code

Name

Description

1

WEB

Personalized (feed-based), default

2

COMMENT_CARD

Comment card

3

PHONE

Telephone (external)

4

EMAIL

Email (external)

5

MAIL

Postal mail (external)

6

FEEDLESS

Anonymous (Feedless)

7

SOCIAL_MEDIA

Social media

8

STATIC_REPORT

Static report

Warning: Experience Cloud automatically maps the code value to this field; do not manually set it in the survey, such as in a Hidden field. This prevents to run a validation for surveys that, for example, were opened but not begun (that is, not clicking the "Begin survey" button). In those cases, e_survey_method is mapped to a null value and, when importing the survey, that null value is written on top of the automatically assigned code value. If that process fails, valid surveys do not return to Experience Cloud for reports.
e_survey_source
How the survey record entered Experience Cloud.

Code

Name

Description

0

INVITED

Internal, feed-based survey.

1

FEEDLESS

Feed-less survey.

2

EXTERNAL

External survey.

3

NOT_SAMPLED

Default source before sampling.

e_survey_type
Type of information stored in the survey record. By default, Experience Cloud store survey results in survey records. But for efficiency and reporting purposes, additional non-survey information is stored in the records. This field identifies the type of information.

Value

Survey type

0

SURVEY

Regular survey record (default).

1

STATIC_REPORT

Internal.

2

UNIT_METRIC

Values tied to a specific Unit representing Unit information, such as financial records or social media rankings.

3

FEED_FILE_PROCESSING_REPORT

A processing report generated after a feed file is processed.

4

QUOTA_MANAGEMENT_REPORT

Quota management reports when sampling runs and quota rules are enabled for a specific Unit.

5

USER_ACTIVITY

End-user activity information, like screen views or workflow paths.

6

SURVEY_EXPORT_STATS

Survey export statistics.

7

OMNI_EXPORTER_STATS

Omni Exporter statistics.

8

SSO_EVENT_STATS

SSO (single sign-on) event statistics.

9ACTION_PLANAction plan record.
e_ta_eligible_date
Timestamp of when the survey record is marked for Medallia Text Analytics processing for the first time (that is, when Experience Cloud determines a survey needs to be processed by Text Analytics). In most cases, this happens when the Automatic Tagging Enabled property (on the Reporting > Text Processing > Topic & Theme Tagging > Settings screen) is on, and survey record's Survey status (e_status) field is set to COMPLETION_PENDING or COMPLETED. This value does not change if Text Analytics reanalyzes the record; it is never reset or unset.
This field can be null for any of the following reasons:
  • There are no comments in the survey fields marked for Text Analytics processing (so Text Analytics processing is unnecessary).

  • The Automatic Tagging Enabled property is not on.

  • The survey e_status field hasn't been set to COMPLETED or COMPLETION_PENDING.

In some cases, e_ta_eligible_date is given a timestamp even when the survey record is not marked for Text Analytics processing. Whenever this occurs, e_ta_completed_date field is given the same timestamp. Experience Cloud issues this timestamp when the survey status changes from COMPLETION_PENDING to COMPLETED and one of the following conditions is true:
  • Automatic tagging is not enabled.

  • Automatic tagging is enabled, SurveyType=SURVEY, and no comments in the survey fields are marked for Text Analytics processing.

Tip: This field is created by Text Analytics to gather internal statistics and can be used in Reports or Exports.
e_ta_completed_date
Timestamp of when the Text Analytics engine is finished with the survey — even when Text Analytics is disabled for the company. This happens some time after the Survey status (e_status) is set to COMPLETION_PENDING, and can be before or after the e_accepteddate timestamp.

This value does not change if the engine re-analyzes the record.

When a record is processed for Text Analytics, the process that transitions e_status from COMPLETION_PENDING to COMPLETED waits for Text Analytics processing to complete, and sets the datetime value for e_ta_completed_date to the current time.

Note: Auto-completed records without any comments do not go through the processing phase that changes the value of Survey status (e_status) from COMPLETION_PENDING to COMPLETED. Because there are no comments, the records do not undergo Text Analytics processing. As a result, the value of Text Analytics completed date (e_ta_completed_date) is null for auto-completed records with no comments. When configuring recurring report exports, filtering data by Text Analytics completed date (e_ta_completed_date) may result in unintentional record exclusions in the exported report.
e_unitid
The Unit ID associated with the customer or employee episode or transaction. This field is required and the value is provided when the survey record is created by the data import.
e_user_activity_units
The primary unit permission that user associated with the record had when that user signed in to Experience Cloud. This is used in records that record user activity, such as as in user engagement Health Check reports. For more information, see User activity.