Data and Integrations

What is Integration?

The process of Integration is linking together different systems for the flow of data. Compass uses various standardized methodologies to work with Client organizations to integrate data into Compass

The initial process typically involves tech teams from both sides to discuss and implement the pilot of the integration

Once set, the Compass integration method fetches data automatically in the next cycle onwards from Client systems and programs, reports, templates are updated automatically

What is Data source?

In order to evaluate and calculate the incentives for any program, Compass requires the user and transactional (event) data of the organization on which the calculation can be performed by creating KPIs and programs. This data is critical for the program's success.

Data Source is the source where the transactional data is fed into compass.

Types of Data source

Data source can be broadly classified into two categories:

Manual : Manual integration is where the data is uploaded by the admin of the organization directly via the admin console. This is currently achieved through uploading .csv files into the system.
Integration: This is the mechanism where the data from the organization is taken directly from the data sources like Database/CRM/Data lakes through push and OR pull techniques.

How to Use the Feature

Defining Schema of the Data: First step is to define the schema of the Data file that is to be uploaded onto the system. This needs to be agreed beforehand with the compass implementation team.
Define the integration type: it should be agreed what integration type will be followed to upload the data on the system, manual or automated via one of the integration methods.

Defining Schema of the Data

In the admin console of the compass WebView , go to the Data and Integrations and click on + Add Data source

After clicking on the “+Add Datasource” button, you’ll see the below options, which provide the types of Data sources integration our standard product offers.

In this document we will talk about the manual integration as for integration schema definition is done in the backend by technical team. We currently offer standard CRM integration with

Close.io
Leadsquared
Hubspot
Salesforce

Choose the upload a CSV option

Now select your csv file to upload it into the system. If this is the first time you are uploading the file with a different or new schema, the system will ask you to define the fields in the system by automatically marking the columns in the red that will need to be defined in compass.

Now click on each field, marked in red to include or not to include in the compass system schema.

When you create New field, it will show a pop up asking for the details of the field. The field label should be a unique string(name of the column), field type and if this field will have unique values and if the data should be always present in this field. Please fill in accordingly:

a. It is mandatory to define one unique and mandatory field in the schema

b.If the field signifies date, please choose the correct date format as this will be used in other places also.

There are four types of fields available on Compass to define the field type:

Integer - Fields with numeric values without decimals
Text - Fields with string value
Float - Fields with numeric values with decimals
Date - Fields with date, common date formats can be selected from the dropdown

Once Create is clicked, again click on the field to show the list of available fields to be mapped to.

Now click on the field just created to map this field to that label and it will turn into white.

Now do that for all fields in red and once all fields are done , please click on Next to name your data source and complete the upload process.

Now you can see the status of the upload and also the data source name (eg. test 123), along with the File Name, Upload Date and Uploader name (admin) in logs. These logs are maintained on Compass and also have historical data for all uploads till date.

This data source will be added to your Data & Integrations tab also from where you can access it to add/edit data. In case of failed records, the logs will indicate the same for the particular data upload, there will be a download button next to it. You can download the failed records in a CSV and check the exact reason behind failure mentioned in the CSV file against the failed data records.

Once the schema template is defined in the compass, you can upload the data with the same schema without the need for the mapping into the same data source.

View/Edit Data Schema/Template

After the above steps are done, data source will be added to your Data & Integrations tab also from where you can access it to add/edit data.

Go to your Data source name and click on 3 dots, to see
1. Data values for the data source in compass
2. Edit Template
3. Delete Data Source
View & Add Data Values to the current data source:

Here you can see the current Data values present in the data source.

The data can be downloaded using the Download button at the top in .csv format.
Also can add more data into the data source using Add Data but in .csv format. For this a .csv file with the same template as data source is required with new data.

Edit Template: The template created above can be edited to
1. Edit the existing fields
2. Add a new Field
3. Ignore a current field

Once done with the changes, click on Done at the bottom and the changes will be saved in the template.

Delete Data Source: Delete Data source will delete the template and the related altogether from the system and it will not be available in compass anymore. This option should be used with utmost caution and make sure that this is actually what is to be done before proceeding with it.

For automated type of data upload (through integrations)

This involves involvement of Tech IT team from both organizations to

Define the type of integration
Dev/test of the integration data pipeline
Deployment and monitoring

Below is the technical documentation related to Integration which talks about various types of integration compass allows and how it can be set up also.

https://help.getcompass.ai/integrations/integration-methodologies

For any further information regarding the technical aspect of integration, please reach out to your account representative.