5.1.1. Setting Up Dashboard Gadgets

Engineering Knowledge Manager

User's Guide | Chapter 5: Customizing EKM for Your Own Use | 5.1. Setting Up Your Dashboard |

5.1. Setting Up Your Dashboard |  | 5.1.2. Rearranging Gadgets
Prev |  | Next

### 5.1.1. Setting Up Dashboard Gadgets

You can easily add a variety of gadgets to your dashboard using the New Gadget action.

To set up a dashboard gadget:

1. Go to the Home section and select Dashboard.

2. Select (New) > Gadget. This opens the Add Dashboard Gadget dialog box (for example, Figure 5.2: Adding a Container Gadget).

3. Select the type of gadget you want to set up, and then fill in the rest of the dialog box according to the instructions for each gadget type listed below.

   - Container Gadget

   - File Gadget

   - Discussion Board Gadget

   - Extraction Monitor Gadget

   - Job Monitor Gadget

   - Process Monitor Gadget

   - My Tasks Gadget

   - Saved Query Gadget

   - URL Gadget

   - ANSYS Viewer File Gadget

4. Click OK to add the gadget to your dashboard. The gadget name appears as a link at the top of the gadget frame and when you click the link, it takes you to the object.

You can resize, edit or remove a gadget that is on your dashboard. You can also rearrange gadgets and reset the layout to the default if desired.

#### 5.1.1.1. Container Gadget

A Container gadget displays the contents of a folder or container in the gadget. The folder/container contents display as a list with four properties: Name, Type, Created by, and Date Modified.

To set up a Container gadget:

1. Select (New) > Gadget.

2. In the Add Dashboard Gadget dialog box, select Container from the Type of object to be viewed drop box.

   Figure 5.2: Adding a Container Gadget

3. Click Browse to select the desired folder or specify the path to it.

4. Keep the default name of the gadget (the folder/container name) or enter a new name.

5. Click OK. The contents of the folder/container display in the gadget.

The following example displays the contents of a Repository.

Figure 5.3: Sample Container Gadget

The container gadget displays links to objects in the folder or container. For example, if you click on a link shown in the sample gadget above, its contents will be displayed in the file list window:

Figure 5.4: Displaying the Content of a Linked Object

#### 5.1.1.2. File Gadget

A File gadget displays the contents of a file in the gadget. Except for Reports and EKM Journal files, the raw contents of the file are displayed. Some files in EKM’s file list window are shown in alternate views. For example, a process template is an XML file, but its default view is the process diagram. If you select this in the Dashboard gadget, only the XML content is shown. A Report is also an XML file, but is rendered in HTML when it is selected in the Dashboard Gadget. Similarly, if an EKM Journal file is selected and it has the property Result Report Macro specified, the result of the macro execution is shown in the gadget. The Result Report Macro property should point to a macro specified in the journal file. This macro shouldn’t take any arguments and must return an instance of `ReportObjectInterface`. See Scripts and Journals in the EKM Administration Guide for more details.

To set up a File gadget:

1. Select (New) > Gadget.

2. In the Add Dashboard Gadget dialog box, select File as the object type from the drop-down list.

   Figure 5.5: Adding a File Gadget

3. Click Browse to select the desired file or specify the path to it.

   Important: Only select files of those types that can be viewed in the web browser such as Text, HTML, Image, and so on. Selecting a binary file for a File gadget may prompt you to download the file every time you view or refresh the Dashboard.

4. Keep the default gadget name (the file name) or enter a new name.

5. Click OK. The contents of the file are displayed in the gadget.

   Figure 5.6: Sample File Gadget

#### 5.1.1.3. Discussion Board Gadget

A Discussion Board gadget displays the discussions that are posted on a discussion board, with the most recently-posted discussions shown first. The Discussion Board gadget will not show attachments or references that are associated with messages — only the text of messages.

To set up a Discussion Board gadget:

1. Select (New) > Gadget.

2. In the Add Dashboard Gadget dialog box, select Discussion Board from the drop box, as shown below:

   Figure 5.7: Adding a Discussion Board Gadget

3. Click Browse to select the discussion board that you want to display in the gadget.

4. By default, the name of the discussion board will be used as the gadget name. You can edit the gadget name if desired.

5. Click OK. The Discussion Board displays in the gadget.

   Figure 5.8: Sample Discussion Board Gadget

See Discussion Boards for more details on Discussion Boards.

#### 5.1.1.4. Extraction Monitor Gadget

An Extraction Monitor gadget displays the status of metadata extraction from files that have been uploaded to EKM. It is a view of the Data/Extraction Monitor page.

To set up an Extraction Monitor gadget:

1. Select (New) > Gadget.

