Qlik¶

Base class for Qlik assets.

Reference documentation

This is reference documentation covering the entire Atlan model. It is not the best place to start when trying to understand managing Qlik assets in Atlan. For that, we would suggest starting with either:

Snippets — small, atomic examples of single-step use cases.
Patterns — walkthroughs of common multi-step implementation patterns.

classDiagram
    direction RL
    class Qlik {
        <<abstract>>
    }
    link Qlik "../qlik"
    class BI {
        <<abstract>>
    }
    link BI "../entities/bi"
    BI <|-- Qlik : extends
    class Catalog {
        <<abstract>>
    }
    link Catalog "../entities/catalog"
    Catalog <|-- BI : extends
    class Asset {
        <<abstract>>
    }
    link Asset "../entities/asset"
    Asset <|-- Catalog : extends
    class Referenceable {
        <<abstract>>
    }
    link Referenceable "../entities/referenceable"
    Referenceable <|-- Asset : extends
    class QlikSpace
    link QlikSpace "../entities/qlikspace"
    Qlik <|-- QlikSpace : extends
    class QlikStream
    link QlikStream "../entities/qlikstream"
    QlikSpace <|-- QlikStream : extends
    class QlikApp
    link QlikApp "../entities/qlikapp"
    Qlik <|-- QlikApp : extends
    class QlikChart
    link QlikChart "../entities/qlikchart"
    Qlik <|-- QlikChart : extends
    class QlikDataset
    link QlikDataset "../entities/qlikdataset"
    Qlik <|-- QlikDataset : extends
    class QlikSheet
    link QlikSheet "../entities/qliksheet"
    Qlik <|-- QlikSheet : extends

Type-specific properties¶

Following are the properties uniquely available on Qlik assets in Atlan.

Java Python Raw REST API

qlikAppId

Unique identifier (in Qlik) of the app where the asset exists.
builder.qlikAppId("String0"); // (1)
qlik.getQlikAppId(); // (2)
client.assets.select().where(Qlik.QLIK_APP_ID.eq("String0")); // (3)

Set the qlikAppId for a Qlik.

For more details

For more information, see the asset CRUD snippets on either creating or updating assets.
Retrieve the qlikAppId from a Qlik.

For more details

For more information, see the asset CRUD snippets on retrieving assets.
Find all assets in Atlan with their qlikAppId exactly matching the provided value.

For more details

For more information, see the searching section on term queries.

qlikAppQualifiedName

Unique name of the app where the Qlik asset exists.
builder.qlikAppQualifiedName("String0"); // (1)
qlik.getQlikAppQualifiedName(); // (2)
client.assets.select().where(Qlik.QLIK_APP_QUALIFIED_NAME.eq("String0")); // (3)
client.assets.select().where(Qlik.QLIK_APP_QUALIFIED_NAME.match("String0")); // (4)

Set the qlikAppQualifiedName for a Qlik.

For more details

For more information, see the asset CRUD snippets on either creating or updating assets.
Retrieve the qlikAppQualifiedName from a Qlik.

For more details

For more information, see the asset CRUD snippets on retrieving assets.
Find all assets in Atlan with their qlikAppQualifiedName exactly matching the provided value.

For more details

For more information, see the searching section on term queries.
Find all assets in Atlan with their qlikAppQualifiedName textually matching the provided value.

For more details

For more information, see the searching section on full text queries.

qlikId

Unique identifier of the Qlik asset in Qlik.
builder.qlikId("String0"); // (1)
qlik.getQlikId(); // (2)
client.assets.select().where(Qlik.QLIK_ID.eq("String0")); // (3)

Set the qlikId for a Qlik.

For more details

For more information, see the asset CRUD snippets on either creating or updating assets.
Retrieve the qlikId from a Qlik.

For more details

For more information, see the asset CRUD snippets on retrieving assets.
Find all assets in Atlan with their qlikId exactly matching the provided value.

For more details

For more information, see the searching section on term queries.

qlikIsPublished

Whether the asset is published in Qlik (true) or not (false).
builder.qlikIsPublished(true); // (1)
qlik.getQlikIsPublished(); // (2)
client.assets.select().where(Qlik.QLIK_IS_PUBLISHED.eq(true)); // (3)

