IBM Content Navigator, Version 2.0.3 Supports: Content Manager, FileNet P8, OnDemand, OASIS CMIS

Constructing a URL for IBM Content Navigator

IBM® Content Navigator desktops, features, folders, and documents can be started or opened remotely by sending the user’s browser to a specified URL that includes the item's unique identifier. This capability makes referencing documents and folders in a custom application simple and consistent, even when the source code in IBM Content Navigator is changed.

Before you begin

IBM Content Navigator must be installed and configured.

About this task

You can open IBM Content Navigator on a particular desktop, folder, or document with a URL. For example, you can embed a URL in your custom application to open IBM Content Navigator to a particular document.

You can get URLs for documents or folders when you select the item and click Actions > View link.

Each type of URL opens a different view of IBM Content Navigator:

Desktop URL: Opens to the default pane that is associated with the desktop in the full IBM Content Navigator client.
Feature URL: Opens to a feature that is available on the current desktop that the user is logged in to. Users must be logged in to the desktop that is associated with this feature before they enter the URL to the feature.
Folder URL: Opens the IBM Content Navigator link viewer, which provides a view of a specified folder.
Document URL: Opens the document in the IBM Content Navigator Viewer or the configured default viewer for the MIME type of the document.
Content list view URL: Displays the content list for the Home, Browse, Search, or Teamspace feature in the specified view mode: Details view, Magazine view, or Filmstrip view. If the specified view is not available on the desktop, the Details view is used as the default view.

You can use the URL-based interface to embed a link in the portal of a custom application to a specific document or folder in a specific repository. Review participants can review the contents of the folder or document. For example, you can embed a link on your company-wide intranet to a folder in the repository that contains safety and emergency protocol documents. For a more advanced example, you can create a web application that adds documents to a repository, records the docid value, and generates the docid value as a confirmation number. The docid value can then be used in the URL syntax to create a valid link to the document.

Procedure

To construct a URL for IBM Content Navigator desktops, documents, or folders:

Insert the following base URL into the application:
Desktops and Features
```
http://server:port/context_root/?
```
Folders and Documents
```
http://server:port/context_root/bookmark.jsp?
```
After you enter the base URL, use the question mark (?) before you append any parameters.

Append the appropriate parameters to the URL.

Separate each parameter-value pair with an ampersand (&).

The following lists describe the parameters that you can append to the URL, the appropriate format, and valid values for each parameter.

Logging in to a specific desktop

Table 1. Valid parameters and values for viewing the default pane on a desktop.
Parameters	Values
desktop	Specifies which desktop to log in to. Specify the ID that is displayed for the desktop in the ID column on the Desktops tab in the administration tool. Format: desktop=`desktop_ID`

Example: http://myserver.mycompany.com:9080/navigator/?desktop=AccountsPayable

Logging in to a feature on a specified desktop

To log in to a feature on a desktop, you use the feature parameter. The feature parameter specifies a feature to access on a desktop. Specify the value to display in the tooltip when you hover over a row for the feature name in the Displayed features table on the Appearance tab in the administration tool. To access a feature on a desktop, the feature must be available in the desktop layout, which is configured on the Layout tab for a desktop.

You create custom features by creating plug-ins. The ID and values for custom features must be specified by the creator of the plug-in.

The following features are available with IBM Content Navigator:

Table 2. Valid values for a feature parameter on the current desktop.
Features	Values
Favorites	favorites
Browse	browsePane
Search	searchPane
Work	workPane
Teamspace	manageTeamspaces
Sample feature	sampleFeature The Sample feature is available with the Sample Plugin plug-in.
Analyze content	icaPane The Analyze content feature is available with the IBM Watson Content Analytics plug-in.

Format: feature=feature_value

Example: http://myserver.mycompany.com:9080/navigator/?desktop=AccountsPayable&feature=manageTeamspaces

Display the content list for the Favorites, Browse, Search, or Teamspace feature in the specified view mode by appending the defaultListView parameter to the feature URL:

Table 3. Valid values for displaying the content list in a specific view mode for the feature URL.
Views	Values
Details	viewDetails
Magazine	viewMagazine
Filmstrip	viewFilmStrip

Format: defaultListView=content_list_view_value

If the specified view is not available on the desktop, the Details view is used as the default view.

Example: http://myserver.mycompany.com:9080/navigator/?desktop=AccountsPayable&feature=manageTeamspaces&defaultListView=viewMagazine

You can hide the banner or the sidebar by appending the sideChrome parameter to the feature URL:

Important: The following parameters are part of the layout widget, ecm.widget.layout.NavigatorMainLayout. If you specify a different layout for the web application, this function is not available.

Table 4. Valid values for hiding desktop features for the feature URL.
Layout modifications	Values
Hide the banner and side bar.	0
Hide the banner only.	1
Hide the sidebar only.	2

Format: sideChrome=side_chrome_value

Example: http://myserver.mycompany.com:9080/navigator/?desktop=AccountsPayable&feature=manageTeamspaces&sideChrome=2

Viewing documents

Use the following parameters to identify the document to view:

Table 5. Valid parameters and values for viewing documents.
Parameters	Values
desktop	Specifies which desktop to log in to. Specify the ID that is displayed for the desktop in the ID column on the Desktops tab in the administration tool. Format: desktop=`desktop_ID`
repositoryId	Specifies the server to log in to. Specify the ID that is displayed for the server in the ID column on the Repositories tab in the administration tool. Format: repositoryId=`repository_ID`
docid	The system-generated identification number for the document. Uses the template_name value as the prefix to this folder ID. Format: docid=`document_ID`
template_name	`Document`, `Folder`, or the name of the custom document class or item type. Format: template_name=`template_name`
version	current, released, or a specific version number. Format: version=`version_number`
vsld	The IBM FileNet® P8 version series object, which is the Globally Unique Identifier (GUID), that is associated with the document. Format: vsld=`GUID_number`

Example: http://myserver.mycompany.com:9080/navigator/bookmark.jsp?desktop=AccountsPayable&repositoryId=AP_P8_System&docid=30dd879c-ee2f-11db-8314-0800200c9a66&template_name=APtemplate&version=released

Viewing folders

Use the following parameters to identify the folder to view:

Table 6. Valid parameters and values for viewing folders.
Parameters	Values
desktop	Specifies which desktop to log in to. Specify the ID that is displayed for the desktop in the ID column on the Desktops tab in the administration tool. Format: desktop=`desktop_ID`
repositoryId	Specifies the server to log in to. Specify the ID that is displayed for the server in the ID column on the Repositories tab in the administration tool. Format: repositoryId=`repository_ID`
docid	The system-generated identification number for the document. Uses the template_name value as the prefix to this folder ID. Format: docid=`document_ID`
template_name	`Document`, `Folder`, or the name of the custom document class or item type. Format: template_name=`template_name`

Example: http://myserver.mycompany.com:9080/navigator/bookmark.jsp?desktop=AccountsPayable&repositoryId=CM_System&docid=30dd879c-ee2f-11db-8314-0800200c9a66&template_name=CHEMtemplate