Download PDF
Download page Creating and Managing Object Mappings.
Creating and Managing Object Mappings
Object Mapping is a process of defining the relationship between objects and entities in the Revenue Lifecycle Platform (RLP). The Object Mapping feature enables you to establish a correlation between the properties of objects and data structures.
The initial list of objects to be synced is gathered from the tenant profile and displayed on the Object Mappings page. When you need to add new objects or fields to the sync or update the existing data structure, you can do so from the Data Sync UI on the Conga Platform. When adding new objects or managing existing objects, you can also select which fields to include or exclude from the sync operation.
You can not only map target fields to source fields but also transform target field values to match the format the Conga platform can handle if they are written differently or in an incompatible format.
You must set up your data synchronization infrastructure before object mapping. For more details on configuring data sync infrastructure, see Getting Started with Data Sync.
Out-of-the-box (OOTB) objects and fields are automatically mapped during customer onboarding. However, the currency field is not mapped by default. If your organization uses multiple currencies, you must manually map the currency field for the relevant objects before initiating data sync.
To create object mapping
- Log in to the Conga Platform as an admin user.
- Click the App Launcher () icon from the top-left corner > Admin Console > Data Sync. The Mapped Objects for Data Sync page appears.
- Click Create Object Mapping. A Create Object Mapping page appears.
Enter values in the following fields:
Field Description Source Object Name Enter the source object name. Target Object Name Enter the name of the target object that you want to map to the source object. Sequence Enter the sequence to indicate how important an object is. When syncing data, the system considers this number to decide which objects should be synced first. Sync API Path Enter the relative API path to invoke the custom API during data sync. Source Filter Criteria Enter a query condition based on the source system to define the criteria for filtering records for synchronization.
- For forward sync from Salesforce to the Platform: Use Salesforce Object Query Language (SOQL) to define a query condition.
EmailTemplate Object ETL sync
"EmailTemplate.FolderId IN (SELECT Id FROM Folder WHERE AccessType = 'Public') AND ( TemplateType = 'text' OR TemplateType = 'html')"
CODE - For reverse sync from the Platform to Salesforce: Use platform expression format (formula syntax) to define a query condition.
Conditional status evaluation for Syncing Data to Salesforce
(ProductConfiguration.OldValue.BusinessObjectId == null AND ProductConfiguration.BusinessObjectId != null) OR (ProductConfiguration.OldValue.Status != \"Finalized\" AND ProductConfiguration.Status == \"Finalized\")
CODE{ObjectName}.OldValue.FieldName
.
Category Select the application to which the object belongs, such as CLM, CRM, CPQ, etc.
Sync Direction Select the direction of sync from the dropdown list:
- Forward: Near Realtime from Salesforce to RLP
- Reverse: Near Realtime from RLP to Salesforce
- ETL: Extract, Transform, and Load through Data Sync.
Forward Sync: Forward sync, whether full or incremental, does not update null values for any column from Salesforce to the RLC. Additionally, it does not synchronize objects with complex designs that require custom logic for data transfer to the RLC.
Reverse Sync: To include system audit fields (CreatedDate, CreatedBy, UpdatedDate, and UpdatedBy) in the reverse data sync from Conga Platform to Salesforce, you need to:
- Map the Conga Platform fields to the corresponding Salesforce fields. For more information, see Creating and Managing Object Mappings.
- Enable the permission to create audit fields for standard profiles in Salesforce. For more information, see Enable the permission 'Create Audit Fields' for standard profiles.
Custom Query Enter the query, including fields and criteria-based filters, to retrieve specific records. It is useful for the Postgres system as a source.
Source Type Select the type of source system a data sync establishes a connection with. It supports Salesforce and Postgres at the moment.
Skip Delete Sync? Enable this toggle to skip the synchronization of deleted records from the source object to the target object. By default, this feature is turned off. For an incremental sync, if a record gets deleted in the source object, the corresponding record must be removed from the target object.
Is Protected Enable this toggle to prevent any modifications to the object and mark it as an OOTB schema object mapping.
Is Enabled? Enable this toggle if you want the system to consider the object when syncing data.
This applies to manual data sync. In the case of scheduled data sync, it considers the specific objects you have chosen when creating a sync schedule. For more details on scheduling data sync, see Scheduling Data Sync.
Is Document Sync Required? Enable this toggle to sync the documents. This is only for the CLM application documents.
Is Translation Object Enable this toggle to sync translation data of multiple languages used on the source platform. For more information, see Translation Sync.
Is Complex Array Type? Enable this toggle to indicate that an object supports the Complex Array type. Once enabled, you must specify values for the Complex Array Type Field Name and Complex Array Parent ID Field Name from the platform schema.
This is useful for the Approvals use cases.
- For forward sync from Salesforce to the Platform: Use Salesforce Object Query Language (SOQL) to define a query condition.
- Click Save. A new object mapping is created. Next, you need to map the source objects' fields to the target objects' fields.
- Click on the required Object Mapping from the list > click Create Field Mapping.
The Field Mappings page appears. Enter values in the following fields.
Field Description Source Field Name Enter the keyword to search and select the source field name. Source Field Type This field's value is automatically filled based on the selected source field name, but you can edit it if needed.
Target Field Name Enter the keyword to search and select the target field name that you want to map to the source field. Target Field Type This field's value is automatically filled based on the selected target field name, but you can edit it if needed. Target Lookup Object Name Enter the name of the lookup object if the target field is lookup. Rule Name Search and select the rule name used to execute the specific transformation name that is needed as part of data sync while bringing data from the source to the destination system. Is Image Field Enable this toggle to indicate that a field is intended to store the image information in URL format.
Is ID Column Enable this toggle to mark a field as the Primary ID field for the associated object. This is useful for the Conga Contract use cases. Is Primary Name Field Enable this toggle to mark a field as the Primary Name Field for the associated object. This is useful for the Conga Contract use cases. Is Reverse Sync Enabled Enable this toggle to indicate that a field is a part of transaction data that needs to be synced from the platform to an external system.
Do not enable this toggle for formula fields, as Reverse Sync does not support them. This is by design, as SFDC does not support inserting or updating formula fields.
Is Enabled? Enable this toggle if you want the system to consider the field when syncing data. Click Save. A new field mapping is created for the object.
You might encounter field data that are written differently or in a format that doesn't match what the Conga Platform can work with. In that case, you can convert source field data into a format that matches the requirements of the Conga Platform. For more information, see Transforming Field Values.
- Click on the required Object Mapping from the list > click Create Field Mapping.
To edit object mapping
- Log in to the Conga Platform as an admin user.
- Click the App Launcher () icon from the top-left corner > Admin Console > Data Sync. The Mapped Objects for Data Sync page appears with a list of objects.
- Click the More () icon next to the object.
- Click Edit.
- Edit the fields as required and click Save.
Similarly, you can edit field mapping.
You can only modify synced object mappings.
To delete object mapping
- Log in to the Conga Platform as an admin user.
- Click the App Launcher () icon from the top-left corner > Admin Console > Data Sync. The Mapped Objects for Data Sync page appears with a list of objects.
- Click the More () icon next to the object.
- Click Delete.
Similarly, you can delete field mapping.
You can not delete if the object mapping is not synchronized and marked as Is Protected.