DOCX Converter — Setup and User Guide

Setup

To set up the DOCX Converter, you must perform the following steps –

  1. Firstly, you need to install the DOCX Converter tool. 

  2. Create a collection structure on the server repository to set up the path for dynamic configuration. 

  3. Upload configuration files to the collections as per dynamic configuration. 

  4. Launch the DOCX Converter tool and sync it with you QPP server repository. 

Install DOCX Converter

The DOCX Converter installation process is as follows –

  1. Download the installer package provided by the Quark team and extract it.

  2. Double-click on the installer file and then follow the on-screen instructions to complete the installation. 

  3. Once the installation is complete, the app launcher icon for DOCX Converter becomes available (in the Start menu on Windows and in Finder > Applications on Mac). 

Set up the path for dynamic configuration

There are two ways to set up the path for dynamic configuration: automatic and manual.

  1. Automatic creation: To facilitate automatic creation of setup files required for DOCX Converter, ensure that the option for generating StyleMapping file is enabled during the environment deployment process. Once activated, the system will automatically generate StyleMapping file on the server each time a new content model is established. If not done, you can contact Quark Support for the configuration process. 

    It is essential to link the content model to a content type during the content model creation to initiate the StyleMapping file generation process.
  2. Manual creation: For manual creation, follow the steps given below -

    • After installing the DOCX Converter tool successfully on your system, you must set up the path to store a few necessary dynamic configuration files. 

    • In Quark Publishing Platform, the default path is set as $Root> contentmodels > conf > MigrationTool. Therefore, on your QPP server, the collection structure for dynamic configuration should look like this –

      The path for dynamic configuration files may differ based on the settings of your QPP server repository. 
    • In the collection MigrationTool, create a sub-collection with the name of the content model for which you want to support in DOCX Converter. In this sub-collection, configuration files related to the content model are to be stored. 

       

Upload configuration files as per dynamic configuration

On installing the DOCX Converter tool, several configuration files become available in the Program Files folder of your local machine. You're required to upload the following configuration files to the dynamic configuration collection on your QPP server repository. These files are as follows –

  • AppConfig.xml: It contains several application-level and document-level configurations in default settings mode, which you can upload to set the server as is, if the default settings are good for you.

  • StyleMapping.xml: It contains content model-specific configurations, which you must modify based on the structure of your content model before uploading to the server. 

The configurations that these files contain are described ahead in the Configurations section. 

The steps required to upload these files are as follows –

Upload AppConfig.xml

  1. On your local machine, go to the location $Root> Program Files > Quark > DOCX Converter > configs. 

  2. Upload the AppConfig.xml to the dynamic configuration collection MigrationTool on your QPP serv server repository. 

Upload StyleMapping.xml

By default, DOCX Converter supports two in-built content models available on a QPP server, which are Smart Document and BUSDOC. The StyleMapping.xml file for each of these content models is available in their respective folders in the Program Files. 

The steps to upload StyleMapping.xml to QPP server are as follows –

  1. On your local machine, go to the location $Root> Program Files > Quark > DOCX Converter > configs > Content Model Name (for example, Smart Document). 

  2. Create a copy of the file StyleMapping.xml elsewhere on the local machine. 

  3. Modify the copy of StyleMapping.xml based on the structure of your content model for which you want to add support in DOCX Converter. 

  4. Upload the modified StyleMapping.xml to the dynamic configuration collection for the content model (Content Model 1) on your QPP server repository. 

Launch DOCX Converter and sync it with QPP Server repository

Before you can start the conversion process, you must sync your QPP Server with the DOCX Converter tool. To do that, follow the steps shown below –

  1. Firstly, launch the DOCX Converter tool on your system. Upon launching the tool, you'll be asked to connect to a server repository to convert the DOCX files. Click on Preferences. 

  2. On the Connection Settings dialog, enter the server URL and then click Log On. 

    Use the + icon to save the server to your list. This allows you to select it in the future without re-entering the URL. 
  3. This will open the Log On window. Enter a valid set of administrator credentials of your QPP server and then click Log in. 

    The Log On window disappears once you're logged in. And if your credentials are not valid or have expired, the Log On window displays an error message accordingly.
  4. After logging into the platform, the dynamic configuration loading screen will appear. This process only takes a few seconds to complete. 

  5. To switch servers, you must first log off from your current session. Navigate to Preferences and click Log Off. Once disconnected, you can select another saved server from your list and log in.