On this Page

Snap type:

Write

Description:

This Snap is used to write input record documents into Anaplan.

  • Expected upstream Snaps: Snap that produces input documents containing records of the same type.
  • Expected downstream Snaps: Optional Snap that reads the output result of the Write operation and performs follow-up actions.
  • Expected input: Documents containing same type of records.
  • Expected outputDatetime finished, Failed or non-failed message with any details provided by Anaplan server.


Prerequisites:

[None]


Support and limitations:

Works in Ultra Pipelines

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 exactly one document input view.
OutputThis Snap has at most one document output view.
ErrorThis Snap has at most one document error view and produces zero or more documents in the view.


Settings

Label


Required. 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. The workspace that contains the target model.

Default value: N/A

Model


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

Default value: N/A

Import name


Required. List of the export ID's available in a model.
Default value: [None]


Server filename


Required. Filename for an Anaplan server file.
Default value: [None]


Overwrite file


If selected, the Anaplan server file is overwritten. Otherwise, an error will occur if the file already exists.
Default value: Selected


Override server settings

Select this check box to override the settings saved on Anaplan's server for Separator and Text Delimiter.

Default value: Not selected

Separator


Choose the column separator for the Snap to use the following available options:

  • TAB
  • COMMA
  • SEMICOLON

Default value: TAB


  • Anaplan server might ignore this setting and try to auto-detect.
  • Ensure that the separator settings in the Snap match the contents of the uploaded file. Else, an error message, "Could not find separator in the file: <File name>" is displayed.


Text Delimiter*


Choose the text delimiter for the Snap to use the following available options:

  • DOUBLE_QUOTE
  • SINGLE_QUOTE
  • NONE

Default value: DOUBLE_QUOTE


Anaplan server might ignore this setting and try to auto-detect.


Upload only


If selected, uploads the server file and does not run an import job.
Default value: Not selected


Retry limit

Specifies 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

Specifies 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

Specifies 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

Example


The example assumes that you have configured & authorized a valid Anaplan account (see Configuring Anaplan Accounts) to be used with this Snap. The following Anaplan Write Snap writers to a file in your Anaplan Workspace. The Anaplan Write Snap is described using the following pipeline: 
 

 


The pipeline:

  1. Reads a CSV file from your SnapLogic projects using the File Reader Snap.
  2. Parses the file data using the CSV Parser Snap.
  3. Writes/imports the file/file-data on your Anaplan Workspace using the Anaplan Write Snap. 

 The File Reader Snap reads the actor.csv file (a comma separated file) from SnapLogic projects: 


Then, the CSV Parser Snap parses the actor.csv file data for Anaplan Write Snap to write it on the Anaplan Workspace. The Anaplan Write Snap writes to a file sample_1.csv in the Anaplan Workspace,SnapLogic QA, and Model, Anaplan Snap Tests
 
Note that, selecting Upload Only in this Snap uploads the file as a new file on your Anaplan Workspace. This is the same operation as performed in Anaplan Upload Snap. Not selecting the Upload Only option, updates/appends the file data (based on the input data) to an existing file in the Anaplan Workspace.

After a successful validation of the Snap, you will see a data preview that gives the status of the write operation and details of the file written/imported to Anaplan Workspace: