Configure knowledge sync parameters
The Administrator can configure the automatic synchronization of solutions to the designated Amazon S3 bucket by configuring the parameters in KnowledgeSyncParameters.
- Setting Name:
KnowledgeSyncParameters - Section Name: Knowledge Sync
- Description: Stores the configuration parameters to enable knowledge synchronization to the designated Amazon S3 bucket. The configuration parameters include the login details, storage location, format of the data, and filters to choose which collections and solution statuses to sync.
- Superadmin only?: No
To configure the KnowledgeSyncParameters setting:
-
Open the Administrator Console.
-
Click Settings > Application Settings.
-
On the Application Settings page, click and expand Knowledge Sync.
-
Click and expand KnowledgeSyncParameters and enter the following values.
-
For adding the configuration at the company level:
-
Click Add near Company/Group Values
-
Under Select Company, select the company for which you want to enable the synchronization to the designated Amazon S3 bucket.
-
Under Value, configure the parameters:
-
sync_type- configures the type of backup, 'Delta' or 'Incremental'. 'Delta' replaces the existing backup file while 'Incremental' creates a new backup on every save without replacing previous versions. -
sync_collection_list– list of the collections from which solutions will be migrated/backed-up to the external storage system. -
sync_solution_status_list– list solution statuses eligible for backup. -
backup_format– Specifies the backup file format (e.g., XML, JSON, PDF). -
bucket_name– Specifies the S3 bucket name. -
bucket_region– Defines the S3 bucket region (e.g., us-east-1). -
client_id– Stores the client ID for authentication. -
client_secret– Stores the encrypted client secret for authentication.
Note: You must configure the parameters for each file format type.
Example:
{"sync_param_name" : "NASync11","sync_type": "delta","backup_format": "XML","backup_location": "aws-s3","bucket_name": "rta-qa-legacy-builds","bucket_region": "us-east-1","client_id": "AKIAQGITTQ6MW7XLJWHP","client_secret": "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","sync_collection_list":"*Assurance,support*,custom_sa,custom_SharedCollectionNEW","sync_solution_status_list": "draft,published,Review"} -
-
Click Save.
-
Click Save Setting.
-