43
3-Heights™ Document Converter, Version 4.6
Page 22 of 90
January 25, 2016
© PDF Tools AG - Premium PDF Technology
The first entry (-w) is always mandatory and defines the working folder for the watched
folder thread. Unless -wd is also specified, this is the folder where documents need to be
dropped and will be picked up by the service.
The option -R can be specified with -wd to include also subfolders of the pickup
directory. The output of files dropped into a subfolder will be stored in a subfolder with
the same name below the output folder (see option -o below).
Unless the -o option specifies some other output folder, the converted documents will be
located in the “PDFs” subfolder of the working folder (the “TIFFs” subfolder when
converting to TIFF). The value specified to the -o option is either an absolute path, or it
may be the name of a subfolder of the pickup directory prefixed by a colon.
Similarly, folders for storing the input file can be specified. Option -os sets the
“Succeeded” folder, -of the “Failed” folder (which are by default located in the working
folder). Note that in order to move input files rather than delete them, AutoDelete and
AutoDeleteAll settings must be set to false.
Examples:
-wd c:\Pickup -o C:\Out -R
File 1.doc dropped into C:\Pickup\doc will be converted into C:\Out\doc\
File 2.doc dropped into C:\Pickup will be converted into C:\Out\
-wd C:\Pickup -o :out -R
File 1.doc dropped into C:\Pickup\doc will be converted into C:\Pickup\doc\out\
File 2.doc dropped into C:\Pickup will be converted into C:\Pickup\out\
File 3.doc dropped into C:\Pickup\out\ will be ignored
Furthermore, option “-l” can be used to create an error log file in the output directory
whenever errors occur during job processing.
The option -o2 has the effect that documents picked up in a drop folder will always be
copied to the output folder. When a job fails, another copy of the input document will
still be stored in the ‘Failed’ folder.
The option -o0 will make sure that no output document will be produced when any error
occurs during conversion processing. Actually, the output document will shortly appear
in the output folder, but be deleted as soon as the job completes.
The option -op has the effect that the job prefix in the file name of the output document
will be removed. Job prefixes are useful to avoid name conflicts and to ensure proper
sequencing of multiple conversion jobs.
The option -ow applies to conversion jobs producing PDF/A compliant output (i.e. the
job option PDFA is also set). Whenever the PDF/A-conversion encounters a situation
where the appearance of pages might change due to conversion processing, a warning
is returned. When the option -ow is set, such warnings are ignored (as long as the final
output has been successfully validated as PDF/A compliant). Note: use this option with
caution.
50
3-Heights™ Document Converter, Version 4.6
Page 23 of 90
January 25, 2016
© PDF Tools AG - Premium PDF Technology
2.4
Quick Service Installation on a Client PC
The 3-Heights™ Document Converter can be installed and executed with some
restrictions on a client PC, e. g. for evaluation purposes. Due to the limitations of
Windows client platforms, you will need to start the “Ad hoc Converter Service” rather
than making use of the standard service.
Perform the following steps:
Make sure you have Microsoft Office installed, if you want to test the conversion of
Office documents
Install the 3-Heights™ Document Converter (complete or default features selected)
Disable automatic startup of the O2PSRV service (shown as “3-Heights™ Document
Conversion Dispatcher” in the Windows services control panel)
Adjust any conversion settings; please refer to the previous section for details.
Start the Ad hoc Converter Service via the installed start menu item
You will have a single conversion worker application running in your interactive session
that will perform any document conversion requests. Unlike in a standard server based
installation, you may see windows popping up. Do not click away any of these windows,
as this might interfere with the conversion processing.
Note: for background information, refer to section 5.5. You also may refer to the white
paper
on
the
PDF
Tools
website,
https://www.pdf-
tools.com/public/downloads/whitepapers/Whitepaper-DocumentConverter-EN.pdf
2.5
Updating an Existing Installation
If you have a previous installation, you need to perform an uninstallation, and then
install the new version.
Note that the uninstallation does not remove the configuration data contained in
*.config and *.ini files. These files remain in the installation directory, and will not be
changed when performing the installation of the new version into the same installation
location.
2.5.1 Uninstallation Checklist
• Stop the Document Converter Service (all services)
• Stop the web service if installed and remove from IIS (skip in case of updating
the document converter).
• Make sure no other users are logged into the server. Force any other sessions to
terminate.
• Restart the Print Spool service (at least, be sure this service is running)
• Terminate any office applications or other programs having a “print” function and
might have loaded a printer driver DLL. In case you have created a share for one
of the PDF or TIFF printers, remove that share. Otherwise, uninstallation of the
printer drivers will fail.
22
3-Heights™ Document Converter, Version 4.6
Page 24 of 90
January 25, 2016
© PDF Tools AG - Premium PDF Technology
• Perform the uninstallation (from the “programs and features” control panel, or
using the shortcut in the Converter Service shortcut group).
To verify that the uninstallation has completed successfully, you may want to verify in
the “Devices and Printers” control panel, that all “Converter Service” printer entries are
removed, that the 3-Heights PDF and TIFF printer drivers are removed, and that the 3-
Heights Port monitor is removed (try to add a new port, and check the selection of
available port types).
In case of problems, check the PDF Tools AG support site about how to deal with PDF
Producer uninstallation problems.
2.5.2 Re-Installation Checklist
• Make sure you know the location of the previous installation, and the set of
features that you need to install. Also, make sure the Print Spooler is (still)
running.
• Perform the installation, using the MSI kit
• Select/verify the installation directory
• Select the features as required
You may now start the configuration editor, and verify the settings, before starting the
service, and verifying the proper functioning.
19
3-Heights™ Document Converter, Version 4.6
Page 25 of 90
January 25, 2016
© PDF Tools AG - Premium PDF Technology
3
Using the Document Converter
This section gives a quick overview on how to use the standard user features. For
detailed background information, refer to the sections on configuration (3.4) and also to
the reference part (5).
3.1
Explorer Shell Extension
The “Client Application” feature of the MSI installer kit adds an extension to the
Windows Explorer.
3.1.1 Using the Shell Pop-up
When you are right-clicking on an office document, the pop-up menu will show the
“3-Heights(TM) Document Converter Service” entry.
The menu entry will be shown when one or multiple documents are selected, and the
selection contains documents having a known file extension. Folders can also be
selected. When activating the menu, the following form pops up:
27
3-Heights™ Document Converter, Version 4.6
Page 26 of 90
January 25, 2016
© PDF Tools AG - Premium PDF Technology
You can now add more documents, set the output folder and file name, and finally click
the “Convert” button to start processing.
The Options tab offers the possibility to control the document conversion. The string in
the “Advanced Options” box is passed as-is. Please refer to the job and document
options documentation in section 5 of this manual.
Note that this form can also be opened via the Windows Start menu in the 3-Heights
Document Converter group.
3.1.2 Configuration of the Pop-up Menu
The pop-up menu will be shown by the explorer for files with certain name extensions. It
will also be shown for folders that contain corresponding files.
The list of relevant file extensions is configured via the O2PCM.ini file that is located in
the installation directory of the Document Converter.
Note that EXPLORER.EXE will need to be restarted to reflect changes in the O2PCM.ini
file.
3.2
Watched Folders
If you have a Watched Folders Service configured, it is very simple and straight-forward
to use that by just moving documents into the pickup folder, and later retrieving the
conversion results from the output folder.
3.3
Command Line Executable
The command line executable is a convenient tool for automating conversion tasks in a
shell script or as a scheduled task.
24
3-Heights™ Document Converter, Version 4.6
Page 27 of 90
January 25, 2016
© PDF Tools AG - Premium PDF Technology
Unless you have extended the PATH environment setting to include the installation
directory of the Document Converter, you have to specify the full file path to call the
o2pclient.exe program (as shown above).
For a detailed explanation of the options, refer to section 5.4.2.
3.4
Office Add-In
The Office Add-In is a simple way for converting documents directly from the Application
used to create the document. It is intended for use in a client environment only (i.e. do
not install it on the server hosting the document converter service).
3.4.1 Configuration
The Office Add-In always uses the server configuration to convert documents. This
means that changes in configuration have to be made on the server side.
3.4.2 Installation for 64-Bit Office
The installation procedure for 64-Bit Office currently has to be completed manually:
1. Open a CMD-Shell as Administrator
2. Execute the following command:
regsvr32 "C:\Program Files (x86)\PDF Tools AG\3-Heights(TM) Document
Converter Service\PdfOfficeAddin64.dll”
3.4.3 Using the Office Add-In
With the Office Add-In, Documents can be converted directly from Word and Outlook:
7
3-Heights™ Document Converter, Version 4.6
Page 28 of 90
January 25, 2016
© PDF Tools AG - Premium PDF Technology
The document is sent to the conversion server where it is converted with the standard
server settings:
The converted document can then be saved on the client again:
45
3-Heights™ Document Converter, Version 4.6
Page 29 of 90
January 25, 2016
© PDF Tools AG - Premium PDF Technology
4
Configuration
The Document Converter features several configuration options that are described in the
following sections.
4.1
Conversion Control
The Document Converter contains control modules for each document format that
automate the corresponding office applications. There is a standard way of configuring
these modules, which works with a windows profile file (application INI file).
The name of a configuration INI file corresponds to the file name of the executable. So,
O2PWSC.exe will read from O2PWSC.ini. Note that O2PSRV.exe does not directly control
any office applications; therefore, there is no need for an O2PSRV.ini file.
A sample O2PWSC.ini is provided by PDF Tools AG.
[Outlook]
OUTLOOKEXE=\Microsoft Office\Office12\OUTLOOK.EXE
EXE
button_yes=&Ja
access_grant = &Zugriff *
[MSWord]
preload = false
SAVEASPDF = true
WorkingSet = 90M
Each configuration setting applies to the section for the specific office application
(Microsoft Word and Outlook in the above sample).
The following table lists the section names and settings that are available in the
Document Converter.
Section
Name
Setting
Default
Value
Description
Outlook
OUTLOOKEXE
\OUTLOOK.EXE Executable path of the
Outlook application; this
is needed to identify the
process being controlled.
*
for values to be specified with the English version of MS Outlook, see end of this
section
82
3-Heights™ Document Converter, Version 4.6
Page 30 of 90
January 25, 2016
© PDF Tools AG - Premium PDF Technology
button_yes
&Ja
The caption of the Outlook
popup asking for grant to
access
e-mail
l
address
information
(this
popup
needs to be identified and
automatically closed by the
Document Converter).
Case sensitive.
access_grant
&Zugriff
The caption of the text
string shown in the Outlook
popup message (see above).
Case sensitive.
SKIPFILES
List of file extensions.
Attachments
having
an
extension listed in this
value will be ignored.
Example: .db .exe .dll
The special value “failing”
can be used to suppress
attachments that cannot be
converted successfully.
The special value “none”
can be used to refer to
file names without any
extension in their name.
Small
images
can
be
filtered out by setting a
value like “SIZE<4x5”, i.e.
the width must be at least
4 pixels, and the height at
least 5 for the image to be
converted.
SELECTFILES
List of file extensions.
Only
attachments
having
their extension listed in
this
value
will
be
converted.
UseHtmlBody
false
If true, save the body in
HTML or RTF format and
convert that rather than
using
the
“PrintOut”
function of Outlook.
Advantage: the page format
will
be
adjusted
as
necessary for very wide
pages
in
HTML
format
(requires IEPRINT = true).
Documents you may be interested
Documents you may be interested