Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

On this Page

Table of Contents
maxLevel2
excludeOlder Versions|Additional Resources|Related Links|Related Information

Snap type:

Write

Description:

This Snap is used to run an action in Anaplan, such as a delete action.

  • Expected upstream Snaps: Any document processing Snap, such as a Mapper Snap.
  • Expected downstream Snaps: Optional Snap that reads the output result of the Write operation and performs follow-up actions.
  • 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 output: Datetime finished, Failure or success message with any details provided by Anaplan. 
Prerequisites:

None

Support and limitations:

Works in Ultra Task 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 at most 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.

Note

Workspace ID and Workspace Name can be used interchangeably.

Default value: N/A

Model


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

Note

Model ID and Model Name can be used interchangeably.


Default value: N/A

Action name


Required. The name of the action to run.

Default value: N/A

Output Handling


Required. This setting only applies to import actions. The acceptable values are AllSuccessMixed, & Stream Errors

  • AllSuccess: If the import action was successful with no errors/warnings, records are written in the output view. Else, the error messages and details are written to the error view.
  • Mixed: If an error occurs in the import action, the import file is downloaded and compared with the error records. Rows without an error are written to the output view, and rows with an error are written to the error view.
  • Stream errors: If the Action fails, the error documents will be posted to the error view, one error document for each error record, and a task result summary document will be posted to the output view.


Note

The error document schema in the Stream errors mode is different from the ones in other modes. Prior to 4.6.0 release, this property did not exists and its equivalent default behavior was AllSuccess. Therefore, the pipelines that existed prior to 4.6.0 will automatically be set to Stream errors and might fail if the downstream Snaps at the error view of this Snap have dependency in the error document schema.

Default value:  Stream errors

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

Multiexcerpt include macro
nameSnap Execution
pageSOAP Execute

Multiexcerpt include macro
nameExecution_Detail_Write
pageSOAP Execute

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 Action Snap executes an Anaplan operation that is defined and configured in your Anaplan Workspace. In this example, an existing action, Delete the Sales - Customer 1.csv File, is triggered and executed. This action is configured to delete file data from the Anaplan Workspace, SnapLogic QA, and Model, Anaplan Snap Test

After a successful validation of the Snap, you will see a data preview that gives the status of executed Anaplan action and its details: 

Excerpt Include
Anaplan Snap Pack
Anaplan Snap Pack
nopaneltrue