PrizmDoc® v14.2 Release - Updated
PrizmDoc / Administrator Guide / PrizmDoc Server / Configuring / Configure Microsoft Office Conversion Connectivity
In This Topic
    Configure Microsoft Office Conversion Connectivity
    In This Topic

    Introduction

    PrizmDoc provides Microsoft Office Conversion connectivity for PrizmDoc Server Docker container deployments. While the Microsoft Office Conversion add-on requires PrizmDoc Server running on Windows, it is possible to configure the PrizmDoc Server Docker container to utilize the Microsoft Office Conversion service to have native rendering of Microsoft documents in PrizmDoc.

    Please see Windows Requirements and Windows Installation sections for information regarding installation of PrizmDoc with the Microsoft Office Conversion service.

    The following steps describe how to enable Microsoft Office connectivity for a PrizmDoc Server Docker container.

    Single Server Mode

    Docker Server Configuration

    1. An MSO enabled license is required for the Microsoft Office Conversion connectivity for PrizmDoc Server Docker deployments.

    2. Configure the following two parameters in the prizm-services-config.yml file of the PrizmDoc Server Docker container:

      fidelity.msOfficeCluster.host

      Set this value to the hostname or the IP of a single PrizmDoc Server running on Windows. By setting this value, you can use the Microsoft Office Conversion service running on Windows to have native rendering of Microsoft documents in PrizmDoc.

      fidelity.msOfficeCluster.port

      Set this value to the public port of a single PrizmDoc Server running on Windows specified by the network.publicPort parameter of the remote server. By setting this value, you can use the Microsoft Office Conversion service running on Windows to have native rendering of Microsoft documents in PrizmDoc.

    3. Restart PrizmDoc.

    Cluster Mode

    Docker Server Configuration

    1. An MSO enabled license is required for the Microsoft Office Conversion connectivity for PrizmDoc Server Docker deployments.

    2. Configure the following two parameters in the prizm-services-config.yml file of the PrizmDoc Server Docker container:

      fidelity.msOfficeCluster.host

      Set this value to the hostname or the IP of a load balancer of a cluster running on Windows to utilize the Microsoft Office Conversion service running on Windows to have native rendering of Microsoft documents in PrizmDoc.

      fidelity.msOfficeCluster.port

      Set this value to the public port of a load balancer of a cluster running on Windows specified by network.publicPort parameter of the cluster to utilize the Microsoft Office Conversion service running on Windows to have native rendering of Microsoft documents in PrizmDoc.

    3. Restart PrizmDoc.

    NOTE: When making REST API calls to a PrizmDoc Server configured for Microsoft Office Conversion Connectivity, use the Docker network.publicPort entry point. We do not recommend using the MSO cluster network.publicPort entry point because it may lead to unexpected behavior in Cluster Mode.

    HTTPS Protocol Support

    If you need your PrizmDoc Server Docker container instance (cluster) to communicate to the Windows MSO instance (cluster) over an untrusted network, or if you need additional security within your local network, you may want to set them up to support the HTTPS protocol. See Security Guidance for details.

    File Formats

    After performing the configuration steps above, a PrizmDoc Server Docker deployment will convert all Microsoft Office documents through the Microsoft Office Conversion renderer from the PrizmDoc Server running on Windows.

    Please refer to the Supported File Formats section for the information on the exact file formats supported by the Microsoft Office Conversion renderer.