Switch

The switch control offers users a simple yet powerful way to toggle between two states, providing intuitive control over binary options within forms. Whether rendered as "Active" and "Default" or "Yes" and "No," this versatile control enhances user experience by streamlining data entry and decision-making processes.

A quick glance at Switch Control on Form Designer for an Application Designer.

Upon configuring the Switch control, following figure is a view on Main Form for End User or Analyst.

Let's explore the following Use Case:

Configure Switch

Configuring Switch comprises various settings such as Properties, Advance, Validations, Appearance, and Security. Along with information such as how it should render, like helpful information message and a tooltip on the usage of configured Switch.

To configure Switch control, perform the following steps:

1. Navigate to Form Designer > Design Form > Controls.
   

2. Expand Form Controls to locate the Switch control.
   

3. Drag and drop Switch control on the design canvas. Hover over the added control to access the Settings and Delete icon.
   The Switch control is displayed:

   

   Figure: Switch

   Icon	Description
   	Settings icon will enable the Application Designer to configure the Switch Control in the Main Form.
   	Delete icon will delete the Switch control from the Main Form.
   	Controls for adjusting the size of Switch on Canvas.

4.  Click Settings icon to configure the Switch control.
   On the Settings pop-up window, the following tabs can be configured.

   • Properties

   • Advance

   • Validations

   • Appearance

   • Security

Properties

Following are the 'General Properties' for the Switch control, followed by specific details about each field.

Figure: Switch - Properties

Field Description

This table contains the list of fields and their descriptions that are available under the Properties tab:

Field	Description
General
Title*	Enter an unique name for the Switch control. This name is identified in the configured Main Form. Example: Major Incident, Terms and Conditions, etc.
Subtitle	Enter the text which 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.
Render as*	Select from the drop-down to determine the behavior of the control. You can render the Switch as Active, Default and Switch. Active When the switch is in the "On" or "Active" position, it indicates that a certain setting, feature, or option is enabled or activated. Conversely, when the switch is in the "Off" or "Inactive" position, it indicates that the setting, feature, or option is disabled or deactivated. Example: In the Incident module of the Service Management application, the Priority form allow administrators to customize the priority levels available for tasks within the module. The added priority values can be made active of inactive by enabling the respective active switch. Figure: Render as Active Switch Notes On a form we can only include One Active switch. Only active values will be displayed for selection when referred to as Data Source in transaction forms. Default A Default Switch is a user interface control element that represents the default state of a setting, feature, or option, providing users with a clear indication of the initial configuration while still allowing them to make changes as needed. Example: In the Incident module of the Service Management application, in the Priority form, you have the option to mark a specific priority value as the Default. The Default Priority is the initial Priority level assigned to tasks when they are created, however the consumer can Switch to other value. Figure: Render as Default Switch Note Only One Default Switch can be added. Switch Applicable in scenarios where users are required to make mutually exclusive decisions, such as choosing between 'Yes' or 'No' options, or selecting between 'Option 1' and 'Option 2'. Figure: Render As Switch
Informative
Help Text	Provide a Help Text that gives the end users guidance on how to fulfill the purpose. Example: Hotline Numbers, Bridge Details etc. Upon providing details in the Help Text configuration, an information icon is displayed on the right side of the configured switch when used on the Main Form. When hovered upon the information icon, the Help Text information is displayed. Figure: Help Text
Rich Text	Select it to enable the Help Text as a Rich Text format. It allows formatting like Bold, Italicized, Font Color to the text, etc. By default, Plain Text field is displayed. To convert this to a Rich Text Editor, enable the switch control for Rich Text. Figure: Rich Text Editor
Tooltip	Add a Tooltip that is displayed when the user hovers the cursor over the Switch control. Figure: Tooltip

Advance

Use switch in flexible ways on the Main Form  such as to include as Filter, as a column in grid view and to have it clickable, on the Advance properties of Switch Configuration.

Figure: Advance Properties

Field Description

This table contains the list of fields and their descriptions that are available under the Advance tab:

Validations

Validations ensure that the Switch meets specific criteria or requirements. Application Designer can add pre-built validations to save time and effort by ensuring accuracy and completeness without the need for custom rules. These offer a standardized method of Switch validation across forms, reducing errors and improving data reliability.

To configure Switch Validations, perform the following steps:

1. Click Validations and select Tenant from the dropdown.
   Validation configuration is displayed.

   

   Figure: Switch Validation
   

2.  Select the any of the following value for Validation.

   • Mandatory: Select Mandatory from the drop-down to make the control a mandatory control. It ensures that this field must be enabled before submitting the form. 

   • Disabled: Select Disabled from the drop-down to make the control as non-functional, it will be greyed out and user cannot act upon this control.

     Mandatory Validation	Disabled Validation

3. Upon selecting either Mandatory or Disabled, the following options to execute the validation is displayed.

   • Every Time: Select Every Time if you want to display this control always without any specific conditions.

   • Below Condition Meet: Select Below Condition Meet if you want the validations on the control to be triggered based on a specific condition(s).

     

   
   Multiple Validations can be added using Add icon or the existing validation can be deleted from using Delete icon.

   Field	Description
   	Click Add icon to include more Conditions. If multiple conditions are added then, it will by default consider 'AND' operator to execute the Validation.
   	Click Delete icon to delete the condition from the configuration.

Appearance

This tab helps you to customize the Switch's appearance through appearance properties, enhancing user experience and reinforcing brand identity.

 Click Appearance on the configuration screen for the settings to be displayed.

Field Description

This table contains the list of fields and their descriptions that are available under the Appearance tab.

Refer to the following table for the field description: 

Security

The Security tab ensures data security and privacy by applying restricted access or encryption to the Switch, ensuring that only users with authorized roles can access it.

Click Security on the configuration screen for the settings to be displayed.

Field Description

This table contains the list of fields and their descriptions that are available under the Security tab:

Refer to the following table for field description: