Merge "Update documentation"
[dcaegen2.git] / docs / sections / services / pm-mapper / configuration.rst
1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. http://creativecommons.org/licenses/by/4.0
3
4 Configuration
5 =============
6
7 Filtering
8 """""""""
9 PM mapper maps PM XML files to performance VES event by applying the mapper filtering information. Mapper filtering is configured during instantiation through cloudify manager.
10 Mapper filtering is based on the PM dictionary fields.
11 PM mapper expects the filter in the following JSON format:
12
13 ::
14
15
16          "filters":[{
17             "pmDefVsn": "1.3",
18             "nfType": "gnb",
19             "vendor": "Ericsson",
20             "measTypes": [ "attTCHSeizures", "succTCHSeizures" ]
21         }]
22
23
24
25 ====================   ============================      ================================
26 Field                  Description                       Type
27 ====================   ============================      ================================
28 pmDefVsn               PM Dictionary version.            String
29 vendor                 Vendor of the xNF type.           String
30 nfType                 nfType is vendor                  String
31                        defined and should match the
32                        string used in file ready
33                        eventName.
34 measTypes              Measurement name used in PM       Array of String
35                        file in 3GPP format where
36                        specified, else vendor
37                        defined.
38 ====================   ============================      ================================
39
40 Message Router Topic Name
41 """""""""
42 PM Mapper publishes the perf3gpp VES PM Events to the following authenticated MR topic;
43
44 ::
45
46         topic.org.onap.dmaap.mr.PM_MAPPER