Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This article will guide you through the process of importing the necessary packages into ServiceNow. Additionally, we'll walk you through adding the workflows in the Orchestration Pack to the ServiceNow Service Catalog and configuring them. Finally, we'll show you how to make the EmpowerID Chat Bot available to users within ServiceNow.

Note

Gather Repository Information from EmpowerID

The EmpowerID Orchestration Pack for ServiceNow is customized to meet the business logic and workflow requirements of each customer. These customized files are hosted separately for each customer. Before you begin the integration process, please gather the following information for your Orchestration Pack for ServiceNow from EmpowerID, as the details vary for each customer:

  • Access Token: An access token is required to access the repository. This access token will be used as a password later when creating the credentials.

  • URL of the Repository: URL of the repository.

  • Branch: Branch of the repository.

  • x_36687_eid.base_url : Each client has a unique EmpowerID URL for ServiceNow configuration, which differs from the regular instance URL.

Step 1 – Import Orchestration Package and Configure Base URL

The EmpowerID Orchestration Pack for ServiceNow can be conveniently imported from the ServiceNow platform. To import the orchestration package, you need to

  • Create credentials on the ServiceNow platform,

  • Import the package from GitHub into the studio,

  • Configure x_36687_eid.base_url.

Please follow the instructions below to import and configure the base URL.

  1. Login Log in to your ServiceNow instance as an administrator.

  2. Click on All to Expand the Filter Navigator, and navigate to Connection and Credential > Credential.

    image-20240409-094049.png

  3. Click on the New button to proceed.

    image-20240409-094629.png

  4. Select Basic Auth Credentials as the type of credentials.

  5. Provide the necessary details and click on Submit to save the credential:

    • Name: A unique and descriptive identifier for the credential.

    • Username: A username to be used for the credential.

    • Password: Access Token for the repository. (Provided by EmpowerID)

      image-20240409-095012.png

  6. Click on All to Expand the Filter Navigator, and navigate to System Applications > Studio.

    image-20240409-095253.png

  7. Click on Import from Source Control.

    image-20240409-095733.png

  8. Provide the necessary details and click on Import.

    image-20240409-100521.png

    • Network Protocol: Choose the appropriate network protocol:

    • URL (Provided by EmpowerID)

      • HTTPS: By default, use the URL provided below, or if a different URL has been provided, please use that instead.

        Code Block
        https://github.com/empowerID/SNOWIntegration.git
      • SSH: By default, use the git ssh SSH provided below, or if specific information has been provided, please use that instead.

        Code Block
        git@github.com:empowerID/SNOWIntegration.git
    • Credentials: Select the credential you created earlier.

    • Branch: Provide the branch of the EmpowerID repository. (Provided by EmpowerID)

  9. Once the process is completed, EmpowerID will be listed among the applications in the Select Application window we used earlier.

    image-20240409-101411.png

  10. The final configuration to make this setup work is to configure the x_36687_eid.base_url, In the All Menu, type sys_properties.list and press enter to open the system properties page.

    image-20240409-130748.png

  11. Search for the x_36687_eid.base_url property and click on it.

    image-20240409-131159.png

  12. Replace the value with the x_36687_eid.base_url with the URL provided by EmpowerID and click Update.

    image-20240409-132402.png

You have successfully imported the orchestration package into EmpowerID and configured the necessary URL. Proceed to the next step, which is to add adding workflows to the service catalog.

Step 2 – Import Groups and Management Roles

To configure EmpowerId for communication of Groups and Roles to SNOW in your developer instance, follow these steps. If the configuration doesn't exist, create it:

  1. Login to EmpowerID with the necessary permissions.

  2. On the navigation bar, expand the Admin section. Click on Application and Directories → Account Store and System.

    image-20240426-062948.pngImage Added

  3. Click on the Account Store tab and use the search bar to find the account store created for Service Now.

    image-20240426-063640.pngImage Added
  4. Click on the Account Store name link to view its details.

  5. Select the Resource System tab. Click on Configuration Parameters within the Resource System Info sub-tab.

    image-20240426-070055.pngImage Added

  6. Please make sure that all current parameters are properly configured. The configuration list below lists the parameter names and values. If any parameters are missing, please follow the instructions in step #7 to add them.
    To modify an existing parameter,

    • Click on the edit icon ✏️ in the parameter,

      image-20240426-073926.pngImage Added

    • Enter the correct values, and then click on Save.

      image-20240426-074518.pngImage Added

  7. If any parameters are missing, please refer to the configuration list below for the parameter name and value and add them accordingly. Repeat this step for each missing configuration value until all are added.

    • Click on the add (plus) button.

      image-20240426-071707.pngImage Added

    • Input the values provided in the table below. Click save.

      image-20240426-071926.pngImage Added

