Canvas Envision Knowledge Base 5.10 Help

Gadget Data Record Property Mapping

Search condition JSON objects use the names of gadget data record properties given in the application database (DB). Gadget data webhooks send HTTP messages with gadget data record property names that differ from the UI and DB. The labels of gadget data record properties in the UI differ from the names of these properties in the DB and HTTP messages. The table below maps the UI labels to the DB and HTTP names.

The table also notes the data type of each property in the DB. The properties of gadget data records retrieved from the DB are of these types.

UI label

DB name

DB data type

HTTP message name

Description

Center

center.name

Text

center_name

A work center containing the document where a gadget data record was entered.

Created

created

Date and time

created

The date and time when the actual data of the gadget data record was first entered.

Customer Ref. identifier

customer_ref_identifier

Text

customer_ref_identifier

An ID of the viewing session, such as a work order number, serial number of an asset, ticket number, etc., entered in the Reference field of the login gadget if such a gadget exists in the document where the gadget data record was entered. If the document has no login gadget, this field includes a system-generated session ID unique within the document.

Data id

key

Text

data_id

The database ID of the data capture field where the actual value of the gadget data record was entered. The data capture field ID is unique within the document.

Envision User email

user.email

Text

user_email

The email address of the user who entered the actual value of the gadget data record.

File

file.id

Text

file_id

The path to the document where the gadget data record was entered. It is relative to the work center.

File version

file_version

Text

file_version

The Envision file version of the document where the gadget data record was entered.

Gadget instance identifier

instance_identifier

Text

instance_identifier

The system-generated ID of the data capture gadget object where the gadget data record was entered. The gadget instance identifier is unique within the document.

Gadget name

gadget_purpose_tag

Text

gadget_purpose_tag

The database ID of the data capture gadget where the gadget data record was entered. The gadget name is not unique within the document.

Gadget type

gadget_type

Text

gadget_type

The type of the data capture gadget where the gadget data record was entered.

IP Address

ip_address

Text

ip_address

The IP address of the device where the gadget data record was entered.

Is gadget

is_gadget

Boolean

is_gadget

A flag indicating whether the object where the gadget data record was entered is a gadget (true) or not (false).

Updated

updated

Date and time

updated

The date and time when the gadget data record was last entered.

User Identifier

user_identifier

Text

user_identifier

A user ID, such as a name, email, personal number, etc., entered in the User ID field of the login gadget if such a gadget exists in the document where the gadget data record was entered. If the document has no login gadget, this field is empty.

Value

value

Text

value

A piece of actual data that the user entered in the specified data capture field of the specified gadget object instance during the identified document viewing session.

01 August 2025