Step 1: Create the Customers Entity
Last updated
Last updated
The first step is to create the Entity for storing customer account records.
To go to the Entity database section, click “Entity database” under the “Database” menu on the left side panel.
To create a new entity, click the [+ Entity] button on the displayed page.
The New Entity settings page is displayed. To label the entity, enter the Entity name as “UserName_Acc_customers”.
Optionally add a description.
The Field tab is preselected with one field created by default. To add a field, click the [+ Field] button.
To store customer details in the Entity “Username_Acc_customers”, add and define corresponding fields following the steps below.
To define a field storing the primary key for this entity, define the field for Customer ID as follows. (The relation of this Entity with the Activities Entity will also be established through this field.)
Enter the field name as “Customer_ID”.
Select Data Type as “GUID”.
Select “Primary Key”. This field will contain the primary key for this entity.
Select “Auto Generate”. This value of this field will be auto-generated with each new record.
Select “Display”. This field will be displayed in the entity.
Add another field.
To store the customer’s first name, define the field as follows:
Enter field name as “First_Name”.
Select Data Type as “string”.
Select “Default Field”. This is the default field to be displayed.
Select “Display”.
To store the customer’s last name, add and define the field as follows:
Enter field name as “Last_Name”. This contains the customer’s last name.
Select Data Type as “string”.
Select “Display”.
To describe the status for the customer as Active or Inactive, add and define the field as follows:
Enter field name as “IsActive”. This contains information on whether the customer is active or inactive.
Select Data Type as “Boolean”. This field can either be true or false.
By default, this value is set to “false”.
Select “Display".
To store the customer’s phone number, add and define the field as follows:
Enter the field name as “Phone”.
Select Data Type as “string”.
Select “Display”.
To store the customer’s email address, add and define the field as follows:
Enter the field name as “Email”.
Select Data Type as “string”.
Select “Display”.
To store the customer’s joining date, add and define the field as follows:
Enter the field name as “Join_Date”.
Select Data Type as “DateTime”. A template of the date and time will be populated as Default Value.
Select “Display”.
To store the customer’s address, add and define the field as follows:
Enter the field name as “Address".
Select Data Type as “string”.
Select “Display”.
To store the customer’s city, add and define the field as follows:
Enter the field name as “City”.
Select Data Type as “string”.
Select “Display”.
To store the customer’s Zip Code, add and define the field as follows:
Enter the field name as “Zip_Code”.
Select Data Type as “string”.
Select “Display”.
To store the customer’s country, add and define the field as follows:
Enter the field name as “Country”.
Select Data Type as “string”.
Select “Display”.
A customer value is the amount of business that a customer provides to a company. This can be measured as the amount of expenditure a customer makes to procure the company's products or services. Create and define the field as follows.
Enter the field name as “Customer_Value”.
Select Data Type as “integer”. Enter Default Value as “1”.
Select “Display”.
A customer rating is the number allotted to a customer reflecting the number to measure the customer loyalty level and is denoted by a range of numbers e.g. 1=Beginner, 2=Average, 3=Top Profile. To store the rating of the customer, create and define the field as follows.
Enter the field name as “Rating”.
Select Data Type as “integer”. Enter Default Value as “1”.
Select “Display”.
To store only day and month of the joining date of the customer, create and define the field as follows:
Enter the field name as “DayMonthJoinDate”.
Select Data Type as “string”.
Select “Display”.
To save the Entity, click the [Save] button.
To close the Entity, click the [Close] button.
To open the created entity, in the list of Entities, click on “Username_Acc_customers”. The list will show the records created if any, and the columns are the fields that are selected with display option.
Additional fields such as Modified Date, Created Date and the Actions column will also be populated for additional information on the record. These dates are when the record was created, updated. The Action column is for any action needed to be taken for entity record such as deletion.
In this exercise, the record is added through the API (to be created in Step 2). However, users can add a record directly into the Entity. ⠀1.To create a record directly in an Entity, click on the created entity in the Entities listing
To create a record directly in an Entity, in the Entities listing, click on the created entity.
Click the [+ Record] button.
In the displayed form, enter the relevant information to be stored as a record.
Click the [Save & Close] button. One record will be updated in the Entity.
To create a record in the Entity through an API, proceed to Step 2 of this exercise.