Export and Import Configurations using APIs
Steps to Export Configurations
Export Steps
-
Export Roles, Groups, Users using individual respective APIs
-
Export configurations for source server
Configs available with export configurations API
Default Configs
-
Domains
-
Attributes
-
RelationTypes
-
ContentTypes
-
Workflows and Forms
-
Channels
-
MimeTypes
-
IndexingChannels and XADocAttributeMappings
-
Translations
-
Qaservice
-
DefaultConfigs
Enabled with serviceNames Flag
-
qcpapplicationservice
-
qcpauthenticationservice
-
qcpaiservice
-
qcpwebhookservice
-
preferenceservice
-
assets
Steps to Import Configurations
Pre-requisite Check
-
Webhooks service to be disabled (Refer Recommended approach for Webhook export/import: section).
-
User license should be equal to the number present in source machine if user are imported with license. If not, it can be ignored.
-
The privileges on licenses should be same for importing roles. If privileges are not the same, USER_PRIVILEGE_NOT_FOUND exception will be thrown. There are some privileges which get added exclusively from addon license package (for example, Developer, BYOI addon). These addons on licenses from source and target server should be the same.
Import Steps
-
Import Roles
-
Import Users
-
Import Groups
-
Import Configuration data
-
Import Roles again
Recommended Approach for Webhook Export/Import
-
Webhook service "qcpwebhookservice" name to be excluded from list of services while exporting configurations.
-
Webhooks configuration to be exported and imported separately using the individual API.
