On this Page
| Table of Contents | ||||
|---|---|---|---|---|
|
| Snap type: | Read | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Description: | This Snap reads an SAP IDoc of the configured SAP server. The IDoc property provides the output view schema.
Expected upstream Snaps: The DOCUMENT_NUMBER field can be mapped using an upstream Mapper Snap, which will provide the IDoc number(s) to be read from SAP. Expected downstream Snaps: The Snap will output one document for every IDoc read 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 read record is represented as one document on the output view. | ||||||||||||
| Prerequisites: | |||||||||||||
| 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 Configuring SAP Accounts for information on setting up this type of account. | ||||||||||||
| Views: |
| ||||||||||||
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. | ||||||||||||
iDoc Read BAPI Name | Required. An IDOC Read BAPI name that is based off the SAP-delivered IDOC_READ_COMPLETELY BAPI property and containing the same input. In SAP, clone the IDOC_READ_COMPLETELY BAPI to Z_SNAP_IDOC_READ_COMPLETELY to make the default value work. Typically done in se37 transactions by users who have SAP programmatic access. Example: Z_SNAP_IDOC_READ_COMPLETELY Default value: Z_SNAP_IDOC_READ_COMPLETELY
| ||||||||||||
| Max request attempts | Required. The maximum number of SAP connection attempts in case of a failure. When 0 is entered, the Snap tries for infinite times for the connection. Default value: 3 | ||||||||||||
| Request retry interval | The time in seconds to wait before retrying the request. Default value: 5 | ||||||||||||
Route errors | Writes configuration errors to the error view. If the error is non-recoverable, especially connection errors such as exception handling would be routed to the error view with relevant information. Default value: Not selected | ||||||||||||
|
| ||||||||||||
| Info | ||
|---|---|---|
| ||
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.
|
Examples
We will show one example on how to read an SAP IDoc record from SAP.
First we configure the Mapper Snap to define the IDoc number to read and to map it to the DOCUMENT_NUMBER field of the IDoc Read input view.
The SAP IDoc Read Snap is configure with the defaults.
Which will result in the following output:
| Note |
|---|
| The IDoc number is unique to the SAP system being used in the example, hence you must choose your own number for the SAP system being used. |
Downloads
| Multiexcerpt include macro | ||||
|---|---|---|---|---|
|
| Attachments | ||||||
|---|---|---|---|---|---|---|
|
| Insert excerpt | ||||||
|---|---|---|---|---|---|---|
|