Run as a service (Windows)

Start server, dispatcher or satellite as a service

The callas pdfToolbox Services application is only available for Windows at the moment. 

For Mac or Linux a Deamon can be used:

Installation

1. Ensure there is an installation of callas pdfToolbox Server/CLI on the system and the application has been activated successfully.

2. A special executable, which is needed to run pdfToolbox as a service, is located in /cli/var/Service.

Copy the executable into the subfolder "/cli" of the application folder of the server installation.

3. To install, the following command has to be executed on the command line:

pdfToolboxService.exe --install
Click to copy

Please confirm the security question of Windows if shown.

4. Open the "Services dialog" of Windows. This dialog can easily opened by typing the following string into the search field of the Windows start menu or use the following command on the command line:

Services.msc

5. There should show up 3 new services:

  • callas pdfToolbox Server
  • callas pdfToolbox Satellite
  • callas pdfToolbox Dispatcher

6. Select "pdfToolbox Server" and use the right-click menu item "Action" [or "Properties" depending on the Windows-version] in order to use this service and set in "General" the "Startup Type" to "Automatic" or "Manual".

When "Automatic" is choosen, every started job will continue processing, even when no user is logged on the system. It will even start processing, when the operating system is started.

When using "Automatic", also user details have to be entered into the "Log On" tab.

It must be ensured, that all folders used in the jobsettings can be accessed by the defined user (especially when network paths shall be used by the job).

Configuration of a job

Now a job can be configured using the ServerUI, which can be accessed using the Standalone version (Menu: Tools - Server).

When a job is started, pdfToolbox Standalone can be closed. The services apllication ensures, that the processing will continue even when the user is logging off.

If a job is using network paths for the used folders, it is recommended to use UNC paths (e.g. "\\192.168.1.22\hotfolder\...") as an assigned drive letter (e.g. "H:\hotfolder\...")  is user-specific.

Access by remote

It is possible to connect to a Server running as a service by remote via the local network.

Start pdfToolbox standalone, select menu: "Tools" - "Server" and choose

"Connect with remote server".

Enter the IP of the remote server where the service is running.

After connecting all jobs on the remote server are shown and can be started, stopped or even modified. (Hotfolder paths of any server jobs (IN, OUT, etc.) have to be configured so that they are valid from the service's perspective (the system where the service is running) - and not from the perspective of the controlling standalone application).

Uninstall or change to a new major version

If the Service is no longer needed and the entry shall be removed or when the Service entry has to be updated because of a new major version (e.g. when upgrading from version 9 to version 10), it is recommended to uninstall the service using the following command:

pdfToolboxService.exe --uninstall
Click to copy

The pdfToolboxService.exe has to be in the same directory like the pdfToolbox.exe (like when installing the Service).

Troubleshooting

If network paths are used for processing jobs, the user should have sufficient rights to access them.

There may be special requirements for converting Office files to PDF when using pdfToolbox as a service. Check http://www.callassoftware.com/goto/tbx_ENU_topdf for the latest details.

Note: In general it is recommended to grant the respective service user administrator privileges. If this level of rights can not set due to internal regulations, some additional settings within the operating system are recommended. Additional settings with limited user rights

Additional settings for Office conversion with restricted user permissions

If Office conversion is needed out of services using Windows it is recommend­ed to grant the respective service user administrator privileges. If this level of rights can not set due to internal regulations, some additional settings within the operating system are recommended.

The following folders should allow the user the respective access right:

For 64-bit machines
C:\Windows\Temp
Modify
C:\Windows\syswow64\config
Read
C:\Windows\syswow64\config\systemprofile
Read
C:\Windows\syswow64\config\systemprofile\AppData
Modify
C:\Windows\syswow64\config\systemprofile\Desktop
Modify (Create it, if it does not exist)
C:\Windows\syswow64\config\systemprofile\AppData\Local\Microsoft\Win­dows\INetCache
Modify (Create it, if it does not exist)
For 32-bit machines
C:\Windows\Temp
Modify
C:\Windows\system32\config
Read
C:\Windows\system32\config\systemprofile
Read
C:\Windows\system32\config\systemprofile\AppData
Modify
C:\Windows\system32\config\systemprofile\Desktop
Modify (Create it, if it not exist)
C:\Windows\system32\config\systemprofile\AppData\Local\Microsoft\Win­dows\INetCache
Modify (Create it, if it not exist)

Additional settings:

  • Set the 32-bit folder preferences (for details see above) in addition to the 64-bit preferences on 64-bit systems running 64-bit versions of Micro­soft Office
  • Set the default printer to XPS Document Writer

DCOM settings:  

  • Launch DCOMCNFG by using:
C:\WINDOWS\SysWOW64> mmc comexp.msc /32 
  • Go to Computers  MyComputer DCOM Config.
  • Right-click the application that you want to automate. The application names are listed in the table below:
Application
DCOM Name
Microsoft Access 2007/2010/2013/2016
Microsoft Access Application
Microsoft Excel 2007/2010/2013/2016
Microsoft Excel Application
Microsoft Office Word 2007
Microsoft Office Word 97 - 2003 Document
Microsoft Word 2010/2013/2016
Microsoft Word 97 - 2003 Document
  • On some systems Microsoft Word is not displayed and you will have to use      {00020906-0000-0000-C000-000000000046} instead.
  • Click Properties to open the property dialog box for this application.
  • Verify Identity and Security tabs

Note

For Microsoft Excel, Microsoft Word and Microsoft PowerPoint the DCOM Identity "The launching user" must be selected.

For Microsoft Visio the DCOM Identity "The interactive user" needs to be selected.