Enhanced CMDB Module to customize Standard Tabs and Fields

Owned by Saranya S
Last updated: Apr 23, 2024 by Shilpa K (Deactivated)Version comment
7 min read

Read Complete Release Notes

Feature released in SummitAI IT Service Management (CMDB, Tahoe)

What's New?

Organization often requires the ability to view and update tabs and fields that are required as per the business requirements and scenarios. Now, for the Configuration Items mapped to a system defined standard classification, you can customize the tabs and fields of the standard tabs. The configuration capability for the Standard tabs provides great flexibility to the organizations to maintain data sets within the CMDB module.

In the CMDB module, the following standard tabs are now customizable:

  • Server
  • Desktop
  • Network Device (Network link)

Business Benefits

CMDB provides you the following business benefits:

  • Enable or disable the Standard tabs in the Tab section
  • Disable the fields in Standard tabs
  • Create custom fields for the Standard tabs

If the Configuration Items are mapped to the Server, Desktop, and Network Device tabs, then the tabs and fields are configurable using the Form Builder.

Example, if Server option is selected from Classification field of the CUSTOM ATTRIBUTE FOR CMDB page then it displays SERVER section with the details wherein you can deactivate or edit the fields. For more information, see Configuring Custom Fields for CMDB.

Note:

You will not be able to rename the existing fields and group name in the Form Builder of the Standard tabs. Also, when renaming the tabs:

  • For Standard Classification Tab – You will not be able to rename the Tab name, only it can be deactivated (Server, Network, Desktop).
  • For Custom Classification Tab – Can be renamed but will not be able to provide the same name that is provided for system defined standard classification tabs already (ex, Server, Network, Desktop).


Figure: CUSTOM ATTRIBUTE FOR CMDB page: Server Tab

To customize the tabs and fields of Server, Desktop, and Network tabs, see Adding Custom Tabs and edit the fields on the CUSTOM ATTRIBUTE FOR CMDB page, see Configuring Custom Fields for CMDB. The fields are displayed on the Configuration Item page based on the configuration done in the Form Builder.

UI Impacts

Tenant page

On the Tenant page of CMDB module, under Details section, the Configure CI Mandatory fields will not display the fields of Server and Network Device tabs since these tabs are now customizable in Form Builder.

  • If the existing records are configured under Configure CI Mandatory fields, it is automatically reflected in the Form Builder. For more information, see Configuring CMDB Module.
  • If you are creating a new Tenant, the system defined standard classification fixed fields are created as custom fields in the Form Builder (Server, Network and Desktop Tab).

Child classification can be created for system defined standard classification, the same tab and fields of Parent classification are available for Child classification also. Activate and deactivate is done separately for Parent and Child classification in the Form Builder.

CMDB Discovery Mapping page

On the CMDB Discovery Mapping page, only the General tab details are displayed by default. To view the Custom Tab field details, you should select the tabs manually in the Classification.

  • If the customs fields are inactive on the Form builder then the details cannot be viewed. For more information, see Configuring CMDB Discovery Mapping.
  • The Server, Desktop, and Network fields will be displayed with the Field and Tab name on the CMDB Discovery Mapping
  • If already the configuration is done for fixed fields of standard classification, the same is applicable for the dynamic fields.

CMDB Data Migration

For CMDB Data Migrations, execute the CMDB Data Migration job. The CMDB Data Migration job is configured in the Custom Scheduler (Admin > Basic > Infrastructure > Custom Scheduler). For more information, see Configuring Custom Scheduler.

Migration Scenario:

If you want to migrate the existing configured CI data for the system defined standard classification, such as Server, Network, and Desktop from fixed fields to the custom fields. If any CI data flows from Asset or ITOM module, the CMDB Data Migration job takes care by syncing the fixed fields to the custom fields. Similarly, for similar migration scenarios the job can be used.

REST API for Creating or Updating a CI

