Manage Entity Views
This entry describes how to configure Entity Views.
Entity Views allow you to customize which fields are displayed in various parts of LearningBuilder™ for a given Entity.
There are four types of Views:
View Type | Where Used (varies by Area; see second table) |
Summary |
|
Detail |
|
Report | Available as a data source in the Admin > Report sub-navigation tab. |
Export | On CSV exports on the Audit and Eligibility tabs. Prior to Release 8.11, the also controlled the CSV export on the Admin -> Profile page. |
All Entities have a default View, which is used in all areas and for all View types, unless another View is created to override it. You will need to create additional Views if there is a need to have different fields appear in different areas of the system. For example, you might not want internal comments about a Learning Plan to be visible to practitioners. In this case you would add a View and assign it as the Practioner - Summary, and Practitioner - Detail View Types. Now there exists a set of fields from the workflow that are visible to the Practitioner, as well as a set of fields that are invisible.
The table below lists each Entity Type in LearningBuilder™, along with the system areas, View Types and situations in which they are used. This is important to know in case you would like a unique combination of fields to display in different areas, or view types.
For more information about the different areas, see the section: Areas of LearningBuilder.
When Modifying an Entity View, the View Type menu on the edit form includes the Area and View Type (ex: "Administrator - Detail").
Note: Prior to LearningBuilder 7.11, LearningBuilder™ lists many other combinations of Entity Type, Area and View Type that are not in the table below. Although these can be selected when configuring an Entity View, they have no impact on the system.
Entity Type | Area | View Type | Where Used |
|
Activity | Activity Approvals | Detail, Summary | Under view icon during a Full Page Branded Activity Search (new in Release 7.18) |
|
Administrator | Detail, Summary | Under view icon during a Full Page Branded Activity Search (new in Release 7.18) |
| |
Report | Reports sub-navigation tab |
| ||
Auditor, Eligibility | Detail, Summary | Under view icon during a Full Page Branded Activity Search (new in Release 7.18) |
| |
Practitioner | Detail, Summary | Under view icon during a Full Page Branded Activity Search (new in Release 7.18) |
| |
Provider | Detail, Summary | Under view icon on the Activity sub-navigation tab |
| |
Public | Detail, Summary | Under view icon during a Full Page Branded Activity Search (future) |
| |
Activity Instance, | Administrator | Detail, Summary | Under view icon on Profile -> Learning Plans |
|
Report | Reports sub-navigation tab |
| ||
Auditor | Detail, Summary | Under view icon when viewing a Learning Plan |
| |
Eligibility, | Detail, Summary | Under view icon when viewing a Learning Plan |
| |
Public | Detail, Summary | On Overview page for a Learning Plan in the External Contact Area |
| |
XML | Detail, Summary | Included in Process Synchronization if Depth = Activity |
| |
Learning Plan Instance | Administrator | Detail, Summary | On Overview page from Profile -> Learning Plans |
|
Report | Reports sub-navigation tab |
| ||
Auditor, Eligibility | Detail, Summary | Under view icon on in the Queue search results |
| |
Export | Included in the Queue Export |
| ||
Practitioner | Detail, Summary | On Overview page for a Learning Plan |
| |
Public | Detail, Summary | On Overview page for a Learning Plan in the External Contact Area |
| |
XML | Detail, Summary | Included in Process Synchronization if Depth = LearningPlan, TaskGroup or Activity |
| |
Learning Plan Definition | Administrator | Detail | On Overview page for a Learning Plan Definition |
|
Summary | On Overview page for a Learning Plan Definition |
| ||
Report | Reports sub-navigation tab |
| ||
Organization | Administrator | Report | Reports sub-navigation tab |
|
Member Role | Administrator | Detail | Under view icon on Profile -> Learning Plans |
|
Summary | Under view icon on Profile -> Learning Plans |
| ||
Report | Reports subnavigation tab |
| ||
Export | Included in the Profile Export (Deprecated in Release 8.11) |
| ||
Auditor, Eligibility | Detail, Summary | On Overview page for a Learning Plan |
| |
Export | Included in the Queue Export |
| ||
Practitioner | Detail, Summary | On Overview page for a Learning Plan |
| |
Member Search | Detail, Summary | On the Member Search Results after clicking view icon |
| |
My Account | Detail | In the Roles section |
| |
Provider | Detail | On the Member Search Results after clicking view icon |
| |
Public | Summary, Detail | On the Member Search Results, the Detail view is shown after clicking view icon |
| |
XML | Detail, Summary | Included in Process Synchronization |
|
Considerations
A best practice is to include more workflow fields on the Detail view type and fewer on the Summary view type.
When configuring your Export view type, remember that a larger Display List may result in a more cumbersome CSV file.
Also be sure to set your System Administrator role to False when exporting Member Role fields. This is a currently known limitation (Member Role fields won't export correctly with overlapping Admin and System Admin roles).
When an Entity View is created in the database, it uses the VIEW_SQL from the ENTITY_TYPE table. For Activity Instances, it did not omit the archived/deleted activities from the data (IS_ARCHIVED = 0). There is not a way for an entity view, after this change and by design, to get to deleted activities. (New in 8.15.0 #fb30996)