Documentation for PM Mapper and API

[dcaegen2.git] / docs / sections / services / pm-mapper / configuration.rst

diff --git a/docs/sections/services/pm-mapper/configuration.rst b/docs/sections/services/pm-mapper/configuration.rst
index b014f6f..88d2ccc 100644 (file)
--- a/docs/sections/services/pm-mapper/configuration.rst
+++ b/docs/sections/services/pm-mapper/configuration.rst
@@ -4,4 +4,39 @@
 Configuration\r
 =============\r
 \r
-< To-Do >
\ No newline at end of file
+Filtering\r
+"""""""""\r
+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.\r
+Mapper filtering is based on the PM dictionary fields.\r
+PM mapper expects the filter in the following JSON format:\r
+\r
+::\r
+\r
+\r
+         "filters":[{\r
+            "pmDefVsn": "1.3",\r
+            "nfType": "gnb",\r
+            "vendor": "Ericsson",\r
+            "measTypes": [ "attTCHSeizures", "succTCHSeizures" ]\r
+        }]\r
+\r
+\r
+\r
+====================   ============================      ================================\r
+Field                  Description                       Type\r
+====================   ============================      ================================\r
+pmDefVsn               PM Dictionary version.            String\r
+vendor                 Vendor of the xNF type.           String\r
+nfType                 nfType is vendor                  String\r
+                       defined and should match the\r
+                       string used in file ready\r
+                       eventName.\r
+measTypes              Measurement name used in PM       Array of String\r
+                       file in 3GPP format where\r
+                       specified, else vendor\r
+                       defined.\r
+====================   ============================      ================================\r
+\r
+Feed Name\r
+"""""""""\r
+A default feed name "bulk_pm_feed" is configured in PM Mapper blueprint but the feed name can be changed to a user defined value through cloudify manager.
\ No newline at end of file