Exporting

This section focuses on attributes related to exporting content in ways other than emails and briefcases. Many of the settings in this section can be modified by the user in the document viewer by selecting Tools → Options → Download (or just Options → Download in the web client). See the Laserfiche User Guide on Exporting From Laserfiche.

See other pages for attributes related to the following:

• Exporting Laserfiche entries through emails
• Exporting briefcases

Color and Format of Exported Images

[Settings]ExportImageBWFormat

Determines the format in which black-and-white Laserfiche images are exported. Windows client only.

Valid values:

• Integers. 28 = TIFF with G4 compression, 29 = TIFF with LZW compression, 35 = PDF, 14 = JPEG, 21 = PNG, 1 = BMP Raw.

Default value: 28

[Settings]ExportImageColorFormat

Determines the format in which color Laserfiche images are exported. Windows client only.

Valid values:

• Integers. 28 = TIFF with G4 compression, 29 = TIFF with LZW compression, 35 = PDF, 14 = JPEG, 21 = PNG, 1 = BMP Raw.

Default value: 28

[Settings]ExportImageDragColor

Determines whether images that are exported by dragging and dropping will be exported using the format set in [Settings]ExportImageColorFormat. Does not apply to the web client.

Valid values:

• Integers. 1 = Yes, 0 = No.

Default value: 1

[Settings]ExportImagePdfLossless

Determines whether lossless compression will be used when generating a PDF from Laserfiche pages.

Valid values:

• Integers. 1 = Yes, 0 = No.

Default value: 0

[Settings]JPEGCompression

Determines the quality level when exporting Laserfiche pages into JPEG files or into lossy PDFs. HIgher values indicate higher quality and less compression.

Valid values:

• Integers from 1 to 100.

Default value: 75

[Settings]ExportImageMultipageTiff

Determines whether multiple images from a document will be exported together as a multi-page TIFF.

Valid values:

• Integers. 1 = Yes, 0 = No.

Default value: 1

[Settings]ExportImagePdfA

Determines whether a PDF generated from Laserfiche pages will be created in PDF/A-1b format.

Valid values:

• Integers. 1 = Yes, 0 = No.

Default value: 0

[Settings]ExportImageFormat

Specifies the default format for exported images. Web client only.

Valid values:

• Integers. 0 = PDF, 1 = TIFF with G4 compression, 2 = Tiff with JPEG compression, 3 = BMP Raw, 4 = JPEG, 5 = PNG, 6 = Tiff with LZW compression, 7 = Default

Default value: 0

[Settings]PDFSuperCompression

Specifies whether to optimize compression for text on color images when exporting images into a PDF. When this is TRUE, [Settings]ExportImagePdfA, [Settings]ExportImagePdfLossless, and [Settings]JpegPdfCompression will be ignored.

Note: Enabling this may slow the export process and result in a lower quality PDF.

Valid values:

• TRUE/FALSE

Default value: TRUE

[Settings]ExportImageOmitPdfText

If this is TRUE, when exporting a document with text associated with it to a PDF, the PDF will not be given a text stream from the document text. Windows client only.

Valid values:

• TRUE/FALSE

Default value: FALSE

Other Settings for Image Export

[Settings]ExportImagePageNumberLength

Determines the minimum width (in characters) of the page number portion of the exported file's name. For example, if you set this to 2, the files for pages 1-9 will contain a leading space.

Valid values:

• Integers.

Default value: 4

[Settings]ExportImagePagePrefix

Determines the prefix that will be appended before page numbers in exported document names, when exporting a document's pages as individual files. By default, the file names will be the name of the document being exported, followed by the prefix specified in this attribute, followed by the page number, in the form DocumentNamePagePrefixPageNumber.

Valid values:

• String

Default value: , Page

[Settings]MaxImageWriteAttempts

Specifies how many times to retry exporting a page into an image file if the process fails. Failures are usually due to sharing conflicts with Explorer.exe. This applies to the Windows client only.

Valid values:

• Integers

Default value: 100

[HiddenDialogs]IgnoreBadImageExportChecksum

If TRUE, the user is warned when they try to export images with an invalid checksum. They then have the option of aborting the export.

Valid values:

• TRUE/FALSE

Default value: TRUE

[Settings]ConfirmSaveDocument

When the user tries to export a modified document, this attribute determines whether a dialog box pops up asking the user if they would like to save changes to a document before exporting its images. Windows client only.

Valid values:

• TRUE to show dialog box, FALSE to hide.

Default value: TRUE

Annotations and Watermarks

[Settings]ExportImageConvertPDFAnnotations

Specifies whether annotations will be converted into PDF annotations when exporting a document as a PDF.

Valid values:

• Integers. 1 = Yes, 0 = No.

Default value: 1

[Settings]ExportImageIncludeAnnotations

Specifies whether annotations and redactions will be included when exporting images.

Valid values:

• Integers. 1 = Yes, 0 = No.

Default value: 1

[Settings]ExportImageIncludeRedacts

Determines whether redactions are included in exported images.

Valid values:

• TRUE/FALSE

Default value: TRUE

[Settings]ExportTextRedactChar

When exporting document text, determines which character should be used in place of redacted characters.

Valid values:

• String

Default value: X

Settings for Exporting Text

See Annotations and Watermarks for text redaction settings.

[Settings]ExportTextLineBreaks

