Install WorkZone PDF Engine


Install manually with standard settings

If you install WorkZone PDF Engine for working with other WorkZone products, you must select the Real-time conversions installation profile which is the default profile.

The following WorkZone features are automatically enabled by the Real-time conversions profile:

  • Preview of documents in WorkZone Client.
  • Print reports for WorkZone Client and WorkZone Process.

The Real-time conversions installation profile also:

  • Installs WorkZone PDF Engine under the WorkZone web site.
  • Identifies WorkZone PDF Engine by the URI <WorkZone URL>/Render, for example https://db01/render.
  • Creates an application pool with the default name WZRender. You can rename the Application Pool Name if necessary.
  • Uses Windows authentication.

Note: Custom parameters cannot be specified during installation when using the Real-time conversions profile. If you need to define custom parameters for the WorkZone PDF Engine, you must either select the Custom installation profile or wait until the installation has completed and then define any custom parameters after the installation.

See WorkZone PDF Engine custom parameters.

To install the WorkZone PDF Engine with standard settings:

  1. Double-click the KMD WorkZone PDF.exe file. On the Welcome to the KMDWorkZone Installation Wizard page, click Next.
  2. On the WorkZone Products page, click WorkZone PDF Engine to start the installation of WorkZone PDF Engine.
  3. On the WorkZone PDF Engine page, click Install.
  4. On the Installation Profiles page, select Real-time conversions to install the WorkZone PDF Engine with standard settings and then click Select.
  5. On the License Agreement page, you must read and accept the license agreement terms before you can continue the installation. Select the I accept the terms of this license agreement check box and then click Next.
  6. On the Prerequisites page, click Verify to ensure all prerequisites are present on the local machine and then click Next.
  7. On the WorkZone PDF Engine Settings page, define the Application Name. You cannot define any other settings due to the selected Real-time conversion installation profile. Click Next to continue.
  8. On the WorkZone PDF Engine OData Settings page, specify the location of the OData Service as well as user credentials for accessing the OData service. Click Next to continue.
  9. On the Ready to installWorkZone PDF Engine page, click Install to start the installation.

If you want to specify your own default parameter values for the WorkZone PDF Engine application during the installation, you can specify these in the Database Configuration installation option or select to install WorkZone PDF Engine with customized settings. See Perform database configuration.


Install manually with customized settings

If you want to customize the WorkZone PDF Engine installation to match the specific needs of your organization, you must select the Custom installation profile.

If you want to change the custom parameter setup after installation, you can edit the parameters in the WorkZone PDF Engine Web.config file. The WorkZone PDF Engine Web.config file is located: C:\Program Files (x86)\KMD\WorkZone\IIS\WorkZone\Render.

See WorkZone PDF Engine custom parameters.

To install the WorkZone PDF Engine with customized settings:

  1. Double-click the KMD WorkZone PDF.exe file. On the Welcome to the KMDWorkZone Installation Wizard page, click Next.
  2. On the WorkZone Products page, click WorkZone PDF Engine to start the installation of WorkZone PDF Engine.
  3. On the WorkZone PDF Engine page, click Install.
  4. On the Installation Profiles page, select Custom to install the WorkZone PDF Engine with customized settings and then click Select.
  5. On the License Agreement page, you must accept the license agreement terms before you can continue the installation. Select the I accept the terms of this license agreement check box and then click Next.
  6. On the Prerequisites page, click Verify to ensure all prerequisites are present on the local machine and then click Next
  7. On the WorkZone PDF Engine Settings page, define the settings for the PDF Engine. The settings already contain the default values, but you can overwrite the settings if necessary.
    The FQDN field is automatically filled in with the current domain but you can change it, for example if you want to set up a test system to run in a different domain. In the Host Headers field, you can enter the host headers that you have created.
    Click Next to continue.
  8. On the WorkZone PDF Engine Parameters page, specify the values of the parameters you want to customize.
    If you want to change the WorkZone PDF Engine parameters after installation, you can edit the parameters in the WorkZone PDF Engine Web.config file.
  9. On the Ready to install WorkZone PDF Engine page, click Install to start the installation.


Install silently

To install WorkZone PDF Engine under a new site, follow this procedure:

  1. Open the Command prompt window as administrator.
  2. Type the path to the KMD WorkZone PDF.exe file.
  3. Specify the product name -engine.
  4. Specify parameters.
