Parameters for .lfe Shortcuts

This parameter specifies the Laserfiche repository that will be opened when the Laserfiche Windows client is launched.

Example: <repository name='MyRepository'>

This parameter indicates that you want to use Windows authentication to authenticate to the specified Laserfiche repository. Valid values are 'y' (yes) or 'n' (no).

Example: <repository name='MyRepository' domainauth='y'>

This parameter specifies the entry ID of the entry that will be automatically opened when the Laserfiche Windows client is launched. This parameter applies to both folders and documents, and the syntax is the same. The entry ID of a particular document or folder can be viewed either from the Entry ID column in the folder browser or by viewing the General tab of the Document/Folder Properties dialog box.

Example: <entry id='55' />

If the entry is a folder, setting this parameter to 'y' (yes) will cause the specified folder to display as the root folder. Setting it to 'n' (no) will cause the entire folder tree to be displayed, with the specified folder selected. If the parameter is not set, the default value is 'y'. This parameter will be ignored if the specified is a document.

Example: <entry id='55' makeroot='n' />

If the entry is a document, setting this parameter will cause the document to open to a particular page. The first page of the document is considered to be at position '0'. Therefore, to link to the first page, specify '0'. To link to the second page, specify '1'. To link to the fifth page, specify '4', and so on. This parameter will be ignored if the entry is a folder.

Example: <entry id='60' page='4' />

If the entry is a document, setting this parameter will cause the document to open to a particular version, by version number. The document will be read-only. This parameter will be ignored if the specified entry is a folder. This option was introduced in Laserfiche 9.0.1.

Example: <entry id='60' version='2' />

If the entry is a document, setting this parameter will cause the document to open in a particular way. For instance, you choose to open a document in the metadata view, the document viewer, or, if it is an electronic document, in its native application. If this parameter is not set, the Laserfiche Windows client default settings will be followed. This parameter will be ignored if the entry is a folder.

The possible modes are specified by number:

• 0: Opens the metadata dialog for the specified document.
• 1: Opens the specified document in the document viewer.
• 2: Opens the specified document in its native application, if it is an electronic document. This mode should not be used with imaged documents.
• 3: Opens the specified document in its native application in read-only mode, if it is an electronic document. This mode should not be used with imaged documents.
• 4: Opens the business process history for the specified document.

Example: <entry id='60' mode='2' />

If the entry is a document and you have also specified that it should be opened in mode 4 (business process history), setting this parameter will open the business process dialog to the specified Business Process Entity ID. This parameter will be ignored if the entry is a folder.

Example: <entry id='60' mode='4' bpeid='10' />

If the entry is a document, setting this parameter to 'y' (yes) will cause the target document to be checked out when it is opened. (Since checkout cannot be performed on imaged documents unless they are under version control, if this parameter is used with an imaged document that is not under version control, the user will be prompted to first place it under version control.) This parameter will be ignored if the entry is a folder.This option was introduced in Laserfiche 9.0.1.

The checkout parameter supports the following additional parameters:

• versioncomment: Specifies a version comment to be saved on the document before it is checked out. If the document is an electronic document that is not under version control, this parameter will be ignored. If this parameter is not set, no version comments will be added.
• localcheckoutpath: Specifies the path on your computer at which the local copy of the electronic document will be saved. This option will be ignored if the document is an imaged document. If this parameter is not set, the default location will be used.

Example: <entry id='60' checkout='y' />

Example: <entry id='60' checkout='y' localcheckoutpath='C:\Documents\Local Copies' />

Example: <entry id='60' checkout='y' versioncomment='This document has been checked out for review.' />

If the entry is a document, setting this parameter to 'y' (yes) will cause the target document to be checked in when the shortcut is opened. (The document itself will not be opened.) If it is not currently checked out by the user who opens the link, this parameter will be ignored. This parameter will also be ignored if the entry is a folder. This option was introduced in Laserfiche 9.0.1.

The checkin parameter supports the following additional parameters:

• showcheckindialog: Setting this parameter to 'n' (no) will skip the check-in dialog. If this parameter is not set (or is set to 'y'), the check-in dialog box will display normally.
• versioncomment: Specifies a version comment to be saved on the document when it is checked in. If showcheckindialog is not set, or is set to 'y', the user can still manually type a comment.
• edoccheckinoption: If the document is an electronic document not under version control, this parameter specifies the way the document will be checked in. (If it is an imaged document, or an electronic document under version control, this parameter will be ignored.) The possible check-in methods are as follows:
• newlink: Checks in the changes as a new document in the same link group.
• checkin: Enables version control for the document and checks in the changes as a new version.
• newdocument: Checks in the changes as a new document.
• overwrite: Checks in the changes in place and overwrites the original document.

Example: <entry id='60' checkin='y' edoccheckinoption='checkin' />

Example: <entry id='60' checkin='y' showcheckindialog='n' versioncomment='Checked in following final review' />

This parameter specifies the advanced search that should be performed when the Laserfiche Windows client is launched.

Example: <search phrase='{[Human Resources]:[Status]=&quot;Waiting for Approval&quot;}' />