Anaplan
The Anaplan component uses the Anaplan API to retrieve bulk data (exports) to load into a table—this stages the data, so the table is reloaded each time. You can then use transformations to enrich and manage the data in permanent tables.
Warning
This component is potentially destructive. Depending on the setting of the property Create Table Mode, the target table might be recreated or truncated. Setting the property to Fail if Exists will prevent both recreation and truncation. Do not modify the target table structure manually.
Properties
Name = string
A human-readable name for the component.
Authentication Method = drop-down
Currently, only Anaplan Username & Password credentials are supported.
Username = string
Your Anaplan login username.
Password = string
Your Anaplan password. This is stored as a secret definition. Read Secret definitions to learn how to store a password as a secret definition.
Note
Login passwords have a 90-day lifespan in Anaplan, and must be reset manually.
Workspace = drop-down
An Anaplan workspace. You can find your Workspace ID in the URL of a given model. See the portion of the URL that reads /workspaces/[workspace-id]/ where [workspace-id] is an alphanumeric Workspace ID.
Model = drop-down
An Anaplan model. You can find your Model ID in the URL of a given model. See the portion of the URL that reads /models/[models-id]/ where [model-id] is an alphanumeric Model ID.
Data Source Type = drop-down
Currently only supports Anaplan export.
Export = drop-down
Select an available export. Anaplan offers documentation on creating export actions here.
Note
It's recommended that you format your exports as "Tabular Single or Multi Column CSV" to allow exports to be stored in a cloud data warehouse as a standard table.
Destination = drop-down
- Cloud Storage: Load your data into your preferred cloud storage location.
- Snowflake: Load your data into your preferred cloud data warehouse. A cloud storage location will be used for temporary staging of the data.
Click either the Cloud Storage or Snowflake tab on this page for documentation applicable to that destination type.
Folder Path = string
The folder path of the written files.
File Prefix = string
A string of characters to include at the beginning of the written files. Often used for organizing database objects.
Storage = drop-down
A cloud storage location to load your data into for storage.
Choose either Amazon S3 or Azure Blob Storage.
Click either the Amazon S3 or Azure Blob Storage tab below for documentation applicable to that storage type.
AWS Bucket = drop-down
An AWS S3 bucket to load data into. The drop-down menu will include buckets tied to the cloud provider credentials that you have associated with your environment.
Storage Account = drop-down
Select a storage account linked to your desired blob container to be used for staging the data. For more information, read Storage account overview.
Container = drop-down
Select a Blob container to be used for staging the data. For more information, read Introduction to Azure Blob storage.
Warehouse = drop-down
The Snowflake warehouse used to run the queries. The special value, [Environment Default], will use the warehouse defined in the environment. Read Overview of Warehouses to learn more.
Database = drop-down
The Snowflake database. The special value, [Environment Default], will use the database defined in the environment. Read Databases, Tables and Views - Overview to learn more.
Schema = drop-down
The Snowflake schema. The special value, [Environment Default], will use the schema defined in the environment. Read Database, Schema, and Share DDL to learn more.
Table Name = string
The name of the table to be created.
Create Table Mode = drop-down
- Replace if exists: If the specified table name already exists, that table will be destroyed and replaced by the table created during this pipeline run.
- Truncate and insert: If the specified table name already exists, all rows within the table will be removed and new rows will be inserted per the next run of this pipeline.
- Fail if exists: If the specified table name already exists, this pipeline will fail to run.
Clean Staged files = boolean
- Yes: Staged files will be destroyed after data is loaded.
- No: Staged files are retained in the staging area after data is loaded.
Stage Platform = drop-down
Choose a data staging platform using the drop-down menu.
- S3: Stage your data on an AWS S3 bucket.
- Snowflake: Stage your data on a Snowflake internal stage.
Click one of the tabs below for documentation applicable to that staging platform.
AWS Bucket = drop-down
An AWS S3 bucket to stage data into. The drop-down menu will include buckets tied to the cloud provider credentials that you have associated with your environment.
Internal Stage Type = drop-down
A Snowflake internal stage type. Currently, only type User is supported.
Read Choosing an Internal Stage for Local Files to learn more about internal stage types and the usage of each.
Storage Account = drop-down
Select a storage account linked to your desired blob container to be used for staging the data. For more information, read Storage account overview.
Container = drop-down
Select a Blob container to be used for staging the data. For more information, read Introduction to Azure Blob storage.
| Snowflake | Databricks (preview) | Amazon Redshift (preview) |
|---|---|---|
| ✅ | ❌ | ❌ |