mParticle
mParticle is a customer data platform that allows you to centralize, manage, and activate your customer and engagement data across any channel.
Use this integration to:
- Send data from Harness FME as a feed input in mParticle. When configured, FME sends traffic impression data for feature flags to mParticle.
- Send data to the Harness FME as an event output in mParticle. When configured, FME processes and displays mParticle event data in FME for analysis.
This guide explains how you can set up and test different configurations within the mParticle integration.
Harness FME as a feed input
In mParticle
Before you begin, within your mParticle account, set up Harness FME using the Integration Directory to receive your API key and secret. Copy and save these 2 strings. Refer to mParticle documentation for more information.
In Harness FME
- Click the profile button at the bottom of the left navigation pane and click Admin settings.
- Click Integrations and navigate to the Marketplace tab.
- Find mParticle from the integration list, click Add and select the project for which you would like to configure the integration.
- Under Configure as a partner feed input in mParticle, select Add configuration.
- Select the environment type in mParticle you want to send your data to. You can select either:
- Development
- Production
- Select how you want to map Harness FME traffic types to mParticle identities. You can select:
- customer_id
- microsoft
- yahoo
- other
- other_id_2
- other_id_3
- other_id_4
- FME impressions display as get_treatment in mParticle by default or you can customize this event name with a maximum of 256 characters.
- Paste the server to server key and secret from your mParticle account and click Save.
- Once you save the configuration, send a test event from Harness FME into mParticle.
Repeat this process for each environment and traffic type you want to configure.
Harness FME as an event output
In Harness FME
- Click the profile button at the bottom of the left navigation pane and click Admin settings.
- Click Integrations and navigate to the Marketplace tab.
- Find mParticle in the integration list, click Add and select the project for which you would like to configure the integration.
- Under Configure as an events output in mParticle, select Add configuration.
- Select the environment type in mParticle you would your data to be sent to. You can select either:
- Development
- Production
- Select how you want to map Harness FME traffic types to mParticle identities. You can select:
- mpid
- customer_id
- microsoft
- yahoo
- other
- other_id_2
- other_id_3
- other_id_4
- Enable identify to On if you want Harness FME to capture the user attributes in your mParticle events using an identify call.
- Enable events to On if you want Harness FME to capture mParticle events sent to FME.
- Click Save.
- Copy the generated key and use it to configure the events integration settings in mParticle.
In mParticle
Within mParticle, select Split from the integration directory and configure the events integration. When prompted, enter the integration key provided by Harness FME. Refer tomParticle documentation for more information.
User identity mapping
Logged in and anonymous mapping
If you want to map logged in and anonymous traffic, we recommend mapping your logged-in traffic type in Harness FME to customer_id in mParticle. For mapping an anonymous traffic type, pass any anonymous ID to Harness FME for targeting and use a other_id field in the user identities to reserve for FME anonymous traffic.
If you are unsure of which mParticle identifier to map your Harness FME traffic to, reach out to your mParticle solutions consultant or contact support@split.io.
Multiple identity mapping
In general, it is recommended to map a single mParticle identity to a single traffic type in Harness FME. If you require mapping multiple mParticle identities to a single traffic type in FME, contact support@split.io so we can provide guidance on best practices. If an event contains two mParticle identities that are mapped to a single FME traffic type, two events are generated.
For example, if we have customer_id = 123 and other_id = 456 as mParticle identities in an event and both are mapped to user traffic type in FME. It becomes two events in FME, both with traffic type as user and event one has key = 123 and event two has key = 456. Other fields remain the same.
Event data mapping
From mParticle, we accept the following events types:
- commerce event
- custom event
- session start
- session end
- screen view
See the following section to learn more about how fields and properties are mapped in Harness FME for each event type.
Commerce event
For the commerce event, Harness FME accepts product-based events. These events have a product action field populated. FME does not accept promotion-based or impression-based commerce events. If multiple products are included in the product action event, the number of products are equal to the number of events generated in FME.
Event fields are mapped as shown below:
| mParticle field | Mapped field in Harness FME |
|---|---|
| event type | eventTypeId |
| eventid | foreignId |
| timestamp | timestamp |
| session id source message id | properties |
| Product action fields: action transaction id total amount tax amount shipping amount currency code affiliation | properties |
| Location fields: location latitude location longitude location accuracy | properties |
| Product fields: product id product name product brand product category product variant product position product price product quantity product coupon code product total amount | properties (These fields are prepended with product in the event property field in FME) |
| custom attributes | properties (These fields are prepended with attribute in the event property field in FME.) |
Custom event
Event fields are mapped as shown below:
| mParticle field | Mapped field in Harness FME |
|---|---|
| event name | eventTypeId |
| event id | foreignId |
| timestamp | timestamp |
| session id source message id | properties |
| Location fields: location latitude location longitude location accuracy | properties |
| custom attributes | properties (These fields are prepended with attribute in the event property field in FME.) |
Session start event
Event fields are mapped as shown below:
| mParticle field | Mapped field in Harness FME |
|---|---|
| event type | eventTypeId |
| event id | foreignId |
| timestamp | timestamp |
| session id source id | properties |
| Location fields: location latitude location longitude location accuracy | properties |
| custom attributes | properties (These fields are prepended with attribute in the event property field in FME.) |
Session end event
Event fields are mapped as shown below:
| mParticle field | Mapped field in Harness FME |
|---|---|
| event type | eventTypeId |
| event id | foreignId |
| timestamp | timestamp |
| session id source id | properties |
| Location fields: location latitude location longitude location accuracy | properties |
| Other session end fields: session length ms | properties |
| custom attributes | properties (These fields are prepended with attribute in the event property field in FME.) |
Screen view
Event fields are mapped as shown below:
| mParticle field | Mapped field in Harness FME |
|---|---|
| event type | eventTypeId |
| event id | foreignId |
| timestamp | timestamp |
| session id source id | properties |
| Location fields: location latitude location longitude location accuracy | properties |
| Other sessionview fields: screen name | properties |
| custom attributes | properties (These fields are prepended with attribute in the event property field in FME.) |
Note that Harness FME doesn't accept the following event types from mParticle:
- uninstall
- crash report
- opt out
- push registration
- application state transition
- push message
- network performance
- breadcrumb