Post-installation tasks
There are certain tasks that must be completed post-installation, in order for your 1E and ServiceNow integration to work correctly. These tasks include both mandatory and optional configuration steps.
App Menu
ServiceNow provides an application navigator that enables administrators to navigate between the screens. To use SGC for 1E application, first install it from ServiceNow app store and then search for SGC for 1E in the application navigator. Non-administrators (end users) do not have access to SGC for 1E. The application menu is shown in the picture below.
Here's an overview of the SGC for 1E menu items and the roles needed to access each page:
Item |
Description |
Roles needed to view the Item's page |
|
---|---|---|---|
SGC for 1E app roles |
ServiceNow roles |
||
Setup |
Displays guided setup to configure the application. |
n/a |
admin (System Administrator) |
Data Sources |
Displays a list of data sources related to SGC for 1E. |
n/a |
admin (System Administrator) |
Scheduled Imports |
Displays a list of scheduled imports related to SGC for 1E. |
n/a |
admin (System Administrator) |
Scheduled Jobs |
Displays a list of scheduled jobs for SGC for 1E. |
n/a |
admin (System Administrator) |
Integration Dashboard |
This Dashboard shows the execution status of CMDB. |
n/a |
admin (System Administrator) |
1E DEX Settings |
Displays the application settings. |
x_1e_cmdb_connect.admin |
admin (System Administrator) |
Instruction Definition |
Displays a list of available SGC for 1E instructions. |
x_1e_cmdb_connect.admin |
admin (System Administrator) |
1E Information Service |
Displays a list of available SGC for 1E instructions that can be run on the targeted endpoints all at once. |
x_1e_cmdb_connect.admin |
admin (System Administrator) |
Triggered Instruction |
Displays a list of instructions that have been run. |
x_1e_cmdb_connect.admin |
admin (System Administrator) |
Logs |
Displays the application specific logs. |
n/a |
admin (System Administrator) |
Support |
Displays information on how to contact 1E Support. |
x_1e_cmdb_connect.admin |
admin (System Administrator) |
1E DEX Settings
After a successful SGC for 1E install, the admin user must complete and save the 1E DEX Settings form listed under the SGC for 1E application menu, shown below. Completing the configuration allows the SGC for 1E app to communicate with 1E.
To test whether the application is successfully synced with 1E server, click Test Server Connection in the top right corner. Once the connection is established, click Retrieve Instructions to import the instructions from 1E into ServiceNow.
The 1E DEX Settings page displays these fields:
Configuration field |
Description |
---|---|
1E User Name |
This is the user configured in ServiceNow and is responsible for fetching or executing instructions to or from 1E. Enter the Tachyon username and domain here. |
1E User Password |
This is the password for the 1E User to fetch and execute instructions. |
1E Instructions keep answers minutes |
This value is used when ServiceNow sends an instruction to 1E and displays how long a 1E response is active after the instruction is executed. It has a default value of 120 with a valid range between 10 and, 10080, the same feature is also available in 1E Core. If an admin has not provided a value, 1E uses the value saved in the 1E Core app. |
1E Instructions gather data minutes |
This value shows the timeframe in minutes for how long 1E should gather the instruction response data. It has a default value of 60 with a valid range between 10 and, 10080. The same feature is available in 1E Core as well. In case an admin has not provided a value, then 1E server by default considers the value saved in 1E Core app. |
Response batch size |
The instruction responses from 1E into ServiceNow are fetched into batches. This feature sets the batch size for these responses. The default value is set to 100. |
Response batch size for 1E Information Service |
The instruction responses from 1E into ServiceNow are fetched into batches. This feature sets the batch size for these responses. Default value is 1000. |
Response API wait seconds for 1E Information Service |
When an instruction gets triggered from ServiceNow to 1E as a part of the 1E Information Service, there is a continuous calling from ServiceNow to 1E for fetching the responses. If there is no response available from 1E for this instruction, the next response call is triggered after a period of seconds. The default value is set to 10. |
There is a continuous counter on 1E from ServiceNow for getting responses. If the responses are not empty, then the counter is set to 0 whereas if responses are empty (for example, there is no response) then the counter is increased by 1. In case there are no responses for more than three times from 1E, then we increase this wait time as shown in the following formula:
Wait time = (Counter value / 3) * 5 * (Response API wait seconds for 1E Information Service).
For example: If wait counter is 7 and wait time is set to 10 seconds by an admin on the configuration page, then wait time = (7 / 3) * 5 * 10 = 2 * 50 = 100 seconds.
The value 5 here is called a poll multiplier. To change this value, update the value in the x_1e_cmdb_connect.pollMultiplier system property.
Adding 1E CMDB Connect tab for a device
Ensure that your current application scope is Global to perform this task.
To configure the device form to display 1E CMDB Connect tab, follow these steps:
-
Type cmdb_ci_computer.LIST in filter navigator and press enter.
-
This opens up the Computers page in a new tab. To open an existing record of a device, click Name or the information icon of the device. You can also click New given at the top for a blank record.
-
A form will open up, click the hamburger (three horizontal bars) and select Configure, then select Form Layout as shown in the picture.
-
On the Configuring Computer form page, in Form view and section select New... item in the Section drop down list to create a new section as shown below in the picture.
-
A pop-up for Create new section opens up. Type the Section caption as 1E CMDB Connect and click OK.
-
After you have successfully created the section, select 1E CMDB Connect in Section and move the 1E CMDB Connector item from Available to Selected list box. Click Save to complete the form layout setup.
-
Now, open any existing record for device in the cmdb_ci_computer table, you can see that the 1E CMDB Connect tab is now available.
An admin user can add multiple tabs of any specification as required.
Adding 1E CMDB Connect tab for Windows Server
To perform this task, ensure that your current application is Global.
Similarly follow the steps below, to configure 1E CMDB Connect tab for a Windows Server:
- Type cmdb_ci_win_server.LIST in filter navigator and press enter.
- This opens up the Windows Server page in a new tab. To open an existing record of a Windows Server, click the Name or the information icon. You can also click the New button given at the top for a blank record.
- A new Windows Server record opens up, now click the hamburger (three horizontal bars) and select Configure, then select Form Layout.
-
On the Configuring Windows Server form page, in Form view and section select New... item in the Section drop down list to create a new section.
-
A pop-up for Create new section opens up. Type the Section caption as 1E CMDB Connect and click OK.
-
After you have successfully created the section, select 1E CMDB Connect in Section and move the 1E CMDB Connector item from Available to Selected list box. Click Save to complete the form layout setup.
-
Now, open any existing record for device in the cmdb_ci_win_server table, you can see that the 1E CMDB Connect tab is now available.
Adding Related Lists to a device
To perform this task, ensure that your current application is Global.
Follow these steps to configure Related Lists:
-
Type cmdb_ci_computer.LIST in filter navigator and press enter.
-
To open an existing device record on the Computers page, click Name or the information icon of the device. You can also click New given at the top of the page for a blank record.
-
A form will open up, click the hamburger (three horizontal bars), select Configure, then select Related Lists as shown in the picture.
-
On the Configuring related lists on Computer form screen select all six options present in Available list and move them onto right under Selected list using > arrow.
-
Click Save to save the selection of lists. Now open any existing record for a device in the cmdb_ci_computer table and note that the related lists are now available.
For each selected related list, there is a respective button added on the Computer page. When you click this button, it triggers the related 1E instruction. The table below shows the mapping between the related list and the associated 1E instruction.
Related list |
Required Tachyon instruction |
---|---|
1E CI IPs |
1E-Explorer-TachyonCore-GetIpAddresses |
1E File Systems |
1E-Explorer-TachyonCore-LogicalDiskDetails |
1E Installed Software |
1E-Explorer-TachyonCore-AllInstalledSoftware |
1E RAM Usage |
1E-Explorer-Examples-GetMemoryFromSysInfo |
1E Running Process |
1E-Explorer-TachyonCore-NetworkListeningProcessesAndPorts |
1E TCP_Connections |
1E-Explorer-Examples-GetConnections |
An admin user can add any number of Related Lists as required.
Adding Related Lists for Windows Server
To perform this task, ensure that your current application is Global.
Similarly follow the steps below, to configure Related Lists for a Windows Server:
-
Type cmdb_ci_win_server.list in filter navigator and press enter.
-
To open an existing record on the Windows Serverpage, click the Name or the information icon. You can also click the New button given at the top of the page for a new record.
-
A new Windows Server record opens up, now click the hamburger (three horizontal bars) and select Configure, then select Related Lists.
-
On the Configuring related lists on Windows Server form screen select all the same six options as CI present in Available list and move them onto right under Selected list using > arrow.
-
Click the Save button to save the selection of lists. Now open any existing record for a device in the cmdb_ci_win_server table and note that the related lists are now available.
For each selected related list, there is a respective button added on the Windows Server page. When you click this button, it triggers the related 1E instruction.
SG-1ETachyon as a discovery source
At first, verify whether SG-1ETachyon is already a discovery source on your ServiceNow instance or not.
Follow the steps below to find SG-1ETachyon in discovery source:
-
Type dictionary in filter navigator and press enter. This opens into Dictionary Entries page on the right-pane of your ServiceNow window.
-
Now type =cmdb_ci in the search box under column Table and *discovery_source in the search box under Column name and press enter.
-
This filters the available list of records and results into the cmdb_ci table as shown in the picture opposite.
-
Click cmdb_ci to open the record.
-
It opens the Dictionary Entry page on the right-pane of your ServiceNow window, as shown in the second picture on the right.
-
Scroll down and click the Choices tab at the bottom of the page.
-
This displays a complete list of all the choices and the respective suggested value, along with other details.
-
Look for SG-1ETachyon in this list.
-
If you don't find SG-1ETachyon in the list, then click the New button to add.
Follow the below steps to add it to the discovery source.
Adding SG-1ETachyon as a discovery source
Follow the steps below to add SG-1ETachyon as a discovery source:
-
Follow the above given steps to check whether SG-1ETachyon is available in the Choices list.
-
If unavailable, click the New button to create a new record.
-
This opens a form allowing an admin user to add a new record to the sys_choice table.
-
Verify that you have Configuration Item cmdb_ci in the Table dropdown list.
-
Verify that you have discovery_source in the Element text box.
-
Type SG-1ETachyon in Label text box.
-
Type SG-1ETachyon in Value text box.
-
Click the Submit button.
-
SG-1ETachyon is now successfully added as a discovery source.
Update Scheduled Import for Integration Dashboard
To display data under the Integration Dashboard feature, it is important that you make the following configurations on the Scheduled Imports page.
- Click Scheduled Imports tab given under SGC for 1E menu items on the left. The Scheduled Data Imports page displays the lists of all available Imports.
- Look for SG-1E Computer from the available list of Imports as shown in the picture.
- Click SG-1E Computer to open the respective record as shown in the picture.
- Now check the Concurrent Import checkbox and click the Update button to save the changes made.
Scheduled Jobs to enable Remove Software
To enable the Remove Software feature, it is important that you make the following configurations on the Scheduled Jobs page.
- Click Scheduled Jobs tab given under Service Graph Connector for 1E menu items on the left. The Scheduled Jobs page displays the lists of every available job.
- Look for SG-1E Remove Software from the available list of jobs.
- Click SG-1E Remove Software to open the respective record as shown in the picture below.
- Now, perform the following tasks:
If you are using 1E Platform 24.11 and later versions, you should follow Setup for 1E SaaS to enable SG-1E Remove Software-Kafka schedule job for removing software.
User Roles provided by SGC for 1E
ServiceNow provides role based access to users. The SGC for 1E provides three custom roles, as displayed in the following list:
Role |
User Persona |
Description |
---|---|---|
x_1e_cmdb_connect.admin |
App Administrator |
This user can modify 1E Platform Settings. An App Administrator can access other features like 1E Settings, Schedule Jobs, Instruction Definition, 1E Information Service, Triggered Information and Support. |
x_1e_cmdb_connect.config_manager |
App Manager |
This user can access 1E Information Service module to run any 1E instruction on the devices. |
x_1e_cmdb_connect.user |
App User |
This user can view device information fetched from 1E. The user can also view the Related Lists available on the same Computer and Windows Serverpage. |