You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
<!-- description --> Create a simple IDoc interface to enable monitoring IDocs with SAP Application Interface Framework.
11
+
10
12
## Prerequisites
11
13
- You have set up SAP Application Interface Framework
12
-
-You have working IDoc communication in place
13
-
-SAP S/4HANA 1709 or later, AIF 4.0
14
+
-SAP S/4HANA 1709 or later, SAP Application Interface Framework 4.0
15
+
-Optionally: You have a working IDoc communication in place
14
16
15
-
## Details
16
-
### You will learn
17
+
## You will learn
17
18
- How to create a simple IDoc interface
18
19
- How to use the IDoc Structure Generator
19
20
- How to set up IDoc monitoring in SAP Application Interface Framework
20
21
22
+
## Intro
21
23
In this tutorial, you'll learn how to create a simple IDoc interface that enables you to set up IDoc monitoring. In this process, you'll use the IDoc Structure Generator to create interfaces to display and process IDocs.
22
24
25
+
> If you don't have a working IDoc scenario in place, the first three steps show you how to set up the IDoc communication with the IDoc message type `FLCUSTOMER_CREATEFROMDATA`. Otherwise, you can skip the first three steps and set up the customizing based on your existing IDoc communication.
26
+
23
27
---
24
28
25
-
[ACCORDION-BEGIN [Step 1: ](Create namespace)]
29
+
### Create RFC destination
30
+
31
+
32
+
Open your system. Go to **Configuration of RFC Connections** (transaction `SM59`) and choose **Create**.
33
+
34
+
Enter a destination name following the naming convention `<SID>CLNT<client>`, with `<SID>` being your system ID and `<client>` the client number of your system. As **Connection Type**, choose `3 RFC connection to ABAP system`. Choose **Continue**. The settings for your newly created destination open.
35
+
36
+
Switch to the **Logon & Security** tab. Maintain **Language** and **Client** and set the `Current User` flag.
Go to **Ports in IDoc processing** (transaction `WE21`), select the **Transactional RFC** node and choose **Create** to create a new port.
46
+
47
+
In the upcoming dialog, choose `Generate port name` and then **Continue**.
48
+
49
+
Maintain a description and in the field **RFC destination**, enter the destination you created in the previous step.
50
+
51
+
52
+
53
+
**Save** your changes.
54
+
55
+
56
+
### Create partner profile
57
+
58
+
59
+
Go to **Partner profiles** (transaction `WE20`) and choose **Create**.
60
+
61
+
Enter a **Partner no.**, following the naming convention `<SID>CLNT<client>`, `<SID>` being your system ID and `<client>` being the client number of your system. As **Type**, choose `LS` (Logical System).
62
+
63
+
In tab **Post Processing: Valid Processors**, enter **Ty.** (agent type) `US` (User). As **Agent**, enter your user name.
In the **Inbound** table, choose **Create inbound parameter**. In the upcoming screen, choose or enter **Message Type**`FLCUSTOMER_CREATEFROMDATA` and **Process Code**`BAPI`. Lastly, for **Processing by Function Module**, choose `Trigger immediately`.
Navigate back to the partner profile and **Save** your changes.
72
+
73
+
74
+
### Create namespace
75
+
26
76
The **IDoc Structure Generator** is a report that generates most of the required customizing settings for SAP Application Interface Framework. To be able to use it correctly, you require a namespace.
27
77
28
78
Open your system. Go to **Customizing** for SAP Application Interface Framework (transaction `/n/AIF/CUST`) and navigate to **Interface Development** > **Define Namespace**.
@@ -37,10 +87,9 @@ Select **New Entries** and enter the following name and description for your new
37
87
38
88
Press **Enter** to confirm your entry.
39
89
40
-
[DONE]
41
-
[ACCORDION-END]
42
90
43
-
[ACCORDION-BEGIN [Step 2: ](Create package)]
91
+
### Create package
92
+
44
93
For the next steps, you need to create a package that serves as the destination for your newly created objects.
45
94
46
95
Go to the **Object Navigator** (transaction `SE80`). From the drop-down menu, select **Package**, enter the name **`ZDEMO`**, and press **Enter** or select **Display or Create Object**. Confirm the dialogue window, enter a meaningful short description for your new package, and select **Confirm**. If prompted, enter a workbench request and confirm again.
@@ -49,10 +98,9 @@ Go to the **Object Navigator** (transaction `SE80`). From the drop-down menu, se
49
98
50
99
You have successfully created a new package named `ZDEMO`.
51
100
52
-
[DONE]
53
-
[ACCORDION-END]
54
101
55
-
[ACCORDION-BEGIN [Step 3: ](Generate DDIC structure and interface)]
102
+
### Generate DDIC structure and interface
103
+
56
104
Internally, SAP Application Interface Framework works with DDIC structures, but IDoc Basic Types are not available as DDIC structures. However, the IDoc Structure Generator can create the required DDIC structure for a specific basic type and extension combination.
57
105
58
106
Open the **IDoc Structure Generator** (transaction `/n/AIF/IDOC_GEN`) and enter the following general information about the IDoc you want to monitor:
@@ -85,7 +133,7 @@ In section **Interface Definition**, enter the following details:
85
133
86
134
| Field name | Description | Value
87
135
| :--------- | :---------- | :-------------
88
-
| Namespace | An existing namespace in which the interface should be created | **`DEMO_1`** (the namespace created in step 1)
136
+
| Namespace | An existing namespace in which the interface should be created | **`DEMO_1`** (the namespace created in step 4)
89
137
| Interface Name | The name of the to be created interface, for example (an abbreviation of) the basic type | **`FCUSTOMER`**
90
138
| Interface Version | The version number of the interface | **`1`**
91
139
| Interface Description | The short description of the interface | your short description
@@ -98,10 +146,9 @@ When you've entered all the details, press **F8** or select **Execute**. The IDo
[ACCORDION-BEGIN [Step 4: ](Create interface-specific single index table)]
150
+
### Create interface-specific single index table
151
+
105
152
106
153
It's recommended to implement an interface-specific single index table to ensure full flexibility, especially if you expect a high load of messages or if you plan to define key fields for your interface (now or later).
107
154
@@ -123,10 +170,9 @@ Select **New Entries** to create a new entry in **Define Interface-Specific Feat
123
170
124
171
**Save** your changes.
125
172
126
-
[DONE]
127
-
[ACCORDION-END]
128
173
129
-
[ACCORDION-BEGIN [Step 5: ](Create recipient for interface)]
174
+
### Create recipient for interface
175
+
130
176
If you want to monitor the newly created interface in the Interface Monitor of the Message Dashboard app, a recipient for the interface is required.
131
177
132
178
Go to **Customizing** (transaction `/AIF/CUST`) and navigate to **SAP Application Interface Framework** > **Error Handling** > **Define Namespace-Specific Features**. Enter or select your namespace **`DEMO_1`** and select **Continue**.
@@ -137,10 +183,9 @@ In the menu on the left, navigate to **Define Recipients** by double-clicking it
137
183
138
184
**Save** your changes.
139
185
140
-
[DONE]
141
-
[ACCORDION-END]
142
186
143
-
[ACCORDION-BEGIN [Step 6: ](Assign recipient to interface)]
187
+
### Assign recipient to interface
188
+
144
189
145
190
To be able to see any data in the Interface Monitor or the Message Dashboard, a recipient must be assigned to the interface you want to monitor.
146
191
@@ -154,10 +199,9 @@ In the menu on the left, double-click **Assign Recipients Without Key Fields** a
154
199
155
200
**Save** your changes.
156
201
157
-
[DONE]
158
-
[ACCORDION-END]
159
202
160
-
[ACCORDION-BEGIN [Step 7: ](Assign users to recipient)]
203
+
### Assign users to recipient
204
+
161
205
162
206
Now the users in charge of monitoring the IDoc must be assigned to the recipient.
163
207
@@ -171,38 +215,57 @@ Create a new entry and select the namespace and recipient you created in the ste
171
215
172
216
**Save** the new entry.
173
217
174
-
[DONE]
175
-
[ACCORDION-END]
176
218
177
-
[ACCORDION-BEGIN [Step 8: ](Test IDoc interface)]
219
+
### Test IDoc interface
220
+
221
+
222
+
After the setup is complete, test your settings and verify that the IDoc monitoring is working as planned.
223
+
224
+
1. Send in new test IDocs, for example using the **Test Tool for IDoc Processing** (transaction `WE19`).
225
+
226
+
2. In the test tool, maintain basic type `FLCUSTOMER_CREATEFROMDATA01`.
227
+
228
+
3. Maintain the control record fields corresponding to your partner profile and the port created beforehand as follows:
178
229
179
-
After the setup is complete, you should test your settings and verify that the IDoc monitoring is working as planned.
230
+
| Field name | Value
231
+
| :---------------------------- | :-------
232
+
| Receiver Port | `SAP<SID>` (`<SID>` being your system ID)
233
+
| Receiver Partner Number | The partner number as specified in the partner profile
234
+
| Receiver Type | `LS`
235
+
| Sender Port | The port as specified before
236
+
| Sender Partner Number | The partner number as specified in the partner profile
237
+
| Sender Type | `LS`
238
+
| Message Type | **`FLCUSTOMER_CREATEFROMDATA`**
180
239
181
-
Send in new test IDocs, for example using the **Test Tool for IDoc Processing** (transaction `WE19`).
240
+
182
241
183
-
If you're using SAP GUI, check the results of your test in the **Interface Monitor** (transaction `/n/AIF/IFMON`). You'll only be able to see the new interface if you correctly assigned your user to the recipient.
242
+
4. Maintain sample data record by entering at least customer name, form, street, postcode, city, country and customer type. As customer type, choose either `B` or `P`.
184
243
185
-
244
+
186
245
187
-
When you select the summary line for your recipient, you're forwarded to **Monitoring and Error Handling**, where you can see your selected test message(s).
246
+
5. Then, select **Standard Inbound**. A dialog pops up informing you that the IDoc was passed to the application.
188
247
189
-
248
+
6. If you're using SAP GUI, check the results of your test in the **Interface Monitor** (transaction `/n/AIF/IFMON`). You'll only be able to see the new interface if you correctly assigned your user to the recipient.
190
249
191
-
Alternatively, if you're using SAP Application Interface Framework with SAP Web Dynpro, you can check the test results on the **Message Dashboard** (transaction `/n/AIFX/ERR_WEB`).
When you select the summary line for your recipient, you're forwarded to **Monitoring and Error Handling**, where you can see your selected test message(s).
194
253
195
-
Here, too, selecting the summary line for your recipient forwards you to **Monitoring and Error Handling**, where you can see your selected test message(s).
7. Alternatively, if you're using SAP Application Interface Framework with SAP Web Dynpro, you can check the test results on the **Message Dashboard** (transaction `/n/AIFX/ERR_WEB`).
Here, too, selecting the summary line for your recipient forwards you to **Monitoring and Error Handling**, where you can see your selected test message(s).
0 commit comments