Working with hot folders in pdfToolbox Server
Previous articles of this manual talked about profiles (Profiles: the corner stone of pdfToolbox) and process plans (When profiles are not enough: Process Plans), but only on how to run those manually on PDF documents you open in pdfToolbox Desktop. Of course there are times where it is more efficient to process PDF documents automatically – and this article describes how to do that using hot folders in pdfToolbox Server.
pdfToolbox Server is one of the automatic flavors of the pdfToolbox product family. It is capable of handling any number of jobs; each job is a hot folder setup with an input folder and one or more output folders. PDF documents dropped into an input folder are picked up and processed automatically.
Launching the pdfToolbox Server user interface
pdfToolbox Server doesn't have its own user interface; instead it can be controlled through pdfToolbox Desktop. To launch it:
- Launch pdfToolbox Desktop.
- Click the "Tools" > "Server" menu item.
The pdfToolbox Server control panel appears:
- Use "Start a Server" to launch pdfToolbox Server on the same machine as pdfToolbox Desktop.
- Use "Connect with Remote Server" to connect to a pdfToolbox Server instance that is already running either on the same machine or on a different machine on the network. This allows remote monitoring and configuration over the network. You will need to know the IP address of the machine running pdfToolbox Server.
- "Start a Dispatcher" and "Start a Satellite" are part of the distributed processing system available in pdfToolbox. This is not further described in this overview manual.
Starting a pdfToolbox Server instance
Assuming pdfToolbox Server is installed on the same machine as pdfToolbox Desktop, we can start it locally. To do so, click the "Start a Server" button in the pdfToolbox Server control panel.
After a few seconds, the pdfToolbox Server control panel changes to show the currently running server. Most importantly:
- Because this is a local server (on the same machine as our pdfToolbox Desktop), the control panel shows "Local server". If we had connected to a remote server, the IP address of the remote machine would be shown instead.
- The server action button gives access to configuration possibilities for the pdfToolbox Server instance (including the ability to start a new job or to stop the server).
- Underneath the server row, the different configured jobs are shown. Each job is a hot folder setup that can process files using a specific profile or process plan.
- Next to the name of the job, the control panel shows the "Start" / "Stop" button. Clicking the triangle will start processing for this job, clicking the square will stop the job.
- Next to that is the job action button which gives access to the job configuration.
Creating a new job
To create a new job:
- Click on the action button next to the server you want to create this job in.
- Click the "Create new job" menu item.
This will open the job editing window. Start with filling in basic job information:
- Each job has a name, which is shown in the server control panel. Choose a unique, descriptive name.
- Optionally provide a description for the job.
- Select a profile or process plan for this job to use. The pull-down menu shows all profiles and process plans in the currently active library in pdfToolbox Desktop. You can search in the list by entering your search terms in the search field at the top of the list.
This just leaves setting up the different hot folders. To do this you can select each of the folders in the list on the left, or you can use the "Turbo..." button. When using the turbo button, you have to select a folder and pdfToolbox will automatically create sub folders in that folder for you for all of the folders it needs.
- After using the "Turbo..." button, all paths have been set to sub folders of the main folder selected (in this example "/Server hotfolders/Test").
- Click on each item in the list on the left to further setup the job:
- "Overview" is the overview shown in the screengrab above.
- "In folder" lets you define the input folder. This is the actual watched folder where files are going to be picked up from.
- "On success" is the folder processed files are dropped in if there are no info messages, warnings or errors during processing.
- "On info" is the folder processed files are dropped in if there is at least one info message, but no warnings or errors during processing.
- "On warning" is the folder processed files are dropped in if there is at least one warning, but no errors during processing.
- "On error" is the folder processed files are dropped in if there is at least one error during processing.
- "Processed files" is the folder where the original files (the ones dropped in the in folder) are moved to if "Keep original" is checked.
After configuring the hot folder, click "OK" and don't forget to turn it on in the server configuration panel if you want to test it.
Locate your jobs folder of pdfToolbox Server
By now you know that every job that you create in pdfToolbox Server is stored in the "Jobs" folder. It's very important to know where that Jobs folder is located to create a backup of that folder. Because when you lose your data after a crash, you will be able to put the Jobs folder backup in the right place to load your jobs back in pdfToolbox Server. This is how you can do that:
- Go to:
/Library/Application Support/callas software/callas pdfToolbox CLI (version)/Server/Jobs
C:\ProgramData\Application Support\callas software\callas pdfToolbox CLI (version)\Server\Jobs
- Create a backup of the "Jobs" folder.
The "Jobs" folder can be stored on a backup server or you can put it on another machine where pdfToolbox Server is running, same path as described above.