How do I soft delete a tag?
Use the "alterTag" action to set a tag's "status" to "inactive".
How do I undelete a tag?
To undelete a soft-deleted tag, use the "alterTag" action to set a tag's "status" to "active".
You cannot undelete a tag that has been deleted using the "deleteTags" action.
How do I list only active tags?
Use the "listTags" action with "status" set to "active".
How do I list soft-deleted tags?
Use the "listTags" action with "status" set to "inactive".
How do I clone a tag?
Use the "describeTags" action to retrieve a tag and use its properties in "createTag" to create a new tag. You must give the new tag a different name.
Should createTag or alterTag be blocked by alterOneTable permission if it does not specify a source field?
No.
A tag represents one or both of the following in an integration table: a JSON property in the source_payload field, a user-defined field, or both.
A user must have the effective permission of the alterOneTable privilege to create or alter the user-defined fields in a table.
If a tag create or alters a user-defined field, the user must have the effective permission of the alterOneTable privilege; otherwise, a user may freely create and alter a tag’s other settings.
What is the difference between a Field, a Tag, and a JSON property?
A field and a tag are not the same thing.
A field is a column in a table that uses FairCom’s standard field types. SQL can query fields.
A JSON property in the source_payload field of an integration table is updated when a FairCom Edge connector collects data or an MQTT client publishes a message to a topic containing a JSON payload.
A tag is available only in the Edge and MQ products. It assigns a friendly name, description, and universal data type to a collected piece of data.
- A tag identifies which property in the
source_payloadfield contains a specific piece of data. - A tag optionally maps a JSON property in the
source_payloadfield to a user-defined field in the table.- When a tag maps a property to a field, the FairCom server automatically synchronizes the data between the JSON property and the field. The synchronization process is bidirectional and occurs when someone updates the field or updates the JSON property.
Why does a tag have different data types than a table field and a JSON property?
A JSON property has too few data types because it does not support date, time, timestamp, binary, and variant data types.
A table field has too many data types with many specialized number, string, and temporal types.
A tag data type unifies JSON and field data types into a universal set of data types that are useful in IoT use cases. The list of tag data types is universal because it covers all major types and includes the variant type, which can represent any possible data type conceived today and in the future.
A tag has the following set of types:
"string""number""boolean""date""time""timestamp""binary""json""variant"
A JSON property only has the following data types:
- string
- number
truefalsenull- object
- array
A database field has the following data types:
"bigint""binary""bit""char""date""double""integer""json""lvarbinary""lvarchar""money""nchar""number""nvarchar""real""smallint""time""timestamp""tinyint""varbinary""varchar""variant"