Associate a domain ID with a chat portal

  • Release version: Washingtondc
  • Updated February 1, 2024
  • 1 minute to read
  • The Service Portal platform is not domain-separated, but you can create different versions of a portal and restrict each version's use to a single domain for chat purposes. For example, you could create two employee service portals and define a different domain for each.

    Before you begin

    Role required: admin

    About this task

    Elements of the Service Portal platform such as settings, portals, pages and widgets are not domain-separated. However, the data within widgets does display when based on the appropriate domain. To provide different experiences, admins should create separate service portals, each with unique URLs, that they can redirect users to. For a domain-separated chat experience in the web client channel, create a portal and use the sysparm_domain_id parameter in the URL to designate the domain. For more information, see Virtual Agent URL parameters.

    Procedure

    1. Optional: Create a new domain and assign roles to the domain as needed.
    2. Copy the domain's sys ID.
      1. Navigate to All > Domain Admin > Domains.
      2. Right-click the name of a domain, and then select Copy sys_id.
        Copy the sys ID for the domain.
      3. Paste the ID in a text editor and save it for later.
    3. Navigate to All > Service Portal > Agent Chat.
    4. Select the name of the portal that you want to restrict to a domain, or create a new one.
      If prompted, open the record for editing.
    5. In the Server script area, add the domain_id parameter and the domain's sys ID that you copied earlier.
      Add the domain_id parameter to the portal script.
    6. Select Update or Submit to save your changes.

    Result

    The sysparm_domain_id parameter gets passed in the portal URL.