Introduction
This information in this topic will help you upgrade to Central Configuration from the deprecated legacy configuration:
To use Central Configuration, watchdog.config must contain the paths.central_config_file property whose value is a path to the central configuration file relative to the PrizmDoc Server install directory. This is the default setting, but if you are migrating from legacy configuration, you should verify that this property is set correctly.
The following table maps the legacy file and property that corresponds to each central config property:
The file paths for the Central Configuration file are:
- Docker: <config_folder>/prizm-services-config.yml, where <config_folder> is the folder that you mapped as
/configwhen creating the container. See Installing / Using Docker for more details. - Windows: C:\Prizm\prizm-services-config.yml (assuming the standard install location.)
| Central Configuration Property | Legacy Configuration File |
|---|---|
| license.solutionName | Property: license.solutionName File: watchdog.config |
| license.key | Property: license.key File: watchdog.config |
| network.publicPort | Property: cep_port OR sep_port File: watchdog.config Instructions: If running in cluster mode, the central config value corresponds to cep_port. If it is running in single-server mode, it corresponds to sep_port instead. |
| network.internalStartingPort | Property: internal_starting_port File: watchdog.config |
| network.clustering.enabled | Property: server_mode File: watchdog.config Instructions: A central config value of true corresponds to a server mode of "multi", and false corresponds to "single". |
| network.clustering.clusterPort | Property: sep_port File: watchdog.config Instructions: The central config value maps to sep_port only if running in cluster mode. |
| network.clustering.servers | Property: cep_servers File: watchdog.config Instructions: Reduce the cep_servers array to an array of only the addresses of each server. The port of each will be assumed to be network.clustering.clusterPort. |
| security.aesEncryption.key | Property: ViewingSessionEncryptionKey OR encryptionKey OR affinityTokenKey, depending on file File: plb/pcc.config, redaction.config, workfile.config, contentconversion.config |
| security.aesEncryption.iv | Property: ViewingSessionEncryptionIv OR encryptionIv OR affinityTokenIv, depending on file File: plb/pcc.config, redaction.config, workfile.config, contentconversion.config |
| logging.directory | Property: paths.app_log_dir File: watchdog.config Instructions: - Join the elements of paths.app_log_dir into a path string. |
| logging.daysToKeep | Property: logging.streams.count, workfileService.logging.count, redactionService.logging.count, fileViewer.logging.count, contentConversionService.logging.count, errorReportingService.logging.count, OR logging.count, depending on file File: watchdog.config, plb/pcc.config |
| cache.directory | Property: DocumentPath, GroupStateFolder, TempcachePath File: servicehost/pcc.config |
| workFiles.directory | Property: workfileService.workfileCache.path File: watchdog.config |
| workFiles.lifetime | Property: workfileService.workfileCache.expirationPeriod File: watchdog.config |
| userDocuments.directory | Property: UserDocumentFolder File: servicehost/pcc.config |
| processIds.lifetime | Property: redactionService.cache.expirationPeriod, contentConversionService.cache.expirationPeriod File: watchdog.config |
| viewing.allowDocumentDownload | Property: EnableSourceDocumentDownload File: servicehost/pcc.config |
| viewing.sessionLifetime | Property: ViewingSessionTimeout File: servicehost/pcc.config |
| viewing.cacheLifetime | Property: CacheExpirationPeriod File: servicehost/pcc.config |
| viewing.contentEncryption.enabled | Property: EncryptPageContent File: servicehost/pcc.config |
| viewing.sessionConstraints.documentSource.allowedValues | Property: ViewingSessionPropertyDocumentSource File: servicehost/pcc.config Instructions: Split ViewingSessionPropertyDocumentSource into an array of allowed sources. |
| viewing.sessionConstraints.countOfInitialPages.min | Property: ViewingSessionPropertyCountOfInitialPages File: servicehost/pcc.config Instructions: Set the central config value to the min value from ViewingSessionPropertyCountOfInitialPages. |
| viewing.sessionConstraints.countOfInitialPages.max | Property: ViewingSessionPropertyCountOfInitialPages File: servicehost/pcc.config Instructions: Set the central config value to the max value from ViewingSessionPropertyCountOfInitialPages. |
| viewing.sessionConstraints.documentExtension.regex | Property: ViewingSessionPropertyDocumentExtension File: servicehost/pcc.config |
| viewing.sessionConstraints.externalId.regex | Property: ViewingSessionPropertyExternalId File: servicehost/pcc.config |
| viewing.sessionConstraints.pageContentEncryption.allowedValues | Property: ViewingSessionPropertyPageContentEncryption File: servicehost/pcc.config Instructions: Set the central config value to an array of the values allowed by ViewingSessionPropertyPageContentEncryption. |
| viewing.sessionConstraints.serverCaching.allowedValues | Property: ViewingSessionPropertyServerCaching File: servicehost/pcc.config Instructions: Set the central config value to an array of the values allowed by ViewingSessionPropertyServerCaching. |
| viewing.sessionConstraints.render.alwaysUseRaster.allowedValues | Property: Html5RenderAcceptableRasterValue File: servicehost/pcc.config Instructions: Set the central config value to an array of the values allowed by Html5RenderAcceptableRasterValue. |
| fileTypes.pdf.pageBoundaries | Property: useCropBox File: PDFConversionService. <Platform>.configInstructions: Set the central config value to "cropBox" if useCropBox is true, or "mediaBox" if it is false. |
| fileTypes.excel.pagination.enabled | Property: officeConversionService.excelPagination File: watchdog.config |
| fileTypes.excel.pagination.dimensions.minWidth | Property: officeConversionService.excelPageWidthMin File: watchdog.config Instructions: Add 'in' to the end of the value in watchdog.config. |
| fileTypes.excel.pagination.dimensions.maxWidth | Property: officeConversionService.excelPageWidthMax File: watchdog.config Instructions: Add 'in' to the end of the value in watchdog.config. |
| fileTypes.excel.pagination.dimensions.minHeight | Property: officeConversionService.excelPageHeightMin File: watchdog.config Instructions: Add 'in' to the end of the value in watchdog.config. |
| fileTypes.excel.pagination.dimensions.maxHeight | Property: officeConversionService.excelPageHeightMax File: watchdog.config Instructions: Add 'in' to the end of the value in watchdog.config. |
| fileTypes.office.disableExternalHyperlinks | Property: officeConversionService.disableExternalHyperlinks File: watchdog.config |
| fidelity.msOfficeDocumentsRenderer | Property: officeConversionService.msOfficeDocumentsRenderer File: watchdog.config |
| resourceUsage.pccis.instances | Property: pccis_instances File: watchdog.config Instructions: Set the central config value equal to the number of objects in the pccis_instances array. |
| resourceUsage.ocs.numInstances | Property: officeConversionService.officeInstanceCount File: watchdog.config |
| resourceUsage.ocs.numThreads | Property: officeConversionService.threadCount File: watchdog.config |
| resourceUsage.ocs.numPorts | Property: officeConversionService.officePortCount File: watchdog.config |