Automatic knowledge synchronization

The Super Administrator can enable automatic synchronization of RightAnswers content to Amazon S3 buckets. When enabled, the automatic synchronization feature ensures that your published solutions are continuously synchronized to Amazon S3 in the required file format, providing a reliable and scalable way to serve external systems.

How knowledge sync works:

  • The automatic sync is enabled when the KnowledgeSyncEnabled setting is set to 'True'.

  • The sync can be configured to be either 'Delta' or ' Incremental'. 'Delta' replaces the existing backup file while ' Incremental' creates a new backup on every save without replacing previous versions. The sync_type attribute in the KnowledgeSyncParameters setting configures the backup to be either 'Delta' or ' Incremental'.

  • A solution is synced only if its collection and status match the ones configured in the KnowledgeSyncParameters setting:

    • must belong to the same collection set in the SyncCollectionList parameter in the KnowledgeSyncParameters setting.

    • must have the same status set in the SyncSolutionStatusList  parameter in the KnowledgeSyncParameters setting.

  • When solutions that match the configured collection and status criteria are saved, a backup file is uploaded to the S3 bucket when the SaveSolutionsTaskJob runs. The SaveSolutionsTaskJob asynchronously executes all scheduled save solution tasks every 10 seconds on a single node. The batch size and embedding task delay can be configured for this job. Backup files are created using the solution ID.

  • If no match is found but the solution exists in the destination, its backup file is removed from the Amazon S3 bucket. 

  • A one-time backfill job of all eligible solutions can be triggered manually by support teams to upload the solutions retroactively using the KnowledgeSyncBackfillTask SQL job. When the job is not run, only new saves continue syncing to the Amazon bucket.
     NOTE: The KnowledgeSyncBackfillTask job MUST NOT be run in parallel with the SaveSolutionsTaskJob because it may result in race conditions and lock situations.   

  • The supported backup file formats are PDF, CSV, XML, SALESFORCE-CSV, JSON and DOCX.
    The SALESFORCE-CSV format exports the column headers along with the data in CSV format.

  • A knowledge sync will be triggered when changes to a content block result in updates to its associated solutions. This behavior is independent of the CBUpdateTriggersMMD setting that updates the Minor Modified Date of the associated solutions.

  • When a solution is deleted, its corresponding backup file is also deleted.

What’s Not Supported (Exclusions):

Currently, synchronization does not apply to:

  • Imported solutions

  • Workflow solutions