Parameter Required? Default value Meaning

-i

Yes

 

Installation mode.

-profile

No

"Typical"

Installation profiles:

  • Typical - A predefined configuration.
  • Custom - Specify the application name under an existing web site, application pool name, authentication method, and WorkZone PDF Engine parameters.

-app

No

"Render"

Web application name.

-pool

No

"WzRender"

Application pool name for web application.

-auth

No

"Anonymous"

Authentication method for web application (Windows, Anonymous).

Note: Can only be used with the Custom profile.

-params

No

"Compress PDF output=True, Default footer style={}, Default header style={}, Hide review information=True, Optimize PDF output for the web=True, PDF output format=Default, Suppress content that exceeds page bounds=False, Watermark style={}"

List of custom parameters for PDF Engine.

-Allowed CorsOrigin

No

*

Define which web client applications executed in a browser hosted on other domains will be able to perform CORS requests to the server.

An origin for the AllowedCorsOrigin parameter1 must be defined as:

<scheme>://[<hostname>.]<host>[:<port>], for example Https://WZClient if WorkZone Client is hosted on Https://WZClient and the rest of WorkZone services are hosted on another domain, such as Https://WZServices.

Origins are separated with semi-colons ";".

When using Cross-Origin Resource Sharing (CORS) with WorkZone , this parameter should be set to the specific origins as most browsers will prevent passing credentials or tokens to the service when the wild card (*) is used as the origin.

Using the wild card (*) origin means the PDF service is open for every origin. It is used when the wild card origin (*) is the only origin that is set in the configuration file or in the corresponding system environment variable, or the origin of the request is not found and the AllowedCorsOrigins parameter contains the wild card origin (*).

Example: The following parameter in the Web Config file: <add key="allowCorsOrigin" value="*" /> will fail unless the wild card origin "*" is replaced with the specific origins of the web client to be accessed.

-AllowedCorsHeader

No

Origin;X-Requested-With;Content-Type;Accept;Accept-Language;OData;Authorization

Used in a response to OPTIONS preflight request. Indicates which headers can be used during the actual HTTP CORS request.

The AllowedCorsHeaders1 parameters corresponds to Access-Control-Allow-Header response header (ACAH) and acts as an answer to request’s Access-Control-Request-Headers request header.

The AllowedCorsHeaders parameter can be configured with:

- “*” The Access-Control-Allow-Header will contain headers requested by the request as well as specific PDF headers.

- specified headers (ACAH header will contain these headers as well as specific PDF headers).

- both * and specified headers (ACAH will contain headers from the configuration and headers requested by the request as well as specific PDF headers).

1 These parameters are also mapped to the following system environment variables on the server:

  • WORKZONE_PDF_CORS_ALLOWEDORIGINS
  • WORKZONE_PDF_CORS_ALLOWEDHEADERS

System environment variables take precedence over the parameters defined in the web.config files.

There is one additional common parameter, which you can use to extend the behavior of the installation:

-l

Log, which enables text log output that can be used to review and find issues during the installation, update, or uninstallation process.

Example: Typical installation

"KMD WorkZone PDF.exe" -Engine -i -profile:Typical -l:"c:\mylog.txt"

The copy image is missing

Example: Custom installation

"KMD WorkZone PDF.exe" -Engine -i -profile:Custom -app:"Default web site/Pdf" -pool:WzRender -auth:Windows -params:"Hide review information=True, PDF output format=Default, Optimize pdf output for the web=True, Suppress content that exceeds page bounds=False" -l:"c:\mylog.txt"

The copy image is missing


Verify the installation

  1. In Internet Information Services (IIS) Manager, select Render.

  2. Double-click Authentication.
  3. Verify that settings specified during installation are correct.
  4. Navigate to Application Pools and double click on the WZRender application pool that was created during installation. The Edit Application Pool dialog box displays.
  5. Under .NET CLR Framework version, verify that .NET CLR Framework v.4.0.30319 for the application pool which is used for the WorkZone PDF Engine.

  6. Click OK.
  7. If you selected the Custom installation profile to use WorkZone PDF Engine with host headers, you can verify the binding between the web site and the appropriate host header. Select the web site under which the PDF service is installed, and then click Bindings in the Actions menu.

In the Site Bindings dialog box, verify that the bindings to the appropriate host headers are created.