Domains
Every Dataset is registered to a Domain. This Domain can be referred as a type of Business/Industry/Purpose or some other type of specification, this helps to maintain and segregate data between different Datasets.
When creating a Dataset, users must have a Domain. For example, if users have two Datasets that hold medical and infrastructure data, it would be useful to have two separate Domains, one for medical and one for infrastructure.
Users can Find this feature in the Manage -> Shared Resources -> Domains
Domain Details
The Domain Details page offers a detailed overview of the domain, including its description, associated resources like datasets and jobs, and activity logs. Users have various management options such as refreshing domain details, sharing access with other users and tags, editing domain information, deleting the domain, and cloning existing domains to create new ones with similar settings.
How to add a Domain?
To create a domain:
- Click on
+ Create Domain
button - Fill in the below information:
Type | Description |
---|---|
Domain Name | A unique identifier assigned to the domain, used for distinguishing it within the system. |
Display Name | The name displayed in the Amorphic, helping users easily recognize and reference the domain. |
Description | A brief summary outlining the purpose of the domain |
Tenant Name | The name of the tenant - Only required for Multi-tenancy enabled environments |
For a Multi-tenancy enabled environments, Domains are considered as a part of tenants. Users can decide which Domain belongs to a given tenant. The Domains made for a tenant should have the tenant's name in front, except for the standard tenant. To learn more, refer Tenants documentation.
For example, to create a Domain "finance" under a tenant "department", the Domain Name should be "department_finance". However, in the case of a default tenant. if users want to create a Domain "finance" under the default tenant, the Domain Name will be simply "finance".
Access Control
To create a dataset, access to the Domain is required. Access control is similar to other features, meaning that if users create a Domain, they will get owner access and can provide access to others using authorized users and tags.
Granting Tenant Access When Sharing Domain (API Only)
To grant both Domain and Tenant access simultaneously, include IsTenantAccessRequested
: true
in the AdditionalMetadata
field.
Path: /share/domains
Method: POST
Request Body:
{
"AccessType": "owner"/"read-only"/"editor",
"ResourceIds": [
"domainname"
],
"AccessTags": [
{
"TagKey": "tagkey",
"TagValue": "tagvalue"
}
],
"AdditionalMetadata": {
"IsDatasetLevelAccessProvided": false,
"IsTenantAccessRequested": true
}
}
- Only users with at least read-only access to the domain can be granted access to its datasets.
- A domain with attached datasets cannot be deleted; users must first remove all associated datasets. Full access is required to delete a dataset.