Deep Linking

+ More

Table of Contents

How to Use Deep Linking View Options description Edit Object URL pattern Edit Object Preview Object Open Wizard URL pattern Global Search

How to Use Deep Linking

View Options description

view-options is a URL parameter that is used to configure.

It has the following structure:

{
    "embedded": boolean, // optional, default is false, if true - do not show header and navigation
    "dialogId": guid, // optional, id of a dialog to use, if not set - default dialog will be taken
    "objectId": guid, // optional, id of the context object
    "archived": 0 or 1, // if 1 - intended object is archived
    "type": string, // Entity type name   
    "viewType": "new" or "preview" or "action" or "edit", // new = open create dialog, edit = open edit dialog, preview = open preview, action = run action/wizard
    "actionId": guid, // optional, if viewType is action this specifies an action to be called
    "viewId": guid, // optional, if set - show only specified dialog page
}

Common URL pattern

<HOST>/wm/app-<App Name>/?view-options=<View Options>

Edit Object URL pattern

Example demonstrates how to open create new incident dialog in Service Desk, without a header and navigation, with prefilled User and Subject 

https://wmpreview03.imagoverum.com/wm/app-ServiceDesk/?view-options={"embedded":true,"dialogId":"be4ceef2-aadf-ca41-a130-08d46543427a","type":"SPSActivityTypeTicket","viewId":"0944d5ed-bc62-f8f6-7187-f6800a3bcb2b","viewType":"new"}&presetParams={"SPSActivityClassBase":{"Subject":"SUBBBBBJECT!!!!","Initiator":"af72bbed-3d28-e811-719c-d850e6420719"}}

Example demonstrates how to open the create new incident in Service Desk without a header and navigation, and with a single dialog tab shown: 

https://wmpreview03.imagoverum.com/wm/app-ServiceDesk/?view-options={"embedded":true,"dialogId":"be4ceef2-aadf-ca41-a130-08d46543427a","type":"SPSActivityTypeTicket","viewType":"new"}

  • JS code to perform "save" action in embedded view: 
mx.EmbeddedView.save()

presetParams: provides access to prefill datamodel

For example, let's open the Incident General tab create dialog in the embedded view:

You can see that the dialog is responsive, so it can be used for mobile app integration and also only the General tab is available.

Edit Object

URL Example: 

https://wmpreview03.imagoverum.com/wm/app-ServiceDesk/?view-options={"embedded":true,"dialogId":"be4ceef2-aadf-ca41-a130-08d46543427a","objectId":"ab111d51-45d1-cba9-3fd5-08dbdaecc035","type":"SPSActivityTypeTicket","viewType":"edit"}

The "objectId" is a mandatory parameter representing an object that will be edited.

Preview Object

URL Example: 

https://wmpreview03.imagoverum.com/wm/app-ServiceDesk/?view-options={"embedded":true,"dialogId":"be4ceef2-aadf-ca41-a130-08d46543427a","objectId":"ab111d51-45d1-cba9-3fd5-08dbdaecc035","type":"SPSActivityTypeTicket","viewType":"preview"}

 "isArchived" is a mandatory parameter indicating a current object will be taken for previewing if the value is set to "0"; otherwise, an archived one if the parameter is set to "1".
The "previewWidgetId" parameter is optional, providing a concrete dialog for preview; otherwise, used by the dialog with higher priority (by default).

Open Wizard URL pattern

URL Example demonstrates how to open the Forward wizard for an incident in Service Desk 

https://wmpreview03.imagoverum.com/wm/app-ServiceDesk/?view-options={"objectId":"ab111d51-45d1-cba9-3fd5-08dbdaecc035","type":"SPSActivityTypeIncident","viewType":"action","actionId":"580b9b8e-91d8-e511-9b82-60e327035d31"}

&presetParams={} parameter provides access to prefill the datamodel.

Next URL Example demonstrates how to open Send E-mail wizard for an incident in Service Desk with prefilled the following fields:the option CC is on, and one user added to CC list as well as set Message text by default. 
https://wmpreview03.imagoverum.com/wm/app-ServiceDesk/?view-options={"objectId":"ab111d51-45d1-cba9-3fd5-08dbdaecc035","type":"SPSActivityTypeIncident","viewType":"action","actionId":"18120902-fdd9-e511-9b82-60e327035d31"}&presetParams={"Context":{"IsVisibleCC":true,"RecipientCC":{"all":["36172e8b-555f-e811-789c-d850e6420719"]}},"SubmitData":{"data":{"Text":"Test EMail"}}}

User with Admin Role also has possibility to open wizard in new window and copy URL from there with necessary set parameters.

 

Global Search

Starting with v.26.1, the deep linking supports globalSearch URL parameter which has the following structure:

  • keyword: the search term used for the global search. Must contain at least two characters.
  • types: a comma-separated list of internal names for the Configuration Items to include in the global search. Only types that are available in the Global Search Context can be specified (Present in Global Search Context List property is enabled in the Navigation Item settings). See also, Search context groups and contexts configuration.
    If no type is specified, the search includes default types.

Common URL pattern:

<HOST>/wm/app-<App Name>/<Layout Type>/<Layout ID>?globalSearch=<Global Search Options>

The following example opens the global search on the specified Self Service Portal landing page, with the search field prefilled with the keyword “print”, and runs the search across Knowledge Base Articles:

https://wmpreview03.imagoverum.com/wm/app-SelfServicePortal/landing-page/14587d3e-63aa-e611-d99b-bc5ff41a70c0?globalSearch={"keyword":"print","types":"SVMKBArticleType"}

 

 

 

Related Articles