Dashboard
Search: Search or filter for the desired mapping. Your filter selections persist as you navigate, so the list stays filtered until you clear it.
Add New Mapping Collection: To create a new mapping (see following page for more details).
Active/Inactive: Change to see inactive or active mappings.
Type: Data Model (and child) where this data will be mapped to.
Parent Record: Mapping at the parent level.
Name: The name given by the user or integrator. As a best practice, it should be named in the following format:
[APPLICATION] [DATA MODEL] [ADD/MODIFY/DELETE] [FROM/TO] IPAASCount: The number of fields in that mapping.
Child Record: Mapping at the child level.
Clone: Duplicate the mapping.
Reverse Clone: Clone the mapping that flips the direction and field mappings.
If the integration doesn't support the reversed direction for that data type, reverse clone is blocked to prevent creating an unusable mapping.
Add Child Collection: Add a child mapping collection.
Edit: Edit this collection (see details on next page).
Delete: Delete the mapping.
Add a New Mapping Collection
Type: Data Model (and child) where this data will be mapped to. This is NOT limited to the data types supported by the subscription nor by enabled webhooks.
If a data type and direction combination isn't supported by the integration, the platform prevents creating that mapping collection. This is driven by the integration's supported features.
Parent Record: Mapping at the parent level.
Name: The name given by the user or integrator. As a best practice, it should be named in the following format:
[APPLICATION] [DATA MODEL] [ADD/MODIFY/DELETE] [FROM/TO] IPAASSync Type: The sync type tells iPaaS.com what to do when there is new or updated data in the mapping collection.
Collision Handling Method: Options for how iPaaS deals with duplicate records on this mapping. More information here. (See note below.)
Description: The description of the mapping.
Mapping Filter: Allows users to use C# to filter out items that are not needed or are not ready for iPaaS.com or the destination system.
Error Filter: Allows users to use C# to trigger errors based on the data in this mapping collection.
Direction: Is this to or from iPaaS.com.
Sort Order: Defines where this will show in the list. The lower the number the higher it will live in the list.
Collision handling is set at the parent level. The Collision Handling Method is only shown on parent mapping collections, not on child collections. Children are processed as part of their parent, so collision handling for the whole record is decided once on the parent - a child can't resolve collisions independently of the record it belongs to. This is why the option doesn't appear when editing a child collection.
Edit Mapping Collection
These are the base settings for a mapping:
Name: The name given by the user or integrator.
Sync Type: The sync type tells iPaaS.com what to do when there is new or updated data in the mapping collection (see next page).
Parent: If this is a child record the parent would be specified here.
Direction: Is this to or from iPaaS.com
Open Manual Sync: Jump right into a manual sync to test your mapping from here.
Sort Order: Defines where this will show in the list. The lower the number the higher it will live in the list.
Collision Handling Method: Options for how iPaaS deals with duplicate records on this mapping.
Apply: Save your changes to the mapping collection without closing the window, so you can keep working. (Saving and closing remains available.) (not shown)
Sync Type
The sync type tells iPaaS.com what to do when there is new or updated data in the mapping collection:
Add: Add the new data.
Update: Update any existing data.
Add/Update: Either adding or updating data.
Delete: Delete the data.
Delete Triggered Update: Action that happens when iPaaS.com is passed a delete command from another system.
Filters
Mapping Filter: Allows users to use C# to filter out items that are not needed or are not ready for iPaaS.com or the destination system.
Error Filter: Allows users to use C# to trigger errors based on the data in this mapping collection.
Description: The description of the mapping to communicate to other iPaaS.com users the intent of the mapping.
View/Edit Toggle: Toggle on or off if you can edit a description.
Cancel: Exit without saving your work.
Apply: Save while staying on the page.
Apply and Close: Save changes and exit.
Note: Errors that are due to an error filter will not automatically retry.
Mappings List
Bulk Delete: Use the check boxes to select mappings to delete.
Add New Mapping: Allows users to add a new field in the new field modal. (see next page)
Mapping Type: Specifies the type of mapping which will hide or show other options.
Source: The field, formula or value of the source data. Depending on the direction of the mapping this could be iPaaS.com data or data from the external system.
Destination: The destination field for this mapping.
Edit: Edit the mapping. (see following pages)
Note: A note about the mapping. Useful for documenting a dynamic formula.
Reorder: Drag and drop to reorder the mappings.
Edit/Add Mapping Types
Field
Full Screen: See the mapping collection in full screen mode.
Close: Close the mapping collection.
Types: To see the following fields, field is selected.
Destination: Choose if this data will be in a field or custom field.
Field Selection for Destination: Visible fields are based on the mapping collection type (which pulls from the data model) and the direction. If the direction is TO iPaaS.com, these fields are iPaaS.com fields. If the direction is FROM iPaaS.com then these fields are from the subscription.
Create a custom field inline: When choosing a source or destination custom field, you can create a new custom field directly from the mapping window without leaving to Data Management first. See Custom Fields.
Source: Choose if this data will be in a field or custom field.
Field Selection for Source: Visible fields are based on the mapping collection type (which pulls from the data model) and the direction. If the direction is TO iPaaS.com, these fields are subscription fields. If the direction is FROM, then these fields are from iPaaS.com.
View/edit toggle for note: Toggle so you do not accidentally edit the field.
Note Field: Add notes about the mapping. These are populated when needed for most integrations.
Add to additional mapping collections: If there are other mapping collections in the same direction for the same mapping collection, you can add this mapping across multiple collections.
Cancel: Cancel your changes
Save: Save your changes
Note: The rest of these only call out the differences as to not repaeat.
Field with Default
Types: To see the following fields, field with default is selected.
Field/Custom Field for Source: Select if the source is a field or custom field.
Field Selection for Source: Visible fields are based on the mapping collection type (which pulls from the data model) and the direction. If the direction is TO iPaaS.com, these fields are iPaaS.com fields. If the direction is FROM iPaaS.com then these fields are from the subscription.
Default: Allows for a default value to be passed in if the source data is not present.
Static
Types: To see the following fields, static is selected.
Source: A static value to add to the destination field.
Lookup Translation
Types: To see the following field, lookup translation is selected.
Lookup Collection: Select the lookup translation to reference for this mapping field. The collection must already be created to be referenced here (see below).
Dynamic Formula
Types: To see the following fields, dynamic formula is selected.
Source: Used for C# to specify a formula to add to the destination field. There are type-ahead and error warnings displayed here to support you.
Generate: Tell AI what you want the formula to do and have it generate it for you.
More information about dynamic formulas can be found here.
Translations
Translations are collections of pairs of data that match a set of data from one system to data in iPaaS.com. In the below example, you can see the order statuses in one system and how they have been slimmed down. The advantage of this type of mapping is that it can be easily editable.
Dashboard
Name: The name given to the translation.
Type: The data module or child that this translation is associated with.
Sort Order: Defines where this will show in the list. The lower the number the higher it will live in the list.
Direction: Is this going TO or FROM iPaaS.com.
Destination: Choose if this data will be in a field or custom field.
Field Selection for Destination: Visible fields are based on the mapping collection type (which pulls from the data model) and the direction. If the direction is TO iPaaS.com, these fields are iPaaS.com fields. If the direction is FROM iPaaS.com then these fields are from the subscription.
Source: Choose if this data will be in a field or custom field.
Field Selection for Source: Visible fields are based on the mapping collection type (which pulls from the data model) and the direction. If the direction is TO iPaaS.com, these fields are subscription fields. If the direction is FROM then these fields are from iPaaS.com.
Add/Edit Translation Collection
Name: The name given to the translation.
Type: The data module or child that this translation is associated with.
Sort Order: Defines where this will show in the list. The lower the number the higher it will live in the list.
Direction: Is this going TO or FROM iPaaS.com.
Destination: Choose if this data will be in a field or custom field.
Field Selection for Destination: Visible fields are based on the mapping collection type (which pulls from the data model) and the direction. If the direction is TO iPaaS.com, these fields are iPaaS.com fields. If the direction is FROM iPaaS.com then these fields are from the subscription.
Source: Choose if this data will be in a field or custom field.
Field Selection for Source: Visible fields are based on the mapping collection type (which pulls from the data model) and the direction. If the direction is TO iPaaS.com, these fields are subscription fields. If the direction is FROM then these fields are from iPaaS.com.
Source: Name of the value for the source value.
Destination: Name of the value for the destination value.
Edit: Edit the lookup translation.
Delete: Delete the lookup translation.
Add/Edit Lookup Translation Lines