Ale for Abapers

Saint- Gobain IBM Confidential : 2008

Application Link Enabling (ALE)

June, 2009ABAP Team (IBM India)

2 Saint – Gobain & IBM Confidential : 2008

Topics to coverTopics to cover

What is ALE ?

Components of ALE.

Anatomy of an IDoc.

ALE Processing

Transactions For Monitoring and Processing IDocs.

ALE in typical Project Scenario.

Questions


ALE!! What is it ??

It is a set ofIt is a set of Tools, programs and data definitions

that provides the mechanism for that provides the mechanism for distributing functionality and data across distributing functionality and data across multiple system.multiple system.


What Data can be Exchanged ?What Data can be Exchanged ?

Transaction Data–SD, MM, FI, CO, etc.

Master Data–Material, Customer, Vendor, etc.

Control Data–Organizational Reference Information

•Plants, Sales Orgs, etc.

Data required to enable tightly coupled, distributed applications

–Separate HR, Separate Treasury, etc.


What is ALE ?

Components of ALE.

Anatomy of an IDoc.

ALE Processing


Trouble Shooting


Questions



Components of ALE Components of ALE

Services:Services:

Application ServicesApplication Services

Distribution ServicesDistribution Services

Communication ServicesCommunication Services

Tools:Tools:

Customizing Tools Customizing Tools

Development ToolsDevelopment Tools



Services:Services:




Tools:Tools:



This is where the SAP applications ( SD, FI, MM etc. ) generate their data and documents



Services:Services:




Tools:Tools:



Recipients Formats and

Filters the data Creates IDocs

