1. Login to your Ambition instance.

2. Open the left navigation and click Administration > Data > Integrations.

3. Under Available Integrations, click the Enable Integration button in line with the File Upload integration. You will be redirected within the new File Upload Integration.

Upon enabling you will be redirected within the Integration. To enter the File Upload Integration anytime after original enabling the File Upload Integration will appear under Active Integrations at the top of the page.

4. Click the Settings button to enter the File Upload Integration.

5. Set a descriptive name for Integration Name. We recommend an explicit name, typically the system/data being transmitted.

6. Provide an Admin Email Address. This email will be contacted if and when Integration issues arise.

7. Click the Save button.

Setting the File Format

You've now enabled the File Format Integration, but Ambition needs to be instructed on how to handle your data.

Here you will indicate what type of file format will be sent to Ambition. CSV or JSON.

1. Within the File Format Integration, click the Data Format tab.

2. Click the dropdown to access File Format options. Set the File Format, either CSV or JSON.

3. Click the Save File Format button.

Setting the Data Format

You've chosen what type of file will be sent, now you will determine how your data is formatted.

Will your Organization be sending Daily Totals or Records?

Data Format Type

1. If you navigated away from the page after setting the File Format above, return to the File Upload Integration, click the Data Format tab.

2. Use the Data Format Type dropdown to select either Daily Totals or Records.

email,date,calls,emails,appointments
jason@yourcompany.com,2020-8-17,11,12,3
sarah@yourcompany.com,2020-8-17,6,9,10

Records

Select Records if you will be transmitting raw records for each employee. This typically means that you will be offloading the processing to Ambition, specifically the logic to derive Metrics from records

Records Example - CSV

email,created_date,record_id,type,status,appointment_date,booking_date,revenue
jason@yourcompany.com,2020-8-14 8:23:11,abc123,appointment,completed,2020-8-17,,
jason@yourcompany.com,2020-8-17 7:59:23,abc456,call,completed,,,

Field Mappings

This is where you will define and map the data transmitted.

If your File Format is CSV, then you will be mapping your spreadsheet's named columns.

If your File Format is JSON, then you will be mapping your key names.

Field Key: How the field is identified within your file, either a key or column name. 43 character limit.

Display Name: How the field key will be displayed within Ambition.

Field Type: The type of information contained within the field.

Field Type Options

Your Data Format Type (Daily Totals or Records) will determine which Field Types are available.

To Create Field Mappings:

1. Click the Add button.

2. Fill in the Field Key, Display Name, and Field Type for each CSV column header or JSON key.

Field Key: How the field is identified within your file, either a key or column header.

Display Name: How the field key will be displayed within Ambition.

Field Type: The type of information contained within the field.

As noted above: 

Ensure that these Field Keys are updated to match the formatting, including capitalization, of your actual headers or keys.

Update the email and date, and if Records based data, id placeholder Field Keys as needed to fit your Data Format.

3. Once the Data Format is complete, click the Save Data Format button.

4. Type I UNDERSTAND and click the CONFIRM button to confirm your understanding about the Data Format Type, Fields, and Metrics put in place.

Metrics

If you previously created any Metric (Sum) or Metric (Average) field mappings these will automatically show up in your Metric Library.

If accessing existing Metrics, click Manage under the Metric Library tab.

If you desire to build new Metrics, click Add under the Metric Library tab.

Metric Logic

Who Gets Credit?: Select an available Email or Employee Unique Identifier field

When Do They Get Credit? Select an available Date or Date/Time field.

Metric Type and Field to Sum:

If Metric (Sum) or Metric (Average) was selected, these fields will be prepopulated.

For Records format, you will have the additional option of Count.

Metric Filters (only applicable for Records based Data Formats)

To add filters:

1. Click on the Add Filter button to optionally add logic.

2. Select a Field from the first dropdown.

3. Select a logic statement from the second dropdown.

4. Enter or select a value from the third dropdown.

If you add multiple filters notice that a Logic bar appears where you can add logic to your filters if required.

For example, if you have Filter 1 and Filter 2 your Logic bar can be:
1 AND 2 which means both Filter 1 and Filter 2 must be True
1 OR 2 which means either Filter 1 or Filter 2 must be True

Click the Confirm and Save Changes button to save the Metric.