Anchor
clist
clist
Configuration List for Groups and Management Roles

Here is the list of configurations needed for the SNOW integration to import groups and management roles, including their names and values.

Note

Please replace the {yourinstanceurl} placeholder in the values below with the unique EmpowerID URL for ServiceNow configuration (Provided by EmpowerID), which differs from the regular EmpowerID instance URL.

Name

Value

ImportGroupsToSnowInstance

TRUE

ImportManagementRolesToSnowInstance

TRUE

GET_GROUPS_URL

{yourinstanceurl}/api/x_36687_eid/eid/getMgmtGroupsGuid

GET_MANAGEMENT_ROLES_URL

{yourinstanceurl}/api/x_36687_eid/eid/getMgmtRolesGuid

GROUP_HAS_ROLE_URL

{yourinstanceurl}/api/now/table/sys_group_has_role

GROUPMEMBER_URL

{yourinstanceurl}/api/now/table/sys_user_grmember

GROUPS_DELETE_URL

{yourinstanceurl}/api/x_36687_eid/eid/deleteMgmtGroups

GROUPS_URL

{yourinstanceurl}/api/now/table/sys_user_group

IMPORT_GROUPS_URL

{yourinstanceurl}/api/x_36687_eid/eid/mgmtgroups

MANAGEMENT_ROLES_DELETE_UR

{yourinstanceurl}/api/x_36687_eid/eid/deleteMgmtRoles

Request_URL

{yourinstanceurl}/api/now/table/sc_request

ROLES_URL

{yourinstanceurl}/api/now/table/sys_user_role

SC_REQ_ITEM_URL

{yourinstanceurl}/api/now/table/sc_req_item

SC_TASK_URL

{yourinstanceurl}/api/now/table/sc_task

Step 3 – Add EmpowerID Workflows to the Service Catalog

  1. In ServiceNow, search Search for Service Catalog in the Filter Navigator and then click Service Catalog.

  2. Click the Add New button inthe main pane of the Service Catalog,

  3. In the Sections dialog that appears, select Catalog Categories > EmpowerID Services and then click Add here.


    You should see EmpowerID Services as a new widget.

  4. Click the EmpowerID Services widget.

    You should see the three EmpowerID workflows.

Next, incorporate the Change Password workflow into ServiceNow and display it as a link in the main menu.

Step 3

Step 4 – Choose to Use Flow / Workflow in Service Catalog

As you know, EmpowerID offers both When integrating EmpowerID with ServiceNow, customers can choose between using flows and workflows for automating tasks in ServiceNow. As a customer, you have the freedom to choose the option that suits your requirements. However, to decide whether to use to automate various tasks. Both options offer distinct advantages and can be configured according to specific business needs. To facilitate the choice between using a flow or a workflow , you need to configure the process engine in the service catalogs. Please Service Catalog, follow the steps below to set up between using a flow or a workflow.outlined below:

  1. Click on All to Expand the Filter Navigator, and navigate to System Applications > Studio.

  2. In the Select Application popup, search for EmpowerID and click on it.

    image-20240409-141421.png

  3. After loading the studio page, navigate to the Service Catalog Catalog Items node in the Application Explorer pane.

    image-20240409-142219.pngImage Removedimage-20240411-050352.pngImage Added

  4. To configure a catalog item, click to open it and find the Process Engine tab in the details view.

    image-20240409-143357.png

  5. If you want to To use flows as the process engine for your service catalog, simply deselect the workflow select , choose the appropriate desired flow, and Click click "Update." By default, the workflow is workflows are selected as the process engine.

    image-20240409-143924.png

  6. Repeat steps #5 and #6 to configure the appropriate flow as a process engine for all service catalogs.

You have now successfully configured the use of either Flow or Workflow in the service catalog. Next, please proceed to the following step to add a workflow specifically for password changes in the menu.

