Anaplan Write

Created by Aparna Tayi

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 output: Datetime 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

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.

Temporary Files

During execution, data processing on Snaplex nodes occurs principally in-memory as streaming and is unencrypted. When larger datasets are processed that exceeds the available compute memory, the Snap writes Pipeline data to local storage as unencrypted to optimize the performance. These temporary files are deleted when the Snap/Pipeline execution completes. You can configure the temporary data's location in the Global properties table of the Snaplex's node properties, which can also help avoid Pipeline errors due to the unavailability of space. For more information, see Temporary Folder in Configuration Options. 

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:  

 
 

Snap Pack History

 Click to view/expand
ReleaseSnap Pack Version DateTypeUpdates
4.29main15993 StableUpgraded with the latest SnapLogic Platform release.
4.28main14627 StableUpgraded with the latest SnapLogic Platform release.
4.27427patches13160 Latest

Fixed the issue with Anaplan Snaps, where the log messages were stored in jccoutput.log file instead of jcc.json file, and updated the dependent libraries.

4.27

main12833

 

Stable

Upgraded with the latest SnapLogic Platform release.
4.26main11181 StableUpgraded with the latest SnapLogic Platform release.
4.25 Patch425patches10360 Latest

Added the following fields to the Anaplan Write Snap:

  • Override server settings
  • Separator
  • Text Delimiter
4.25main9554 StableNo updates made.
4.24424patches9313 LatestFixed an issue related to Index out of range in the Anaplan Upload Snap when the separator is not present or does not match the one in the upload file.
4.24main8556 StableNo updates made.
4.23 

main7430

 

Stable

No updates made.

4.22422patches7392
 
Latest

Fixed the Snap Pack error handling issue by reverting the getChunk method, that returns a variant that contains all or a part of the contents of a large text or binary data Field object, of 1.4.4.2 jar version to 1.4.4.1 jar version and upgraded the jar version to 1.4.4.3.

4.22422patches6561
 
Latest
  • Fixed the Anaplan Snaps by displaying the same value for both Task ID and Task Name, by following the Anaplan client SDK.
  • Enhanced the Anaplan Snaps by allowing you to provide interchangeable inputs for the following fields: 
    • Workspace ID and Workspace Name

    • Model ID and Model Name

      Introduces a suggestible option that enables you to select the Workspace Name and Model Name.

4.22main6403
 
Stable

No updates made.

4.21421patches5851
 
Latest

Fixed the Anaplan Action Snap that outputs the same value for TaskID and TaskName parameters.

4.21snapsmrc542
 
StableNo updates made.
4.20snapsmrc535
 
StableNo updates made
4.19snaprsmrc528
 
Latest

Removed the suggestion button from the Workspace and Model fields in the Snap Settings dialog. Hence, you need to enter the field values manually.  

4.18snapsmrc523
 
Stable

No updates made.

4.17Anaplan7422
 
Latest

Fixed an issue with the Anaplan Read Snap wherein the Snap pulls archived and deleted models.

4.17ALL7402
 
Latest

Pushed automatic rebuild of the latest version of each Snap Pack to SnapLogic UAT and Elastic servers.

4.17snapmrc515
Latest

Added the Snap Execution field to all Standard-mode Snaps. In some Snaps, this field replaces the existing Execute during preview check box.

4.16snapsmrc508
 
Stable

No updates made. Automatic rebuild with a platform release.

4.15snapsmrc500
 
Latest
  • To support Anaplan v2.0 API, we have enhanced the Anaplan Account configuration.
  • Added retry capability to Anaplan Action, Read, Write, and Upload Snaps that allow you to handle connection timeouts during Pipeline execution.
4.14anaplan6247

 

Latest

Added a new property, Override server settings, to override a few settings saved on Anaplan's server.

4.14anaplan5742
 
Latest

Fixed an issue where certain JCC-logging configurations had conflicts in class loading that resulted in inaccurate log information.

4.14snapsmrc490
 
Stable

No updates made. Automatic rebuild with a platform release.

4.13

