Updated: 27/06/2024
Install WorkZone PDF Crawler
Prerequisite: After the installation, you must enable WorkZone PDF Crawler in WorkZone Configurator. To do this, go to Global > Feature settings > WorkZone PDF, select WorkZone PDF Crawler, and click Save.
Install manually
- Double-click the KMD WorkZone PDF.exe file. On the Welcome to the KMDWorkZone Installation Wizard page, click Next.
- On the WorkZone Products page, click WorkZone PDF Crawler to start the installation of WorkZone PDF Crawler.
- On the WorkZone PDF Crawler page, click Install.
- 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.
- On the WorkZone PDF Crawler OData Settings page, specify the location of the OData service, Crawler OAuth2 Client Id, and Crawler OAuth2 Client Secret, as the WorkZone PDF Crawler application uses the OData module to connect to WorkZone. Click Next to continue.
The Crawler OAuth2 Client Id and Crawler OAuth2 Client Secret parameters can be defined as any strings allowed in the WorkZone Content Server OAuth2. - On the WorkZone PDF Crawler Credentials page, specify the User Principal Name (UPN) and Password to be used to run the WorkZone PDF Crawler service. By default, the UPN is defined as system but you can change it to the user with the "Log on as a service" rights. Click Next to continue.
- On the Ready to installWorkZone PDF Crawler page, click Install to start the installation.
Install silently
- Open the Command prompt window as administrator.
- Type the path to the KMD WorkZone PDF.exe file.
- Specify the installation mode
-i. - Specify the product name
-crawler. - Specify parameters:
| Parameter | Required | Default value | Meaning |
|---|---|---|---|
| -odata |
no |
The first defined OData URL on the target server |
URL to OData application. |
|
-CrawlerClientId |
no |
WZPDF.CRAWLER |
These parameters can be defined as any strings allowed in the WorkZone Content Server OAuth2. |
|
-CrawlerClientSecret |
yes |
|
|
|
-user |
no |
system |
Name of the WorkZone PDF Crawler user with Log on as a service rights. The user is used to run the WorkZone PDF Crawler service. See Create WorkZone PDF user with the "Log on as a service" rights. |
|
-password |
yes, if the user is not system |
|
The password of the Crawler user specified for |
|
-l |
no |
The TEMP folder of the current user under which the installation is running |
Log, which enables text log output that can be used to review and find issues during the installation, update, or uninstallation process. |
Example:
"KMD WorkZone PDF.exe" -crawler -i -odata:"https://db01/OData" -CrawlerClientId:WZPDF.CRAWLER -CrawlerClientSecret:[secret] -user:[user] -password:[password] -l:"C:\Logs\Crawler.log"
To install more than one instance of PDF Crawler you need to run the installation command for every instance.