Set the qlikIsPublished for a Qlik.

For more details

For more information, see the asset CRUD snippets on either creating or updating assets.
Retrieve the qlikIsPublished from a Qlik.

For more details

For more information, see the asset CRUD snippets on retrieving assets.
Find all assets in Atlan with their qlikIsPublished exactly matching the provided value.

For more details

For more information, see the searching section on term queries.

qlikOwnerId

Unique identifier (in Qlik) of the owner of the asset.
builder.qlikOwnerId("String0"); // (1)
qlik.getQlikOwnerId(); // (2)
client.assets.select().where(Qlik.QLIK_OWNER_ID.eq("String0")); // (3)

Set the qlikOwnerId for a Qlik.

For more details

For more information, see the asset CRUD snippets on either creating or updating assets.
Retrieve the qlikOwnerId from a Qlik.

For more details

For more information, see the asset CRUD snippets on retrieving assets.
Find all assets in Atlan with their qlikOwnerId exactly matching the provided value.

For more details

For more information, see the searching section on term queries.

qlikQRI

QRI of the Qlik object.
builder.qlikQRI("String0"); // (1)
qlik.getQlikQRI(); // (2)
client.assets.select().where(Qlik.QLIK_QRI.eq("String0")); // (3)
client.assets.select().where(Qlik.QLIK_QRI.match("String0")); // (4)

Set the qlikQRI for a Qlik.

For more details

For more information, see the asset CRUD snippets on either creating or updating assets.
Retrieve the qlikQRI from a Qlik.

For more details

For more information, see the asset CRUD snippets on retrieving assets.
Find all assets in Atlan with their qlikQRI exactly matching the provided value.

For more details

For more information, see the searching section on term queries.
Find all assets in Atlan with their qlikQRI textually matching the provided value.

For more details

For more information, see the searching section on full text queries.

qlikSpaceId

Unique identifier (in Qlik) of the space where the asset exists.
builder.qlikSpaceId("String0"); // (1)
qlik.getQlikSpaceId(); // (2)
client.assets.select().where(Qlik.QLIK_SPACE_ID.eq("String0")); // (3)

Set the qlikSpaceId for a Qlik.

For more details

For more information, see the asset CRUD snippets on either creating or updating assets.
Retrieve the qlikSpaceId from a Qlik.

For more details

For more information, see the asset CRUD snippets on retrieving assets.
Find all assets in Atlan with their qlikSpaceId exactly matching the provided value.

For more details

For more information, see the searching section on term queries.

qlikSpaceQualifiedName

Unique name of the space where the Qlik asset exists.
builder.qlikSpaceQualifiedName("String0"); // (1)
qlik.getQlikSpaceQualifiedName(); // (2)
client.assets.select().where(Qlik.QLIK_SPACE_QUALIFIED_NAME.eq("String0")); // (3)
client.assets.select().where(Qlik.QLIK_SPACE_QUALIFIED_NAME.match("String0")); // (4)

Set the qlikSpaceQualifiedName for a Qlik.

For more details

For more information, see the asset CRUD snippets on either creating or updating assets.
Retrieve the qlikSpaceQualifiedName from a Qlik.

For more details

For more information, see the asset CRUD snippets on retrieving assets.
Find all assets in Atlan with their qlikSpaceQualifiedName exactly matching the provided value.

For more details

For more information, see the searching section on term queries.
Find all assets in Atlan with their qlikSpaceQualifiedName textually matching the provided value.

For more details

For more information, see the searching section on full text queries.

qlik_app_id

qID of a app where the qlik object belongs
builder.qlik_app_id = ...  # (1)
qlik.qlik_app_id  # (2)
FluentSearch().where(FluentSearch.asset_type(Qlik)).where(Qlik.QLIK_APP_ID.eq("String0"))  # (3)

Set the qlik_app_id for a Qlik.

For more details

For more information, see the asset CRUD snippets on either creating or updating assets.
Retrieve the qlik_app_id from a Qlik.

For more details

For more information, see the asset CRUD snippets on retrieving assets.
Find all assets in Atlan with their qlik_app_id exactly matching the provided value.

For more details

For more information, see the searching section on term queries.

qlik_app_qualified_name

