CVSINGLE is the principal DC component which actually performs the conversion of documents.  This topic describes all the operations of CVSINGLE.

CVSINGLE Operation Modes

CVSINGLE has four separate modes of operation:

Command-line ModeIn command-line mode, CVSINGLE converts a single input file to an output file, both files being specified on the command line.  The command line can also have an initial options parameter, and a final parameter supplying a temporary folder which can be used when the output file is to be writtent to a network folder.  You can also allow the temp folder to default and supply instead a third parameter consisting of a string commencing "QPDF_OPTIONS: " which provides an override for this variable.
FFEXTERN ModeWhen called from FFEXTERN, a command line is shown in the trace file to indicate the files being converted, but the actual files to be used, along with other parameters, are passed to CVSINGLE using inter-process communication.  Again, only a single source document is processed, so that when processing an FS file containing multiple document files, CVSINGLE will be called more than once. More than one output file may result from a single source conversion: for example a Word document may be first converted to TIF for sending by fax and then saved as PDF for use as an e-mail attachment.
WordMerge ModeFor single-shot WordMerge conversions, a data source filename will be included in the parameter set passed from FFEXTERN, which will have created this file containing the data for a single list row.  The passed original Word document is then used as a master for the single-item list.  In this case there are three possible outputs from the 'personalize and convert' operation, a TIF for sending by fax, a PDF for e-mail attachment with content-type application/pdf, and a DOC for e-mail attachment with content type application/msword.
Bulk WordMerge ModeIn this mode, CVSINGLE is also called from FFEXTERN, but with parameters which include the full data source for the merge and the folder in which the FS files already launched by Job Admin can be found.  In this mode, CVSINGLE will automate a full Word merge and will update each FS file with the resulting converted documents.

These operation modes are described in more detail in the sub-topics.

CVSINGLE Document Locations

In Command-line and FFEXTERN modes, CVSINGLE supports three types of document location:

File SystemThis is the normal case, where the source document is on a local drive or in a file on the LAN.
Web DocumentThese documents are identified by an http:// source filename prefix.  Unless the prefix is an http:///filename prefix, CVSINGLE downloads the document using HTTP before conversion.  The source file time may also be retrieved using HTTP depending on the IgnoreLM and exptime options described in the $convert_options topic.
FTP DocumentThese documents are identified by an ftp:// source filename prefix.  CVSINGLE will download the document using HTTP before conversion.  The source file time is taken to be the current time.

CVSINGLE Document Types

For the first two processing modes, CVSINGLE starts by determining the document type of the source document.  In WordMerge mode the document type will already be known in order for Job Admin, as initiator, to have selected this mode.

See supported document formats for details.

CVSINGLE Conversion Methods

After determining the document type, CVSINGLE next has to determine the conversion method.  This is a function of the document type and the selected options.  The available conversion methods for each document type are also shown in the supported document formats topic.  The inverse of this, the document types which can be processed by each conversion method, are shown below:

Acrobat ProfessionalUsed for PDF when options GSPDF, GS300, GS400 and QPDF are absent.  Used for XIF files and non-faxable TIF files when option TIFAcrobat is present.
Adobe ReaderUsed for PDF when options GSPDF, GS300, GS400 and QPDF are absent and Acrobat Professional is not installed.
Star Office 2Used for DOC and RTF files when option SODOC is present.  Used for XLS files when option SOXLS is present.  Used for PPT files when option SOPPT is present.
TIF InternalUsed for non-faxable TIF files and XIF files unless option TIFAcrobat is present.
FirefoxUsed for HTM, HTML, PNG, GIF, JPG and JPEG files when option Firefox is present.  Note that this uses an older Mozilla ActiveX component and is now deprecated.
HTTP InternalUsed for HTM, HTML, XML, PNG, GIF, JPG and JPEG files when option NoIE is present.
Internet ExplorerUsed for  HTM, HTML, XML, PNG, GIF, JPG and JPEG files when options NoIE and HTMLWord are absent..
GhostscriptUsed for PDF when any of options GSPDF, GS300, GS400 are present.
CVTIFUsed for fixable non-faxable TIF files and for JTFax, Winfax and Brooktrout G3 TIF files.
SnapViewUsed for SNP files.
Word 2007Used for DOC, RTF and DOCX files if the highest Office version installed is 12.
Excel 2007Used for XLS and XLSX files if the highest Office version installed is 12.
Powerpoint 2007Used for PPT and PPTX files if the highest Office version installed is 12.
Open/Libre OfficeUsed for DOC, DOCX and RTF files when option OODOCX is present.  Used for XLS and XLSX files when option OOXLSX is present.  Used for PPT and PPTX files when option OOPPTX is present.
Word 2010Used for DOC, RTF and DOCX files if highest Office version installed is 14.
Excel 2010Used for XLS and XLSX files if highest Office version installed is 14.
Powerpoint 2010Used for PPT and PPTX files if highest Office version installed is 14.
QuickPDFUsed for PDF when option QPDF is present.
Word 2013Used for DOC, RTF and DOCX files if highest Office version installed is 15.
Excel 2013Used for XLS and XLSX files if highest Office version installed is 15.
Powerpoint 2013Used for PPT and PPTX files if highest Office version installed is 15.
Word 2016Used for DOC, RTF and DOCX files if highest Office version installed is 16.
Excel 2016Used for XLS and XLSX files if highest Office version installed is 16.
Powerpoint 2016Used for PPT and PPTX files if highest Office version installed is 16.