Conga Product Documentation

Welcome to the new doc site. Some of your old bookmarks will no longer work. Please use the search bar to find your desired topic.

Data Sync Frequently Asked Questions (FAQ)

This section answers common questions about data synchronization. Helps administrators and developers understand how data synchronization works and resolve common issues quickly.

Forward Data Sync

1. Is ETL the same as Forward Sync?
Yes. ETL (Extract, Transform, Load) is the same as Forward Sync.
2. Can I perform a data sync on a newly onboarded org without any prior configuration?
No. Before running a data sync on a new org, you must set up the following:
3. Do I need to add a Salesforce org in External Integration before adding Salesforce Settings?
Yes. Add the Salesforce org through Org Management > External Integration before adding Salesforce Settings. Skipping this step results in an error. For more information, see External Integration.
4. Can I enable all objects even if I only want to sync specific ones?
No. Enable only the objects needed for syncing.
5. What happens if I enable Reverse Sync objects while running a Forward Sync?
There is no impact. Objects with a sync direction set to Reverse are ignored during Forward Sync.
6. Can I add object or field mappings without adding them to the Schema first?
No. Add the object or field to the Schema before setting up any mappings.
7. How many stages does a data sync have?
A data sync has three stages:
  • Fetch: Retrieves data from the source.
  • Transform: Processes and maps the data.
  • Upload: Loads the data into the destination.
8. What should I do if a data sync fails?
If a data sync fails, go to the Admin Console and navigate to Data Sync > Run History. From the list of runs, open the corresponding Run ID for the failed sync and download the error logs. Review the logs to identify the issues, correct the data as needed, and then rerun the data sync. For more information, see Data Sync Run History.
9. Is there a more efficient way to add multiple fields in Field Mapping and Schema?
Yes. Use the Mappings option to add multiple fields at once, instead of adding them individually. For more information, see All Object Mappings.
11. How do I enable or disable all objects at once?
Use either of the following options:
  • Toggle Is Enabled? manually.
  • Use the Enable All or Disable All options.

For more information, see Overview of the Data Sync UI.

12. If I delete a record in Salesforce and run a Full Sync, will the record be deleted on the Conga Advantage Platform?
No. Full Sync supports only Create and Update operations. It does not delete records from the Conga Advantage Platform. To remove deleted records, you must run an Incremental Sync.
13. If I delete a record or image, run a Full Sync, and then run an Incremental Sync, will the record be deleted on the Conga Advantage Platform?
No. The record will not be deleted on the Conga Advantage Platform.
14. What sync direction is required to run a Forward Sync using the Forward Sync API? Is there anything else I need to configure?
The sync direction for the object must be set to Forward.
15. What should I do if I see a "Failure happened on 'Source' side" error or an ODBC XML parsing error?
This error typically indicates a field mapping issue. To resolve the issue:
  1. Check the Field Mapping for the affected object and remove any duplicate field mappings.
  2. If a mapping has been added for the Name or Id field, do one of the following:
    • Remove or disable the mapping.
    • Set the appropriate flag to true: set IsPrimaryName to true for the Name field, or set IsIdColumn to true for the Id field.

For more information, see Object Mappings.

16. What should I do if I see the error "The given key 'ExternalId' was not present in the dictionary"?
This error is caused by an incorrect field mapping configuration. To resolve the issue:
  1. Open the Field Mapping for the affected object.
  2. If any field has ExternalId marked as true, set it to false.
  3. Check whether IsPrimaryNameField is set to true. If yes, set it to false.
  4. Retry the sync.

For more information, see Object Mappings.

Reverse Data Sync

1. What is Reverse Sync?
Reverse Sync is the process of synchronizing data from a Conga Advantage Platform object to a Salesforce object.
2. Is Reverse Sync a real-time process?
Reverse Sync is a near real-time process. When a record is created or updated on the Conga Advantage Platform, it begins synchronizing data to Salesforce based on the Change Data Capture (CDC) event triggered by the system.
4. Can I reverse sync any object from the Conga Advantage Platform to Salesforce?
Yes. Set valid object and field mappings to initiate Reverse Sync for any object using a Data Change Event. Starting from release 202410.2, any object with valid Reverse Sync object and field mappings can be synchronized.
5. How does the Criteria field in object mapping work for Reverse Sync?
The Criteria field controls when a sync is triggered. Set a condition based on a specific field value. The sync runs only when that condition is met.
6. Can I apply rules to field mappings in Reverse Sync?
No. Rules on field mappings are not supported for Reverse Sync.
7. Can I sync a multi-picklist field from the Conga Advantage Platform to Salesforce using Reverse Sync?
Yes. Reverse Sync supports multi-picklist fields for string field types. For more details, see Is Reverse Sync Enabled description.
8. How can I check the status of a Reverse Sync?
Go to Data Sync > Run History to check the status of a Reverse Sync. For more information, see Run History.
9. Can I use the Sync Now button to trigger a Reverse Sync?
No. The Sync Now button works only for ETL (Forward) Sync. Reverse Sync runs automatically in near real-time based on Data Change Events.
10. What is a race condition, and how does it affect Reverse Sync?
A race condition occurs when a child object tries to sync to Salesforce at the same time as its parent object. If the parent sync is incomplete, the child sync may fail because the required reference field value is not yet available.

