# 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:** 18\
**Page:** 4

<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:** [July 18, 2023, 6:37pm UTC](https://forum.inductiveautomation.com/t/new-feature-tag-report-tool/61594/61 "2023-07-18T18:37:10Z")

</div>

When copying out the script, we are including a qualified value rather than just the value itself. I am going to submit a bug for this, but the following should work every time:

```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"
            }
          ]
        }
      ]
    }
  },
  "returnProperties": [
    "tagType",
    "quality"
  ]
}

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

```

---

<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 18, 2023, 6:56pm UTC](https://forum.inductiveautomation.com/t/new-feature-tag-report-tool/61594/62 "2023-07-18T18:56:22Z")

</div>

That doesn't work. I will contact support so they can take a closer look. Thanks for the help @ggross

---

<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:** [July 18, 2023, 8:00pm UTC](https://forum.inductiveautomation.com/t/new-feature-tag-report-tool/61594/63 "2023-07-18T20:00:47Z")

</div>

If you have a non-production Gateway, any chance you can try the latest Ignition nightly? The issue I noted looks to have been fixed last week and there were a couple of other changes around value searching.

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:** [July 18, 2023, 9:08pm UTC](https://forum.inductiveautomation.com/t/new-feature-tag-report-tool/61594/64 "2023-07-18T21:08:23Z")

</div>

I can either try the nightly, or just wait until the stable release and try. I will hold off on contacting support until one of those happens. Thanks @ggross .

---

<div class="post-metadata">

**Author:** ![paul-griffith](https://sea1.discourse-cdn.com/inductiveautomation/user_avatar/forum.inductiveautomation.com/paul-griffith/32/37249_2.png) [@paul-griffith](https://forum.inductiveautomation.com/u/paul-griffith)\
**Post date:** [October 3, 2024, 10:24pm UTC](https://forum.inductiveautomation.com/t/new-feature-tag-report-tool/61594/65 "2024-10-03T22:24:44Z")

</div>

Split this topic on October 3, 2024, 10:24pm UTC

25 posts were split to a new topic: [Json Diffing Discussion](https://forum.inductiveautomation.com/t/json-diffing-discussion/96800)

---

<div class="post-metadata">

**Author:** ![Chris\_Bingham](https://avatars.discourse-cdn.com/v4/letter/c/e5b9ba/32.png) [@Chris\_Bingham](https://forum.inductiveautomation.com/u/Chris_Bingham)\
**Post date:** [October 28, 2024, 11:27pm UTC](https://forum.inductiveautomation.com/t/new-feature-tag-report-tool/61594/66 "2024-10-28T23:27:00Z")

</div>

Finally started playing with this, and decided it was powerful enough to start the migration away from my legacy tools (script libraries which output similar results) over to Tag Report Tool (via script). Wish this available long ago! Big fan!

Two issues I'm seeing initially:

1. When operating from screen with limited resolution (docked laptop), the Tag Report Tool window appears on a different display and extends beyond what's available on that display - the top & bottom of the window are both off-screen. I first need to resize the window in the x-direction (which relocates the top of the window to top of my screen), then resize the top of the window and drag until window is within bounds of my screen, then move it over to the same screen as my Designer.

2. Any way to get the Path (not the Full Path) property from `system.tag.query()`?  
Posting here because from the tag report tool, I can add results columns for both _Path_ & _Full Path_:  

Then, can copy the query to JSON and see the properties in the results (in this example, to get all UDT types of a provider):

```python
{
  "query": {
    "options": {
      "includeUdtMembers": true,
      "includeUdtDefinitions": true
    },
    "condition": {
      "path": "_types_*",
      "tagType": "UdtType",
      "attributes": {
        "values": [],
        "requireAll": true
      }
    },
    "returnProperties": [
      "name"
    ]
  },
  "columns": [
    {
      "alias": "",
      "key": "name",
      "type": "property",
      "visible": true,
      "width": 122
    },
    {
      "alias": "",
      "key": "path",
      "type": "property",
      "visible": true,
      "width": 243
    },
    {
      "alias": "",
      "key": "fullpath",
      "type": "property",
      "visible": true,
      "width": 243
    }
  ]
}

```

Results are as expected, with 'Relative Path' in one column, 'Full Path' in another. However, "Copy as Script" and executing from Script Console appears to return only the fullPath property. I've attempted to add the 'path' as a return parameter (see below) to no avail.

```python
query = {
  "options": {
    "includeUdtMembers": True,
    "includeUdtDefinitions": True
  },
  "condition": {
    "path": "_types_*",
    "tagType": "UdtType",
    "attributes": {
      "values": [],
      "requireAll": True
    }
  },
  "returnProperties": [
    "name",
    "path"
  ]
}

```

A print of all keys in the first return object shows there is only the 'fullPath' property, and the 'path' property is omitted entirely.  
Sure, it's easy enough to strip the "[provider]" off of the full path for each result but hoping to avoid the extra processing if this property is readily available.

---

<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:** [October 29, 2024, 12:07am UTC](https://forum.inductiveautomation.com/t/new-feature-tag-report-tool/61594/67 "2024-10-29T00:07:58Z")

</div>

The `fullPath` of the results is an object that has a number of different options for returning the path in different formats:

```python
.toString(): Full Path
.toStringFull(): Same as .toString()
.toStringPartial(): Path without provider

```

if you take the default query that is copied from the Tag Report Tool, you should be able to run the following to get the path without the provider:

```python
print(results[0]['fullPath'].toStringPartial())

```

Keep in mind when doing comparisons with the path (should you need to do it) that `fullPath` is a `BasicTagPath` object and would need to be cast to a String for most use cases.

Garth

---

<div class="post-metadata">

**Author:** ![pturmel](https://sea1.discourse-cdn.com/inductiveautomation/user_avatar/forum.inductiveautomation.com/pturmel/32/3295_2.png) [@pturmel](https://forum.inductiveautomation.com/u/pturmel)\
**Post date:** [October 29, 2024, 12:09am UTC](https://forum.inductiveautomation.com/t/new-feature-tag-report-tool/61594/68 "2024-10-29T00:09:39Z")

</div>

> [@Chris\_Bingham](#):
>
> Any way to get the Path (not the Full Path) property from `system.tag.query()`?

I do this programmatically in my Exchange utility with the `.toStringPartial()` method of the `fullPath` TagPath object.

> [@Tag Report Utility](https://forum.inductiveautomation.com/t/tag-report-utility/95299):
>
> New resource just uploaded to the Exchange (pending review). Also available here: [https://www.automation-pros.com/TagReportUtility/](https://www.automation-pros.com/TagReportUtility/) I intend to publish at this link as well as in the Exchange going forward. Announcements will be in this topic. (: Highlights: Provides a Perspective Popup View that provides a user interface to system.tag.query() that entirely replicates the functionality of the Designer's Tag Report Tool. Provides a Perspective Embedded View that provides Time Span selectio…

---

<div class="post-metadata">

**Author:** ![Chris\_Bingham](https://avatars.discourse-cdn.com/v4/letter/c/e5b9ba/32.png) [@Chris\_Bingham](https://forum.inductiveautomation.com/u/Chris_Bingham)\
**Post date:** [October 29, 2024, 5:03pm UTC](https://forum.inductiveautomation.com/t/new-feature-tag-report-tool/61594/69 "2024-10-29T17:03:52Z")

</div>

Thank you for the insight! I'm ashamed I didn't look into the details of the returned object previously 🤦‍♂️. I was converting to string, then back to TagPath using:

```python
from com.inductiveautomation.ignition.common.tags.paths.parser import TagPathParser
fullPath = str(results[0]['fullPath']) # "[provider]path/to/tag"
partialPath = TagPathParser.parseSafe(fullPath).toStringPartial() # "path/to/tag"

```

Any insight on the issue of window resolution w.r.t. screen resolution?

> [@Chris\_Bingham](#):
>
> the top & bottom of the window are both off-screen

---

<div class="post-metadata">

**Author:** ![paul-griffith](https://sea1.discourse-cdn.com/inductiveautomation/user_avatar/forum.inductiveautomation.com/paul-griffith/32/37249_2.png) [@paul-griffith](https://forum.inductiveautomation.com/u/paul-griffith)\
**Post date:** [October 29, 2024, 5:12pm UTC](https://forum.inductiveautomation.com/t/new-feature-tag-report-tool/61594/70 "2024-10-29T17:12:14Z")

</div>

The window sizing issue is just a Java Swing/frame packing problem. The default size the report tool window assumes is too large, but Swing doesn't detect that and resize it until you trigger a notification by resizing the window horizontally. Not a ton to be done about it unfortunately.

---

<div class="post-metadata">

**Author:** ![Chris\_Bingham](https://avatars.discourse-cdn.com/v4/letter/c/e5b9ba/32.png) [@Chris\_Bingham](https://forum.inductiveautomation.com/u/Chris_Bingham)\
**Post date:** [October 31, 2024, 3:35pm UTC](https://forum.inductiveautomation.com/t/new-feature-tag-report-tool/61594/71 "2024-10-31T15:35:56Z")

</div>

I'm unsure if this would be considered a bug, but while trying to query for all UDTs which have Parent Data Types, I'm seeing some curious results when adding the desired property condition (Query as JSON for each in details):

> **Parent Data Type : Has**
>
> ```python
> {
> "query": {
> "options": {
> "includeUdtMembers": true,
> "includeUdtDefinitions": true
> },
> "condition": {
> "path": "_types_*",
> "attributes": {
> "values": [],
> "requireAll": true
> },
> "properties": {
> "op": "Or",
> "conditions": [
> {
> "op": "And",
> "conditions": [
> {
> "prop": "typeId",
> "comp": "Defined"
> }
> ]
> }
> ]
> }
> },
> "returnProperties": [
> "tagType"
> ]
> },
> "columns": [
> {
> "alias": "",
> "key": "path",
> "type": "property",
> "visible": true,
> "width": 403
> },
> {
> "alias": "",
> "key": "tagType",
> "type": "property",
> "visible": true,
> "width": 301
> }
> ]
> }
> 
> ```

vs

> **Parent Data Type : != : (Field after '!=' intentionally left blank)**
>
> ```python
> {
> "query": {
> "options": {
> "includeUdtMembers": true,
> "includeUdtDefinitions": true
> },
> "condition": {
> "path": "_types_*",
> "attributes": {
> "values": [],
> "requireAll": true
> },
> "properties": {
> "op": "Or",
> "conditions": [
> {
> "op": "And",
> "conditions": [
> {
> "prop": "typeId",
> "comp": "NotEqual",
> "value": ""
> }
> ]
> }
> ]
> }
> },
> "returnProperties": [
> "tagType"
> ]
> },
> "columns": [
> {
> "alias": "",
> "key": "path",
> "type": "property",
> "visible": true,
> "width": 403
> },
> {
> "alias": "",
> "key": "tagType",
> "type": "property",
> "visible": true,
> "width": 301
> }
> ]
> }
> 
> ```

The first query appears to show several more results than the latter, including several UDTs which have \<None\> selected in the drop down next to Parent Data Type, though not all UDTs matching this config show up in the results. Perhaps some of these UDTs had a Parent Data Type selected in the past?  
Edit: Add escape character "\" before "\<" and "\>" around None.

---

<div class="post-metadata">

**Author:** ![Chris\_Bingham](https://avatars.discourse-cdn.com/v4/letter/c/e5b9ba/32.png) [@Chris\_Bingham](https://forum.inductiveautomation.com/u/Chris_Bingham)\
**Post date:** [November 1, 2024, 4:22pm UTC](https://forum.inductiveautomation.com/t/new-feature-tag-report-tool/61594/72 "2024-11-01T16:22:58Z")

</div>

While configuring Tag Report, clicking on Ancestor drop-down does NOT populate list of types when clicking _directly_ on the down-arrow. Anything _outside_ of the red area I outlined in the below snip appears to work correctly.

 ![image](https://us1.discourse-cdn.com/inductiveautomation/original/3X/a/f/af3c426a80fbab43347e0b6ee6071afbb70c6c8d.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:** [November 6, 2024, 10:18pm UTC](https://forum.inductiveautomation.com/t/new-feature-tag-report-tool/61594/73 "2024-11-06T22:18:06Z")

</div>

> [@Chris\_Bingham](#):
>
> Perhaps some of these UDTs had a Parent Data Type selected in the past?

This is exactly what is happening. `has` is looking for any Tag definition that has the property as part of the definition. Once a property is set in a tag, even if it is cleared or matches a default value the key will persist as part of the tag definition forevermore. It isn't ideal, and we have had discussions about cleaning things like this up; but it isn't something that we are looking to do anytime in the future.

> [@](#):
>
> While configuring Tag Report, clicking on Ancestor drop-down does NOT populate list of types when clicking _directly_ on the down-arrow

This is an issue that has been logged internally for a while now [internal ID IGN-6946]. I am adding this comment to the ticket so that it adds another data point to people affected by the issue.

Garth

---

<div class="post-metadata">

**Author:** ![diamond](https://avatars.discourse-cdn.com/v4/letter/d/e79b87/32.png) [@diamond](https://forum.inductiveautomation.com/u/diamond)\
**Post date:** [November 10, 2024, 9:09am UTC](https://forum.inductiveautomation.com/t/new-feature-tag-report-tool/61594/74 "2024-11-10T09:09:47Z")

</div>

> [@ggross](#):
>
> This is an issue that has been logged internally for a while now [internal ID IGN-6946]. I am adding this comment to the ticket so that it adds another data point to people affected by the issue.

Sorry for the off-topic, would you mind sharing what software you use for internal ticketing at Ignition? It seems to be very effective.

---

<div class="post-metadata">

**Author:** ![Kevin.Herron](https://sea1.discourse-cdn.com/inductiveautomation/user_avatar/forum.inductiveautomation.com/kevin.herron/32/7259_2.png) [@Kevin.Herron](https://forum.inductiveautomation.com/u/Kevin.Herron)\
**Post date:** [November 11, 2024, 1:44am UTC](https://forum.inductiveautomation.com/t/new-feature-tag-report-tool/61594/75 "2024-11-11T01:44:25Z")

</div>

We use YouTrack from JetBrains.

---

<div class="post-metadata">

**Author:** ![Chris\_Bingham](https://avatars.discourse-cdn.com/v4/letter/c/e5b9ba/32.png) [@Chris\_Bingham](https://forum.inductiveautomation.com/u/Chris_Bingham)\
**Post date:** [December 17, 2024, 1:38am UTC](https://forum.inductiveautomation.com/t/new-feature-tag-report-tool/61594/76 "2024-12-17T01:38:08Z")

</div>

Reviewing an earlier post related to an issue I'm seeing on 8.1.44:

> [@richardNZ15](#):
>
> Is there any way we can utilize this to see what the internal alarm configuration is?

I, too, am hoping to query for values of any of these alarm properties. For example, Alarms where 'priority' = 'Critical'. A couple of queries to illustrate the issue I'm seeing:  
The below returns all alarms (as expected):

> **Query as JSON (Alarms Like \*)**
>
> ```python
> {
> "query": {
> "options": {
> "includeUdtMembers": true,
> "includeUdtDefinitions": true
> },
> "condition": {
> "path": "*",
> "attributes": {
> "values": [
> "alarm"
> ],
> "requireAll": true
> },
> "properties": {
> "op": "Or",
> "conditions": [
> {
> "op": "And",
> "conditions": [
> {
> "prop": "alarms",
> "comp": "Like",
> "value": "*"
> }
> ]
> }
> ]
> }
> },
> "returnProperties": [
> "alarms"
> ]
> },
> "columns": [
> {
> "alias": "",
> "key": "path",
> "type": "property",
> "visible": true,
> "width": 275
> },
> {
> "alias": "",
> "key": "alarms",
> "type": "property",
> "visible": true,
> "width": 476
> }
> ]
> }
> 
> ```

Whereas the below returns \<nothing\>:

> **Query as JSON (Alarms Like \*Critical\*)**
>
> ```python
> {
> "query": {
> "options": {
> "includeUdtMembers": true,
> "includeUdtDefinitions": true
> },
> "condition": {
> "path": "*",
> "attributes": {
> "values": [
> "alarm"
> ],
> "requireAll": true
> },
> "properties": {
> "op": "Or",
> "conditions": [
> {
> "op": "And",
> "conditions": [
> {
> "prop": "alarms",
> "comp": "Like",
> "value": "*Critical*"
> }
> ]
> }
> ]
> }
> },
> "returnProperties": [
> "alarms"
> ]
> },
> "columns": [
> {
> "alias": "",
> "key": "path",
> "type": "property",
> "visible": true,
> "width": 286
> },
> {
> "alias": "",
> "key": "alarms",
> "type": "property",
> "visible": true,
> "width": 438
> }
> ]
> }
> 
> ```

Is there a workaround to search for specific alarm properties?

---

<div class="post-metadata">

**Author:** ![Chris\_Bingham](https://avatars.discourse-cdn.com/v4/letter/c/e5b9ba/32.png) [@Chris\_Bingham](https://forum.inductiveautomation.com/u/Chris_Bingham)\
**Post date:** [April 24, 2026, 5:21pm UTC](https://forum.inductiveautomation.com/t/new-feature-tag-report-tool/61594/77 "2026-04-24T17:21:47Z")

</div>

> [@New Feature - Tag Report Tool](https://forum.inductiveautomation.com/t/new-feature-tag-report-tool/61594/72):
>
> While configuring Tag Report, clicking on Ancestor drop-down does NOT populate list of types when clicking directly on the down-arrow. Anything outside of the red area I outlined in the below snip appears to work correctly.

It appears this bug is still present in 8.3.5, for both the "Quality" and the "Traits" dropdown items:

 ![image](https://us1.discourse-cdn.com/inductiveautomation/original/3X/3/5/35cc761f5285c7ec65d182d479e0428210057867.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:** [April 24, 2026, 5:36pm UTC](https://forum.inductiveautomation.com/t/new-feature-tag-report-tool/61594/78 "2026-04-24T17:36:36Z")

</div>

> [@Chris\_Bingham](#):
>
> It appears this bug is still present in 8.3.5, for both the "Quality" and the "Traits" dropdown items:

The internal bug is still open and we haven't been able to circle back to fixing this issue yet. I will mention it to the product managers and devs to see if there is any way to sneak it in somewhere.

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