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:

Flow


Description:

This Snap receives SAP IDoc requests and sends the IDoc data contained in the requests to the output view. 

SAP IDoc Listener runs a JCo IDoc server that listens and receives IDoc requests, which means once a pipeline with an SAP IDoc Listener Snap is started, the pipeline won't finish and the user needs to stop the pipeline manually when needed.  

If Include header is checked, the TID (Transaction ID) of a IDoc request will be put in a header object along with the IDoc with the key as "tid" and sent to the output view. 

This Snap records logs of JCoDestination's connection pool's status each time it receives an IDoc request. The logs can be seen in Dashboard.

  • Expected downstream Snaps: Any snap that have a Document input view
  • Expected output: Document that contains segments of IDoc. For preview during validation, the output will be a mocked Document that shows the schema of IDoc type specified.


Prerequisites:

The SAP Snaplex machine's service file should be configured for the SAP gateway service:

Unix/Linux: /etc/services
Windows:    c:\windows\system32\drivers\etc\services


You need to add the SAP Gateway service entry to the file. For example, if the Gateway service is sapgw01, the line entry like this should be added to the file: 

sapgw01         3301/tcp
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 Configuring SAP Accounts for information on setting up this type of account.


Views:


InputThis Snap has no input views. Input IDoc data is sent by remote clients.
OutputThis Snap has exactly one document output view that is populated with IDoc document. If the Import header property is enabled, there will be a header object with tid placed alongside the IDoc document.
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.


Gateway host

Required. The address of SAP gateway host on which the IDoc listener will be registered.

Example: sap.cloud.com

Default value: N/A


Gateway service

Required. The SAP gateway service, usually in the format of "sapgwNN", in which NN stands for two digits.

Example: sapgw01

Default value: N/A


Program ID

Required. Program ID used to register the Snap as a JCo IDoc server in the Snap on SAP gateway server.

Example: Snaplogic

Default value: N/A


Connection count

Required. The count of the registered connections managed by the JCo IDoc server in this Snap. 

Example: 4

Default value: 2


Router string

The SAP router string to be used to access a system protected by a firewall. Such systems can only be reached using an SAP router when registering the server at the gateway of the ABAP server associated with the system. A router string typically has the following format: /H/firewall.hostname/H/.

Default value: N/A


Max request attempts

This property defines 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.

Example: 300

Default value: 300

Maximum: 1800

Max startup delay

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

Enable trace

Select this check box to activate JCo traces, which retrieves information about the methods invoked and the data passed through the underlying communication layers throughout the call. This information can help you analyze errors that are related to connection issues associated with the Snap's execution.

Default value: Deselected

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


Multiexcerpt macro
hiddenfalse
nameHalt on SAP Error
fallbackfalse

Halt on SAP error



Multiexcerpt macro
hiddenfalse
nameHalt_on_SAP_Error_Description
fallbackfalse

Select this checkbox to enable the Listener to interrupt and halt processing when the Snap encounters a non-connection error.

We recommend you to select this checkbox when the Max request attempts is greater than 0 and you want the Snap to fail on any error received by the Listener. Zero indicates to continue to retry and not interrupt on any errors (infinite retries).

Default Value: Deselected


Advanced JCo Server Properties
Multiexcerpt include macro
nameAdvanced JCo Server Properties
pageSAP RFC Listener
Property Name
Multiexcerpt include macro
nameJCo Server Property Name
pageSAP RFC Listener
Property Value
Multiexcerpt include macro
nameJCo Server Property Value
pageSAP RFC Listener
Include header

If enabled, a header object containing tid will be generated in the output document.

Default value: false


Basic type for preview

Specify the IDoc basic type that need to be shown in preview during validation. This property works only for validation. If this is empty, then no preview will be generated.

Default value: N/A


Extension type for preview

Specify the IDoc extension type that need to be shown in preview during validation. This property works only for validation. This property must be used with basic type for preview.

Default value: N/A


Segment types for preview

Specify segment types that need to be shown in preview during validation. This property works only for validation. This property must be used with basic type for preview.

Default value: N/A


Multiexcerpt include macro
nameSnap Execution
pageAnaplan Read


Multiexcerpt include macro
nameSnap_Execution_Introduced
pageAnaplan Read

Examples


In this pipeline, the SAP IDoc Document Listener Snap sends the documents to an output view that shows the schema of a specified IDoc type. The output is then written to a file using the File Writer Snap.

On the Snap settings, provide the Basic type of the IDoc, DEBMAS07,  Extension type, ZDEBMAS07, and the Segment type, E1KNA1H to be shown during the validation. Note if the Segment type is not provided with, the Snap displays all the segment types of the IDoc.

Image RemovedImage Added


The output preview from the Snap:

   

Downloads

Multiexcerpt include macro
namedownload_instructions
pageOpenAPI

Attachments
patterns*.slp, *.zip

Insert excerpt
SAP Snap Pack
SAP Snap Pack
nopaneltrue