qualifiedName of an app where the qlik object belongs to
builder.qlik_app_qualified_name = ...  # (1)
qlik.qlik_app_qualified_name  # (2)
FluentSearch().where(FluentSearch.asset_type(Qlik)).where(Qlik.QLIK_APP_QUALIFIED_NAME.eq("String0"))  # (3)
FluentSearch().where(FluentSearch.asset_type(Qlik)).where(Qlik.QLIK_APP_QUALIFIED_NAME.match("String0"))  # (4)

Set the qlik_app_qualified_name for a Qlik.

For more details

For more information, see the asset CRUD snippets on either creating or updating assets.
Retrieve the qlik_app_qualified_name from a Qlik.

For more details

For more information, see the asset CRUD snippets on retrieving assets.
Find all assets in Atlan with their qlik_app_qualified_name exactly matching the provided value.

For more details

For more information, see the searching section on term queries.
Find all assets in Atlan with their qlik_app_qualified_name textually matching the provided value.

For more details

For more information, see the searching section on full text queries.

qlik_id

qID/guid of the qlik object
builder.qlik_id = ...  # (1)
qlik.qlik_id  # (2)
FluentSearch().where(FluentSearch.asset_type(Qlik)).where(Qlik.QLIK_ID.eq("String0"))  # (3)

Set the qlik_id for a Qlik.

For more details

For more information, see the asset CRUD snippets on either creating or updating assets.
Retrieve the qlik_id from a Qlik.

For more details

For more information, see the asset CRUD snippets on retrieving assets.
Find all assets in Atlan with their qlik_id exactly matching the provided value.

For more details

For more information, see the searching section on term queries.

qlik_is_published

If the qlik object is published
builder.qlik_is_published = ...  # (1)
qlik.qlik_is_published  # (2)
FluentSearch().where(FluentSearch.asset_type(Qlik)).where(Qlik.QLIK_IS_PUBLISHED.eq(True))  # (3)

Set the qlik_is_published for a Qlik.

For more details

For more information, see the asset CRUD snippets on either creating or updating assets.
Retrieve the qlik_is_published from a Qlik.

For more details

For more information, see the asset CRUD snippets on retrieving assets.
Find all assets in Atlan with their qlik_is_published exactly matching the provided value.

For more details

For more information, see the searching section on term queries.

qlik_owner_id

Owner's guid of the qlik object
builder.qlik_owner_id = ...  # (1)
qlik.qlik_owner_id  # (2)
FluentSearch().where(FluentSearch.asset_type(Qlik)).where(Qlik.QLIK_OWNER_ID.eq("String0"))  # (3)

Set the qlik_owner_id for a Qlik.

For more details

For more information, see the asset CRUD snippets on either creating or updating assets.
Retrieve the qlik_owner_id from a Qlik.

For more details

For more information, see the asset CRUD snippets on retrieving assets.
Find all assets in Atlan with their qlik_owner_id exactly matching the provided value.

For more details

For more information, see the searching section on term queries.

qlik_q_r_i

QRI of the qlik object, kind of like qualifiedName on Atlan
builder.qlik_q_r_i = ...  # (1)
qlik.qlik_q_r_i  # (2)
FluentSearch().where(FluentSearch.asset_type(Qlik)).where(Qlik.QLIK_QRI.eq("String0"))  # (3)
FluentSearch().where(FluentSearch.asset_type(Qlik)).where(Qlik.QLIK_QRI.match("String0"))  # (4)

Set the qlik_q_r_i for a Qlik.

For more details

For more information, see the asset CRUD snippets on either creating or updating assets.
Retrieve the qlik_q_r_i from a Qlik.

For more details

For more information, see the asset CRUD snippets on retrieving assets.
Find all assets in Atlan with their qlik_q_r_i exactly matching the provided value.

For more details

For more information, see the searching section on term queries.
Find all assets in Atlan with their qlik_q_r_i textually matching the provided value.

For more details

For more information, see the searching section on full text queries.

qlik_space_id

qID of a space where the qlik object belongs to
builder.qlik_space_id = ...  # (1)
qlik.qlik_space_id  # (2)
FluentSearch().where(FluentSearch.asset_type(Qlik)).where(Qlik.QLIK_SPACE_ID.eq("String0"))  # (3)

