AVEVA™ Insight

Create a CSV or JSON metadata file

Save PDF

Create a CSV or JSON metadata file

Save PDF

Last UpdatedAug 16, 2022
3 minute read

Note: You can add tags as often as needed, but metadata for existing tags should not routinely be modified more than a a few times a month. Note that reuploading the same metadata for a tag doesn't count as "modifying" it.

Note 2:See Tag naming conventions to ensure that your tag names are supported by AVEVA Insight before proceeding.

To create a metadata file in CSV or JSON format

Open a new file using a spreadsheet for a CSV file, or text editor for a JSON file.

Note: When using the HTTPS upload endpoint URL, your file's content should be in UTF-8 encoding.
Name the first column (or in the case of JSON, the first parameter) "TagName" (not case-sensitive).
Use the actual tag names for your data as values for the TagName column.
Add other metadata columns (not case-sensitive). You may include:
- Any of the columns listed in the "Supported metadata columns" section below.
- Any extended tag properties that you would like to define.
Follow these guidelines for data values:
- A decimal separator is not required for numeric values; but when supplied, it must be "."
- If no data type is specified, AVEVA Insight assigns the data type automatically when the data is uploaded. To do this, AVEVA Insight determines whether the data can be parsed to a numeric value. If it can, it is assigned the "float" data type. If not, it is assigned "DoubleByteString".
- For other metadata columns, if no value is specified, AVEVA Insight uses the default for that column.

Supported metadata columns

These columns are supported in metadata files:

Column name	Description	Comments about how values are processed
Alias	A tag alias for the tag. A tag alias is a friendly, searchable name that you can assign to a tag.
DataType	Indicates the datatype for the tag. Note: This column corresponds to TagType in the Tag Dictionary.	For numeric (analog): Int2 – Signed 2-byte integer; UInt2 – Unsigned 2-byte integer; Int4 – Signed 4-byte integer; UInt4 – Unsigned 4-byte integer; Float – Single precision floating point number ; Double – Double precision floating point number For string: String – Used to specify double byte string tags. For discrete: Int1 – 1-byte integer
Description	A description of the tag.	Any description is accepted.
EngUnit	The engineering units used for the tag's recorded values.	Any engineering unit provided is accepted. For strings tags, values are ignored and set to blank.
IntegralDivisor	The factor to be applied when integrating a rate with the units [EngUnits/TimeUnit] to a quantity with units [EngUnits]. Default is 0.	Processed as a double precision floating point number. Ignored for string and discrete tags.
InterpolationType	The interpolation type used for data retrieval. Valid values are: Linear, StairStep, or SystemDefault. Default is SystemDefault, which lets the system automatically detect and set the appropriate Interpolation Type for the tag's data type.	For string and discrete tags, values are ignored and set to (None).
Location	Defines subgroups for your team and data. With locations defined, you can specify who can see which tags. (For example, tags with the location "Houston" are visible by users whose accounts have the "Houston" location.)
Max	Max values are used for both maxEU and maxRaw. Note: This column corresponds to EngUnitMax in the Tag Dictionary.	Any maximum provided is accepted. For string and discrete tags, values are ignored and set to 0.
MessageOff	The message associated with the FALSE state of the discrete tag. The maximum number of characters is 64. A discrete tag set to 0 is in the FALSE state.
MessageOn	The message associated with the TRUE state of the discrete tag. The maximum number of characters is 64. A discrete tag set to 1 is in the TRUE state.
Min	Min values are used for both minEU and minRaw. Note: This column corresponds to EngUnitMin in the Tag Dictionary.	Any minimum provided is accepted. For string and discrete tags, values are ignored and set to 0.
RolloverValue	The rollover value for the tag.	Processed as a double precision floating point number. Ignored for string and discrete tags.
TagName	Required as the first column in the file. Values are the actual names of the tags.

Sample metadata files

Select a link below to see sample CSV and JSON metadata files:

AVEVA™ Insight