Alarm Fields, REST Examples and Attribute Mapping

Alarm Fields, REST examples and Attribute mapping
casp1041
DX NetOps Spectrum
Alarm Fields
By default, the enhanced integration framework for integrating
DX NetOps Spectrum
with the third-party Service Desk applications uses a polling mechanism to communicate with all the Service Desks.
The following
DX NetOps Spectrum
Alarm Model fields data is passed to Service Desks to create an incident.
  • Summary
  • reportedByUserID
  • Severity
  • Alarm_Status
  • assetID
  • TroubleShooter
  • Creation_Date
  • ModifiedTime
  • affectedEndUserID
  • resolution
Mapping Alarm Model Fields to Incident Fields
The following REST API returns mappings of the above-mentioned
DX NetOps Spectrum
alarm model fields to the incident fields:
URL
Sample
: http://<serverhost>:<serverport>/ca-nim-sm/api/v2/config/integration/caspectrum/mapping/incident
Method
GET
Request Body
None
Headers
Authorization
: Basic bmltYWRtaW46bmltYWRtaW4=
Accept
: application/json
Content-type
: application/json
Response
[
{
"NIMField": "reportedByUserID",
"MDRField": "reportedByUserID",
"Description": "UserName or ID of the user who reported the Incident"
},
{
"NIMField": "name",
"MDRField": "summary",
"Description": "short description of the Incident"
},
{
"NIMField": "severity",
"MDRField": "severity",
"Description": "Severity of the Incident"
},
{
"NIMField": "description",
"MDRField": "description",
"Description": "Description of the Incident"
},
{
"NIMField": "status",
"MDRField": "alarmStatus",
"Description": "Status of the Incident"
},
{
"NIMField": "affectedCIID",
"MDRField": "assetID",
"Description": "CI on which Incident is created"
},
{
"NIMField": "assigneeUserID",
"MDRField": "troubleShooter",
"Description": "User to which the incident is assigned"
},
{
"NIMField": "creationTimeStamp",
"MDRField": "creationDate",
"Description": "Time at which the incident is created/opened"
},
{
"NIMField": "updatedTimeStamp",
"MDRField": "modifiedTime",
"Description": "Last updated time stamp for the incident"
},
{
"NIMField": "affectedEndUserID",
"MDRField": "affectedEndUserID",
"Description": "UserName or ID of the user impacted by the Incident"
},
{
"NIMField": "resolution",
"MDRField": "resolution",
"Description": "Describes the resolution of the incident"
}
]
Mapping Incident Fields and Service Desk Incident
To view field mappings between integration incident and Service Desk incident, use the below REST API:
URL
Generic
:http://<serverhost>:<serverport>/ca-nim-sm/api/<version>/config/integration/<mdrName>/mapping/<ciName>
Sample
:
http://<Spectrum_OC_Host>:<OC_Port>
/ca-nim-sm/api/v2/config/integration/<service_desk_id>/mapping/incident
Method
GET
Request Body
None
Headers
Authorization
: Basic bmltYWRtaW46bmltYWRtaW4=
Accept
: application/json
Content-type
: application/json
Example
To see mappings between normalized incident and ServiceNow incident fields, following REST API should be invoked –
http://<serverhost>:<serverport>/ca-nim-sm/api/v2/config/integration/<service_desk_id>/mapping/incident
Verifying or Looking at Log Levels
This REST API is used to get log levels of the integration components.
URL
Generic
: http://<serverhost>:<serverport>/ca-nim-sm/api/<version>/Loglevel
Sample
:  http://<SPECTRUM_OC_HOST>:<OC_PORT>/ca-nim-sm/api/v2/Loglevel
Method
GET
Request Body
None
Headers
Authorization
: Basic bmltYWRtaW46bmltYWRtaW4=
Accept
: application/json
Content-type
: application/json
Response
[
{
"name": "root",
"level": "INFO"
},
{
"name": "cacsm",
"level": "INFO"
},
{
"name": "omodule",
"level": "INFO"
},
{
"name": "oapi",
"level": "INFO"
},
{
"name": "resources",
"level": "INFO"
},
{
"name": "model",
"level": "INFO"
},
{
"name": "HPServiceManager",
"level": "INFO"
},
{
"name": "common",
"level": "INFO"
},
{
"name": "configuration",
"level": "INFO"
},
{
"name": "com.ca.integration.normalization.mdr.ca.cmdb",
"level": "INFO"
{
"name": "BMCRemedy",
"level": "INFO"
},
{
"name": "im",
"level": "INFO"
},
{
"name": "ServiceNow",
"level": "INFO"
},
{
"name": "CASDM",
"level": "INFO"
}
]
Enable Loglevel in Integration Component to Debug
The following REST API is used to set the log level for the given integration component.
URL
Generic
: http://<serverhost>:<serverport>/ca-nim-sm/api/<version>/Loglevel/<name>
Sample
: http://<SPECTRUM_OC_HOST>:<OC_PORT>/ca-nim-sm/api/v2/Loglevel/common
Method
PUT
Request Body
None
Headers
Authorization
: Basic bmltYWRtaW46bmltYWRtaW4=
Accept
: application/json
Content-type
: application/json
Payload
{
"name": "common",
"level": "DEBUG"
}
Response
{
"name": "common",
"level": "DEBUG"
}
Attribute Mapping
The following table displays the attribute mappings between
DX NetOps Spectrum
(Alarms and Incidents) and the supported Service Desk applications.
Any updates made to these attributes from either
DX NetOps Spectrum
or the configured Service Desk will be updated and reflect in the other, based on the polling/ OneClick notification mechanism you configure.
The OneClick notification through the push mechanism is enabled/supported only for ServiceNow. By default,
DX NetOps Spectrum
polls the Service Desk servers for updates.
Alarm Field Name
Incident Field Name
MDR FIELD NAMES
MDR FIELD NAMES
MDR FIELD NAMES
MDR FIELD NAMES
CACSM
ServiceNow
HPSM
BMC Remedy ITSM
reportedByUserID
reportedByUserID
RequesterID
opened_by
Submitter
Summary
name
Description
short_description
Title
Description
Severity
severity
Severity
severity
description
description
DescriptionLong
description
Description
Detailed Description
Alarm_Status
status
TicketStatus
state
Status
Status
assetID
affectedCIID
RelatedCI
cmdb_ci
AffectedCI
Troubleshooter
assigneeUserID
AssignedContactID
assigned_to
Assignee
Assignee Login ID
Creation_Date
creationTimeStamp
CreationTimeStamp
opened_at
OpenTime
Submit Date
ModifiedTime
updatedTimeStamp
LastModTimeStamp
sys_updated_on
UpdatedTime
Last Modiied Date
affectednEnduserID
affectednEnduserID
RequestedForID
caller_id
TicketOwner
resolution
resolution
Resolution
close_notes
Solution
Resolution
Customize
DX NetOps Spectrum
to CA NIM Field Mapping
From 10.4.1, you can create a ticket with five more
DX NetOps Spectrum
attributes (either Alarm or Model) in the ticketing system using the CA Normalized Integration Management (NIM) custom attributes. You can map
DX NetOps Spectrum
attributes to NIM custom attributes and populate the same in the ticketing system.
Before adding a new attribute mapping, copy the nim-mappings-config.xml file from the
<SPECROOT>\tomcat\webapps\spectrum\WEB-INF\svdsk\config
directory to the 
<SPECROOT>\custom\svdsk\config
directory.
Prerequisites:
  • Ensure that you maintain a unique mapping; that is, one
    DX NetOps Spectrum
    attribute to one NIM Field.
  • Avoid duplicate entries in either
    DX NetOps Spectrum
    attribute or NIM Field.
  • A maximum of five custom mappings are supported, which is a limitation in NIM.
  • Ensure that the NIM custom fields are mapped to the corresponding Service Desk fields in the NIM Customization page to populate the
    DX NetOps Spectrum
    attributes to the ticketing system.
The following are the custom fields in CA NIM:
  • customField1
  • customField2
  • customField3
  • customField4
  • customField5
Sample Configuration for Reference:
The below example shows the customization of the
DX NetOps Spectrum
attribute to the CA NIM Field Mapping attributes to the ticketing system.
<custom-mappings> <incident> ---- --- <!-- ##### Attribute Custom Mapping Support ##### Below example describes - Spectrum Model Name (0x1006e) mapped to NIM customField1 - Spectrum Alarm Symptom Count(0x12a06) mapped to NIM customField2 Please make sure maintain unique mappings,i.e. 1 Spectrum Attribute to 1 NIM Field. There should not be duplicate entries in either Spectrum Attribute or NIM Field. Maximum 5 custom mappings are supported, which is current limitation in NIM Please make sure the NIM custom field mapped to the corresponding Service Desk field in the NIM Customization page to populate the spectrum attributes to the ticketing system. --> <attribute-mappings> <Mapping> <model-attribute>0x1006e</model-attribute> <NIMField>customField1</NIMField> </Mapping> <Mapping> <alarm-attribute>0x12a06</alarm-attribute> <NIMField>customField2</NIMField> </Mapping> </attribute-mappings> </incident> </custom-mappings