Mobile deep link structure

  • Release version: Yokohama
  • Updated January 30, 2025
  • 3 minutes to read
    • Summarize
    Summarized using AI
    This content was generated using new OpenAI-powered functionality. Results are provided on an as is basis and are not guaranteed to be accurate or complete.

    Summary of Mobile deep link structure

    Mobile deep links in ServiceNow enable direct navigation to specific screens within mobile apps such as Now Mobile or Mobile Agent. These links consist of three components: a variable name, a reference to the target mobile app, and a public method that generates the deep link. This structure allows you to programmatically open various screen types including forms, lists, launchers, and authentication screens.

    Show full answer Show less

    Key Features

    • Variable Name: Assign any identifiable variable name to hold the deep link for easy reference in your code.
    • Mobile App Reference: Specify the target app by name—use 'Request' for Now Mobile or 'Agent' for Mobile Agent—to direct the deep link appropriately.
    • Public Methods for Link Generation: Several methods are available to generate links tailored to different screen types and use cases:
      • getButtonLink(buttonId, tableName, recordSysId): Opens an input form screen tied to a specific button.
      • getFormScreenLink(formScreenId, tableName, recordSysId): Opens a non-parameterized form screen.
      • getLauncherScreenLink(launcherScreenId): Opens a launcher screen.
      • getPrefillLink(forceLocalLogin): Provides a pre-filled login instance link for first-time mobile users to streamline authentication.
      • getScreenLink(documentId, uiParams): Links to list screens or other screen types, with optional UI parameters.
      • getSSOPrefillLink(sysid): Generates a secure single sign-on (SSO) link using a specified identity provider, useful for multi-IdP environments. Requires the Multi-Provider SSO plugin and active IdP.
      • getUniversalLink(url): Creates a link that opens a list, form, or browser screen based on a given URL.

    Practical Use

    By using this mobile deep link structure, ServiceNow customers can create customized, direct navigation paths within mobile applications to enhance user experience and streamline workflows. Whether launching specific forms, enabling secure SSO access, or guiding users to launcher screens, these links provide precise control over mobile navigation. Activating Multi-Provider SSO and properly identifying identity providers is essential when using SSO-related deep link methods.

    Familiarize yourself with how to construct and use mobile deep links in any screen type within a mobile app.

    Mobile deep links essentially consist of three components. The name of the variable, a reference to a mobile app, and the public method used to pull the mobile deep link. The following mobile deep link has a variable with the name deepLinkGen, where a specified screen opens in the Mobile Agent.

    var deepLinkGen= new global.MobileDeepLinkGenerator('Agent');
 return deepLinkGen.getScreenLink('73f3d135532033002d96ddeeff7b1212');
    Variable name
    You can give any variable name for the mobile deep link, although it should be identifiable for future reference.
    Mobile app call
    Enter one of the mobile apps that the mobile deep link points to. You can enter either Request for the Now Mobile app or Agent for the Mobile Agent app. For example, to generate a link using the mobile deep link generator that points to the Now Mobile app, use the following code: new global.MobileDeepLinkGenerator('Request');
    Public method
    Use one of the public methods that can be used to create a mobile deep link. Reference the table for an explanation of each method, and the reason for its use.
    Method Reason for use Method parameters
    getButtonLink(buttonId, tableName, recordSysId) getButtonLink is used to link into any input form screen. buttonId (required): sys_id of the button you want to launch the input form screen

    tableName (optional): name of the table for the current context

    recordSysId (optional): sys_id of the current context record
    getFormScreenLink(formScreenId, tableName, recordSysId) getFormScreenLink is used to link into any non-parameterized form screen. formScreenId (required): sys_id of required form screen

    tableName (required): table name of required form screen

    recordSysId (required): sys_id of record from tableName
    getLauncherScreenLink(launcherScreenId) getLauncherScreenLink is used to link into any launcher screen. launcherScreenId (required): sys_id of the required launcher screen.
    getPrefillLink(forceLocalLogin) getPrefillLink is useful for first-time ServiceNow mobile users. This link format pre-fills the instance link for users who have not yet added an instance to their mobile app. This method is the default authentication experience.

    This method does not generate a link to a specific screen.

    		 forceLocalLogin (required):

    Enter true for the system to pre-fill the instance login details of the user.

    Enter false, for the user to manually enter login details.
    getScreenLink(documentId, uiParams) getScreenLink is used to link into any list screens, including both parameterized and non-parameterized types. Can also be used for any non-parameterized screen type. An optional UI parameter can be passed into this method. documentId (required): sys_id of desired screen

    uiParams (optional): Parameter of a data item
    getSSOPrefillLink(sys_id) getSSOPrefillLink generates a link that uses the identity provider (IdP) that is identified by the sys_id parameter. This link can be used to authenticate end users that use different IdPs. For example, pre-hires might use Microsoft Azure as their IdP, and on-boarded employees might use Okta as their IdP. A common use of these SSO (single sign-on) pre-filled links is to embed them in emails sent to employees. These emails contain a link that can be used to log in securely to a ServiceNow instance using their mobile apps.
    Important:
    You must activate the Multi-Provider SSO plugin and have an active IdP to use this method. For more information, see Activate Multi-Provider SSO plugin
    		 sys_id (required): Enter the sys_id of the IdP you want to use from the Identity Providers [sso_properties] table.
    To get the sys_id of the IdP:
    1. Navigate to All > Multi-Provider SSO > Identity Providers.
    2. Right-click an identity provider record and select Copy sys_id.
    getUniversalLink(url) getUniversalLink generates a link into either a list, form, or browser. A screen is generated based on the content of this URL. See Universal linking for mobile. url (required): a link to a resource on an instance