2. In the Add Dashboard Gadget dialog box, select Extraction Monitor from the drop box, as shown below:

   Figure 5.9: Adding an Extraction Monitor Gadget

3. Click Browse to select the discussion board that you want to display in the gadget.

4. Specify the gadget name, then click OK. The gadget is created.

   Figure 5.10: Sample Extraction Monitor Gadget

For more information about the extraction monitor, see Monitoring Data Extraction.

#### 5.1.1.5. Job Monitor Gadget

The Job Monitor gadget displays the jobs that are on your Jobs/Job Monitor page, and lets you access those jobs directly.

To set up a Job Monitor gadget:

1. Select (New) > Gadget.

2. In the Add Dashboard Gadget dialog box, click the Type of object to be viewed drop box and select Job Monitor from the list.

   Figure 5.11: Adding a Job Monitor Object

3. Enter a name for the gadget in the Name of gadget edit box, or keep the default name.

4. Click OK to add the gadget to your dashboard.

Figure 5.12: Sample Job Monitor Gadget

See Monitoring and Controlling Jobs for more information about job monitoring.

#### 5.1.1.6. Process Monitor Gadget

A Process Monitor gadget displays active processes in the same way that they are displayed on the Processes/Process Monitor page.

To set up a Process Monitor gadget:

1. Select (New) > Gadget.

2. In the Add Dashboard Gadget dialog box., select Process Monitor as the type of object to be viewed.

   Figure 5.13: Adding a Process Monitor Gadget

3. Keep the default gadget name (`Process Monitor`) or enter a new name.

4. Click OK.

   Figure 5.14: Sample Process Monitor Gadget

For more information about the creation, display and monitoring of processes, see Starting a Process.

#### 5.1.1.7. My Tasks Gadget

A My Tasks gadget displays the tasks that are in your queue in the same way that they are displayed on the Processes/My Tasks page.

To set up a My Tasks gadget:

1. Select (New) > Gadget.

2. In the Add Dashboard Gadget dialog box, select My Tasks as the type of object to be viewed.

   Figure 5.15: Adding a My Tasks Gadget

3. Keep the default gadget name (`My Tasks`) or enter a new name.

4. Click OK.

   Figure 5.16: Sample My Tasks Gadget

See Managing Tasks Assigned to You for more details on tasks.

#### 5.1.1.8. Saved Query Gadget

A Saved Query gadget executes the search for the query, and displays the search results in a single table in order of relevance.

To set up a Saved Query gadget:

1. Select (New) > Gadget.

2. In the Add Dashboard Gadget dialog box, select Saved Query as the object type from the drop-down list.

   Figure 5.17: Adding a Saved Query Gadget

3. Click Browse to select the saved query or specify the path to it.

4. Keep the default gadget name (the name of the saved query) or enter a new name.

5. Click OK. The query executes and the search results are displayed in the gadget.

   Figure 5.18: Sample Saved Query Gadget

#### 5.1.1.9. URL Gadget

A URL gadget displays a connection to a URL object that exists in the EKM repository. For example, if a connection to the ANSYS home page (http://www.ansys.com) exists in the repository and is named “ANSYS”, then you can define a URL gadget to display the contents of the ANSYS connection using this option.

To set up a URL gadget:

1. Select (New) > Gadget.

2. In the Add Dashboard Gadget dialog box, select URL from the Type of object to be viewed drop-down list.

   Figure 5.19: Adding a URL Gadget

3. Click Browse to select the saved query or specify the path to it.

4. Keep the default gadget name (the URL object name) or enter a new name.

5. Click OK. The URL web page displays in the gadget. An example is shown below.

   Figure 5.20: Sample URL Gadget

#### 5.1.1.10. ANSYS Viewer File Gadget

An ANSYS Viewer File gadget displays a selected ANSYS Viewer Archive (.avz) file in an embedded, interactive viewer. This is the same viewer that is displayed on the Image tab when viewing certain types of simulation files and 3D image files. It includes a toolbar that enables you to interact with the model and change the view.

To set up an ANSYS Viewer gadget:

1. Select (New) > Gadget.

2. In the Add Dashboard Gadget dialog box, select ANSYS Viewer File from the Type of object to be viewed drop-down list.

3. Click Browse to select the desired .avz file from the repository.

4. Keep the default gadget name (the file name) or enter a new name.

5. Click OK. The model is displayed in the viewer inside the gadget, as shown below.

   Figure 5.21: Sample ANSYS Viewer Gadget

For information how to interact with the model and control the view, see Viewing Simulation Models and Images.

Contains proprietary and confidential information of ANSYS, Inc. and its subsidiaries and affiliates.

Prev | Up / Contents | Next

Release 18.2 - © ANSYS, Inc. All rights reserved.