The REST interface is a powerful tool that facilitates seamless integration and efficient data transfer for file conversion. Proper configuration is essential to ensure optimal functionality. This technical troubleshooting guide provides step-by-step instructions to address configuration-related issues when setting up the REST interface for file conversion.
Enabling the REST Interface
To enable the REST interface for file conversion, please follow the instructions below:
Step 1: Locate the Configuration File
- Navigate to the installation folder.
- Find and open the file named `C:\Program Files\Foxit\Rendition Server\ManagingNodeConfig.user.xml` using a suitable text editor.
Step 2: Configure the REST Interface
- Inside the `ManagingNodeConfig.user.xml` file, locate the following section:
<network>
<authorization>
...
</authorization>
<certificate ... />
<bindings>
<conversion enableMtom="False" />
<administration />
<monitoring />
<rest port="14714" logLevel="Information">
<aspsettings>
</aspsettings>
<fileStorage basePath="\\files\transfer\RESTStorage" azureStorageAccount="" />
</rest>
</bindings>
</network>
- Remove the comment tags (`<!--` and `-->`) surrounding the REST section to uncomment it.
Step 3: Configure the File Storage Path
- Set a valid UNC path to a network file share in the `basePath` attribute of the `<fileStorage>` element. This path will be used for temporary storage of input and output files.
- Ensure that the same path is configured on each Managing Node if multiple nodes are utilized, enabling seamless file access.
Step 4: Verify User Account Permissions
- Ensure that the Windows user account running the Managing Node service has full access permissions to both the file system folder and the network share (if applicable). This guarantees smooth file operations within the REST interface.
Configuring the REST Interface for Configuration Web Application
To utilize the REST interface in the Configuration Web Application, make the following changes in the `RenditionServiceProperties.user.config` file:
Step 1: Locate the Configuration File
- Find the `C:\inetpub\rs-apps\config\RenditionServiceProperties.user.config` file associated with the Configuration Web Application.
Step 2: Update the Configuration Values
- Open the `RenditionServiceProperties.user.config` file using a suitable text editor.
- Within the `<serviceProperties>` element, update the `adminServiceBaseAddress` attribute to the appropriate URL of your Managing Node's REST interface, such as `"http://mnode.domain.com:14714/rs/api/rest/"`.
- Confirm that the `adminServiceViaRest` attribute is set to `true`.
Configuring the REST Interface for Conversion Web Application
To configure the REST interface for the Conversion Web Application, modify the `WebConversionClient.user.config` file:
Step 1: Locate the Configuration File
- Find the `C:\inetpub\rs-apps\convert\WebConversionClient.user.config` file associated with the Conversion Web Application.
Step 2: Update the Configuration Values
- Open the `WebConversionClient.user.config` file using a suitable text editor.
- Within the `<webConversionClientSettings>` section, locate the `<renditionServer>` element.
- Set the `protocolType` attribute to `"Rest"`.
- Set the `portNumber` attribute to the corresponding port value from the `<rest>` element in the `ManagingNodeConfig.user.xml` file (e.g., 14714).
- Update the `hostName` and `protocol` attributes to match the appropriate values based on your environment.
By meticulously following the outlined steps, you should be able to successfully configure the REST interface for file conversion. If you encounter any difficulties or persisting issues, we recommend consulting the relevant documentation or contacting technical support for further assistance.
