# New Feature - Tag Report Tool

**URL:** <https://forum.inductiveautomation.com/t/new-feature-tag-report-tool/61594>\
**Category:** Ignition Early Access\
**Tags:** ignition81\
**Created:** [July 6, 2022, 9:44pm UTC](https://forum.inductiveautomation.com/t/new-feature-tag-report-tool/61594 "2022-07-06T21:44:25Z")\
**Posts on this page:** 20\
**Page:** 3

<div class="post-metadata">

**Author:** ![ggross](https://sea1.discourse-cdn.com/inductiveautomation/user_avatar/forum.inductiveautomation.com/ggross/32/12668_2.png) [@ggross](https://forum.inductiveautomation.com/u/ggross)\
**Post date:** [November 17, 2022, 9:26pm UTC](https://forum.inductiveautomation.com/t/new-feature-tag-report-tool/61594/41 "2022-11-17T21:26:32Z")

</div>

> [@nminchin](#):
>
> Edit:  
> One extra column option that would be good would be to have Type Id to which the tag belongs to. To be extra annoying, if the tag is part of a UDT that is nested in another UDT, it would be great to show this AND be able to edit the underlying UDT definitions directly.
> 
> E.g. Column "Type Id' displayed value:  
> `_types_/Devices/Pump 1 -> _types_/Devices/Pump Common` -\> `_types_/Devices/Some other UDT`
> 
> Right clicking on the Type Id value would show a context menu with options:
> 
> - Edit `_types_/Devices/Pump 1` Definition
> - Edit `_types_/Devices/Pump Common` Definition
> - Edit `_types_/Devices/Some other UDT` Definition
> 
> And obviously the option to edit the instance as well, which is the default edit option now

I think for now you will have to live with the Tag Hierarchy stuff that is being added for 8.1.23. The Tool will have a right click option for `View Tag Hierarchy` that will bring up this type of information in a separate dialog that would give you this type of insight/editing capabilities.

Garth

---

<div class="post-metadata">

**Author:** ![nminchin](https://sea1.discourse-cdn.com/inductiveautomation/user_avatar/forum.inductiveautomation.com/nminchin/32/6911_2.png) [@nminchin](https://forum.inductiveautomation.com/u/nminchin)\
**Post date:** [November 17, 2022, 9:32pm UTC](https://forum.inductiveautomation.com/t/new-feature-tag-report-tool/61594/42 "2022-11-17T21:32:58Z")

</div>

I think I can live with 10x better than my idea 😄  
Looks awesome!

I have a script already which can read relative tags/properties from a tag path which I can use to read these typeIds, e.g.

| TagPath | ../TypeId | ../../TypeId | ../../../TypeId |
| --- | --- | --- | --- |
| Pump A/PID/SP | Devices/PID | Devices/Motors/VSD-Danfoss\_ENet\_2Dir | |

Where:  
`../TypeId` = type id of `Pump A/PID`  
`../../TypeId` = type id of `Pump A`  
`../../../TypeId` = type id of nothing...

---

<div class="post-metadata">

**Author:** ![jlandwerlen](https://avatars.discourse-cdn.com/v4/letter/j/bc8723/32.png) [@jlandwerlen](https://forum.inductiveautomation.com/u/jlandwerlen)\
**Post date:** [February 21, 2023, 4:34pm UTC](https://forum.inductiveautomation.com/t/new-feature-tag-report-tool/61594/43 "2023-02-21T16:34:57Z")

</div>

> [@ggross](#):
>
> Values and Timestamps of tags can be explicitly searched for

I can run a report and it will return numeric values, but I can't seem to get it to work for strings. I tried using `=`, `Like`, wrapping in quotes, using a wildcard, etc. Nothing seems to return a tag with a specific string value. Is this a bug, or am I missing something?

---

<div class="post-metadata">

**Author:** ![ggross](https://sea1.discourse-cdn.com/inductiveautomation/user_avatar/forum.inductiveautomation.com/ggross/32/12668_2.png) [@ggross](https://forum.inductiveautomation.com/u/ggross)\
**Post date:** [February 22, 2023, 4:41pm UTC](https://forum.inductiveautomation.com/t/new-feature-tag-report-tool/61594/44 "2023-02-22T16:41:23Z")

</div>

> [@jlandwerlen](#):
>
> I can run a report and it will return numeric values, but I can't seem to get it to work for strings. I tried using `=`, `Like`, wrapping in quotes, using a wildcard, etc. Nothing seems to return a tag with a specific string value. Is this a bug, or am I missing something?

It isn't clear to me if this is expected or not, or if it is a bug at this point. I have an open question with the developer about if `Value` only works with numeric value because we have to be able to do comparisons and know it is a number (kind of like Alarm triggers).

As a work around, if you search for `Qualified Value` like `*<string>*` you will be able to find the tags you are looking for. Make sure to use the asterisks as a wild card as the qualified value has more information than just the value.

I will follow up when I have more of a definitive answer on if this is intentional.

Garth

---

<div class="post-metadata">

**Author:** ![jlandwerlen](https://avatars.discourse-cdn.com/v4/letter/j/bc8723/32.png) [@jlandwerlen](https://forum.inductiveautomation.com/u/jlandwerlen)\
**Post date:** [February 23, 2023, 7:23pm UTC](https://forum.inductiveautomation.com/t/new-feature-tag-report-tool/61594/45 "2023-02-23T19:23:39Z")

</div>

Thanks @ggross that is a simple enough workaround and solution if the current method(s) stands.

I have another question, is it possible to use the tag report tool to return tags with a custom property, or even further, tags with a specific custom property?

---

<div class="post-metadata">

**Author:** ![ggross](https://sea1.discourse-cdn.com/inductiveautomation/user_avatar/forum.inductiveautomation.com/ggross/32/12668_2.png) [@ggross](https://forum.inductiveautomation.com/u/ggross)\
**Post date:** [February 23, 2023, 9:05pm UTC](https://forum.inductiveautomation.com/t/new-feature-tag-report-tool/61594/46 "2023-02-23T21:05:42Z")

</div>

> [@jlandwerlen](#):
>
> I have another question, is it possible to use the tag report tool to return tags with a custom property, or even further, tags with a specific custom property?

We have added a bug to fix string values not returning in comparison searches and it will be prioritized by our product owners.

Custom fields should be searchable. While they will not be populated in the list of selectable properties, you can manually type in the property you are looking for on the left hand side of the search area:  
Example 1: Search would return any tags that have `CustomTest` as a set property.

 ![CustomSearch](https://us1.discourse-cdn.com/inductiveautomation/original/3X/5/0/5059e7507f169faa93848ad350c6354af6f003bb.png)  
Example 2: Search would return any tags that have a `CustomTest` property set to `abc`:  
 ![CustomSearch2](https://us1.discourse-cdn.com/inductiveautomation/original/3X/b/2/b220b0012b4f1066a10074bf2643c243d144a632.png)

If you search for the column, it should also pop up as a field in the export options as well, or you can manually add it there as well.

Garth

---

<div class="post-metadata">

**Author:** ![j.israelsen](https://avatars.discourse-cdn.com/v4/letter/j/ad7895/32.png) [@j.israelsen](https://forum.inductiveautomation.com/u/j.israelsen)\
**Post date:** [February 24, 2023, 3:22pm UTC](https://forum.inductiveautomation.com/t/new-feature-tag-report-tool/61594/47 "2023-02-24T15:22:30Z")

</div>

Is there a way to do a tag export with the results from the tag report tool? Or is that a feature that could be added?

I have had scenarios where the report properly returns the tags I am querying for. However, I noticed there is a change that needs to be made to the parameters of the tags. Unfortunately, the multi-tag edit tool doesn't work on parameters. I was hoping to export the tags from the report tool, make the correction, and then reimport the tags. I know this is just one example, but I could see where this could be useful for various reasons.

---

<div class="post-metadata">

**Author:** ![jlandwerlen](https://avatars.discourse-cdn.com/v4/letter/j/bc8723/32.png) [@jlandwerlen](https://forum.inductiveautomation.com/u/jlandwerlen)\
**Post date:** [February 24, 2023, 5:44pm UTC](https://forum.inductiveautomation.com/t/new-feature-tag-report-tool/61594/48 "2023-02-24T17:44:25Z")

</div>

@ggross sorry for the repeated questions. Is it possible to have two properties and return results if either are "true"?

For example, in a UDT I have a member `MyName` and the same may exist in a tag as a custom property.

![image](https://us1.discourse-cdn.com/inductiveautomation/original/3X/b/c/bc1a4b6e5b73d971e54966eea22f99f5e07c8aa7.png)

When I export the script I noticed an option under for properties for `and`. I assumed changing to `or` would allow this, but doesn't work. Are there any ways to create multiple properties and then determine and/or?

```auto
"properties": {
      "and": [
        [
          "name",
          "Equal",
          "MyName"
        ]
      ],
      "defined": [
        "MyName"
      ]
    }
  },

```

---

<div class="post-metadata">

**Author:** ![ggross](https://sea1.discourse-cdn.com/inductiveautomation/user_avatar/forum.inductiveautomation.com/ggross/32/12668_2.png) [@ggross](https://forum.inductiveautomation.com/u/ggross)\
**Post date:** [February 24, 2023, 8:11pm UTC](https://forum.inductiveautomation.com/t/new-feature-tag-report-tool/61594/49 "2023-02-24T20:11:01Z")

</div>

> [@jlandwerlen](#):
>
> Is it possible to have two properties and return results if either are "true"
> 
> When I export the script I noticed an option under for properties for `and`. I assumed changing to `or` would allow this, but doesn't work. Are there any ways to create multiple properties and then determine and/or?

There is not currently a way in the UI or scripting to do `OR` searches. The API is built in a way where it could be added in the future, but there were issues that prevented it from being available for the initial release and we don't currently have it hooked up behind the scenes. This is functionality that we hope to add in the future.

The only workaround for this would be to use scripting to run two separate queries and combine the results.

Garth

---

<div class="post-metadata">

**Author:** ![j.israelsen](https://avatars.discourse-cdn.com/v4/letter/j/ad7895/32.png) [@j.israelsen](https://forum.inductiveautomation.com/u/j.israelsen)\
**Post date:** [March 3, 2023, 9:31pm UTC](https://forum.inductiveautomation.com/t/new-feature-tag-report-tool/61594/50 "2023-03-03T21:31:02Z")

</div>

@ggross, following up with this post:

> [@j.israelsen](#):
>
> Is there a way to do a tag export with the results from the tag report tool? Or is that a feature that could be added?
> 
> I have had scenarios where the report properly returns the tags I am querying for. However, I noticed there is a change that needs to be made to the parameters of the tags. Unfortunately, the multi-tag edit tool doesn't work on parameters. I was hoping to export the tags from the report tool, make the correction, and then reimport the tags. I know this is just one example, but I could see where this could be useful for various reasons.

---

<div class="post-metadata">

**Author:** ![ggross](https://sea1.discourse-cdn.com/inductiveautomation/user_avatar/forum.inductiveautomation.com/ggross/32/12668_2.png) [@ggross](https://forum.inductiveautomation.com/u/ggross)\
**Post date:** [March 4, 2023, 8:19am UTC](https://forum.inductiveautomation.com/t/new-feature-tag-report-tool/61594/51 "2023-03-04T08:19:24Z")

</div>

> [@j.israelsen](#):
>
> Is there a way to do a tag export with the results from the tag report tool? Or is that a feature that could be added?

While it isn’t currently possible to export tags from the tag report tool, it is something that I found myself asking for a couple weeks back when attempting to troubleshoot an issue with support. We have a ticket open to add that feature, but we don’t have a set timeframe of when it will get worked on.

Garth

---

<div class="post-metadata">

**Author:** ![richardNZ15](https://sea1.discourse-cdn.com/inductiveautomation/user_avatar/forum.inductiveautomation.com/richardnz15/32/33373_2.png) [@richardNZ15](https://forum.inductiveautomation.com/u/richardNZ15)\
**Post date:** [March 6, 2023, 5:15am UTC](https://forum.inductiveautomation.com/t/new-feature-tag-report-tool/61594/52 "2023-03-06T05:15:41Z")

</div>

Managed to get pretty close to what i need for identifying any tags that have **alarms overriden** , using the following tag report:

```auto
{
  "query": {
    "options": {
      "includeUdtMembers": true,
      "includeUdtDefinitions": false
    },
    "condition": {
      "attributes": {
        "values": [
          "alarm",
          "override"
        ],
        "requireAll": true
      },
      "properties": {
        "and": [
          [
            "alarmEvalEnabled",
            "Equal",
            "true"
          ]
        ],
        "overridden": [
          "alarms"
        ]
      }
    },
    "returnProperties": [
      "tagQueryOverrides"
    ]
  },
  "columns": [
    {
      "alias": "",
      "key": "path",
      "type": "property",
      "visible": true,
      "width": 492
    },
    {
      "alias": "",
      "key": "tagQueryOverrides",
      "type": "property",
      "visible": true,
      "width": 465
    },
    {
      "alias": "",
      "key": "override",
      "type": "trait",
      "visible": false,
      "width": 76
    }
  ]
}

```

One thing i'm struggling with at the moment is searching for a **custom alarm property** , such as one i've defined as "AlarmClass" shown below in a JSON copy of the tag. Is this possible?  
 ![image](https://us1.discourse-cdn.com/inductiveautomation/original/3X/4/f/4f69cbe033b1a294bcf7b0386f5e708cff12a6ed.png)

This didn't return any results when adding it to the existing report:  
 ![image](https://us1.discourse-cdn.com/inductiveautomation/original/3X/9/5/95b20fcdef2386da5fd69a8b7b0095c93bdb530a.png)

---

<div class="post-metadata">

**Author:** ![ggross](https://sea1.discourse-cdn.com/inductiveautomation/user_avatar/forum.inductiveautomation.com/ggross/32/12668_2.png) [@ggross](https://forum.inductiveautomation.com/u/ggross)\
**Post date:** [March 6, 2023, 6:20am UTC](https://forum.inductiveautomation.com/t/new-feature-tag-report-tool/61594/53 "2023-03-06T06:20:20Z")

</div>

The tag report tool doesn't have access to the individual properties within a tag's alarm, it only knows that and alarm exists on the tag. Because of how things are modeled, adding the ability to search these properties takes a significant amount of additional work to make work. It is something we hope to add one day. The one thing that probably should work that I will open a bug for is:

```auto
Alarms like *AlarmClass*

```

When Alarms is shown in the table or exported into a CSV, we include the String representation of the Alarm properties. I will discuss it with one of the developers tomorrow.

Until any change is made, the best we could do is modify a scripting function to return the results. If the goal is to modify the results, I know that isn't helpful, but adding something like the following to the query you produced would provide information about the tags you are looking for:

```auto
new_results = []

for result in results:
	if 'alarms' in result:
		for alarm in result['alarms']: 
			if alarm.has_key('AlarmClass'):
				new_results.append(result)
			
print new_results

```

Garth

---

<div class="post-metadata">

**Author:** ![richardNZ15](https://sea1.discourse-cdn.com/inductiveautomation/user_avatar/forum.inductiveautomation.com/richardnz15/32/33373_2.png) [@richardNZ15](https://forum.inductiveautomation.com/u/richardNZ15)\
**Post date:** [March 6, 2023, 7:24pm UTC](https://forum.inductiveautomation.com/t/new-feature-tag-report-tool/61594/54 "2023-03-06T19:24:57Z")

</div>

Awesome thank you. This should do what we need for now. Just trying to identify overridden alarms so we can make sure changes to our parent UDTs get manually updated on these too.

Overrides are a tricky thing.. perhaps we'll need to review how we use them with UDTs.

Tool is amazing though, thank you so much for all the work being put into it.

---

<div class="post-metadata">

**Author:** ![richardNZ15](https://sea1.discourse-cdn.com/inductiveautomation/user_avatar/forum.inductiveautomation.com/richardnz15/32/33373_2.png) [@richardNZ15](https://forum.inductiveautomation.com/u/richardNZ15)\
**Post date:** [March 6, 2023, 8:12pm UTC](https://forum.inductiveautomation.com/t/new-feature-tag-report-tool/61594/55 "2023-03-06T20:12:35Z")

</div>

Potential bug:  
If you sort the results of the report tool, then double click to edit, it seems to open the wrong tag.

Right click, edit seems to work fine.

---

<div class="post-metadata">

**Author:** ![nminchin](https://sea1.discourse-cdn.com/inductiveautomation/user_avatar/forum.inductiveautomation.com/nminchin/32/6911_2.png) [@nminchin](https://forum.inductiveautomation.com/u/nminchin)\
**Post date:** [March 6, 2023, 11:02pm UTC](https://forum.inductiveautomation.com/t/new-feature-tag-report-tool/61594/56 "2023-03-06T23:02:06Z")

</div>

I think I reported this before but it might not have been picked up. But it appears to open the unsorted row's tag ☹

---

<div class="post-metadata">

**Author:** ![ggross](https://sea1.discourse-cdn.com/inductiveautomation/user_avatar/forum.inductiveautomation.com/ggross/32/12668_2.png) [@ggross](https://forum.inductiveautomation.com/u/ggross)\
**Post date:** [March 6, 2023, 11:25pm UTC](https://forum.inductiveautomation.com/t/new-feature-tag-report-tool/61594/57 "2023-03-06T23:25:54Z")

</div>

> [@richardNZ15](#):
>
> Potential bug:  
> If you sort the results of the report tool, then double click to edit, it seems to open the wrong tag.

It's a bug...We fixed it once before release, not sure how it got back in but it will get fixed.

Garth

---

<div class="post-metadata">

**Author:** ![richardNZ15](https://sea1.discourse-cdn.com/inductiveautomation/user_avatar/forum.inductiveautomation.com/richardnz15/32/33373_2.png) [@richardNZ15](https://forum.inductiveautomation.com/u/richardNZ15)\
**Post date:** [March 7, 2023, 5:32am UTC](https://forum.inductiveautomation.com/t/new-feature-tag-report-tool/61594/58 "2023-03-07T05:32:13Z")

</div>

Is there a .getDataset() equivalent planned for the returned "results" object?  
Scripting reference page of manual doesn't seem to contain a section for this yet.  
Trying to export the results to Excel via the scripting method, same as it would when exporting directly from Tag Report Tool GUI.

---

<div class="post-metadata">

**Author:** ![hpark](https://sea1.discourse-cdn.com/inductiveautomation/user_avatar/forum.inductiveautomation.com/hpark/32/21222_2.png) [@hpark](https://forum.inductiveautomation.com/u/hpark)\
**Post date:** [March 22, 2023, 10:20pm UTC](https://forum.inductiveautomation.com/t/new-feature-tag-report-tool/61594/59 "2023-03-22T22:20:49Z")

</div>

Greetings to all! We appreciate you taking the time to share your thoughts and valuable feedback on this feature post/thread! As the feature has been out for a while now, we've been collecting a multitude of responses and reviewing them. We would like to conduct another round of survey to help us identify further areas of improvement and prioritize which issues need the most attention first. The survey will take no more than 5 minutes of your time, and your input would be greatly appreciated! Thank you.

[**Take Survey on Tag Report Tool**](https://forms.gle/tKWoEJCGgjJV58HC9)

---

<div class="post-metadata">

**Author:** ![jlandwerlen](https://avatars.discourse-cdn.com/v4/letter/j/bc8723/32.png) [@jlandwerlen](https://forum.inductiveautomation.com/u/jlandwerlen)\
**Post date:** [July 16, 2023, 2:00pm UTC](https://forum.inductiveautomation.com/t/new-feature-tag-report-tool/61594/60 "2023-07-16T14:00:10Z")

</div>

On 8.1.28.  
I have been battling something for a while and I have narrowed it down:

I want to search for a name and a value, this is the script:

```auto
provider = 'default'
limit = 100

query = {
  "options": {
    "includeUdtMembers": True,
    "includeUdtDefinitions": False
  },
  "condition": {
    "attributes": {
      "values": [],
      "requireAll": True
    },
    "properties": {
      "op": "Or",
      "conditions": [
        {
          "op": "And",
          "conditions": [
            {
              "prop": "name",
              "comp": "Equal",
              "value": "MyTagName"
            },
            {
              "prop": "value",
              "comp": "Equal",
              "value": "[1, Good, Sun Jul 16 09:47:08 EDT 2023 (1689515228005)]"
            }
          ]
        }
      ]
    }
  },
  "returnProperties": [
    "tagType",
    "quality"
  ]
}

results = system.tag.query(provider, query, limit)

```

Screenshot for the tag report tool:  
 ![image](https://us1.discourse-cdn.com/inductiveautomation/original/3X/3/3/338ca9ce53e8958c52a79adde288004618b1d312.png)

I have noticed sometimes it works, other times it doesn't. Currently I am using Top Server in simulation mode. If I read the qualified value it comes back as:

```auto
[true, Good, Sun Jul 16 09:46:04 EDT 2023 (1689515164393)]

```

But, no results from the tag report tool. If I change the tag to memory the qualified value looks no different (except for the timestamp), but the tag report tool returns what it should.

I see nothing in the tag diagnostics that suggest something is wrong. Any ideas on why this is happening? @ggross

[Previous page](https://forum.inductiveautomation.com/t/new-feature-tag-report-tool/61594.md?page=2)

[Next page](https://forum.inductiveautomation.com/t/new-feature-tag-report-tool/61594.md?page=4)
