Endpoint - Attributes

Overview

An attribute is a specification that defines the property of any product/device. It can be considered metadata for the products. It is read only field of any device/endpoint.

Authorized users are able to select the “Attributes” tab for any endpoint to view the group wise attributes list and current value of each attribute. Attributes will be added during the endpoint configuration of any particular product line.  Authorized user can add attributes for the dynamic endpoint and view the value of the each attribute under the endpoint attribute section of any particular product. Endpoint attributes are required under endpoint to view the current value of the corresponding attributes.


Step-by-Step Process

Step 1 – Endpoint Attributes

  • After selecting product line, Click on “Endpoints” button for any particular product from the list
  • Click on End Point from the End Point list
  • Click on “Attributes” tab to view the list of groups (of attributes) and by clicking on any group, user can view corresponding attribute list.
  • Attribute list will display below details about the attributes:
    • Name
    • Description
    • Current Value
      • Users can be able to see the current value if it is set from the agent portal. (Refer Step -2).
    • Cloud Timestamp
    • Device Time Stamp
  • Expand/Collapse All Button
    • Click on it to expand/collapse all the groups to view their attributes details
  • Refresh Button
    • Click on “Refresh” button to refresh the attribute data.

Notes

  • Product must be active to view the attributes of the selected Endpoint
  • Definitions/Configurations of endpoint attributes are common for all the products of any particular product line.
  • In order to send the attribute value of the endpoint from the Agent portal, user must have to configure agent portal with that particular product’s device ID, serial number and CUID.

Step 2 – Sync Product

  • Click on “Advanced Controls” tab from the agent portal
  • Click on “Sync” button to sync the agent portal with flex portal
  • Agent portal will notify the user with the success or failure message
  • In case of success message, user can proceed with Step -3.

Note

  • Once the sync process is done, users can be able to send the value of attributes from the agent portal and it can be viewed in flex portal.

Step 3 – Dump DB

  • Click on “DB View” tab from the agent portal
  • Click on “Attributes” tab from the DB view
  • Click on “Dump DB” button.
    • It will display all the added attributes of the product/endpoint along with below details:
      • Attribute GUID
      • Attribute ID
      • Attribute Name
      • Attribute Datatype
      • Attribute Status
      • Endpoint ID (in case of endpoint’s attribute)

Step 4 – Set Attribute Value

  • Click on “Messaging” tab from the agent portal
  • User can see “Send Attributes” option where users need to insert below values:

Field

Type

Required?

Description

EP Local Id

Text Box

Yes

This field requires end point’s unique ID.

User can see this value from the DB View>> Attributes>> Ep ID (see below screen)

Attr Local Id

Text Box

Yes

This field requires the attribute’s unique ID. User can see this value from the

 DB View>> Attributes>> Attr ID (see below screen)

Data Type

Drop Down

Yes

This field requires the data type for the selected attribute of any endpoint

Attr Value

Text Box

Yes

Insert the attribute value

  • Click on “Send Attributes” button
  • Agent portal will notify to the user with the success or failure message
  • In case of success message, user can proceed to Step -5.

Step 5 – View Attribute Value in Flex Portal

  • Click on “Endpoints” button for any particular product from the product list.
  • Click on any endpoint from the endpoint list
  • Click on “Attribute” tab to view the value of attributes.
    • User can view the attribute value of that particular attribute which he has entered from the Agent portal.

 

Search