Step 1 – Analyses Hierarchy Levels:
Analyses the data relationships being processed in the interface. Define the appropriate hierarchical Parent-to-Child relationships.
Navigate to transaction code WEDI
Transaction WEDI displays the IDOC main menu. This allows navigation around the various development and control areas to create a customized IDOC.
Step 2 – Create a new segment:
via wedi : Development - IDOC Segments or Transaction code WE31.
• Enter segment name and click on Create.
Name of theÞthe segment type must start with Z1, and have a maximum of eight characters.
• Enter description and enter the relevant field names and data elements.
The each field in theÞsegment should represent a structure in the program so for segment a field name and a data element must be defined.
• Save the segment and enter Person Responsible and Processing Person.
• Go to Edit and Set Release.
• Repeat this procedure for each new Segment in the IDOC.
Step 3 – Create a new IDOC Type
via wedi Development - IDOC Types or Transaction WE30.
• Enter segment name (starting with Z), click on Basic Type and then Create.
• Create as new, enter Person Responsible and Processing Person and enter description.
• On ‘Create Basic Type’ screen decide where segments should be inserted and go to Edit/Create Segment.
• Complete relevant fields in the Maintain Attributes screen:
• From the relevant segments created in Step 2 enter the Segment type and if mandatory segment.
• The Minimum and Maximum number of segments to be allowed in the sequence. (One minimum and one maximum if segment is mandatory).
• The Parent Segment and Hierarchy Level will be automatically created depending on where in the IDOC tree you decided to create that particular segment.
• Repeat this process for each segment needed in the IDOC type, deciding whether to add the next segments at the same level or as a ‘Child’.
• When IDOC created return to initial screen. Go to Edit and Set Release.
• Go to Transaction WE60 to view the IDoc Type you have created.
Step 4 – Create new Message Type
via wedi Development - Message Types or Transaction WE81.
• Display/Change and click on New Entries
• Create a new Message Type and Save.
Step 5 – Link Message Type to IDOC Type
via wedi Development - IDOC Type/Message or Transaction WE82.
• Display/Change and then click on New Entries.
• Enter Message Type, Basic Type (IDOC Type) and Release (46C) and Save.
Step 6 – Create an entry in EDP13 via transactions WE20 and BD64.
The partner profile for the Idoc must be set up and generated in the transaction BD64 and transaction WE20.
• WE20 – Add Message Type to appropriate Partner Type, Enter Message Type,
• BD64 – Create a Model View, Enter Sender and
Step 7 – Populate the custom IDOC via ABAP Program
See Test Program ZOUTBD_IDOC_TEMPLATE, Appendix IV.
• Create an Internal Table for each segment type, this should be exactly the same structure as the segment type.
• The control record is filled into a structure like EDIDC. The message type and the Idoc type for the Idoc must be populated into the eddic structure.
- PERFORM populate_Control_structure USING c_mestyp
• The data segments are filled into a structure like edidd-sdata; sdata and the segment name are populated into the eddied structure.
- PERFORM transfer_Parent_data_to_seg.
• The standard SAP function module MASTER_IDOC_DISTRIBUTE is called to pass the populated IDOC to the ALE Layer.
- PERFORM master_idoc_distribute.
• NOTE: This function module is only called for stand alone programs and Shared Master Data programs (SMD). It is not called when using extensions or output determination.
• The ALE Layer handles the sending of the IDOC to the receiving system.
• Error handling (see Step 7b).
• Commit work.
Project Specific Step 7b – Error Handling
• Analyze which fields in the interface are mandatory for the receiving system and who needs to receive error notification.
• Declare a structure of type ‘MCMAILOBJ’ for sending instructions.
• Enter values for the internal table based on structure ‘MCMAILOBJ’
• for selection processes, on SY-SUBRC checks and where fields are mandatory for the receiving system; insert Function Module ‘MC_SEND_MAIL’.
• Enter values in the following parameters: -
MS_MAIL_SENDMODE = ‘B’ (Batch Mode)
MS_MAIL_TITLE = 'Mail Title'
MS_MAIL_DESCRIPTION = ‘Error description’ (e.g. MATNR not given)
MS_MAIL_RECEIVER = ‘Name of Receiver’ (To be determined)
MS_MAIL_EXPRESS = ‘E’ (Express Delivery)
MS_MAIL_DLINAME = Leave Blank
MS_MAIL_LANGU = 'E' (Lang usage)
MS_MAIL_FUNKOBJ_NAME = Leave Blank
MS_MAIL_CONT = I_MCMAILOBJ
It has to be determined separately for each interface how these errors and mail notifications are to be grouped – dependant upon the number of errors that are potentially likely. One possible approach is to send an email for each reason for rejection and include all the records that failed for that reason in the mail notification. Another possible approach is to send an email for every failure.
When error checking for mandatory fields it is common SAP practice to reject a record on its first failure (irrespective of subsequent errors in that record)
Step 7c – Send status mail
• Append to table I_MCMAILOBJ details of the time the interface was processed, how many Idocs were created and how many of these produced a status of 03.
• Select the user to receive the mail from ZINT_RECEIVER, using the name of the program as a key (SY-CPROG).
• Use function Module ‘MC_SEND_MAIL’ to send a mail to the user containing the contents of I_MCMAILOBJ at the end of the interface processing.
Step 8 – Test the population of the custom IDOC
via wedi IDoc - Display IDoc or Transaction WE02.
• Enter your message type and execute.
• Status should be green, double click on one of the Idocs you have created to view its contents.
• If a problem has occurred click on Status which will give you a description of the error.
• Drop down Data Records arrow and this should list the data in the IDoc in the correct hierarchical structure.
• Click on each individual segment and view the content to check that the correct data has been read.
• If you have UNIX access by using AL11 you can view the file that you have created.
For some interfaces it may be valid to send an empty file to SAP. This empty file is converted to the custom IDOC format expected by SAP. This custom IDOC will contain dummy information. In the inbound processing code, if the dummy information is identified then the processing of the IDOC is considered to be complete and the IDOC should then be assigned a successfully processed status of 53, even though it has not been processed at all.
2.2 Inbound Interface
Follow steps 1 to 5 inclusive as detailed above in outbound interface.
Write a custom function module to handle custom inbound processing. This custom function module must
• Check for the correct message type
• Read the IDoc data segment
• Perform data conversion and validate the data as appropriate
• Post the data to the database
• Handle any error situations
• Set the correct return values for the status record
Note that the Function Module must not make a commit to the database. This is because the status record is not written until control returns to the ALE layer. So if you commit work in the Function Module and an error occurs in returning to the ALE Layer, the status record must not be updated with a successful outcome.
The commit work is executed in the ALE Layer after the status records are updated, via the standard SAP function module IDOC_INBOUND_PROCESS. This attributes of this function module are set up in (Transaction BD51), click on ‘New Entries’ and fill in data; the main input parameters being ‘Input Type’ and ‘Dialog Allowed’.
Take care as some standard SAP transactions contain a Commit Work as part of their processing. Therefore using a BDC to process inbound data to SAP may not be acceptable. You need to check that the SAP transaction is ALE enabled.
Assign the custom function module to the IDoc type and the message type.
Set function module to type ‘F’ and direction ‘2’ for inbound.
Create a new process code and assign it to the function module. The process code determines how the incoming IDoc is to be processed in SAP.
Assign the function module to the process code created above. Got to ‘New Entries’ and enter the process code and the function module name.
(Transaction WE20 and Transaction BD64)
Create a partner profile for your message and ensure that in transaction WE20 the process code is the one that points to your function module. (See step 6 of creating Outbound Idocs).
Ensure that error handling functionality is present.
If an interface is expecting a file every day, and a custom IDoc may only be output from SAP periodically, it would be necessary to create some kind of output from SAP on a daily basis to pass to Mercator to allow it to map to an empty file. As we are dealing with custom IDoc types we can design the IDoc so that the data segments are not mandatory. Therefore the SAP program, on finding no data to populate the custom IDoc, would only need to create the control record. The empty IDoc containing the control record would be passed to Mercator. Mercator will map this to an empty file format.
Useful Transaction Codes:
WEDI : IDoc Menu
WE02 : IDoc List (can enter IDoc number to select on)
WE05 : IDoc List
WE19 : Transaction WE19 can be used to test the IDoc
WE30 : IDoc Type Development: Initial Screen
WE31: Development Segments: Initial Screen
WE60 : Documentation for IDoc Types. This allows you to view the IDoc you have created.
WE81: Display View ‘EDI: Logical Message Types’: Overview
WE82: Display View ‘Message Types and Assignment to IDoc Types’: Overview
For Outbound ALE Configurations: (Example)
IDoc definitions and necessary ALE configurations settings for the outbound.
Create Idoc segments – Transaction WE31.
Create Idoc type – Transaction WE30.
Create Message Type – Transaction WE81.
Assign Message Type to Idoc type – Transaction WE82.
Create a distribution Model - Transaction BD64
Update outbound parameters of the Partner profile – Transaction WE20
For the Logical system A for the above two message types update the partner profile.
For each message type specify the Port and the IDoc types.
( Note : Port definition need to maintained using transaction WE21 and
it has to be defined as a Transactional RFC port with RFC destination for
system specified, which need to be maintained using SM59 ).