Retrievals for dashboard controls

The Dashboard Control Retrieval dialog box opens when dashboard controls with data retrieval capabilities are added to a dashboard window or when the (Retrieval) property for these controls is changed in the Properties dialog box. This dialog box is used to select a retrieval for these controls.


 

Contents  [Hide]

 

Retrieval Basics

For any dashboard control that is based on a Retrieval, that Retrieval defines two things:

There are six types of retrievals:

Selecting an existing data retrieval

The Dashboard Control Retrieval dialog box displays separate lists of any existing data retrievals.

  1. In the Show retrievals for list, select the type of retrieval you want to use.

  2. Click a retrieval name to select it on the list. Then, click Next or OK.

Tip: By typing any part of a retrieval name in the Search field, you can restrict the list so that it displays closer matches.

Creating a new data retrieval

To create a new data retrieval:

  1. In the Show retrievals for list, select the type of retrieval you want to use.

  2. Click New... on the Dashboard Control Retrieval dialog box.

  3. Enter a name for the new retrieval.

  4. Click OK.

Editing or copying a retrieval

Important: Editing or changing a retrieval listed on the Dashboard Control Retrieval dialog box will apply any edits made to it, to any control on a saved dashboard window that uses that particular data retrieval on one or more of its controls. See the Used by... button to determine if other dashboards use a specific retrieval.

Note: You can copy an existing retrieval, change it as needed, and then save it with a different retrieval name without affecting any dashboards that might be using that retrieval. See Copying and renaming a retrieval to learn more.

To edit a retrieval

Important: Editing or changing a retrieval listed on the Dashboard Control Retrieval dialog box will apply any edits made to it to any control on a saved dashboard window that uses that particular data retrieval on one or more of its controls. A good alternative to editing a retrieval can be Copying and renaming an existing retrieval.

To edit a data retrieval:

  1. In the Show retrievals for list, select the type of retrieval you want to use.

  2. Click the retrieval name on the list to select it.

  3. Click Edit... on the Dashboard Control Retrieval dialog box to change the settings for that retrieval.

The Used by ... button

To check if other saved dashboard windows have dashboard controls using a particular retrieval:

  1. In the Show retrievals for list, select the type of retrieval you want to use.

  2. Click the retrieval name on the list to select it.

  3. Click the Used by... button on the Dashboard Control Retrieval dialog box.

A message will be displayed to indicate which dashboards (if any) use the selected retrieval.

Copying and renaming a retrieval

To copy and rename an existing retrieval:

  1. In the Show retrievals for list, select the type of retrieval you want to use.

  2. Click the retrieval name on the list to select it.

  3. Click Copy... on the Dashboard Control Retrieval dialog box.

  4. Enter a new name for the new retrieval.

  5. Click OK.

  6. Now click the name of the new retrieval you just created.

  7. Click Edit... on the Dashboard Control Retrieval dialog box to change the settings for the new retrieval.

The Show locked... button

To view retrievals that are locked:

  1. In the Show retrievals for list, select the type of retrieval you want to use.

  2. Click the Show locked... button on the Dashboard Control Retrieval dialog box.

A message will be displayed to indicate which retrievals in the current list are locked (if any).

Importing a retrieval to the retrieval list

To import a data retrieval:

  1. In the Show retrievals for list, select the type of retrieval you want to use.

  2. Click the Import button.

The Open file dialog box opens.

  1. Click a saved retrieval file in the Open file dialog box to select it. Then, click Open.

An Enter Value dialog opens.

  1. Enter a new name for the retrieval in the text field. This name is how the retrieval will list in the Dashboard Control Retrieval open dialog box list. Then, click OK.

An informational dialog box opens confirming successful file import. The new retrieval name is highlighted in the retrieval list on the Dashboard Control Retrieval open dialog box.

Exporting a copy of a retrieval to a file

You can export a copy of a data retrieval shown on the retrieval list to a user-specified file.

To export a data retrieval:

  1. In the Show retrievals for list, select the type of retrieval you want to use.

  2. Click the retrieval name on the list to select it.

  3. Click the Export button.  An informational dialog box opens.

  4. Click Yes to export the selected retrieval.



    A Save As dialog box opens with the file name in the File name: text field.

  5. Click Save to save the retrieval to the designated file.

An informational dialog box opens, confirming the successful export of a copy of the retrieval to the designated file. Click OK.

Deleting a retrieval

To delete a retrieval from the Dashboard Control Retrieval dialog box retrieval list:

  1. In the Show retrievals for list, select the type of retrieval you want to use.

  2. Click the retrieval name on the list to select it.

  3. Click the Delete button.

An informational dialog box opens. Click Yes to confirm the deletion,