Adding or modifying parameters in the configuration file is considered an advanced configuration change. Most installations don't require any additional parameters, nor do they require modification to existing parameters. We generally discourage most users from making changes to parameters in the configuration file, as doing so could result some unintended behavior or security vulnerabilities. We list the parameters on this page for the sake of transparency.
If you choose to add or modify parameters in the the configuration file, you do so at your own risk.
A section of the configuration file contains a header stating "Java Additional Parameters". This section allows for a large number of configuration changes, and merits having some discussion on how to add new parameters. On install, the Java Additional Parameters section may look like the following:
# Java Additional Parameters wrapper.java.additional.1=-Ddata.dir=data #wrapper.java.additional.2=-Xdebug #wrapper.java.additional.3=-Xrunjdwp:transport=dt_socket,server=y,suspend=n,address=*:8000
When adding a new parameter, the "
wrapper.java.additional.#" prefix must be added to a new line. Each parameter contains a prefix ("
wrapper.java.additional.#"), a key, and a value that the key will be set to. Generally speaking, each parameter in the file should follow the pattern below:
Uncommented parameters should be listed in ascending numerical order, based on the number at the end of the prefix, as shown below.
# Add parameters like this: wrapper.java.additional.1=-Ddata.dir=data #wrapper.java.additional.2=-Xdebug #wrapper.java.additional.3=-Xrunjdwp:transport=dt_socket,server=y,suspend=n,address=*:8000 wrapper.java.additional.2=-some.thing=foo wrapper.java.additional.3=-some.other.thing=bar # Avoid skipping commented numbers: wrapper.java.additional.1=-Ddata.dir=data #wrapper.java.additional.2=-Xdebug #wrapper.java.additional.3=-Xrunjdwp:transport=dt_socket,server=y,suspend=n,address=*:8000 wrapper.java.additional.4=-some.thing=foo
Java Service Wrapper, developed by Tanuki Software, is used to control various Wrapper settings (i.e. wrapper.logfile.maxsize and wrapper.logfile.maxfiles). For a list of parameters and their function, visit https://wrapper.tanukisoftware.com/doc/english/properties.html.
You may sometimes need to change Ignition's locale information in the Gateway Configuration File. The following parameters will allow you to change the most commonly used localization information.
# Locale - Language (United States English) wrapper.java.additional.1=-Duser.language=en_US # Locale - Country (United States) wrapper.java.additional.2=-Duser.country=US # Locale - Variant (English (United States, Computer) wrapper.java.additional.3=-Duser.variant=POSIX # Timezone (Pacific Time) wrapper.java.additional.4=-Duser.timezone=America/Los_Angeles
You might also need to change how your files are encoded. The following parameter will allow you to change the encoding technique to what you require.
# File Encoding (Using UTF-8) wrapper.java.additional.1=-Dfile.encoding=UTF-8
See the Gateway and Gateway Network Parameters page for more Gateway and Gateway Network parameter information.
See the Perspective Parameters page for more Perspective parameter information.
It is possible to adjust the refresh rate of the System Tag Provider's System Tags. To do so, add the following system flag in the ignition.conf file:
Where "####" is the rate in milliseconds that the Tags should refresh at. Default refresh rate is 5000 milliseconds.
The Ignition Tag Historian stores and queries data in a particular way. When a Tag has Tag History enabled on it, an entry is generated for this Tag inside the sqlth_te table in your database. This Tag's Tag path, along with other Tag attributes, are stored in this table. Every Tag entry in the sqlth_te table has a unique Tag id which is used by the Tag Historian to identify each Tag. Whenever we make any type of change to this Tag's historical configurations, such as its Tag Group for instance, the current sqlth_te table entry for this Tag becomes retired and a new, unretired entry for this Tag gets created with a new Tag id. Due to this dynamic, it is common for a Tag path in the sqlth_te table to be associated with more than one Tag id. When a Tag History query executes for a specific Tag, a check is made against the sqlth_te table for all the Tag id's that match this Tag's Tag path. These Tag id's are then used to build a dynamic SQL query like the one shown below:
SELECT "tagid", "intvalue", "floatvalue", "stringvalue", "datevalue", "t_stamp", "dataintegrity" FROM sqlth_1_data WHERE "t_stamp" >= 1580680800000 AND "t_stamp" <= 1581026400000 AND ( "tagid" = 14568 OR "tagid" = 14571 OR "tagid" = 14572 ) ORDER BY "t_stamp" ASC, "tagid" ASC
When we query Tag history for a Tag with three Tag id's associated with its Tag path, the system uses repetitive OR clauses to account for all the Tag id's for this Tag. Additional OR clauses in this fashion can be hard for databases to optimize. For this reason, we changed the query generating mechanism to use the IN operator like so:
SELECT "tagid", "intvalue", "floatvalue", "stringvalue", "datevalue", "t_stamp", "dataintegrity" FROM sqlth_1_data WHERE "t_stamp" >= 1580680800000 AND "t_stamp" <= 1581026400000 AND "tagid" IN (14568, 14571, 14572) ORDER BY "t_stamp" ASC, "tagid" ASC
The use of the IN operator allows for better database side query optimization. Users who want to change their historian to use the old query constructor with OR operators can do so by placing the following system flag in the ignition.conf file: