Configuring deep links to attached objects

In the the Web App interface of v10, deep links can be configured to quickly access documents, employee forms or employee reports attached to process grids from anywhere in the application. This article describes the procedures to be followed in order to configure a deep link to an object attached to a grid.

Creating the URL of the deep link

The first step in the configuration consists in creating a URL which will be used to redirect users to the attached object. The parameters defined in the URL will allow access to a specific hierarchy node to which the object is attached and define a specific page layout.

The following tables reference the general and optional parameters that can be configured in the URL of the deep link.

General parameters

The parameters outlined in the following table need to be retrieved from various database tables to correctly generate the URL of the deep link.

Attached object deep link configuration parameters

Parameter	Description	Database Table
Hierarchy ID	Identifier of the selected process hierarchy	hm_nodetreepublished
Node ID	Identifier of the selected node in the hierarchy	hm_nodelinkpublished
Hierarchy Security ID	Identifier of the hierarchy security (if applied)	k_tree_security
Item Type	Node item type of the selected hierarchy (ex: 14 = payee)	hm_nodelinkpublished
Item ID	Identifier of the selected item in the hierarchy	hm_nodelinkpublished
Plan ID	Identifier of the selected process	k_m_plans
Plan UID	Unique Identifier of the selected process	k_m_plans uid_object
Step ID	Identifier of the selected employee step in the grid	k_m_plans_payees_steps
Attached Object UID	For forms and reports: unique identifier of the attached object For documents: document keyword will open a document	Catalog database obj.bqm_object

In order to retrieve the Attached Object UID, use the following Gateway API method: /api/objects/{planUID}/relation. This method returns the list of attached objects with their unique identifier.

Optional parameters

The following optional parameters enable you to reorganize the page layout when the user is redirected to the attached object page.

Redirection page layout parameters

Parameter	Description	Default Value
hierarchyCollapsed	Set this parameter to true to have the hierarchy tree panel collapsed	false
attachedObjectHorizontal	Set this parameter to false to have the attached object panel displayed vertically	true
attachedObjectFullScreen	Set this parameter to false to have the attached object displayed in full screen mode	false
hideBottomBar	Set this parameter to true to have the bottom bar (Export, Import and Save buttons) hidden	false

URL format

The URL format slightly differs depending on the type of attached object:

• Employee forms and reports (SSRS and Advanced Analytics):

  • 1 /processes

  • 2 /hierarchy/{Hierarchy ID}

  • 3 /node/{Node ID}-{Hierarchy Security ID}-{Item Type}-{Item ID}

  • 4 /plan/{Plan ID}-{Plan UID}

  • 5 /employee/{Step ID}

  • 6 /attach/{Attached Object UID}

  • 7 ? hierarchyCollapsed= false/true &

  • 8 attachedObjectHorizontal= false/true &

  • 9 attachedObjectFullScreen= false/true &

  • 10 hideBottomBar= false/true

• Documents:

  • 1 /processes

  • 2 /hierarchy/{Hierarchy ID}

  • 3 /node/{Node ID}-{Hierarchy Security ID}-{Item Type}-{Item ID}

  • 4 /plan/{Plan ID}-{Plan UID}

  • 5 /employee/{Step ID}

  • 6 /document

  • 7 ? hierarchyCollapsed= false/true &

  • 8 attachedObjectHorizontal= false/true &

  • 9 attachedObjectFullScreen= false/true &

  • 10 hideBottomBar= false/true

Deeplink display modes in the application

Deeplink mode

If the Step ID parameter is specified in the URL, the attached object will be opened in deep link mode. In deep link display mode, the following process grid elements and features are hidden from the user:

• Process view

• Budget widget

• Filter tool

• Grouping tool

• Sorting tool

• Column visibility tool

• Row density selector

• Summary and group summary columns

• Column sort option when clicking Columns

• Export and Import buttons

Attached object in deep link mode

This is a tip message.

In deep link display mode, the following actions are still available:

• Edit the data in the process grid

• Access the individual planner (if allowed)

• Save the process grid

• Edit attached forms

• Save attached forms

• Upload/download documents

Grid mode

The grid mode is the current process grid display. If the Step ID parameter is not specified in the URL of the deep link, the grid mode is used to display the attached object.

The following actions will switch the attached object display from deep link mode to grid mode:

• Select another node in the hierarchy

• Select another hierarchy

• Select another process

• Click the Load Full Grid button

Adding the URL of the deep link to the application

The last step is to add the deep link URL in the relevant location in the application where you want the deep link to be displayed.

This is an attention message.

Text hereThe location in the application must support HTML content. For more information about the insertion of the deep link, refer to Using the profile switching feature with deep links.

Error handling

In certain circumstances, the application might fail to retrieve one or several parameters contained in the URL. In that case, users can be presented with the following error scenarios:

• The provided Node ID is not found. The application will return INF_Error_HierarchyNodeNotFound error.

• The provided Step ID is not found. The application will return the INF_Error_EmployeeStepNotFound error.

• The provided Attached Object UID is not found. The application will return the INF_Error_AttachedObjectNotFound error.