Child pages
  • Dashboards
Skip to end of metadata
Go to start of metadata

As at Open-AudIT 2.2, we now ship with several pre-configured Dashboards. If you are a Professional user, you can select between two of these and set it as your default page when you logon. If you are an Enterprise user, you can not only select between the five preconfigured Dashboards, but you also have the ability to create your own.

The page How do Dashboards and Widgets work? may be of some assistance here.

Dashboards use Widgets, of which we supply over thirty as a default set. Professional users cannot alter these, but an Enterprise user has complete customisation abilities - including creating your own.

Dashboard provide "at a glance" important visibility for changes occurring on your network as well as providing quick links to device types, manufacturers, and operating systems and so much more.

Database Schema

The schema for the database is below. It can also be found in the application is the user has database::read permission by going to menu: Admin -> Database -> List Tables, then clicking on the "dashboards" table.

CREATE TABLE `dashboards` (
  `id` int(10) unsigned NOT NULL AUTO_INCREMENT,
  `name` varchar(100) NOT NULL DEFAULT '',
  `org_id` int(10) unsigned NOT NULL DEFAULT '1',
  `type` enum('default','org','user','') NOT NULL DEFAULT '',
  `user_id` int(10) unsigned NOT NULL DEFAULT '0',
  `description` text NOT NULL,
  `sidebar` enum('y','n') NOT NULL DEFAULT 'y',
  `options` text NOT NULL,
  `edited_by` varchar(200) NOT NULL DEFAULT '',
  `edited_date` datetime NOT NULL DEFAULT '2000-01-01 00:00:00',
  PRIMARY KEY (`id`)

API / Web Access

You can access the /dashboards collection using the normal Open-AudIT JSON based API. Just like any other collection (assuming you're an Enterprise user). Please see the API documentation for further details.

Access is provided as part of a roles permissions. Dashboards is a standard resource and can have create, read, update, delete and execute permissions.

The API routes below are usable from both a JSON Restful API and the web interface. The Web application routes are specifically designed to be called from the web interface (a browser).

API Routes

Request Method
Resulting Function
Permission Required
URL Example
Example Response
collectiondashboards::read/dashboardsReturns a list of dashboards.
createdashboards::create/dashboardsInsert a new dashboards entry.
readdashboards::read/dashboards/{id}Returns a dashboards details.
updatedashboards::update/dashboards/{id}Update the details of a dashboards entry.
deletedashboards::delete/dashboards/{id}Delete a dashboards entry.
EXECUTEyexecuteexecutedashboards::read/dashboards/{id}/executeExecute a dashboards and return the resulting dataset.

Web Application Routes

Request Method
Resulting Function
Permission Required
URL Example
GETncreatecreate_formdashboards::create/dashboards/createDisplays a standard web form for submission to POST /dashboards.
GETyupdateupdate_formdashboards::update/dashboards/{id}/updateShow the dashboards details with the option to update details using PATCH to /dashboards/{id}