How To Create A View Entity

Overview
A View Entity is a special kind of read only entity that returns data similar to a report but with the added feature of having entity operations such as behaving as a parent/child object as well as being referenced in LOOKUP-type fields available.

The data in the view entity are read only as these are generated by combining fields/columns similar to reports.


Procedure
Step 1. Locate the List of Entities

Select the setup tab, and locate the Develop category. Under this category will be the Entity node, select this to display all entities. The list will look similar to below.



In addition to displaying all entities in the system this list will also show what you are able to do with existing entities. Such as customizing the entity itself and layouts.

Step 2. Select the New Button

By selecting the new button you will begin the new entity wizard. The first screen will look similar to below.

To set the new entity as a view entity, tick the View Entity checkbox. This will then change the attributes that are available to only show those that are relevant to the view entity type.

Field Name Description
Entity Name Enter an entity name for your new entity. This field can contain letters, numbers, and other characters. Field cannot contain spaces, start with a number, or punctuation.
Entity Label Enter a display friendly label for your new entity. This is what will show on the UI.
Enable Recycle Bin Enabling the recycle bin for your new entity means you will be able to store deleted records in the recycle bin for a determined amount of time.
Enable Cascade Delete Selecting this box means if you delete a record, and child records exist under it, child records will be deleted. For example with customers in your existing system. If you delete a customer then the pricing plans will be deleted along with it. 
Enable Cascade Delete Selecting this box means if you delete a record, and child records exist under it, child records will be deleted. For example with customers in your existing system. If you delete a customer then the pricing plans will be deleted along with it. 
Enable Related List Enabling related list means that data from this entity will be available using a a related list from other entities.
Enable Auto Search Selecting this box will auto-load the records in the entity when viewed in the UI. Otherwise, the user will need to enter a search string or hit the Refresh button when navigating into this node.
Create Search Form If you would like a basic search form to be created for your new entity select this box.
View Entity Indicates if the entity is a view entity.
Base Entity Applicable when View Entity is ticked. This is the base entity that will be used to build the fields to be sourced for this read-only entity.

Select the Next button to continue.

Step 3. Position Your New Entity

The next page will offer you a list of entities and nodes. Use this drop-down to select where you would like to place your new entity. This screen will look similar to below.


The new entity will be placed below the item you select in the list.

Select the Next button to continue.

Step 4. Set The Fields To Be Included And Set Permissions

The next step is to select the fields that will be included/sourced into the new entity. The object reference model can be used to select the fields that are needed relative to the source entity that was selected in the previous step.

Furthermore, filters can be used to determine what records will be shown similar to how reports are generated.


Lastly, set the entity role permissions for the new view entity using the Role Permissions table.

Step 5. Save The New Entity.

Click the Save button to save the new entity.

Have more questions? Submit a request

Comments

Powered by Zendesk