Review and update the equipment model details
Review and update the details for an equipment model that you imported into the ServiceNow AI Platform so that you can make sure that the information is correct. You can also manually create a new equipment model entity and then add details to it.
Before you begin
Import equipment model data to the ServiceNow AI Platform. To learn more, see Importing equipment model data.
Role required: cmdb_ot_isa_viewer, cmdb_ot_isa_editor, cmdb_ot_isa_admin.
About this task
If you have an assigned cmdb_ot_isa_viewer role, you can only view equipment model entities. If you have any of the other assigned cmdb_ot_isa roles, you can also edit equipment model entities.
Procedure
- Navigate to All > Industrial Workspace Admin > Industrial Process Manager > Equipment Model Manager.
-
In the Equipment model view for field, select the site that you
want to view the equipment model information for.
You can search for a site by typing in the site name or its short code.
-
Review an existing equipment model entity, or create one.
Task Description Review and update an existing equipment model In the selector pane, do the following actions: - Expand the equipment model hierarchy.
- Click the entity that you want to view.
Create an equipment model entity and populate the details - Click Create new entity.
- In the Create new entity form, fill in the details. To learn more, see Create an entity for a new equipment model.
- Click Save.
- Use the Equipment model view details form to enter the remaining details for the new equipment model entity.
-
On the form, review and update the fields.
Table 1. Equipment model details form Field Description Entity name Name of the equipment model entity. Note:You can update the Entity name field after the equipment model entity is created. Updating this field also updates the tree component and site filter.For more information, see Update the entity name or parent of an equipment model entity.
Parent Name of the entity, if any, that is the parent to this equipment model entity. This field is empty for the top-level parent entity, which has no parent. The top-level parent entity is referred to as a site. Note:You can update the Parent field after the equipment model entity is created.Updating this field also updates the tree component and site filter. For more information, see Update the entity name or parent of an equipment model entity.
Template Equipment model template that is assigned to an equipment model entity you manually create. Note:You can't assign an equipment model template to an equipment model that you imported into the ServiceNow AI Platform® using the Integration Hub ETL or a third-party integration.Level Hierarchical level that is assigned from the selected equipment model template for data sorting and structuring purposes. Examples are as follows: - Site
- Industrial site.
- Area
- Area in an industrial site.
- Work Center
- Work center in an industrial site.
Search for and select an equipment level to assign to the equipment model entity. To learn more, see Create hierarchical sorting levels for an equipment model template.
Type Name of the level type that is assigned to the equipment model template level. For example, Material Assembly or Production Cell for a Work Center level. To learn more, see Create equipment model level types. Short description Short description of this equipment model entity and its purpose. Short Code Short code that is assigned to this equipment model entity. Path Concatenation of the short codes of this equipment model entity and all its parent entities. For example, ATL-B42-MQSTOR-Z1is the concatenation of the following short codes:- ATL short code for the Atlanta site.
- B42 short code for Building B42.
- MQSTORE short code for Model M and Q.
- Z1 short code for the Zone 1 transfer storage zone for Model M and Q.
Location Location of the equipment model entity. For example, Atlanta Building 64 would be the location for each associated equipment model that is located there. Search for and select the location to assign to the equipment model entity. Timezone select the timezone that corresponds to the factory's physical location. Company Name of the company that is associated with the equipment model entity. Search for and select a company to assign to the entity. Assigned to Assigned user who operates and handles this equipment model entity. Search for and select the user to assign to the entity. Managed by Name of the assigned person who owns and is responsible for managing this entity record. Search for and select the user to assign to the equipment model entity. Process criticality Measure of how critical, or important, the equipment model entity is to the industrial process. Select the process criticality for the entity. For example: - 1 - most critical.
- 2 - somewhat critical.
Support Group Name of the group that supports this equipment model entity. Search for and select the user group to assign to the equipment model entity. Managed by Group Name of the assigned group that owns and is responsible for managing this entity record. Search for and select the user group to assign to the entity. Company Name of the company that the equipment model entity belongs to. The core_company value is stored in the CMDB in the ServiceNow AI Platform as a reference. Operational status Current operational status of the equipment model entity: - Operational
- Entity that is fully operational in the production process.
- Non-Operational
- Entity that is non-operational in the production process.
- Not in use
- Entity that is operational but intentionally offline. You can use this value to designate which sites are included for licensing purposes.
The sites marked as Not in use won't be visible in the Equipment Model Manager of the Industrial Workspace.
-
Review the associated equipment model data in the related list tabs as follows:
Task Description View the equipment model hierarchy See View the equipment model hierarchy. Map the upstream production processes for the equipment model entity. - Click Upstream Process.
- To learn more, see Map the upstream production processes for the selected equipment model entity.
Map the downstream production processes for the equipment model entity. - Click Downstream Process.
- To learn more, see Map the downstream production processes for the selected equipment model entity.
View the child entities for the equipment model entity. - Click Child Entities.
- To learn more, see Review the child entities for the equipment model entity.
View the OT devices that are associated with the current equipment model entity and its child entities. - Click Mapped OT Devices.
- To learn more, see Add OT devices that are associated with the selected equipment model entity.
Note:By default, you cannot see OT control modules in this list. -
When you finish reviewing and updating the equipment model details, do one of the
following actions.
Action Description Save the updated equipment model entity Click Save. Delete the equipment model entity Click Delete.
What to do next
- Mapped OT Devices
- OT Incidents
- OT Change Requests
- Vulnerable Items
- Remediation Tasks