Imaged Document URLs

By default, the URL for an imaged document has the following structure:

• http://servername/laserfiche/index.aspx?db=repositoryname#id=id;view=pages
  • servername = the name of the server where Web Access is installed
  • repositoryname = Laserfiche Repository
  • id = Entry ID.

Note: To retrieve a document's entry ID, right-click on the document, select Properties, and look next to Entry ID under the General tab.

The portion of the URL before the # is processed by the Web Access Server while the portion after # is processed by the browser.

Note: If you modify the URL syntax, ensure you adjust the syntax to be compatible with URLs.

Customizing Imaged Document URLs

In the above example, the sample URL ends with view=pages. This option specifies that Web Access should display the pages of a document. The view parameter supports additional options to control how you want to view a document or folder. See the following examples:

• view=browse: show a folder in the browse view
  • http://servername/laserfiche/index.aspx?db=repositoryname#id=id;view=browse
• view=metadata: show an entry in the Metadata Viewer
  • http://servername/laserfiche/index.aspx?db=repositoryname#id=id;view=metadata
• view=metadata;type=tags: show an entry in the Metadata Viewer with the tags tab open
  • http://servername/laserfiche/index.aspx?db=repositoryname#id=id;view=metadata;type=tags
• view=metadata;type=links: show an entry in the Metadata Viewer with the links tab open
  • http://servername/laserfiche/index.aspx?db=repositoryname#id=id;view=metadata;type=links
• view=metadata;type=versioncontrol: show an entry in the Metadata Viewer with the versions tab open
  • http://servername/laserfiche/index.aspx?db=repositoryname#id=id;view=metadata;type=versioncontrol
• view=metadata;type=digitalsignatures: show an entry in the Metadata Viewer with the digital signatures tab open
  • http://servername/laserfiche/index.aspx?db=repositoryname#id=id;view=metadata;type=digitalsignatures
• view=pages: show a document in the Document Viewer
  • http://servername/laserfiche/index.aspx?db=repositoryname#id=id;view=pages
• view=pages;version=versionnumber: show a specific version of a version controlled document
  • http://servername/laserfiche/index.aspx?db=repositoryname#id=id;view=pages;version=7
• view=pages;page=pagenumber: show a specific page in a document
  • http://servername/laserfiche/index.aspx?db=repositoryname#id=id;view=pages;page=10
• view=newroot: show a folder as the root in the browse view
  • http://servername/laserfiche/index.aspx?db=repositoryname#id=id;view=newroot
• view=pages;page=pagenumber;annotation=annotationID: show a document with an annotation in focus
  • http://servername/laserfiche/index.aspx?db=repositoryname#id=id;view=pages;page=4;annotation=2

Tip: You can use your Web browser to obtain the ID for a particular annotation.

To obtain the annotation ID number using Internet Explorer

1. Open the document in the Document Viewer, right-click the annotation, and select Properties.
2. Right-click anywhere in the Properties dialog box and select Properties again.
3. Next to Address: (URL), look in the URL for i=. The number following the equal sign is the annotation ID. You may have to highlight the URL and scroll over or down to see the whole URL.

To obtain the annotation ID number using Firefox

1. Open the document in the Document Viewer, right-click the annotation, and select Properties.
2. Right-click anywhere in the Properties dialog box, point to This Frame and select View Frame Info.
3. Next to Address: look in the URL for i=. The number following the equal sign is the annotation ID. You may have to highlight the URL and scroll over or down to see the whole URL.

You can use additional identifiers with imaged document URLs. The action parameter allows you to check in or check out an imaged document via a URL.

• action=Checkout checks out an imaged document.
  • http://servername/laserfiche/index.aspx?db=repositoryname#id=id;action=Checkout

When checking in a document via a URL, you can specify the check in comment and whether to show the Check In dialog box.

• action=Checkin;versioncomment=comment checks in a document and specifies the check in comment.
  • http://servername/laserfiche/index.aspx?db=repositoryname#id=id;action=Checkin;versioncomment=Updated the document
• action=Checkin;showcheckindialog=n checks in a document without showing the Check In dialog box.
  • http://servername/laserfiche/index.aspx?db=repositoryname#id=id;action=Checkin;showcheckindialog=n

These parameters can be combined in a link. For example, you could create a URL that checks an imaged document, specifies a check in comment, and skips the Check In dialog box.

• http://servername/laserfiche/index.aspx?db=repositoryname#id=id;action=Checkin;versioncomment=comment;showcheckindialog=n

Related Topics