Mobile deep link structure

  • Release version: Xanadu
  • Updated August 1, 2024
  • 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

    This guide explains how to construct and use mobile deep links within ServiceNow mobile apps, specifically for the Now Mobile and Mobile Agent apps. Mobile deep links enable users to directly open specific screens or forms in the mobile apps, enhancing navigation efficiency and user experience.

    Show full answer Show less

    Key Components of Mobile Deep Links

    • Variable Name: Any identifiable variable name can be assigned to the deep link for easy reference in code.
    • Mobile App Call: Specify the target mobile app, either Request for the Now Mobile app or Agent for the Mobile Agent app, to direct the deep link accordingly.
    • Public Method: Use one of several public methods to generate links to various screen types or authentication experiences within the mobile apps.

    Public Methods and Their Use Cases

    • getButtonLink(buttonId, tableName, recordSysId): Opens an input form screen via a button. Requires the button’s sysid; table name and record sysid are optional.
    • getFormScreenLink(formScreenId, tableName, recordSysId): Opens a non-parameterized form screen. All parameters are required.
    • getLauncherScreenLink(launcherScreenId): Opens a launcher screen specified by its sysid.
    • getPrefillLink(forceLocalLogin): Useful for new mobile users to pre-fill instance login details. Set true to auto-fill or false for manual entry. Does not link to a specific screen.
    • getScreenLink(documentId, uiParams): Links to list or non-parameterized screens. Requires the screen’s sysid; uiParams is optional for additional UI data.
    • getSSOPrefillLink(sysid): Generates a link for Single Sign-On (SSO) authentication using a specified Identity Provider (IdP). Requires the Multi-Provider SSO plugin and active IdP sysid from the Identity Providers table.
    • getUniversalLink(url): Creates a link to a list, form, or browser screen based on the provided URL.

    Practical Benefits for ServiceNow Customers

    • Enables precise navigation within mobile apps, improving user efficiency.
    • Supports different authentication scenarios, including SSO for diverse user groups.
    • Facilitates onboarding of first-time mobile users through pre-filled login links.
    • Allows embedding of secure, deep-linked URLs in communications like emails to streamline access.

    Implementation Notes

    • Always assign clear variable names to deep links for maintainability.
    • Choose the mobile app context carefully depending on target user roles and app functionality.
    • Ensure the Multi-Provider SSO plugin is activated and configured to use SSO-based deep links.
    • Use sysid values from relevant tables (buttons, forms, screens, IdPs) to generate accurate deep links.

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