Configure ServiceNow
ServiceNow is one of the ticketing systems that you can connect to in Zilla.
This article covers the following topics:
- 1.1 Prerequisites
- 1.2 Add a Public Key (Certificate)
- 1.3 Add an Application Registry (for Inbound Requests)
- 1.4 Add a Service User
- 1.5 Configure Zilla to Connect to ServiceNow
- 1.6 Create an Application Registry (for Outbound Requests)
- 1.7 Validate the Connection
- 1.8 Update System Property for Zilla Base URL
- 1.9 Sync the Applications and Permissions
- 2 Additional Information
Prerequisites
Admin account in Zilla
Access to certificates, application registry, and user administration in ServiceNow
Download the Zilla Security Access Requests from the ServiceNow Store
Submit a ticket to the Support team requesting a Zilla public key
Add a Public Key (Certificate)
In ServiceNow, search for and select
Certificates
in theAll
menu underSystem Definition
.
On the Certificates List page, click
New
.Name the certificate
Zilla Public Key
.Copy the public key provided by the Support team in the prerequisite activities, paste it in the certificate field, and click
Submit
.
Add an Application Registry (for Inbound Requests)
Search for and select
Application Registry
in theAll
menu.
Click
New
and select theCreate an OAuth JWT API endpoint for external clients
option.Provide a
Name
for the Application Registry and clickSubmit
. The client secret is auto-generated and should be left blank.
Return to the
Application Registry
you created. Go to theJWT Verifier Maps
tab and clickNew
.Name the JWT Verifier Map (for example, Zilla JWT Verifier) and click the magnifying glass for
Sys Certificate
. Select theZilla Public Key
.Click on
Submit
for both JWT Verifier Map and Application Registry.
Add a Service User
Next, create a service user that will be used to add comments and make updates to service requests. The email for this service user is servicenow-zilla-app@customertenant-domain
. For example, if your Zilla tenant domain is acme.org
, the email for the service user you create is servicenow-zilla-app@acme.org
.
Search for
User Administration
and selectUsers
from theAll
menu.
Click
New
to create a new user and fill out the details listed below.Username: servicenow-zilla-app
Email (from above):
servicenow-zilla-app@customertenant-domain
Replace
customertenant-domain
with the domain you use to access Zilla
First Name: Zilla
Last Name: ServiceNow Connector
In the
Roles
tab for the user, clickEdit
and add the roles listed below to the service user.catalog_admin
sn_request_write
If you use onboard provisioning, add the additional role listed below.
approval_admin
Keep this tab open to refer to when configuring Zilla.
Configure Zilla to Connect to ServiceNow
Open another tab and log in to your Zilla tenant as an admin. Click
Settings
in the navigation pane on the left side of the page andAdd Provider
under theConfigure Ticketing System
section.
Add the
ServiceNow Instance URL
,Client ID
, andClient Secret
. The Client ID and Client Secret were generated when adding the application registry for inbound requests.Click
Generate Token
to generate a Client ID and Secret for the next step.
Create an Application Registry (for Outbound Requests)
In ServiceNow, search for and select
Application Registry
in theAll
menu and clickNew
.Select
Connect to a third party OAuth Provider
.Fill out the details listed below.
Name: Type a name for the registry (for example, ServiceNow outbound to Zilla)
Client ID: Paste the Zilla-generated Client ID from the previous step
Client Secret: Paste the Zilla-generated Client Secret from the previous step
Token URL: Paste
https://app.zillasecurity.com/api/oauth2/token?domain=acme.org
replacingacme.org
with your tenant domainDefault Grant Type: Select
Client Credentials
Click
Submit
.Search for and open
Rest Message
from theAll
menu.Select
Zilla App Integration
and edit the record.Add the endpoint
https://app.zillasecurity.com
. Make sure the endpoint does not include a slash at the end of the URL.In the Authentication section, click the
Search
icon forOAuthProfile
, select the name that you gave while creating outbound Application Registry, and clickUpdate
.Return to the
Zilla App Rest Message
and clickGet OAuth Token
to open a dialogue box and attempt to fetch an OAuth token.
Validate the Connection
In Zilla, click
Check Connection
to validate that the connection is successful.
Update System Property for Zilla Base URL
In ServiceNow, search for
sys_properties.list
in theAll
field and pressEnter
.Search for
x_zis_sec_plg.zilla_endpoint
.Update to the base URL of the environment using
https://app.zillasecurity.com
.
Sync the Applications and Permissions
Applications and permissions are synced from Zilla and stored in ServiceNow tables. The request forms rely on the tables to show the application and permissions to the requestor. This is a scheduled job and can run on demand. The instructions below detail how to perform sync on demand.
On the ServiceNow homepage, search for and select
Scheduled Jobs
.Search for and select
Sync Zilla Applications and Permissions
.Click
Execute Now
to run an on-demand sync.
Additional configurations on this page include Sync Run Interval, Time Zone (if the time zone is set to --None--, the time zone will reflect your instance’s time zone), and Time (the exact time the sync job starts running).
Checking Application Logs to Confirm the Sync Completed
On the ServiceNow home page, go to
Application Logs
.Select
Message
from the dropdown and search for*Sync Zilla Application
. Three logs should be returned:Scheduled Job to Sync Zilla Application and Permissions ended at <time>
Starting DB actions to Sync Zilla Application and Permissions for <noOfApps> apps at <time>
Starting scheduled Job to Sync Zilla Application and Permissions at <time>
Additional Information
Configure Backup Approver
If Zilla is not able to assign approvers, this feature (if turned on) will assign people from the configured Group as approvers.
Search for
Users and Groups
in theAll
menu and selectGroups Search
.Find the group by the group name, right click on the group name, and click
Copy Sys Id
.Go to system properties by searching
sys_properties.list
in theAll
menu.Select
Application
from the dropdown and search forZilla
.The system properties display and can be changed as desired.
After enabling the feature, set appropriate values to approver group and delay.
System Properties and their Meanings
Property Name | Description | Default |
---|---|---|
x_zis_sec_plg.backup_approver_flow_enabled | Enable/Disable the backup approver flow | false |
x_zis_sec_plg.backup_approver_group_sysid | SysId of the group to be set | empty |
x_zis_sec_plg.backup_approver_delay_in_minutes | Delay (in minutes) after which backup approver is set | 10 |
Set Task Assignment Group for an Application
For task assignment, the Zilla workflow assigns the application technical owner (as set in Zilla) to the fulfillment task. Alternatively, an assignment group can be used instead.
Search for
Zilla
in theAll
menu and selectZilla Applications
.
If the assignment group column is not visible in the Zilla Applications view, it can be added by clicking on the gear icon and moving Assignment Group
from Available
to Selected
.
Click the name of the application to which you want to add the assignment group.
Add the group for task assignment to the Assignment Group field and update the record.
Role-Persona Mapping
Below is a representative mapping of expected roles for a persona. The actual mapping can vary based on your organization and ServiceNow set up.
Persona | Roles |
---|---|
Requestor | No role/default ServiceNow role |
Approver | approver_user & ITIL |
Assignee/Fulfiller | ITIL (minimum) or Admin |