Anaplan Crawler¶
The Anaplan crawler fetches assets from Anaplan and publishes them to Atlan for discovery. It also create lineage between assets (using model, module, lineitem, view and list). The assets crawled are:
- App
- Page
- Workspace
- Model
- Module
- LineItem
- View
- 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 Workspace
: Select workspaces that you want to catalog in Atlan. If empty, all workspaces and assets under the workspaces are ingested into Atlan. -
(Optional)
Exclude Workspace
: Select workspaces that you do not want to catalog in Atlan. If empty, all workspaces and assets that comply with the include filter (if any) are ingested into Atlan.Warning
Include and Exclude filters still need list access for the workspace names from the REST API (https://api.anaplan.com/2/0/workspaces) to display the names of the workspaces in the filters. Any workspace not visible in these filters is out of the scope of this crawler due to limited access.
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.