Using 1E Core
The purpose of 1E Core is to enable 1E ServiceNow applications to leverage the capabilities of 1E. For example, 1E ITSM Connect enables rapid investigation of your network environment, allowing you to quickly retrieve device sets and perform immediate actions on them.
Instruction Definitions
The 1E Core application imports 1E instructions on behalf of other 1E ServiceNow applications and stores them in a table. An admin can view these application instructions fetched from 1E.
To access the Instruction Definitions page, a ServiceNow user must be a member of the following role:
-
x_1e_core_connect.admin
You can view every instruction available in ServiceNow on the Instruction Definitions page, as show below.
To view details for all instructions run by the 1E Core application:
- Log into your ServiceNow instance.
- Navigate to 1E Core → Instruction Definitions.
-
A new page appears with a list of run instructions.
The Instruction Definitions page displays the following information:
Field Name |
Description |
---|---|
Instruction Name |
The 1E instruction name. |
Instruction Description |
This field provides a brief description of what the instruction does. |
Type |
The kind of instruction — question or action. |
Instruction Set |
The 1E instruction set the instruction is grouped in. |
Active |
If the instruction is available to be used. |
Domain |
This field specifies whether the specific instruction is executed globally in an enterprise or to a specific domain. |
Business Application Name |
The 1E ServiceNow application that triggered the instruction. |
The Instruction Definitions page initially only displays active instructions. The instructions which are soft deleted by ServiceNow are Inactive and display a status of False in the Active column.
Instruction detail page
Clicking any Instruction Name from the list on the Instruction Definitions page, opens up the Instruction detail page. This page displays details of the selected instruction, as shown in the picture below.
At the bottom of the page there is an instruction parameter table, this lists every parameter required by the selected instruction. The Instruction Parameters table displays details of every parameter required by the selected instruction, including parameter name, type, allowed values and default values.
Instruction Parameter page
Click any parameter name on the Instruction Parameters table to open up the Instruction Parameter page. This page displays every detail of the selected parameter.
Updating Instruction sets
1E instruction sets are periodically updated, so when an admin user downloads them, they may include additions, deletions or other updates to the list of instructions.
This can result in an instruction or instructions set being unavailable, and the respective table of instructions is modified in ServiceNow. But ServiceNow only soft deletes instructions and marks them as inactive, ensuring data integrity is maintained by retaining historical data.
Triggered instructions
The 1E Core application passes instruction data between other 1E ServiceNow applications. For example, 1E instructions can be triggered from the incident form in the ITSM module of ServiceNow. 1E Core keeps a history of instructions it has executed (triggered) on behalf of those applications. The history includes:
-
The instructions
-
Parameters passed to a 1E instruction
-
Responses received from a 1E instruction
-
The Business Application that triggered the 1E instruction
-
Target end-user device
Triggered instruction history
A 1E Core administrator can view details for every instruction run in 1E Core.
To access the Triggered Instruction page, a ServiceNow user must be a member of the following role:
-
x_1e_core_connect.admin
To view details for instrcutions run on the 1E Core app:
-
Login to your ServiceNow instance.
-
Navigate to 1E Core→Triggered Instructions.
-
To view the details for a particular instruction, click the instruction ID link in the Number column. This displays the Triggered Instruction page for the selected instruction.
Triggered Instruction page
The Triggered Instruction page displays the following information:
Field Name |
Description |
---|---|
Number |
A unique number assigned to every triggered instruction record. |
Instruction Name |
The name of the executed instruction. |
Instruction Parameters |
This field contains JSON parameters passed to 1E for this triggered instruction. |
Target Endpoint |
The CI hostname (computer name) from the incident or request. It refers to the device name for the endpoint where 1E server will execute the instruction. |
Task |
The incident number where the 1E instruction was executed. |
Status |
The instruction status as reported by 1E, such as completed, error, awaiting approval etc. |
Instruction Execution ID |
The unique instruction ID returned by 1E when run. |
Business Application Name |
The 1E ServiceNow application that initiated the instruction. |
User |
The ServiceNow user that ran the instruction. |
Purging triggered instructions
The 1E Core application has common APIs that can be used by other 1E ServiceNow applications. This includes an API to purge instructions which accepts the following parameters:
-
Business Application Name
-
No. of Months.
The API purges triggered instructions specified by the Business Application Name and older than the given number of months. It will not purge triggered instructions passed by any other application and are newer than the specified number of months.