Skip to main content

App Manage App assets

Operations on App assets.

In general, these should be:

  • Created in top-down order (Connection, then Application, then ApplicationField)
  • Deleted in bottom-up order (ApplicationField, Application, then Connections)1

Asset structure​

Connection​

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

Create an App connection
String adminRoleGuid = client.getRoleCache().getIdForName("$admin"); // (1)
Connection connection = Connection.creator( // (2)
        "app-connection", // (3)
        AtlanConnectorType.APP, // (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 APP.
  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 GUIDs of the workspace roles. 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 names of the groups. 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 usernames of the users. 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.)

Application​

An Application requires a name and a qualifiedName. For creation, you also need to specify the connectionQualifiedName of the connection for the Application. You can also provide the appId and applicationOwnedAssets for the asset.

Create an Application
Application application = Application.creator( // (1)
        "application", // (2)
        connectionQualifiedName,) // (3) 
    .appId("1234") // (4)
    .applicationOwnedAssets(List.of(
        Table.refByQualifiedName("default/snowflake/123456789/DATABASE/SCHEMA/TABLE"),
        Schema.refByQualifiedName("default/snowflake/123456789/DATABASE/SCHEMA"))) // (5)
    .build();
AssetMutationResponse response = application.save(client); // (6)
  1. Build up the minimum request to create an Application.
  2. Provide a human-readable name for your Application.
  3. Provide the qualifiedName of the connection for this asset.
  4. (Optional) Provide the appId of this application in the source system.
  5. (Optional) Provide the list of assets that exist in this application. Also update the individual assets to hold the qualifiedName of this application in the attribute applicationQualifiedName.
  6. Actually call Atlan to create the application. Because this operation will persist the asset in Atlan, you must provide it an AtlanClient through which to connect to the tenant.

ApplicationField​

An ApplicationField requires a name and a qualifiedName. For creation, you also need to specify the connectionQualifiedName of the connection for the ApplicationField, and the applicationQualifiedName of the field's ancestor. You can also provide the applicationFieldOwnedAssets for the asset.

Create an ApplicationField
ApplicationField applicationField = ApplicationField.creator( // (1)
        "application-field", // (2)
        application) // (3) 
    .applicationFieldOwnedAssets(List.of(
        Table.refByQualifiedName("default/snowflake/123456789/DATABASE/SCHEMA/TABLE"),
        Schema.refByQualifiedName("default/snowflake/123456789/DATABASE/SCHEMA"))) // (4)
    .build();
AssetMutationResponse response = applicationField.save(client); // (5)
  1. Build up the minimum request to create an ApplicationField.
  2. Provide a human-readable name for your ApplicationField.
  3. Provide the application for this field.
  4. (Optional) Provide the list of assets that exist in this ApplicationField. Also update the individual assets to hold the qualifiedName of this ApplicationField in the attribute applicationFieldQualifiedName.
  5. Actually call Atlan to create the ApplicationField. Because this operation will persist the asset in Atlan, you must provide it an AtlanClient through which to connect to the tenant.

Available relationships​

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

Footnotes​

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

Was this page helpful?