Differences

This shows you the differences between two versions of the page.

--- alarm_analysis:meta_tags [2023/06/21 10:31] – su
+++ alarm_analysis:meta_tags [2023/09/08 10:54] – su
@@ Line 15: / Line 15: @@
 This above meta tag requests the priority of the 3rd most frequently occuring Alarm on the Oil Co Osprey asset. Clearly this is not a value you would expect to interrogate like a regular process data tag, however there may be cases where it is required.
-If explicit tag entry is not permitted in an app, and the meta-tag is not available in search, it can be manually added to the Alarm Analysis Tag Index.
+If explicit tag entry is not permitted in an app, and the meta-tag is not available in search, it can be manually added to the Alarm Analysis Tag Index. For more information, refer to: [[alarm_analysis:How to add a "Meta Tag" to an Alarm Analysis Tag Index]]
 ===== How to add a "Meta Tag" to an Alarm Analysis Tag Index =====
+If explicit tag entry is not permitted in an app, and the meta-tag is not available in search, it can be manually added to the Alarm Analysis Tag Index.
 //Adding a meta-tag to an Alarm Analysis Tag Index will make it tag discoverable and allow other apps to query it.//
@@ Line 26: / Line 29: @@
 To administer an Alarm Analysis Tag Index, you must log on the App Store Connect server hosting the Alarm Analysis data source. The instructions below are useful Powershell command.
-**1. Identifiy Alarm Analysis Tag Indices**
+**1. Identifiy Alarm Analysis tag indices**
   ### Get all AA Tag Indices
@@ Line 39: / Line 42: @@
    e.g. "oilco.osprey.tagidx"
-**2. Query a Tag Index**
+**2. Find a meta-tag in the tag index**
-  ### Find tag in tag index
+  ### Find tag
   $body='{
       "query":{
           "term":{
-              "id":"Oil Co/Osprey/Export Gas/Alarm State"
+              "id":"Oil Co/Osprey/ALM BA report/3.priority"
           }
       }
@@ Line 54: / Line 57: @@
     -ContentType 'application/json' `
     -Method Post `
-    -Body '{"query":{"term":{"id":"Oil Co/Osprey/Export Gas/Alarm State"}}}' `
+    -Body $body `
     | ConvertTo-Json -Depth 20
-The above query is checking the "oilco.osprey.tagidx" for meta-tag "Oil Co/Osprey/Export Gas/Alarm State".
+The above query is checking the "oilco.osprey.tagidx" for meta-tag "Oil Co/Osprey/ALM BA report/3.priority".
-**3. Add an entry to a Tag Index**
+**3. Add an meta-tag to a tag index**
-If a tag doesn't already exist, it is safe to create it.
+Only add a meta-tag to the tag-index, if...
-  ### Add tag to tag index
+  * It does not already exist - //check using the find-tag script above.//
+  * You have a valid meta-tag name - //check against the meta-tag list.//
+  ### Create tag
   $body='{
-      "query":{
+    "id": "Oil Co/Osprey/ALM BA report/3.priority",
-          "term":{
+    "fullName": "Oil Co/Osprey/ALM BA report/3.priority",
-              "id":"Oil Co/Osprey/Export Gas/Alarm State"
+    "name": "Oil Co/Osprey/ALM BA report/3.priority",
-          }
+    "tag": "",
-      }
+    "alarmIdentifier": "",
+    "type": "",
+    "description": "Bad Actor Priority",
+    "eventTagType": "kpi",
+    "uom": "",
+    "lastUpdateUtc": "2023-06-21T10:52:56.2978113Z"
   }'
-  Invoke-RestMethod -Uri http://localhost:9200/oilco.osprey.tagidx/_search `
+  Invoke-RestMethod -Uri http://localhost:9200/oilco.osprey.tagidx/eventtag/ `
     -ContentType 'application/json' `
     -Method Post `
-    -Body '{"query":{"term":{"id":"Oil Co/Osprey/Export Gas/Alarm State"}}}' `
+    -Body $body `
     | ConvertTo-Json -Depth 20
+**4. Delete a meta-tag from the tag index**
-**4. Remove an entry to a Tag Index**
+Every tag in the tag index has a unique "_id" field (e.g. "AYjeEdp6nSbnh-NXfE0C"). This must be specified in the delete request.
+Use the search query above to obtain the "_id".
+  ### Delete tag
+  Invoke-RestMethod -Uri http://localhost:9200/oilco.osprey.tagidx/eventtag/AYjeEdp6nSbnh-NXfE0C `
+    -ContentType 'application/json' `
+    -Method Delete `
+    | ConvertTo-Json -Depth 20