Creating a Visualization

Creating a visualization from scratch involves creating an index pattern. In the PeopleSoft implementation of OpenSearch Dashboards, an index pattern is associated with a search definition, so a visualization is based on a search definition. The index pattern identifies the mapping of the indexed fields. You could also use an index pattern that has already been created if you need to create a visualization based on the same search definition.

A user with the Search Administrator role or a user with create privilege specified on the Insights Privileges page can create a visualization.

See Specifying User Privileges.

Before you can create a visualization, you need to create an index pattern.

To create a new visualization, complete the following steps:

1. On the Insights home page, select the Management icon.

   The Management page displays existing index patterns, if any.

   Note:

   You must specify one of the index patterns as the default index pattern. If you do not set a default search pattern, users may see error messages when they attempt to view any of the dashboards.

2. Select Create index pattern.

   The Create index pattern page displays the application data indexes that are indexed in OpenSearch. The indexes are suffixed with a database name.

3. For Step 1: Define index pattern, enter an indexed search definition and suffix it with a wild card character (*) to generalize the index pattern and to avoid dependency on the database. If the search definition name that you entered matches the indexed search definition, a success message is displayed.

   For example, ep_ap_payments*

   When you enter a name, take into consideration the characters that can be used.

   If you prefer to create a new index pattern, based on a delivered index pattern, you can name it with an additional underscore (-) before the wildcard (*), for example, ep_ap_payments_*. Thus, you can avoid overwriting your customized index pattern when PeopleSoft delivers an update on the index pattern.

4. Select Next Step.

5. For Step 2: Configure settings, enter a time filter field name or you can select I don't want to use the Time Filter.

   If you select a time filter field name, OpenSearch Dashboards will use the field to filter the data by time.

   Use the Show advanced options link to specify a custom name for the index pattern instead of the system-generated name.

6. Select Create index pattern.

   On creating an index pattern, OpenSearch Dashboards displays the mapping of all the fields in the index pattern.

   In the PeopleSoft implementation of OpenSearch Dashboards, you should use the field alias for aggregation to return the original text based on the required case-sensitive text.

   Note:

   If you are using PeopleTools 8.59.02 or earlier, you may be using technical field names instead of the field name alias, which is the default in PeopleTools 8.59.03 and later versions. For instructions on remediating the issue, see Using Field Aliases in Kibana Visualizations in PeopleTools (Doc ID 2787722.1).

   If additional languages are enabled in the index, the field names display the corresponding field alias.

7. After creating the index pattern, select the Discover icon to view the indexed documents of the index pattern.

   Select a date range to filter the documents.

   Note:

   The Discover page uses the technical names for fields rather than the alias names displayed on the index pattern.

8. Next, select the Visualize icon. The page lists existing visualizations, if any.

   1. Select the plus sign to create a new visualization.

   2. On the New Visualization page, you can see visualization types, such as, tabular form, pie chart, bar chart, gantt chart, region map, and so on. For instructions on creating a region map, see Creating Custom Vector Maps (Region Maps) Visualization.

      Select a visualization type.

      Hover over each type to read a description of the visualization type.

   3. On the New Pie/Choose a source page, select the index pattern that you created.

   4. Specify metrics for the visualization.

      The options differ based on the visualization type.

   5. Specify bucket aggregations as required.

   6. Select Save, and then enter a name for the new visualization.

9. Select the Dashboard icon, and then select Create a new dashboard.

   You may add the visualization to an existing dashboard.

   You can add one or more visualizations to a dashboard.

   1. On the Editing New Dashboard page, select Add to choose a visualization.

   2. From the Add Panels page, select the required visualization.

   3. Select Save, and enter a name for the new dashboard.

      Note:

      The dashboard name should be unique.

      You may add a description for the dashboard.

      The new dashboard is listed on the Dashboard page.

For details on creating visualizations and using the various features of OpenSearch Dashboards, refer to the OpenSearch Dashboards documentation [3.2.0] on www.opensearch.org.