snapsmrc486

 
Stable

No updates made. Automatic rebuild with a platform release.

4.12

snapsmrc480

 
StableNo updates made. Automatic rebuild with a platform release.
4.11snapsmrc465
 
StableNo updates made. Automatic rebuild with a platform release.
4.10

snapsmrc414

 
StableNo updates made. Automatic rebuild with a platform release.
4.9snapsmrc405
 
Latest
  • Added connection retry logic to Anaplan Action Snap.
  • "Re-submission of chunks" logic added to Anaplan Upload Snap.
4.8

snapsmrc398

 
Stable
  • No updates made. Automatic rebuild with a platform release.
  • Info tab added to accounts.
4.7

anaplan2179

 
Latest

Improved suggest lookup of Anaplan Snaps server files setting.

4.7

snapsmrc382

 
Latest

Updated the Anaplan Action Snap with a new output handling mechanism, Stream errors. Additionally, starting from 4.7 release, the default output handling mechanism is Stream errors. Prior to 4.7 release, the default mechanism was AllSuccess.

4.6

anaplan1874

 
Latest

Improved the error doc schema and error handling.

4.6

anaplan1870

  
Latest

Implemented new "Stream errors" mode.

4.6

anaplan1863

 
Latest

Resolved an issue with the Anaplan Action Snap failing with Java Heap Space.

4.6

snapsmrc362

 
Latest

Extended support for a der encoded representation of Anaplan Certificate for Anaplan account validation. Anaplan Action Snap is enhanced to support handling of output during an import action. If an import operation is unsuccessful, rows without an error are written to the output view, and rows with an error are written to the error view.

4.5.1


 
Stable

No updates made. Automatic rebuild with a platform release.

4.5

snapsmrc344

 
Latest
  • Resolved an issue with some Anaplan Snaps stopping on error even when an error view was enabled.
  • Improved error handling and output information to the Snaps in the Anaplan Snap Pack.
  • Support for Upload only operation in Anaplan Write Snap to upload a file to a server without running an import job.
  • Doc Enhancement: Examples added to Anaplan Snap documentation.

4.4.1


 
Latest

Anaplan Action Snap updated to include "resolution" in error output.

4.4


 
Latest

Resolved a "String index out of range" issue in the Anaplan Write Snap.

4.3.2


 
Latest
  • NEW! Anaplan Upload Snap
  • Anaplan Write now outputs more details to error view.
  • Resolved an issue in the Anaplan Read Snap where the suggested values for Export ID came back null.
  • Resolved an issue with the Anaplan Write Snap failing when writing to the error output view.
  • Resolved an issue with the Anaplan Action Snap not showing a list of the processes during Suggest.

4.3.1


 
Latest
  • Resolved an issue with Anaplan Write Snap's error handling in some cases producing inaccurate information.
  • Resolved null pointer exceptions in the Write Snap.
  • Server filename is now suggestible.
  • Migration impact: The output of the Write Snap is now a document instead of a string. Any pipelines using Anaplan Write along with a downstream Snap that is parsing the Anaplan Write output it will have to be reworked to use the new document map.
4.3
 
Latest

Migration Impact: The Anaplan Read Snap now writes the Anaplan file data read into the binary output view as a stream. This was done to resolve an issue with the Snap generating all column values into a single column.4.2.2


4.2.1


 
Latest
  • Resolved an issue with the Anaplan Write Snap skipping the first row.
  • Resolved an Anaplan Exception when writing from a database to Anaplan.
  • Resolved an issue with requests routing to error view but the file getting imported into Anaplan instance.
  • Migration Impact: The Anaplan Read Snap now writes the Anaplan file data read into the binary output view as a stream. This was done to resolve an issue with the Snap generating all column values into a single column.


June 2015 Latest

Anaplan action Snap should work for Anaplan processes as well.June 6, 2015 (2015.20)



March 2015

Latest

Anaplan accounts now work with Anaplan certificates



December 2014

Latest

NEW! Anaplan Action & Write



October 2014

Latest

NEW! Anaplan Read (Beta)