alarm_analysis:meta_tags
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revisionNext revisionBoth sides next revision | ||
alarm_analysis:meta_tags [2023/01/26 12:06] – su | alarm_analysis:meta_tags [2023/06/21 13:46] – [How to add a "Meta Tag" to an Alarm Analysis Tag Index] su | ||
---|---|---|---|
Line 1: | Line 1: | ||
- | < | + | ====== Alarm Analysis |
- | <span style=" | + | |
- | </ | + | |
- | Meta tags are used to perform various aggregations | + | The KPIs and metrics that make up the Alarm Analysis reports can be queried via //meta tags//, meaning Alarm Analysis |
+ | For a full list of meta tags, refer to the [[https:// | ||
+ | |||
+ | **Not all Meta Tags are Discoverable** | ||
+ | |||
+ | While Power BI allows free text entry when configuring data queries, others apps such as Gestalt PnID and Trend restrict users to a " | ||
+ | |||
+ | For example, | ||
+ | |||
+ | Oil Co/ | ||
+ | | ||
+ | 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. | ||
+ | |||
+ | ===== How to add a "Meta Tag" to an 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.// | ||
+ | |||
+ | **Complexity Level:** Advanced \\ | ||
+ | **Required Privileges: | ||
+ | |||
+ | 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** | ||
+ | |||
+ | ### Get all AA Tag Indices | ||
+ | | ||
+ | Invoke-WebRequest -Uri http:// | ||
+ | | ||
+ | | Select-Object -Expand Content | ||
+ | |||
+ | Tag Indices names are constructed thus: | ||
+ | |||
+ | | ||
+ | e.g. " | ||
+ | |||
+ | **2. Find a meta-tag in the tag index** | ||
+ | |||
+ | ### Find tag | ||
+ | | ||
+ | $body=' | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | } | ||
+ | } | ||
+ | }' | ||
+ | | ||
+ | Invoke-RestMethod -Uri http:// | ||
+ | -ContentType ' | ||
+ | -Method Post ` | ||
+ | -Body $body ` | ||
+ | | ConvertTo-Json -Depth 20 | ||
+ | | ||
+ | The above query is checking the " | ||
+ | |||
+ | **3. Add an meta-tag to a tag index** | ||
+ | |||
+ | Only add a meta-tag to the tag-index, if... | ||
+ | |||
+ | * 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=' | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | }' | ||
+ | | ||
+ | Invoke-RestMethod -Uri http:// | ||
+ | -ContentType ' | ||
+ | -Method Post ` | ||
+ | -Body $body ` | ||
+ | | ConvertTo-Json -Depth 20 | ||
+ | | ||
+ | **4. Delete a meta-tag from the tag index** | ||
+ | |||
+ | Every tag in the tag index has a unique " | ||
+ | | ||
+ | Use the search query above to obtain the " | ||
+ | |||
+ | ### Delete tag | ||
+ | | ||
+ | Invoke-RestMethod -Uri http:// | ||
+ | -ContentType ' | ||
+ | -Method Delete ` | ||
+ | | ConvertTo-Json -Depth 20 | ||
+ | | ||
+ | |||
+ |
alarm_analysis/meta_tags.txt · Last modified: 2024/01/31 14:23 by su