Gainsight administrators can now create and manage the Matrix Data - Objects (formerly known as Subject Areas) using the “Data Management” application.
As an analogy, a Matrix Data - Object and its field can be thought of as a database table and its columns.
Data Management can be accessed via the Administration > Operations > Data Management link as shown below:
This article describes how to:
- Create Matrix Data - Object Manually
- Create Matrix Data - Object Automatically
- Edit Matrix Data - Object
- Update/Upsert Matrix Data - Object using Update Keys
- Load data into an Matrix Data - Object
- Check Dependencies on the an Matrix Data - Object
- View Activity Log
- Create Calculated Fields on Matrix Data - Object
- Supported Data Types
Upon clicking the Data Management link, the object listing page is opened:
Contact Gainsight Customer Support (email@example.com) to enable Redshift if object lookup functionality is required.
- All of the objects, including out-of-the-box objects, (read-only objects) and custom objects are displayed.
- MDA object fields have a maximum limit of 250 characters.
In order to access the Data Management console, and be able to view and load data, a user must have access to the visual Force Page JBCXM.COM.
How to Manually Create Matrix Data - Object
To create an MDA subject area:
1. Go to Administration > Operations > Data Management > + Object.
2. In the Create Object window, enter the following details:
- Object name: The name of the object (Matrix Data - Object) that you want to create.
- Object description: A description of the object being created.
3. Select Manual and then click NEXT to enter the following details:
- Display Name: The easily understandable display name.
- Field Name: The system defined field name with a suffix of __gc.
- Data type: The data type of the field being created.
- Default Value: The default value that you would like to insert in the object field.
- SFDC Mapping: Map the field being created with an SFDC object, if any.
- Description: The description of the object being created
- The Enable lookup Relation checkbox appears only when the field is of String, SFDC ID, or Email data type and the underlying data store for the objects is AWS Redshift rather than MongoDB. To know if AWS Redshift is enabled as a data store for your objects, please contact Gainsight support (firstname.lastname@example.org).
- Currenntly, Gainsight does not support duplicate Display Name.
- The idea for generating the technical field names is to simplify the formula setup on MDA objects. However, formula setup on an MDA object is still unsupported.
4. Click ADD; then click SAVE. The object gets created. You can click the Edit button to edit the object name.
5. Click ADD FIELD to add the remaining fields of the created object.
Creating an Object Automatically Using a CSV
If a new object that needs to be created has a lot of fields, creating it manually using the Data Management user interface is a cumbersome and error prone process.
If you have a CSV data file that contains field names as headers and some data, the object creation process can be automated as below:
- Field name is taken from the CSV header file
- Data type of the field is auto-inferred from the CSV data file
- Optionally, the data from the file can be imported into the object
To create an object using a CSV data file:
1. Navigate to Administration > Operations > Data Management > All Objects > +OBJECT.
2. Enter the following details:
- Object name: Enter the desired object name.
- Object description: Enter a description for the object being created.
- Select Data File Upload (CSV)
3. Click BROWSE to select the appropriate CSV file. Click NEXT.
The CSV headers are taken as is and Target Object Field and Target Object Data Type are created automatically as shown in the image below. You can choose a different data type, if the automatic matching is incorrect.
Note: You must select the field for which you assign a default value during the data ingestion process (for example, uploading data using a CSV file). Otherwise, the field contains a NULL value.
4. (Optional) You can enter default values under Target Object Default Value. Also, select Load Data to load data from CSV to Gainsight. Otherwise, only the schema would be created.
5. Click CREATE.
Editing a Matrix Data - Object
To edit a Matrix Data - Object:
1. Go to Administration > Operations > Data Management > All Objects > [Click on an existing object] > Schema.
2. Click on the Pencil icon to edit a particular field.
- Only editable fields can be edited.
- The total number records available in the object is displayed at the top.
- You can delete the object using the DELETE OBJECT button if the object has no dependencies. If there are any dependencies, you will have to delete the dependencies to delete the custom object.
Update/Upsert Matrix Data - Object using Update Keys
Admins can define the key field(s) that must be used on an object to update or upsert the existing records using the new Update Keys - BETA tab. This is primarily introduced to avoid updating the existing data with the wrong key fields (as it can corrupt the entire object data) and ensure that Update / Upsert operations are allowed ONLY when the valid keys are used.
To update a Matrix Data - Object:
- Navigate to Administration > Operations > Data Management > [Click on an existing object] > Update Keys - BETA.
- Drag-and-drop the desired fields from AVAILABLE KEYS to MAPPED UPDATE KEYS.
- Click SAVE AND VALIDATE. This defines the Update key(s).
- AVAILABLE KEYS: Displays all fields available in the selected object.
- MAPPED UPDATE KEYS: After you drag-and-drop fields from AVAILABLE KEYS to MAPPED UPDATE KEYS, it reflects the key fields that you use to identify unique object records during an UPDATE/UPSERT.
- If MAPPED UPDATE KEYS do not represent a unique record, an error message is displayed when you click SAVE AND VALIDATE.
- Once Update key(s) are defined, subsequent Update or Upsert operation in the data Ingest (S3 connector , Data load API, or Rules engine > Load to MDA) is allowed only when the same update/upsert keys are used. If the keys are different, the update/upsert process would fail. Therefore, exercise caution while enabling this feature for an existing object. Existing rules will fail if the update keys are different. We strongly recommend that you create a new object, and experiment with this feature.
How to Load Data into Matrix Data - Object
Once you have created a Matrix Data - Object, you can load data into the object. It is designed to load small files (under 1 MB). The purpose is to manually load a small data file and view the object data in the data browser to verify its structure.
To load data into an MDA subject area:
1. Go to Administration > Operations > Data Management > [Select the object in which you want to load data].
2. Click Import Data > Choose file to select the CSV file. Optionally, you can click GENERATE CURL to generate a sample template for inserting data into a subject area. This sample template needs to be modified as per cURL requirements. You can refer to cURL documentation for that.
Note: Select File has headers if the CSV that you are about to import has headers in it.
3. Click PROCEED TO MAPPINGS; then map the CSV file fields with that of the object fields. If the field names are the same in both the CSV file and the object, the mappings are done automatically.
4. Click VALIDATE; then click LOAD DATA. If something is missing or is incorrect, during validation, an error is thrown and you will be asked to perform the correct mapping.
Note: Only CSV files that are less than 1 MB can be loaded.
5. In the left pane, click Data. You can now see the data loaded from CSV file to the created object.
Deleting Data from a Matrix Data - Object
To delete data from a Matrix Data - Objects:
1. Go to Administration > Operations > Data Management > All Objects > [Click on an existing object] > Data.
2. You can perform either of the following operations:
Delete All: You can click Delete All to delete all data from a Matrix Data - Object.
Delete specific data: You can first filter the data that you want to delete and then click Delete to delete the filtered data.
How to Check Dependencies on a Matrix Data - Object
Once the Matrix Data - Objects are created and then referenced in a different part of the application, we wish to restrict the Gainsight Administrators from accidentally modifying or deleting the Matrix Data - Objects as part of the object dependency tracking feature.
Currently, we are tracking the below application areas in dependency:
- Data Integrations
Note: this is an experimental feature. Upon feedback and usage, we will decide whether to keep this feature and track more areas (like S3 Data Integration Projects, and so on), or disable it.
To identify Rules or Reports that are dependent on a custom object:
1. Navigate to Administration > Operations > Data Management > [Select the object for which you want to check dependencies].
2. Click Dependencies to see Rules, Reports, Relationships, Data Integrations, and CoPilot outreaches that are dependent on the custom object you selected.
Viewing Activity Log
This section helps you see all changes made to MDA Data Object.
To view activity log:
1. Navigate to Administration > Operations > Data Management > Activity Log.
The Activity Log tab displays log details of each object. In addition, you can click the Details link to get detailed log information of the object for an operation.
Things to Remember
- Calculated fields can be created using Numeric, Currency, and Percentage data types.
- Number, Currency, and Percentage can be used in formula fields while building a formula.
- Fields and Operators can be inserted in the Formula field through the mouse click only.
- Numeric values, functions, and advanced operators are not supported as of now.
To create a calculated field on a Matrix Data - Object:
1. Navigate to Administration > Operations > Data Management.
2. Click on the desired object for which you want to create a calculated field; then click ADD FIELD.
3. In the pop-up window, enter the following details:
- Display Name: The display name of the field.
- Field Name: The Field Name that is automatically generated.
- Data Type: select Number.
- Select Calculated Field; then click CREATE FORMULA. You will be navigated to the Formula Builder window which is enhanced with the complete Field names and Operators, and the addition of the ADVANCED FORMULA option to create complex formulas.
Note: The Calculated Field checkbox appears only if there are at least two Number fields present.
ADVANCED FORMULA builder helps the Admins to create complex formulas like performing arithmetic operations and case statements.
Basic arithmetic operations with constants
Examples : A + 10, A - 1, A*100 , A/100, (A+B)/2
- case when A>0 then 1 else 0 end
- case when A-B>=0 then A-B else C-B end
- case when A=B then 1 else 0 end
- case when A is null then 0 else B * (180/7) end
- case when (A+B+C+D) = 0 then 0 else ((E+F+G+H+I)/(A+B+C+D)*100) end
- Ensure that the syntax is correct.
- Validator for advanced formula is being developed.
- Once an advanced formula field is set, reverting to a basic formula is not supported as basic formula builder does not support these operations.
5. Click ADD.
Note: Gainsight recommends you to write down your formula on paper. If you get it wrong while building the formula in the Formula field, you will have to start all over again. The formula can be edited from right to left using the close icon.
8. (Optional) You can click on the Pencil icon corresponding with the calculated field to edit the formula, if required.
Things to remember:
- Field Name can be used in a calculated field or curl command.
The following image shows how Field Names look while configuring a caluculated field. For more information about this support related enhancements, refer to the '4. Dropdown list data type' section under Gainsight Data Management (GDM) in the Release Notes Version 5.5 February 2017.
The following image shows how Field Names appear when a curl command is generated.
Supported Data Types
|String||The String data type.||This data type can be mapped (Join Field data type) to String, SFDCID, and Email.|
|Boolean||The Boolean data type.|
|Date||The Data data type.|
|DateTime||The DateTime data type.|
|Number||The Number data type.||Formula Support: Formulas are supported through Formula Builder; they must be set from the Tenant Management. For more information about this support, refer to the '3. Advanced formula builder available in free form editor' section under Gainsight Data Management (GDM) in the Release Notes Version 5.5 February 2017.|
|SFDC ID||The SFDC ID data type.
||When data is being loaded to an MDA object with SFDC ID as a data type, the application checks and converts 15 digit IDs to 18 digit SFDC ID. If the SFDC ID value is not a 15 digit or an 18 digit record, data would be rejected. SFDC ID field can contain NULL.
This data type can be mapped (Join Field data type) to string and SFDCID.
|The Email data type.
When data is being loaded to an MDA object with Email as a data type, the application validates the email ID with the following criteria.
The email ID must have:
1. At least one @ in the email address.2. There should be at least one character before and after @
This data type can be mapped (Join Field data type) to String and Email.
|Dropdown List||This data type is available for Standard and System fields, and you can use those fields in Report Builder.|
The following table shows how the currency numbers are stored in various areas of Gainsight.
|Currency type at Object level (GDM)||Data Ingest Format||MDA Storage Format||Format in Reporting||Format in Formula Fields|
The following table shows how the percentage numbers are stored in various areas of Gainsight.
|Data Ingest Format||MDA Storage Format||Format in Reporting||Format in Calculated Fields|
MDA Standard Objects
All customers are provisioned with standard objects namely Company, User, Relationship, and Relationship Type. These standard objects can be viewed under Data Management, as shown in the following image. Standard Objects in MDA will support common Reporting, Scorecards 2.0 feature; and Gainsight Connect will help you to import the data from Salesforce to MDA standard objects. Admins can view the standard objects in the Administration > Operations > Data Management location.
Note: The standard objects will be visible in the Rules Engine under the source only when there is an MDA join on Standard Objects. MDA standard objects include Picklist, User, Company, Relationship Type, and Relationship. You can import data in these objects using Gainsight Connect or S3 Connector.
These Standard objects will have the following:
|Schema Editability?||Data Editability?|
Data can be ingested into the standard objects using the following options: