TABLE OF CONTENTS




Introduction

Field Settings is the base from which available Filters, Import fields and field labels are being pulled from. The field settings allows you to manage which fields exist in CustomerGauge, and how they're called. You can add fields to various "Objects" (types of data) that exist within CustomerGauge.




Good to Know

  • Field Settings is only available to Admin users without Data Access Restriction
  • Fields can not be moved between objects
  • Fields can not be removed
  • Field Settings currently apply to the following areas:
    • Reporting Filters
    • Account and Account Alias Imports
  • Your Account or Implementation Manager will need to manage fields used in the following places:
    • "Legacy Import Data" (Legacy Survey import and Revenue)
    • Export Engine




Objects & Fields

In order to set up your fields, it is important to understand what each Object is used for, and what each Field is used for. "Objects" are main pieces of data, like accounts, contacts, and survey records. Each Object stores important details (such as customer names or survey answers) to help track information and understand customer interactions better. Each such piece of information is stored in a “field” inside the Object.

Field Types

CustomerGauge supports various field types, each with different features relying on them.

Segment: These fields hold information that is used to filter, organize data for reports, or drive business rules. They help focus on specific groups or parts of the data. Segment fields that exist on an Account or Contact object also exist on the Survey Record object. The Account and Contact versions hold the latest information, whereas the Survey Record holds the information that was true at the time of the Survey invitation.

Unique Identifier: A unique identifier in an object is a special code or number that only belongs to that one object. It helps the system recognize and find that exact object’s record easily.

Hierarchy: These fields organize information in a way that shows levels, like departments in a large company. This helps show how parts of a business are connected.

Informative: These fields can be used to store extra details. They are used for storing information, and have no functionality dependent on them.

Custom: These fields store extra details, such as support ticket numbers or reference information, which might be useful to look up later. They are for storing information, not for reports.

CustomerGauge does not support fields that can store multiple values or multiple layers of information in one field. Each field can only hold one piece of information. This keeps the data simple and clear.


Account Object

Accounts represent organizations or businesses that interact with your company. Each Account holds key information about the organization, like its name, industry, size, and contact details, helping you manage business relationships and track interactions with each company.

Technical Field Name

Example Field Label

Field Type

Data Type

Description

reference

Account Reference

Unique Identifier

String (128 characters)

Is used to identify Accounts. It typically holds the unique identifier of accounts, such as a customer number. If an Account has no Account Display Name, the value stored here will be shown in the system.

display_name

Account Display Name

Text, Informative

String (128 characters)

Holds the name shown for a company or organization in the system

number

Account ID

Text, Informative

String (128 characters)

Holds an additional identifier that can be used to look up in another system, such as a billing system, or your CRM. This field does not get used as a unique identifier by CustomerGauge.

segment_a to segment_z and segment_1 to segment_5

Account Manager Name, Account Manager Email, Trade Name, Is Key Account, Channel, Classification, Direct/Indirect, Wholesaler Name

Segment

String (128 characters)

Holds information that helps slice and dice your data, and enables analysis, as well as business rules.

 

 

Contact Object

Contacts are individuals within those Accounts, such as specific employees or representatives who interact with your business. Each Contact record contains details like name, job title, phone number, and email address, making it easier to communicate directly with people in each organization.

Technical Field Name

Example Field Label

Field Type

Data Type

Description

email

Email

Unique Identifier

String (100 characters)

Is used, along with the Phone number, to identify the Contact. Must be a valid email address. Required to send survey invitations by email.

phone

Phone

Unique Identifier

String (30 characters)

Is used, along with the Email address, to identify the Contact. Must be a valid phone number. Required to send survey invitations by SMS or WhatsApp.

first_name

First Name

Text

String (60 characters)

The First Name of the Contact.

last_name

Last Name

Text

String (60 characters)

The Last Name of the Contact.

salutation

Salutation

Text

String (20 characters)

Holds the data of how to address the Contact. Often used in languages that lack gender-neutral ways of addressing someone.

identifier

Contact ID

Text, Informative

String (100 characters)

Holds an additional identifier of the Contact that can be used to look up in another system, such as a billing system, or your CRM. This field does not get used as a unique identifier by CustomerGauge.

language

Language

Text

String (2 characters)

2-digit ISO-639 Language Code

Holds the 2-digit language code that the Contact wants to be addressed in.

country

Country

Segment

String (2 characters)

2-digit ISO-3166 Country Code

Holds the 2-digit country code that the Contact works in.

state

State

Segment

String (6 characters)

5-digit ISO-3166 Subdivision Code

Holds the 5-digit subdivision code (province, municipality, etc.) that the Contact works in.

area

Area

Segment

String (128 characters)

Holds the name of the area that the Contact works in.

city

City

Segment

String (128 characters)

Holds the name of the city or town that the Contact works in.

job_level

Job Level

Segment

String (1 character)

Holds the position of the  organizational hierarchy of the Contact (A, B, C, U) where "A" is the top level in the organization (C-Suite) and "C" is Operational / Frontline. "U" stands for "Unknown".

job_title

Job Title

Segment

String (128 characters)

Holds the job title of the Contact.

currency

Currency

Text

String (3 characters)

The 3-digit code of the currency that the Contact gets charged in.

segment_a to segment_z and segment_1 to segment_5

Pronoun

Segment

String (128 characters)

Holds information that helps slice and dice your data, and enables analysis, as well as business rules.


Survey Record Object

A Survey Record is a stored non-response or response from a customer or contact to a survey. It contains the answers given by the individual, including scores, comments, and other feedback. Survey Records help capture customer loyalty and insights, which can be analyzed to improve customer experience and address issues. Survey Records are also known as “Survey Transactions”, “Non-Responses”, “Responses”, or “Cases”.

