Last Revised: Written by Veloxity CRM Time Estimate: About 10 minutes to read. Version 2.0
Contents
- What are Attributes in Data Designer?
- Where can I find Data Designer Attributes?
- How can I use Attributes in Data Designer?
- Data Type Name
- Display Name
- Plural Display Name
- Description
- Icon for Data Type
- Owner Assignment Type
- Default Creator Ownership
- Show on Add Menu
- Enable on Main Menu
- Prompt for Number to Add
- High Volume Data Type
- Extension Data Type
- Hide Data Records
- Enforce Single Parent
- Record Image Assignable
- Record Image Manually Assignable
- Record Assignable
- Attachment Data Type
- Valid File Extensions
- Is Restricted (SaaS Only)
- Is Removable (SaaS Only)
- Related articles
What are Attributes in Data Designer?
Definition
Attributes refer to the qualities and characteristics of a data type.
When editing data types several attributes of the data can be defined.
How can I use Attributes in Data Designer?
Configure the data type Attributes to reflect the following:
- How does the data type appear in application menus?
- What features does the end-user see when using this data type?
Where can I find Data Designer Attributes?
Data Type Attributes configuration is found in Data Designer in Veloxity App Setup.
From the Main Menu, click My Profile > App Setup > Data Designer > Attributes
Navigating Attributes in Data Designer
You are looking at a screenshot of Navigating Attributes in Data Designer:
Figure 1. Navigating Attributes in Data Designer.
How can I use Attributes in Data Designer?
Attributes | How to Use |
---|---|
Data Type Name |
What name will Plugins and APIs use to access this data type? The Data Type Name is the internal name. Plugins and APIs use this name to access records of this type. The Data Type Name is used for reference in the code. The Data Type Name must adhere to the following rules:
For example, the following is the Data Type Name for the Data Type - Contact:
|
Display Name |
What name will users employ to access this data type? The Display Name is the data type Name displayed visually on the user interface. The Display Name is what the user sees when using this data type. For example, the following is the Display Name for the Data Type - Contact:
|
Plural Display Name |
What name will be utilized by users when there are multiples of this data type? The Plural Display Name is the name displayed visually on the user interface when there are multiples of this data type. For example, the following is the Plural Display Name for the Data Type - Contact:
|
Description |
How would you describe this data type for internal reference? What will others accessing this data type through Data Designer need to know? A detailed description of the data type. This description only appears in Data Designer and is not shown in other areas of Veloxity. |
Icon for Data Type |
What Icon visually represents this data type to users? Carefully selecting the icon is important. The icon becomes a visual language users associate with the data type. You are looking at a screenshot of Configuring an Icon for a data type:
Figure 2. Configuring an Icon for a Data Type. |
Owner Assignment Type |
How many users can share ownership of a data record of this data type? Owner Assignment Type defines the number of users who can share ownership of individual data records of this data type. Select from the following:
What does it mean to be a record owner? Data Type Access Privileges for Record Owners are configured in Group Manager. |
Default Creator Ownership |
Is the record creator the default Owner? Default Creator Ownership defines whether the creator of the data record is the default Record Owner. Ownership is further configured in CRM Setup under Owner Assignment Rules. |
Show on Add Menu |
Do you want users manually adding records of this data type outside of a controlled process? In most cases, you do not want to enable Show on Add Menu. In typical implementations for most data types, this feature will not be enabled because records are usually added via other mechanisms. Show on Add Menu enables this data type to appear on areas in the system where you are adding records. Show on Add Menu will give users the ability to add new records to the system. Be aware that new records added in this way will be added to the ether because the system does not know the parent record. While you cannot access records in ether through a hierarchy, the records are accessible through search. Creating a relationship removes the record from the ether. As an example, using Show on Add Menu, a user could add a new record to the system using Linked Records:
Figure 3. Data Type Shown on Linked Records.You may want to enable Prompt for Number to Add in addition to Show on Add Menu if you want to make it easy for users to add many data records in one step. |
Enable on Main Menu |
Do you want users to access this data type from the Main Menu? Enable on Main Menu determines whether this data type gets its own menu item on Veloxity's Main Menu. If granted the ability, a user can add records (without a parent record) and can also directly run saved searches for a record. By default, a “List All” search is shown here for the data type on the menu. This is a two-step process, after selecting Enable on Main Menu, ensure that the users will see the menu item by adding it to their group’s permissions in the Toolbar Designer. When the data type is enabled on the Main Menu, users have access to system created functions associated with this new item:
Using Show on Add Menu, a user could add a new record to the system via the Main Menu +Add option:
Figure 4. Data Type Shown on Main Menu. |
Prompt for Number to Add |
Do you want users to be able to add multiple records of this data type in one step? If Show on Add Menu is selected, you can enable users to add multiple records of the data type in one step. When this function is enabled, and the end-user chooses to add a data record of this type to the system, the user will be prompted to select how many records to add. As an example, if the user selects “Add Contact”, the system will ask how many Contacts the user wants to add. Prompt for Number to Add makes it easy for the user to add many data records in one step if this is a common task. If this option is not enabled, the system will create a single instance of the data type. You may also be interested in reviewing Data Import in CRM Setup for information on quickly importing data records into the system. |
High Volume Data Type |
Will this data type be comprised of millions or billions of data records? Extremely large numbers of records for a given data type can slow down the server and negatively impact the performance of the data type. Marking a data type as a high-volume data type enables Veloxity to treat records of this type differently. This helps to mitigate performance penalties that would normally be caused by the extreme scale of these records. A high-volume data type has certain restrictions not applicable to other data types:
|
Extension Data Type |
Does this data type extend another data type? In some instances, it is useful to extend the Attributes of a data type with another data type. An Extension Data Type is further metadata on another parent type. The fields of the Extension Data Type are only viewed when they have data because it would look like a lot of blank fields on the record views and tables.
|
Hide Data Records |
Do you want to hide this data type and all the corresponding data records from users? Hide Data Records to remove the data type from user view. General system users will not be able to view or interact with this data type. The data type will only be visible to a user in the Data Designer and through the API. |
Enforce Single Parent |
Do you want to only allow one parent record for this data type? Veloxity CRM supports a data type definition where a single type can have numerous valid parent data types. Enforce Single Parent overrides this definition. Enforce Single Parent means records of this data type can be under only one parent record of any of their valid parent types. In addition, many to many relations are not supported for this data type when Enforce Single Parent is enabled. |
Record Image Assignable |
Do you want to enable images to be added to records of this data type? Record Image Assignable enables adding an image to records of this data type.
|
Record Image Manually Assignable |
If images are enabled, do you want to allow users to add their own images? Allows the user to add an image to records of this data type. |
Record Assignable |
Do you want to allow child data types of this record to be moved? Determines if records of applicable child types can be moved/assigned under this type. |
Attachment Data Type |
Do you want to allow file attachments to this data type? An Attachment Data Type allows file data to be associated with this data type. Attachment Data Types require specific extra fields. By enabling Attachment Data Types, the data type is automatically populated with these extra fields. Attachments are unique within Veloxity CRM in that for each record there is an associated document attachment. Therefore, two parts exist to the data type record:
When creating an Attachment Data Type, you can specify what types of file extensions are valid for this data type. |
Valid File Extensions |
If file attachments are enabled for this data type, do you want to restrict the attachments to specific file extensions? When a data type is an Attachment Data Type, you can specify a restricted set of file extensions. For example, to designate an attachment of a new data type as only a .doc or .docx, list the extensions as the only types supported for this Attachment Data Type in the text box.
|
Is Restricted (SaaS Only) |
Is this data type restricted? When a data type is restricted, relationships with other restricted data types cannot be added or removed. The default layout for restricted data types are also not modifiable, but new layouts can be added. |
Is Removable (SaaS Only) |
Is this data type removable? Determines if this data type can be removed by users in SaaS applications. |
Related articles