Manage Preset assets

Operations on Preset assets (connections, workspaces, collections, charts, datasets).

In general, these should be:

• Created in top-down order (connection, then workspace, then collection, then charts and datasets)
• Deleted in bottom-up order (charts and datasets, then collections, then workspaces, then connections)¹

erDiagram
  Connection ||--o{ PresetWorkspace : contains
  PresetWorkspace ||--o{ PresetDashboard : contains
  PresetDashboard ||--o{ PresetChart : contains
  PresetDashboard ||--o{ PresetDataset : contains

Asset structure

Connection

2.0.0 4.0.0

A Preset connection requires a name and qualifiedName. For creation, specific settings are also required to distinguish it as a Preset connection rather than another type of connection. In addition, at least one of adminRoles, adminGroups, or adminUsers must be provided.

Java Python Kotlin Raw REST API

String adminRoleGuid = client.getRoleCache().getIdForName("$admin"); // (1)
Connection connection = Connection.creator( // (2)
        "preset-connection", // (3)
        AtlanConnectorType.PRESET, // (4)
        List.of(adminRoleGuid), // (5)
        List.of("group2"), // (6)
        List.of("jsmith")) // (7)
    .build();
AssetMutationResponse response = connection.save(client); // (8)
String connectionQualifiedName = response.getCreatedAssets().get(0).getQualifiedName(); // (9)

1. Retrieve the GUID for the admin role, to use later for defining the roles that can administer the connection.
2. Build up the minimum request to create a connection.
3. Provide a human-readable name for your connection, such as production or development.
4. Set the type of connection to Preset.
5. List the workspace roles that should be able to administer the connection (or null if none). All users with that workspace role (current and future) will be administrators of the connection. Note that the values here need to be the GUID(s) of the workspace role(s). At least one of adminRoles, adminGroups, or adminUsers must be provided.
6. List the group names that can administer this connection (or null if none). All users within that group (current and future) will be administrators of the connection. Note that the values here are the name(s) of the group(s). At least one of adminRoles, adminGroups, or adminUsers must be provided.
7. List the user names that can administer this connection (or null if none). Note that the values here are the username(s) of the user(s). At least one of adminRoles, adminGroups, or adminUsers must be provided.
8. Actually call Atlan to create the connection. Because this operation will persist the asset in Atlan, you must provide it an AtlanClient through which to connect to the tenant.
9. Retrieve the qualifiedName for use in subsequent creation calls. (You'd probably want to do some null checking first.)

from pyatlan.cache.role_cache import RoleCache
from pyatlan.client.atlan import AtlanClient
from pyatlan.model.assets import Connection, PresetWorkspace, PresetDashboard, PresetChart, PresetDataset
from pyatlan.model.enums import AtlanConnectorType

admin_role_guid = RoleCache.get_id_for_name("$admin") # (1)
connection = Connection.creator( # (2)
  name = "preset-connection", # (3)
  connector_type = AtlanConnectorType.PRESET, # (4)
  admin_roles = [admin_role_guid], # (5)
  admin_groups = ["group2"], # (6)
  admin_users = ["jsmith"] # (7)
)

response = client.asset.save(connection) # (8)
connection_qualified_name = response.assets_created(asset_type=Connection)[0].qualified_name # (9)

1. Retrieve the GUID for the admin role, to use later for defining the roles that can administer the connection.
2. Build up the minimum request to create a connection.
3. Provide a human-readable name for your connection, such as production or development.
4. Set the type of connection to Preset.
5. List the workspace roles that should be able to administer the connection (or None if none). All users with that workspace role (current and future) will be administrators of the connection. Note that the values here need to be the GUID(s) of the workspace role(s). At least one of admin_roles, admin_groups, or admin_users must be provided.
6. List the group names that can administer this connection (or None if none). All users within that group (current and future) will be administrators of the connection. Note that the values here are the name(s) of the group(s). At least one of admin_roles, admin_groups, or admin_users must be provided.
7. List the user names that can administer this connection (or None if none). Note that the values here are the username(s) of the user(s). At least one of admin_roles, admin_groups, or admin_users must be provided.
8. Actually call Atlan to create the connection.
9. Retrieve the qualified_name for use in subsequent creation calls. (You'd probably want to do some null checking first.)

val adminRoleGuid = client.roleCache.getIdForName("\$admin") // (1)
val connection = Connection.creator( // (2)
        "preset-connection", // (3)
        AtlanConnectorType.PRESET, // (4)
        listOf(adminRoleGuid), // (5)
        listOf("group2"), // (6)
        listOf("jsmith")) // (7)
    .build()
val response = connection.save(client) // (8)
val connectionQualifiedName = response.createdAssets[0].qualifiedName // (9)

1. Retrieve the GUID for the admin role, to use later for defining the roles that can administer the connection.
2. Build up the minimum request to create a connection.
3. Provide a human-readable name for your connection, such as production or development.
4. Set the type of connection to Preset.
5. List the workspace roles that should be able to administer the connection (or null if none). All users with that workspace role (current and future) will be administrators of the connection. Note that the values here need to be the GUID(s) of the workspace role(s). At least one of adminRoles, adminGroups, or adminUsers must be provided.
6. List the group names that can administer this connection (or null if none). All users within that group (current and future) will be administrators of the connection. Note that the values here are the name(s) of the group(s). At least one of adminRoles, adminGroups, or adminUsers must be provided.
7. List the user names that can administer this connection (or null if none). Note that the values here are the username(s) of the user(s). At least one of adminRoles, adminGroups, or adminUsers must be provided.
8. Actually call Atlan to create the connection. Because this operation will persist the asset in Atlan, you must provide it an AtlanClient through which to connect to the tenant.
9. Retrieve the qualifiedName for use in subsequent creation calls. (You'd probably want to do some null checking first.)

{
  "entities": [
    {
      "typeName": "Connection", // (1)
      "attributes": {
        "name": "preset-connection", // (2)
        "connectorName": "preset", // (3)
        "qualifiedName": "default/preset/123456789", // (4)
        "category": "bi", // (5)
        "adminRoles": [ // (6)
          "e7ae0295-c60a-469a-bd2c-fb903943aa02"
        ],
        "adminGroups": [ // (7)
          "group2"
        ],
        "adminUsers": [ // (8)
          "jsmith"
        ]
      }
    }
  ]
}

1. The typeName must be exactly Connection.
2. Human-readable name for your connection, such as production or development.
3. The connectorName must be exactly preset.
4. The qualifiedName should follow the pattern: default/preset/<epoch>, where <epoch> is the time in milliseconds at which the connection is being created.
5. The category must be bi.
6. List any workspace roles that can administer this connection. All users with that workspace role (current and future) will be administrators of the connection. Note that the values here need to be the GUID(s) of the workspace role(s). At least one of adminRoles, adminGroups, or adminUsers must be provided.
7. List any groups that can administer this connection. All users within that group (current and future) will be administrators of the connection. Note that the values here are the name(s) of the group(s). At least one of adminRoles, adminGroups, or adminUsers must be provided.
8. List any users that can administer this connection. Note that the values here are the username(s) of the user(s). At least one of adminRoles, adminGroups, or adminUsers must be provided.

Access policies

Atlan creates the policies that grant access to a connection, including the ability to retrieve the connection and to create assets within it, asynchronously. It can take several seconds (even up to approximately 30 seconds) before these are in place after creating the connection.

You may therefore need to wait before you'll be able to create the assets below within the connection.

To confirm access, retrieve the connection after it has been created. The SDKs' retry loops will automatically retry until the connection can be successfully retrieved. At that point, your API token has permission to create the other assets.

Note: if you are reusing an existing connection rather than creating one via your API token, you must give your API token a persona that has access to that connection. Otherwise all attempts to create, read, update, or delete assets within that connection will fail due to a lack of permissions.

PresetWorkspace

2.0.0 4.0.0

A Preset workspace requires a name and a qualifiedName. For creation, you also need to specify the connectionQualifiedName of the connection for the workspace.

Java Python Kotlin Raw REST API

PresetWorkspace workspace = PresetWorkspace.creator( // (1)
        "ps-workspace", // (2)
        connectionQualifiedName) // (3)
    .build();
AssetMutationResponse response = workspace.save(client); // (4)
workspace = response.getResult(workspace); // (5)

1. Build up the minimum request to create a workspace.
2. Provide a human-readable name for your workspace.
3. Provide the qualifiedName of the connection for this workspace.
4. Actually call Atlan to create the workspace. Because this operation will persist the asset in Atlan, you must provide it an AtlanClient through which to connect to the tenant.
5. Retrieve the created workspace for use in subsequent creation calls. (You'd probably want to do some null checking first.)

workspace = PresetWorkspace.creator( # (1)
  name = "ps-workspace", # (2)
  connection_qualified_name = connection_qualified_name # (3)
)
response = client.asset.save(workspace) # (4)
preset_workspace_qualified_name = response.assets_created(asset_type=PresetWorkspace)[0].qualified_name # (5)

1. Build up the minimum request to create a workspace.
2. Provide a human-readable name for your workspace.
3. Provide the qualified_name of the connection for this workspace.
4. Actually call Atlan to create the workspace.
5. Retrieve the created workspace for use in subsequent creation calls. (You'd probably want to do some null checking first.)

var workspace = PresetWorkspace.creator( // (1)
    "ps-workspace", // (2)
    connectionQualifiedName) // (3)
    .build()
val response = workspace.save(client) // (4)
workspace = response.getResult(workspace) // (5)

1. Build up the minimum request to create a workspace.
2. Provide a human-readable name for your workspace.
3. Provide the qualifiedName of the connection for this workspace.
4. Actually call Atlan to create the workspace. Because this operation will persist the asset in Atlan, you must provide it an AtlanClient through which to connect to the tenant.
5. Retrieve the created workspace for use in subsequent creation calls. (You'd probably want to do some null checking first.)

{
  "entities": [
    {
      "typeName": "PresetWorkspace", // (1)
      "attributes": {
        "name": "ps-workspace", // (2)
        "qualifiedName": "default/preset/123456789/ps-workspace", // (3)
        "connectionQualifiedName": "default/preset/123456789", // (4)
        "connectorName": "preset" // (5)
      }
    }
  ]
}

1. The typeName must be exactly PresetWorkspace.
2. Human-readable name for your workspace.
3. The qualifiedName should follow the pattern: default/preset/<epoch>/<workspace_name>, where default/preset/<epoch> is the qualifiedName of the connection for this workspace and <workspace_name> is the name of the workspace.
4. The connectionQualifiedName must be the exact qualifiedName of the connection for this workspace.
5. The connectorName must be exactly preset.

PresetDashboard

2.0.0 4.0.0

A Preset collection requires a name and a qualifiedName. For creation, you also need to specify the connectionQualifiedName of the connection for the collection, and the names and qualifiedNames of the collection's ancestors.

Java Python Kotlin Raw REST API

PresetDashboard collection = PresetDashboard.creator( // (1)
        "ps-collection", // (2)
        workspace) // (3)
    .build();
AssetMutationResponse response = collection.save(client); // (4)
collection = response.getResult(collection); // (5)

1. Build up the minimum request to create a collection.
2. Provide a human-readable name for your collection.
3. Provide the workspace for this collection. If you did not already have the object, you could also use PresetWorkspace.refByGuid() with the GUID of the workspace, or PresetWorkspace.refByQualifiedName() with the qualifiedName of the workspace.
4. Actually call Atlan to create the collection. Because this operation will persist the asset in Atlan, you must provide it an AtlanClient through which to connect to the tenant.
5. Retrieve the created collection for use in subsequent creation calls. (You'd probably want to do some null checking first.)

collection = PresetDashboard.creator( # (1)
  name = "ps-collection", # (2)
  preset_workspace_qualified_name = preset_workspace_qualified_name # (3)
)
response = client.asset.save(collection) # (4)
preset_dashboard_qualified_name = response.assets_created(asset_type=PresetDashboard)[0].qualified_name # (5)

1. Build up the minimum request to create a collection.
2. Provide a human-readable name for your collection.
3. Provide the qualified_name of the Preset workspace for this collection.
4. Actually call Atlan to create the collection.
5. Retrieve the created collection for use in subsequent creation calls. (You'd probably want to do some null checking first.)

var collection = PresetDashboard.creator( // (1)
    "ps-collection", // (2)
    workspace) // (3)
    .build()
val response = collection.save(client) // (4)
collection = response.getResult(collection) // (5)

1. Build up the minimum request to create a collection.
2. Provide a human-readable name for your collection.
3. Provide the workspace for this collection. If you did not already have the object, you could also use PresetWorkspace.refByGuid() with the GUID of the workspace, or PresetWorkspace.refByQualifiedName() with the qualifiedName of the workspace.
4. Actually call Atlan to create the collection. Because this operation will persist the asset in Atlan, you must provide it an AtlanClient through which to connect to the tenant.
5. Retrieve the created collection for use in subsequent creation calls. (You'd probably want to do some null checking first.)

{
  "entities": [
    {
      "typeName": "PresetDashboard", // (1)
      "attributes": {
        "name": "ps-collection", // (2)
        "qualifiedName": "default/preset/123456789/ps-workspace/ps-collection", // (3)
        "connectionQualifiedName": "default/preset/123456789", // (4)
        "connectorName": "preset", // (5)
        "presetWorkspace": { // (6)
          "typeName": "PresetWorkspace", // (7)
          "uniqueAttributes": { // (8)
            "qualifiedName": "default/preset/123456789/ps-workspace"
          }
        },
        "presetWorkspaceQualifiedName": "default/preset/123456789/ps-workspace" // (9)
      }
    }
  ]
}

1. The typeName must be exactly PresetDashboard.
2. Human-readable name for your collection.
3. The qualifiedName should follow the pattern: default/preset/<epoch>/<workspace_name>/<collection_name>, where default/preset/<epoch>/<workspace_name> is the qualifiedName of the workspace for this collection and <collection_name> is the name for this collection.
4. The connectionQualifiedName must be the exact qualifiedName of the connection for this collection.
5. The connectorName must be exactly preset.
6. The workspace in which this collection exists is embedded in the presetWorkspace attribute.
7. The typeName for this embedded reference must be PresetWorkspace.
8. To complete the reference, you must include a uniqueAttributes object with the qualifiedName of the workspace. Note: the workspace must already exist in Atlan before creating the collection.
9. The presetWorkspaceQualifiedName should be the qualifiedName of the workspace.

PresetChart

2.0.0 4.0.0

A Preset chart requires a name and a qualifiedName. For creation, you also need to specify the connectionQualifiedName of the connection for the chart, and the names and qualifiedNames of the chart's ancestors.

Java Python Kotlin Raw REST API

PresetChart chart = PresetChart.creator( // (1)
        "ps-chart", // (2)
        collection) // (3)
    .build();
AssetMutationResponse response = chart.save(client); // (4)

1. Build up the minimum request to create a chart.
2. Provide a human-readable name for your chart.
3. Provide the collection for this chart.
4. Actually call Atlan to create the chart. Because this operation will persist the asset in Atlan, you must provide it an AtlanClient through which to connect to the tenant.

chart = PresetChart.creator( # (1)
  name = "ps-chart ", # (2)
  preset_dashboard_qualified_name = preset_dashboard_qualified_name # (3)
)
response = client.asset.save(chart) # (4)

1. Build up the minimum request to create a chart.
2. Provide a human-readable name for your chart.
3. Provide the qualified_name of the collection.
4. Actually call Atlan to create the chart.

val chart = PresetChart.creator( // (1)
    "ps-chart", // (2)
    collection) // (3)
    .build()
val response = chart.save(client) // (4)

1. Build up the minimum request to create a chart.
2. Provide a human-readable name for your chart.
3. Provide the collection for this chart.
4. Actually call Atlan to create the chart. Because this operation will persist the asset in Atlan, you must provide it an AtlanClient through which to connect to the tenant.

{
  "entities": [
    {
      "typeName": "PresetChart", // (1)
      "attributes": {
        "name": "ps-chart", // (2)
        "qualifiedName": "default/preset/123456789/ps-workspace/ps-collection/ps-chart", // (3)
        "connectionQualifiedName": "default/preset/123456789", // (4)
        "connectorName": "preset", // (5)
        "presetDashboard": { // (6)
          "typeName": "PresetDashboard", // (7)
          "uniqueAttributes": { // (8)
            "qualifiedName": "default/preset/123456789/ps-workspace/ps-collection"
          }
        },
        "presetDashboardQualifiedName": "default/preset/123456789/ps-workspace/ps-collection", // (9)
        "presetWorkspaceQualifiedName": "default/preset/123456789/ps-workspace" // (10)
      }
    }
  ]
}

1. The typeName must be exactly PresetChart.
2. Human-readable name for your chart.
3. The qualifiedName should follow the pattern: default/preset/<epoch>/<workspace_name>/<collection_name>/<chart_name>, where default/preset/<epoch>/<workspace_name>/<collection_name> is the qualifiedName of the collection for this chart and <chart_name> is the name for this chart.
4. The connectionQualifiedName must be the exact qualifiedName of the connection for this chart.
5. The connectorName must be exactly preset.
6. The collection in which this chart exists is embedded in the presetDashboard attribute.
7. The typeName for this embedded reference must be PresetDashboard.
8. To complete the reference, you must include a uniqueAttributes object with the qualifiedName of the collection. Note: the collection must already exist in Atlan before creating the chart.
9. The presetDashboardQualifiedName should be the qualifiedName of the collection.
10. The presetWorkspaceQualifiedName should be the qualifiedName of the workspace.

PresetDataset

2.0.0 4.0.0

A Preset dataset requires a name and a qualifiedName. For creation, you also need to specify the connectionQualifiedName of the connection for the dataset, and the names and qualifiedNames of the dataset's ancestors.

Java Python Kotlin Raw REST API

PresetDataset dataset = PresetDataset.creator( // (1)
        "ps-dataset", // (2)
        collection) // (3)
    .build();
AssetMutationResponse response = dataset.save(client); // (4)

1. Build up the minimum request to create a dataset.
2. Provide a human-readable name for your dataset.
3. Provide the collection for this dataset.
4. Actually call Atlan to create the dataset. Because this operation will persist the asset in Atlan, you must provide it an AtlanClient through which to connect to the tenant.

dataset = PresetDataset.creator( # (1)
  name = "ps-dataset ", # (2)
  preset_dashboard_qualified_name = preset_dashboard_qualified_name # (3)
)
response = client.asset.save(dataset) # (4)

1. Build up the minimum request to create a dataset.
2. Provide a human-readable name for your dataset.
3. Provide the qualified_name of the collection.
4. Actually call Atlan to create the dataset.

val dataset = PresetDataset.creator( // (1)
    "ps-dataset", // (2)
    collection) // (3)
    .build()
val response = dataset.save(client) // (4)

1. Build up the minimum request to create a dataset.
2. Provide a human-readable name for your dataset.
3. Provide the collection for this dataset.
4. Actually call Atlan to create the dataset. Because this operation will persist the asset in Atlan, you must provide it an AtlanClient through which to connect to the tenant.

{
  "entities": [
    {
      "typeName": "PresetDataset", // (1)
      "attributes": {
        "name": "ps-dataset", // (2)
        "qualifiedName": "default/preset/123456789/ps-workspace/ps-collection/ps-dataset", // (3)
        "connectionQualifiedName": "default/preset/123456789", // (4)
        "connectorName": "preset", // (5)
        "presetDashboard": { // (6)
          "typeName": "PresetDashboard", // (7)
          "uniqueAttributes": { // (8)
            "qualifiedName": "default/preset/123456789/ps-workspace/ps-collection"
          }
        },
        "presetDashboardQualifiedName": "default/preset/123456789/ps-workspace/ps-collection", // (9)
        "presetWorkspaceQualifiedName": "default/preset/123456789/ps-workspace" // (10)
      }
    }
  ]
}

1. The typeName must be exactly PresetDataset.
2. Human-readable name for your dataset.
3. The qualifiedName should follow the pattern: default/preset/<epoch>/<workspace_name>/<collection_name>/<dataset_name>, where default/preset/<epoch>/<workspace_name>/<collection_name> is the qualifiedName of the collection for this dataset and <dataset_name> is the name for this dataset.
4. The connectionQualifiedName must be the exact qualifiedName of the connection for this dataset.
5. The connectorName must be exactly preset.
6. The collection in which this dataset exists is embedded in the presetDashboard attribute.
7. The typeName for this embedded reference must be PresetDashboard.
8. To complete the reference, you must include a uniqueAttributes object with the qualifiedName of the collection. Note: the collection must already exist in Atlan before creating the dataset.
9. The presetDashboardQualifiedName should be the qualifiedName of the collection.
10. The presetWorkspaceQualifiedName should be the qualifiedName of the workspace.

Available relationships

Every level of the business intelligence structure is an Asset, and can therefore be related to the following other assets.

erDiagram
  Asset }o--o{ AtlasGlossaryTerm : meanings
  Asset ||--o{ Link : links
  Asset ||--o| Readme : readme
  Asset }o--o{ Process : inputToProcesses
  Asset }o--o{ Process : outputFromProcesses

AtlasGlossaryTerm

A glossary term provides meaning to an asset. The link terms to assets snippet provides more detail on setting this relationship.

Link

A link provides additional context to an asset, by providing a URL to additional information.

Readme

A README provides rich documentation for an asset. The add asset READMEs snippet provides more detail on setting this relationship.

Process

A process provides lineage information for an asset. An asset can be both an input and an output for one or more processes. The lineage snippets provide more detail on creating and working with lineage.

---

1. Although if you want to delete everything in a connection, your better avenue is the packaged connection delete utility in the UI. ↩

---