Set Options for Document Converter
$convert_options keyword|exptime[H|D] [keyword ... ]
This command controls the default processing of retrievals 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 job type 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 expiry 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.
The parameters on this command are used as follows:
| keyword | One of the following keywords ([x] indicates the corresponding CVSINGLE command-line flag): |
| DftIE | [B] Pass files for which a conversion method cannot be determined to Internet Explorer for processing. This was originally the default behavior but was found to be less than helpful, so such conditions now result in conversion failure. |
| FailFS | Abandon the entire transmission (FS file) if a conversion operation fails. The default is to send the remaining documents, if any. |
| 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. |
| GSPDF | [G] Specifies the use of Ghostscript for PDF conversions |
| GS300, GS400 | Specifies the use of Ghostscript for PDF conversions, and the use of 300x300 or 400x400 resolution respectively. |
| SODOC | [S] Specifies the use of StarOffice or Open Office 2.x instead of Microsoft Word for DOC formats (and overrides OODOCX). |
| SOXLS | [S] Specifies the use of StarOffice or Open Office 2.x instead of Microsoft Excel for XLS formats (and overrides OOXLSX). |
| SOPPT | [S] Specifies the use of StarOffice or Open Office 2.x instead of Microsoft Powerpoint for PPT formats (and overrides OOPPTX). |
| OODOCX | [S] Specifies the use of Open Office v3 instead of Microsoft Word for DOC and DOCX formats. |
| OOXLSX | [S] Specifies the use of Open Office v3 instead of Microsoft Excel for XLS and XLSX formats. |
| OOPPTX | [S] Specifies the use of Open Office v3 instead of Microsoft Powerpoint for PPT and PPTX formats. |
| NoIE | [N] Specifies the use of an internal HTML/XML renderer instead of Internet Explorer. The built-in converter selected by this option typically converts HTML documents between twice and three times as fast as using Internet Explorer, but may not successfully convert complex HTML syntax. |
| Firefox | [F] Specifies the use of the Mozilla ActiveX Control for HTML and GIF, JPG, PNG conversions. |
| HTMLWord | [H] Specifies the use of Microsoft Word (or Star Office, see SODOC above) for conversions of local HTML files instead of Internet Explorer. |
| O2K | [K] Forces the use of Office 2000 components. |
| O2003 | [C] Forces the use of Office 2003 components |
| O97 | [V] Forces the use of Office 97 components. |
| TIFInternal | [T] (accepted, but no longer used to specify the internal TIF converter, which is now the default for XIF and non-faxable TIF files) |
| TIFAcrobat | [A] Forces the use of Acrobat Professional V6/V7/V8 for XIF and non-faxable TIF files. |
| Use_Imagemaker | [M] Forces the use of Imagemaker for graphical files (no LZW compression). |
| Use_eiStream | [E] Forces the use of eiStream for graphical files instead of Windows imaging (no PNG). |
| WordPerfect | [W] Allows WordPerfect .DOC files to be passed to Word for conversion. Only use this keyword if your copy of Word is configured to accept these documents on the node(s) running FFEXTERN/CVSINGLE. This enables processing of .DOC files whose first four bytes are "\xffWPC". |
| TimeoutN | Override the timeout default set in conversion, 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. |
| 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. |
| 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. |
| 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 expiry 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 and force the failure of the FS if any conversions fail:
$convert_options noie failfs
Topic url:
http://www.copia.com/support/refmanual/index.html?%24convert_options_usr.htm
