- 10 Jul 2024
- 3 Minutes to read
- Print
- PDF
Configure Sub Domain
- Updated on 10 Jul 2024
- 3 Minutes to read
- Print
- PDF
A Sub Domain acts as a dedicated space within the domain, allowing for a structured and efficient management of the application. Sub domain is a hierarchical structure within the main domain, that enables a logical and organized separation in the further configuration of components in a Department. Sub Domains configured in a platform provide isolation of the configuration settings, reducing the risk of unintended interference. Changes made within a Sub Domain typically do not affect the configuration of other Sub Domains, enhancing system stability.
The following actions can be performed on a Sub Domain.
Create Sub Domain
You can create a Sub Domain that reflects its hierarchical link to the domain and describes its service. This provides flexibility to configure the Sub Domain at either the global or local level.
To configure a new Sub Domain, perform the following steps:
- Navigate to Settings > Platform Studio > Platform Topology > Sub Domain.
A list of configured Sub Domain is displayed.
Figure: Sub Domain - Click New to create a new Sub Domain.
The Add Sub Domain screenshot is displayed.
Figure: Add Sub Domain - Enter the required details as described in the following table and click Submit.
A successful message 'You have successfully created a Sub Domain' is displayed. Click GO TO LIST to navigate to Sub Domain listing page.Field Description Domain* Select the configured Domain name, the configured domains that include one global domain and all local domains is displayed in the drop-down list. Notes- Upon selecting a Global Domain, the Sub Domain configuration screen will be added with a new form control named Global that is of a switch type. That allows the Super Admin to define the Sub Domain as a global configuration. However, there can exist only one global configuration of a Sub Domain within the global Domain.
Expand to view the configuration screen
Figure: Global Domain Selection - Upon selecting a local domain, the Sub Domain configuration screen will not be changed.
Expand to view the configuration screen
Figure: Local Domain Selection
Sub-Domain* Enter the Sub Domain name, ensuring its uniqueness, as no two Sub Domains can share the same name. The text field for this unique name can accept alphanumeric values. NoteBy default, when configuring a domain, the first Sub Domain will be automatically named the same as the domain.Sub-Domain Description Describe the purpose of the Sub Domain in this text field. Describing the Sub Domain will help you understand its purpose clearly and how to engage with it within the application.
Figure: Sub Domain DescriptionSort Order Use the arrows to set the sort order number for the configured sub domains. The sub domains are displayed on other screens according to their assigned sort order number. NoteThe sort order field starts accepting values from 1. When two or more Sub Domains are configured with the same sort order, they will be alphabetically displayed on the pages.ExampleIf two domains, 'Motors' and 'Operations', share the same sort order value of 1, 'Motors' will precede 'Operations' wherever the Sub Domain field is used in the application.Active The Active switch enables you to activate or deactivate a Sub Domain. By default, the switch is enabled, indicating that the configured Sub Domain is active. NoteThe default value for Active switch is always enabled at the time of configuration, unless the Super Admin disables for any specific reason. - Upon selecting a Global Domain, the Sub Domain configuration screen will be added with a new form control named Global that is of a switch type. That allows the Super Admin to define the Sub Domain as a global configuration. However, there can exist only one global configuration of a Sub Domain within the global Domain.
Edit Sub Domain
After configuring the Sub Domain, you can edit the Sub Domain configurations based on the requirements. This process involves updating the existing configured Sub Domains.
To update a configured Sub Domain, perform the following steps:
- Navigate to Settings > Platform Studio > Platform Topology > Sub Domain.
A list of configured Sub Domains is displayed.
Figure: Sub Domain - Click the ID hyperlink corresponding to the configured Sub Domain and edit the required details.
The Sub Domain Details screenshot is displayed.
Figure: Sub Domain Details - Edit the required details and click Update.
A confirmation message 'You have successfully updated the Sub Domain' is displayed. Click GO TO LIST to navigate to Sub Domain listing page.
Deactivate Sub Domain
To deactivate a configured Sub Domain, perform the following steps:
- Navigate to Settings > Platform Studio > Platform Topology > Domain.
A list of configured Sub Domains is displayed.
Figure: Sub Domain - Click the ID hyperlink to view the details of configured Sub Domain.
The Sub Domain details screenshot is displayed.
Figure: Sub Domain Details - Disable Active control and click Update.
The Sub Domain will be deactivated across the application.
Deactivating a Sub Domain leads to the deactivation of all Departments related to the Sub Domain. When the Sub Domain is deactivated a following message is popped:
Figure: Deactivate Sub Domain