Child pages
  • Dashboards

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


 

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.

...

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.


 Image Added

Image Removed

 

Image Removed

 


Image Added


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: Manage Admin -> Database -> List DatabaseTables, then clicking on the "dashboards" table.

Code Block
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`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8;

 


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.

...

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
ID
Action
Resulting Function
Permission Required
URL Example
Notes
Example Response
GETn
 

collectiondashboards::read/dashboardsReturns a list of dashboards.
 

POSTn
 

createdashboards::create/dashboardsInsert a new dashboards entry.
 

GETy
 

readdashboards::read/dashboards/{id}Returns a dashboards details.
 

PATCHy
 

updatedashboards::update/dashboards/{id}Update the details of a dashboards entry.
 

DELETEy
 

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
ID
Action
Resulting Function
Permission Required
URL Example
Notes
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}