Web Client URLs

You can use URLs to navigate to entries or search results in the Laserfiche web client, to determine how content is displayed, and to perform actions on entries.

Note: The following syntax assumes that the Laserfiche web client is communicating using SSL. If this is not the case, replace https:// in the URL with http://

Base URL

The base URL for the Laserfiche web client takes the following form:

where ServerName is the name of your Laserfiche web client server computer, or of your domain. All URL options build on this base URL.

Open to a Specific Folder

You can create a link that will open the Laserfiche web client directly to a specific folder. To do so, use the following URL:

where dbName is the name of your repository and EntryID is the entry ID of the folder. You can find the entry ID in the Laserfiche web client in the Metadata tab of the details pane, under Show advanced. This URL can also be obtained by navigating to the folder and opening it in the Laserfiche web client, then copying the URL from the address bar.

You can also choose to show the specified folder as the root of the repository. Folders other than the specified folders and its children will not be displayed in the folder tree. To do so, use the following URL:

Note that the new root URL option will only take effect if the link is used when the user is logged out; it will not take effect if used while a user is logged in.

Open to a Document in the Document Viewer

You can create a link that will open the Laserfiche web client directly to a specific document. To do so, use the following URL:

where dbName is the name of your repository and EntryID is the entry ID of the document. You can find the entry ID in the Laserfiche web client in the Metadata tab of the details pane, under Show advanced. This URL can also be obtained by navigating to the document and opening it in the Laserfiche web client, then copying the URL from the address bar.

Note: While this syntax can be used on documents of any type, only imaged documents and PDFs will display the document content in the document viewer. Electronic documents will display document metadata only. To open the electronic file portion of an electronic document using a URL, see Opening an Electronic File, below.

When opening a document in the document viewer, you can also use the following options:

For information about manually checking out a document for editing using a URL, see Perform Check Out and Check In Operations, below.

Open to a Set of Search Results

You can create a link that will automatically launch a search when the Laserfiche web client opens and display the search results. To do so, use the following URL:

where dbName is the name of your repository and SearchSyntax is the search syntax of the search you want to perform. Note that if your search syntax string contains characters that are not valid in a URL (which is true of most search syntax strings), you will need to replace them with the appropriate URL encoding.. In most cases, rather than do this manually, you should perform the search in the Laserfiche web client, then use the Copy Search URL option to get the full search URL.

If the search has only one result, you can specify that it should open that document or folder automatically, rather than opening the search results. (If there are more than one result, the search results will be opened instead.) To do so, use the following URL:

To open a saved search, use the following URL:

where SavedSearchName is the name of the saved search. Note that if your saved search name contains characters that are not valid in a URL, you will need to replace them with the appropriate URL encoding.

Open in a View Mode

The Laserfiche web client supports responsive view modes, displaying content optimized for the size of the screen or device on which it's being viewed. Using a custom URL, you can specify the view mode that the page will be opened in. This is particularly useful for integrations and when displaying the Laserfiche web client in an iframe.

There are several view modes available. Small, medium, and large view modes correspond to the way the Laserfiche web client is displayed in browser windows of various sizes. (Large view mode is the default when viewing the Laserfiche web client in most browsers.) Phone view mode is optimized for phones, and embedded view mode is optimized for embedding the Laserfiche web client in an iframe.

Note that the view mode URL options will only take effect if the link is used when the user is logged out; it will not take effect if used while a user is logged in. Descriptions for the view modes are noted below:

Document Viewer

Folder Browser

 

View mode options can be combined with other URL options by appending an ampersand and then the option at the end of the URL.

Open Documents in the Same Tab as the Folder Browser

By default, the Laserfiche web client opens documents in the document viewer in a new tab. You can use a URL option to instead force the Laserfiche web client to open documents in the same tab as the folder browser. This is particularly useful for embedding the Laserfiche web client in an iframe.

To do so, use the following URL:

where dbName is the name of your repository. Note that this URL option will only take effect if the link is used when the user is logged out; it will not take effect if used while a user is logged in.

View mode options can be combined with other URL options by appending an ampersand and then the option at the end of the URL.

Open an Electronic File

You can create a link that will open directly to the electronic file portion of an electronic document. Since electronic files cannot be viewed in the document viewer, there are two ways that users can open these documents. If an electronic file is a Microsoft Office file type (Word document, Excel spreadsheet, PowerPoint slide deck, or Outlook message), you can create a link that will open the document directly using the Office Integration, or you can create a link that will download it. (If you choose to open it directly, the user can then choose whether to open it for editing or for viewing only.) If an electronic file is not a Microsoft Office file type, you can either create a link that will download the document, or, if it is an audio or video file, you can create a link that will stream it directly in the browser.

For information about manually checking out a document for editing using a URL, see Perform Check Out and Check In Operations, below.

Microsoft Office Documents

There are two ways to open a Microsoft Office document using a URL: you can open it directly using Office Integration, which will allow you to view and modify the document and its metadata in the Office application and then save the changes directly back to Laserfiche, or you can download it. If you choose to open it in Office Integration, you will be prompted to decide whether you want to open it for editing (which will check it out) or purely for viewing.

Other Electronic Document Types

Electronic documents that are not Microsoft Office documents can be either downloaded or, if they are audio or media files, streamed directly in the browser.

Open to a Quick Access View

The Laserfiche web client provides users easy access to certain categories of documents using quick access views. These include Starred, Documents in Use, Recently Opened Documents, Records Management views, and the Recycle Bin. You can create a URL to link a user directly to a quick access view.

Perform Check Out and Check In Operations

You can create a link that will automatically check the specified document out, or check it back in.

Checking Out a Document

There are three ways to check out a document: you can check out an imaged document if it is under version control, you can manually check out any type of electronic document, or you can use the automatic check out feature of Office Integration to check out a Microsoft Office document type. When you create one of the links below, if a user follows the link, the document will be checked out and opened for them.

Checking In an Imaged Document

You can create a URL that will automatically check in an imaged document that is checked out. This is useful if you want to prompt a user to save their changes so that they can be seen by other users, and so that the document is available for editing by other users. To do so, use the following URL:

You can also use the following check in options:

Checking In an Electronic Document

You can create a URL that will automatically check in an electronic document that is checked out. This is useful if you want to prompt a user to save their changes so that they can be seen by other users, and so that the document is available for editing by other users. To do so, use the following URLs:

Launch Web Scanning

You can create a URL that will automatically launch Laserfiche Scanning. For more information, see Launching Web Scanning with a Custom URL.