For example, if the Order object is the parent of OrderLineItem and the Order sync has not completed, the OrderLineItem sync may fail with the following error: Required fields are missing: [Apttus_Config2__OrderId__c]

11. How can I prevent a race condition during Reverse Sync?
Use the Criteria field in the object mapping for the child object. Set an appropriate condition to ensure the parent object sync has completed before the child object begins syncing.
12. Can I sync Attributes and their extension objects using Reverse Sync?
Attributes are synchronized with their parent LineItem object and cannot be synced independently. Starting from release 202411.1, attribute extensions can also be reverse synced. Set up object mappings for both the attribute object and its extension to enable this.
13. Can I sync documents using Reverse Sync?
Yes, but only for the Agreement object. Document syncing is not supported for other objects.
14. How can I enable reverse sync for the Owner field?

To enable Reverse Sync for the Owner field, configure the correct field mapping in the Agreement object:

  • Set both Source Field Type and Target Field Type to Lookup.
  • Map Source Field Name OwnerId to Target Field Name RecordOwner.
  • Set Target Lookup Object Name to User.
  • Turn on the Reverse Sync option.

After updating the mapping, save the configuration and retry the reverse sync.

15. Can I see the External ID for an attribute when querying it on the platform after a Reverse Sync?
No. The External ID is not visible when querying an attribute that has been reverse synced on the Conga Advantage Platform.
16. How can I enable Audit Field Reverse Sync?
Follow these steps:
  1. Configure the audit field in Salesforce. For more information, see the Salesforce Help article on audit fields.
  2. Add the corresponding field mapping on the platform.
17. Do rules work for Reverse Sync?
No. Rules are not supported for Reverse Sync.
18. What should I do if the AgreementClause object fails to reverse sync?
This is commonly caused by an incorrect field mapping for the DocumentVersionId field, which is no longer in use. Disable or update the field mapping for DocumentVersionId in the AgreementClause object and retry the sync.
19. What should I do if I get the error "Object name cannot be empty"?
Check the field mapping of the affected object. If the object has any reference or lookup fields, verify that the reference or lookup object name is provided. If the name is missing, add the object name and retry the sync.
21. What should I do if I see the error "Operation is not valid due to the current state of the object" in Grafana while performing a Reverse Sync for an Order?
Check the source filter criteria applied. This error indicates that the criteria is not being satisfied. Correct the criteria or ensure the record meets the required conditions, then retry.
22. What should I do if a record is being skipped with the message "Skipped sync of update event due to no criteria and the record does not have an externalId"?
This error occurs when a record is updated without an External ID and no source filter criteria is applied. The following table describes how Reverse Sync handles each scenario: To resolve this error, apply a valid source filter criteria on the object and retry.

Scenario

Reverse Sync Behavior

Record created on platformReverse Sync runs automatically if the object sync direction is set to Reverse and the fields are marked for Reverse Sync.
Record updated, no External ID, no criteriaReverse Sync skips or fails. Apply a valid source filter criteria to resolve this.
Record updated, no External ID, valid criteria existsReverse Sync processes and synchronizes the record successfully.
23. What should I do if a record is being skipped with the message "Retried for 11 times"?
This error usually means the object has a lookup field where IsParentField is marked as true, but the referenced parent record has not been reverse synced and does not have an External ID. Ensure the parent record is reverse synced first, then retry.
24. What should I do if the Business Object ID is appearing as a Platform ID in Salesforce?
Check the field mapping for the affected object. The data type for the Business Object ID field must be set to Reference on both the source and sink sides. The following is an example of the correct field mapping configuration:
{
  "SourceFieldName": "Apttus_Config2__BusinessObjectId__c",
  "SourceFieldType": "Reference",
  "SinkFieldName": "BusinessObjectId",
  "SinkFieldType": "Reference",
  "LookupObjectNameSink": "Proposal",
  "RuleName": "",
  "IsEnabled": true,
  "ObjectMappingId": "625312b4-e8ae-42ff-b11b-49a696e4eebb",
  "IsIdColumn": false,
  "IsPrimaryNameField": false,
  "IsProtected": false,
  "IsReverseSync": true,
  "IsImageField": false
}