- Home /
- Explore m3ter Documentation /
- Integrations /
- Setting Up and Managing Native and Notification Integrations
Creating and Managing External Mappings
When you integrate your 3rd-party systems with the m3ter platform, 3rd-party entities and fields are mapped to m3ter entities and fields. External Mappings are created and act as mapping reference lookups for which objects and fields have been mapped across two or more systems. You can review these mapping references on the External Mappings page under Integrations where they are listed.
When you are working to set up your Integrations and want to test or troubleshoot your implementation before going live, you might need to create External Mappings manually and, at a later date, edit or delete them. You can also create bulk mappings for specific mapping types.
This topic explains how to create and manage the External Mapping needed for the integrations with external systems you've set up for your Organization:
Tip: External Mappings for Accounts? You can review any External Mappings created for an Account directly from the External Mappings tab on an Account page. You can then create and manage External Mappings directly from there - see Creating and Managing External Mappings for Accounts.
Creating Single External Mappings
From the External Mappings page, you can create a single mapping of a specific mapping type:
To create a single External Mapping:
1. Select Integrations>External Mappings. The External Mappings page opens.
2. Select Create External Mapping. To create a mapping, you must complete a two-stage workflow and the Create page opens ready for you to complete Stage 1.
Stage 1 - Select mapping type:
3. Enter External Mapping Settings:
Use the m3ter entity type drop-down to select the m3ter entity type you want to use to create the mapping type.
Use the External system drop-down to select the 3rd-party system referenced.
Use the External table drop-down to select the table in the selected 3rd-party system that you want to use for the mapping type:
In this example, we've chosen to create an Account <> Subscription mapping for m3ter <> Chargebee.
Tip: Other External systems showing? Note that you can configure mappings for any of the integrations with 3rd-party systems set up for your m3ter Organization. This includes any custom integrations as well as native integrations.
4. When you've completed the mapping type set up, select Next. The page adjusts to allow you to complete Stage 2:
The m3ter entity type, External System, and External table you configured for Stage 1 are shown.
Stage 2 - Add mapping IDs:
5. On the External Mappings Table panel:
Use the m3ter entity drop-down to select the specific entity - here Account - in your Organization you want to create the mapping for.
Tip: Selection is filtered! Note that the list of m3ter entities available for selection will be filtered to show only those entities of that type - here Accounts - for which a mapping of the selected type has not yet been created.
In the External entity ID field, enter the id of the 3rd-party system entity you want to map to.
Tip: Possibles values might show! Note that if the possible values for the External entity ID field can be fetched for the External system, then you can use a drop-down list to select the value for this field from the list of possible values returned.
Warning: Do not use duplicate External Entity IDs! When you enter the External entity ID, ensure you do not use the ID of an entity that has already been mapped to for mappings of this type.
6. Select Create External Mapping. The Create page closes and the new External Mapping is shown on the External Mappings tab. For example:
Creating Bulk External Mappings
From the External Mappings page, you can create mappings in bulk for a specific mapping type:
To create External Mappings in bulk:
1. Select Integrations>External Mappings. The External Mappings page opens.
2. Select the three-dot menu button at top-right of the page and then select Create in bulk:
To create mappings in bulk, you must complete a two-stage workflow and the Create in bulk page opens ready for you to complete Stage 1.
Stage 1 - Select mapping type:
3. Enter External Mapping Settings:
Use the m3ter entity type drop-down to select the m3ter entity type you want to use to create the mapping type.
Use the External system drop-down to select the 3rd-party system referenced.
Use the External table drop-down to select the table in the selected 3rd-party system that you want to use for the mapping type:
In this example, we've chosen to create Account <> Subscription mappings in bulk for m3ter <> Chargebee.
4. When you've completed the mapping type set up, select Next. The page adjusts to allow you to complete Stage 2:
The m3ter entity type, External System, and External table you configured for Stage 1 are shown.
Stage 2 - Add mapping IDs:
5. On the External Mapping Details panel, select Add Mapping. The page adjusts to add a row for the first mapping:
Use the m3ter entity drop-down to select the specific entity in your Organization you want to create the mapping for.
Tip: Selection is filtered! Note that the list of m3ter entities available for selection will be filtered to show only those entities of that type - here Accounts - for which a mapping of the selected type has not yet been created.
In the External entity ID field, enter the id of the 3rd-party system entity you want to map to.
Tip: Possibles values might show! Note that if the possible values for the External entity ID field can be fetched for the External system, then you can use a drop-down list to select the value for this field from the list of possible values returned.
Warning: Do not use duplicate External Entity IDs! When you enter the External entity ID, ensure you do not use the ID of an entity that has already been mapped to for mappings of this type.
6. Select Add mapping again and repeat up to a maximum of 20 mappings of the selected type:
In this example, we've added three mappings of the selected Account <> Subscription mapping type for m3ter <> Chargebee.
7. Select Create External Mappings. You are returned to the External Mappings page where the bulk mappings of the selected type are now listed:
Managing External Mappings
From the External Mappings page you can manage you Organization's mappings and edit or delete them:
To manage External Mappings:
1. Select Integrations>External Mappings. The External Mappings page opens.
2. If you want to edit a mapping, select Edit.
3. On the Edit page, make your changes and select Update External Mapping.
4. If you want to delete a single mapping, select Delete:
A confirmation pop-up appears. Select Yes to complete the delete action.
5. If you want to delete multiple mappings, check those you want to delete and click Delete selected:
Additional Support
Login to the Support portal for additional help and to send questions to our Support team.