Create a search dashboard

You can build a search dashboard from scratch or you can jump-start that process from the Explore screen. 

1. About search dashboards

The basis for building a Search dashboard is to give the user a means to enter data into the deployment and to filter the way that data is displayed on the dashboard. You can specify filtering options from the Settings section of a dashboard, which is available only in edit mode. Now that your dashboard is in edit mode, the Settings button is available on the top menu of the dashboard.

You are now going to define the filters that your users will be able to use when using the dashboard.

2. Create a search dashboard

Step Action
1 Click the Explore icon from the left menu, and ensure you have selected the Order entity, then CycleNumber, CustomerName, and CustomerReference.
2 Click the Save as Dashboard button. The dashboard is created. The title bar of the dashboard also indicates the date and time of creation.
3

At the right side of the screen, click the Actions icon > Edit. The dashboard is displayed in edit mode.

4 Click the Settings button.The Dashboard Settings pop-up window is displayed.
5 Click Parameters under General Settings on the left menu, if it is not already selected.
6 Click the New parameter button.
7

In the Configuration pane, enter, for example, Cycle Number as the Name of your new parameter.

Similar to mappings, the names that you give to your parameters are only handles. You could name the parameter Boat, and the mapping would still work, but this would confuse the users.

8 In the Type drop-down, select Attribute.This enables you to enter text to compare against the instances of data. You will not be using any entities in the settings for this dashboard, so you should always select the Attribute type.
  In the Attribute type drop-down, select String (which is the correct type for Cycle Number, Customer Name, and Customer Reference).
9 You can select the Default Value option to specify the default selector/comparator to use in a search. This option is not required. When you create an attribute parameter, it is recommended to select the Contains option.
10 Leave the Mandatory checkbox empty. Note: Selecting the Mandatory checkbox indicates that the user must enter a value in the dashboard field associated with the parameter.
11 Repeat the same steps to create parameters for Customer Name and Customer Reference.
12 When you are finished, click Done.
13 Do not click Save on the dashboard yet.

Even though you have defined the parameters in the dashboard settings, the dashboard does not display any data yet.

3. Create a dashboard pagelet

Add a pagelet to hold your parameters. Every dashboard has one or more pagelets (pieces of a page). There are several types of pagelets. A specific pagelet is available to hold the type of parameters you defined.

Let's create that pagelet now:

Step Action
1
Define the location of the new pagelet. You can add a new pagelet by splitting the Data pane horizontally or vertically. For this tutorial, click the Split Vertically icon.

The Dashboard area is divided into two pagelets, the existing one and a new blank one.

2 In the untitled pagelet, click the Click here to configure the pagelet link. A pop-up window is displayed
3 Select the Search by Criteria pagelet type.
4 Drag-and-drop the parameters from the available parameters area to the displayed parameters area. When your parameters are in the displayed parameters area, click Done.
5

To move your pagelet to the top of the pane, click the title bar of the pagelet you just created, and hold the mouse button down while dragging the pagelet towards the top of the page. When you see a highlighted bar across the top of the dashboard space, drop the pagelet. The Search by Criteria pagelet is now at the top and the "Data" pagelet is at the bottom.

6 Verify that your dashboard is working properly. Try to enter some test data – for example, enter 4 in the Customer Reference Contains text box and click Apply . Based on the data in the deployment, you should get a results list with no entries, because no Customer Reference contains a 4.

 Investigate: Selection did not work

If you followed the steps above, you can still see all four items in the list in the bottom pagelet. That means the list did not get filtered based on your search. That is because you must configure the pagelet to create a filter for the list. To create a filter for the list, review the following information about pagelet configuration and then follow the procedure to edit the configuration.

4. About pagelet configuration

Configure the Data pagelet from the Pagelet configuration screen.

The following table describes the different areas in the Pagelet configuration screen and what they enable you to do:

Area Purpose
  1. Pagelet title

To edit the name of your pagelet.

2. Pagelet Representation

To see a preview of what the pagelet contents will look like on your dashboard. The way a pagelet is displayed varies depending on the type of pagelet.

3. Settings

To customize the way the data is displayed in a pagelet on a dashboard, click Format.

To define the data to display in the pagelet, click Data.

4. Time range

To view data in the deployment at instant or over a specific interval of time. By default, the option is set to at instant, that is, at the time machine instant.
5. Global Dimensions, Columns, and Rows To add dimensions to your pagelet and how they will be displayed.
6. Values The Values column on the right hand-side contains the values related to the attributes that you select in the Global Dimensions or Columns or Rows areas.

5. Edit a dashboard pagelet

To edit a dashboard pagelet, follow these steps.

Step Action
1 With your dashboard still in edit mode, click the pencil icon in the title bar of the bottom pagelet in your dashboard. Note: The bottom pagelet should be named Data, provided you didn't modify its name. The Data pagelet configuration page is displayed. For more information about what you can do from a pagelet configuration page, see About pagelet configuration.
2

You do not need to make any changes in the value pane. Instead, modify the Order entity section selected in the Rows area.

3

Click the Order box in the Rows area. Decision Insight opens the Edit Dimension page.

4
On the left menu, click Filter.

6 In the filter by attribute area, click Add filter by attribute.
  When the list of attributes is displayed, pick one that you used in the definition of your parameters, and click Select.
7

This will add a couple of lines to the Filter section. That section consists of words and selections. The words and the selections are dependent upon what you select. Find the drop-down box after the word "with" and change the drop-down selection to parameter.

8 In the second drop-down list, select the name of your setting parameter that matches the attribute you selected.
9 Do that again for the second and third attribute / parameter pair.
10 Click Done on the Edit Dimension page. Then click Done on the pagelet screen. You will still be in edit mode for the dashboard, but the functionality of the dashboard is active. If you still have the previous search parameter set (Customer Reference Contains 4), the results pagelet should be empty because no Customer Reference contains a 4.
11 Verify the accuracy of your filters again. When you pick Customer Reference Contains 7 and click Apply, you should see two lines. If that is working as expected, your dashboard is a success.
12

This would be a good time to change the title of the dashboard and the title of the Data section to something more meaningful. You can see an example in the image below.


13 Click Save.


 Congratulations, your dashboard is complete.

Related Links