Post-installation tasks
Post-installation tasks, these tasks include mandatory and optional configuration tasks.
App Menu in Application Navigator
ServiceNow provides an application navigator that enables administrators to navigate from one screen to another easily. To use 1E CMDB Connect application, first install it from ServiceNow app store and then search for 1E CMDB Connect in the application navigator. Non-administrators (end users) do not see 1E CMDB Connect at all. The menu is shown in the picture.
Here's an overview of the 1E CMDB Connect menu items and the roles needed to access each page:
Item |
Description |
Roles needed to view the Item's page |
|
---|---|---|---|
1E CMDB Connect app roles |
ServiceNow roles |
||
App Configuration |
Displays the application settings |
x_1e_tachyon_cmdb.admin |
admin (System Administrator) |
1E Import Schedules |
Displays a list of scheduled imports related to this application |
x_1e_tachyon_cmdb.admin |
admin (System Administrator) |
Instruction Definitions |
Displays a list of available 1E CMDB Connect instructions |
x_1e_tachyon_cmdb.admin |
admin (System Administrator) |
1E Information Services |
Displays a list of available 1E CMDB Connect instructions that can be run on the targeted endpoints all at once |
x_1e_tachyon_cmdb.admin, x_1e_tachyon_cmdb.config_manager |
admin (System Administrator) |
Triggered Instructions |
Displays a list of instructions that have been run |
x_1e_tachyon_cmdb.admin |
admin (System Administrator) |
Scheduled Jobs |
Displays the scheduled jobs to retrieve 1E instructions on daily basis |
n/a |
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_tachyon_cmdb.admin |
admin (System Administrator) |
App Configuration
After a successful 1E CMDB Connect install, an admin user must complete and save the App Configuration form listed under the 1E CMDB Connect module. Completing the configuration allows the 1E CMDB Connect 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 Instruction to import the instructions from 1E into ServiceNow.
The App Configuration page displays these fields:
Configuration field |
Description |
---|---|
1E User Name |
This is the user configured in ServiceNow and is responsible to fetch or execute instructions to or from 1E. Enter the 1E username and domain here. |
1E User Password |
This is the password for 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, with a default value of 120 with a valid range between 10 and 10080. The same feature is available in 1E Core as well. 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 admin has not provided any value, then 1E server by default considers the value saved in 1E Core app. |
Page size |
When devices are fetched (synced) from 1E into ServiceNow, these are fetched into batches. This feature sets the batch size for same. The default value is set to 1000. |
Response batch size |
The responses of instruction that are fetched 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 feature 1E Information Service trigger 1E instructions on all available end-user devices at once. These responses of instructions that are fetched from 1E into ServiceNow are fetched into batches. This feature sets the batch size for these responses. The default value is set to 1000. |
Response API wait seconds for 1E Information Service |
When an instruction is triggered from ServiceNow to 1E as a part of 1E Information Service, there is a continuous calling from ServiceNow to 1E for fetching the responses. In case there is no response available on 1E for this instruction, then the next response call is triggered after these many seconds. The default value is set to 10. |
There is a continuous counter on 1E from ServiceNow for getting responses. If responses are not empty, then the counter is set to 0 whereas if responses are empty (i.e. there is no response) then the counter is increased by 1. In case there is no response 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_tachyon_cmdb.pollMultiplier property.
The listed devices allow an admin user to configure the types of devices that are to be synced from 1E to ServiceNow. In the current version, the Endpoints (Desktop/Laptop) and Windows Server are available for configuration. This toggle allows the population of endpoint devices (cmdb_ci_computer) and Windows server (cmdb_ci_win_server).
If all the toggle options for devices are disabled, then no devices would be synced from 1E into ServiceNow.
Personalizing your Computers List
To configure the Computers list for 1E CMDB Connect, follow these steps:
-
Type cmdb_ci_computer.list in filter navigator and press enter. If you have not added any fields to the Personalize List, then it will only show the default fields, as shown in the picture opposite.
-
To add more fields, click the Personalize List (cogwheel icon) given in the top right corner and then select the fields from Personalize List Columns that you want to see in your Computers table and click OK to save.
-
Once you refresh, you can now see all the selected fields in the Computers table.
Configure these system properties
The Computes page retrieves and displays information about devices from the Computer table. You can add more details to the Computer table by adding these two system properties. By configuring the system property x_1e_tachyon_cmdb.enable_all_fields_mappings the below mentioned fields get mapped to the Computer table, otherwise you don't see these fields:
-
CPU Type
-
CPU Name
-
RAM
-
Chassis Type
On the other hand you can configure the system property x_1e_tachyon_cmdb.enable_os_name_with_version. By setting the value of this property to true you can get the full name of the OS along with version displayed in the Computer table.
Adding 1E CMDB Connect tab for Computers
To perform this task, ensure that your current application scope is Global.
To configure the Computer form for 1E CMDB Connect, follow these steps:
-
Type cmdb_ci_computer.list in filter navigator and press enter.
-
This opens up the Computers page as shown in the picture. To open an existing record of a device, click
the Name or Fully qualified domain name, whichever is the first field listed in the table. You can also click the information icon of the device to open an existing record. You can also click the New button given at the top for a blank record.
To open a new or blank record, you can click New.
-
Click the hamburger (three horizontal bars) and select Configure, then select Form layout as shown in the picture.
-
On the Configuring Computer Form page, under the 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 successful creation of the section, select 1E CMDB Connect in Section and move 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 cmdb_ci_computer table, and 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 Related Lists for Computers
To perform this task, ensure that your current application is Global.
Follow these steps to configure Related Lists:
-
Type cmdb_ci_computer.list in the filter navigator and press enter.
-
To open an existing device record on the Computers page, click the Name or Fully qualified domain name, whichever is the first field in the table. You can also click the information icon of the device to open an existing record. You can also click New given at the top of the page for a blank record.
-
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 the right under Selected list using > arrow as shown in the picture below.
-
Click the Save button to save the selection of lists. Now open any existing record for device in cmdb_ci_computer table and observe that the related lists are available.
For each selected related list, there is a respective button added on the Computer page. When you click a button, the related 1E instruction is triggered. The table below shows the mapping between the related list and the respective Tachyon instruction:
Related list |
Required 1E instruction |
---|---|
1E CI IPs |
1E-Explorer-TachyonCore-GetIpAddresses.xml |
1E File Systems |
1E-Explorer-TachyonCore-LogicalDiskDetails.xml |
1E Installed Software |
1E-Explorer-TachyonCore-AllInstalledSoftware.xml |
1E RAM Usage |
1E-Explorer-Examples-GetMemoryFromSysInfo.xml |
1E Running Process |
1E-Explorer-TachyonCore-NetworkListeningProcessesAndPorts.xml |
1E TCP Connections |
1E-Explorer-Examples-GetConnections.xml |
An admin user can add any number of Related Lists as required.
Adding 1E CMDB as a discovery source
Follow the steps below to add '1E CMDB' as a discovery source:
-
Type sys_choice.do in the filter navigator. This opens into a form that allows an admin user to add a new record to the sys_choice table.
-
In Table dropdown list, select Configuration Item [cmdb_ci].
-
In Element Textbox type discovery_source.
-
Type 1E CMDB in Label text box.
-
Type 1E CMDB in Value text box.
-
Click Submit button.
-
1E CMDB is successfully added as a discovery source.
Adding Windows Server table
After you have saved the configuration on App Configuration page, to populate Windows server devices in the CMDB table, you need to perform these tasks.
To configure form layout and related list for Windows server table for 1E CMDB Connect, follow these steps:
-
Ensure that your current application scope is Global.
-
Type cmdb_ci_win_server.list in the filter navigator and press enter.
-
This opens up the Windows Server page as shown in the picture. To open an existing record of a device, click the Name or Fully qualified domain name, whichever is the first field listed in the table. You can also click the information icon of the device to open an existing record.
To open a new or blank record, you can click the New button.
-
Click the hamburger (three horizontal bars) or right-click the header and select Configure, then select Form layout as shown in the picture.
-
On the Configuring Windows Server Form page, under the 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 successful creation of the section, select 1E CMDB Connect in Section and move 1E CMDB Connector item from Available to Selected list box. Click Save to complete the form layout setup.
-
Now to configure the related lists, go back to blank record. Click the hamburger (three horizontal bars) or right-click the header and select Configure, then select Related Lists as shown in the picture.
-
On the Configuring related lists on Windows Server form screen, select all six options present in the Available list and move them onto the right under Selected list using > arrow as shown in the picture below.
-
Click the Save button to save the selection of lists. Now open any existing record for device in cmdb_ci_win_server table and observe that the related lists are available.
-
Now create an import schedule to populate the Windows Server data.
-
Navigate to 1E Import Schedules tab available under the 1E CMDB Connect menu.
-
Create a new record by clicking on the New button given in the top right corner. Select the Target Table as Windows Server (cmdb_ci_win_server). Based on the selection of the Target Table, the Filter value gets populated.
-
Click the Execute Now button in order to populate the Windows Server data into the Windows Server table.
-
Now go to Windows Server table (cmdb_ci_win_server) and check whether the list of populated servers are from discovery source 1E CMDB.
-
Open any record and verify the population of mapped fields and the details populated under 1E CMDB Connect and Related lists.
User Roles provided by 1E CMDB Connect
ServiceNow provides role based access to users. 1E CMDB Connect provides three custom roles, as given below:
Role |
User Persona |
Description |
---|---|---|
x_1e_tachyon_cmdb.admin |
App Administrator |
This user will be able to modify App configuration settings. As an App Administrator a user will have access to other features like 1E Import Schedules, Instruction Definition, 1E Information Service, Triggered Information and Support. |
x_1e_tachyon_cmdb.config_manager |
App Manager |
This user will have access to the 1E Information Service module to run any 1E instructions on the devices. |
x_1e_tachyon_cmdb.user |
App User |
This user will be able to view the device information fetched from 1E. The user will also be able to view the Related Lists available on the same Computer page. |