Mythradon Entity Types¶
This document describes the pre-built functionality provided by each of the various Entity Types that can be created using the Mythradon Entity Manager.
Note: Once you create an Entity and have defined the 'Entity Type' you are unable to change it. Your options would be to either remove the entity and start defining it again (Any data that you had in this entity would be lost if your took this option) or manually adding the additional functionality that is required.
The Entity Manager supports the following entity types:
| Entity Type | Description |
|---|---|
| Base | Base is the most basic entity type. Automatically creates basic system fields like Name, Assigned User, Teams, Description. |
| Base Plus | Similar to the Base entity type with additional Activities, History, Tasks panels. |
| Event | Designed for support event that can be displayed in the Mythradon Calendar. Automatically creates Start Date, End Date, Duration, Parent, Status fields. |
| Person | Designed specifically for storing details on People. Automatically creates Email, Phone, First Name, Last Name, Salutation, Address fields; Activities, History, Tasks panels. |
| Company | Designed specifically for storing details on Companies/Businesses. Automatically creates Email, Phone, Billing Address, Shipping Address fields; Activities, History, Tasks panels. |
All entity types support the enablement of Streams.
Here are additional details and examples demonstrating the usage of various Entity Types.
Base¶
The Base entity type is the most simple entity type.
After creating a new Base entity the default Detail view for creating a new record will look as follows:
System Fields¶
This will provide the following system fields on the entity:
| Label | Field Name | Data Type | Description |
|---|---|---|---|
| Assigned User | assignedUser | Link (User) | A link to the User that is assigned ownership of the record. By default this will be the current User who created the record. |
| Created At | createdAt | Date-Time | Date/time stamp when the record was created. |
| Created By | createdBy | Link (User) | A link to the User record that created the record. |
| Description | description | Text | General description field. |
| Modified At | modifiedAt | Date-Time | Date/time stamp when the record was last modified. |
| Modified By | modifiedBy | Link (User) | A link to the User record that last modified the record. |
| Name | name | Varchar(255) | General purpose name field. This will be a required field that is used to identify the record. |
| Teams | teams | Link Multiple (Teams) | Links to multiple Teams that have access to the record. |
Base Plus¶
The Base Plus entity type provides the same functionality as the Base entity type with additional relationships to Activities, History and Task panels.
After creating a new Base Plus entity the default Detail view for creating a new record will look as follows:
System Fields¶
This will provide the following system fields on the entity:
| Label | Field Name | Data Type | Description |
|---|---|---|---|
| Assigned User | assignedUser | Link (User) | A link to the User that is assigned ownership of the record. By default this will be the current User who created the record. |
| Created At | createdAt | Date-Time | Date/time stamp when the record was created. |
| Created By | createdBy | Link (User) | A link to the User record that created the record. |
| Description | description | Text | General description field. |
| Modified At | modifiedAt | Date-Time | Date/time stamp when the record was last modified. |
| Modified By | modifiedBy | Link (User) | A link to the User record that last modified the record. |
| Name | name | Varchar(255) | General purpose name field. This will be a required field that is used to identify the record. |
| Teams | teams | Link Multiple (Teams) | Links to multiple Teams that have access to the record. |
Relationships¶
| Foreign Entity | Link Type | Label | Foreign Entity Label |
|---|---|---|---|
| Parent-to-Children | Parent | Emails | |
| Task | Parent-to-Children | Parent | Tasks |
Event¶
The Event entity type provides special functionality that allows the records to act as calendar events or activities with a start and end date/time. Records created in Event type entities can be displayed in the Mythradon Calendar.
To display new Event entities in the calendar you need to enable the entity in the calendar settings.
After creating a new Event entity the default Detail view for creating a new record will look as follows:
System Fields¶
This will provide the following system fields on the entity:
| Label | Field Name | Data Type | Description |
|---|---|---|---|
| Assigned User | assignedUser | Link (User) | A link to the User that is assigned ownership of the record. By default this will be the current User who created the record. |
| Created At | createdAt | Date-Time | Date/time stamp when the record was created. |
| Created By | createdBy | Link (User) | A link to the User record that created the record. |
| Date End | dateEnd | Date/Date-Time | End date of the event. Has a date with an optional time. |
| Date End (all day) | dateEndDate | Date | End date of the event without an optional time. Used for all-day events. |
| Date Start | dateStart | Date/Date-Time | Start date of the event. Has a date with an optional time. |
| Date Start (all day) | dateStartDate | Date | Start date of the event without an optional time. Used for all-day events. |
| Description | description | Text | General description field. |
| Duration | duration | Duration | Duration of the event. Displays values such as: 5m, 30m, 1h. |
| Is All-Day | isAllDay | Boolean | Flag controls if the Event is an all-day event. |
| Modified At | modifiedAt | Date-Time | Date/time stamp when the record was last modified. |
| Modified By | modifiedBy | Link (User) | A link to the User record that last modified the record. |
| Name | name | Varchar(255) | General purpose name field. This will be a required field that is used to identify the record. |
| Parent | parent | Link Parent | Parent entity of the Event. By default this will have the values Account, Contact, and Lead however other entities can be added. |
| Reminders | reminders | Json Array | Array of reminders that can be set on the Event. |
| Status | status | Enum | Status of the Event. Default options are:
|
| Teams | teams | Link Multiple (Teams) | Links to multiple Teams that have access to the record. |
Relationships¶
| Foreign Entity | Link Type | Label | Parent Entity Types |
|---|---|---|---|
| Children-to-Parent | Parent |
|
Person¶
The Person entity type provides special functionality for storing the common details of a Person such as their Name, Address and Contact details. It also provides pre-built relationships to Activities, History and Task panels.
After creating a new Person entity the default Detail view for creating a new record will look as follows:
System Fields¶
This will provide the following system fields on the entity:
| Label | Field Name | Data Type | Description |
|---|---|---|---|
| Address | address | Address | Address field set. |
| City | addressCity | Varchar(255) | Address City/Suburb field. |
| Country | addressCountry | Varchar(255) | Address Country field. |
| Map | addressMap | Map | Address Map field. |
| Postal Code | addressPostalCode | Varchar(40) | Address Postal Code field. |
| County | addressState | Varchar(255) | Address County/State field. |
| Street | addressStreet | Text | Address Street field. |
| Assigned User | assignedUser | Link (User) | A link to the User that is assigned ownership of the record. By default this will be the current User who created the record. |
| Created At | createdAt | Date-Time | Date/time stamp when the record was created. |
| Created By | createdBy | Link (User) | A link to the User record that created the record. |
| Description | description | Text | General description field. |
| emailAddress | Email Address field. Supports the entry of a set of addresses. | ||
| Email Address is Invalid | emailAddressIsInvalid | Boolean | Flag used to identify that the email address is considered invalid. |
| Email Address is Opted-Out | emailAddressIsOptedOut | Boolean | Controls if the Email Address field is opted-out of marketing campaigns. |
| First Name | firstName | Varchar(100) | Person's First Name field. |
| Last Name | lastName | Varchar(100) | Person's Last Name field. |
| Middle Name | middleName | Varchar(100) | Person's Middle Name field. |
| Modified At | modifiedAt | Date-Time | Date/time stamp when the record was last modified. |
| Modified By | modifiedBy | Link (User) | A link to the User record that last modified the record. |
| Name | name | Person Name | Person's full name field. |
| Phone | phoneNumber | Phone | Phone Number field. Supports the entry of multiple phone numbers. |
| Phone Number is Invalid | phoneNumberIsInvalid | Boolean | Flag used to identify that the phone number is considered invalid. |
| Phone Number is Opted-Out | phoneNumberIsOptedOut | Boolean | Flag used to control the opted-in/out status of the Phone Number from marketing campaigns. |
| Salutation | salutation | Enum | Person's Salutation field. Default options are:
|
| Teams | teams | Link Multiple (Teams) | Links to multiple Teams that have access to the record. |
Relationships¶
| Foreign Entity | Link Type | Label | Foreign Entity Label |
|---|---|---|---|
| Tasks | Parent-to-Children | Parent | Tasks |
Company¶
The Company entity type provides special functionality for storing the common details of a Company/Business such as their Name, Address and Contact details. It also provides pre-built relationships to Activities, History and Task panels.
After creating a new Company entity the default Detail view for creating a new record will look as follows:
System Fields¶
This will provide the following system fields on the entity:
| Label | Field Name | Data Type | Description |
|---|---|---|---|
| Assigned User | assignedUser | Link (User) | A link to the User that is assigned ownership of the record. By default this will be the current User who created the record. |
| Billing Address | billingAddress | Address | Billing Address field set. |
| City | billingAddressCity | Varchar(255) | Billing Address City/Suburb field. |
| Country | billingAddressCountry | Varchar(255) | Billing Address Country field. |
| Map | billingAddressMap | Map | Billing Address Map field. |
| Postal Code | billingAddressPostalCode | Varchar(40) | Billing Address Postal Code field. |
| County | billingAddressState | Varchar(255) | Billing Address County/State field. |
| Street | billingAddressStreet | Text | Billing Address Street field. |
| Created At | createdAt | Date-Time | Date/time stamp when the record was created. |
| Created By | createdBy | Link (User) | A link to the User record that created the record. |
| Description | description | Text | General description field. |
| emailAddress | Email Address field. Supports the entry of a set of addresses. | ||
| Email Address is Invalid | emailAddressIsInvalid | Boolean | Flag used to identify that the email address is considered invalid. |
| Email Address is Opted-Out | emailAddressIsOptedOut | Boolean | Controls if the Email Address field is opted-out of marketing campaigns. |
| Modified At | modifiedAt | Date-Time | Date/time stamp when the record was last modified. |
| Modified By | modifiedBy | Link (User) | A link to the User record that last modified the record. |
| Name | name | Person Name | Company/business name. |
| Phone | phoneNumber | Phone | Phone Number field. Supports the entry of multiple phone numbers. |
| Phone Number is Invalid | phoneNumberIsInvalid | Boolean | Flag used to identify that the phone number is considered invalid. |
| Phone Number is Opted-Out | phoneNumberIsOptedOut | Boolean | Flag used to control the opted-in/out status of the Phone Number from marketing campaigns. |
| Shipping Address | shippingAddress | Address | Shipping Address field set. |
| City (Shipping) | shippingAddressCity | Varchar(255) | Shipping Address City/Suburb field. |
| Country (Shipping) | shippingAddressCountry | Varchar(255) | Shipping Address Country field. |
| Map (Shipping) | shippingAddressMap | Map | Shipping Address Map field. |
| Postal Code (Shipping) | shippingAddressPostalCode | Varchar(40) | Shipping Address Postal Code field. |
| County (Shipping) | shippingAddressState | Varchar(255) | Shipping Address County/State field. |
| Street (Shipping) | shippingAddressStreet | Text | Shipping Address Street field. |
| Teams | teams | Link Multiple (Teams) | Links to multiple Teams that have access to the record. |
| Website | website | Url | Company Website Address field. |
Relationships¶
| Foreign Entity | Link Type | Label | Foreign Entity Label |
|---|---|---|---|
| Tasks | Parent-to-Children | Parent | Tasks |
See also¶
- Mythradon Basics
- Mythradon Marketing
- Mythradon Sales
- Mythradon Service
- Mythradon System Administration
- Mythradon Tools