Set Conversion Options for Document Converter
$convert_options keyword|exptime[H|D] [keyword ... ]
This command controls the processing in Document Converter operations. The command affects all outbound operations under the control of the USR or UJP file. It can be overridden by the same command in an FS file. This command replaces the now-deprecated $web_options command.
In $convert_options commands in an owner or jobtype UJP file only, an option keyword can be preceded with a tilde (~) character to indicate that a higher-level option is to be deleted. This feature is not available in system convert options because there is no higher level to affect, and is not available in job instance convert options because these will have already been distilled from system, owner and job type convert options when the job instance UJP file was created. The tilde is not valid on FontSize or Timeout keywords, preceding the expiration time, or when the $convert_options command is placed on an $fs_template command. In these cases the multiple keywords will override each other in the usual hierarchy.
These commands are added to any option letters added as CVSINGLE command-line switches (for single conversions) and any option letters in the or CVTOPTS environment variable value (for all conversions).
The parameters on this command are used as follows:
| keyword | One of the following keywords ([x] indicates the corresponding CVSINGLE or CVTOPTS option letter): |
| Adobe | [A] This option selects the use of Acrobat (if installed) for conversion of PDF documents. |
| AllowFail | Do not fail the FS file if a conversion operation fails. This reverses the default behavior of earlier releases. The FailFS keyword is now ignored, but is retained if specified in case the file is used by a version 7 program. |
| DCHTML | This keyword signals to Job Administration applications that HTML conversions are to be handled by the Document Converter instead of at transmit time, even if the HTML keyword does not appear on the active $convert_options command. The IE keyword below implies this also. |
| DCImage | This keyword signals to Job Administration applications that GIF, JPG and PNG conversions are to be handled by the Document Converter instead of at transmit time, even if the corresponding keyword does not appear on the active $convert_options command. |
| DCPDF | This keyword signals to Job Administration applications that PDF conversions are to be handled by the Document Converter instead of at transmit time, even if the PDF keyword does not appear on the active $convert_options command. The Adobe keyword implies this also. For Job Administration operations, the threshold for converting PDFs with smaller page counts at transmit time is always ignored. |
| ExcelSETP | [V] When specified for an Excel conversion, adjusts the paper size in printer preferences to match the page size of the first Worksheet. See Printer Page Size. |
| FontsizeN | Specify the font size to be used in Internet Explorer. The N is a number from 0 (smallest) to 4 (largest), corresponding to the five menu entries under View / Text Size in Internet Explorer. In the internal HTML converter, the same five values implement respectively a scaling of the rendered image by -20%, -10%, 0%, +10% and +20%. The percentage steps (default 10) can be overridden using the value of variable CVSINGLE_SCALESTEP in the FS file. |
| FPimage | [F] Specifies that an image conversion (PNG, JPG, GIF) is to be scaled to full-page. |
| GSPDF | [G] Specifies the use of Ghostscript for PDF conversions. We recommend the use of option QPDF (see below) in preference to GSPDF if you are unable to use Adobe. |
| GS300, GS400 | Specifies the use of Ghostscript for PDF conversions, and the use of 300x300 or 400x400 resolution respectively. |
| HTMLWord | [H] Specifies the use of Microsoft Word (or Star Office, see OODOCX above) for conversions of local HTML files instead of Internet Explorer. |
| IgnoreLM | Ignore the Last Modification time of an HTTP URL, if available. The default is to always attempt a retrieval even if a corresponding fax format file exists which has not expired, but to abandon the retrieval if the fax file has a later timestamp than the last modification time in the HTTP header. The last modification time of a FILE URL is always available and is never ignored. |
| IE | [I] Uses Internet Explorer to convert HTML documents instead of the built-in HTML renderer. |
| ImgN | This keyword specifies the Image Option Set number to use for conversions in the context of the user profile, where N is from 1 to 9. The image options for each set are specified on the $image_options configuration command. If this keyword is not present or the N is omitted, the value from $image_options 0 is used, but if there is no corresponding $image_options N command, an empty option set is used. The contents of the selected image options set are overridden by the value of the IMAGE_OPTIONS variable, if defined. Only a single option set can be selected. |
| InterPDF | [Y] When specified for the conversion of an Office document, the document is saved as an intermediate PDF file without the use of the print driver, and then converted to TIF using the built-in PDF converter. This option is now the default and the keyword is ignored, other than in UJP files where it can override a higher-level option. |
| NoIE | [N] Specifies the use of an internal HTML converter instead of Internet Explorer. This option is now the default and the keyword is ignored, other than in UJP files where it can override a higher-level option. |
| LODOC | [X] Specifies the use of LibreOffice instead of Microsoft Word for DOC and DOCX formats. The older keywords SO... and OO... will be treated as synonyms. See Using LibreOffice |
| LOPPT | [T] Specifies the use of LibreOffice instead of Microsoft Powerpoint for PPT and PPTX formats. The older keywords SO... and OO... will be treated as synonyms. See Using LibreOffice |
| LOXLS | [S] Specifies the use of LibreOffice instead of Microsoft Excel for XLS and XLSX formats. The older keywords SO... and OO... will be treated as synonyms. See Using LibreOffice |
| PartialOK | Treat as successful an IE5 retrieval operation which times out before all the graphics have been downloaded. The default is to treat the retrieval of the partial document as a failure. |
| PDFAttach | When specified for the conversion of Office document, in an FS file where both $fax_filename and $email_attach reference the same Office document and the e-mail content-type is 'application/pdf', this causes the attachment to be converted directly from the Office document. Note that a $fax_filename command is required to force the FS file to be moved by the engine into PREPROC, but will be removed by the Document Converter if the FS has no $fax_phone command. Without this option, an attachment with application/pdf content-type is converted from the TIF which results from the conversion to fax format, and is therefore monochrome and an image format in the PDF. |
| PDFSETP | [K] When specified for an Adobe conversion, adjusts the paper size in printer preferences to match the page size of the first page. See Printer Page Size. This keyword was formerly AdobeSETP; you may also need to set environment variable USE_ADOBESETP if you wish to continue using the old name. |
| PPTSETP | [U] When specified for a PowerPoint conversion, adjusts the paper size in printer preferences to match the page size of the first slide. See Printer Page Size. |
| PRINT | [P] This option selects the use of the Document Converter print driver for Microsoft Office Documents. This option overrides InterPDF if both appear. |
| QPDF | [Q] Specifies the use of the built-in PDF converter for PDF conversions. This option is now the default and the keyword is ignored, other than in UJP files where it can override a higher-level option. |
| StripJS | [C] Causes a PDF to be checked for Javascript which causes it to put up a print dialog as soon as it is opened in Acrobat, and for the Javascript to be removed if so. The file is saved without the Javascript as filename_NJ.PDF. |
| TimeoutN | Override the timeout default (45 seconds) to timeout in N seconds. This timeout applies first to the remote retrieval of a document using HTTP or FTP, if applicable, and then to the print operation to the Document Converter print driver, if needed. |
| WordSETP | [W] When specified for a Word conversion, adjusts the paper size in printer preferences to match the page size of the first page. See Printer Page Size. |
| exptime | The expiration time (in hours, after its creation) of the fax-format representation of the HTTP document. The value may be zero or positive (negative values are treated as zero) and is used as follows: |
| | If the IgnoreLM keyword is given, then the fax-format file is used until its expiration date and no web retrieval is attempted if the file has not expired. After the fax file has expired, IE5 web retrieval is attempted and the Last Modification information is ignored. |
| | If the IgnoreLM keyword is not given, then web retrieval is always attempted, and if there is a Last Modification time available in the HTTP header, it is used to determine whether the fax format file should be replaced or retrieval abandoned, and the expiration time is ignored. |
| | If the IgnoreLM keyword is not given, then web retrieval is always attempted, and if the Last Modification time is not available in the HTTP header, the expiration time is used to determine whether the fax format file should be replaced or retrieval abandoned. |
| | If the URL is a file URL, the expiration date is always ignored and the decision to re-convert to fax is based only on the file times. |
| H | A suffix indicating hours (default) |
| D | A suffix indicating days |
Note that when the option keywords specify the use of the HTTP Header "Last-Modified" data (which is the default), the machine running FFEXTERN must be configured with the correct time-zone and daylight-savings settings for your location. This is because the HTTP data always uses Universal Time (GMT), and so the correct conversion must be used to match local times of the corresponding fax files on your system.
Default: No keywords are used, and expiration time 0.
Examples:
Allow partial retrievals where the document load timed out before all graphics were loaded:
$convert_options partialok
Ignore web document last modification times and unconditionally retrieve documents.
$convert_options 0 ignoreLM
Use the internal html conversion:
$convert_options noie
Extend the conversion timeout:
$convert_options timeout100
