Description
The file2pdf-settings schema specifies the syntax for the XML configuration files (file2pdf-settings files) used with the Generate PDF and Distiller services.
The root element is the file2pdf-settings element.
These files are a serial representation of the settings you can specify by using the LiveCycle Administration Console web pages for the Generated PDF services. The following web pages correspond to elements within this schema:
- Adobe PDF Settings
- File Type Settings
- Optimize PDF
The file2pdf-settings files are used in the following situations:
- Importing settings into the LiveCycle server.
- Exporting settings from the LiveCycle server.
- Passed as arguments to the Java methods exposed by the Generate PDF or Distiller services.
- Provided as LiveCycle Workbench Inputs to Generate PDF or Distiller operations.
A single file2pdf-settings file contains multiple instances of each type of settings (Adobe PDF Settings, File Type Settings, Optimize PDF, and User Accounts). Each instance is uniquely named, and one instance of each type is designated as the default.
A file2pdf-settings XML file can contain multiple instances of each type of settings. The operations and methods that consume a file2pdf-settings file use only the default settings instances. These default settings are identified by the default="true" attribute in the corresponding element, for examle:
file2pdf-settings/filetype-settings/settings/@default="true"
file2pdf-settings/security-settings/settings/@default="true"
Annotations
| appinfo |
Elements
| Element | Description |
|---|---|
| AddIns | List of Excel add-ins to load. List must be comma separated with no extra spaces. |
| colorManagement | Color management settings for converting PDF to images. |
| colorManagement\CMYK | Color management settings for converting PDF to images. |
| colorManagement\Grayscale | Color management settings for converting PDF to images. |
| colorManagement\RGB | Color management settings for converting PDF to images. |
| conversion | Color management settings for converting PDF to images. |
| conversion\colorspace | Settings for converting PDF to images. |
| conversion\resolution | Settings for converting PDF to images. |
| createBookmarks | Settings for converting PDF to HTML. |
| createTags | Settings for converting PDF to HTML. |
| Distiller | Settings for converting Microsoft Excel, Microsoft Word, or Microsoft PowerPoint to PDF. |
| exportImages | Settings for converting PDF to HTML. |
| exportTo | Target file format, expressed as an enumerated value. |
| file2pdf-settings | A container element for the different types of Generate PDF settings. |
| file2pdf-settings\action | Names of the settings to use for per-job conversions. |
| file2pdf-settings\action\filetype-setting | Specifies one or more file type settings. |
| file2pdf-settings\action\job-option-setting | Name of the job option settings to use for the conversion. |
| file2pdf-settings\action\security-setting | Name of the security settings to use for the conversion. |
| file2pdf-settings\action\timeout | Timeout in seconds after which conversion jobs are terminated. |
| file2pdf-settings\version | Version of LiveCycle with which the file2pdf-settings are compatible. |
| fileSettings | Settings used to convert PDF files to TIFF, JPEG, or PNG images. |
| fileSettings\color | Settings used to convert PDF files to images. |
| fileSettings\filter | Settings used to convert PDF files to images. |
| fileSettings\format | Settings used to convert PDF files to images. |
| fileSettings\grayscale | Settings used to convert PDF files to images. |
| fileSettings\interlace | Settings used to convert PDF files to images. |
| fileSettings\monochrome | Settings used to convert PDF files to images. |
| filetype-settings | Container element for the individual file type settings. |
| filetype-settings\settings | Specifies application settings for supported file types. |
| filetype-settings\settings\Acrobat | Deprecated. |
| filetype-settings\settings\Acrobat\ocrDownsampleType | Deprecated. |
| filetype-settings\settings\Acrobat\ocrLanguage | Deprecated. |
| filetype-settings\settings\Acrobat\ocrOutputStyle | Deprecated |
| filetype-settings\settings\Acrobat\saveForAcrobatVersion | Deprecated. |
| filetype-settings\settings\Acrobat\useOCR | Deprecated. |
| filetype-settings\settings\AdobeFlash | Settings converting SWF and FLV files to PDF. |
| filetype-settings\settings\AutoCAD | Settings for converting AutoCAD files to PDF. |
| filetype-settings\settings\GenericApp | Settings for using a generic application to convert files to PDF. |
| filetype-settings\settings\Html2pdf | Initial view settings and settings for converting HTML files to PDF or for converting ZIP files containing HTML files to PDF. |
| filetype-settings\settings\Image | Settings for converting image file formats to PDF. |
| filetype-settings\settings\Image\ocrDownsampleType | Decreases the number of pixels in color, grayscale, and monochrome images. |
| filetype-settings\settings\Image\ocrLanguage | Language for the OCR engine to use to identify the characters. |
| filetype-settings\settings\Image\ocrOutputStyle | Target OCR style |
| filetype-settings\settings\Image\saveForAcrobatVersion | Target Acrobat version. |
| filetype-settings\settings\Image\useOCR | Boolean that specifies whether to perform Optical Character Recognition (OCR) on the PDF generated from the image. |
| filetype-settings\settings\MSExcel | Specifies how Microsoft Excel files are converted. |
| filetype-settings\settings\MSExcel\worksheets | Boolean that specifies whether to reduce the size of the text to fit the worksheet on a single page. |
| filetype-settings\settings\MSPowerpoint | Conversion settings for Microsoft PowerPoint files |
| filetype-settings\settings\MSProject | Conversion settings for Microsoft Project files. |
| filetype-settings\settings\MSPublisher | Conversion settings for Microsoft Publisher files. |
| filetype-settings\settings\MSVisio | Conversion settings for Microsoft Visio files |
| filetype-settings\settings\MSWord | Conversion settings for Microsoft Word files. |
| filetype-settings\settings\MSWord\preserveMarkup | Preserves any markup when the file is converted. |
| filetype-settings\settings\MSWord\stylesToBookmark | Conversion settings for Microsoft Word bookmarks |
| filetype-settings\settings\MSWord\stylesToBookmark\stylesWithLevels | Paragraph style names and bookmark levels |
| filetype-settings\settings\OpenOffice | Specifies how OpenOffice files are converted. |
| filetype-settings\settings\OpenOffice\general | Conversion settings for OpenOffice. |
| filetype-settings\settings\OpenOffice\general\exportBlankPages | A Boolean that specifies whether to include blank pages from the source document. |
| filetype-settings\settings\OpenOffice\general\exportNotes | A Boolean that specifies whether to include Writer and FormCalc document notes in the PDF document. |
| filetype-settings\settings\OpenOffice\general\formsFormat | Specifies the format in which forms are submitted |
| filetype-settings\settings\OpenOffice\general\taggedPDF | A Boolean that specifies whether to include tags in the PDF file. |
| filetype-settings\settings\OpenOffice\general\useTransitionEffects | A Boolean that specifies whether to include Impress slide transition effects in the PDF document. |
| filetype-settings\settings\OpenOffice\images | OpenOffice conversion settings for images |
| filetype-settings\settings\OpenOffice\images\compression | Compression algorithm to use |
| filetype-settings\settings\OpenOffice\images\compressionValue | Level of compression when JPEG compression is enabled |
| filetype-settings\settings\OpenOffice\images\reduceImageResolution | OpenOffice conversion settings for images |
| filetype-settings\settings\OpenOffice\images\reduceImageResolutionValue | OpenOffice conversion settings for images |
| filetype-settings\settings\OpenOffice\pageOrientation | Page orientation |
| filetype-settings\settings\OpenOffice\pages | Pages to convert. |
| filetype-settings\settings\OpenOffice\pages\range | Specifies whether all or some of the pages are converted. |
| filetype-settings\settings\OpenOffice\pages\rangeValue | Range of pages to convert. |
| filetype-settings\settings\Optimizer | Optimization settings including objects to clean up and objects to remove. |
| filetype-settings\settings\Optimizer\CleanUp | Objects to optimize in the PDF file. |
| filetype-settings\settings\Optimizer\CleanUp\discardInvalidBookmarks | A Boolean that specifies whether to discard invalid bookmarks. |
| filetype-settings\settings\Optimizer\CleanUp\discardInvalidLinks | A Boolean that specifies whether to discard invalid links. |
| filetype-settings\settings\Optimizer\CleanUp\discardUnrefDest | A Boolean that specifies whether to discard unreferenced destinations. |
| filetype-settings\settings\Optimizer\CleanUp\lzwToFlate | A Boolean that specifies whether to apply Flate compression to all content streams and images that use LZW encoding. |
| filetype-settings\settings\Optimizer\CleanUp\objectCompression | |
| filetype-settings\settings\Optimizer\CleanUp\optimizeFastWebView | A Boolean that specifies whether to restructure a PDF document for page-at-a-time downloading (byte-serving) from web servers. |
| filetype-settings\settings\Optimizer\CleanUp\optimizePageContent | A Boolean that specifies whether to convert all end-of-line characters to space characters, which improves Flate compression. |
| filetype-settings\settings\Optimizer\CleanUp\useFlateForUnencoded | A Boolean that specifies whether to apply Flate compression to all streams that aren’t encoded. |
| filetype-settings\settings\Optimizer\cleanupOptionIsOn | |
| filetype-settings\settings\Optimizer\colorImgOptions | |
| filetype-settings\settings\Optimizer\discardObjectOptionIsOn | |
| filetype-settings\settings\Optimizer\DiscardObjects | Objects to discard from the PDF file as part of optimization. |
| filetype-settings\settings\Optimizer\DiscardObjects\convertLineToCurve | A Boolean that specifies whether to convert lines to curves. |
| filetype-settings\settings\Optimizer\DiscardObjects\discardAltImages | A Boolean that specifies whether to discard alternate images from the PDF. |
| filetype-settings\settings\Optimizer\DiscardObjects\discardBookmarks | A Boolean that specifies whether to discard bookmarks from the PDF. |
| filetype-settings\settings\Optimizer\DiscardObjects\discardDocTags | A Boolean that specifies whether to discard document tags from the PDF. |
| filetype-settings\settings\Optimizer\DiscardObjects\discardEmbeddedPrint | A Boolean that specifies whether to discard embedded print settings, such as page scaling and duplex mode, from the document. |
| filetype-settings\settings\Optimizer\DiscardObjects\discardEmbeddedSearchIndex | A Boolean that specifies whether to remove embedded search indexes. |
| filetype-settings\settings\Optimizer\DiscardObjects\discardEmbeddedThumbnail | A Boolean that specifies whether to remove embedded thumbnails. |
| filetype-settings\settings\Optimizer\DiscardObjects\discardFormSubmission | A Boolean that specifies whether to disable all actions related to submitting or importing form data and to reset form fields. |
| filetype-settings\settings\Optimizer\DiscardObjects\discardJSActions | A Boolean that specifies whether to discard JavaScript actions. |
| filetype-settings\settings\Optimizer\DiscardObjects\flattenFormField | A Boolean that specifies whether to make form fields unusable with no change to their appearance. . |
| filetype-settings\settings\Optimizer\DiscardObjects\mergeImageFragments | A Boolean that specifies whether to merge fragmented images or masks into a single image or mask. |
| filetype-settings\settings\Optimizer\DiscardUserData | Container for settings that discard user data |
| filetype-settings\settings\Optimizer\DiscardUserData\discardComments | A Boolean that specifies whether to remove all comments, forms, form fields, and multimedia from the PDF. |
| filetype-settings\settings\Optimizer\DiscardUserData\discardDocInfo | A Boolean that specifies whether to discard document information, including all metadata. |
| filetype-settings\settings\Optimizer\DiscardUserData\discardExternalCrossRefs | A Boolean that specifies whether to remove links to other documents. |
| filetype-settings\settings\Optimizer\DiscardUserData\discardFileAttachments | A Boolean that specifies whether to remove all file attachments, including attachments added to the PDF as comments. |
| filetype-settings\settings\Optimizer\DiscardUserData\discardHiddenLayer | A Boolean that specifies whether to discard hidden layers in the PDF and flatten visible layers. |
| filetype-settings\settings\Optimizer\DiscardUserData\discardObjectData | A Boolean that specifies whether to remove XObject dictionaries from the PDF document. |
| filetype-settings\settings\Optimizer\DiscardUserData\discardPrivateData | A Boolean that specifies whether to discard private data in the PDF. |
| filetype-settings\settings\Optimizer\discardUserDataOptionIsOn | |
| filetype-settings\settings\Optimizer\Fonts | |
| filetype-settings\settings\Optimizer\Fonts\subsetEmbeddedFonts | |
| filetype-settings\settings\Optimizer\Fonts\UmembeddingOptions | |
| filetype-settings\settings\Optimizer\Fonts\UmembeddingOptions\fontName | |
| filetype-settings\settings\Optimizer\Fonts\UmembeddingOptions\unembedFontsAll | |
| filetype-settings\settings\Optimizer\Fonts\UmembeddingOptions\unembedFontsNone | |
| filetype-settings\settings\Optimizer\fontsOptionIsOn | |
| filetype-settings\settings\Optimizer\grayscaleImgOptions | |
| filetype-settings\settings\Optimizer\imageOptionIsOn | |
| filetype-settings\settings\Optimizer\monochromeImgOptions | |
| filetype-settings\settings\Optimizer\Transparency | |
| filetype-settings\settings\Optimizer\Transparency\clipComplexRegions | |
| filetype-settings\settings\Optimizer\Transparency\convertStrokesToOutlines | |
| filetype-settings\settings\Optimizer\Transparency\convertTextToOutlines | |
| filetype-settings\settings\Optimizer\Transparency\pctRasterVectorBalance | |
| filetype-settings\settings\Optimizer\Transparency\ppiGradientMeshResolution | |
| filetype-settings\settings\Optimizer\Transparency\ppiLineArtTextResolution | |
| filetype-settings\settings\Optimizer\Transparency\preserveOverprint | |
| filetype-settings\settings\Optimizer\transparencyOptionIsOn | |
| filetype-settings\settings\PDFExport | Settings for converting PDF to another file format. |
| filetype-settings\settings\PDFExport\HtmlTxt | Settings to convert PDF to HTML. |
| filetype-settings\settings\PDFExport\JPEG | Settings to convert PDF to JPEG. |
| filetype-settings\settings\PDFExport\PNG | Settings to convert PDF to PNG. |
| filetype-settings\settings\PDFExport\TIFF | Settings to convert PDF to TIFF. |
| filetype-settings\settings\WebCapture | Deprecated. |
| filetype-settings\settings\WebCapture\createBookmarks | Deprecated. |
| filetype-settings\settings\WebCapture\createTags | Deprecated. |
| filetype-settings\settings\WebCapture\levels | Deprecated. |
| filetype-settings\settings\WebCapture\placeHeadersAndFooters | Deprecated. |
| filetype-settings\settings\WebCapture\samePath | Deprecated. |
| filetype-settings\settings\WebCapture\sameServer | Deprecated. |
| filetype-settings\settings\WebCapture\saveRefreshCmds | Deprecated. |
| filetype-settings\settings\XPS | |
| folder | Deprecated |
| folder\allowedExtensions | Deprecated |
| folder\batchSize | Deprecated |
| folder\createInFolder | Deprecated |
| folder\duplicates | Deprecated |
| folder\filetype-settings | Deprecated |
| folder\job-options | Deprecated |
| folder\jobTimeout | Deprecated |
| folder\purgeTime | Deprecated |
| folder\refreshTime | Deprecated |
| folder\saveFailed | Deprecated |
| folder\saveSuccessful | Deprecated |
| folder\security-settings | Deprecated |
| html2pdfSettings | Settings for converting HTML to PDF conversion. |
| html2pdfSettings\createBookmarks | |
| html2pdfSettings\createTaggedPDF | |
| html2pdfSettings\footerContent | A string that is placed at the bottom of each page in the converted PDF document |
| html2pdfSettings\forceEncoding | |
| html2pdfSettings\headerContent | A string that is placed at the top of each page in the converted PDF document |
| html2pdfSettings\inputEncoding | |
| html2pdfSettings\levels | Specifies the levels to include in the HTML spidering. |
| html2pdfSettings\marginBottom | Settings for converting HTML to PDF (see LiveCycle ES3 Administration Help). |
| html2pdfSettings\marginLeft | Settings for converting HTML to PDF (see LiveCycle Administration Console Help). |
| html2pdfSettings\marginRight | Settings for converting HTML to PDF (see LiveCycle Administration Console Help). |
| html2pdfSettings\marginTop | Settings for converting HTML to PDF (see LiveCycle Administration Console Help). |
| html2pdfSettings\pageHeight | Settings for converting HTML to PDF (see LiveCycle Administration Console Help). |
| html2pdfSettings\pageWidth | Settings for converting HTML to PDF (see LiveCycle Administration Console Help). |
| html2pdfSettings\placeFooter | Settings for converting HTML to PDF (see LiveCycle Administration Console Help). |
| html2pdfSettings\placeHeader | Settings for converting HTML to PDF (see LiveCycle Administration Console Help). |
| html2pdfSettings\samePath | A Boolean that specifies whether to include all web pages on the same path as the original web page |
| html2pdfSettings\sameServer | A Boolean that specifies whether to include all web pages on the save server as the original web page |
| imageDirectory | Subfolder in which to store generated images. The default is Images. |
| imageFormat | Final format in which to save images, by default JPG. |
| imagePrefix | Prefix added to the image file names if there are several versions of the same image file |
| initialView | Initial viewing characteristics of the PDF document |
| initialView\documentOptions | Controls the appearance of the PDF document within the document window |
| initialView\documentOptions\pageLayout | Determines whether the document is viewed in single-page, facing-page, continuous page, or continuous facing-page mode. |
| initialView\documentOptions\pageMode | Determines which panes and tabs are displayed in the application window by default. |
| initialView\documentOptions\pageNumber | Page that the document opens at, which is usually page 1. |
| initialView\documentOptions\zoomType | Zoom level at which the document will be displayed when opened. |
| initialView\documentOptions\zoomType\percent | Percentage zoom, meaningful only if the zoomMode element has a value of Percentage. |
| initialView\documentOptions\zoomType\zoomMode | Mode for the zoom level |
| initialView\uiOptions | Container for settings that influence visibility of navigator tools |
| initialView\uiOptions\hideMenuBar | A Boolean that specifies whether to hide the menu bar |
| initialView\uiOptions\hideToolBar | A Boolean that specifies whether to hide the toolbars |
| initialView\uiOptions\hideWindowUI | A Boolean that specifies whether to hide the window controls |
| initialView\windowOptions | Container for elements that determine how the window adjusts in the screen area when a user opens the document |
| initialView\windowOptions\centerWindow | Positions the window in the center of the screen area. |
| initialView\windowOptions\fitWindow | Adjusts the document window to fit snugly around the opening page, according to the options that you selected under Document Options. |
| initialView\windowOptions\fullScreenMode | Maximizes the document window and displays the document without the menu bar, toolbar or window controls. |
| initialView\windowOptions\titleDisplay | Determines whether the window title bar of the window displays the filename of the document title. |
| job-options | Container element for the Adobe PDF settings. |
| job-options\job-option | Specifies how files are converted into PDF and what characteristics the resulting PDF file has. |
| job-options\job-option\optionData | A PDF dictionary that represents the Adobe PDF settings |
| job-sources | Deprecated |
| job-sources\email-sources | Deprecated |
| job-sources\watched-folders | Deprecated |
| job-sources\web-services | Deprecated |
| job-sources\web-ui | Deprecated |
| Layouts | Specifies the AutoCAD layouts to convert |
| method | Deprecated |
| optimizeImgOptions\compressAlgo | |
| optimizeImgOptions\compressQlty | |
| optimizeImgOptions\downSampleAbove | |
| optimizeImgOptions\downSampleAlgo | |
| optimizeImgOptions\downSampleTo | |
| optimizeImgOptions\tileSize | |
| orientation | Orientation of the HTML content on the PDF page |
| PDFMaker | PDFMaker conversion settings |
| pop3-account | Deprecated. |
| pop3-account\accept | Deprecated |
| pop3-account\accept\domain | Deprecated |
| pop3-account\allowedExtensions | Deprecated |
| pop3-account\allowWebcapture | Deprecated |
| pop3-account\batchSize | Deprecated |
| pop3-account\defaultSubject | Deprecated |
| pop3-account\failureRecipients | Deprecated |
| pop3-account\failureRecipients\recipient | Deprecated |
| pop3-account\filetype-settings | Deprecated |
| pop3-account\interval | Deprecated |
| pop3-account\job-options | Deprecated |
| pop3-account\jobTimeout | Deprecated |
| pop3-account\maxPdfFileSize | Deprecated |
| pop3-account\maxSrcFileSize | Deprecated |
| pop3-account\password | Deprecated |
| pop3-account\returnAddress | Deprecated |
| pop3-account\returnName | Deprecated |
| pop3-account\security-settings | Deprecated |
| pop3-account\sendTimeout | Deprecated |
| pop3-account\smtpHost | Deprecated |
| pop3-account\subjectHeader | Deprecated |
| pop3-account\successRecipients | Deprecated |
| pop3-account\successRecipients\recipient | Deprecated |
| pop3-account\timeout | Deprecated |
| printColor | |
| printContent | |
| printHandoutOrder | |
| printOutputType | |
| printPageRange | |
| printPageType | |
| printType | |
| security-settings | Container that specifies one or more security settings |
| security-settings\settings | Security settings that can be applied to a PDF document. |
| security-settings\settings\acrobatVersion | Sets the type of encryption for opening a password-protected document. |
| security-settings\settings\changePermissions | Defines which editing actions are allowed in the PDF document |
| security-settings\settings\documentChangePasswd | Password that is required to change the permissions settings. . |
| security-settings\settings\documentOpenPasswd | Password that is required to open the document |
| security-settings\settings\enableCopying | A Boolean that specifies whether to enable copying of text, images, and other content |
| security-settings\settings\enableTextAccess | A Boolean that specifies whether to enable text access of screen reader devices for the visually impaired |
| security-settings\settings\encrypt | Parts of the PDF document to encrypt. |
| security-settings\settings\printPermissions | Quality of printing for the PDF document |
| targetPDFVersion | Enumerated value for the PDF version created by the Generate PDF service's Optimize operation. |
Complex Types
| Complex Type | Description |
|---|---|
| optimizeImgOptions |
Simple Types
| Simple Type | Description |
|---|---|
| colorProfile | |
| fileCompression | |
| jpgFormat | |
| jTimeout | Deprecated |
| marginType | Decimal type for expressing margin widths in inches, to thousandths of an inch. |
| pageType | Decimal type for expressing page width or height in inches, to thousandths of an inch. |
| pngFilter | |
| pngInterlace | |
| srcPriority | Deprecated |