Metadata

In Laserfiche, metadata includes fields, templates, tags, document relationships, link groups, versions, and signatures. See the Watermarks page for watermark-related attributes, and the Annotations page for annotation-related attributes.

In addition to metadata properties, this page also covers the display properties of the Metadata Pane and Metadata dialog box.

Tabs and Columns in the Metadata Pane or Dialog Box

These properties apply to the Metadata Pane or dialog box, whether accessed from the folder browser or the document viewer.

[DocFrame]ShowTagsTab

Determines whether the tags tab will be included in the Metadata dialog box or Pane. Windows client only.

Valid values:

  • TRUE/FALSE

Default value: TRUE

[DocFrame]ShowLinksTab

Determines whether the links tab will be included in the Metadata dialog box or Pane. Windows client only.

Valid values:

  • TRUE/FALSE

Default value: TRUE

[DocFrame]ShowFieldsTab

Determines whether the fields tab will be included in the Metadata dialog box or Pane. Windows client only.

Valid values:

  • TRUE/FALSE

Default value: TRUE

[DocFrame]ShowVersionHistoryTab

Specifies whether to include the version history tab in the Metadata dialog box or Pane. Windows client only.

Valid values:

  • TRUE/FALSE

Default value: TRUE

[DocFrame]ShowDigitalSignatureTab

Determines whether to include the digital signature tab in the Metadata dialog box or Pane. This is the same setting as the Digital Signatures checkbox in Tools → Options → View → Layout. Windows client only.

Valid values:

  • TRUE/FALSE

Default value: TRUE

[Settings]DefaultViewWithinLinkTab

Determines what the default view is within the links tab. Web client only.

Valid values:

  • Integers. 0 = Document relationships, 1 = Link groups.

Default value: 0

[Settings]MetadataDialogStartTab

Determines which tab of the Metadata dialog box to display first.

Valid values:

  • Integers. 2 = Fields tab, 16 = Tags tab, 32 = Links tab, 128 = Versions tab, 512 = Signatures tab.

Default value: The tab that was last used.

[Settings]MetadataTypeColumnOrder

These attributes determine how columns are ordered in the tabs of the Metadata Pane or dialog box. Since each tab corresponds to a metadata type, the attributes are named differently for each metadata type. For example, a user may drag the columns in the Links tab so that the "Comments" column comes before the "Path" column. This will then change the attribute [Settings]LinkColumnOrder.

Valid values:

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

Signatures

[Settings]SignExistingSignatures

This is the same setting as Countersign existing signature(s) in theSign Document dialog box.

Valid values:

  • TRUE/FALSE

Default value: FALSE

[Settings]DeleteSignature

Determines whether the user encounters a prompt asking them to confirm deletion when they attempt to delete a signature. Web client only.

Valid values:

  • Integers. Set to 6 to disable the prompt. Delete the attribute to enable the prompt.

Default value:

[Settings]RemoveExistingSignatures

Determines whether to remove existing signatures from the same user before signing the document.

Valid values:

  • TRUE/FALSE

Default value: FALSE

[HiddenDialogs]DigitalSignatureReportStyle

Determines whether the dialog box asking the user which format to save a signature report in (see [Settings]CreateReportOptionsStyle and [Settings]DigitalSignatureReportFormat) appears.

Valid values:

  • TRUE = Hide dialog, FALSE = Show dialog

Default value: FALSE

[Settings]CreateReportOptionsStyle

Determines the default format in which to save a signature report. Windows client only.

Valid values:

  • Integers. 0 = HTML, 1 = CSV.

Default value: 0

[Settings]DigitalSignatureReportFormat

Determines the default format in which to save a signature report. Web client only.

Valid values:

  • String indicating format. Valid options are "HTML", "Text (CSV)", and "EXCEL".

Default format: HTML

[Settings]SignOnImport

Determines whether documents are signed upon import. This is the same setting as Sign documents on import in Options → New Documents → General.

Valid values:

  • TRUE/FALSE

Default value: FALSE

[Options]SigningImageDirectory

Specifies the last directory from which the user's signing image was selected.

Valid values:

  • String representing directory path.

[Settings]SigningImage

Specifies the default image used to sign imported documents. Web client only.

Valid values:

  • String representing path to image file.

[Signing]LastCertificateThumbprint

Specifies the thumbprint of the last signing certificate used in the Windows client. Not applicable to the web client.

Valid values:

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

[Settings]SigningCertificateThumbprint

Specifies the thumbprint of the default certificate for signing documents upon import in the web client. Not applicable to the Windows client.

Valid values:

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

[Signing]ImportCertificateThumbprint

Specifies the thumbprint of the default certificate for signing documents upon import in the Windows client. Not applicable to the web client.

Valid values:

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

[Signing]ImportComment

Specifies the default signature comment when signing upon import is configured. Windows client only.

Valid values:

  • String

[Signing]ImportImageData

Contains the Base64-encoded image data for the default image for signing upon import. Windows client only.

Valid values:

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

[Signing]LastImageData

Specifies the signing image used for the user's most recent signing.

Valid values:

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

[Settings]UseDefaultImportSignature

This is the same setting as Use default signature in Options → New Documents → General.

Valid values:

  • TRUE/FALSE

Default value: FALSE

[Settings]EnforceNSASuiteB

If TRUE, ensures that signatures applied to documents use algorithms in NSA Suite B.

Valid values:

  • TRUE/FALSE