Custom Tabs and Attributes can be posted through REST API, when creating or updating a CI for the Classification. A new "Tab Name" field is added to the JSON. When posting the CI using POST method, you can specify the tab name in the "Tab Name" fields to create or update the Custom Tab. Also, "Tab Name" with "Multiple value" field can be added in the JSON.

Now, the Server, Network, Desktop tabs and fields can be added as custom fields or fixed fields.

Server Tab API Details

Standard Tab 
{
 "ServiceName": "CMDB_CreateOrUpdateCIDetails",
 "objCommonParameters":{ 
"_ProxyDetails":{ 
"AuthType": "APIKEY", 
"APIKey": "XXXXX",
 "ProxyID": 0, 
"ReturnType": "JSON" 
 },
 "_CMDBDetails": {
 "Configuration_Id": 0,
 "InstanceName": "Info",
"Device_Host_Name": "Router1",
 "Serial_No": "SNoRouter1",
 "Owner_Workgroup_Name": "CMDB Workgroup",
 "Owner_Name": "john@gmail.com",
 "Managed_By": "CMDB Workgroup",
 "Classification": "Server",
 "Status": "Production",
 "LifeCycleStatus": "Design",
 "Criticality_Name": "High",
 "Customer": "SUMMIT",
 "VendorName": "",
 "LocationName": "",
 "Make": "Microsoft Corporation",
 "Mac_Address": "3E:45:DT:G6",
 "Model_No": "VMware",
 "Rack": "Rack1",
 "Warranty": "2018-04-30",
 "Annual_Maintains_Contract": "Contract",
 "Version": "1.0",
 "Description": "CI Created for Server",
 "Remarks": "CI Created for Server",
 "Test_Plan_Mandatory": true,
 "Purchase_Order_No": "PO123",
 "Server_CPU": "8 Core Processor",
 "Server_Hard_Disk_Drive": "80 GB",
 "Server_RAM": "8 GB RAM",
 "Server_NIC": "2",
 "Server_NETWORK": "LAN",
 "Server_RAID_LEVEL": "1",
 "Server_RAID_CARD": "2",
 "Server_BACKUP_STATE": true,
 "Server_BACKUP_DETAILS": "Back up on secondary",
 "Server_OPERATING_SYSTEM": "Windows 2016 Standard",
 "Server_SERVICE_PACK": "SP 1",
 "Server_INSTALLED_APPLICATIONS": "Windows",
 "Server_PATCHES": "Windows"
 }
 }
}
Custom Tab 
{
 "ServiceName": "CMDB_CreateOrUpdateCIDetails",
 "objCommonParameters":{ 
"_ProxyDetails":{ 
"AuthType": "APIKEY", 
"APIKey": "XXXXX",
 "ProxyID": 0, 
"ReturnType": "JSON" 
 },
 "_CMDBDetails": {
 "Configuration_Id": 0,
 "InstanceName": "Info",
"Device_Host_Name": "Router1",
 "Serial_No": "SNoRouter1",
 "Owner_Workgroup_Name": "CMDB Workgroup",
 "Owner_Name": "john@gmail.com",
 "Managed_By": "CMDB Workgroup",
 "Classification": "Server",
 "Status": "Production",
 "LifeCycleStatus": "Design",
 "Criticality_Name": "High",
 "Customer": "SUMMIT",
 "VendorName": "",
 "LocationName": "",
 "Make": "Microsoft Corporation",
 "Mac_Address": "3E:45:DT:G6",
 "Model_No": "VMware",
 "Rack": "Rack1",
 "Warranty": "2018-04-30",
 "Annual_Maintains_Contract": "Contract",
 "Version": "1.0",
 "Description": "CI Created for Server",
 "Remarks": "CI Created for Server",
 "Test_Plan_Mandatory": true,
 "Purchase_Order_No": "PO123",
 "CustomFields": [
 {
 "GroupName": "Server Details",
 "ID": "0",
 "Name": "CPU",
 "Value": "7 Core Processor",
 "TabName": "Server"
 },
{
 "GroupName": " Server Details",
 "ID": "0",
 "Name": " Hard_Disk_Drive",
 "Value": "345",
 "TabName": "Server"
 }
]
 }
 }
}

