Relationship
  • 23 Oct 2024
  • 7 Minutes to read
  • PDF

Relationship

  • PDF

Article summary

Relationship Control help to create association between various records. This feature is useful to link records from the same form or another form in the same module or forms from an entirely different module. These relationships can be established as peers or as parent-child. 

Let's explore the following use-case.

Use Case

User Persona: Application Designer

Solution
NovaTech's end users have reported multiple incidents of system failure. The end user raises an incident in the ITSM application for its resolution.  

To resolve this, Sam configures the Relationship action in the Form Designer Advance controls. The IT support team that analyses the issue determines that the incident requires specialized services (Service request) or deeper investigation (Problem management). The link and create utility in the relationship is thus utilized by the team to link multiple incidents into a parent-child relationship and simultaneously map relevant information from the Incident.

Configure Relationship Control

To configure the Relationship control, perform the following steps.

1. Navigate to Form Designer > New Form.

2. Enter the appropriate details in the required fields.

3. Click Next.

4. Click Advance.

5. Drag and drop Relationship onto the designer page. The following page is displayed. 

Figure: Relationship control

6. Click the setting icon to configure the Relationship control. The following window is displayed. 

For more information on the fields, refer to the table below.

The following tabs have fields related to the basic configuration of the Relationship control.  

  • Properties - All the mandatory generic properties of the Relationship control is defined here. 
  • Appearance - We can customize the appearance of the control using this property. 
  • Links - We can configure the form to provide links to different modules and application. 
  • Create - We can configure the form to create records. 

Properties

This section contains the list of generic properties using which the user can configure the Relationship Control.  For more information refer to the table below. 

FieldDescription
TitleSpecify the unique name for the Relationship feature. This name identifies the Relationship control in the form. 
Subtitle This is the text that you want to display just beneath the Title. You may use it to describe the purpose of the control or the way it should be used. 
InfoSpecify the additional information related to the feature. 
TooltipA tooltip is a small pop-up message explaining a field when hovered over. 
Include LabelThis is the name displayed in the consumer facing screen. 

Appearance

Customize controls appearance by aligning brand colors through appearance properties, enhancing user experience, reinforcing brand identity. For more information refer to the table below.

Figure: Appearance

FieldDescription
ClassEnter a class name for the section. This is a unique name for the action. 
IconChoose an icon from the selection provided in the Select the Icon option and upload it This icon will represent the form group. If no icon is selected and uploaded, the form group will appear with the default icon. 
Icon PositionSpecify whether the icon should be displayed to the left or right of the label. 

Links provide an option to select a data source and configure relationships. For more information refer to the table below. 

Figure: Links 

If Data Source is selected as API, the following fields need to be configured as per the screen below. 

Figure: Links - API

FieldDescription
Data SourceWhen the Data Source is API, the following fields need to be updated. 
OriginChoose the origin of the data source which needs to be configured using API. For example, Cross origin, Same origin etc. 
TypeSelect the Type of the source for the API. For example, GET, PUT, POST etc. 
AddressEnter the specific API URL for the data source. 
ParametersChoose the parameters specific to the API. 
Label FieldEnter a name for the Label Field. 
Value FieldEnter a name for the Value Field. 

If Data Source is selected as Table, the following fields need to be configured. 

Figure: Links

For more information, refer to the table below. 

Data Source

FieldDescription
ApplicationSelect the target application for linking the current form. For example, Service Management, Asset Management etc. 
ModuleChoose the target module for linking the current form. All active modules under the selected application will be displayed. For example, if Service Management is chosen, options like Incident, Service Request, Change, Problem, Knowledge, and Call will be displayed
FormSelect the target form to which you want to link the current form. All the published main forms applicable to the current form's role type under the selected module will be shown. 
Relationship TypeSpecify the Form Relationship established between the source form and target form to be created.
Note: There is an option to create a new Form Relationship if the dropdown does not have the required options.
Alias NameChoose an Alias name for the established relationship to be displayed in the consumer view.
An icon to drag up or down for reordering the row.
Icon to add more links with additional rows.
Add ConditionEnable the button to set the conditions. Click Add Filter Set and the following page is displayed.