Default value: FALSE

[HiddenDialogs]DeleteCountersignedSignature

Determines whether a confirmation dialog box appears when users try to delete countersigned signatures.

Valid values:

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

[HiddenDialogs]ConfirmDeleteCertificate

Determines whether a confirmation dialog box appears when the user tries to delete a signing certificate. Applies only to the web client.

Valid values:

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

Versioning

[Settings]VersionCommentDontAskAgain

When TRUE, a "Don't ask me again" checkbox is enabled on the dialog box that asks users if they want to add comments to a new version of a document. Windows client only.

Valid values:

  • TRUE/FALSE

Default value: FALSE

[Settings]VersionTrackingApplySubfolders

This is the same setting as the Apply to all subfolders checkbox in the Start Tracking Versions dialog box. Windows client only.

Valid values:

  • TRUE/FALSE

Default value: FALSE

[Settings]VersionTrackingEnableOpenDoc

If TRUE, opens the document for editing immediately when the user enables version control on the document. This is the same setting that is enabled when the user selects Open the document for editing immediately in the Start Tracking Versions dialog box.

This setting does not apply to the web client.

Valid values:

  • TRUE/FALSE

Default value: TRUE

[HiddenDialogs]WarnVersionDeleteNoSave

Determines whether a confirmation dialog box appears when the user tries to delete a version of a document in the Versions tab. Web client only.

Valid values:

  • Integers. 6 = Hide the dialog. Delete the attribute to bring back the dialog.

Default behavior: Dialog box appears.

[HiddenDialogs]WarnVersionRevertNoSave

Determines whether a confirmation dialog box appears when the user tries to revert to a previous version of the document in the versions tab. Web client only.

Valid values:

  • Integers. 6 = Hide the dialog. Delete the attribute to bring back the dialog.

Default behavior: Dialog box appears.

[HiddenDialogs]ConfirmStartTrackVersions

Determines whether a confirmation dialog box appears when the user enables version tracking on a document. Windows client only.

Valid values:

  • TRUE to hide dialog box, FALSE to show dialog box.

Default value: FALSE

Others

[Settings]CacheFieldValues

If this is TRUE, list fields and dynamic fields will be cached, so that they will be retrieved only once per client instance. This attribute is not supported in Laserfiche Scanning.

Valid values:

  • TRUE/FALSE

Default value: FALSE

[Settings]MaxDropDownLength

Specifies the maximum number of possible values for a list field that can be displayed in a drop-down menu. List fields longer than the limit will no longer display until you enter enough characters to decrease the number of options to be not more than the maximum. This attribute is not supported in Laserfiche Scanning.

Valid values:

  • Integer

[Settings]MetadataTokenParsed

If TRUE, displays all tokens in the metadata that can be immediately parsed. This is the same action as clicking Display parsed token in the token menu.

This attribute applies to the Windows client only.

Valid values:

  • TRUE/FALSE

Default value: FALSE

[Settings]QPList_fieldname

Inserts a quick pick list for the field fieldname. Windows client only.

Valid values:

  • String. Semicolon-delimited list of options.

[Settings]QPList_Count

Determines the maximum number of quick pick options in a list field. Set this to 0 to turn off quick pick lists altogether. Windows client only.

Valid values:

  • Integer

Default value: 3

[Settings]NewFolderTemplateName

Determines the default template for new folders. Windows client only.

Valid values:

  • String (template name)

[Settings]MetadataShowTokenPicker

If FALSE, hides the token button () that appears next to fields in the Metadata dialog box or Metadata Pane.

Valid values:

  • TRUE/FALSE

Default value: TRUE

[WebAccess]ReducePaddingMetadataPane

If TRUE, reduces the blank space between fields in the web client's metadata pane. This is the same setting as Compress field display in Options → Display.

Valid values:

  • TRUE/FALSE

Default value: FALSE

[HiddenDialogs]ConfirmRelationshipDelete

If TRUE, a confirmation dialog box will appear when the user tries to remove a relationship between documents. Web client only.

Valid values:

  • TRUE/FALSE

Default value: FALSE

[HiddenDialogs]ConfirmDeleteTag

Determines whether a confirmation dialog box appears when the user attempts to delete a tag. Web client only.

Valid values:

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

[HiddenDialogs]ConfirmSecureTag

Determines whether a confirmation dialog box appears when the user decides to convert an informational tag into a security tag. Web client only.

Valid values:

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

[HiddenDialogs]ConfirmDeleteLink

Determines whether a confirmation dialog box appears when the user attempts to delete a type of document link. Web client only.

Valid values:

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

[HiddenDialogs]ConfirmVersionDelete

Determines whether a confirmation dialog box appears when the user attempts to delete a document in a link group. Web client only.

Valid values:

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

[HiddenDialogs]ConfirmDiscardListInfo

Determines whether a confirmation dialog box appears when the user attempts to change the type of the field. Web client only.

Valid values:

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

[HiddenDialogs]ConfirmFieldWidthChangeInfo

Determines whether a confirmation dialog box appears when a user attempts to alter the width of a field. Web client only.

Valid values:

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

[Settings]MaxDynamicFieldResults

Determines the maximum number of possible values available for selection in a child dynamic field. Web client only.

Valid values:

  • Integers

[HiddenDialogs]ConfirmDeleteField

Determines whether a confirmation dialog box appears when a user attempts to delete a field. Web client only.

Valid values:

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