Ignition 8.3.0 - System Functions - Code completion discrepancies - Docs vs Designer/Console Script

cesarcoatl · August 18, 2025, 8:45pm

Hello IA,

I would like to report some discrepancies between the Docs and the Designer/Console Script.

Note: This might not be an exhaustive list, but it is what I was able to find.

Function	Docs	Designer
system.db.runQuery	Missing.
system.db.runScalarPrepQuery	Missing.
system.db.runScalarQuery	Missing.
system.db.SFNamedQuery	Present in docs.	Deprecated.
system.db.SFPrepUpdate	Missing.
system.db.SFUpdateQuery	Present in docs.	Deprecated.
system.db.runUpdateQuery	Missing.
system.historian.queryAggregatedPoints	Missing.
system.historian.queryRawPoints	Missing.
system.historian.queryValues	Present in docs.	Not listed.
system.net.httpDelete	Present in docs.	Deprecated.
system.net.httpGet	Present in docs.	Deprecated.
system.net.httpPost	Present in docs.	Deprecated.
system.net.httpPut	Present in docs.	Deprecated.
system.roster.getUsers	Missing
syste,security.getUserRoles	Present in docs.	Deprecated.
syste,security.validateUser	Present in docs.	Deprecated.
system.tag.browseHistoricalTags	Present in docs.	Deprecated.
system.tag.deleteAnnotations	Present in docs.	Deprecated.
system.tag.queryAnnotations	Present in docs.	Deprecated.
system.tag.queryTagCalculations	Present in docs.	Deprecated.
system.tag.queryTagDensity	Present in docs.	Deprecated.
system.tag.queryTagHistory	Present in docs.	Deprecated.
system.tag.storeAnnotations	Present in docs.	Deprecated.
system.tag.storeTagHistory	Present in docs.	Deprecated.
system.util.getAvailableLocales	Present in docs.	Deprecated.
system.util.getAvailableTerms	Present in docs.	Not listed.
system.vision.getAvailableLocales	Missing.
system.vision.getAvailableTerms	Missing.
system.vision.invokeLater	Present in docs.	Deprecated.
system.vision.validateUser	Missing.

There are also differences between the Script Console code completion and the code completion for scripts on the Designer.

I would like to know what's the source of truth? The Designer or the docs?

Thanks!

EDIT: This was created using version 8.3.0-beta3 (b2025081112).

Susan_Shamgar · August 18, 2025, 10:12pm

Thanks for bringing these to our attention! There are a number of changes to many of the system functions listed here in the Upgrade Guide:

Some of the functions listed as missing are actually present in the Deprecated pages section of the user manual, while others that are listed as present in the docs have a note near the top of the page calling them out as deprecated. I went through and added links where I could to clarify, and we'll take another pass through to ensure we're handling deprecated functions the same way across the board. The 8.3 docs are still a work in progress, so we're still making some revisions where needed in order to make sure the docs reflect what's present in the software.

Function	Docs	Designer	Notes
system.db.runQuery	Missing.		system.db.runQuery \| Ignition User Manual
system.db.runScalarPrepQuery	Missing.		system.db.runScalarPrepQuery \| Ignition User Manual
system.db.runScalarQuery	Missing.		system.db.runScalarQuery \| Ignition User Manual
system.db.SFNamedQuery	Present in docs.	Deprecated.
system.db.SFPrepUpdate	Missing.		system.db.runSFPrepUpdate \| Ignition User Manual
system.db.SFUpdateQuery	Present in docs.	Deprecated.	Deprecated in Vision only
system.db.runUpdateQuery	Missing.
system.historian.queryAggregatedPoints	Missing.
system.historian.queryRawPoints	Missing.
system.historian.queryValues	Present in docs.	Not listed.
system.net.httpDelete	Present in docs.	Deprecated.	Note on page: This function was deprecated in 8.3, use system.net.httpClient.delete.
system.net.httpGet	Present in docs.	Deprecated.	Note on page: This function was deprecated in 8.3, use system.net.httpClient.get.
system.net.httpPost	Present in docs.	Deprecated.	Note on page: This function was deprecated in 8.3, use system.net.httpClient.post.
system.net.httpPut	Present in docs.	Deprecated.	Note on page: This function was deprecated in 8.3, use system.net.httpClient.put.
system.roster.getUsers	Missing
syste,security.getUserRoles	Present in docs.	Deprecated.
syste,security.validateUser	Present in docs.	Deprecated.
system.tag.browseHistoricalTags	Present in docs.	Deprecated.
system.tag.deleteAnnotations	Present in docs.	Deprecated.
system.tag.queryAnnotations	Present in docs.	Deprecated.
system.tag.queryTagCalculations	Present in docs.	Deprecated.
system.tag.queryTagDensity	Present in docs.	Deprecated.
system.tag.queryTagHistory	Present in docs.	Deprecated.
system.tag.storeAnnotations	Present in docs.	Deprecated.
system.tag.storeTagHistory	Present in docs.	Deprecated.
system.util.getAvailableLocales	Present in docs.	Deprecated.
system.util.getAvailableTerms	Present in docs.	Not listed.
system.vision.getAvailableLocales	Missing.
system.vision.getAvailableTerms	Missing.
system.vision.invokeLater	Present in docs.	Deprecated.	Note on page: This function replaces system.util.invokeLater. Any scripts containing Vision Client scoped functions that were replaced with system.vision syntax will still work to maintain backwards compatibility. Only the system.vision variations will appear in the Script Editor's autocomplete popup.
system.vision.validateUser	Missing.

As far as the difference in behavior you're seeing between the Script Console and the Designer, that may be related to the scope of the script you're writing. If the function you want is not part of the selected scope, it won't show up in the autocomplete hints.

We'll get things sorted out in the docs to verify what the correct behavior should be and make sure the appendix is updated to match. Please let us know if you spot anything else that needs our attention.

cesarcoatl · August 19, 2025, 1:17am

Taking into account that the following functions are deprecated as per the docs, should we consider the following suggestions as bugs within the Designer?

system.db.runQuery
system.db.runScalarPrepQuery
system.db.runScalarQuery
system.db.SFPrepUpdate

All of them are not identified as deprecated.

Current behavior^[1]:

Expected behavior:

system.db.runQuery
system.db.runScalarPrepQuery
system.db.runScalarQuery
system.db.SFPrepUpdate

Using 8.3.0-beta4 (b2025081810). ↩︎

cesarcoatl · August 19, 2025, 1:29am

And regarding system.vision.invokeLater, this is currently showing as deprecated in the Designer.

If I understand correctly, system.util.invokeLater is deprecated but not system.vision.invokeLater

These are the deprecated fields and functions for system.vision:

Which is kind of odd, considering this is a brand new module.

paul-griffith · August 19, 2025, 5:21pm

system.vision.invokeLater indeed should not be deprecated in the software - that's an issue on our end (likely to survive into 8.3.0 with current timing, but should be fixed by 8.3.1).

The system.db functions indeed should be deprecated - looks like a merge conflict got goofed somewhere along the way. Similar story, but the inverse - these should be deprecated in the software, but that discrepancy may not get fixed for 8.3.0.