AVEVA AIM Dashboard Extensions

The architectural framework of the AIM Dashboard has been built so that you can extend the functionality of the following areas:

• The Global Navigation Panel - the bar on the left hand side of the screen that displays the main AIM Dashboard areas of functionality, for example, Search or Browse.

• The Tabs Panel - the bar along the top of the screen that displays tabs for the items you open in the AIM Dashboard.

• Item Views - are different layouts or "views" of an item and its information, the two default views are the Document View and the Summary view.

• The Actions menu - this enables you to perform an "action" on one or more items simultaneously. It is found where multiple items can be selected at the same time. For examples, opening items from the Search panel.

• The Item View Actions menu - the specialized Actions menu on an Item View, such as the Document View, Summary View or selected item Content Card.

• The Document View toolbar - the toolbar at the top-left of the Document View.

Examples of extensions to these areas can be found in:

[installation folder]\Dashboard\Samples\DashboardExtensionSamples.zip

The types of files that can be found in the various examples are as follows:

• JavaScript (JS) - contains the registration and directive for the extension, always required.

• HTML - HTML structure, where required.

• CSS - Styling for HTML, where required.

• PNG - image files that can be used, for example, as icons. where required.

To use the example extensions:

1. Copy the example files in to [application root]\App\custom\.

2. Reset IIS.

To create your own extensions:

3. Create a new folder in [application root]\App\custom\.

   Note: It is recommended that you use a different folder for each extension.

4. Copy the file(s) from the relevant sample extension folder to the new folder.

5. Alter the file(s) based on your requirements, with reference to the descriptions in the following tables.

   Note: All references to images in CSS must be relative to the App/custom folder and all references to templates should be from the web root.

6. Reset IIS.

When you create an extension there are, typically, two parts to the JS file:

• The registration into an extendible area of the AIM Dashboard.

• The directive (the control) that is used for that extension.

The following sections contain the reference for the registration and the directive of each extendible area of the AIM Dashboard.