( Intermediate

Documents



Services:Services:




Tools:Tools:



•TCP/IP

•RFC

•tRFC

• etc



Services:Services:




Tools:Tools:



Model Maintenance Tool.

(for configuring the flow of data

between systems )Shared Master Data(SMD)tools

(for distributing master data ) Customization parameters

(within SAP for IDoc filtering and

conversion. )


Customizing ToolsCustomizing Tools

Services:Services:




Tools:Tools:


Development ToolsDevelopment Tools Tools for creating and modifying IDocs


Application Data

MasterIDOC Determine

Receipients

DetermineReceipients

Filter/ConvertData, Create IDOC

Filter/ConvertData, Create IDOC

Comm.IDOC

Application Functions

Application Functions

Filter/ConvertData

Filter/ConvertData

Comm.IDOC

CarrierCarrier

Application Layer

Application Layer

Distribution/ ALE Layer

Distribution/ ALE Layer

Communication Layer

Communication Layer

ApplicationApplication

In a Nut ShellIn a Nut Shell



What is ALE ?

Components of ALE.

Anatomy of an IDoc.

ALE Processing


Trouble Shooting


Questions


Control recordData RecordStatus Record

IDOC

“Intermediate Document”


The very first record of an IDoc package is always a control record. Thestructure of this control record of the structure EDIDC and describes the contents of the data contained in the package.

Control RecordControl Record


All records in the IDoc, which come after the control record, are the IDoc data. They are all structured alike, with a segment information part and a data part, which is 1000 character in length, filling the rest of the line.

Data RecordData Record


Status RecordStatus Record Information about the IDoc status like:IDoc identification numberStatus number - table verifiedIDoc typeDirectionData and time stamp


Idoc SegmentsIdoc Segments

TCODE:

WE31


Idoc TypesIdoc Types

TCODE:

WE30


How to Attach SegmentsHow to Attach Segments


Message TypesMessage Types

WE81WE82



What is ALE ?

Components of ALE.

Anatomy of an IDoc.

ALE Processing.

i.Outbound Processing

ii.Inbound Processing


Trouble Shooting


Questions


Outbound Processing


Outbound processing: directOutbound processing: direct

Application posting

Need to create IDOC?

Create master IDOC

Customer Distribution Model

Receiver determination

Segment filter

Field value conversion

Version change

ALE layer

Dispatch controlDatabase

M

Application document posted simultaneously with IDOCs

Comm. layer

asynch. RFCor

EDI

CLinks C

Comm. layer


Application posting


Create master IDOC



Segment filter


Version change

ALE layer


M

Application document posted simultaneously with IDocs

Comm. layer

asynch. RFCor

EDI

Links C

Querying the ModelQuerying the Model

asynch. RFCor

EDI

Comm. layer

C

- ALE supplies APIs (function modules) to allow applications to query the model

Is anybody interested in my message type? Optional: what filter objects are they

interested in?


Application posting


Create master IDOC



Segment filter


Version change

ALE layer


M


- The application creates the IDOCThe application creates the IDOC- Technically it is stored as an Technically it is stored as an

internal tableinternal table- Passed to ALE via an API Passed to ALE via an API

(function module)(function module)

Links C

Handover IDoc to ALEHandover IDoc to ALE

asynch. RFCor

EDI

C

Comm. layer


Receiver determinationReceiver determination

Application posting


Create master IDOC



Segment filter


Version change

ALE layer


M


asynch. RFCor

EDI

Links C

asynch. RFCor

EDI

C

Comm. layer

- If the application has no specified If the application has no specified recipientsrecipients ALE refers to the customer ALE refers to the customer

distribution model to determine distribution model to determine themthem

Data not relevant to receiver Data not relevant to receiver (according to model) is removed (according to model) is removed in ALE layer.in ALE layer.


Segment filterSegment filter

Application posting


Create master IDOC



Segment filter


Version change

ALE layer


M


asynch. RFCor

EDI

Links C

asynch. RFCor

EDI

C

Comm. layer

- The filter is data-independentThe filter is data-independent- IDOC segments that are not IDOC segments that are not

required can be removedrequired can be removed- The filter is message and receiver-The filter is message and receiver-

specificspecific


Field value conversionField value conversion

Application posting


Create master IDOC



Segment filter


Version change

ALE layer


M


asynch. RFCor

EDI

Links C

asynch. RFCor

EDI

C

Comm. layer

- The contents of individual The contents of individual fields can befields can be translated to new valuestranslated to new values suppressedsuppressed

- The filter is message and The filter is message and receiver-specificreceiver-specific


Version changeVersion change

Application posting


Create master IDOC



Segment filter


Version change

ALE layer


M


Comm. layer

asynch. RFCor

EDI

Links C

asynch. RFCor

EDI

C

Comm. layer

- IDOCs can be changed to older IDOCs can be changed to older versionsversions

- Systems with different release Systems with different release levels can communicate levels can communicate without additional application without additional application logiclogic


Make LinksMake Links

Application posting


Create master IDOC



Segment filter


Version change

ALE layer


M


CCLinks

asynch. RFCor

EDI

C

Comm. layer

- Links are written between IDOC Links are written between IDOC andand Application object contained Application object contained

in IDOCin IDOC Communication-Layer's Communication-Layer's

"Transaction-ID""Transaction-ID"


Dispatch controlDispatch control

Application posting


Create master IDOC



Segment filter


Version change

ALE layer


M


C

asynch. RFCor

EDI

Links C

asynch. RFCor

EDI

C

Comm. layer

- Technical comms parameters are Technical comms parameters are defineddefined

- EDI or aRFC (asynch. remote EDI or aRFC (asynch. remote function call)function call)

- Send immediately or cumulate Send immediately or cumulate and send via batch joband send via batch job If batch, packet size is If batch, packet size is

determineddetermined


Scenario analysisScenario analysis

• How does the IDOC look like ?

• How is data being sent ?

• How is the data being received ?


Outbound program development

• Program logic

– “How is the IDOC being IDOC created ?”

• Triggering

– “How is the IDOC creation kicked off ?”


Program logicProgram logic

• Select data from application tables• Fill data into IDOC • Pass IDOC to ALE layer (Call function MASTER_IDOC_DISTRIBUTE)• Commit Work

• Receiver determination• Segment filtering• Version Control• Dispatch Control

IDOC program

ALE layer

MASTER_IDOC_DISTRIBUTE


MASTER_IDOC_DISTRIBUTEMASTER_IDOC_DISTRIBUTE

Call function ‘MASTER_IDOC_DISTRIBUTE’ Exporting

master_idoc_control: IDOC control record

Tables

communication_idoc_control: returned information about the

distribution

master_idoc_data: IDOC data segments


Filling an EDIDD structureFilling an EDIDD structure

Header (55bytes) SDATA (1000bytes)…. SEGNAM ….EDIDD

Z1SEGField1 Field2 Field3 Field4

“10” “ABC”

MOVE “Z1SEG” to EDIDD-SEGNAMMOVE “10” to Z1SEG-FIELD1MOVE “ABC” to Z1SEG-FIELD2MOVE Z1SEG to EDIDD-SDATA


General Programming rulesGeneral Programming rules

Design Guidelines for creating IDOC data records:

• Left-justified filing of IDOC Fields

• Replacing SAP codes with ISO codes

currency keys

country keys

unit of measure

shipping instructions

• Converting Currency Amounts


Left-justified FillingLeft-justified Filling

All fields must be left-justified Character fields:

automatic

Non-character fields:

‘Condense’ statement must be used

Check IDOC documentation to find out which fields require a ‘condense’

All types unequal to ‘char’, ‘cuky’, ‘clnt’, ‘accp’, ‘numc’, ‘dats’, ‘tims’ or ‘unit’ require a condense


Code ConversionsCode Conversions

Replacing SAP codes with ISO codes

– Currency keys: ‘currency_code_sap_to_iso’– Country keys: ‘country_code_sap_to_iso’– Units of measure: ‘unit_of_measure_sap_to_iso’– Shipping instructions: sap_iso_package_type_code’

• Conversion of currency amounts– ‘currency_amount_sap_to_iso’


Filter ObjectsFilter Objects

BD95BD59


Sending Master Data IdocsSending Master Data Idocs

Only send objects that have changed ?

Change Pointeravailable?

Master data ?

Standalone with custom logic to keeptrack of changes

Change Pointerbased Program

y

N

Y

Standalone programwith user-definable selection criteria

N

Y


Sending Transactional Data IdocsSending Transactional Data Idocs

Ensure transactional Integrity?

Output Determination available ?

Transaction Data ?

hard coded ALElayerModification

Output determinationbased Program

y

N

Y

N

Y

User-Exitavailable?

N

Hardcoded ALE layerno Modification

Y

See Master data


Change Pointers Change Pointers

Application Posting

• Post Application document

• Create Change Document

• Are changes ALE relevant ?

•Write Change Pointers

• Commit Work

ALE configuration

• ALE relevant Fields

Batch Program(RBDMIDOC)

IDOC Module (Masteridoc_Create_SMD_<MSGTYPE>)

• Read Change Pointers• Fill IDOC• Call ALE layer• Update Change Pointer

Master data

Change pointers

ALE layerMaster_IDOC_DISTRIBUTE

• Determine IDOC module• Call IDOC module


Change PointersChange Pointers

BD61BD50


Change Pointers… ContinuedChange Pointers… Continued

BD52BD60


IDOC moduleIDOC module

IDOC module has to be implemented as function module

Naming Convention: MASTERIDOC_CREATE_SMD_<msgtype>

Function module reads change pointers information to get data that needs to go into IDOC

Function module logic:

Read change pointers

Fill IDOC structure

Call ALE layer

Update Change Pointer status

Commit Work


ALE Configuration For Change PointersALE Configuration For Change Pointers

• Define change pointer creation• Define which change document fields are to be logged

• Change pointer activation

• Activate generally

• Activate per message type

• “Publish” new function module• Link message type to function module


ALE For Transactional data ---- Output DeterminationALE For Transactional data ---- Output Determination

NACE


Output Determination -- Access SequenceOutput Determination -- Access Sequence


Output Determination -- Output TypesOutput Determination -- Output Types


Output Types -- DetailsOutput Types -- Details


Output Types -- Partner FunctionsOutput Types -- Partner Functions


Output Types -- Processing RoutinesOutput Types -- Processing Routines


Output Types -- ProceduresOutput Types -- Procedures


Output Types -- Procedures ControlOutput Types -- Procedures Control


Output Types -- Condition recordsOutput Types -- Condition records


Inbound Processing


Inbound Processing.Inbound Processing.

Application posting


ALE layer

Input control

Database

A

Simultaneously update IDOC's status

Comm. layer

asynch. RFCor

EDI

Version change

Segment filter

C

A

Post application document

Process IDOCSerialization


Input ControlInput Control

Application posting


ALE layer

Input control

Database

A


Comm. layer

asynch. RFCor

EDI

Version change

Segment filter

C

A



- For each message type and sender For each message type and sender one can defineone can define when to process when to process

(immediate/batch)(immediate/batch) whether to call application whether to call application

directly or start customer directly or start customer workflowworkflow

who should get work items in who should get work items in case of errorcase of error

- Incoming IDOC packets are passed to Incoming IDOC packets are passed to applicationapplication


Application InputApplication Input

Application posting


ALE layer

Input control

Database

A


Comm. layer

asynch. RFCor

EDI

Version change

Segment filter

C

A



- Inbound IDOCs are passed to Inbound IDOCs are passed to the application via a the application via a standardized function standardized function interfaceinterface


SerializationSerialization

Application posting


ALE layer

Input control

Database

A


Comm. layer

asynch. RFCor

EDI

Version change

Segment filter

C

A



- When processing the When processing the inbound IDOC, the inbound IDOC, the application can call an ALE application can call an ALE API (function module) to API (function module) to check that the IDOC has not check that the IDOC has not been overtakenbeen overtaken If change No. 1 arrives If change No. 1 arrives

after change No. 2, the after change No. 2, the IDOC containing it has IDOC containing it has been overtaken (by the been overtaken (by the IDOC containing the IDOC containing the later change)later change)


ALE Inbound configuration

IDoc controlrecord

IDoc typeSend. partnr typeSender partner no.Message typeMessage variantMessage functionTest flag

Sender typeSender no.Message typeMessage var.Message func.Fest flag

Process codeProcess typeError eventsAppl.obj.typeInbound func. Inbound func.

Input typeDialog?

Appl. obj. typeInbound func.

Message type

Message var.

Message func.

IDoc type

PartnerProfileinbound

Process codetables(inbound)

Functionmodule'sattributes

ALE functionmoduleregistry

Process code


FM Assignment to Message Type and IDoc typeFM Assignment to Message Type and IDoc type

TCODE:

WE57


Process CodesProcess Codes

WE41WE42


Process Codes in Inbound and OutboundProcess Codes in Inbound and Outbound

TCODE:

WE64


FM For Inbound EDI FM For Inbound EDI

TCODE:

BD67


Basic Configuration ElementsBasic Configuration Elements

Create and allocate Logical System Define Ranges (Idocs, Ports, etc ) Define RFC Destinations Define Ports Maintain Customer Model Create Partner Profiles


Logical SystemLogical System

TCODE:

BD54


Allocate Logical System to the clientAllocate Logical System to the client

SALE > BASIC SETTINGS > SET UP LOGICAL SYSTEM > ASSIGN LOGICAL SYSTEM TO THE CLIENT

TCODE:

SCC4


Number RangesNumber Ranges

Maintain number ranges for ports Maintain number ranges for IDocs Maintain number ranges for IDoc types and segment version Maintain number range for change pointers


Maintaining RFC DestinationsMaintaining RFC Destinations

TCODE:

SM59


Displaying and Maintaining PortsDisplaying and Maintaining Ports

A port is a logical representation of a A port is a logical representation of a communication channel in SAP with communication channel in SAP with the data communicated being IDocsthe data communicated being IDocs.

TCODE:

WE21


Partner ProfilesPartner Profiles

TCODE:

WE20


Partner Profiles-OutboundPartner Profiles-Outbound


Partner Profiles-InboundPartner Profiles-Inbound


Distribution ModelDistribution Model

TCODE:

BD64


Inbound Program DevelopmentInbound Program Development

INBOUND_IDOC_PROCESSIDOC

ALE layer

IDOC_INPUT_<MSGTYPE>

• Read IDOC data• Post Application data• Send Success info back to ALE layer

ALE configuration• Partner Profiles• Process Code• Function module attribute• Function module registry

Workflow Task

Call function

Return Variables

If ERROR, trigger

• Version change• Segment filter• Field conversion


ALE error handlingALE error handling

User action R/3 action

Execute Workitem

Fix error and reprocess IDocorFlag IDoc for deletion

Error in inbound function module

ALE triggers error event

Workitem appears in user's Inbox

Display IDoc for user processing

(IDoc method "InputForeground")

ALE triggers end event

Workitem completed

input Error Occurred

input Finished


ALE error handlingALE error handling

Necessary Steps: Create new object type in Business Object Repository for IDOC;

object is child of IDOCAPPL

Create new customer task

Create event-couplings linking

Event ‘inputErrorOccured’ linked to standard task

Event ‘inputFinished’ to function module

To support mass processing:

Create new object type as child of IDOCPACKET

Maintain process code to refer the above objects and events


Advanced Inbound TopicsAdvanced Inbound Topics

• Data consistency

• Serialization

• Individual vs. mass processing

• Call transaction function modules


Data ConsistencyData Consistency

• Problem:

– Ensure transactional integrity• Don’t process and IDOC twice• Allow for IDOC reprocessing after rollback of

application document posting

• Solution:

– Application document must be posted in the same LUW as the IDOC status records

– IDOC function module must not use a ‘Commit Work’


Data ConsistencyData Consistency

ALE Layer Applicationfunction module

Read IDoc(s)

Commit Work

Unlock IDoc(s) andapplication objects

Lock IDoc(s)

Write IDoc(s) statusWrite linksOptional:

Write serialization dataTrigger event(s)

Lock application objectsOptional: Serialization checkProcess IDoc dataWrite application data to DB



Receiver

1

2

1

2

Object X, changed twice:

First IDOC overtaken

Comm. LayerSender

!?

!?

Input from IDOC 1 must be prevented in order not to lose information from IDOC 2



Check, if IDOC has been overtaken Use function module ‘IDOC_SERIALIZATION_CHECK’

react to overtaken IDOCs according to your needs

Prerequisite is the definition of a serialization object


Mass ProcessingMass Processing

Processing more than one IDOC can improve throughput: more than one IDOC is processed per Commit Work

the function can be coded to add multiple entries to a table with one update command (‘array insert’)

Function module has to be coded in a way that it supports mass processing

Attribute of delivered function module specifies if mass processing is supported or not


Call TransactionCall Transaction

Pros: Error reprocessing in foreground

Easy to program

Cons: Call Transaction has significant performance overhead

Automatic Commit work, no data consistency

Recommendation: Try to use function modules that update database directly

If you want to use ‘Call transaction’, they have been ‘ALE-enabled’ to guarantee data concistency



What is ALE ?

Components of ALE.

Anatomy of an IDoc.

ALE Processing



Questions


List Of All IDocs Created. (Default, Additional, EDI)-- WE02List Of All IDocs Created. (Default, Additional, EDI)-- WE02


Selection Program For Issuing Output -- WE15Selection Program For Issuing Output -- WE15


Process All Selected IDocs. WE14Process All Selected IDocs. WE14


Test Tool For Idoc ProcessingTest Tool For Idoc Processing


Select IDocs BD87Select IDocs BD87


Idoc Search For Business Contents (Database). WE09Idoc Search For Business Contents (Database). WE09


Status Conversion With Trfc Execution. BD75Status Conversion With Trfc Execution. BD75



What is ALE ?

Components of ALE.

Anatomy of an IDoc.

ALE Processing.



Questions


QuestionsQuestions

Ale for Abapers

Documents

Transcript of Ale for Abapers