Navigation functions enable you to define simple ways for end users to navigate within the mobile platform, for example, navigating to a record from a field on another record.

Before you begin

Before you create a navigation function, you should have a source screen and a destination screen for your navigation.

Role required: admin

Procedure

  1. Navigate to All > System Mobile > Mobile App Builder.
    The Mobile App Builder opens in a new browser tab and displays the application scope selection screen.
  2. Search for the application scope you are working in and then select the name of the application scope.
    The Mobile App Builder categories home screen displays.
  3. Select Functions from the menu and then select New.
  4. In the Function form, complete the following fields.
    Table 1. New function record form
    Field Description
    Properties
    Name The name of your navigation function.
    Description Unique description for your navigation function to make it easy to identify.
    Type Type of function. Select Navigation.
    Context

    Whether the function uses the Global or the Record context.

    Use Record context navigation functions in situations where the navigation depends on information form a record. For example, if you want to navigate from the Assigned to field in an incident record to the assignee's user record.

    Use Global context navigation functions in situations where the navigation does not depend on information from a record. For example, select Global for navigating to a screen.
    Available offline Whether the navigation function is available offline.
    Note:
    • The screen and the application that contains the navigation function must be marked as available offline for the navigation function to work when the device is offline.
    • Offline is only supported for the Mobile Agent.

    For more information about offline mode, see Offline mode.
    Settings
    Destination type The type of destination to which you want to navigate. Select either Screen or Launcher.
    Auto-populate screen parameters Automatically populates parameters in the destination screen.
    Destination screen/launcher The destination screen or launcher to which you want to navigate. Select Choose, select the screen or launcher, and then select Apply to add it to your navigation function.
    Data
    Table Select the table that contains the field you want to use for the function. This option only appears if you select Record for the Context.
    Conditions The condition that must be met for the function to be visible in the app to end users. For example, if you don't want an end user to navigate to a screen of tasks until after they have clocked in for the day.
  5. If you added a destination screen that has a parametrized data item, in the Redirection destination fields section, select the Name field to update the redirection parameter fields for the destination screen.
    If you need to add a destination screen, select New to add one. Complete the following fields as needed.
    Table 2. Redirection destination fields form
    Field Description
    Destination UI parameter The name of the parameter you created for the data item. Select Choose to search for the parameter and then select Apply.
    Settings
    Type Source of information for the parameter. The available options are:
    • Field: The parameter gets the information from a field on a table.
    • Constant: The parameter uses a constant value.
    • Source UI parameter: The parameter gets the information from a source field.
    Function table The table that you select in Step 4 if the function uses a Record context. This table is automatically populated in the form.
    Function This is the function you created in Step 4. The function name is automatically populated in the form.
    Source field UI parameter for the source screen. This field appears only if Source UI Parameter is the redirection parameter Type value.
  6. Select Save in the Redirection destination fields form, and then select the function in the navigation menu to navigate back to the function you created in Step 4.
  7. In the Button attributes section, select an existing button attribute record or select New to add one.
    If you need to add a new button attribute record, in the Button Attribute form, complete the following fields as needed.
    Field Description
    Button Name of the button record. This information is automatically populated from the function record.
    Name The button attribute. Select from:
    • used_for_deeplink
    • alerts_require_dismissal
    • trigger_offline_cache_download
    • check_acl_on_url_parameter_field
    Note: The trigger_offline_cache_download button attribute is only available when the Available offline option has been turned on in Step 4.
    Value Whether the attribute is turned on. Enter true to turn on the attribute. By default, the Value is set to true.
  8. In the Role access section, select Choose to add the roles that can use the navigation function.
  9. In the Function form, select Save.

What to do next

After you create a navigation function, you must associate it with a specific location in the mobile app. For more information, see Associate a function with a location in the app.