Associations

Administrators can define associations across custom modules. After an association is configured, technicians can associate records between the associated custom modules.

Associations can be defined only across custom modules in published states.

Role Required: SDAdmin

Create New Association

Go to Admin > Customization > Associations.
In the filter drop-downs, select an active custom module.
Click New.
The form displayed contains 2 tabs, fill out the details using the pointers below.

Configuration Tab:

Field	Description
Source Module	The source module refers to the custom module from where the association can be configured. The custom module selected in the filter drop-down is auto-selected in this field.
Association Type	Define the nature of association by an association and inverse association type. Learn how to create an association type.
Associated Module	Select the custom module to which the source module is associated with.
Cardinality	Define the numerical relationship between the records in source and association modules: One to One - One source module entity can be associated with one associated module entity. One to Many - One source module entity can be associated with multiple associated module entities. Many to One - One source module entity can be associated with multiple associated module entities. Many to Many - Multiple source module entities can be associated with multiple associated module entities.
Display Name in Source Module	Provide an association title to be displayed in the source module.
Source Module API Name & Source Module API Plural Name	Specify the API names for the source module in snake_case. By default, source module API names are prefixed with assoc_. API names cannot be edited.
Field to filter list view in Source Module	Users can filter the associations listed in the source module based on the selected fields. You can select the following fields to filter associations: Created by field Pick list additional fields with reference entities configured
Filter criteria in Source Module	You can choose to predefine conditions to filter the association module records displayed in the source module. Select the column, criteria, and enter the value. Click to add multiple conditions.
Display Name in Associated Module	Provide an association title to be displayed in the associated module.
Associated Module API Name & Source Module API Plural Name	Specify the API names for the associated module in snake_case. By default, source module API names are prefixed with assoc_. API names cannot be edited.
Field to filter list view in Associated Module	Users can filter the associations listed in the associated module based on the selected fields. You can select the following fields to filter associations: Created by field Pick list additional fields with reference entities configured
Filter criteria in Associated Module	You can choose to predefine conditions to filter the source module records displayed in the associated module. Select the column, criteria, and enter the value. Click to add multiple conditions.

Click Save. You will be redirected to the Additional Fields tab.

Additional Fields Tab:

Click New Field to configure additional fields to collect details about the association properties.

You can use or to edit or delete additional fields.

You can configure the following additional field types:

Field Type	Purpose	Configuration
Single line	Enter brief text or phrases	Enter a unique field name and API name. Describe the field purpose or usage. Set a default value to be populated in the field. Specify the character length for the field. You can choose to restrict the field to contain only numbers.
Multi line	Enter detailed text or comments	Enter a unique field name and API name. Describe the field purpose or usage. Set a default value to be populated in the field.
Pick list	Select an option from the list	Enter a unique field name and API name. Describe the field purpose or usage. You can select a reference entity to retrieve values from other configurations. You can add criteria to filter the values listed. Alternatively, you can also manually enter the pick list values.
Numeric	Enter numerical values	Enter a unique field name and API name. Describe the field purpose or usage. Set a default value to be populated in the field. Specify the character length for the field.
Decimal	Enter a decimal value	Enter a unique field name and API name. Describe the field purpose or usage. Set a default value to be populated in the field. Specify the number of decimal places allowed in the input.
Boolean types	Specify yes or no decisions	Enter a unique field name and API name. Describe the field purpose or usage. Set a default value to be populated in the field. You can choose to have the field selected by default.
Date	Specify date and day	Enter a unique field name and API name. Describe the field purpose or usage. Set a default value to be populated in the field. You can choose to have the field selected by default.
Date/Time	Specify the date, day, and time	Enter a unique field name and API name. You can specify if the field contains personally identifiable information (PII). Describe the field purpose or usage. Set a default value to be populated in the field. You can choose to set the current date in the field by default.
File Upload	Upload files to the additional field	Enter a unique field name and API name. Describe the field purpose or usage. Files can be uploaded based on Attachment Settings.
Color	Choose a color from the color picker
Percentage	Specify a percentage in numbers
Phone	Enter phone numbers	Enter a unique field name and API name. You can specify if the field contains personally identifiable information (PII). Encrypt the field to store users' confidential information securely in the database. Describe the field purpose or usage.
URL	Enter hyperlinks	Enter a unique field name and API name. Describe the field purpose or usage.
Email	Enter email addresses	Enter a unique field name and API name. You can specify if the field contains personally identifiable information (PII). Encrypt the field to store users' confidential information securely in the database. Describe the field purpose or usage.

List View Operations

Use the filter drop-down to view associations created based on their active status or the source custom module.

Click to update association details. API names cannot be edited.
Select the associations and click to remove the association.

If the custom module configured in the association is deleted, the association will be moved to inactive status.