How to Create a New Entity

Overview
Entities allow you to create entire new sections of data within BillingPlatform that can interact with other portions of the application as well as being report-able.

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.

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.
Child Node You can create entities under other entities. An example of this can be viewed with customers in your current system. Each customer has pricing plans under it. These pricing plans would be a child node. Child records will be tied to the parent record. You can place entities under others without having the data attached by leaving this box unchecked. To make your new entity a child node, select this check-box.
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 Look-up Enabling look-up means that data from this entity will be available using a look-up field from other entities. For more information please read the article on look-up fields.
Recycle Bin Retention Days Select the number of days to leave records in the recycle bin (if applicable)
Create Search Form If you would like a basic search form to be created for your new entity select this box.

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.

As noted in the screenshot. Child entities can only be placed under items marked with an asterisk (*).

Lastly, an option to hide the entity from the UI will allow the creation and viewing of records to be fully controlled from related list fields on parent entities. This is particularly useful if the data on the child entity only need to appear as data on related list and the admin does not want the users to access the child entity directly.

Select the Next button to continue.

Step 4. Set Permissions for Your New Entity

Use the grid to set permissions for your new entity. This screen will look similar to below.


This will allow you to specify who will be able to interact with the new entity and in which way. More information on roles can be found here.

Next Steps

Once you have created your entity you will want to populate the new entity with fields and configure the layouts.
Entity Fields - This section will cover entity fields, as well as how to create and configure them. Follow the link for more information on entity fields.
Layouts - This section contains tutorials showing you how to configure layouts within your entities. These layouts include input forms, list views, and search forms. Follow the link for more information on layouts.

Related Articles

View Entities - This section covers the creation of a View Entity. This is used to generate a read-only entity by stringing together fields similar to reports but they can be associated with other standard entities via lookups and as parent objects.

Have more questions? Submit a request

Comments

Powered by Zendesk