The Anaplan orchestration component uses the Connect and Configure parameters to query the Anaplan Bulk API and create a table of Anaplan export data, which is then stored in your preferred storage location (Snowflake, Databricks, Amazon Redshift, or cloud storage). You do not need to use the Create Table component when using this connector, as the Anaplan component will create a new table or replace an existing table for you using the Destination parameters you define.
The Anaplan connector supports full data loads only. Each pipeline run exports the complete dataset from the selected Anaplan export action.
If the component requires access to a cloud provider (AWS, Azure, or Google Cloud), it will use the cloud credentials associated with your environment to access resources.
To stage data to Azure Blob Storage, the Azure credentials associated with your environment must be assigned the Storage Blob Data Contributor role. For more information, read User assigned with the Storage Blob Data Contributor role.
Properties
Reference material is provided below for the Connect, Configure, Destination, and Advanced Settings properties.
This connector does not include a Connection Options parameter.
A human-readable name for the component.
Connect
Currently, only Anaplan Username & Password credentials are supported.
Your Anaplan login username.
Your Anaplan password. This is stored as a secret definition. Read Secrets and secret definitions to learn how to store a password as a secret definition.Login passwords have a 90-day lifespan in Anaplan, and must be reset manually.
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.
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.
Currently only supports Anaplan export. Select an available export.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
Select your cloud data warehouse.
Snowflake
Databricks
Amazon Redshift
Google BigQuery
Select the destination for your data. This is either in Snowflake as a table or as files in cloud storage.
- Snowflake: Load your data into a table in Snowflake. The data must first be staged via Snowflake or a cloud storage solution.
- Cloud Storage: Load your data directly into files in your preferred cloud storage location. The format of these files can differ between source systems and will not have a file extension so we suggest inspecting the output to determine the format of the data.
The Snowflake warehouse used to run the queries. The special value [Environment Default] uses the warehouse defined in the environment. Read Overview of Warehouses to learn more. The Snowflake schema. The special value [Environment Default] uses the schema defined in the environment. Read Database, Schema, and Share DDL to learn more. The name of the table to be created in your Snowflake database. You can use a Table Input component in a transformation pipeline to access and transform this data after it has been loaded. Define what happens if the table name already exists in the specified Snowflake database and schema.
- Replace: 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: Each time the pipeline runs, two operations are performed: first, the table is truncated, meaning all existing rows are deleted. Then, your new rows are inserted. The table itself is never destroyed and recreated.
- Fail if Exists: If the specified table name already exists, this pipeline will fail to run.
- Append: If the specified table name already exists, then the data is inserted without altering or deleting the existing data in the table. It’s appended onto the end of the existing data in the table. If the specified table name doesn’t exist, then the table will be created, and your data will be inserted into the table.
Select one or more columns to be designated as the table’s primary key.
- Yes: Staged files will be destroyed after data is loaded. This is the default setting.
- No: Staged files are retained in the staging area after data is loaded.
Select the stage access strategy. The strategies available depend on the cloud platform you select in Stage Platform.
- Credentials: Connects to the external stage (AWS, Azure) using your configured cloud provider credentials. Not available for Google Cloud Storage.
- Storage Integration: Use a Snowflake storage integration to grant access to Snowflake to read data from and write to a cloud storage location. This will reveal the Storage Integration property, through which you can select any of your existing Snowflake storage integrations.
Use the drop-down menu to choose where the data is staged before being loaded into your Snowflake table.
- Amazon S3: Stage your data on an AWS S3 bucket.
- Snowflake: Stage your data on a Snowflake internal stage.
- Azure Storage: Stage your data in an Azure Blob Storage container.
- Google Cloud Storage: Stage your data in a Google Cloud Storage bucket.
Select the Snowflake internal stage type. Use the Snowflake links provided to learn more about each type of stage.
- User: Each Snowflake user has a user stage allocated to them by default for file storage. You may find the user stage convenient if your files will only be accessed by a single user, but need to be copied into multiple tables.
- Named: A named stage provides high flexibility for data loading. Users with the appropriate privileges on the stage can load data into any table. Furthermore, because the stage is a database object, any security or access rules that apply to all objects will apply to the named stage.
Named stages can be altered and dropped. User stages cannot. Select your named stage. Read Creating a named stage to learn how to create a new named stage.There is a known issue where named stages that include special characters or spaces are not supported.
- Append Files in Folder: Appends files to storage folder. This is the default setting.
- Overwrite Files in Folder: Overwrite existing files with matching structure.
The folder path for the files to be written to. Note that this path follows, but does not include, the bucket or container name.
A string of characters that precedes the name of the written files. This can be useful for organizing database objects.
A cloud storage location to load your data into files for storage. Choose either Amazon S3, Azure Storage, or Google Cloud Storage.
Select the destination for your data. This is either in Databricks as a table or as files in cloud storage.
- Databricks: Load your data into Databricks. You’ll need to set a cloud storage location for temporary staging of the data.
- Cloud Storage: Load your data directly into files in your preferred cloud storage location.
Select a Databricks Unity Catalog. The special value [Environment Default] uses the catalog defined in the environment. Selecting a catalog will determine which databases are available in the next parameter. The Databricks schema. The special value [Environment Default] uses the schema defined in the environment. Read Create and manage schemas to learn more. The name of the table to be created in your Databricks schema. You can use a Table Input component in a transformation pipeline to access and transform this data after it has been loaded. Define what happens if the table name already exists in the specified Databricks schema.
- Fail if Exists: If the specified table name already exists, this pipeline will fail to run.
- Replace: 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: Each time the pipeline runs, two operations are performed: first, the table is truncated, meaning all existing rows are deleted. Then, your new rows are inserted. The table itself is never destroyed and recreated.
- Append: If the specified table name already exists, then the data is inserted without altering or deleting the existing data in the table. It’s appended onto the end of the existing data in the table. If the specified table name doesn’t exist, then the table will be created, and your data will be inserted into the table.
- Yes: Staged files will be destroyed after data is loaded. This is the default setting.
- No: Staged files are retained in the staging area after data is loaded.
Use the drop-down menu to choose where the data is staged before being loaded into your Databricks table.
- Amazon S3: Stage your data on an AWS S3 bucket.
- Azure Storage: Stage your data in an Azure Blob Storage container.
- Append Files in Folder: Appends files to storage folder. This is the default setting.
- Overwrite Files in Folder: Overwrite existing files with matching structure.
The folder path for the files to be written to. Note that this path follows, but does not include, the bucket or container name.
A string of characters that precedes the name of the written files. This can be useful for organizing database objects.
A cloud storage location to load your data into for storage. Choose either Amazon S3, Azure Storage, or Google Cloud Storage.
Select the destination for your data. This is either in Amazon Redshift as a table or as files in cloud storage.
- Redshift: Load your data into Amazon Redshift. You’ll need to set a cloud storage location for temporary staging of the data.
- Cloud Storage: Load your data directly into files in your preferred cloud storage location.
Amazon Redshift
Cloud Storage
Select the Amazon Redshift schema that will contain your table. The special value [Environment Default] uses the schema defined in the environment. For information about using multiple schemas, read Schemas. The name of the table to be created in your Amazon Redshift database. You can use a Table Input component in a transformation pipeline to access and transform this data after it has been loaded. Define what happens if the table name already exists in the specified Amazon Redshift database and schema.
- Replace: If the specified table name already exists, that table will be destroyed and replaced by the table created during this pipeline run.
- Fail if Exists: If the specified table name already exists, this pipeline will fail to run.
- Truncate and Insert: Each time the pipeline runs, two operations are performed: first, the table is truncated, meaning all existing rows are deleted. Then, your new rows are inserted. The table itself is never destroyed and recreated.
- Append: If the specified table name already exists, then the data is inserted without altering or deleting the existing data in the table. It’s appended onto the end of the existing data in the table. If the specified table name doesn’t exist, then the table will be created, and your data will be inserted into the table.
- Yes: Staged files will be destroyed after data is loaded. This is the default setting.
- No: Staged files are retained in the staging area after data is loaded.
An AWS S3 bucket to stage data into before it is loaded into your Amazon Redshift table. The drop-down menu will include buckets tied to the cloud provider credentials that you have associated with your environment.
- Append Files in Folder: Appends files to storage folder. This is the default setting.
- Overwrite Files in Folder: Overwrite existing files with matching structure.
The folder path for the files to be written to. Note that this path follows, but does not include, the bucket or container name.
A string of characters to include at the beginning of the written files. Often used for organizing database objects.
A cloud storage location to load your data into for storage. Choose either Amazon S3, Azure Storage, or Google Cloud Storage.
Google BigQuery
Cloud Storage
- Append Files in Folder: Appends files to storage folder. This is the default setting.
- Overwrite Files in Folder: Overwrite existing files with matching structure.
The folder path for the files to be written to. Note that this path follows, but does not include, the bucket or container name.
A string of characters that precedes the name of the written files. This can be useful for organizing database objects.
A cloud storage location to load your data into files for storage. Choose either Amazon S3, Azure Storage, or Google Cloud Storage.
Advanced Settings
Parse 'Null' & Empty Strings as NULL
Converts common strings that represent null into a null value. This is case-sensitive and works with the following strings: "", “NULL”, “NUL”, “Null”, “null”. The default is No.Currently, this property is only applicable when using Snowflake as your destination.
Deactivate soft delete for Azure blobs (Databricks)
If you intend to set your destination as Databricks and your stage platform as Azure Storage, you must turn off the “Enable soft delete for blobs” setting in your Azure account for your pipeline to run successfully. To do this:
- In the Azure portal, navigate to your storage account.
- In the menu, under Data management, click Data protection.
- Clear the Enable soft delete for blobs checkbox. For more information, read Soft delete for blobs.
