On this Page
Table of Contents | ||||
---|---|---|---|---|
|
Snap type: | Write | ||||||
---|---|---|---|---|---|---|---|
Description: | This Snap writes an SAP IDoc to the configured SAP server. Because IDocs are processed asynchronously on the server, Polling interval and Polling timeout are additional configurations that define how to get the processing status. Expected upstream Snaps: The Control record fields of the IDoc Write Snap input view can be mapped using an upstream Mapper Snap. Expected downstream Snaps: The Snap will output one document for every IDoc write operation, hence any document processing Snap can be used down stream. Expected input: Document that conforms to the input view schema of the Snap. The input view schema is provided to an upstream Mapper Snap based on the selected service object. Expected output: Document which represents the record structure of the retrieved IDoc record output definition. Each IDoc write record is represented as one document on the output view.
| ||||||
Prerequisites: | To make the IDoc Listener snap work with SAP, we have to configure the RFC destination in SAP to use Unicode to communicate with the target system. The way to set this up, is through the SM59 transaction in SAP. choose the RFC destination being used. In the Unicode tab, set Communication Type with Target System as Unicode. | ||||||
Support and limitations: | |||||||
Account: | This Snap uses account references created on the Accounts page of SnapLogic Manager to handle access to this endpoint. See Configuring SAP AccountAccounts for information on setting up this type of account. | ||||||
Views: |
| ||||||
Settings | |||||||
Label | Required. The * | Specify 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 pipelinePipeline. | |||||
IDOC* | Required. The Specify the SAP IDoc type to write. Default Value: N/A | ||||||
IDOC Extension type | The Specify the IDoc Extension Write type is an extension of an associated IDOC type. If the IDoc specified in the "IDOC" Setting needs to be written with a specified custom extension type, provide a valid extension type in addition to the valid IDOC type with which the custom type is associated. The Snap displays an error in the following cases:
Default Value: N/A | ||||||
Success codes* | Required. This property defines Specify the comma-separated status codes (with a leading 0) that are considered to be successful for the Snap execution. ExampleDefault value: 01,03Default value: 01,03,06,08,10,11,13,14,16,18,22,24,30,32,33,,35,38,39,41,50,53,55,62,64,66,69,70,71,73,75
| ||||||
Polling interval | This property defines Specify the polling interval in seconds for obtaining the IDoc processing status. At At each polling interval, the Snap checks the status of the IDoc processing. A value of 0 indicates no polling for the IDoc processing status. ExampleDefault Value: 5 Maximum: 60 | ||||||
This property defines Specify the polling timeout in seconds for obtaining the IDoc processing status. If the timeout occurs while waiting for the status, the Snap displays a SnapExecutionException. ExampleDefault Value: 300 Maximum: 1800 | |||||||
IDoc Read BAPI Name | Specify a name for IDOC Read BAPI Name. This field is based on the “IDOC_READ_COMPLETELY” SAP function, which reads the details associated with an IDoc. Default Value: Z_SNAP_IDOC_READ_COMPLETELY | ||||||
Max request attempts | Required. The Specify the maximum number of SAP connection attempts in case of a failure. When you enter 0 is entered, the Snap tries for makes infinite times for the connection attempts. Default valueValue: 3 | ||||||
Request retry interval | The Specify the time in seconds to wait before retrying the request. | ||||||
Route errors | Writes Select this checkbox to write configuration errors to the error view. If If the error is non-recoverable, especially connection errors such as exception handling would be routed to the error view with relevant information. Default valueValue: Not Not selected | This property enables you to execute the Snap during the Save operation so that the output view can produce the preview data. Default value: Not selected |
title | Clearing Cache for the Snaplex |
---|
To load a new or updated IDoc, the cache needs to be cleared for the Snaplex. Instead of restarting the JCC to access the refreshed metadata, running the following pipeline (download) can help clear the cache. This pipeline informs all nodes in the Snaplex that their respective SAP metadata cache is stale. This action can take a moment to propagate to all nodes in the Snaplex. A Snap in a node, on the next run, will automatically clear the cache for the given node, display the IDoc version, and populate the current schema.
Reload IDoc Metadata | Select this checkbox to reload the metadata (latest schema) for the current BAPI function before executing the BAPI function.
| ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|
Examples
We will provide one example that executes an SAP IDoc write operation for a given input.
First we provide the input to the SAP IDoc Write Snap, as defined below.
The SAP IDoc Write Snap is configured as:
Which results in:
Downloads
Multiexcerpt include macro | ||||
---|---|---|---|---|
|
Attachments | ||||||
---|---|---|---|---|---|---|
|
Insert excerpt | ||||||
---|---|---|---|---|---|---|
|