For more information refer conditions.
Add Filter SetSpecify the conditions required for this criterion by defining the following.
FieldAll the fields from the main form are displayed upon expanding the Fields dropdown.
OperatorSelect the operator based on the selected field. For example, if the field selected is a single choice, radio button, or tree control, operators like 'is, 'is not', 'is one of' etc is displayed.
ValueSelect and enter a value based on the selected field type. The value fields will match the control type of the chosen field. For example, if the selected field is single choice control, the value would be represented as a dropdown control.

Validation on Peer Records

The act of confirming the veracity and accuracy of material supplied by peer-reviewed sources or other authoritative references in hyperlinks embedded within a document, webpage, or database is known as validation of peer records.

Figure: Validation on Peer Records

For more information, refer to the table below. 


FieldDescription
Source RecordThe reference data or original data entered as basis for verifying the accuracy and integrity of other records. 
I should not be able to set
Add Filter SetSpecify the conditions required for this criterion by defining the following.
FieldAll the fields from the main form are displayed upon expanding the Fields dropdown.
OperatorSelect the operator based on the selected field. For example, if the field selected is a single choice, radio button, or tree control, operators like 'is, 'is not', 'is one of' etc is displayed.
ValueSelect and enter a value based on the selected field type. The value fields will match the control type of the chosen field. For example, if the selected field is single choice control, the value would be represented as a dropdown control.
Linked RecordsThe details of the linked records are displayed. 
ApplicationSelect the target application for linking the source form for peer records. For example, options could include Service Management, Asset Management, or Customer Relationship Management.
ModuleChoose the target module for linking the source form for peer records. All active modules under the selected application will be listed. For example, if Service Management is chosen, options like Incident, Service Request, Change, Problem, Knowledge, and Call will be displayed.
Form Select the target form to which you want to link the current form to the source form for peer records. All published main forms applicable to the current form's role type under the selected module will be shown.

Validation on Child Records

The process of ensuring the accuracy and validity of data entries associated with subordinate or related entries within a database or system to meet specified criteria or constraints is called validation of child records. 

Figure: Validation on Child Records

FieldDescription
Allow Edit of Child RecordsThis option can be enabled to grant permission for editing child records. We can select Yes to allow editing and No to restrict editing access. 
Update PreferenceThis option allows to choose All field values or only blank field values. All field values can be chosen to update all the existing field values and Only Blanks will allow update for only the blank fields in the child record. 
Exception FieldsSpecify the fields that will remain unaffected by changes to the parent record. These fields will retain their original value and can be manually edited. Once configured, the following pop up is displayed while configuring child incidents. The fields can be selected to be updated. 

Create

The create tab allows to create new records from an existing record. It can be in the same module or different module or an entirely different application. 

Figure: Create

For more information, refer to the table below. 

FieldDescription
ApplicationSelect the target application for creating the current form. For example, options could include Service Management, Asset Management, or Customer Relationship Management.
ModuleChoose the target module for creating the current form. All active modules under the selected application will be listed. For example, if Service Management is chosen, options like Incident, Service Request, Change, Problem, Knowledge, and Call will be displayed.
FormSelect the target form to which you want to create the current form. All published main forms applicable to the current form's role type under the selected module will be shown. For example, if the conversion utility is being configured on the Manage Incident form published to the Fulfiller persona, selecting the Service Request module will display the Manage Service Request form published to the Fulfiller persona.
Relationship TypeSpecify the Form Relationship established between the source form and target form to be created.

Choose a list of previously created form relations between the source and target forms. If no active form relation exists, the application designer can click on the +Add Relation button to create a new one. Once a new Relation is created, App designer can come back to the current configuration screen, click on the refresh button to load the newly created relation. 

Alias NameOptionally provide an alias name for the create action. This user-friendly name can be easily understood by end-users. If no alias name is given, the form name will be displayed.




Was this article helpful?

What's Next
Changing your password will log you out immediately. Use the new password to log back in.
First name must have atleast 2 characters. Numbers and special characters are not allowed.
Last name must have atleast 1 characters. Numbers and special characters are not allowed.
Enter a valid email
Enter a valid password
Your profile has been successfully updated.