For the complete documentation index, see llms.txt. This page is also available as Markdown.

Data Schema Field Attributes and Field Permissions

Provides information on data schema field attributes and field permissions

Data Schema Field Attributes

For each field in the Data Schema, the following attributes are defined:

  • Name: the name of this field

  • Identifier: the string by which this field should be identified in the input data (if empty, the Name field will be used for identification)

  • Description: a description of the field (including any information that can help collaborators put the data in the correct format)

  • Type: the name of the field type. Please refer to Supported Data Schema Data Types for a full list of supported data types within the Rhino FCP

  • Type Params: any parameters for the field type (e.g., min/max values for a ContrainedInt type). Please refer to Supported Data Schema Data Types for a full list of supported parameters for each data type within the Rhino FCP

  • Units: the units in which the values of this field are expected to be. These units will also appear in charts showing aggregate values from this field in the Rhino UI

  • Sensitive Data: whether or not this field may contain sensitive data

  • Aggregate Statistics: the field's underlying data is only persisted on-prem, and NO aggregate statistics can be viewed in the cloud. This field can be viewed via Secure Access, given the proper permissions.

  • Secure Access: the field's underlying data is only persisted on-prem, and aggregate statistics can be viewed in the cloud. This field isn’t viewable via Secure Access.

Data Schema Field Permissions

For each variable defined within a schema, one of the following permission profiles can be applied:

  • Default: The variable's underlying data only persists on-prem, and aggregate statistics can be viewed in the cloud. This field can be viewed via secure access given the proper permissions.

  • No Aggregate Statistics: The variable's underlying data only persists on-prem, and no aggregate statistics can be viewed in the cloud. This field can be viewed via secure access given the proper permissions.

  • No Secure Access: The variable's underlying data only persists on-prem, and aggregate statistics can be viewed in the cloud. This field isn’t viewable via secure access.

  • Local Only: The variable's underlying data only persists on-prem, and no aggregate statistics can be viewed in the cloud. This field isn’t viewable via secure access.

Last updated

Was this helpful?