Technical Field Name

Example Field Label

Field Type

Data Type

Description

number_customergauge

CG-ID

Unique Identifier

Integer

Holds the unique identifier of the survey record.

longitude

Longitude

Longitude

Decimal (11 characters, 8 decimals)

Holds the longitude of the Outlet or Account.

latitude

Latitude

Latitude

Decimal (11 characters, 8 decimals)

Holds the latitude of the Outlet or Account.

touchpoint

Touchpoint

Touchpoint

String (128 characters)

Holds the label of the touchpoint that this survey transaction is about.

flight

Wave

Segment

String (128 characters)

Holds the value of the wave this survey record is sent in.

division

Division

Hierarchy

String (128 characters)

Holds the value of a division or business unit. Controls Data Access Restriction, and can be made a hierarchy.

date_order

Order Date

Date/time

Datetime (YYYY-MM-DD hh:ii:ss)

Holds the date of  a purchase, or other transaction that this survey record is about. Gets populated with the import date if not provided.

date_email_sent

Sent Date

Date/time

Datetime (YYYY-MM-DD hh:ii:ss)

Holds the date of the primary survey invitation being sent.

date_form_completed

Survey Completed Date

Date/time

Datetime (YYYY-MM-DD hh:ii:ss)

Holds the date of the survey being answered.

number_order

Order Number

Text, Informative

String (128 characters)

Holds an additional identifier of the Survey Record or transaction leading up to this survey invitation, and can be used to look up in another system, such as a billing system, or your CRM. This field does not get used as a unique identifier by CustomerGauge.

currency

Currency

Text

String (3 characters)

The 3-digit code of the currency that the Contact gets charged in.

rand_value

Order Value

Number

Float(15 characters, 2 decimals)

Holds a monetary value of a B2C order. Does not get used for Monetized reporting.

segment_a to segment_z and segment_1 to segment_5

BD Territory, BD Email, Team Leader Email, Commercial Area Manager Email

Segment

String (128 characters)

Holds information that helps slice and dice your data, and enables analysis, as well as business rules.

custom_field_1 etc.
Custom Field
Custom
String (128 characters)
Holds additional information that is needed in exports or manual reference when using CustomerGauge.





Using the Field Settings

You can find the Field Settings by navigating to Settings → System Admin → System Settings → Field Settings.


  1. Navigate the tabs to the objects you'd like to interact with.
  2. In the Accounts column, you can find all the properties configured on the Account level. Hover over the existing fields to access Edit.
  3. Adding fields in Accounts creates a copy of that field on Survey Records in Field Settings. You can upload data on survey imports once your Account or Implementation Manager also adds it in the backend for you - please tell them the "Classic Label" name for the field (visible while in Edit).
    1. This allows you to upload a snapshot in time. E.g. the Account Manager for the survey sent now is "John", but a year from now it might be "Jane". When you look back to "now", a year from now, you'd still want to see the survey attached to "John", while the account belongs to Jane now.
  4. In the Contacts column, you can find all the properties configured on the Contact level. Hover over the existing fields to access Edit.
  5. Adding fields in Contacts creates a copy of that field on Survey Records in Field Settings. You can upload data on survey imports once your Account or Implementation Manager also adds it in the backend for you - please tell them the "Classic Label" name for the field (visible while in Edit).
    1. This allows you to upload a snapshot in time. E.g. the Job Level for the survey sent now is "B", but a year from now it might be "A". When you look back to "now", a year from now, you'd still want to see the survey attached to "B", while the contact is belongs to A now.
  6. In the Survey Records column, you can find all the properties configured on the Survey level. Hover over the existing fields to access Edit.
    1. Making changes in Field Settings do not directly impact data. Do note that changing the context of a field (e.g. changing the field label to something completely different) is ill advised.
  7. Adding fields in Survey Records enables it to be turned into a filter. You can upload data on survey imports once your Account or Implementation Manager also adds it in the backend for you - please tell them the "Classic Label" (visible while in Edit).




Editing Fields

While editing a field you are able to update its Label, Field type, the max amount of characters allowed, enable a blockage of new values when uploading and also make it a mandatory field.



Field details

Field: shows the field being edited.

Label: update the label of the selected field.


Upload validations

Field type: determines the type of data that must be uploaded for this field.
Types:

Date (2023-09-15 00:00:00);

Email (simple.way@example.com);

Numeric (numbers from 0 to 9);

Text (letters, numbers, symbols).


Max character amount: this determines the amount of characters are allowed when uploading data into this field.

Example: setting it to 2 will only allow uploads that have up to two characters like AA or BB.


Restrict new values on upload: this option will block any uploads in case a value for that field is not already available. This function blocks the creation of new values for a specific field.


Mandatory field on upload: this option turns the field a required field when uploading data, in case the field is not present  or doesn't have data the upload will fail.


Please note: All fields validation are only applicable in the new Imports, v7 APIs, Webhooks and Microsoft Dynamics. It's NOT available in Salesforce Integration, SFTP or v4 APIs.




Asking Account or Implementation Manager to Update

Your Account or Implementation Manager will need to manage fields in a couple of places that are not controlled by Field Settings yet. Each scenario is listed below.



Legacy Import Data

Your Account or Implementation Manager can help with the following actions:

  • Add or Remove a Survey field to be available to be imported

Emphasis: If you have added a field to Survey Records in Field Settings, and would like to use it in legacy imports, make sure to ask your Account Manager to update the Import Settings of your platform!

  • Re-label an existing field or change its technical name



Export Engine

Your Account or Implementation Manager can help with the following actions:

  • Add or Remove a Survey field to be available to be exported
  • Re-label an existing field or change its technical name