Create or edit a Record Definition
In this section:
Create a Record Definition
To create a record definition, and to define the fields go to, Dashboard > Records > Add new
Edit a Record Definition
To edit a record definition, go to, Dashboard > Records > Select Record > click Edit Record Definition in the top right corner.
Option | Description |
---|---|
The left-hand side of the screen contains the information about the record definition itself and the right-hand side has details of the fields/schema. | |
Record Definition details | |
Record name | Required. Name for the record definition. |
ID | Required. A unique ID for the record definition used in the API. Once created this field cannot be modified. |
Title field | When viewing the details of a record, the record definition ID is displayed by default. To view the details of a record, go to Dashboard > Records > select from the list > select record. You can customise this (view record details page) to display the contents of the title, subtitle or the tooltip field.
|
Subtitle field | |
Tooltip | |
Context | Context is useful both for setting permissions and for relating data generally. If you wish to display other relations between records directly, use a contextual view.
You must add fields to your record definition before configuring the source of context. For example, you can set the Parent to Current User and the From Field to a field in your record that contains information that can identify the user (for example, email). |
Permissions | Setting permissions for a record definition allows you to view or edit permissions after the initial save. If no permissions are set, a warning is displayed. We appreciate there are circumstances where it may be required to create a totally immutable record definition. For more information on permissions, see Permissions. Ensure that you set the required permissions for a record definition before you save it. If you fail to do so, users (including the creator of the record definition) are not allowed to view or edit it. Adding permission To add a permission click the button. The Add permissions box displays. Enter the name of the group and select the required permission settings: Read permissions Edit/Write permissions Adding read permission for a group allows you to:
Users who can view one or more fields within the record definition can load an expurgated version containing only whether they can write the field and its type and not what permissions other users have. The edit permission for a group allows users of that group to alter the definition of the record definition type.
|
Delete permission | If enabled, users with required permissions can delete records. Users must have permission to edit the record and fields, to be able to delete a record. For more information see Records. |
Listing | Allows you to set listing permissions for the record. The following options are available:
|
History | Allows you to configure who can view the history of changes made to the record. The following options are available:
Click Save to save and apply the settings. |
Audit Logging | This allows you to set when logs for users actions like reading/listing a record should be generated. Log reads can now be set on the Record and View definition pages by any user who has permission to write/edit the selected record type. By clicking on the Audit logging switch you can set when logs should be made for this record type (i.e when a user is reading a record or when a user is reading and listing records). To create the logging permissions select the table you would like to record, who made the read (Log actor to) and what fields they accessed. You can choose to monitor log reads by a specific user or all users. Please note that this is separate to the inherent logging as part of the blockchain and is designed to facilitate the use of history as part of access control or triggers.
|
You must create fields for the record definition to be able to save it. An error is displayed if you click Save before defining fields for the record definition.
Adding Fields
Data is stored in the record in fields. Fields are a part of a record which contains a single piece of data for the record. You can create new fields or edit attributes of existing fields.
The left-hand side of the screen contains information about the record definition itself, and the right-hand side contains information about the fields in the record.
Once you have created a record definition, make sure that you create fields. To add a field, click on the Click to add a field option in the right-pane.
Option | Description |
---|---|
Field details | |
Field Name | Required. Enter a name for the field. |
Type | Required.
|
Required | Enable the option to set the field as mandatory |
Display in tables | Enable the option if you want to display the field when viewing record details in the table |
Display column | Select the column in which the field should be displayed when creating/updating the record. The options are Left, Right, Bottom and None. |
Display order | Set the order in which the fields must be displayed in the column |
Field encryption type | Select the encryption type to be applied to the field. All data is encrypted at rest using modern, secure AES technology. Sometimes, however, it is desirable to provide a further layer of security that cannot be decrypted without a fully validated transaction (that is, without the consent of the network as a whole) or to mark data as externally encrypted so it is not displayed in the UI. Restrictions apply to how granularly encrypted fields can be used for other purposes as the Gospel engine cannot understand the data contained therein so this is generally best kept for the most sensitive data such as PII. The available options are:
|
Use index | Index Type: Indexing enables efficient retrieval of data in the database. Indexing enables you to store a small portion of the data in special data structures, which supports efficient and quick search results. For more information, see Indexing. It is recommended that you enable indexing for:
Indexing can be enabled for the following data types:
|
Field Link | This option is available only if indexing is enabled. This field allows you to create a relationship between a field in the current (child) record to a field in another record (parent). When creating a record, the child record inherits the values from the parent record. For more information, see Field Link and Foreign Keys. Record Name: The drop-down list displays the list of records. Select the parent record that contains the field. To Field: The drop-down displays the list of fields that exist for the record. Select the field name from the drop-down list. Performance may be affected if the fields in both the parent and child records are not indexed. |
Enforce Foreign Key | If enabled, before saving the record it verifies that the field exists in the parent table. Thus, ensuring foreign key integrity. |
Security Context | Set an override minimum security score to view this data when it contextually matches one of the following:
|
Permissions | Separate permissions are required to read and write data. There are situations, especially in BPM workflows, where users may require only write access and no read access. Click the button. The Add permissions box displays. On this screen, you have to first select to "identify users" to whom the permission is applied, and then, select "what" permission should be applied: Identify users:
What permissions:
Click Save to save and apply the settings. Copying and pasting permissions Creating and applying complex permission can be time-consuming and therefore to simplify this, you can use the Copy/Paste option. Once you have applied the required permission settings to a field, you can Copy the settings and apply to all other required field using the Paste option. |
Click Save to save your changes. Click Revert changes to undo the current changes and revert to the last saved version.