---
sourceDocument: Xanadu API Reference
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/xanadu/api-reference

 Release :

    - xanadu

ft:locale :

    - en-US

ft:publication_title :

    - Xanadu API Reference

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# MobileDeepLinkGenerator - Global

# MobileDeepLinkGenerator - Global {#ariaid-title1}

* Release version: Xanadu
* 
* Updated August 1, 2024
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 2 minutes to read

The MobileDeepLinkGenerator script include provides methods to embed a link to a mobile app list or form applet.  
Use this script include in a global server-side script to create a link to a list or form applet within these apps:

* Now Mobile
* Mobile Agent
* Mobile Onboarding

{#MobileDeepLinkGeneratorAPI__ul_krs_cfr_vhb}  
Note:  
The Mobile Onboarding application is being deprecated!

With the ServiceNow AI Platform Rome release in September 2021, we started phasing out support for the Mobile Onboarding application. Customers may no longer activate it, and we are not offering enhancements or non-critical bug fixes. Mobile onboarding features are available in the [Now Mobile app for HR Service
Delivery](https://www.servicenow.com/docs/access?context=mobile-employee-experience-for-hr-service-delivery&version=xanadu&pubname=xanadu-employee-service-management&ft:locale=en-US).
For example, create a link from an email, push notification, or Virtual Agent conversation that opens a record or list of records in the app. The form or list only includes data that the user has access rights to view.

For an example of this API used in a push notification, see [Configure push notification message content](https://www.servicenow.com/docs/access?context=config-push-notification-message-content&version=xanadu&pubname=xanadu-mobile&ft:locale=en-US). For additional information on deep links, see [Deep linking for mobile](https://www.servicenow.com/docs/access?context=deep-link-mobile&version=xanadu&pubname=xanadu-mobile&ft:locale=en-US).

## MobileDeepLinkGenerator - MobileDeepLinkGenerator(String clientType) {#ariaid-title2}

Instantiates a MobileDeepLinkGenerator object for a specific mobile app.
{#MDLG-MDLG_S__table_fzm_gjr_vhb__entry__3}

| Name | Type | Description |
|-|-|-|
| clientType | String | Name of the app to create a link to. Options include: * agent: Creates a link to a list or screen in the Mobile Agent app. * request: Creates a link to a list or screen in the Now Mobile app. * onboarding: Creates a link to a list or screen in the Mobile Onboarding. {#MDLG-MDLG_S__ul_vpl_pcs_vhb} |
[Table 1. Parameters]

{#MDLG-MDLG_S__table_fzm_gjr_vhb}  
Note:  
The Mobile Onboarding application is being deprecated!

With the ServiceNow AI Platform Rome release in September 2021, we started phasing out support for the Mobile Onboarding application. Customers may no longer activate it, and we are not offering enhancements or non-critical bug fixes. Mobile onboarding features are available in the [Now Mobile app for HR Service
Delivery](https://www.servicenow.com/docs/access?context=mobile-employee-experience-for-hr-service-delivery&version=xanadu&pubname=xanadu-employee-service-management&ft:locale=en-US).  

    var glide = new global.MobileDeepLinkGenerator('onboarding');

## MobileDeepLinkGenerator - getFormScreenLink(String formScreenId, String tableName, String
recordSysId) {#ariaid-title3}

Create a link to a form applet.
{#MDLG-getFormStringLink_S_S_S__table_llq_q3r_vhb__entry__3}

| Name | Type | Description |
|-|-|-|
| formScreenId | String | Sys ID of the applet record in the Applets \[sys_sg_screen\] table. |
| tableName | String | Name of the table containing the record in the recordSysId parameter. |
| recordSysId | String | Sys ID of the record to open in the applet. |
[Table 2. Parameters]

{#MDLG-getFormStringLink_S_S_S__table_llq_q3r_vhb} {#MDLG-getFormStringLink_S_S_S__table_mlq_q3r_vhb__entry__2}

| Type | Description |
|-|-|
| String | Link to the record in the mobile app form applet. |
[Table 3. Returns]

{#MDLG-getFormStringLink_S_S_S__table_mlq_q3r_vhb}  

    var deepLinkGenerator = new global.MobileDeepLinkGenerator("agent");
    var link = deepLinkGenerator.getFormScreenLink("<sys_id>", current.getTableName(), current.getValue("sys_id"));

## MobileDeepLinkGenerator - getScreenLink(String documentId, Object uiParams) {#ariaid-title4}

Create a link to a list applet.
{#MDLG-getScreenLink_S_O__table_xbz_m3r_vhb__entry__3}

| Name | Type | Description |
|-|-|-|
| documentId | String | Sys ID of the applet record in the Applets \[sys_sg_screen\] table. |
| uiParams | Object | Optional. JSON object containing any URL parameters to include in the link. Determine which URL parameters to include by inspecting the URL you want to link to. In general, URL parameters filter records in the list. For example, `var param = {'<company-sys-id>': 'servicenow'}`, where `<company-sys-id>` is the Sys ID of a company UI parameter from the UI Parameters \[sys_sg_ui_parameter\] table for a specific mobile screen. |
[Table 4. Parameters]

{#MDLG-getScreenLink_S_O__table_xbz_m3r_vhb} {#MDLG-getScreenLink_S_O__table_ybz_m3r_vhb__entry__2}

| Type | Description |
|-|-|
| String | Link to the mobile app list applet. |
[Table 5. Returns]

{#MDLG-getScreenLink_S_O__table_ybz_m3r_vhb}  

    var uiParams = {
        "b250294ab3c12300a0d56ad4c6a8dc8c": "servicenow", 
        "7250294ab3c12300a0d56ad4c6a8dc90": "santa clara"}

    var deepLinkGenerator = new global.MobileDeepLinkGenerator("request");
    var link = deepLinkGenerator.getScreenLink("a75df1920f2033001befa68ca8767e50", uiParams);