Network Tab API Details

Standard Tab 
{
 "ServiceName": "CMDB_CreateOrUpdateCIDetails",
 "objCommonParameters":{ 
"_ProxyDetails":{ 
"AuthType": "APIKEY", 
"APIKey": "XXXXX",
 "ProxyID": 0, 
"ReturnType": "JSON" 
 },
 "_CMDBDetails": {
 "Configuration_Id": 0,
 "InstanceName": "Info",
 "Device_Host_Name": "Router2",
 "Serial_No": "SNoRouter2",
 "Owner_Workgroup_Name": "CMDB Workgroup",
 "Owner_Name": "john@gmail.com",
 "Managed_By": "CMDB Workgroup",
 "Classification": "Network Device",
 "Status": "Production",
 "LifeCycleStatus": "Design",
 "Criticality_Name": "High",
 "Customer": "SUMMIT",
 "VendorName": "",
 "LocationName": "",
 "Make": "Microsoft Corporation",
 "Mac_Address": "3E:45:DT:G6",
 "Model_No": "VMware",
 "Rack": "Rack1",
 "Warranty": "2018-04-30",
 "Annual_Maintains_Contract": "Contract",
 "Version": "1.0",
 "Description": "CI Created for Network",
 "Remarks": "CI Created for Network",
 "Test_Plan_Mandatory": true,
 "Purchase_Order_No": "PO123",
  "Network Device_ Device Type": "8 Core Processor",
  "Network Device_IOS/Software": "80 GB",
  "Network Device_Access List ": "8 GB RAM",
  "Network Device_Routes ": "2",
  "Network Device_ A End Description": "LAN",
  "Network Device_ A End IP Address": "Windows 2016 Standard",
  "Network Device_ B End Description ": "SP 1",
  "Network Device_ Subnet Mask": "Windows",
  "Network Device _ Gateway ": "Windows"
  "Network Device_ No. of Slots": "1",
  "Network Device_ Slot Numbers": "SP 1",
  "Network Device_ Ports": "Windows",
  "Network Device _ Card Type": "Windows"
  "Network Device_ VLAN": "Windows",
  "Network Device_ Memory (Flash)": "SP 1",
  "Network Device_ Memory (DRAM)": "Windows",
  "Network Device _ Card Type": "Windows"
 }
 }
}
Custom Tab 
{
 "ServiceName": "CMDB_CreateOrUpdateCIDetails",
 "objCommonParameters":{ 
"_ProxyDetails":{ 
"AuthType": "APIKEY", 
"APIKey": "XXXXX",
 "ProxyID": 0, 
"ReturnType": "JSON" 
 },
 "_CMDBDetails": {
 "Configuration_Id": 0,
 "InstanceName": "Info",
"Device_Host_Name": "Router1",
 "Serial_No": "SNoRouter1",
 "Owner_Workgroup_Name": "CMDB Workgroup",
 "Owner_Name": "John@gmail.com",
 "Managed_By": "CMDB Workgroup",
 "Classification": "Network device",
 "Status": "Production",
 "LifeCycleStatus": "Design",
 "Criticality_Name": "High",
 "Customer": "SUMMIT",
 "VendorName": "",
 "LocationName": "",
 "Make": "Microsoft Corporation",
 "Mac_Address": "3E:45:DT:G6",
 "Model_No": "VMware",
 "Rack": "Rack1",
 "Warranty": "2018-04-30",
 "Annual_Maintains_Contract": "Contract",
 "Version": "1.0",
 "Description": "CI Created for Network",
 "Remarks": "CI Created for Network",
 "Test_Plan_Mandatory": true,
 "Purchase_Order_No": "PO123",
 "CustomFields": [
 {
 "GroupName": "Network Details",
 "ID": "0",
 "Name": "B End IP Address",
 "Value": "7 Core Processor",
 "TabName": "Network"
 },
{
 "GroupName": "Network Details",
 "ID": "0",
 "Name": " Ports",
 "Value": "345",
 "TabName": " Network"
 }
]
 }
 }
}

