TABLE OF CONTENTS
- Introduction
- Custom Tables
- Add New Custom Table
- Manage Field Settings
- Editing Custom Table
- Deleting Custom Table
Introduction
Navigate to: Dev Center > Custom Tables
Using the Custom Table feature of Znode, the administrator can create and manage the custom tables. In these custom tables, the administrators have the capability to add and manage the fields. Once the fields are created, add and manage the data in the rows as records. Also, the administrator has the provision of importing or exporting the table data.
Custom Tables
New menu named "Custom Table" has been added to the Znode Admin Console under the Dev Center where all the created custom tables will be displayed with the details in the following columns:
General Settings
Field | Description |
Table Key | Table Key has been defined as a mandatory field to define a key for the new custom tables and will be a non-editable field when editing an existing table. |
Table Name | Table Name is also a mandatory field that will be used as a label for the custom table that the administrator is creating. |
Created Date | This will be the Custom Table created date. |
Last Updated | This will show the Date when the Custom Table was updated last time. |
Action | Edit and Delete are the 2 actions that the administrator can only perform on the created Custom Tables. |
Add a New Custom Table
Navigate to: Dev Center > Custom Tables > Add New
Administrators have the provision of creating Custom Tables using the "Add New" button, which opens the following screen.
On this screen, the administrator has to add the following details in order to create the new Custom Table:
- Table Key
- Table Name
After adding the above-mentioned details, the administrator has to click on “Save” or "Save & Close" to create the Custom Table.
Note: "Custom Table Field" will be disabled until the administrator creates/saves the Custom Table by clicking on Save or Save & Close.
Adding Fields
Navigate to: Dev Center > Custom Tables > Manage Field > Add Custom Fields
After saving the Custom Table, the next step for the administrator will be to add/manage the Fields. To add a new Field, the administrator has to click on "Add Custom Field" and add the following details:
- Field Type
- Field Code
- Field Name
- Display Order
Manage Field Settings
Field | Description |
Field Type | An administrator has to select from one of the following field types that are supported:
|
Field Code | Field Code has been defined as a mandatory field to define a code for the new field and will be non-editable when the administrator manages the field-related details. |
Field Name | Field Name is also a mandatory field that will be used as a label for the Field that the administrator is adding. |
Display Order | Administrator can add the Display Order for the Fields. |
Action | Edit and Delete are the 2 actions that the administrator can only perform. |
Editing Field
Navigate to: Dev Center > Custom Tables > Manage Fields > Edit
Using the Edit action button, the administrators will be able to manage the previously created fields. Administrators can only edit "Field Name" and "Display Order" as Field Type and Field Code will not be editable.
After making the changes to the fields, it is mandatory for the administrator to save the changes using Save or Save & Close.
Deleting Field
Navigate to: Dev Center > Custom Tables > Delete
Using the Delete action button, the administrators will be able to delete the previously created fields.
Note: The administrator has the capability to delete the fields individually, as the bulk delete option is not available.
Add a Record
Navigate to: Dev Center > Custom Tables > Edit Custom Table > Add a Record
After creating the fields, the next step is to add the records to the table. In order to add a record, the administrator has to click on the "Add a Record" button which will open the following screen and add input to the fields.
The administrator has to click on the Save or Save & Close button to save the record to the table.
Note: Out of the 4 types mentioned above, the input is mandatory for Number and optional for Text and Text Area.
Editing a Record
Navigate to: Dev Center > Custom Tables > Edit Record
Using the Edit action button, the administrators will be able to manage the previously created records. All the values in the records are editable.
The administrator has to click on the Save or Save & Close button to save the record to the table.
Deleting a Record
Navigate to: Dev Center > Custom Tables > Add New > Delete Record
Using the Delete action button, the administrators will be able to delete the previously created fields.
Note: The administrator has the capability to delete the fields individually, as the bulk delete option is not available.
Import
Navigate to: Dev Center > Custom Tables > Edit Custom Table > Import
To add multiple records at once, the administrator can make use of the import feature. To add multiple records at once, the administrator has to follow the below steps:
- Click on the Import Button which will open a pop-up as shown below.
- From here, the administrator can download the template in CSV format.
- After adding the data to the CSV file, the administrator will have to upload the file in order to initiate the Import process.
- Once the import is successful, the administrator will be able to view the records in the table.
Notes -
- Only the .CSV file extension is supported in Import.
- The template will include the Field Code and not the Field Names in the column header that are associated with the Table.
Export
Navigate to: Dev Center > Custom Tables > Edit Custom Table > Export
The administrator has the option to export all the records using the Export Button. Once the Export is initiated for the Custom Table, the exported record will be displayed in the Export Screen under Dev Center with an option to download and delete.
On Export Screen under Dev Center, the Export Type will be Custom Table and File Type will be CSV as this is the only supported format.
Editing Custom Table
Navigate to: Dev Center > Custom Tables > Edit
Using the Edit action button, the administrators will be able to manage the previously created Custom Tables. On Edit Custom Table screen, in the General Information section, Table Key will not be editable and Table Name will be editable.
Also, the administrator can Manage Fields, Add a Record, Import Records or Export Records (as explained above).
Deleting Custom Table
Navigate to: Dev Center > Custom Tables > Delete
Using the Delete action button, the administrators will be able to delete the previously created Custom Tables.
Additional Articles:
Deployment and Setup Documentation for Custom Table