docs/sections/services/mapper/mappingfile.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 .. http://creativecommons.org/licenses/by/4.0
   3 .. Copyright 2018-2019 Tech Mahindra Ltd.
   4
   5 Mapping File
   6 ============
   7
   8 Mapping file is needed by Universal VES Adapter to convert the telemetry data into the VES format.
   9 The Adapter uses Smooks Framework to do the data format conversion by using the mapping files.
  10
  11 | To know more about smooks framework check the following link:
  12 | http://www.smooks.org/guide
  13
  14 SNMP Collector Default Mapping File
  15 ============
  16 Following is the default snmp mapping file which is used when no mapping file is found while processing event from SNMP Trap Collector.
  17
  18 .. code-block:: xml
  19
  20  <?xml version="1.0" encoding="UTF-8"?><smooks-resource-list xmlns="http://www.milyn.org/xsd/smooks-1.1.xsd" xmlns:jb="http://www.milyn.org/xsd/smooks/javabean-1.4.xsd" xmlns:json="http://www.milyn.org/xsd/smooks/json-1.1.xsd">
  21    <json:reader rootName="vesevent" keyWhitspaceReplacement="-">
  22       <json:keyMap>
  23          <json:key from="date&amp;time" to="date-and-time" />
  24       </json:keyMap>
  25    </json:reader>
  26    <jb:bean class="org.onap.dcaegen2.ves.domain.ves54.VesEvent" beanId="vesEvent" createOnElement="vesevent">
  27       <jb:wiring property="event" beanIdRef="event" />
  28    </jb:bean>
  29    <jb:bean class="org.onap.dcaegen2.ves.domain.ves54.Event" beanId="event" createOnElement="vesevent">
  30       <jb:wiring property="commonEventHeader" beanIdRef="commonEventHeader" />
  31       <jb:wiring property="faultFields" beanIdRef="faultFields" />
  32    </jb:bean>
  33    <jb:bean class="org.onap.dcaegen2.ves.domain.ves54.CommonEventHeader" beanId="commonEventHeader" createOnElement="vesevent">
  34       <jb:expression property="version">'3.0'</jb:expression>
  35       <jb:expression property="eventType">'FaultField'</jb:expression>
  36       <jb:expression property="eventId" execOnElement="vesevent">'XXXX'</jb:expression>
  37       <jb:expression property="reportingEntityName">'VESMapper'</jb:expression>
  38       <jb:expression property="domain">org.onap.dcaegen2.ves.domain.ves54.CommonEventHeader.Domain.FAULT</jb:expression>
  39       <jb:expression property="eventName" execOnElement="vesevent">commonEventHeader.domain</jb:expression>
  40       <jb:value property="sequence" data="0" default="0" decoder="Long" />
  41       <jb:value property="lastEpochMicrosec" data="#/time-received" />
  42       <jb:value property="startEpochMicrosec" data="#/time-received" />
  43       <jb:expression property="priority">org.onap.dcaegen2.ves.domain.ves54.CommonEventHeader.Priority.NORMAL</jb:expression>
  44       <jb:expression property="sourceName">'VesAdapter'</jb:expression>
  45    </jb:bean>
  46    <jb:bean class="org.onap.dcaegen2.ves.domain.ves54.FaultFields" beanId="faultFields" createOnElement="vesevent">
  47       <jb:value property="faultFieldsVersion" data="2.0" default="2.0" decoder="Double" />
  48       <jb:value property="alarmCondition" data="#/trap-category" />
  49       <jb:expression property="specificProblem">'SNMP Fault'</jb:expression>
  50       <jb:expression property="vfStatus">org.onap.dcaegen2.ves.domain.ves54.FaultFields.VfStatus.ACTIVE</jb:expression>
  51       <jb:expression property="eventSeverity">org.onap.dcaegen2.ves.domain.ves54.FaultFields.EventSeverity.MINOR</jb:expression>
  52       <jb:wiring property="alarmAdditionalInformation" beanIdRef="alarmAdditionalInformationroot" />
  53    </jb:bean>
  54    <jb:bean class="java.util.ArrayList" beanId="alarmAdditionalInformationroot" createOnElement="vesevent">
  55       <jb:wiring beanIdRef="alarmAdditionalInformation" />
  56    </jb:bean>
  57    <jb:bean class="org.onap.dcaegen2.ves.domain.ves54.AlarmAdditionalInformation" beanId="alarmAdditionalInformation" createOnElement="varbinds/element">
  58       <jb:value property="name" data="#/varbind_oid" />
  59       <jb:value property="value" data="#/varbind_value" />
  60    </jb:bean></smooks-resource-list>
  61
  62 RestConf Collector Default Mapping File
  63 ============
  64 Following is the default RestConf collector mapping file which is used when no mapping file is found while processing notification from RestConf Collector.
  65
  66 .. code-block:: xml
  67
  68  <?xml version="1.0" encoding="UTF-8"?><smooks-resource-list xmlns="http://www.milyn.org/xsd/smooks-1.1.xsd" xmlns:jb="http://www.milyn.org/xsd/smooks/javabean-1.4.xsd" xmlns:json="http://www.milyn.org/xsd/smooks/json-1.1.xsd">
  69    <json:reader rootName="vesevent" keyWhitspaceReplacement="-">
  70       <json:keyMap>
  71          <json:key from="date&amp;time" to="date-and-time" />
  72       </json:keyMap>
  73    </json:reader>
  74    <jb:bean class="org.onap.dcaegen2.ves.domain.ves70.VesEvent" beanId="vesEvent" createOnElement="vesevent">
  75       <jb:wiring property="event" beanIdRef="event" />
  76    </jb:bean>
  77    <jb:bean class="org.onap.dcaegen2.ves.domain.ves70.Event" beanId="event" createOnElement="vesevent">
  78       <jb:wiring property="commonEventHeader" beanIdRef="commonEventHeader" />
  79       <jb:wiring property="pnfRegistrationFields" beanIdRef="pnfRegistrationFields" />
  80    </jb:bean>
  81    <jb:bean class="org.onap.dcaegen2.ves.domain.ves70.CommonEventHeader" beanId="commonEventHeader" createOnElement="vesevent">
  82       <jb:expression property="version">org.onap.dcaegen2.ves.domain.ves70.CommonEventHeader.Version._4_0_1</jb:expression>
  83       <jb:expression property="eventType">'pnfRegistration'</jb:expression>
  84       <jb:expression property="vesEventListenerVersion">org.onap.dcaegen2.ves.domain.ves70.CommonEventHeader.VesEventListenerVersion._7_0_1</jb:expression>
  85       <jb:expression property="eventId" execOnElement="vesevent">'registration_'+commonEventHeader.ts1</jb:expression>
  86       <jb:expression property="reportingEntityName">'VESMapper'</jb:expression>
  87       <jb:expression property="domain">org.onap.dcaegen2.ves.domain.ves70.CommonEventHeader.Domain.PNF_REGISTRATION</jb:expression>
  88       <jb:expression property="eventName" execOnElement="vesevent">commonEventHeader.domain</jb:expression>
  89       <jb:value property="sequence" data="0" default="0" decoder="Long" />
  90       <jb:expression property="lastEpochMicrosec" execOnElement="vesevent">commonEventHeader.ts1</jb:expression>
  91       <jb:expression property="startEpochMicrosec" execOnElement="vesevent">commonEventHeader.ts1</jb:expression>
  92       <jb:expression property="priority">org.onap.dcaegen2.ves.domain.ves70.CommonEventHeader.Priority.NORMAL</jb:expression>
  93       <jb:expression property="sourceName" execOnElement="vesevent">pnfRegistrationFields.vendorName+'-'+pnfRegistrationFields.serialNumber</jb:expression>
  94    </jb:bean>
  95    <jb:bean class="org.onap.dcaegen2.ves.domain.ves70.PnfRegistrationFields" beanId="pnfRegistrationFields" createOnElement="vesevent">
  96       <jb:expression property="pnfRegistrationFieldsVersion">org.onap.dcaegen2.ves.domain.ves70.PnfRegistrationFields.PnfRegistrationFieldsVersion._2_0</jb:expression>
  97       <jb:value property="serialNumber" data="pnfRegistration/serialNumber" />
  98       <jb:value property="lastServiceDate" data="pnfRegistration/lastServiceDate" />
  99       <jb:value property="manufactureDate" data="pnfRegistration/manufactureDate" />
 100       <jb:value property="modelNumber" data="pnfRegistration/modelNumber" />
 101       <jb:value property="oamV4IpAddress" data="pnfRegistration/oamV4IpAddress" />
 102       <jb:value property="oamV6IpAddress" data="pnfRegistration/oamV6IpAddress" />
 103       <jb:value property="softwareVersion" data="pnfRegistration/softwareVersion" />
 104       <jb:value property="unitFamily" data="pnfRegistration/unitFamily" />
 105       <jb:value property="unitType" data="pnfRegistration/unitType" />
 106       <jb:value property="vendorName" data="pnfRegistration/vendorName" />
 107       <jb:wiring property="additionalFields" beanIdRef="alarmAdditionalInformation" />
 108    </jb:bean>
 109    <jb:bean class="org.onap.dcaegen2.ves.domain.ves70.AlarmAdditionalInformation" beanId="alarmAdditionalInformation" createOnElement="vesevent">
 110       <jb:wiring property="additionalProperties" beanIdRef="additionalFields2" />
 111    </jb:bean>
 112    <jb:bean beanId="additionalFields2" class="java.util.HashMap" createOnElement="vesevent/pnfRegistration/additionalFields">
 113       <jb:value data="pnfRegistration/additionalFields/*" />
 114    </jb:bean></smooks-resource-list>