Desktop Tab API Details

Standard Tab 
{
 "ServiceName": "CMDB_CreateOrUpdateCIDetails",
 "objCommonParameters":{ 
"_ProxyDetails":{ 
"AuthType": "APIKEY", 
"APIKey": "XXXXX",
 "ProxyID": 0, 
"ReturnType": "JSON" 
 },
 "_CMDBDetails": {
 "Configuration_Id": 0,
 "InstanceName": "Info",
 "Device_Host_Name": "Router2",
 "Serial_No": "SNoRouter2",
 "Owner_Workgroup_Name": "CMDB Workgroup",
 "Owner_Name": "john@gmail.com",
 "Managed_By": "CMDB Workgroup",
 "Classification": "Desktop",
 "Status": "Production",
 "LifeCycleStatus": "Design",
 "Criticality_Name": "High",
 "Customer": "SUMMIT",
 "VendorName": "",
 "LocationName": "",
 "Make": "Microsoft Corporation",
 "Mac_Address": "3E:45:DT:G6",
 "Model_No": "VMware",
 "Rack": "Rack1",
 "Warranty": "2018-04-30",
 "Annual_Maintains_Contract": "Contract",
 "Version": "1.0",
 "Description": "CI Created for Desktop",
 "Remarks": "CI Created for Desktop",
 "Test_Plan_Mandatory": true,
 "Purchase_Order_No": "PO123",
  "Desktop_CPU": "8 Core Processor",
 "Desktop_Hard_Disk_Drive": "80 GB",
 "Desktop_RAM": "8 GB RAM",
 "Desktop_NIC": "2",
 " Desktop_NETWORK": "LAN",
 " Desktop_OPERATING_SYSTEM": "Windows 2016 Standard",
 " Desktop_SERVICE_PACK": "SP 1",
 " Desktop_INSTALLED_APPLICATIONS": "Windows",
 " Desktop_PATCHES": "Windows"
 }
 }
}
Custom Tab 
{
 "ServiceName": "CMDB_CreateOrUpdateCIDetails",
 "objCommonParameters":{ 
"_ProxyDetails":{ 
"AuthType": "APIKEY", 
"APIKey": "XXXXX",
 "ProxyID": 0, 
"ReturnType": "JSON" 
 },
 "_CMDBDetails": {
 "Configuration_Id": 0,
 "InstanceName": "Info",
"Device_Host_Name": "Router1",
 "Serial_No": "SNoRouter1",
 "Owner_Workgroup_Name": "CMDB Workgroup",
 "Owner_Name": "john@gmail.com",
 "Managed_By": "CMDB Workgroup",
 "Classification": "DESKTOP",
 "Status": "Production",
 "LifeCycleStatus": "Design",
 "Criticality_Name": "High",
 "Customer": "SUMMIT",
 "VendorName": "",
 "LocationName": "",
 "Make": "Microsoft Corporation",
 "Mac_Address": "3E:45:DT:G6",
 "Model_No": "VMware",
 "Rack": "Rack1",
 "Warranty": "2018-04-30",
 "Annual_Maintains_Contract": "Contract",
 "Version": "1.0",
 "Description": "CI Created for Desktop",
 "Remarks": "CI Created for Desktop",
 "Test_Plan_Mandatory": true,
 "Purchase_Order_No": "PO123",
 "CustomFields": [
 {
 "GroupName": "Desktop Details",
 "ID": "0",
 "Name": "CPU",
 "Value": "7 Core Processor",
 "TabName": "Desktop"
 },
{
 "GroupName": " Desktop Details",
 "ID": "0",
 "Name": " Hard_Disk_Drive",
 "Value": "345",
 "TabName": "Desktop"
 }
]
 }
 }
}

Note:

For updating the CI details, the Configuration Id value should be provided based on the requirement. Provide valid CI ID in the Configuration Id value.