Set the qlik_space_id for a Qlik.

For more details

For more information, see the asset CRUD snippets on either creating or updating assets.
Retrieve the qlik_space_id from a Qlik.

For more details

For more information, see the asset CRUD snippets on retrieving assets.
Find all assets in Atlan with their qlik_space_id exactly matching the provided value.

For more details

For more information, see the searching section on term queries.

qlik_space_qualified_name

qualifiedName of a space where the qlik object belongs to
builder.qlik_space_qualified_name = ...  # (1)
qlik.qlik_space_qualified_name  # (2)
FluentSearch().where(FluentSearch.asset_type(Qlik)).where(Qlik.QLIK_SPACE_QUALIFIED_NAME.eq("String0"))  # (3)
FluentSearch().where(FluentSearch.asset_type(Qlik)).where(Qlik.QLIK_SPACE_QUALIFIED_NAME.match("String0"))  # (4)

Set the qlik_space_qualified_name for a Qlik.

For more details

For more information, see the asset CRUD snippets on either creating or updating assets.
Retrieve the qlik_space_qualified_name from a Qlik.

For more details

For more information, see the asset CRUD snippets on retrieving assets.
Find all assets in Atlan with their qlik_space_qualified_name exactly matching the provided value.

For more details

For more information, see the searching section on term queries.
Find all assets in Atlan with their qlik_space_qualified_name textually matching the provided value.

For more details

For more information, see the searching section on full text queries.

qlikAppId

Unique identifier (in Qlik) of the app where the asset exists.
{
  "attributes": {
    "qlikAppId": "String0" // (1)
  }
}

Set the qlikAppId for a Qlik.

For more details

For more information, see the asset CRUD snippets.

qlikAppQualifiedName

Unique name of the app where the Qlik asset exists.
{
  "attributes": {
    "qlikAppQualifiedName": "String0" // (1)
  }
}

Set the qlikAppQualifiedName for a Qlik.

For more details

For more information, see the asset CRUD snippets.

qlikId

Unique identifier of the Qlik asset in Qlik.
{
  "attributes": {
    "qlikId": "String0" // (1)
  }
}

Set the qlikId for a Qlik.

For more details

For more information, see the asset CRUD snippets.

qlikIsPublished

Whether the asset is published in Qlik (true) or not (false).
{
  "attributes": {
    "qlikIsPublished": true // (1)
  }
}

Set the qlikIsPublished for a Qlik.

For more details

For more information, see the asset CRUD snippets.

qlikOwnerId

Unique identifier (in Qlik) of the owner of the asset.
{
  "attributes": {
    "qlikOwnerId": "String0" // (1)
  }
}

Set the qlikOwnerId for a Qlik.

For more details

For more information, see the asset CRUD snippets.

qlikQRI

QRI of the Qlik object.
{
  "attributes": {
    "qlikQRI": "String0" // (1)
  }
}

Set the qlikQRI for a Qlik.

For more details

For more information, see the asset CRUD snippets.

qlikSpaceId

Unique identifier (in Qlik) of the space where the asset exists.
{
  "attributes": {
    "qlikSpaceId": "String0" // (1)
  }
}

Set the qlikSpaceId for a Qlik.

For more details

For more information, see the asset CRUD snippets.

qlikSpaceQualifiedName

Unique name of the space where the Qlik asset exists.
{
  "attributes": {
    "qlikSpaceQualifiedName": "String0" // (1)
  }
}

Set the qlikSpaceQualifiedName for a Qlik.

For more details

For more information, see the asset CRUD snippets.

Relationships¶

The following illustrates how the various Qlik objects inter-relate with each other:

erDiagram
    Connection ||..o{ QlikSpace : ""
    Connection ||..o{ QlikStream : ""
    QlikSpace |o--o{ QlikApp : qlikApps
    QlikSpace |o--o{ QlikDataset : qlikDatasets
    QlikStream |o--o{ QlikApp : qlikApps
    QlikStream |o--o{ QlikDataset : qlikDatasets
    QlikApp |o--o{ QlikSheet : qlikSheets
    QlikSheet |o--o{ QlikChart : qlikCharts