PrizmDoc Viewer v13.17 - Updated
Administrator Guide / PrizmDoc Server / Configuring / Upgrade from Legacy Configuration
In This Topic
    Upgrade from Legacy Configuration
    In This Topic

    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:

    • Linux: /usr/share/prizm/prizm-services-config.yml
    • Windows: C:\Prizm\prizm-services-config.yml

    NOTE: The default installation directory is: C:\Prizm.

    Central Configuration Property Legacy Configuration File Legacy Configuration Property Special Transfer instructions
    license.solutionName watchdog.config license.solutionName -
    license.key watchdog.config license.key -
    network.publicPort watchdog.config cep_port OR sep_port, see 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 watchdog.config internal_starting_port -
    network.clustering.enabled watchdog.config server_mode A central config value of true corresponds to a server mode of "multi", and false corresponds to "single".
    network.clustering.clusterPort watchdog.config sep_port, see instructions The central config value maps to sep_port only if running in cluster mode.
    network.clustering.servers watchdog.config cep_servers 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 plb/pcc.config, redaction.config, workfile.config, contentconversion.config ViewingSessionEncryptionKey OR encryptionKey OR affinityTokenKey, depending on file -
    security.aesEncryption.iv plb/pcc.config, redaction.config, workfile.config, contentconversion.config ViewingSessionEncryptionIv OR encryptionIv OR affinityTokenIv, depending on file -
    logging.directory watchdog.config paths.app_log_dir Join the elements of paths.app_log_dir into a path string.
    logging.daysToKeep watchdog.config, plb/pcc.config logging.streams.count, workfileService.logging.count, redactionService.logging.count, fileViewer.logging.count, contentConversionService.logging.count, errorReportingService.logging.count, OR logging.count, depending on file -
    cache.directory servicehost/pcc.config DocumentPath, GroupStateFolder, TempcachePath -
    workFiles.directory watchdog.config workfileService.workfileCache.path -
    workFiles.lifetime watchdog.config workfileService.workfileCache.expirationPeriod -
    userDocuments.directory servicehost/pcc.config UserDocumentFolder -
    processIds.lifetime watchdog.config redactionService.cache.expirationPeriod, contentConversionService.cache.expirationPeriod -
    viewing.allowDocumentDownload servicehost/pcc.config EnableSourceDocumentDownload -
    viewing.sessionLifetime servicehost/pcc.config ViewingSessionTimeout -
    viewing.cacheLifetime servicehost/pcc.config CacheExpirationPeriod -
    viewing.contentEncryption.enabled servicehost/pcc.config EncryptPageContent -
    viewing.sessionConstraints.documentSource.allowedValues servicehost/pcc.config ViewingSessionPropertyDocumentSource Split ViewingSessionPropertyDocumentSource into an array of allowed sources.
    viewing.sessionConstraints.countOfInitialPages.min servicehost/pcc.config ViewingSessionPropertyCountOfInitialPages Set the central config value to the min value from ViewingSessionPropertyCountOfInitialPages.
    viewing.sessionConstraints.countOfInitialPages.max servicehost/pcc.config ViewingSessionPropertyCountOfInitialPages Set the central config value to the max value from ViewingSessionPropertyCountOfInitialPages.
    viewing.sessionConstraints.documentExtension.regex servicehost/pcc.config ViewingSessionPropertyDocumentExtension -
    viewing.sessionConstraints.externalId.regex servicehost/pcc.config ViewingSessionPropertyExternalId -
    viewing.sessionConstraints.pageContentEncryption.allowedValues servicehost/pcc.config ViewingSessionPropertyPageContentEncryption Set the central config value to an array of the values allowed by ViewingSessionPropertyPageContentEncryption.
    viewing.sessionConstraints.serverCaching.allowedValues servicehost/pcc.config ViewingSessionPropertyServerCaching Set the central config value to an array of the values allowed by ViewingSessionPropertyServerCaching.
    viewing.sessionConstraints.render.alwaysUseRaster.allowedValues servicehost/pcc.config Html5RenderAcceptableRasterValue Set the central config value to an array of the values allowed by Html5RenderAcceptableRasterValue.
    fileTypes.pdf.pageBoundaries PDFConversionService.<Platform>.config useCropBox Set the central config value to "cropBox" if useCropBox is true, or "mediaBox" if it is false.
    fileTypes.excel.pagination.enabled watchdog.config officeConversionService.excelPagination -
    fileTypes.excel.pagination.dimensions.minWidth watchdog.config officeConversionService.excelPageWidthMin Add 'in' to the end of the value in watchdog.config.
    fileTypes.excel.pagination.dimensions.maxWidth watchdog.config officeConversionService.excelPageWidthMax Add 'in' to the end of the value in watchdog.config.
    fileTypes.excel.pagination.dimensions.minHeight watchdog.config officeConversionService.excelPageHeightMin Add 'in' to the end of the value in watchdog.config.
    fileTypes.excel.pagination.dimensions.maxHeight watchdog.config officeConversionService.excelPageHeightMax Add 'in' to the end of the value in watchdog.config.
    fileTypes.office.disableExternalHyperlinks watchdog.config officeConversionService.disableExternalHyperlinks -
    fidelity.msOfficeDocumentsRenderer watchdog.config officeConversionService.msOfficeDocumentsRenderer -
    resourceUsage.pccis.instances watchdog.config pccis_instances, see instructions Set the central config value equal to the number of objects in the pccis_instances array.
    resourceUsage.ocs.numInstances watchdog.config officeConversionService.officeInstanceCount -
    resourceUsage.ocs.numThreads watchdog.config officeConversionService.threadCount -
    resourceUsage.ocs.numPorts watchdog.config officeConversionService.officePortCount -