Skip to content

Anaplan Crawler

The Anaplan crawler fetches assets from Anaplan and publishes them to Atlan for discovery. It also create lineage between assets (only for model, module, lineitem, view and list). The assets crawled are:

  • App
  • Page
  • Workspace
  • Model
  • Module
  • LineItem
  • View
  • Dimension
  • System Dimension
  • List

The relationship between these assets can be understood using the entity diagram from the developer portal reference.

Configuration

Credential

  • Host: Anaplan host URL for the source system. Please make sure to provide the host name without the 'https://' and trailing '/' (e.g., us1a.app.anaplan.com).

  • Authentication: Select the authentication type to be used for source asset extraction.

    Recommendation

    An Anaplan account with workspace admin privileges to have all the assets ingested into Atlan. Refer.

    • Username: Anaplan Username (can be email ID) for the account with access to all workspaces and apps to be cataloged on Atlan.
    • Password: Anaplan Password for the account mentioned in the username field.

Connection

  • Connection Name : Name of the connection that will be created in Atlan. The connection name must be unique across all Anaplan connections.
  • Connection Admins : Add users you want to give admin privileges for all assets under the connection.

Filter

  • (Optional) Include Metadata : Select projects that you want to catalog in Atlan. If empty, all metadata that the account has access to will be ingested into Atlan.

  • (Optional) Exclude Metadata : Select projects that you do not want to catalog in Atlan. If empty, all metadata that the account has access and comply with the include filter (if any) are ingested into Atlan.

    Warning

    Include and Exclude filters still need list access for all the asset names to be displayed in the filters. Any name not visible in these filters is out of the scope of this crawler due to limited access.

  • Exclude Empty Modules : To allow for exclusion of modules which do not have a lineitem in them. Should be used to prevent ingestion of line-separator modules (suggested by anaplan training documentation).

    Ignores every module during extraction, which do not have a lineitem in them.

    Ingests every valid module, even if they do not have a lineitem in them.

  • Ingest System Dimensions ? : To allow for dimensions created by anaplan system to be ingested separately under the anaplan connection. This process is done based on the dimension name. Dimensions with same name accross all models are treated as a singular dimension if "Yes, proxy". System dimensions supported by this option are : Time and Versions.

    Ingests the above mentioned dimensions directly under the connection as "System Dimension" asset type.

    The asset type "System Dimension" will not hold any relationship and will only exist under the anaplan connection as proxy assets for metadata reference.

    Ingests each system dimension under each model along with it's respective relationships as individual "Dimensions".

    Do not ingest the above mentioned system dimensions at all.

What it does

The package performs the following steps:

  • Create a connection in Atlan. If the connection already exists, the step is skipped.
  • Fetch all the assets listed above from the source.
  • Evaluates the assets on selected filters and creates asset and lineage metadata.
  • Publish assets and then lineage between assets.

Warning

Any asset deleted in source is also deleted/archived from Atlan and is also removed from any lineage.