The process for onboarding ServiceNow depends on whether the configuration is created before or after the release of the user interface on August 3, 2022. If you are creating a new integration, use the latest procedures in
ServiceNow integration. There are three scenarios:
Before you can onboard a provider, you must meet these requirements:
Enterprise Marketplace: Version 08/03 or later.
For existing ServiceNow integration created before August 3
This scenario involves an existing ServiceNow integration with an Kyndryl Modern Operations Applications tenant that was created before August 3, 2022. In this case, you just need to execute the migration API by completing the following steps:
Log in to the tenant you want to migrate in Kyndryl Modern Operations Applications.
Enter the following information to display the Reporting Service APIs:
Application:
Select
consume
.
Service:
Select
SNOW_adapter_API
.
Execute the following API:
API:
itsm/v1/itsmsystems/migrate
You can get the status of the migration using the following API:
API:
itsm/v1/itsmsystems/migrate/{requestId}/results
Parameters:
requestId:
The migration request ID you received when you started the migration.
After the migration process is completed, a new ITSM System is created along with required providerType, providerCode, system account, fulfillment policies, and catalog mapping policy. Any custom catalog-mapping policies present in the existing integration will be part of the new ITSM System.
This scenario covers a configuration where you want to integrate ServiceNow with an Kyndryl Modern Operations Applications tenant that was created before August 3, 2022.
Locating your user API key and API tenant URL
The API tenant URL was generated when the tenant was created. Contact the person who created the tenant to get it.
You will need the API key for the user that you will be using. If you do not have it, you can regenerate it using the following steps:
Log in to your Kyndryl Modern Operations Applications tenant with the user you created.
Click
Generate/Regenerate
to generate the API key.
To integrate Kyndryl Modern Operations Applications and ServiceNow, you must do some configuration in ServiceNow by completing these steps:
To create an Kyndryl Modern Operations Applications credential to allow ServiceNow to communicate with it, complete these steps:
Log in to your ServiceNow instance.
Find
API_KEY_CREDENTIALS.LIST
in the navigator and click it.
Enter the following information for your Kyndryl Modern Operations Applications instance and click
Save
:
Active:
Leave this selected.
User name:
The user ID used to log in to your Kyndryl Modern Operations Applications instance.
API key:
The API key for your Kyndryl Modern Operations Applications instance.
Applies to:
Leave this as
All MID servers
.
Order:
Leave this as
100
.
Assign the following roles to the credential:
import_admin
web_service_admin
itil
qs_integration_gbl_user (only visible when QuickStart packages are involved)
x_ibmg3_hcms.hcms_user
The record will be listed under Kyndryl Modern Operations Applications Credential.
To link ServiceNow to Kyndryl Modern Operations Applications, complete these steps:
Log in to your ServiceNow instance.
Find
Kyndryl Marketplace Integration Configuration
in the navigator and click it.
Enter the following attributes for your Kyndryl Modern Operations Applications installation:
Kyndryl Modern Operations Applications URL:
The tenant API URL for Kyndryl Modern Operations Applications. For more information, consult with your Kyndryl Modern Operations Applications tenant admin.
This URL is different from the tenant UI URL.
Kyndryl Modern Operations Applications Credential:
The credential used to connect to Kyndryl Modern Operations Applications.
Approval Workflow:
This is used to set which system controls the approval workflow, which can be Kyndryl Modern Operations Applications or ServiceNow. For more information, see
Setting the ServiceNow approval workflow.
Number of retries to be performed for failed O/B request:
Allows you to change the number of times failed outbound calls to Kyndryl Modern Operations Applications are retried. The default number is three.
Enable Discovery:
Determines whether the ServiceNow discovery feature is enabled. If the discovery feature is disabled, Kyndryl Modern Operations Applications links the catalog request for a Day 2 Operations to a stack CI that is created and managed by Kyndryl Modern Operations Applications. Otherwise it will link to the underlying CI discovered by ServiceNow.
Enable QuickStart:
Determine whether to use QuickStart, which is a ServiceNow product that supports ITSM for VMware Aria Automation (formerly vRA) custom catalogs and services.
Quickstart Authentication Profile:
Select the ServiceNow user profile that you want to use for QuickStart.
Allow Anonymous User:
Set this to
Yes
if you want a request to be created even if the user making that request is not present in ServiceNow.
Enable Outbound Call’s using MID Server:
Determine whether to route outbound calls through an MID server, which is used when ServiceNow is on a private network.
Cloud Assignment Group:
Makes sure that any request created by Kyndryl Modern Operations Applications is assigned to the specified group in ServiceNow. You can leave it as the default of
CLOUDGROUP
or change it to a custom name.
Cloud Assigned to:
Makes sure that any Kyndryl Modern Operations Applications request is assigned to the specified cloud in ServiceNow. You can leave it as the default of
CLOUDAUTO
or change it to a custom name.
Configuration Item Assignment Group:
Select the group that the service instance CI (shell ci) will be assigned to.
After these changes are submitted, the changes will be reflected in the ServiceNow properties.
Installing the ServiceNow Droplet
Communication between ServiceNow and Kyndryl Modern Operations Applications is performed using the Enterprise Marketplace Integration Droplet on the ServiceNow side. The Droplet is released on a quarterly basis. The latest version and installation directions are available
here.
Setting the ServiceNow approval workflow
You can optionally to use the approval mechanisms in ServiceNow rather than the approval flow in Enterprise Marketplace for catalog requests. To do so, you need to provide control of one of the approvals to ServiceNow, after which the ServiceNow admin can then create an approval workflow in that tool. This section covers only the policy needed for ServiceNow approval. For more information, see
Approval process. Complete the following steps:
Open the tenant that you want to allow ServiceNow to control the approval flow for in Kyndryl Modern Operations Applications.
Enter the following parameters for the policy:
Name:
Enter a name for your policy.
Start Date:
Enter a date when the policy will become active.
End Date:
Enter a date when the policy will become inactive.
Does not expire:
Select this to keep the policy active indefinitely.
Status:
Set as
Draft
while the policy is being created, and
Active
to apply it.
Associate Approval Policy with a Business Entity:
This section allows you to set a context in which the policy is applied, such as a team or organization. For more information, see
Context.
Click
Add Rule
, create a rule using the following parameters that will allow ServiceNow to control the approval process, and then click
Apply Rule
:
Name:
Enter a name for your rule.
Order Type:
Select the type of order that you want the rule to affect.
Provider:
Select the cloud service provider or providers that you want to cover.
Total Monthly Cost Is:
(optional) You can set the rule to only affect requests of certain amounts. In this case, select a logical expression and enter a
Monthly Cost
. If you want to you can
Include one time charge in calculation
.
Budget Is:
(optional) Sets the rule to use the status of the budget (
Available
,
Not Available
, or
Not Applicable
) when determining whether the rule applies.
Approval Outcomes:
Set
Technical
,
Financial
, or both to
External Approval
. When prompted, select
itsm
in the
external
field.
The policies are applied in the order that they are listed. To change this order, click
Change Sequence
and drag and drop the policies into the order that you want.
Adding provider for providerType itsm
Before you can add ServiceNow as an ITSM provider, you need to add a Enterprise Marketplace provider for providerType itsm (available out of the box) using the following steps:
On the
Provider Type
tab, select
itsm
in the
Select type
field and click
Next
.
On the
Provider Parameters
tab, enter the following information and click
Create
:
Provider Name:
Provide a name for your provider.
Vault Name:
Select
mongo-vault
.
Provider Code:
The code for the ITSM provider.
Status:
Keep this as
Active
.
Create a system account for ServiceNow
Before ServiceNow will show up as a ITSM provider in Enterprise Marketplace, you must create a system account for it by completing these steps:
Open Kyndryl Modern Operations Applications.
Enter the following information to display the Reporting Service APIs:
Application:
Select
core
.
Service:
Select
cb-credential-service
.
Execute the following API:
API:
/cb-credential-service/api/v2.0/accounts
Parameters:
Kyndryl Modern Operations Applications Tenant API URL:
The API URL for the tenant.
Payload:
{
"account": {
"basicInfo": {
"accountName": "<account_name>",
"accountType": "master",
"serviceProviderType": "<provider_type>",
"serviceProviderCode": "<provider_code>",
"isActive": "Active",
"userType": "system",
"credential_count": 1
},
"modelVersion": "v2.1",
"advancedInfo": {
"endpoint": "https://some.service-now.com",
"authModel": "basic"
},
"credentials": [
{
"purpose": [
"systemIntegration"
],
"context": [
{
"team": [
"TEAM1"
]
}
],
"credentialName": "<credential_name>",
"status": "Active",
"passwordFields": {
"username": "<user>",
"password": "<password>",
"client_id": "{client_id}",
"client_secret": "{client_secret}"
}
}
]
}
}
The following are the payload parameters:
accountName:
Enter a name for the new account.
accountType:
Leave as
master
.
serviceProviderType:
Set as
itsm
.
serviceProviderCode:
Set as
itsm
.
isActive:
Leave as
Active
.
userType:
Leave as
system
.
credential_count:
Leave as
1
.
modelVersion:
The model version, which is currently
v2.1
.
endpoint:
The endpoint of your ServiceNow instance.
authModel:
Leave as
basic
.
purpose:
Leave as
systemIntegration
.
team:
Enter the team for which this account should be associated as context.
credentialName:
The name of the credential you will use to sign in to ServiceNow with.
username:
The name of the user to be used to sign in to ServiceNow.
password:
The password for the above user.
client_id:
Leave this empty because the authModel is
basic
.
client_secret:
Leave this empty because the authModel is
basic
.
Onboarding ServiceNow as a provider
To onboard a provider, complete the following steps:
Click
ServiceNow
and click
Add Provider Endpoint
.
On the
Generic Parameters
tab, enter the following information and then click
Next
:
Associate any team, organization, context, environment, or account that you want associated with the ITSM system by selecting
Associate
and selecting the type of entity under
Business Entities
and the specific entity.
In the
Mode of Communication
section, select one of these types:
Direct:
Select this when your ITSM system is in the public domain.
In the
Additional Data Schema
field, enter any extra description needed so that the purpose of the ITSM integration is clear or any other useful information.
On the
Review
tab, make sure that all parameters that you entered are correct, then click
Save
.
After the provider is onboarded, you receive a message prompting whether you want to add policies for the new provider. If you want to, click
Ok, Add Now
. For more information, see
Adding policies for ServiceNow.
Adding policies for Enterprise Marketplace
A group of default out-of-the-box policies are automatically provided. If these are insufficient, you can add your own policies by completing the following steps. For more information about policies in Enterprise Marketplace, see
Operation Policies.
Policies set so that they only affect a single provider, or they can be global. The procedures vary based on whether you use V2 or V3 authorization:
These procedures are for new Enterprise Marketplace tenants created after August 3, 2022 that you want to integrate with ServiceNow.
Creating a tenant and recording the API server URL
Creating a user and generating an API key
You must create a user in Enterprise Marketplace with the following roles. For more information, see
User Access. Record the API key for the user for later use.
Provider Account Admin
System Admin
Buyer
Service Integrator
Generate an API key for the user you created by completing these steps:
Log in to your Enterprise Marketplace tenant with the user you created.
Click
Generate/Regenerate
to generate the API key and record it.
To integrate Enterprise Marketplace and ServiceNow, you must do some configuration in ServiceNow by completing these steps:
To create a Kyndryl Modern Operations Applications credential to allow ServiceNow to communicate with it, complete these steps:
Log in to your ServiceNow instance.
Find
API_KEY_CREDENTIALS.LIST
in the navigator and click it.
Enter the following information for your Kyndryl Modern Operations Applications instance and click
Save
:
Active:
Leave this selected.
User name:
The user ID used to log in to your Kyndryl Modern Operations Applications instance.
API key:
The API key for your Kyndryl Modern Operations Applications instance.
Applies to:
Leave this as
All MID servers
.
Order:
Leave this as
100
.
The record will be listed under Kyndryl Modern Operations Applications Credential.
To link ServiceNow to Enterprise Marketplace, complete these steps:
Log in to your ServiceNow instance.
Find
Kyndryl Marketplace Integration Configuration
in the navigator and click it.
Enter the following attributes for your Kyndryl Modern Operations Applications installation:
Kyndryl Modern Operations Applications URL:
The tenant API URL for Enterprise Marketplace. For more information, consult with your Kyndryl Modern Operations Applications tenant admin.
This URL is different from the tenant UI URL.
Kyndryl Modern Operations Applications Credential:
The credential used to connect to Kyndryl Modern Operations Applications.
Approval Workflow:
This is used to set which system controls the approval workflow, which can be Enterprise Marketplace or ServiceNow. For more information, see
Setting the ServiceNow approval workflow.
Number of retries to be performed for failed O/B request:
Allows you to change the number of times failed outbound calls to Enterprise Marketplace are retried. The default number is three.
Enable Discovery:
Determines whether the ServiceNow discovery feature is enabled. If the discovery feature is disabled, Enterprise Marketplace links the catalog request for a Day 2 Operations to a stack CI that is created and managed by Enterprise Marketplace. Otherwise it will link to the underlying CI discovered by ServiceNow.
Enable QuickStart:
Determine whether to use QuickStart, which is a ServiceNow product that supports ITSM for VMware Aria Automation (formerly vRA) custom catalogs and services.
Quickstart Authentication Profile:
Select the ServiceNow user profile that you want to use for QuickStart.
Allow Anonymous User:
Set this to
Yes
if you want a request to be created even if the user making that request is not present in ServiceNow.
Enable Outbound Call’s using MID Server:
Determine whether to route outbound calls through an MID server, which is used when ServiceNow is on a private network.
Cloud Assignment Group:
Makes sure that any request created by Enterprise Marketplace is assigned to the specified group in ServiceNow. You can leave it as the default of
CLOUDGROUP
or change it to a custom name.
Cloud Assigned to:
Makes sure that any Enterprise Marketplace request is assigned to the specified cloud in ServiceNow. You can leave it as the default of
CLOUDAUTO
or change it to a custom name.
Configuration Item Assignment Group:
Select the group that the service instance CI (shell ci) will be assigned to.
After these changes are submitted, the changes will be reflected in the ServiceNow properties.
Installing the ServiceNow Droplet
Communication between ServiceNow and Enterprise Marketplace is performed using the Enterprise Marketplace Integration Droplet on the ServiceNow side. The Droplet is released on a quarterly basis. The latest version and installation directions are available
here.
Setting the ServiceNow approval workflow
You can optionally to use the approval mechanisms in ServiceNow rather than the approval flow in Enterprise Marketplace for catalog requests. To do so, you need to provide control of one of the approvals to ServiceNow, after which the ServiceNow admin can then create an approval workflow in that tool. This section covers only the policy needed for ServiceNow approval. For more information, see
Approve orders. Complete the following steps:
Open the tenant that you want to allow ServiceNow to control the approval flow for in Kyndryl Modern Operations Applications.
Enter the following parameters for the policy:
Name:
Enter a name for your policy.
Start Date:
Enter a date when the policy will become active.
End Date:
Enter a date when the policy will become inactive.
Does not expire:
Select this to keep the policy active indefinitely.
Status:
Set as
Draft
while the policy is being created, and
Active
to apply it.
Associate Approval Policy with a Business Entity:
This section allows you to set a context in which the policy is applied, such as a team or organization. For more information, see
Context types.
Click
Add Rule
, create a rule using the following parameters that will allow ServiceNow to control the approval process, and click
Apply Rule
:
Name:
Enter a name for your rule.
Order Type:
Select the type of order that you want the rule to affect.
Provider:
Select the cloud service provider or providers that you want to cover.
Total Monthly Cost Is:
(optional) You can set the rule to only affect requests of certain amounts. In this case, select a logical expression and enter a
Monthly Cost
. If you want to you can
Include one time charge in calculation
.
Budget Is:
(optional) Sets the rule to use the status of the budget (
Available
,
Not Available
, or
Not Applicable
) when determining whether the rule applies.
Approval Outcomes:
Set
Technical
,
Financial
, or both to
External Approval
. When prompted, select
itsm
in the
external
field.
The policies are applied in the order that they are listed. To change this order, click
Change Sequence
and drag and drop the policies into the order that you want.
Adding provider for providerType itsm
Before you can add ServiceNow as an ITSM provider, you need to add a Enterprise Marketplace provider for providerType itsm (available out of the box) using the following steps:
On the
Provider Type
tab, select
itsm
in the
Select type
field and click
Next
.
On the
Provider Parameters
tab, enter the following information and click
Create
:
Provider Name:
Provide a name for your provider.
Vault Name:
Select
mongo-vault
.
Provider Code:
The code for the ITSM provider.
Status:
Keep this as
Active
.
Create a system account for ServiceNow
Before ServiceNow will show up as a ITSM provider in Enterprise Marketplace, you must create a system account for it by completing these steps:
Open Kyndryl Modern Operations Applications.
Enter the following information to display the Reporting Service APIs:
Application:
Select
core
.
Service:
Select
cb-credential-service
.
Execute the following API:
API:
/cb-credential-service/api/v2.0/accounts
Parameters:
Kyndryl Modern Operations Applications Tenant API URL:
The API URL for the tenant.
Payload:
{
"account": {
"basicInfo": {
"accountName": "<account_name>",
"accountType": "master",
"serviceProviderType": "<provider_type>",
"serviceProviderCode": "<provider_code>",
"isActive": "Active",
"userType": "system",
"credential_count": 1
},
"modelVersion": "v2.1",
"advancedInfo": {
"endpoint": "https://some.service-now.com",
"authModel": "basic"
},
"credentials": [
{
"purpose": [
"systemIntegration"
],
"context": [
{
"team": [
"TEAM1"
]
}
],
"credentialName": "<credential_name>",
"status": "Active",
"passwordFields": {
"username": "<user>",
"password": "<password>",
"client_id": "{client_id}",
"client_secret": "{client_secret}"
}
}
]
}
}
The following are the payload parameters:
accountName:
Enter a name for the new account.
accountType:
Leave as
master
.
serviceProviderType:
Set as
itsm
.
serviceProviderCode:
Set as
itsm
.
isActive:
Leave as
Active
.
userType:
Leave as
system
.
credential_count:
Leave as
1
.
modelVersion:
The model version, which is currently
v2.1
.
endpoint:
The endpoint of your ServiceNow instance.
authModel:
Leave as
basic
.
purpose:
Leave as
systemIntegration
.
team:
Enter the team for which this account should be associated as context.
credentialName:
The name of the credential you will use to sign in to ServiceNow with.
username:
The name of the user to be used to sign in to ServiceNow.
password:
The password for the above user.
client_id:
Leave this empty because the authModel is
basic
.
client_secret:
Leave this empty because the authModel is
basic
.
Onboarding ServiceNow as a provider
To onboard a provider, complete the following steps:
On the
Manage ITSM Providers
page, click
ServiceNow
and click
Add Provider Endpoint
.
On the
Generic Parameters
tab, enter the following information and then click
Next
:
Associate any team, organization, context, environment, or account that you want associated with the ITSM system by selecting
Associate
and selecting the type of entity under
Business Entities
and then the specific entity.
In the
Mode of Communication
section, select one of these types:
Direct:
Select this when your ITSM system is in the public domain.
In the
Additional Data Schema
field, enter any extra description needed so that the purpose of the ITSM integration is clear or any other useful information.
On the
Review
tab, make sure that all parameters that you entered are correct, then click
Save
.
After the provider is onboarded, you receive a message prompting whether you want to add policies for the new provider. If you want to, click
Ok, Add Now
. For more information, see
Adding policies for ServiceNow.
Adding policies for Enterprise Marketplace
A group of default out-of-the-box policies are automatically provided. If these are insufficient, you can add your own policies by completing the following steps. For more information about policies in Enterprise Marketplace, see
Operation Policies.
Policies set so that they only affect a single provider, or they can be global. The procedures vary based on whether you have an older tenant or use the Foundation APIs: