On this Page

Snap type:

Read


Description:

This Snap reads the exported file on an Anaplan account.

  • Expected upstream Snaps: Any document processing Snap, such as a Mapper Snap.
  • Expected downstream Snaps: Any document processing Snap, such as a Mapper Snap.
  • Expected input: The properties of the Read Snap can be defined as expressions in case the input variable shall determine the value of one of the properties.
  • Expected outputThe Snap writes the Anaplan file data read into the binary output view as a stream. This stream data can be parsed using parser Snaps like CSV Parser or Excel Parser based on the type of the file read.


Prerequisites:

[None]


Support and limitations:
Account: 

This Snap uses account references created on the Accounts page of SnapLogic Manager to handle access to this endpoint. See Anaplan Account for information on setting up this type of account.


Views:


InputThis Snap has at most one document input view.
OutputThis Snap has exactly one binary output view.
ErrorThis Snap has at most one document error view and produces zero or more documents in the view. Output should contain reason, error, stacktrace, and resolution.


Settings

Label


Required. Enter the name for the Snap. You can modify this to be more specific, especially if you have more than one of the same Snap in your pipeline.

Workspace


Required. Enter the workspace that contains the target model.

Default value: N/A

Model


Required. Enter the model on which you want the Snap to operate.

Default value: N/A

Export ID


Required. Enter the list of the export ID's available in a model.

Default value: [None]

Retry limit

Specify the maximum number of connection retry attempts in case of a connection failure. If the retry attempts exceed the configured value, the pipeline execution fails and an error message appears.

Default value:  3

Retry interval

Specify the minimum retry time interval in seconds. Enter the time interval for the Snap to retry a connection request after a failed connection. The time increases exponentially between failures. For example, if the timeout is set to 3 seconds, the first timeout is at 3, the second is at 4.5 etc.

Default value:  3

HTTP timeout

Specify the connection timeout value in seconds. In case of a connection failure, the Snap aborts the pipeline execution. 
For example, if the HTTP timeout is set to 30 seconds, and the Snap fails to establish a connection until 30 seconds, the pipeline logs a timeout exception and aborts execution.

Default value:  60


Snap Execution



Select one of the three modes in which the Snap executes. Available options are:

  • Validate & Execute: Performs limited execution of the Snap, and generates a data preview during Pipeline validation. Subsequently, performs full execution of the Snap (unlimited records) during Pipeline runtime.
  • Execute only: Performs full execution of the Snap during Pipeline execution without generating preview data.
  • Disabled: Disables the Snap and all Snaps that are downstream from it.


Examples


This example assumes that you have configured & authorized a valid Anaplan account (see Configuring Anaplan Accounts) to be used with this Snap. The following Anaplan Read Snap reads/exports data from a file existing in your Anaplan Workspace. In this example, data from the file, ActionTest - delete:Test 1.xls, in your Anaplan Workspace, SnapLogic QA, and Model, Anaplan Snap Tests, is read.

After a successful validation of the Snap, you will see a data preview that gives the details of the file that was read/exported: