Add or modify an HR deep link

  • Release version: Washingtondc
  • Updated February 1, 2024
  • 2 minutes to read

    • Use the Define Link (Link Generator Sources) to create a record for the target website name and URL.

    Before you begin

    Role required: link_generator_writer

    Procedure

    1. Navigate to All > Link Generator > Define Link.
    2. Click New or an existing record.
      FieldDescription
      Website name Enter the external website name that is the target for the link.
      Website URL Enter the URL of the website.
    3. Click Submit or Update.
    4. Navigate to Define Link Parameters.
    5. Click New or on an existing record.
      FieldDescription
      Deep link name Enter a name or location within the website you are linking to.
      Value A unique link generator service value automatically created from the Deep link name entered.
      Website name Enter the name of the website you are linking to.
      Link type Select:
      • Button link: Creates a button that links to the website.
      • Generated link: Use to generate a URL that you can copy and paste into any table with a field type of URL. For example, on the Manage Content form, create a URL content type. Then, copy and paste the URL in the Content URL field. Other examples include creating links to knowledge articles and catalogs.
      Script Enter a script that directs the user to the external site.
    6. Click Submit or Update.
    7. Navigate to Define Button.
    8. Click New or on an existing record.
      FieldDescription
      Button name Enter a name for the button that links to the outside website. What you enter here appears on the button.
      Button location type Select the location type for the button.
      • Standard form: Use this type to place a deep link on the legacy HR case form.
      • Custom form: Use this type to work with an API.
      • Agent Workspace: Use this type to work with HR Service Delivery Agent Workspace.
      Form (Table) Select the table that contains the field you want the deep link button to appear next to.

      For example, select the HR Profile [sn_hr_core_profile] table when you want the deep link button to appear next to a field on the HR Profile form.
      Location (Field) Select the field from the table selected that you want the deep link button to appear next to.

      For example, select User to place the deep link button next to the User field on the HR Profile form.
      Deep link name This information is pulled from the Deep Link Parameters (Link Generator Service) form.
      Active Check to make this mapping active and available for use.
    9. Click Submit or Update.