Record Editors

Description

The Record Editors module allows you to manage the record editors created and edit the data records defined to be editable in the editors.

Features

  • Add record editor
  • Edit record editor
  • Upload record editor
  • Delete record editor
  • Download record editor
  • Refresh list
  • Search

Module Interfaces

Interface Description Required Privilege
Record Editors Allows Record Editors access mod-record-editor
Record Editors Allowed to edit Record Editors mod-record-editor-edit
Record Editors Allows Record Editors management access mod-record-editors

Add

To add a record editor, start by clicking on the “Add” button on the upper right corner of the page.

In the “New Record Editor” dialog box, set the properties for the new record editor.

Field Description Mandatory Input Type Constraints Default Value
Name Unique name assigned to the record editor. Y Text field Any text (case-sensitive) Empty string
Copy From Copy from an existing record editor. Y Drop-down list Select from list “Blank Record Editor”
Dataset Defines the dataset to edit. Y Drop-down list Select from list None

In “New Record Editor” dialog box, key in the name to be given to the record editor into the “Name” field. The “Name” field must be a unique value (not used by other record editors) and it is case-sensitive.

If an existing record editor is selected in the “Copy From” field, the “Dataset” field will use the property from the existing record editor and will not be available. If a blank record editor is selected in the “Copy From” field, select the dataset to be edited in the “Dataset” field.

Click on the “OK” button in the dialog box to create the new record editor. Clicking on the “Cancel” button aborts the action. By default, the newly added record editor is enabled and is allowed to add and delete records. No fields from the dataset is added to be editable.

Refresh

After performing actions on the browser/tab, the list is reloaded to display the record editors. The manual “Refresh” button is available and is particularly useful if there are others making changes on the same page.

The “Refresh” button is found on the upper right corner of the page. Clicking on it reloads the list.

Upload

To upload a record editor, start by clicking on the “Upload” button on the upper right corner of the page.

The “Upload” dialog box appears on the page.

Browse to the location of the file (<filename>.recordeditor.json) to be uploaded and set the “Name” field. By default, the “Name” field uses the name of the upload file. You can change it to an appropriate name if desired. If the file to be uploaded is to replace an existing record editor, select the “Overwrite” field. Do note that the “Name” field must be unique, or an error message will appear.

Field Description Mandatory Input Type Constraints Default Value
Browse File Browse to select file to be uploaded. Y Text field Any text Empty string
Name Unique name assigned to the file to be uploaded.
When a file is specified in the above field, this field will automatically takes in the file name of the specified file.
Y Text field Any text Empty string
Overwrite If selected, overwrites existing record editor. N Checkbox Select or not selected Not selected

Click on the “OK” button to upload the selected file. Click on the “Cancel” button to abort the action. A message will appear after the file has been successfully uploaded.

If the name of the record editor to be uploaded already exist, an error message will appear.

To overwrite the existing record editor, select the “Overwrite” field in the dialog box, then click on the “OK” button.

You can arrange/sort the list of record editors in ascending or descending order by clicking on the name of the desired field. By default, the list is sorted by the “Name” field in ascending order.

Edit

To modify an existing record editor’s attributes, click on the “Edit” icon under the “Actions” column corresponding the desired record desired.

The “Edit” panel displays the selected record editor’s attributes.

In the “Properties” section, you can change name of the record editor in the “Name” field and the dataset in the “Dataset” field.

You can allow or disallow adding or deleting records in the dataset by selecting or deselecting the “Can Add” and “Can Delete” feilds respectively. To enable or disable the record editor, select or deselect the “Enabled” field respectively. By default, the record editor is enabled and allows adding and deleting of records. Disabled record editors will not be able to access Editor page.

In the “Roles” section, you can select the roles that are allowed to access the record editor by selecting the roles listed.

Alternatively, you can search for the roles required. You can also choose to select all, select none, or invert selection by clicking on the respective icons at the upper right corner of the panel.

In the “Fields” section, by default, no fields are added. There will be no fields to edit in the Editor page.

To add fields for editing, click on the “Add” button and a “Add Field” dialog box will appear.

Select the desired field from the drop-down list and click on the “Add” button in the dialog box. If all fields in the dataset are to be edited, click on the “Add all” button. The list of fields that are selected are displayed in the “Fields” section.

You can order the fields by clicking on the “Order” button that appear in the “Fields” section.

In the “Fields Sort Order” dialog box, drag-and-drop the fields to the desired location and click on the “OK” button to save the changes.

Click on the “Save” button located on the upper right corner of the “Edit” panel to proceed with saving the changes made. Clicking on the “Cancel” button aborts the action and retains the record editor’s attributes prior to opening the “Edit” panel.

Open Editor

To open the record editor, click on the “Open” icon under the “Actions” column corresponding to the desired record editor.

The Editor page will be displayed.

In this Editor page, you can edit the records, add new records, as well as delete a record. Do note that any disabled record editor will not be able to access the Editor page.

For more information on the Editor, see Editor.

Download

You can download an existing record editor by clicking on the “Download” icon under the “Actions” column corresponding the desired record editor.

The downloaded record editor has the following filename format <filename.recordeditor.json>.

Delete

Deleting a record editor removes it from the list.

To delete an existing record editor from Ambience, click on the “Delete” icon under the “Actions” column corresponding the desired record editor.

There is an option to undo the deletion. A notification with an “Undo” button appears right after clicking on the “Delete” icon.

Upon clicking on the “Undo” button, the deleted record editor is restored and is added back to the list. Do note that the notification will disappear after 5 seconds.

Search

The search bar appears on the upper left corner of the page.

This provides an easy way to search through the list. It is case-insensitive and displays records that have the entered search value in any of the values of the fields below:

  • Name
  • Dataset
  • Roles
  • Last Modified