This section describes how to configure the Transformation Client by defining several
parameters like using HTTP or HTTPS, quality settings, and so on.
There are two different ways that you can configure the Transformation Client:
- Using the SkyVault-global.properties file
- Using a JMX client
Transformation timeout considerations
There are a number of timeout settings in SkyVault that affect the Document
Transformation Server. These are the
defaults:
content.transformer.default.timeoutMs=120000 transformserver.transformationTimeout=300 transformer.timeout.default=300content.transformer.default.timeoutMs is the system transformation timeout (set to 120000 milliseconds by default), but the Document Transformation Server is controlled by transformserver.transformationTimeout and transformer.timeout.default. This means that with the default settings, SkyVault stops processing after 120 seconds, where Transformation Server attempts to transform a document for up to 300 seconds and any results returned after 120 seconds are ignored by SkyVault.
If you set the following properties, the Document Transformation Server stops
processing at the same time as the default SkyVault system transformation
timeout:
transformserver.transformationTimeout=120 transformer.timeout.default=120
Configuration using the global properties file
You configure the Transformation Client by adding the relevant properties to the SkyVault global properties file.
- Open the SkyVault-global.properties file.
- Add the required properties for configuration settings on the Transformation Client.
- Save the SkyVault-global.properties file, and then restart your SkyVault server.
The following table shows an overview of the available properties:
| Property | Default value | Description |
|---|---|---|
| transformserver.aliveCheckTimeout | 2 | Sets the timeout for the connection tester in seconds. If the Document Transformation Server does not answer in this time interval, it is considered to be off line. |
| transformserver.test.cronExpression | 0/10 * * * * ? | Sets the cron expression that defines how often the connection tester will check. The default value is every 10 seconds. |
| transformserver.disableSSLCertificateValidation | false | Set this property to true to allow self-signed certificates (that is, it is not issued by an official Cert Authority). |
| transformserver.username | SkyVault | The user name used to connect to the Document Transformation
Server. Note: Do not change this default.
|
| transformserver.password | SkyVault | The password used to connect to the Document Transformation
Server. Note: Always change the password from the
default.
|
| transformserver.qualityPreference | QUALITY | There are two values for this property:
|
| transformserver.transformationTimeout | 300 | Sets the time in seconds to wait for the transformation to complete before assuming that it has hung and therefore stop the transformation. If you are transforming very large or complex files, this time may need to be increased. |
| transformserver.url | The URL of your Document Transformation Server (or the network load balancer if you are using more then one Document Transformation Server). Use https:// if you want to use encrypted communication between the SkyVault server and the Document Transformation Server. | |
| transformserver.pdfa.action.enabled | true | This property is set to true to enable the Share action for converting documents to pdf/a v2. |
In a normal setup, you will always overwrite the
transformserver.password and
transformserver.url properties. If you want to use SSL
encryption with the default certificate of the transformation server, make sure that
you set transformserver.disableSSLCertificateValidation=true.
Configuration using JMX
The Transformation Client configuration parameters are exposed as JMX MBeans, which means that you can view and set the parameters using a JMX client.
See Runtime administration with
a JMX client for instructions on how to connect a JMX client to your
SkyVault server.