Manual Guide: Tables Management¶
This guide outlines the standard interface elements and operations available across all tables modules in the system.
1. Interface Overview¶
The module page consists of a main DataTables grid equipped with bulk action tools and a slide-over panel for form entries.
- Action Toolbar (Top): Contains global controls for bulk operations, search filters, and record creation.
- DataTables Grid (Center): Displays the data list with column-level searching and sorting capabilities.
- DataTables Grid (Bottom): Displays pagination controls if the records exceed the configured
Show Entrieslimit per page. - Slide-over Sidebar (Right): Pops up dynamically when creating or editing a record.
(Example placeholder for GIF)
2. Advanced Filtering & Search¶¶
The table is equipped with a dedicated filter row beneath the column headers to simplify specific data searches:
Free-Text Search: Available for text-based columns like ID, To, Subject, Module, Ref ID, Sent At, Created By, etc.
Simply type keywords into the input box under each respective column to filter data instantly.
Click the cross icon (X) on the right side of the input to clear the filter for that column.
3. Table Controls & Action Toolbar¶
Above the DataTables grid, you will find the global operation toolbar. Here is how each button works:
| Control / Button | Description |
|---|---|
| Opens the right sidebar to add a brand-new record. | |
| Hides or shows specific columns in the table grid. | |
| Copies the currently displayed table data to your clipboard for external use. | |
| Reloads the table data to fetch the latest information from the server. | |
Exports data (all rows if none selected, or targeted rows if checked) as a .zip package. |
|
Bulk uploads records and attachments using a structured .zip template file. |
|
| Selects all data rows simultaneously on the current page. | |
| Clears all currently selected data rows. | |
| Bulk archives selected records. | |
| Bulk updates (Modify All) selected records simultaneously. | |
| Permanently removes selected data after confirmation. |
4. Detailed Workflows & Operations¶
A. Creating a New Record¶
- Click the button in the top toolbar.
- The right sidebar will slide open.
- Fill in all required fields and parameters.
- Click Save to create the new record.
(Example placeholder for GIF)
B. Column Visibility (ColVis)¶
- Click the button in the top action toolbar.
- A dropdown menu showing all available columns will appear.
- Click on any column name to toggle its visibility:
- Checked/Active: The column is visible in the grid.
- Unchecked/Inactive: The column is hidden.
- The table grid will automatically resize and redraw.
(Example placeholder for GIF)
💡 Tip: Helpful for focusing only on specific data fields or optimizing smaller screen spaces.
C. Refreshing Data¶
- Click the button in the top action toolbar.
- The grid will instantly fetch and display the most recent database records.
(Example placeholder for GIF)
D. Copying Data to Clipboard¶
- Click the button in the top action toolbar.
- A confirmation notification will appear once copied.
- Paste directly into Excel or Google Sheets using
Ctrl + V(orCmd + V).
(Example placeholder for GIF)
E. Exporting Data (.zip Package)¶
- (Optional) Select specific rows in the grid, or leave everything unselected to export the entire dataset.
- Click the button in the top action toolbar.
- The browser will automatically download a
.ziparchive containing the.jsondata payload and associated attachments.
(Example placeholder for GIF)
F. Importing Data (ZIP & Preview)¶
- Click the button in the top toolbar to open the upload popup.
- Upload your structured
.ziptemplate file into the designated zone. - Review the parsed preview list showing all detected records and attachments below the upload area.
- Check or uncheck individual items to include or exclude them from the import queue.
- Click Import and wait for the success notification.
(Example placeholder for GIF)
💡 Tip: Ensure your
.ziparchive matches the expected system schema layout to avoid validation errors.
G. Selecting All Data¶
- Click the button in the toolbar to highlight all visible rows in the table.
- Once the rows are selected, bulk action buttons (such as Modify All, Delete All, or Archive All) will become enabled.
- To select a larger batch of records at once, adjust the Show Entries dropdown to display more rows on the current page before clicking the Select All button.
(Example placeholder for GIF)
💡 Tip: The "Select All" action applies to the records currently visible on your active page. Increasing your "Show Entries" limit allows you to execute bulk operations on a larger scale.
H. Deselect All Data¶
- Click the button in the toolbar to clear all currently selected rows in the table.
- All selected rows will be deselected, and the bulk action buttons will become disabled again.
(Example placeholder for GIF)
💡 Tip: Clicking Deselect All instantly resets your selection queue, clearing any active batch actions you have staged.
I. Archiving Data¶
- Select your target rows by clicking the first column of each row data, or use the Select All button at the top column header.
- Click the button in the toolbar to offload the selected records.
- A confirmation prompt or notification will appear once the selected data has been successfully moved to the archive storage.
(Example placeholder for GIF)
⚠️ Important Note: Archived records will be relocated to their respective
_archivetables and removed from the active data grid. You can still inspect, audit, or restore them later viaCustoem Table > Datamenu.
J. Editing an Existing Record¶
- Locate the target row in the grid.
- Double-click the row or click the button inside the row actions.
- The right sidebar will slide open with pre-filled existing data.
- Update the necessary fields and click Update Changes.
(Example placeholder for GIF)
K. Bulk Editing (Modify All)¶
- Select your target rows using the checkbox on the left, or use the Select All button at the top column header.
- Click the top-toolbar button.
- A batch modification slide-over panel will appear.
- Set the target values to apply across all selected records:
- Leaving a field empty will ignore it.
- To explicitly clear/empty a field value, type
null. - Click Update to process the batch modification.
(Example placeholder for GIF)
⚠️ Important Note: Changes applied through Modify All will instantly overwrite data for all selected records. Double-check your selections beforehand.
L. Deleting a Single Record¶
- Locate the target row in the grid.
- Click the row-level button.
- Confirm the deletion prompt in the security warning modal.
(Example placeholder for GIF)
M. Bulk Deleting (Delete All)¶
- Select your target rows using the checkboxes or the Select All button at the top.
- Click the top-toolbar button.
- Confirm the deletion prompt showing the total count of items targeted for removal.
(Example placeholder for GIF)
🚨 Critical Warning: Data deleted via Delete All is permanent and cannot be undone unless a database backup is restored. Exercise extreme caution.