Step

4

5 – Add the Change Password workflow to the main menu

  1. In ServiceNow, search Search for Portals in the Filter Navigator and then click Portals.

  2. Click Service Portal.

  3. In the Service Portals view, click the Info button to the right of the Main Menu.

  4. Click Open Record.

  5. Under Menu Items, click New.

  6. In the Menu Item form, do the following:

    1. Enter Reset Password in the Label field.

    2. Enter password_reset in the Page field.

    3. Click Submit.

  7. In the ServiceNow Filter navigator, search for Service Portal and then click Service Portal.

    The Reset Password link should be displayed as a menu item.

  8. Click Reset Password.

    The Reset Password page should be displayed.


    Next, display Change Password as a catalog item.

Step

5

6 – Add Change Password to the Service Catalog

  1. In the ServiceNow Filter navigator, search for Content Items and then click Content Items.

  2. In the Content Items view, click New.

  3. In the New record form that opens, do the following:

    1. In the Name field, enter a name for the Catalog item, such as Reset EmpowerID Password.

    2. Click the Lock button to the right of the Catalogs link.

    3. Enter Service Catalog in the search field and then click Service Catalog.

    4. Click the Lock button to lock the catalogs.

    5. In the Category field, search for and select Services.

    6. For Content Type, select External Content.

    7. For Target, select New Window/Tab.

    8. In the URL field, enter /sp?id=password_reset.

    9. Click Submit.

  4. In the ServiceNow Filter navigator, search for Service Portal and then click Service Portal.

  5. On the top menu bar, click Catalog.

  6. Search for the created Catalog item that was created, e.g., Reset EmpowerID Password.

  7. Click the Catalog item.

    You should see the Reset Password page displayed in a new tab.

Info

The Change Password workflow is using process operates through the EmpowerID API to successfully Change a user’s password. To call EmpowerID API a token must be generated. Currently it has been configured as a Scheduled Job, update a user's password. This process requires an authentication token, which generated by the Empower Token Generation job, which runs every once a day. This job is responsible for generating tokens which is used to authenticate . Scheduled to run daily, this job is essential for producing tokens needed for authentic interactions with EmpowerID.

For a new instance this job should be executed first, after which it will continue to generate tokens.

Next, add the EmpowerID Chat Bot to ServiceNow

new instances, it is necessary to execute this job at the outset to initiate the token generation cycle, which will then proceed automatically each day. If you want to know how to manually execute the job, please expand the dropdown below for instructions.

Expand
title

To

How to manually execute the EmpowerID Token Generation job
  1. In the ServiceNow Filter navigator, search for Scheduled Job and then click Scheduled Jobs.

Image Removed

  1. Image Added

  2. Search for Empower and then click Empower Token generation.

Image Removed

  1. Image Added

  2. In the Scheduled Script Execution pane that opens, click Execute Now.

Image Removed

  1. Image Added

Next, add the EmpowerID Chat Bot to ServiceNow.

Step

6

7 – Add the EmpowerID Chat Bot

  1. In the ServiceNow Filter navigator, search for Service Portal and then click Service Portal Home.

  2. On the Service Portal Home page, press the CTRL key on your keyboard and then right-click on the page.

  3. Select Page in Designer from the context menu that appears.

  4. Select the Widgets tab and then search for Azure Bot.

    The bot appears on the lower right of the page.

Div
stylefloat: left; position: fixed;

IN THIS ARTICLE

Table of Contents
minLevel2
maxLevel4
stylenone
Macrosuite divider macro
dividerWidth80
dividerTypetext-with-icon
emoji{"id":"smile","name":"Smiling Face with Open Mouth and Smiling Eyes","short_names":["smile"],"colons":":smile:","emoticons":["C:","c:",":D",":-D"],"unified":"1f604","skin":null,"native":"😄"}
textColor#000000
dividerWeight3
labelPositionmiddle
textAlignmentcenter
iconColor#0052CC
iconSize25
fontSizemedium
textNext Steps
emojiEnabledfalse
dividerColor#DFE1E6
dividerIconbootstrap/BarChartSteps

Extend ServiceNow with the Orchestration Pack

Configure Service Catalog Requests

Insert excerpt
IL:External Stylesheet
IL:External Stylesheet
nopaneltrue