Anaplan Batch Source

The Anaplan batch source is available in the Hub.

Plugin version: 1.1.1

Reads the data generated by the given Anaplan process from an Anaplan model. Data from the Anaplan model is first exported to a temporary location on Google Cloud Storage, and then read into the pipeline from there.

Credentials

If the plugin is run on a Google Cloud Dataproc cluster, the service account key does not need to be provided and can be set to ‘auto-detect’. The GCP credentials will be automatically read from the cluster environment (the GCP project where this CDF instance is hosted).

If the plugin is not run on a Dataproc cluster, the path to a service account key must be provided. The service account key can be found on the Dashboard in the Cloud Platform Console. Make sure the account key has permission to access BigQuery and Google Cloud Storage. The service account key file needs to be available on every node in your cluster and must be readable by all users running the job.

Configuration

Property

Macro Enabled?

Description

Property

Macro Enabled?

Description

Anaplan Properties

 

 

Workspace ID

Yes

Required. The target Anaplan workspace ID.

Model ID

Yes

Required. The target Anaplan model ID.

Server File Name

Yes

Required. The name of the predefined placeholder file name in the model for this data import.

Service Location

Yes

Required.  The root service location of the Anaplan API.

Auth Service Location

Yes

Required. The service location for the authentication.

User Name

Yes

Required. The service account used for the connection.

Password

Yes

Required. The password for authentication. It is suggested to use a secure macro to manage the password. For more information, see Using Secure Keys.

GCS Credentials

 

 

Reference Name

No

Required. Name used to uniquely identify this source for lineage, annotating metadata, etc.

Project ID

Yes

Required (for CDAP). Google Cloud Project ID, which uniquely identifies a project. It can be found on the Dashboard in the Google Cloud Platform Console.

Temporary Bucket Name

Yes

Required. The name of the GCS bucket serving as the buffer for the Anaplan data file export.

Temporary file name in GCS bucket

Yes

Required. The name of the temporary file for the data exported from the Anaplan model.

Format of the data to read

Yes

Required. Format of the data to export from the Anaplan model. The format must be one of ‘csv’ and ‘tsv’.

Default is csv.

Service Account Type

Yes

Optional. Select one of the following options:

  • File Path. File path where the service account is located.

  • JSON. JSON content of the service account.

Service Account File Path

Yes

Optional. Path on the local file system of the service account key used for authorization. Can be set to 'auto-detect' when running on a Dataproc cluster. When running on other clusters, the file must be present on every node in the cluster.

Default is auto-detect.

Service Account JSON

Yes

Optional. Content of the service account.


Data Type Mappings from Anaplan to CDAP

The following table lists out different Anaplan data types, as well as the corresponding CDAP data type for each Anaplan data type.

Anaplan Data Type

CDAP Data Type

Anaplan Data Type

CDAP Data Type

text

string

bool

boolean

date

date

numeric

decimal

numeric

double

numeric

float

numeric

int

numeric

long

Created in 2020 by Google Inc.