- 10 Jul 2024
- 4 Minutes to read
- Print
- PDF
Configure Domain
- Updated on 10 Jul 2024
- 4 Minutes to read
- Print
- PDF
In the configure Domain you can now perform the following actions. Now that you understand what a domain is, you can start by learning how to configure it. This page guide you through configuring the domain on your instance before proceeding to perform actions such as creating and updating.
The following actions can be performed on a Domain.
Create Domain
Creating a Domain involves selecting a unique Domain name that represents the organization and describes the service that it offers. It also provides the flexibility to configure a Domain at the global or local level.
To configure a new Domain, perform the following steps:
- Navigate to Settings > Platform Studio > Platform Topology > Domain.
The list of configured Domains is displayed.
Figure: Domain - Click New to create a new Domain.
The Add Domain screenshot is displayed.
Figure: Add Domain - Enter the required details as described in the following table and click Submit.
A successful message 'You have successfully created a Domain' is displayed. Click GO TO LIST to navigate to Domain listing page.Field Description Domain* Enter the Domain name, ensuring its uniqueness, as no two Domains can share the same name. The text field for this unique name can accept alphanumeric values.
For Example: If your company goes by the name NovaTech, then you should create a domain with that sane name.Domain Description Describe the purpose of the Domain in this field. It is meant to offer a brief yet thorough explanation of a particular Domain. Describing the Domain will help you understand its purpose clearly and how to engage with it within the application. Sort Order Use the arrows to set the sort order number for the configured domains. The domains are displayed on other screens according to their assigned sort order number. NoteThe sort order field accepts value starting from 1, the Domains are displayed alphabetically on the pages when two or more Domains are configured with the same sort order.
Example
Suppose the Domain list page has two Domains named 'Acme' and 'Zacme' with the sort order value as 1 (for both the Domains). The 'Acme' Domain will be placed first followed by the 'Zacme' across the application wherever the Domain field is applicable.Active The Active switch enables you to activate or deactivate a Domain. By default, the switch is enabled, indicating that the configured Domain is active. Notes- If a domain is configured with multiple Sub Domains or Departments, attempting to deactivate triggers a validation message 'Deactivating the Domain would deactivate all the Sub Domains and all the configurations associated with it. Would you still want to proceed?' Click Yes to deactivate all the Sub Domains and associated configurations for the selected domain.
- A 'Global Domain' cannot be deactivated as there must always be one in the instance.
Global Select the Global switch to set the configuring Domain as the Global Domain. Once selected, it cannot be changed, and the Global switch becomes read-only. Only one Global Domain is permitted in the application, so you cannot select the Global check box for another domain. NoteThere can be only one global Domain configured, if the Super Admin tries to enable the global switch when the global configuration is already in place, then the message is displayed as shown in the following figure.
Figure: Global Domain Configuration - If a domain is configured with multiple Sub Domains or Departments, attempting to deactivate triggers a validation message 'Deactivating the Domain would deactivate all the Sub Domains and all the configurations associated with it. Would you still want to proceed?' Click Yes to deactivate all the Sub Domains and associated configurations for the selected domain.
Edit Domain
After configuring the Domain, you can edit the Domain configurations based on the requirements. This process involves updating the existing configured Domains.
To edit the configured Domain, perform the following steps:
- Navigate to Settings > Platform Studio > Platform Topology > Domain.
A list of configured Domains is displayed.
Figure: Domain - Click ID hyperlink corresponding to the configured Domain and edit the required details.
- Click Update to save the edited details.
A confirmation message 'You have successfully updated the Tenant' is displayed. Click GO TO LIST to navigate to Domain listing page.
Deactivate Domain
To deactivate a Domain, perform the following steps:
- Navigate to Settings > Platform Studio > Platform Topology > Domain.
A list of configured Domains is displayed.
Figure: Domain - Click ID hyperlink view the details of configured Domain
The Domain details screenshot is displayed.
Figure: Domain Details - Disable Active control and then click Update.
The Domain will be deactivated across the application.
Deactivating a Domain will lead to the deactivation of all subsequent elements related to the Domain. When the Domain is deactivated a message is popped up as displayed in the following figure.
Figure: Deactivate Domain
Global vs Local Domain
In the Platform Topology, there can be only one global Domain and all others will be local. The following table differentiates between global and local Domain configuration.
Global Domain | Local Domain |
---|---|
A global Domain is the highest entity under which you can configure other platform components. Only one global Domain can be configured on a platform.
| Multiple local Domains can be created which can function independent to each other.
|