Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Note |
---|
Prerequisites To install the EmpowerID Orchestration Pack to ServiceNow, you need to import into your ServiceNow instance the XML file that was provided to you by EmpowerID. This file contains the necessary configuration settings for the pack as well as the endpoint information the activities need to call the EmpowerID API. |
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 demonstrate 'll show you how to make the EmpowerID Chat Bot available to users within Service NowServiceNow.
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:
|
Step 1 – Import
the XML file into ServiceNowLoginOrchestration 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.
Log in to your ServiceNow instance .
Search for System Update Sets in the Filter Navigator and then click Retrieved Update Sets.
Image RemovedClick Import Update Set from XML.
Image RemovedBrowse for and select the XML file you received from EmpowerID.
Click Upload.
Image RemovedUnder Retrieved Update Sets, click the Name link for the application you just uploaded.
Image RemovedClick Preview Update Set.
Image RemovedIf the preview is successful, click Commit Update Set.
Image Removed Click Close to closethe Update Set Commit window.If the preview contains errors, scroll to look for them.
Select all the errors and then under Actions on the selected rows, click Accept remote update and then click Commit Update Set.
Image Removed
All the items should be deployed in the instance. The next step is to create UI Actions for the deployed instance.
Step 2as an administrator.
Click on All to Expand the Filter Navigator, and navigate to Connection and Credential > Credential.
Image AddedClick on the New button to proceed.
Image AddedSelect Basic Auth Credentials as the type of credentials.
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 Added
Click on All to Expand the Filter Navigator, and navigate to System Applications > Studio.
Image AddedClick on Import from Source Control.
Image AddedProvide the necessary details and click on Import.
Image AddedNetwork Protocol: Choose the appropriate network protocol:
URL (Provided by EmpowerID)
HTTPS: By default, use the URL 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 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)
Once the process is completed, EmpowerID will be listed among the applications in the Select Application window we used earlier.
Image AddedThe 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 AddedSearch for the x_36687_eid.base_url property and click on it.
Image AddedReplace the value with the x_36687_eid.base_url with the URL provided by EmpowerID and click Update.
Image Added
You have successfully imported the orchestration package into EmpowerID and configured the necessary URL. Proceed to the next step, which is 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:
Login to EmpowerID with the necessary permissions.
On the navigation bar, expand the Admin section. Click on Application and Directories → Account Store and System.
Image AddedClick on the Account Store tab and use the search bar to find the account store created for Service Now.
Image AddedClick on the Account Store name link to view its details.
Select the Resource System tab. Click on Configuration Parameters within the Resource System Info sub-tab.
Image AddedPlease 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 AddedEnter the correct values, and then click on Save.
Image Added
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 button.
Image AddedInput the values provided in the table below. Click save.
Image Added
Anchor | ||||
---|---|---|---|---|
|
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
In ServiceNow, search Search for Service Catalog in the Filter Navigator and then click Service Catalog.
Image RemovedImage AddedClick the Add New button inthe main pane of the Service Catalog,
Image RemovedImage Added
In the Sections dialog that appears, select Catalog Categories > EmpowerID Services and then click Add here.
Image RemovedImage Added
Image RemovedImage Added
You should see EmpowerID Services as a new widget.Click the EmpowerID Services widget.
You should see the three EmpowerID workflows.
Image Removed
Next, incorporate the Change Password workflow into ServiceNow and display it as a link in the main menu.
Step 3
Image Added
Step 4 – Choose to Use Flow / Workflow in Service Catalog
When integrating EmpowerID with ServiceNow, customers can choose between using flows and workflows 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 in the Service Catalog, follow the steps outlined below:
Click on All to Expand the Filter Navigator, and navigate to System Applications > Studio.
In the Select Application popup, search for EmpowerID and click on it.
Image AddedAfter loading the studio page, navigate to the Service Catalog → Catalog Items node in the Application Explorer pane.
Image AddedTo configure a catalog item, click to open it and find the Process Engine tab in the details view.
Image AddedTo use flows as the process engine for your service catalog, deselect the workflow, choose the desired flow, and click "Update." By default, workflows are selected as the process engine.
Image AddedRepeat 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 5 – Add the Change Password workflow to the main menu
In ServiceNow, search Search for Portals in the Filter Navigator and then click Portals.
Image RemovedImage AddedClick Service Portal.
Image RemovedImage AddedIn the Service Portals view, click the Info button to the right of the Main Menu.
Image RemovedImage AddedClick Open Record.
Image RemovedImage AddedUnder Menu Items, click New.
Image RemovedImage AddedIn the Menu Item form, do the following:
Enter Reset Password in the Label field.
Enter password_reset in the Page field.
Click Submit.
Image RemovedImage Added
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.
Image RemovedImage AddedClick Reset Password.
The Reset Password page should be displayed.
Image RemovedImage Added
Next, display Change Password as a catalog item.
Step
46 – Add Change Password to the Service Catalog
In the ServiceNow Filter navigator, search for Content Items and then click Content Items.
In the Content Items view, click New.
Image RemovedImage AddedIn the New record form that opens, do the following:
In the Name field, enter a name for the Catalog item, such as Reset EmpowerID Password.
Click the Lock button to the right of the Catalogs link.
Enter Service Catalog in the search field and then click Service Catalog.
Image RemovedImage AddedClick the Lock button to lock the catalogs.
Image RemovedImage AddedIn the Category field, search for and select Services.
For Content Type, select External Content.
For Target, select New Window/Tab.
In the URL field, enter /sp?id=password_reset.
Click Submit.
Image RemovedImage Added
In the ServiceNow Filter navigator, search for Service Portal and then click Service Portal.
On the top menu bar, click Catalog.
Image RemovedImage AddedSearch for the created Catalog item that was created, e.g., Reset EmpowerID Password.
Click the Catalog item.
Image RemovedImage AddedYou should see the Reset Password page displayed in a new tab.
Image RemovedImage Added
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. |
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 | |
---|---|
|
| |
|
|
|
Image Removed
|
Next, add the EmpowerID Chat Bot to ServiceNow.
Step
57 – Add the EmpowerID Chat Bot
In the ServiceNow Filter navigator, search for Service Portal and then click Service Portal Home.
On the Service Portal Home page, press the CTRL key on your keyboard and then right-click on the page.
Select Page in Designer from the context menu that appears.
Image RemovedImage AddedSelect the Widgets tab and then search for Azure Bot.
The bot appears on the lower right of the page.
Image RemovedImage Added
Div | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
IN THIS ARTICLE
|
Macrosuite divider macro | ||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Extend ServiceNow with the Orchestration Pack
Configure Service Catalog Requests
Insert excerpt | ||||||
---|---|---|---|---|---|---|
|