When exporting document text, determines whether page break characters will be inserted between Laserfiche pages. Applies to the web client only. See [Settings]ExportTextPageBreaks for the Windows client equivalent.

Valid values:

• Integers. 1 = Yes, 0 = No.

Default value: 1

[Settings]ExportTextPageBreaks

When exporting document text, determines whether page break characters will be inserted between Laserfiche pages. Applies to the Windows client only. See [Settings]ExportTextLineBreaks for the web client equivalent.

Valid values:

• TRUE/FALSE

Default value: TRUE

[Settings]ExportTextSingleFile

Specifies whether all text pages will be included in a single file when exporting multiple pages from the same file.

Valid values:

• Integers. 1 = Yes, 0 = No.

Default value: 1

[Settings]ExportTextUnicode

Specifies whether exported text will be formatted with Unicode. Windows client only.

Valid values:

• Integers. 1 = Yes, 0 = No.

Default value: 1

Exporting Folder Contents Lists

These attributes relate to exporting a list of contents of folders, not exporting the actual files in the folder. For attributes related to the latter, see the [Settings]ExportContentsPath and [HiddenDialogs]ConfirmExportFolderContents.

[Settings]ListExportDelimiter

Determines what character is used as a delimiter when exporting the list of contents of a folder.

Valid values:

• Integers. Set to 6 to hide dialog box. Delete attribute to show dialog box.

Default delimiter: Tab

[Settings]ListExportFilter

Determines the default format selected when exporting a list of contents of a folder. Windows client only.

Valid values:

• Integers. 1 = CSV file, 2 = Excel (.xlsx) file.

Default value: 1

[Settings]ListExportDirectory

Determines the default folder to which lists of contents are exported. Windows client only.

Valid values:

• String

[Options]ListExportIncludeSubfolders

Determines whether lists of contents will be exported recursively.

Valid values:

• TRUE/FALSE

Default value: FALSE

[Options]MultiValueFieldDelimiter

When exporting a list of contents, determines which character separates the values of multi-valued fields. Applies to the Windows client only.

Valid values:

• String

Default value: ; (semicolon)

Exporting Other Reports

Besides folder contents list reports, you can also generate reports on metadata, effective access rights for users or entries, and user security properties (e.g. group membership and privileges).

[Settings]ReportMode

Windows client only. Specifies the default type of report to generate. The last type of report the user chose is remembered and stored as the value of this attribute.

Valid values:

• String. "EntryEffectiveRights" = Report on effective access rights of all users, specific users, or groups on the selected entry, "Metadata" = Metadata report, "UserEffectiveRights" = Report on effective access rights of specified user for selected entry and child entries, "UserSecurity" = Report on selected users' security properties.

Default value: Metadata

[Settings]ReportFormat

Determines the file format of the metadata, effective access rights, or user security report. Windows client only.

Valid values:

• String. "excel" = Excel (.xlsx) file, "text" = CSV file.

[Settings]ReportTypeIncludeSubfolders

These attributes determine whether the generated report of the type ReportType includes subfolders of the entry in its report. [Settings]MetadataReportIncludeSubfolders is one of these attributes. Windows client only.

Valid values:

• TRUE/FALSE

Default value: TRUE

Miscellaneous

[Settings]PdfExportUseClientHelper

If TRUE, uses a helper process to export Laserfiche pages into a PDF. If [Settings]PDFSuperCompression is enabled, this defaults to TRUE. Enabling this allows resources to be freed up on the client while the helper process does the computationally intensive work. Applies to the Windows client only.

Valid values:

• TRUE/FALSE

Default value: FALSE

[Settings]ExportDocumentMetadata

If TRUE, the document's metadata is exported as an XML file alongside the electronic document or page contents. Windows client only.

Valid values:

• TRUE/FALSE

Default value: FALSE

[Settings]ExportNameConflictOption

Specifies what happens if the exported file name conflicts with existing files. Windows client only.

Valid values:

• Integers. 0 = Overwrite, 1 = Skip export process, 2 = Automatically rename the file.

Default value: 0

[Settings]LastElectExportPath

Determines the default path for exported electronic files. Windows client only.

Valid values:

• String representing path.

[HiddenDialogs]ConfirmBadEdocExportChecksum

If TRUE, the user is warned when they try to export electronic documents with an invalid checksum. They then have the option of aborting the export. This attribute does not apply to the WIndows client.

Valid values:

• TRUE/FALSE

Default value: The path to the local My Documents folder.

[Settings]OpenExportedFiles

Determines whether exported files are opened immediately. Windows client only.

Valid values:

• TRUE/FALSE

Default value: FALSE

[HiddenDialogs]ConfirmExportFolderContents

Determines whether a confirmation dialog box appears when the user attempts to export the contents of a folder as a zip file. This attribute does not apply to the Windows client.

Valid values:

• Integers. Set to 6 to hide dialog box. Delete attribute to show dialog box.

[Settings]ExportContentsPath

Determines the default path to which the contents of folders (the actual files, not a list of contents) will be exported. Windows client only.

Valid values:

• String representing path

[SETTINGS]PreferEdocOnPDFDownload

Determines whether WebLink will export the original PDF file or generate a PDF based on the Laserfiche pages. When set to true, when a user exports a PDF document with Laserfiche pages that contains no redactions or watermarks, WebLink will deliver the electronic file instead of the Laserfiche pages. Supported in Laserfiche WebLink 11 Update 1 and later.

Valid values:

• TRUE/FALSE