Data Viewer

The Data Viewer in the PaySuite application provides a schema-centric view of the data foundation. From a single page, you can browse standard and custom entities and enums defined in the platform, inspect their fields, and review the data stored in each one.

This is a tip message.

The Data Viewer is available under Workbench > Data Management > Data Viewer. Access to Workbench depends on your role within the platform.

Users with the Configuration, Support, Data Foundation Admin, Compensation Admin, and Global Compensation Admin professional roles have access to the feature.

Page overview

The Data Viewer page is built around the following elements:

• Two summary tiles at the top of the page that show how many Entities and Enums exist in the data foundation.

• The Search field, where you can find a data type by name. This feature supports partial matches, so entering only a fragment of the name is enough to surface the items you are looking for. For instance, entering "Comp" returns results such as CompensationElement, CompensationHistory, or ContractedCompensation.

• The Type drop-down list, which allows you to limit the list to entities or enums, or choose both.

• The Entity category drop-down list for filtering between Standard or Custom items, or selecting All.

• The paginated data type list itself, which includes the Name, Type (Entity or Enum), and Entity category (Standard or Custom) of each item.

The following figure illustrates the Data Viewer page:

Data Viewer page

This is an note/information message.

Custom entities are defined under Workbench > Data Management > Field Management > Custom Entities. Once created, they appear in the Data Viewer together with the standard entities and can be inspected the same way.

Viewing entity or enum details

Clicking the name of an entity/enum in the list opens its detail view. The detail view displays all the fields of the chosen entity/enum in a tabular layout, where each row corresponds to a record stored in the platform and each column – to the respective field.

The entity/enum detail view includes the following elements:

• An entity/enum drop-down list at the top of the page, which displays the entity/enum you are currently viewing and lets you switch to a different one without leaving the detail view.

• The Filters button, used to narrow the records shown in the table by attribute values.

• The Refresh data button, which reloads the table with the latest data.

• The Back to list button in the top-right corner, which takes you back to the main Data Viewer page.

• The data grid, which lists the records of the selected entity/enum together with their field values.

If the entity/enum contains many fields or records, you can scroll horizontally and vertically to see the full content. The pagination below the grid enables convenient navigation.

The image below presents the detail view for the Absence entity:

Entity's detail view

This is an attention message.

Please note that the grid is governed by user permissions, so it only contains records you have access to. If you are not authorized to see a given entity, the table appears empty or the entity is hidden from the main list altogether.

Filtering records within an entity or enum

To filter the records displayed in the detail view:

1. Click Filters above the data grid.

2. In the Select fields and values window, choose a criterion from the Criterion drop-down list, for example AbsenceType or EffectiveRangeStartDate.

3. Set an Operator, for instance Equal to, and provide a Value.

4. Click Apply.

In the grid, you will see only the records matching your criteria.

You can add more conditions to refine the view by clicking + Add condition in the window, and clear them all with the Clear filters button.

Sorting records

The data grid can be reordered by any column. Click a column header to sort the records in ascending order; click the same header again to reverse the order to descending. This works alongside any filters you have applied, so you can reorder the view at the same time.

Switching between entities or enums

There are two ways to move from one entity/enum to another:

• Return to the main list by clicking Back to list above the data grid, and then choose a different entity/enum.

• Open the entity/enum drop-down list at the top of the detail view and select a different entity/enum directly.

This is a tip message.

For more information about data integration into PaySuite, please see Introduction to Data Foundation and other articles from the Data foundation section of our Knowledge Base.

For a people-centric view of worker data that complements the Data Viewer, see the Workers view article.