Professional Documents
Culture Documents
Application Connector
(ALE Communication)
Axway Integration Broker 2.1
Document Number: AA-1028-4
August 2004
NOTICES
Copyright Axway Software, 2005
All rights reserved.
This edition applies to Axway Integration Broker 2.0 (hereafter abbreviated as XIB) and to all subsequent
releases of this product until otherwise indicated in new releases or in technical updates.
No part of this publication may be reproduced, transmitted, stored in a retrieval system, or translated into any
human or computer language, in any form or by any means, electronic, mechanical, magnetic, optical, chemical,
manual, or otherwise, without the prior written permission of the copyright owner, Axway Software.
This document, provided for informational purposes only, may be subject to significant modification. The
descriptions and information in this document may not necessarily accurately represent or reflect the current or
planned functionalities of this product. Axway Software may change this publication, the product described
herein, or both. These changes will be incorporated in new versions of this document. Axway Software does not
warrant that this document is error free.
The optional component, Security Library, is not available in the United States.
Note: In this manual, the screen captures/images of any XIB dialog boxes were taken on a previous version of
the software (version 1.3.0 of the TradeSync Integration Broker), and the descriptions of these dialog boxes may
refer to that version; however, this might not be the only version of XIB that supports this connector. Contact
Axway Support for more.
Trademarks
Axway Integration Broker, XIB, and Datamapper are trademarks of Axway Software.
UNIX is a registered trademark in the United States and other countries, licensed exclusively through X/Open
Company Limited.
Microsoft and Windows are registered trademarks of Microsoft Corporation.
Axway Software recognizes the rights of the holders of all trademarks used in its publications.
How to contact us
Contact Axway Software Support or your local Axway Integration Broker dealer if you have questions or
problems concerning Axway Integration Broker.
Send comments about this manual to:
Technical Documentation
Axway Software
26, rue des Pavillons
Puteaux, 92807 Cedex
France
Notices
TABLE OF CONTENTS
CHAPTER 1. INTRODUCING THE R/3 APPLICATION CONNECTOR .............................9
INTRODUCTION ..............................................................................................................................9
THE METADATA BROWSER ............................................................................................................9
IDOC TRANSFERS AND APPLICATION LINK ENABLING (ALE) .....................................................10
ARCHITECTURE ............................................................................................................................10
SOURCES OF INFORMATION ..........................................................................................................12
CHAPTER 2. METADATA AND THE METADATA BROWSER.........................................13
INTRODUCTION ............................................................................................................................13
THE INITIAL DISPLAY ..................................................................................................................13
WORKING WITH METADATA IN THE SOURCE VIEW......................................................................14
Retrieving Metadata................................................................................................................14
Viewing the Properties of Metadata Items ..............................................................................15
Clearing Child Metadata Items...............................................................................................15
Starting Again from Where You Left Off: the Current Data Set..............................................15
LOGGING ON TO SAP ...................................................................................................................15
WORKING WITH METADATA TYPES .............................................................................................17
MENU OPTIONS ............................................................................................................................18
CHAPTER 3. IDOCS IN XIB ......................................................................................................20
INTRODUCTION ............................................................................................................................20
IDOC DEFINITIONS .......................................................................................................................20
IMPORTING IDOC DEFINITIONS INTO THE XIB DATAMAPPER ......................................................20
Workflow: IDoc Download Metadata Browser Mapping .................................................20
The Metadata Browser ............................................................................................................21
WORKING WITH IDOCS IN THE METADATA BROWSER .................................................................21
Retrieving IDoc Data Structures Interactively........................................................................21
Retrieving IDoc Data Structures Using IDoc Reports ............................................................22
The Levels of Metadata under the IDocs Symbol ....................................................................26
Copying Items from the Source to the right pane....................................................................27
Using the right pane................................................................................................................27
CHAPTER 4. BAPIS IN XIB .......................................................................................................29
INTRODUCTION ............................................................................................................................29
INVOKING BAPIS SYNCHRONOUSLY............................................................................................29
INVOKING BAPIS ASYNCHRONOUSLY .........................................................................................29
VIEWING BAPIS IN THE METADATA BROWSER ...........................................................................29
The Levels of Metadata under the BAPIs Symbol ...................................................................31
Parameters ..............................................................................................................................31
CHAPTER 5. SAP FUNCTION MODULES IN XIB ................................................................32
INTRODUCTION ............................................................................................................................32
INVOKING FUNCTION MODULES IN SAP ......................................................................................32
Importing and Exporting Data to and from Function Modules...............................................32
Managing a Synchronous Dialog with SAP ............................................................................32
VIEWING FUNCTION MODULES IN THE METADATA BROWSER .....................................................33
The Levels of Metadata under the Function Modules Symbol ................................................34
Parameters ..............................................................................................................................34
CHAPTER 6. SAP TRANSACTIONS IN XIB...........................................................................36
INTRODUCTION ............................................................................................................................36
WHAT IS A SAP TRANSACTION?..................................................................................................36
INPUT TO SAP TRANSACTIONS ....................................................................................................36
TRANSACTION CODES ..................................................................................................................36
INVOKING TRANSACTIONS IN SAP...............................................................................................36
Contents
Contents
INTRODUCTION ............................................................................................................................70
IDOC STATUS UPDATES USING A CUSTOM MBC...........................................................................70
Implementing the custom MBC ...............................................................................................70
Configuring the custom MBC..................................................................................................71
Integration Manager ...............................................................................................................71
Sequential Activity...................................................................................................................72
Stage Dialog............................................................................................................................73
CREATING ALE STATUS UPDATE METHODS ................................................................................74
ALE Manager ..........................................................................................................................75
ALE Status Update Method .....................................................................................................75
CHAPTER 14. MESSAGE LOG .................................................................................................80
SEARCH RECEIVE EVENTS ...........................................................................................................80
SEARCH SEND EVENTS .................................................................................................................81
SEARCH STATUS UPDATE EVENTS ...............................................................................................82
SEARCH IDOC DATA CLASSIFIER EVENTS ...................................................................................84
DISPLAY RECEIVE EVENT ............................................................................................................85
DISPLAY SEND EVENT .................................................................................................................90
DISPLAY STATUS UPDATE EVENT ................................................................................................93
DISPLAY IDOC DATA CLASSIFIER EVENT ....................................................................................96
DISPLAY ASYNCHRONOUS IDOC STATUS UPDATE CREATOR EVENT ...........................................98
CHAPTER 15. MESSAGE ATTRIBUTES ..............................................................................100
RECEIVE ATTRIBUTES ................................................................................................................100
SEND ATTRIBUTES .....................................................................................................................101
CHAPTER 16. ALE AND IDOC CONFIGURATION IN SAP..............................................103
DESTINATIONS ...........................................................................................................................103
PORTS ........................................................................................................................................105
LOGICAL SYSTEM ......................................................................................................................106
PARTNER PROFILES ....................................................................................................................107
Outbound Parameters ...........................................................................................................109
Inbound Parameters..............................................................................................................111
DISTRIBUTION MODEL ...............................................................................................................112
OTHER SAP MENU OPTIONS......................................................................................................113
General ALE Configuration ..................................................................................................113
Gateway Monitoring .............................................................................................................114
Transactional RFC Monitoring.............................................................................................114
IDoc Transfer Monitoring.....................................................................................................115
CHAPTER 17. GENERATING IDOC REPORTS IN SAP ....................................................118
CHAPTER 18. ABOUT THE TID VIEWER ...........................................................................121
TRANSACTION IDS (TIDS)..........................................................................................................121
LAUNCHING THE TID VIEWER ...................................................................................................121
WHAT THE TID VIEWER DISPLAYS ............................................................................................121
APPENDIX A. MESSAGE BUILDER LIBRARY REFERENCE.........................................123
APPENDIX B. SAP FUNCTION MODULE IMPLEMENTATION EXAMPLE ................157
APPENDIX C. ALE LOG CLEAN UTILITY..........................................................................161
SYNTAX OF ALE LOG CLEAN ....................................................................................................161
INDEX..........................................................................................................................................162
Contents
TABLE OF FIGURES
Figure 1. From metadata to XIB conversion program.....................................................................10
Figure 2. Data transfer with RFC layer ...........................................................................................11
Figure 3. Processing layers in XIB and SAP...................................................................................11
Figure 4. Transferring data using Message Builder and Function Modules....................................12
Figure 5. From IDoc download to IDoc conversion program .........................................................21
Contents
PREFACE
Intended Audience
This manual is intended for users who want to use Axway Integration Broker (XIB) to
receive or send messages via ALE. A quick introduction to setting up the R/3 Application
Connector can be found in the Getting Started manual.
Chapter 8. Tasks
Preface
Status Updates
Document History
AA-1028-4 (August 2004)
AA-1028-3 (March 2003)
AA-1028-2 (September 2002)
Preface
IDocs
The R/3 Connector supports each of these methods. This manual describes how the R/3
Connector enables the transfer of data when using each of these methods.
1. Introduction to R/3 AC
Metadata
Browser
SAP R/3
1. Metadata is
automatically downloaded
to the Metadata Browser,
where it is available for
use when you make an
ADF file or just browse.
Metadata
ADF file
Other formats
2. Mapping with the
Datamapper: the Source
file is in the left pane, the
Destination file is in the
right pane.
Datamapper
Conversion
Programs
The ALE Transfer Adapter only enables a link between XIB and IDocs within
the ALE subsystem in SAP. It is the responsibility of the XIB user to configure
the ALE subsystem in SAP to send and receive IDocs, and then to enable the
appropriate workflows within SAP.
Architecture
For all data transfers with SAP, the technology underlying the data transfer to and from
SAP is a Remote Function Call (RFC) layer (supplied by SAP), which operates over an
IP network.
1. Introduction to R/3 AC
10
XIB
SAP
IP
RFC layer
RFC layer
In each case, different layers are used to support the data transfers. These layers may be
viewed in two ways.
One view is processing layers. For IDocs, the ALE Transfer Adapter (ALE TA) is used to
transfer data in and out of XIB, and this transfer is processed by the ALE subsystem in
SAP.
XIB
SAP
Routing
Workflow
ALE TA
RFC layer
ALE subsystem
IP
RFC layer
Each layer represents a function within the XIB and SAP systems. The RFC layer is a
low-level transport mechanism, the ALE TA and subsystem are higher-level transport
systems, and Routing and Workflow are involved with the processing of the data at a
business level.
The alternative view is a functional view. If we wish to enable BAPIs, SAP Function
Modules, or SAP Transactions in XIB, then we need to manually create Message Builder
programs, which are used to directly address Function Modules in SAP.
1. Introduction to R/3 AC
11
XIB
SAP
MessageBuilder
Function
Module
RFC layer
IP
RFC layer
So the call to a Function Module is effectively a direct call in the Message Builder
program.
For all data transfers, this is what actually takes place. For example, in the ALE Transfer
Adapter, a data transfer to SAP is achieved by a Message Builder program that calls a
Function Module in SAP. This Function Module transfers the incoming IDoc to the ALE
subsystem for processing. When we retrieve metadata from SAP, this is also achieved by
a Message Builder program that calls a number of Function Modules in SAP.
Sources of Information
For a description of SAP Interface Technology, refer to the free CD that is issued by
SAP, the SAP Interface Advisor. This may be ordered from SAP directly (or through
their Website).
This CD also contains a detailed explanation of how to configure SAP to support their
interfaces, including the technology that supports the link to XIB. In this manual it is
described in outline form in Chapter 16. ALE and IDoc Configuration in SAP. For
more, refer to the SAP manuals.
1. Introduction to R/3 AC
12
A method of creating XIB Datamapper ADF files, which can then be used to create
mapping programs for use in the XIB platform.
Note: the Metadata Browser can be used to make ADF files for IDocs only. It can be
used to browse BAPIs, Function Modules, and SAP transactions, but currently it
cannot be used to make ADF files for them.
Start the Metadata Browser from the System Manager by double-clicking the Metadata
Browser icon.
Left pane this pane displays the metadata for IDocs, BAPIs, Function Modules, and
SAP Transactions.
Right pane this pane displays the output that has been selected from the metadata in
the Source View. This output can then be used to create an ADF file.
The information in each pane is displayed in the form of a tree structure. In the left pane,
a tree can be constructed that displays, in a hierarchical fashion, the metadata retrieved
from SAP. All of this metadata, or only selected elements of the metadata, can be copied
from the left pane to the right pane, where it is also displayed in a tree structure.
13
or
Highlighting an item and selecting the menu option Source / Access Site.
In the case of the R/3 Connector, two items are registered at the top level of the Source
View pane:
SAP
The SAP item may be used to obtain metadata interactively from your SAP system. The
SAP IDoc Report item may be used to retrieve metadata about IDoc data structures from
IDoc reports that are downloaded manually from the SAP system. This method does not
require an interactive connection to your SAP system.
Retrieving Metadata
When an item in a tree has been double-clicked or an item has been selected and Source /
Access Site is selected, the R/3 Connector retrieves one or more levels of metadata below
the current item, and displays them in the pane.
For some items, a dialog will open that prompts the user to select a subset of data for the
next level. For example, if the next level under the current item is a list of IDocs, it is
more sensible to be able to select one or more IDocs rather than download details for all
IDocs on the SAP system.
14
For some items, the R/3 Connector must retrieve a large amount of metadata. In this case,
the metadata is retrieved asynchronously, so that the XIB Tools menu server is not locked
by the operation. When retrieving asynchronously, a progress bar dialog is displayed.
This dialog has a Cancel button; clicking the Cancel button aborts the current metadata
retrieval. Typically, the retrieval would be cancelled if the selection of a subset of
metadata is too wide and the retrieval is taking too long. The retrieval can then be
repeated, selecting a smaller subset of metadata.
In all cases when metadata is being retrieved, a Processing progress bar is displayed
while the Source View pane is being updated with the new data.
Starting Again from Where You Left Off: the Current Data Set
When the Metadata Browser is closed, the current data set is always saved. The current
data set contains the data you retrieved from SAP when you last logged into SAP plus
any changes you have made to the retrieved data. The login information is also saved.
When the Metadata Browser is re-opened, a dialog will ask if you wish to restore the data
that was saved from your last session.
If you select Yes, the saved data set for the current XIB user is restored, and the Metadata
Browser presents the data as it was when you last closed the browser. If you select No,
then the data displayed in the Metadata Browser is reinitialized.
The saved current data set is unique for each XIB user defined to the XIB system.
Logging on to SAP
When you view the left pane, you will refer to the SAP symbol. The level immediately
below the SAP symbol shows the SAP systems to which you can logon.
You must logon to access any metadata from a SAP system. After you select a SAP
system, you enter the logon parameters in the SAP Logon dialog that is displayed.
Access to a SAP system is obtained by:
or
15
Highlighting the SAP Connector item and selecting Source / Access Site.
To successfully logon, you enter, in the SAP Logon dialog, the data that would be
required to start a remote session of the SAP GUI. The following data should be entered:
Data
Destination
Description
The system name of the remote SAP system.
Host name
The name of the remote SAP host. This can take one of
two formats:
1. A TCP/IP host name, or a valid DNS name (if DNS is
being used) or an IP address. If you use a TCP/IP host
name, it must also be defined in the file /etc/hosts on
UNIX systems, the file %SystemRoot%\drivers\etc\hosts
on Windows NT systems, or the TCP/IP host table on
AS/400 systems.
2. A saprouter address. This takes the format:
/H/routername/S/service//H/hostname.
System Number
Gateway
Port
Client
16
User
Password
Language
If the logon is successful, then a tree item will appear, the name of which is set to the
name of the remote SAP system (Destination) specified in the logon dialog.
If the logon is unsuccessful, then an error dialog will be displayed. Note that if you logoff
from XIB, all the logon information is saved and displayed in the dialog box next time
you want to logon.
IDocs
17
or
Note that when you view a tree structure that includes metadata, you are not viewing in
real-time what is in the SAP system. You are viewing what was retrieved from the SAP
system; and after the data has been retrieved, the connection to the SAP system is
terminated until the next request for data.
Tree items will appear for each metadata type.
The figure above shows the display of the different metadata types. Details of the
metadata associated with each of these types are described in subsequent chapters.
Menu options
These menu options are enabled in the Metadata Browser:
Menu option
Description
Exit from the Metadata Browser
File / Exit
Clear the current Format Connector pane.
File / New
Open a Windows dialog to select an existing client
File / Open
Datamapper ADF file, and import the data from
that file into the Format Connector pane.
Save the data in the Format Connector pane to a
File / Save
Datamapper ADF file. If the data has not been
imported from an existing ADF file, and the data
has not been saved previously, then a Windows
dialog will be presented to define the file name.
Save the data in the Format Connector pane data to
File / Save As
18
19
IDoc Definitions
SAP (currently) supplies over 200 standard IDoc definitions with all SAP R/3 systems.
These definitions correspond to the transfer of different types of business data between
systems. For example, there is an INVOIC IDoc definition for the transfer of invoice
information, and an ORDERS IDoc definition for sales orders. You can modify, or add
to, the IDoc definitions in the SAP system, for details refer to the SAP manuals.
Note: XIB supports only versions 2 and 3 of IDoc messages.
IDocs
1. Import format into
XIB ADF repository
with Metadata Browser
SAP System
Some Other
Application Data Format
IDoc
Application Data Format
3. IDocs in XIB
20
The XIB Metadata Browser Builder tool is used to import IDoc descriptions into XIB. To
launch, double-click the Metadata Browser icon from the System Manager.
Interactively, by logging on to your SAP system through the SAP item at the top
level of the Source View pane.
Using an IDoc report generated by your SAP system, through the SAP IDoc Report
item at the top level of the Source View pane.
or
Entering a value in the IDoc Type field will return the metadata for the matching IDocs.
This field allows wildcards. For example, entering ORDERS* will return a list of all
IDocs that start with the text ORDERS.
In addition to the next level of metadata, the IDoc Version is also returned. IDocs exist in
up to two versions, Version 3 and Version 4. It is possible to drill down immediately
through these layers of metadata.
3. IDocs in XIB
21
The figure above illustrates the display of all these metadata items.
Metadata for a particular IDoc Version can be built up by:
or
Highlighting the IDoc Version item and selecting Source / Access Site.
All of the metadata for the selected IDoc Version will be returned immediately. It is
possible to drill down immediately through the next layers of metadata.
or
Highlight the SAP IDoc Report item and selecting Source / Access Site.
3. IDocs in XIB
22
Below the SAP IDoc Report icon, the next level in the Source View pane is a Host level.
The following different hosts are defined:
Client
Server
or
If you select the Client Host item, a File Selection dialog is displayed:
3. IDocs in XIB
23
From this display you can navigate to any directory on your XIB client to find the IDoc
report.
The default directory for this display is the directory defined by the %TEMP%
environment variable on your XIB client.
If a file is selected, it is transferred to the XIB server and parsed to retrieve the IDoc data
structure.
If you select the Server Host item, then a list of files from the directory
$CORE/IDOCreports/import is displayed:
3. IDocs in XIB
24
or
3. IDocs in XIB
25
Records or Groups
Data Elements
A Record is a data structure of one or more data elements. A Group is a repeating unit of
one or more Records. Groups can contain other Groups, to create a multiple level
hierarchy of Records.
3. IDocs in XIB
26
The figure above illustrates the display of all of these metadata items.
Tree structures are built up by copying metadata from the left pane to the right pane. But
not all metadata in the left pane can be copied. This is because an ADF file has a data
structure that is comprised only two logical elements: Records and Fields, and only
metadata items (and their children) that confirm to this structure can be copied.
IDoc Packets the Logical Units with which to Build Tree Structures
For the SAP R/3 Connector, when working with IDocs, the only logical unit that can be
copied is the IDoc packet, which represents a unit of one or more IDocs.
When creating a mapping program in the XIB Datamapper, the file that contains IDoc
data that is the input to or output from this mapping program will always comprise one or
more individual IDocs, and a subset of the records defined for that IDoc. It is therefore
only meaningful if the ADF file created by the Metadata Browser contains one or more
parent IDocs, and a subset of their possible child data definitions.
Creating the ADF File
At any time, data in the right pane can be used to create an ADF file using the File / Save
and File / Save As.
3. IDocs in XIB
27
If you wish to discard the current data in the right pane, selecting File / New will clear all
data from the pane.
Note that for other metadata types in SAP, there is currently no possibility to use mapping
programs, so the copying of metadata to the right pane is not allowed.
3. IDocs in XIB
28
This technique is useful only for BAPIs that do not return significant data
because this data will not be returned to XIB.
4. BAPIs in XIB
29
or
Entering a value in the Business Object Name field will return the metadata for the
matching Business Objects. This field allows wildcards. For example, entering
Material* will return a list of all Business Objects that start with the text Material.
If the Get all metadata checkbox is checked, then all of the metadata for the selected
Business Objects will be returned immediately. If it is unchecked, then only a list of
Business Objects will be returned.
If all of the metadata is returned, then it is possible to drill down immediately through the
layers of metadata displayed in the Browser.
If only the list of Business Objects is returned, then lower layers of metadata can be built
up by:
4. BAPIs in XIB
30
or
Business Object
Parameter
When a single BAPI (Method) is selected for the further retrieval of metadata, all
underlying metadata levels for the BAPI will be populated.
Parameters
A Parameter can have more than one level of metadata. Import and Export Parameters
can either be single fields or a data structure of one or more data elements. If they are data
structures, then two levels of metadata will be displayed. Tables are always data
structures containing one or more data elements, so two levels of metadata will always
represent them.
The figure above illustrates the display of all these metadata items.
4. BAPIs in XIB
31
Import parameters
Import parameters are single data elements, or a single data structure comprised of a
number of data elements, that are used to import data into the program.
Export parameters
Export parameters are single data elements, or a single data structure comprised of a
number of data elements, that are used to export data from the program.
Tables
Tables are data structures containing one or more data elements. They can contain
more than one record, and are therefore used as a means of transferring larger
amounts of data. They can be used to pass data both into and out of a program.
These functions and statements allow a synchronous dialog with SAP to be managed
effectively.
32
In addition there are further Message Builder library functions and statements to support
data conversions between Message Builder and SAP data types.
These library functions and statements are fully documented in Appendix A. Message
Builder Library Reference.
A full example of the implementation of a synchronous call to a SAP Function Module is
provided in ALE.CreateParameter.
A full definition of a Function Module, with all parameters and tables, may be accessed
using the Metadata Browser. This is discussed in Viewing Function Modules in the
Metadata Browser.
The data that is passed into and out of the Function Module is subject to the rules defined
in SAP. It is typically useful to test the operation of any Function Module using the
testing and debugging facilities provided by SAP.
or
Highlighting the Function Modules item and selecting Source / Access Site.
Entering values in the Function Group and Function Name fields will return the metadata
for the matching Function Modules. These fields allow wildcards. For example, entering
RFC_* will return a list of all Function Modules that start with the text RFC_.
If the Get all metadata checkbox is checked, then all of the metadata for the selected
Function Modules will be returned immediately. If it is unchecked, then only a list of
Function Modules will be returned.
33
If all of the metadata is returned, then it is possible to drill down immediately through the
next layers of metadata.
If only the list of Function Modules is returned, then lower layers of metadata can be built
up by:
or
Function Module
Parameter
When a single Function Module is selected for the further retrieval of metadata, all
metadata levels for the Function Module will be populated.
Parameters
A Parameter can have more than one level of metadata. Import and Export Parameters
can either be single fields or a data structure of one or more data elements. If they are data
structures then two levels of metadata will be displayed. Tables are always data structures
containing one or more data elements, so two levels of metadata will always represent
them.
34
The figure above illustrates the display of all of these metadata items.
35
Transaction Codes
Each SAP Transaction is represented by a Transaction Code, which is available in all
screen dialogs in SAP by selecting System / Status. The Transaction Code is displayed in
the field Transaction in the System: Status dialog.
The details of a SAP Transaction can be accessed by retrieving the Transaction metadata
in the Metadata Browser. This is described in Viewing SAP Transactions in the
Metadata Browser.
or
36
Entering a value in the Transaction Code field will return the metadata for the matching
Transactions. This field allows wildcards. For example, entering MB* will return a list
of all Transactions that start with the text MB.
Only a list of Transaction Codes will be returned.
All the metadata for the selected Transaction is returned immediately. It is then possible
to drill down through the next layers of metadata.
Lower layers of metadata can be built up by:
or
Program Name
37
Screen Identifier
The figure above is an example of the display after all of these metadata items have been
added.
38
Activity
...
Activity
Send
Activity
A receive activity:
A send activity:
Sends a message that has been processed by the preceding activities in the
integration.
To receive messages from SAP, you create an ALE retrieve method and an ALE receive
method. When Integration Broker executes these methods, it is the ALE retrieve method
that receives messages from the given SAP server.
To send messages to a SAP server, you create an ALE send method. When Integration
Broker executes the method, it passes the message to the method and the method sends
the message to the given SAP server.
Configuration
You configure Integration Broker using the tools:
Task Managerto create ALE tasks, refer to Chapter 8. Tasks. Typically, you
create three ALE tasks only per Integration Broker installation; by contrast, you
create many methods.
ALE Managerto create ALE methods, refer to Chapter 10. Creating Retrieve and
Receive Methods or Chapter 11. Creating Send Methods.
Once you have configured an integration correctly, you can check how it is processing
messages using the Message Log , refer to Chapter 14. Message Log for details of
ALE-specific functionality.
39
Integration Broker executes an ALE retrieve method as part of a receive activity. When
Integration Broker executes an ALE retrieve method, the method connects to the ALE
server and executes the script. The script receives zero or more messages. (For a
description of how a script executes, refer to Chapter 10. Creating Retrieve and Receive
Methods.) The script either completes (without errors) or it terminates (with errors). If
the script received any messages (whether the script completed or not), Integration Broker
processes each message as specified by the integration of which the ALE retrieve method
is part.
If there are no associated schedule definitions, the method is always available for
execution.
2.
Otherwise, the method is available for execution at the specified times only. For
example, two schedule definitions together can specify that the method is available
for execution on Tuesday mornings each week or overnight on the first day of the
month (and at no other times).
Note: A schedule definition with the same start and stop times specifies that a method is
available at all times with one of these constraints:
40
This description applies to all methods except FTP and OFTP methods. For each
message header received by a retrieve method, Integration Broker examines the
associated receive methods and selects the receive method whose criteria most
closely match the header details. (Each associated receive method must have unique
criteria.) Integration Broker receives the message as defined by the receive method.
If the header details do not match any of the criteria, Integration Broker receives the
message, logs an error in the Message Log, and discards the message (that is, does
not process it further).
This description applies to FTP methods only. Integration Broker receives each
message without needing to refer to the receive method. (FTP receive methods do not
have criteria, and there is a one-to-one relationship between FTP retrieve methods
and FTP receive methods.)
This description applies to OFTP methods only. There are no OFTP retrieve
methods. Integration Broker receives each message without needing to refer to a
receive method. It examines the available receive methods and selects the receive
method whose criteria most closely match the message details. (Each receive method
must have unique criteria.) If the message details do not match the criteria of any of
the receive methods, Integration Broker logs an error in the Message Log and
discards the message (that is, does not process it further).
Whatever the result of executing a retrieve method (whether the method completes or
terminates, whether messages are received or not), Integration Broker immediately
restarts the retrieve method (subject to schedule definitions).
41
1.
Integration Broker searches the list of methods for the method that will be available
first (subject to schedule definitions). (If two methods will be available at the same
time, Integration Broker selects the first one in the list.) As soon as the method is
available, Integration Broker executes it.
2.
The method either completes (no errors) or terminates (with errors). If the method
completes, the activity has completed too. Otherwise, Integration Broker searches the
list of methods for the method that will be available first (subject to schedule and
retry definitions). (If two methods will be available at the same time, Integration
Broker selects the first one in the list.) As soon as the method is available,
Integration Broker executes it.
3.
The method either completes (no errors) or terminates (with errors). If the method
completes, the activity has completed too. Otherwise, Integration Broker continues to
execute methods (as described in step 2 above) until a method completes or the
retries of all methods are exhausted. If the retries of all methods are exhausted,
Integration Broker terminates the activity and logs an error in the Message Log
(since the message was not sent).
Log Entries
For each significant event that happens to a message, Integration Broker writes a log
event to the Message Log. The significant events, and the information logged in each
case, include:
Event
Information logged
Message contents
Error
Acknowledgment
42
CHAPTER 8. TASKS
To create ALE tasks, you must use an Integration Broker login that allows User access to
the Task Manager.
You create two tasks:
1.
2.
Typically, you create precisely one of each of these tasks per Integration Broker
installation. Until you create such tasks, you cannot run ALE integrations. Typically, you
do not need to know what these tasks do.
General Tab
Item
Name
Action
Enter a name for the task.
Requirement
Mandatory
8. Tasks
43
Item
Enable
Action
Select to enable the taskthat is, you want
Integration Broker to run the task (in the case that the
configuration dataset is the same as the run-time
dataset and the change is committed).
Requirement
Optional
Description
Optional
Configuration Tab
Item
Temporary
directory
Action
Enter the name of a directory where you wish
temporary files to be placed. This field defaults to
$CORE_TMP.
Requirement
Mandatory
TID server
Mandatory
8. Tasks
44
Start Up Tab
Item
Add
Action
Click to select a processing engine task. In normal
circumstances, there is just one processing engine
task per Integration Broker installation.
Requirement
Mandatory
Remove
Optional
Advanced
Optional
8. Tasks
45
This section describes how to create an ALE transfer classifier task. In normal
circumstances, there is nothing to configureyou name the task, enable it, and save the
definition.
Typically, you create one ALE transfer classifier task per Integration Broker installation.
Until you create such a task, you cannot run ALE integrations.
From the System Manager window, open the Task Manager. Select
File / New / ALE / ALE Transfer Classifier Task.
Item
Name
Action
Enter a name for the task.
Requirement
Mandatory
Enable
Optional
Description
Optional
8. Tasks
46
ALE Manager
From the System Manager window, open the ALE Manager.
A private send method is only available to send activities via a given application. A
public send method is directly available to send activities.
To create a public send method, click Public and select the folder to which you want to
add the method.
To create a private send method, click Private and select the application to which you
want to add the method.
General Tab
47
Item
Name
Action
Enter a name for the object.
Requirement
Mandatory
Host
Mandatory
Service
Mandatory
Description
Optional
48
From the R/3 Application Connector Manager window, select File / New / Logon
Object.
Click the General tab.
General Tab
Item
Name
Action
Enter a name for the object.
Requirement
Mandatory
Node
Mandatory
Description
Optional
Preferences Tab
49
Item
Client
Action
The client number for the connection to the remote
SAP system.
Requirement
Mandatory
User
Mandatory
Mandatory
Language
Optional
Trace
Optional
Connection
Test
Optional
Performance
Test
Optional
System Info.
Optional
50
If you click Connection Test, and a successful connection is made to the remote SAP
system, then the following window will be displayed:
If you click Performance Test, and a successful connection is made to the remote SAP
system, then the following window will be displayed:
Item
Open connection
Description
The time taken to open the connection to the SAP
system, in seconds.
Fill tables
Call
STFC_PERFORMANCE
If you click SystemInfo., and a successful connection is made to the remote SAP system,
then the following window will be displayed:
51
This window displays system information about the remote SAP system.
Click OK to save the definition.
General Tab
52
Item
Name
Action
Enter a name for the object.
Requirement
Mandatory
Destination
Mandatory
The name of the remote SAP host. This can take one
of two formats:
1. A TCP/IP host name, or a valid DNS name (if
DNS is being used), or an IP address. If a TCP/IP
host name is used, it must also be defined in the file
/etc/hosts on UNIX systems, in the file
%SystemRoot%\drivers\etc\hosts on Windows NT
systems, or in the TCP/IP host table on AS/400
systems.
2. A saprouter address. This takes the format:
/H/routername/S/service//H/hostname.
Mandatory
System
Mandatory
Gateway
Optional
53
Item
Description
Action
Enter a description for the object.
Requirement
Optional
54
ALE Manager
From the System Manager window, double-click the ALE Manager icon.
A private receive method is only available to receive activities via a given application. A
public receive method is directly available to receive activities.
To create a public receive method (and associated retrieve method), click Public and
select the folder to which you want to add the methods.
To create a private receive method (and associated retrieve method), click Private and
select the application to which you want to add the methods.
General Tab
55
Item
Name
Action
Enter a name for the method.
Requirement
Mandatory
ALE
transfer
adapter
task
Optional
Description
Optional
Schedule Tab
Item
New
Action
Click to create a schedule definition.
Requirement
Optional
Open
Optional
Delete
Optional
56
Item
Poll
frequency
Action
Enter the poll frequency. This is the minimum time in
seconds between one execution ending and the next
one starting. For example, if the value is 3, the
method cannot be restarted until at least 3 seconds
after the previous execution has ended (completed or
terminated).
Requirement
Optional
Note: A retrieve method executes as part of a receive activity. The schedule definitions
specify when the method is available for execution. For a full description of how a
receive activity executes, refer to Execution of a Receive or Send Activity on page 40.
Item
Node
Action
Select a Node object.
Requirement
Mandatory
Gateway
Mandatory
57
Item
Program Id
Action
Enter the SAP program ID to load at the remote
host. This must match a Program Id registered
against an RFC Destination in SAP.
Requirement
Mandatory
Update Status
Optional
Status value
Optional
Transactional
Optional
Trace
Optional
General Tab
58
Item
Name
Action
Enter a name for the method.
Requirement
Mandatory
Description
Optional
ALE Tab
Item
Browse
Action
Click to select the retrieve method.
Requirement
Mandatory
59
ALE Manager
From the System Manager window, double-click the ALE Manager icon.
A private send method is only available to send activities via a given application. A
public send method is directly available to send activities.
To create a public send method, click Public and select the folder to which you want to
add the method.
To create a private send method, click Private and select the application to which you
want to add the method.
General Tab
60
Item
Name
Action
Enter a name for the method.
Requirement
Mandatory
Transfer
timeout
Optional
ALE
transfer
adapter
task
Optional
Description
Optional
Retry Tab
Item
Action
Requirement
61
Item
New
Action
Click to create a retry definition.
Requirement
Optional
Open
Optional
Delete
Optional
Move Up
Optional
Move Down
Optional
Notes:
A send method executes as part of a send activity. The retry definitions specify how
many times and at what intervals the method can be retried. The order of the retry
definitions is significant. For a full description of how a send activity executes, refer
to Execution of a Receive or Send Activity.
Schedule Tab
Item
New
Action
Click to create a schedule definition.
Requirement
Optional
Open
Optional
Delete
Optional
Notes:
If there are no schedule definitions, the method is always available for execution.
A send method executes as part of a send activity. The schedule definitions specify
62
when the method is available for execution. The order of the schedule definitions is
not significant. For a full description of how a send activity executes, refer to
Execution of a Receive or Send Activity.
Click the ALE tab.
ALE Tab
Item
Logon
Action
Select a Logon object.
Requirement
Optional
Version
Optional
63
Integration Manager
Integrations are created using the Integration Manager. For details of how to create
Integrations refer to the Integration Manager manual.
In this case, the IDoc Classifier will be implemented as part of a Classification Activity.
From the System Manager window, double-click the Integration Manager icon.
64
Classification Activity
Click the General tab.
General Tab
Item
Name
Action
Enter a name for the activity.
Requirement
Mandatory
Description
Optional
Next
Activity
Optional
65
Item
Classificati
on Anchor
Action
Select the Classification Anchor with which to
associate the Classification Activity.
Requirement
Mandatory
Classifier
MBC
Mandatory
When an initial selection of the IDoc Classifier is made, a configuration window will
open. This has two tabs, IDoc, EDI and Sender, Receiver, and enables you to enter
selection criteria for this Classifier instance.
Click the IDoc, EDI tab.
66
Item
IDoc version
(DOCREL)
Action
Select and enter the data to match against in the
corresponding data field, if you want the Classifier
to select IDocs for a particular IDoc version. This
selection corresponds to the DOCREL field in the
IDoc data format.
Requirement
Optional
IDoc type
extended
(CIMTYP)
Optional
IDoc type
(IDOCTYP)
Optional
EDI version
(EDIVRS)
Optional
67
Item
EDI
standard
(STD)
Action
Select and enter the data to match against in the
corresponding data field, if you want the Classifier
to select IDocs for a particular EDI standard. This
selection corresponds to the STD field in the IDoc
data format.
Requirement
Optional
EDI message
type
(EDIMES)
Optional
Client
(MANDT)
Optional
Test flag
(TEST)
Optional
68
Item
Sender
(SNDPRN)
Action
Select and enter the data to match against in the
corresponding data field, if you want the Classifier
to select IDocs for a particular Sender. This
selection corresponds to the SNDPRN field in the
IDoc data format.
Requirement
Optional
Sender
partner port
(SNDPOR)
Optional
Sender
partner type
(SNDPRT)
Optional
Receiver
(RCVPRN)
Optional
Receiver
partner port
(RCVPOR)
Optional
Receiver
partner type
(RCVPRT)
Optional
69
Using a combination of a custom MBC and an ALE Update Status Method, which
can be placed in any Integration in XIB
70
Set the next activity to that from the stage configuration, using the function
MBC_HIERCHMSGENV.SetActivityBranch.
Get the application acknowledgement attribute from the current message, using the
function MBC_HIERCHMSGENV.GetAttribute. This attribute is automatically set
for all IDocs received in the ALE Transfer Adapter.
Set the application acknowledgement attribute for the new message to the retrieved
value, using the function MBC_HIERCHMSGENV.SetAttribute.
Set the Logger ID for the new message to the same as the current message, using the
functions MBC_HIERCHMSGENV.GetLoggerId and
MBC_HIERCHMSGENV.SetLoggerId.
Integration Manager
Integrations are created using the Integration Manager. For details of how to create
Integrations, refer to the Integration Manager manual.
In this case, the custom MBC will be implemented as part of a Sequential Activity. From
the System Manager window, double-click the Integration Manager icon.
71
To create a new Sequential Activity, select File / New / Activity / Sequential Activity.
Sequential Activity
Click the General tab.
General Tab
Item
Name
Action
Enter a name for the activity.
Requirement
Mandatory
Description
Optional
Hierarchica
l Messaging
Task
Optional
72
Item
New
Action
Click to add a new stage.
Requirement
Optional
Open
Optional
Delete
Optional
Move Up
Optional
Move Down
Optional
Stage Dialog
Click the General tab.
General tab
73
Item
Name
Action
Enter a name for the stage.
Requirement
Mandatory
Description
Optional
Item
Next
Activity
Action
Select an Activity to follow this stage. Typically, be
an ALE Status Update method.
Requirement
Optional
74
To create ALE methods, you must use an Integration Broker login that allows User access
to the ALE Manager.
ALE Manager
From the System Manager window, double-click the ALE Manager icon.
A private status update method is only available to send activities via a given application.
A public status update method is directly available to send activities.
To create a public status update method, click Public and select the folder to which you
want to add the method.
To create a private status update method, click Private and select the application to which
you want to add the method.
75
Item
Name
Action
Enter a name for the method.
Requirement
Mandatory
Transfer
timeout
Optional
ALE
transfer
adapter
task
Optional
Description
Optional
76
Item
New
Action
Click to create a retry definition.
Requirement
Optional
Open
Optional
Delete
Optional
Move Up
Optional
Move Down
Optional
Notes:
A send method executes as part of a send activity. The retry definitions specify how
many times and at what intervals the method can be retried. The order of the retry
definitions is significant. For a full description of how a send activity executes, refer
to Execution of a Receive or Send Activity on page 40.
77
Item
New
Action
Click to create a schedule definition.
Requirement
Optional
Open
Optional
Delete
Optional
Notes:
If there are no schedule definitions, the method is always available for execution.
A status update method executes as part of a send activity. The schedule definitions
specify when the method is available for execution. The order of the schedule definitions
is not significant. For a full description of how a send activity executes, refer to
Execution of a Receive or Send Activity on page 40.
78
Item
Logon
Action
Select a Logon object.
Requirement
Optional
Status
value
Optional
79
Item
Destination
Action
If you want Integration Broker to display only log
entries that record the receiving of a message with a
given Destination via ALE, select and enter the
Destination.
Requirement
Optional
Creation
Date
Optional
80
Item
Creation
Time
Action
If you want Integration Broker to display only log
entries that record the receiving of a message with a
given Creation Time via ALE, select and enter the
Creation Time.
Requirement
Optional
Document
Number
Optional
Transaction
Id
Optional
Save
Optional
Save As
Optional
Count
Optional
Apply
Optional
Recursive
Optional
Reset
Optional
81
Item
Transaction Id
Action
If you want Integration Broker to display only log
entries that record the receiving of a message with
a given Transaction Id via ALE, select and enter
the Transaction Id.
Requirement
Optional
Destination
Optional
Save
Optional
Save As
Optional
Count
Optional
Apply
Optional
Recursive
Optional
Reset
Optional
82
In the Message Log, select File / New, and then select ALE Status Updates.
If required, change the settings on the General tab. For details of this information, refer
to Chapter 8: Message Log in the System and Administration Manager manual.
Click the ALE tab.
Item
Document
Number
Action
If you want Integration Broker to display only log
entries that record the receiving of a status update
with a given Document Number via ALE, select and
enter the Document Number.
Requirement
Optional
Status
Value
Optional
Destination
Optional
Save
Optional
Save As
Optional
Count
Optional
83
Item
Apply
Action
Click to display the log entries that match the search
criteria (on all tabs).
Requirement
Optional
Recursive
Optional
Reset
Optional
Item
IDoc
Number
(DOCNUM)
Action
If you want Integration Broker to display only log
entries that record the classification of an IDoc with
a given IDoc Number, select and enter the IDoc
Number.
Requirement
Optional
IDoc Type
(IDOCTYP)
Optional
84
Item
Sender
(SNDPRN)
Receiver
(RCVPRN)
Save
Save As
Count
Apply
Recursive
Reset
Action
If you want Integration Broker to display only log
entries that record the classification of an IDoc with
a given Sender, select and enter the Sender.
If you want Integration Broker to display only log
entries that record the classification of an IDoc with
a given Receiver, select and enter the Receiver.
Click to save the search as a favorite search.
Click to save the search as a favorite search, with a
new text name.
Click to display the number of log entries that
match the search criteria (on all tabs).
Click to display the log entries that match the search
criteria (on all tabs).
Click to create a recursive search.
Click to reset all selection values (on all tabs).
Requirement
Optional
Optional
Optional
Optional
Optional
Optional
Optional
Optional
The information displayed on this tab is common to all log events. For details of this
information, refer to Chapter 8: Message Log in the System and Administration
Manager manual.
85
Item
Transfer
ID
Description
The transfer ID for the message. The ID uniquely
identifies a message.
Requirement
Read-only
Attributes
Optional
View
Optional
Size
Read-only
View
content as
Optional
View
Optional
86
Item
Destination
Description
The name of the remote SAP system from which
the message was received. This is the equivalent
of an RFC destination in SAP, and is typically set
to the system name of the SAP system.
Requirement
Read-only
Gateway Host
Read-only
Gateway
Service
Read-only
Program Id
Read-only
Update Status
Read-only
Status Value
Read-only
87
Item
Transactional
Description
A flag, which denotes whether to use transactional
control for data transfers.
Requirement
Read-only
Trace
Read-only
Item
Transaction Id
Description
The SAP Transaction Id for the data transfer.
Requirement
Read-only
Receive Date
Read-only
Receive Time
Read-only
File Size
Read-only
88
Item
Client
Description
The client number. This corresponds to the MANDT
field in the IDoc control record.
Requirement
Read-only
Document
Number
Read-only
IDoc
Version
Read-only
Test
Read-only
IDoc Type
Read-only
Extended
IDoc Type
Read-only
Message
Type
Read-only
EDI
Standard
Read-only
EDI
Version
Read-only
89
Item
EDI
Message
Type
Description
The EDI message type. This corresponds to the
STDMES field in the IDoc control record.
Requirement
Read-only
Sender
Port
Read-only
Sender
Partner
Type
Read-only
Sender
Read-only
Receiver
Port
Read-only
Receiver
Partner
Type
Read-only
Receiver
Read-only
Creation
Date
Read-only
Creation
Time
Read-only
90
The information displayed on this tab is common to all log events. For details of this
information, refer to Chapter 8: Message Log in the System and Administration
Manager manual.
Click the Transfer report tab.
Item
Transfer
ID
Description
The transfer ID for the message. The ID uniquely
identifies a message.
Requirement
Read-only
Attributes
Optional
91
Item
View
Description
Click to view the selected attribute.
Requirement
Optional
Item
Transaction Id
Description
The SAP Transaction Id for the data transfer.
Requirement
Read-only
Destination
Read-only
Mode
Read-only
Host
Read-only
System
Read-only
92
Item
Gateway Host
Description
The name of the remote SAP gateway. This can
take one of two formats:
1. A TCP/IP host name, or IP address, or a valid
DNS name (if DNS is being used).
2. A saprouter address. This takes the format:
/H/routername/S/service//H/hostname.
Requirement
Read-only
Gateway
Service
Read-only
Client
Read-only
User
Read-only
Encrypted
Password
Read-only
Language
Read-only
Trace
Read-only
93
The information displayed on this tab is common to all log events. For details of this
information, refer to Chapter 8: Message Log in the System and Administration
Manager manual.
Click the Transfer report tab.
Item
Transfer
ID
Description
The transfer ID for the message. The ID uniquely
identifies a message.
Requirement
Read-only
Attributes
Optional
View
Optional
94
Item
Document
Number
Description
The IDoc number for which the status is to be
updated in SAP.
Requirement
Read-only
Status
Value
Read-only
Destination
Read-only
Host
The name of the remote SAP host. This can take one
of two formats:
1. A TCP/IP host name, or a valid DNS name (if
DNS is being used), or an IP address.
2. A saprouter address. This takes the format:
/H/routername/S/service//H/hostname.
Read-only
System
Read-only
Gateway
Host
Read-only
Gateway
Service
Read-only
Client
Read-only
95
Item
User
Description
The SAP user login name.
Requirement
Read-only
Encrypted
Password
Read-only
Language
Read-only
Trace
Read-only
The information displayed on this tab is common to all log events. For details of this
information, refer to Chapter 8: Message Log in the System and Administration
Manager manual.
Click the Data tab.
96
Item
Client
Description
The client number. This corresponds to the MANDT
field in the IDoc control record.
Requirement
Read-only
IDoc
Number
Read-only
IDoc
Version
Read-only
Test
Read-only
IDoc Type
Read-only
Extended
IDoc Type
Read-only
Message
Type
Read-only
EDI
Standard
Read-only
97
Item
EDI
Version
Description
The version of the EDI standard. This corresponds to
the STDVRS field in the IDoc control record.
Requirement
Read-only
EDI
Message
Type
Read-only
Sender
Port
Read-only
Sender
Partner
Type
Read-only
Sender
Read-only
Receiver
Port
Read-only
Receiver
Partner
Type
Read-only
Receiver
Read-only
Creation
Date
Read-only
Creation
Time
Read-only
98
The information displayed on this tab is common to all log events. For details of this
information, refer to Chapter 8: Message Log in the System and Administration
Manager manual.
Click the SampleIDocStatus tab.
Item
Data
Description
The IDoc number for which the status is to be
updated in SAP.
Requirement
Read-only
99
Set message attributes to override control values specified in ALE send methods.
For details of how to create a sequential activity, refer to the Integration Manager
manual.
Receive Attributes
When XIB receives an ALE message, it stores communication specific values, that is
host, user, file name, as an attribute of the message. A custom MBC (that is, an MBC
written by you) within a sequential activity later in the integration can retrieve these
values and take an action dependent on one or more of them. For example, the MBC
could log an error in the Message Log if the original ALE message was not received from
a given partner.
You need two files:
1. $CORE_ROOT/4edi/include/alerconfig.s4h
2. $CORE_ROOT/4edi/lib/alerconfig.s4
Include the alerconfig.s4h file in the code. The compiler finds the
alerconfig.s4 automatically.
2.
3.
4.
100
# Declare a record.
DECLARE $ReceiveInfo RECORD ALERCONFIG.ReceiveInfo;
DECLARE $ReceiveInfoString STRING;
# Retrieve the attribute.
TRY {
$ReceiveInfoString = MBC_HIERCHMSGENV.GetAttribute($SessionId,
$MessageId, ALERCONFIG.$ReceiveInfoAttribute);
}
CATCH $Exception
WHEN OTHERS {
# Log the error in the trace log.
LOG FORMAT("Failed to get attribute '%s' ",
ALERCONFIG.$ReceiveInfoAttribute) TYPE "ERROR";
}
# Unpack the record.
TRY {
$ReceiveInfo = ALERCONFIG.UnpackReceiveInfoAttribute
($ReceiveInfoString);
}
CATCH $Exception
WHEN OTHERS {
# Log the error in the trace log.
LOG FORMAT("Failed to unpack attribute '%s' ",
ALERCONFIG.$ReceiveInfoAttribute) TYPE "ERROR";
}
# Now check the ALE parameters and do something useful.
Send Attributes
The R/3 Connector uses two kinds of Send Method attributes, for sending an IDoc or for
sending an IDoc status update to SAP. Each of these can be overridden by a custom MBC
(that is, an MBC written by you) that runs within a sequential activity.
You need two files:
1. $CORE_ROOT/4edi/include/alerconfig.s4h
2. $CORE_ROOT/4edi/lib/alerconfig.s4
OverrideIDocAttr. The record contains two variables for each control: One
specifies the control value and the other specifies if that value is to be used or not
when XIB sends the message. For example, the two variables for the Mode control
are $Use_Mode and $Mode.
OverrideStatusAttr. The record contains two variables for each control: One
specifies the control value and the other specifies if that value is to be used or not
when XIB sends the message. For example, the two variables for the Status Value
control are $Use_StatusValue and $StatusValue.
Unlike most other Connectors, the Send Method attributes of the R/3 Connector are data
structures that contain other records, to reflect the structure of the configuration data that
is used. For example the OverrideIDocAttr record contains an OverrideLogonAttr
record, which contains an OverrideNodeAttr record. When creating your MBC, the
only difference is that the syntax for addressing the data elements is slightly different. An
example is given below.
The basic steps in the MBC are:
1.
Include the alerconfig.s4h file in the code. The compiler finds the
alerconfig.s4 automatically.
2.
3.
Set the variables for the controls that you want to override.
101
4.
5.
102
Destinations
In order for data to be passed from SAP to XIB, the XIB system must be configured as an
RFC Destination in SAP.
Open the SAP program Display and maintain RFC destinations (short cut menu code
sm59).
103
Connection Type
Activation Type
Trace
Program ID
Description
104
Ports
In order for SAP to pass data to XIB, the RFC Destination that will be used by XIB must
be attached to a port in SAP.
Open the SAP program Port Definition (short cut menu code we21).
Select the Transactional RFC option and click the Change icon or select Edit / Change
to move into edit mode.
Then click on the New entries icon or select Edit / New entries.
105
The IDoc record type to be used for this port. This can take
the following values:
2 = IDoc record type for R/3 versions 3.0 and 3.1
3 = IDoc record type for R/3 versions 4.0 and onwards
Logical
Destination
Port Description
Logical System
In order for data to be transferred between SAP and XIB, a Logical System must be
created that is the symbolic name of another system, SAP or otherwise.
Open the SAP program Distribution (ALE) (short cut menu code sale), and expand the
Basic Settings and then Set up a logical system structure items.
Double-click on the Maintain logical systems item. You will be informed that the table
XIB: SAP/R/3 Manual
106
The name of the Logical System. The name can contain any
text.
Description
Partner Profiles
In order for data to be transferred between SAP and XIB, a Partner Profile must be
created and Message Types associated with it to define what processing will be
performed within SAP.
Open the SAP program Partner Profiles (short cut menu code we20).
107
Partner type
108
Outbound Parameters
For a Partner Profile, the Outbound Parameters option can be used to configure all IDoc
Types that are required for outbound data transfer from SAP.
From any of the Partner Profile screens shown above, click Outbound parameters.
From the Outbound Parameters screen, you can click New entries or select Edit / New
entries to create a new Message Type entry.
109
Receiver Port
The name of the port to receive the IDoc. This name must be
a valid SAP Port. Typically it will be configured to the Port
definition created in the section above.
Package size
Output mode
Basic type
110
Inbound Parameters
For a Partner Profile, the Inbound Parameters option can be used to configure all IDoc
Types that are required for inbound data transfer into SAP.
From any of the Partner Profile screens shown above, click Inbound parameters.
From the Inbound Parameters screen, you can click New entries or select Edit / New
entries to create a new Message Type entry.
111
Process code
The code that defines what should be done with the inbound
data. This name must be a valid SAP Process Code.
Processing
Distribution Model
In order for SAP to pass data to XIB, the details of any configuration of Outbound and
Inbound Parameters must be associated with the Distribution Model that registers the
transfer of data between Logical Systems.
Open the SAP program Maintain distribution model (short cut menu code bd64).
112
In this screen, it is possible to add new Message Types from one Logical System to
another within a view of the Distribution model. Click Add message type, or select Edit
/ Message type / Add.
113
The main menu options for the maintenance of RFC Destinations, Port Definitions,
Partner Profiles, and many other ALE options, for example, IDoc definitions, are under
this sub menu.
Gateway Monitoring
The clients logged into a SAP gateway to receive IDocs from SAP can be displayed by
using the menu option:
Tools / Administration
Monitor / System Monitoring / Gateway monitor
or by using the short cut menu code smgw, and then the menu option:
Goto / Logged on systems
The Program Id entered in the Receive Method is displayed as the TP Name in this
screen.
114
Select the period to be displayed and the user name, and then click Execute.
This display can, for example, be used to monitor the status of transfers of IDocs from the
SAP system, and any reasons why the transfer failed. The status of the transfer is shown
in the Status Text column.
This display allows re-processing options, if the processing ends in error. In addition, the
default options for retrying the transfer can be set in this screen.
115
Select the range of values to view, and then the Execute option.
From this screen it is possible to drill down to view the individual IDocs and the statuses
that have been registered for the IDoc as it passes through the ALE system.
116
117
Enter the appropriate selection criteria for creating the report, and then click Execute.
Note that you should use one report to document each IDoc data structure you wish to
retrieve.
The IDoc report will be displayed:
118
To download the report from the SAP system, select List / Download. You will be
prompted for the format of the data to download:
Select unconverted, and then click Continue. You will be prompted for a local file
name:
119
Enter a file name, and change the path to the file if required, then click Transfer. The
report will be transferred to your local machine.
120
121
Inbound TIDs
Item
TID
Action
The transaction id for the message in SAP.
State
Date Received
Date Confirmed
Date Executed
Date Created
Outbound TIDs
Item
Transfer Id
Description
The Transfer Id for the message in Message Log.
TID
State
Date
122
This function creates an internal table corresponding to the parameters passed, and it
returns a handle to the table. These parameters can be used for the IMPORT and
EXPORT parameters required by SAP RFC-enabled functions.
The name argument is the name that is presented to the SAP system for this parameter
The length argument is the length of the buffer to be assigned.
The type argument should resolve to one of the values specified in e_ale.s4h
ERRORS
The only possible error is a memory allocation error; this will cause a termination of the
interpreter.
EXAMPLE
DECLARE $id[] INTEGER;
$id[1] = ALE.CreateParameter("RFCSI_EXPORT", $RFC_SystemInfo_Size,
$RFC_TypeCharacter);
SEE ALSO
A. MB Language Reference
123
ALE.FreeParameter
NAME
ALE.FreeParameter handle;
DESCRIPTION
SEE ALSO
A. MB Language Reference
124
ALE.GetParameter
NAME
ALE.GetParameter(handle);
DESCRIPTION
This function returns the data associated with the specified handle. The data is always
returned as a STRING type.
ERRORS
SEE ALSO
A. MB Language Reference
125
ALE.ItAppLine
NAME
The ALE.ItAppLine statement adds another entry to the end of the table created
previously by ALE.ItCreate.
The corresponding ABAP/4 operation is Append.
ERRORS
SEE ALSO
A. MB Language Reference
126
ALE.ItCreate
NAME
This function creates an internal table that can be used for the TABLE parameter required
by SAP RFC-enabled functions. A handle to the specified table is returned.
The name argument is the name that is presented to the SAP system for this parameter.
The length argument is the length of the buffer to be assigned.
The type argument should resolve to one of the values specified in e_ale.s4h
The mode argument should always be set to $RFC_Mode_ByReference
ERRORS
SEE ALSO
A. MB Language Reference
127
ALE.ItDelete
NAME
ALE.ItDelete handle;
DESCRIPTION
The ALE.ItDelete statement frees the memory associated with a table previously created
by ALE.ItCreate. The handle is no longer valid.
The corresponding ABAP/4 function is Free.
ERRORS
SEE ALSO
A. MB Language Reference
128
ALE.ItFill
NAME
ALE.ItFill(handle);
DESCRIPTION
This function returns the number of rows in a table previously created by ALE.ItCreate.
ERRORS
SEE ALSO
A. MB Language Reference
129
ALE.ItFree
NAME
ALE.ItFree Clears the contents of a table associated with the specified handle.
SYNTAX
ALE.ItFree handle;
DESCRIPTION
The ALE.ItFree statement clears the contents of a table previously created with
ALE.ItCreate. The handle is still valid, but the number of rows in the table is now zero.
The corresponding ABAP/4 operation is Free.
ERRORS
SEE ALSO
A. MB Language Reference
130
ALE.ItGetLine
NAME
ALE.ItGetLine(handle, rowNumber);
DESCRIPTION
This function returns the data that is indexed by rowNumber in the table associated with
the specified handle.
The corresponding ABAP/4 operation is Read Table Index
ERRORS
SEE ALSO
A. MB Language Reference
131
ALE.RfcCallReceive
NAME
A. MB Language Reference
132
SEE ALSO
ALE.IndirectCall
A. MB Language Reference
133
ALE.RfcClose
NAME
ALE.RfcClose rfcid;
DESCRIPTION
This statement closes a RFC connection to SAP that was previously opened by
ALE.RfcOpenOutboundConnection.
ERRORS
ALE.RfcOpenOutboundConnection, ALE.RfcOpenInboundConnection
A. MB Language Reference
134
ALE.RfcCreateTransId
NAME
ALE.RfcCreateTransId(rfcid);
DESCRIPTION
This function creates a unique transaction identity for the asynchronous dialogue with the
remote SAP system. This transaction Id can then be used with ALE.RfcIndirectCall.
ERRORS
ALE.IndirectCall
A. MB Language Reference
135
ALE.RfcError
NAME
ALE.RfcError(rfcid);
DESCRIPTION
This function returns the last error encountered by the RFC API. It should be used only
with those functions that do not have an error string as part of their parameter list.
EXAMPLE
A. MB Language Reference
136
ALE.RfcIndirectCall
NAME
The ALE.RfcIndirectCall statement is used to call a RFC enabled function module within
SAP.
The rfcid parameter is the handle returned by a previous call to
ALE.RfcOpenOutboundConnection.
The function parameter is the name of the function to call. This function has to be RFCenabled within SAP.
The tableHandles parameter is an array of integers that are handles to tables previously
created using ALE.ItCreate.
The exportHandles parameter is an array of integers that are handles to parameters
previously created by ALE.CreateParameter.
The transactionId parameter is a transaction id previously created using
ALE.RfcCreateTransId, if this is not passed, then no transaction id will be recorded
within SAP.
If the SAP function module does not require any of the above parameters, then empty
arrays should be declared and passed through.
ERRORS
$tables[] INTEGER;
$exportParameters[] INTEGER;
$tid STRING;
$data STRING;
$openId INTEGER;
ALE.RfcOpenOutboundConnection FKG
MODE
3
HOST
sap.frontec.com
SYSTEM
0
GWHOST
sap.frontec.com
GWSERV
3300
CLIENT
800
USER
sapuser
A. MB Language Reference
137
PASSWORD
LANGUAGE
TRACE
RFCID
ERROR
sappw
E
0
$openId
$errorString;
$tid = ALE.RfcCreateTransId($openId);
$tables[1] = ALE.ItCreate("IDOC_CONTROL", 464, $RFC_TypeCharacter,
$Rfc_Mode_ByReference);
ALE.ItAppLine $tables[1] DATA EDI_DC
ALE.RfcIndirectCall $openId
FUNCTION "INBOUND_IDOC_PROCESS"
TABLES
$tables
EXPORT
$exportParameters;
IF $error <> 0 {
$data = ALE.RfcError($openId);
LOG ERROR : & $data TYPE ERROR;
}
ALE.ItDelete $tables[1];
ALE.RfcClose $openId;
SEE ALSO
ALE.RfcCallReceive
A. MB Language Reference
138
ALE.RfcOpenOutboundConnection
NAME
ALE.RfcOpenOutboundConnection destination
MODE mode
HOST hostName
SYSTEM system
GWHOST gatewayHostName
GWSERV gatewayService
CLIENT client
USER user
PASSWORD password
LANGUAGE language
TRACE trace
RFCID openid
ERROR errorString;
DESCRIPTION
A. MB Language Reference
139
The errorString parameter is populated by the function if there is an error when trying to
connect to the SAP system.
ERRORS
ALE.RfcClose
A. MB Language Reference
140
ALE.SetParameter
NAME
This function sets the contents associated with the specified handle to data.
ERRORS
SEE ALSO
A. MB Language Reference
141
ALE.Version
NAME
ALE.Version()
DESCRIPTION
This function returns the version number of the ALE extension module.
EXAMPLE
DECLARE $data STRING;
$data = ALE.Version();
A. MB Language Reference
142
SAPABAP.InstallAndRun
NAME
Within the ABAP/4 source code, the area of code where substitution is to occur is
bounded by ### INSERT and ### END_INSERT contained within an ABAP/4 comment.
Within this section, substitutions will occur for the values that reference an index within
the substitution array. Each reference that occurs should be prefixed by a dollar sign ($).
Substituted values will be bounded by a pair of single braces.
For example, $1 will be substituted with the value held in first element of the substitution
array.
ERRORS
A. MB Language Reference
143
DECLARE
DECLARE
DECLARE
DECLARE
$nodeinfo[] STRING;
$rfcid INTEGER;
$output[] STRING;
$subs[] STRING;
A. MB Language Reference
144
SAPCONVERT.FloatToPackedDecimalBuffer
NAME
This function converts a Message Builder FLOAT variable into the SAP packed decimal
format (RFC_BCD).
The float parameter is the number to be converted.
The length parameter is the number of bytes that the result should occupy.
The decimals parameter is the number of decimal places.
ERRORS
A. MB Language Reference
145
SAPCONVERT.Int4BufferToInteger
NAME
This function converts a SAP RFC_INT4 type into a Message Builder INTEGER
variable.
The buffer parameter is the buffer to be converted.
ERRORS
A. MB Language Reference
146
SAPCONVERT.IntegerToInt4Buffer
NAME
This function converts a Message Builder INTEGER variable into a SAP RFC_INT4
type.
The buffer parameter is the buffer to be converted.
ERRORS
A. MB Language Reference
147
SAPCONVERT.PackedDecimalBufferToFloat
NAME
This function converts the SAP packed decimal format (RFC_BCD) into a Message
Builder FLOAT variable.
The buffer parameter is the number to be converted.
The decimals parameter is the number of decimal places.
ERRORS
A. MB Language Reference
148
SAPLIB.GetNodeInfo
NAME
This statement reads a tag file, and returns the information associated with the specified
nodeName.
The returned information is stored in the array nodeInfo. This array is set using the
corresponding constant instants found in saplib.s4h.
If the node is not found, then the ARRAYSIZE of nodeInfo will be zero.
EXAMPLE
DECLARE $nodeinfo[] STRING;
SAPLIB.ReadTagFile /amtrix/data/ale_connect;
SAPLIB.GetNodeInfo SAP NODEINFO $nodeinfo;
SEE ALSO
SAPLIB.OpenConnection
A. MB Language Reference
149
SAPLIB.OpenConnection
NAME
SAPLIB.OpenConnection(nodeinfo, trace);
DESCRIPTION
SEE ALSO
SAPLIB.GetNodeInfo, ALE.RfcOpenOutboundConnection
A. MB Language Reference
150
SAPLIB.GetSystemInfo
NAME
This statement returns system information associated with a remote SAP system. It uses
the function module RFC_SYSTEM_INFO.
The openId parameter should be a handle returned by either SAPLIB.OpenConnection or
ALE.RfcOpenOutboundConnection.
The statement returns the systemInfo parameter. This is an array that can be accessed
using the constant indexes defined in saplib.s4h.
EXAMPLE
DECLARE $nodeinfo[] STRING;
DECLARE $systeminfo[] STRING;
SAPLIB.ReadTagFile /amtrix/data/ale_connect;
SAPLIB.GetNodeInfo SAP NODEINFO $nodeinfo;
$openId = SAPLIB.OpenConnection($nodeinfo);
SAPLIB.GetSystemInfo $openId INFO $systeminfo;
A. MB Language Reference
151
SAPLIB.ReadTagFile
NAME
SAPLIB.ReadTagFile fileName;
DESCRIPTION
A. MB Language Reference
152
SAPLIB.SetDebug
NAME
SAPLIB.SetDebug debugFlag;
DESCRIPTION
The debugFlag can be zero or one, which indicate no debug and debug, respectively.
EXAMPLE
DECLARE $nodeinfo[] STRING;
DECLARE $systeminfo[] STRING;
SAPLIB.SetDebug 1;
SAPLIB.ReadTagFile /amtrix/data/ale_connect;
SAPLIB.GetNodeInfo SAP NODEINFO $nodeinfo;
$openId = SAPLIB.OpenConnection($nodeinfo);
SAPLIB.GetSystemInfo $openId INFO $systeminfo;
A. MB Language Reference
153
SAPUTIL.ReadTable
NAME
The SAPUTIL.ReadTable statement is used to read a database table within SAP. The
RFC-enabled function module RFC_READ_TABLE is used.
The rfcid parameter is the handle returned by a previous call to
ALE.RfcOpenoutboundConnection, or SAPLIB.OpenConnection.
The tableName parameter is the table to read.
The where parameter is the filter to be passed to the function module.
The fields output parameter is an array of elements containing the column information for
the specified table.
The data output parameter is an array of elements containing a single row from the
specified table.
The noData parameter can be set to 1 or 0. It defaults to zero, if set to 1, then no data is
returned in the data parameter.
The version parameter is used to indicate the version of the SAP system; if no version is
supplied, then it defaults to 3.
ERRORS
If there is an error during the call to this statement, then an error will be thrown.
EXAMPLE
DECLARE
DECLARE
DECLARE
DECLARE
DECLARE
DECLARE
DECLARE
DECLARE
SAPLIB.ReadTagFile /amtrix/data/ale_connect;
SAPLIB.GetNodeInfo SAP NODEINFO $nodeinfo;
$rfcid = SAPLIB.OpenConnection($nodeinfo, 0);
SAPUTIL.ReadTable $rfcid
TABLE $tablename
WHERE $where
FIELDS $fields
DATA $data
VERSION 4;
$actualData = SAPUTIL.GetTableData($requiredFields, $fields, $data,
4);
FOR $i=1 TO ARRAYSIZE($actualData) {
PRINT Doctyp = & $ActualData[$i][1] & \n;
A. MB Language Reference
154
SEE ALSO
SAPUTIL.GetTableData
A. MB Language Reference
155
SAPUTIL.GetTableData
NAME
The SAPUTIL.GetTableData function is used to extract data from each row of the table
in a structured array.
The requiredFields parameter is an array of field information used to match against the
column information returned by SAPUTIL.ReadTable.
The fields parameter is the fields parameter returned by SAPUTIL.ReadTable.
The data parameter is the data parameter returned by SAPUTIL.ReadTable.
The version parameter is used to indicate the version of the SAP system, it defaults to 3.
ERRORS
If there is an error during the call to this statement then an error will be thrown.
EXAMPLE
SAPUTIL.ReadTable
A. MB Language Reference
156
Description
Display usage
Display version information
Set mode to debug
Tag file. Using this argument enables the retrieval of
connection information from a tag file of the specified name.
Customer code. This argument specifies the selection
criterion for the display of customer details. Wildcards are
allowed, according to rules specified by SAP.
The program uses the RFC_CUSTOMER_GET Function Module to retrieve the customer
information.
/*
* SAP_GetCustomer.s4 - Implementation of Function Module
*
RFC_CUSTOMER_GET
*/
INCLUDE
INCLUDE
INCLUDE
INCLUDE
"saplib.s4h" ONCE;
"e_ale.s4h" ONCE;
"sysinfo.s4h" ONCE;
"sapCustomer.s4h" ONCE;
$programName = ARGUMENT(0);
/* Get arguments */
TRY {
WHILE $TRUE {
CASE ARG.GetOpt("?Vdn:t:c:")
WHEN "" {
BREAK;
}
WHEN "V" {
Version;
EXIT 0;
}
WHEN "?" {
Usage;
EXIT 0;
B. SAP Example
157
}
WHEN "d" {
$debugOn = $TRUE;
SAPLIB.SetDebug $TRUE;
}
WHEN "n" {
$node = ARG.GetOptArgument();
}
WHEN "t" {
$tagfile = ARG.GetOptArgument();
}
WHEN "c" {
$customer = ARG.GetOptArgument();
}
}
}
CATCH $exception
WHEN "EXECUTE" {
Usage;
EXIT 2;
}
IF ($tagfile <> "") {
SAPLIB.ReadTagFile $tagfile;
}
IF ($node = "" AND $tagfile = "") {
PRINTERR "Node or Tag file must be specified\n";
EXIT 3;
}
IF $customer = "" {
PRINTERR "Customer string must be specified\n";
EXIT 4;
}
/* Get the node information */
SAPLIB.GetNodeInfo $node NODEINFO $nodeInfo;
/* Open connection */
$openId = SAPLIB.OpenConnection($nodeInfo);
IF $openId = 0 {
LOG "Failed to Open connection" TYPE "DEBUG";
EXIT 5;
}
/* Call the function module */
GetCustomer $openId CUSTOMER $customer;
/* Close connection */
ALE.RfcClose $openId;
EXIT 0;
B. SAP Example
158
$tables[] INTEGER;
$exportParameters[] INTEGER;
$importParameters[] INTEGER;
$tableData STRING;
$customerInfo[] STRING;
$i INTEGER;
$limit INTEGER;
$errString STRING;
/* Set up tables */
IF $debugOn = $TRUE {
LOG "Generating table entries, and populating" TYPE "DEBUG";
}
$tables[1] = ALE.ItCreate("CUSTOMER_T",
197,
$RFC_TypeCharacter,
$RFC_Mode_ByReference);
/* Set up export parameters */
$exportParameters[1] = ALE.CreateParameter("KUNNR", 10,
$RFC_TypeCharacter);
ALE.SetParameter $exportParameters[1] DATA LEFT($customer, 10);
$exportParameters[2] = ALE.CreateParameter("NAME1", 35,
$RFC_TypeCharacter);
ALE.SetParameter $exportParameters[2] DATA LEFT("*", 35);
IF $debugOn = $TRUE {
LOG "Calling RFC_CUSTOMER_GET" TYPE "DEBUG";
}
/* Call remote SAP function */
ALE.RfcCallReceive $openId
FUNCTION "RFC_CUSTOMER_GET"
EXPORT
$exportParameters
IMPORT
$importParameters
TABLES
$tables
ERROR
$errString;
IF ($errString <> "") OR ($error <> 0) {
LOG "Error occured during RFC call" TYPE "DEBUG";
IF $debugOn = $TRUE {
LOG "Details :"
& "error [" & $error & "], "
& "error string [" & $errString & "]\n"
TYPE "DEBUG";
}
RETURN;
}
$limit = ALE.ItFill($tables[1]);
IF $debugOn = $TRUE {
LOG "Number of records found : "
& $limit & "\n"
TYPE "DEBUG";
}
FOR $i = 1 TO $limit {
$tableData = ALE.ItGetLine($tables[1], $i);
ResolveCustomerInfo $tableData INFO $customerInfo;
LOG "Customer details :\n"
B. SAP Example
159
&
&
&
&
&
&
&
&
&
&
&
&
&
&
&
&
&
&
"
Number
= "
$customerInfo[$RFC_Customer_Number] & "\n"
"
Title
= "
$customerInfo[$RFC_Customer_Title] & "\n"
"
Name
= "
$customerInfo[$RFC_Customer_Name] & "\n"
"
POBox
= "
$customerInfo[$RFC_Customer_POBox] & "\n"
"
Street
= "
$customerInfo[$RFC_Customer_Street] & "\n"
"
PostalCode = "
$customerInfo[$RFC_Customer_PostalCode] & "\n"
"
City
= "
$customerInfo[$RFC_Customer_City] & "\n"
"
Telephone = "
$customerInfo[$RFC_Customer_Telephone] & "\n"
"
Fax
= "
$customerInfo[$RFC_Customer_Fax] & "\n"
TYPE "INFO";
}
/* Tidy up */
ALE.FreeParameter $exportParameters[1];
ALE.FreeParameter $exportParameters[2];
ALE.ItDelete $tables[1];
RETURN;
}
=
=
=
=
=
=
=
=
=
STRMID($data,
STRMID($data,
STRMID($data,
STRMID($data,
STRMID($data,
STRMID($data,
STRMID($data,
STRMID($data,
STRMID($data,
1, 10);
11, 25);
26, 60);
61, 70);
71, 105);
106, 115);
116, 150);
151, 166);
167, 197);
RETURN;
}
/*
* Customer data
*/
DECLARE $RFC_Customer_Number
DECLARE $RFC_Customer_Title
DECLARE $RFC_Customer_Name
DECLARE $RFC_Customer_POBox
DECLARE $RFC_Customer_Street
DECLARE $RFC_Customer_PostalCode
DECLARE $RFC_Customer_City
DECLARE $RFC_Customer_Telephone
DECLARE $RFC_Customer_Fax
=
=
=
=
=
=
=
=
=
1
2
3
4
5
6
7
8
9
CONSTANT
CONSTANT
CONSTANT
CONSTANT
CONSTANT
CONSTANT
CONSTANT
CONSTANT
CONSTANT
INTEGER;
INTEGER;
INTEGER;
INTEGER;
INTEGER;
INTEGER;
INTEGER;
INTEGER;
INTEGER;
B. SAP Example
160
B. SAP Example
161
INDEX
A
ABAP/4..................................................... 32
activation type ......................................... 105
activity
receive ................................................... 41
send ....................................................... 41
ADF file
creating an ............................................. 27
ALE........................................................... 10
configuration ....................................... 114
ALE Gateway Object ................................ 47
ALE inbound search
ALE tab ................................................. 81
ALE logon object ...................................... 49
General tab ............................................ 49
preferences tab ...................................... 49
ALE Manager
concept .................................................. 39
retrieve and receive methods................. 55
send methods................................... 47, 60
ALE methods, creating.............................. 39
ALE node object ....................................... 52
General tab ............................................ 52
ALE objects
creating.................................................. 47
ALE outbound search
ALE tab ................................................. 84
ALE receive method ................................. 58
ALE tab ................................................. 59
concept .................................................. 39
creating.................................................. 55
General tab ............................................ 58
lack criteria............................................ 59
private.................................................... 55
public..................................................... 55
ALE Received
IDoc Data tab ........................................ 89
Parameters tab ....................................... 87
Properties tab......................................... 86
Transfer Data tab................................... 89
Transfer message tab............................. 87
ALE retrieve method................................. 55
ALE tab ................................................. 57
concept .................................................. 39
creating.................................................. 55
execution ............................................... 40
General tab ............................................ 55
Schedule tab .......................................... 56
ALE send method...................................... 60
ALE tab ................................................. 63
concept .................................................. 39
creating.................................................. 60
execution ............................................... 40
General tab ............................................ 60
XIB: SAP/R/3 Manual
private........................................47, 60, 76
public.........................................47, 60, 76
Retry tab ................................................61
Schedule tab ..........................................62
ALE send tab, Data sent successfully........93
ALE status tab, Status update completed
successfully ...........................................95
ALE status update method ........................76
ALE tab .................................................79
creating..................................................75
General tab ............................................76
Retry tab ................................................77
Schedule tab ..........................................78
ALE tab
ALE receive method..............................59
ALE retrieve method .............................57
ALE send method..................................63
ALE status update method ....................79
search ALE outbound search.................84
search ALE send events ........................82
ALE tasks
creating..................................................39
ALE tasks, creating ...................................43
ALE transfer adapter task..........................43
Configuration tab...................................44
General tab ............................................43
Start Up tab ...........................................45
Transfer Adapter tab..............................44
ALE transfer classifier task .......................46
ALE.CreateParameter .............................124
ALE.FreeParameter.................................125
ALE.GetParameter ..................................126
ALE.ItAppLine .......................................127
ALE.ItCreate ...........................................128
ALE.ItDelete ...........................................129
ALE.ItFill ................................................130
ALE.ItFree ..............................................131
ALE.ItGetLine.........................................132
ALE.RfcCallReceive...............................133
ALE.RfcClose .........................................135
ALE.RfcCreateTransId............................136
ALE.RfcError..........................................137
ALE.RfcIndirectCall ...............................138
ALE.RfcOpenOutboundConnection .......140
ALE.SetParameter...................................142
ALE.Version ...........................................143
Application Link Enabling ........................10
attributes
concept ................................................101
receive .................................................101
send .....................................................102
B
BAPI
arguments ..............................................29
Index
162
classification activity................................. 64
Configuration tab .................................. 65
General tab ............................................ 65
classification configuration
IDoc, EDI tab ........................................ 66
Sender, Receiver tab.............................. 68
client number........................... 17, 50, 94, 96
configuration
general................................................... 39
Configuration tab
classification activity............................. 65
stage dialog ........................................... 75
Configuration tab, ALE transfer adapter task
............................................................... 44
connection type ....................................... 105
control value, overriding ......................... 101
conversions
data........................................................ 33
criteria, lacking in ALE receive methods.. 59
criteria, lacking in FTP receive methods... 41
custom MCB ............................................. 72
D
data classifier............................................. 64
data conversions ........................................ 33
data element .............................................. 26
Data sent successfully
ALE send tab......................................... 93
Properties tab......................................... 91
Transfer report tab................................. 92
data structure ............................................. 26
Data tab, IDoc Document Number............ 97
dev_rfc file .......................................... 50, 58
display IDoc types........................... 110, 112
DNS name ............................... 16, 53, 93, 96
drill down options ................................... 117
E
event type
ALE Received ....................................... 86
AleStatusReport .................................... 94
SampleIDocStatus ................................. 99
events, searching for.................................. 81
function
PackSendMethodOverrideAttribute ....103
function group name..................................33
function module
metadata ................................................34
naming convention ................................29
function modules .................................11, 32
export parameters ..................................32
import parameters..................................32
tables .....................................................32
function name............................................33
G
gateway .....................................................16
host ................................ 88, 89, 94, 96, 97
monitoring ...........................................115
SAP .......................................................48
service .......................................48, 94, 96
Gateway Object .........................................47
General tab ............................................47
General tab
ALE logon object ..................................49
ALE node object....................................52
ALE receive method..............................58
ALE retrieve method .............................55
ALE send method..................................60
ALE status update method ....................76
ALE transfer adapter task......................43
classification activity.............................65
Gateway Object .....................................47
sequential activity..................................73
group .........................................................26
I
IDoc
subsystem ..............................................10
IDoc Classifier ..........................................64
IDoc Classifier tab
search IDoc data classifier events..........85
IDoc data classifier events
IDoc Classifier.......................................85
search.....................................................85
IDoc data structure ....................................26
IDoc Data tab, ALE Received...................89
IDoc definitions.......................................115
IDoc Document Number
Data tab .................................................97
Properties tab.........................................97
IDoc packet ...............................................26
IDoc packets..............................................27
IDoc report ..........................................14, 21
from XIB client .....................................23
from XIB server ....................................24
generating and downloading .................22
Index
163
MBC
custom ................................................. 101
message attributes ................................... 101
Message Builder programs
to access BAPIs, function modules, and
SAP transactions ............................... 11
Message Log
concept .................................................. 39
display asynchronous IDoc status update
creator events .................................... 99
display IDoc data classifier event.......... 97
display retrieve events........................... 86
display send events.......................... 91, 94
log entries.............................................. 42
search IDoc data classifier events ......... 85
search receive events............................. 81
search send events ........................... 82, 83
metadata
in IDoc report ........................................ 14
levels of ................................................. 26
metadata types........................................... 17
method....................................................... 31
ALE receive .......................................... 58
ALE retrieve.......................................... 55
ALE send............................................... 60
ALE status update ................................. 76
mode version ....................................... 63, 80
monitoring
gateways.............................................. 115
PackSendMethodOverrideAttribute function
.............................................................103
parameter...................................................31
metadata ................................................34
parameter type ...........................................31
Parameters tab, ALE Received..................87
partner profile..........................................108
partner profiles
maintaining..........................................115
password.................................. 17, 50, 94, 97
port
SAP .....................................................106
port definition.......................... 106, 107, 113
port definitions
maintaining..........................................115
preferences tab, ALE logon object ............49
private receive method ..............................55
private send method ......................47, 60, 76
program ID ..........................................58, 88
Properties tab
ALE Received .......................................86
Data sent successfully ...........................91
IDoc Document Number .......................97
Sample asynchronous IDoc status update
...........................................................99
Status update completed successfully ...94
public receive method ...............................55
public send method........................47, 60, 76
R
receive activity
concept ..................................................39
execution .........................................40, 41
receive attributes, ReceiveInfoAttribute..101
receive events
search.....................................................81
receive method
creating..................................................55
execution ...............................................40
private....................................................55
public.....................................................55
ReceiveInfoAttribute receive attribute ....101
record, defined...........................................26
Index
164
SAPCONVERT.FloatToPackedDecimalBuf
fer ........................................................146
SAPCONVERT.Int4BufferToInteger .....147
SAPCONVERT.PackedDecimalBufferToFl
oat........................................................149
SAPLIB.GetNodeInfo .............................150
SAPLIB.GetSystemInfo ..........................152
SAPLIB.OpenConnection .......................151
SAPLIB.ReadTagFile .............................153
SAPLIB.SetDebug ..................................154
SAPUTIL.GetTableData .........................157
SAPUTIL.ReadTable ..............................155
schedule definition
general ...................................................40
in ALE retrieve method.........................56
in ALE send method..............................62
in ALE status update method ................78
Schedule tab
ALE retrieve method .............................56
ALE send method..................................62
ALE status update method ....................78
search ALE send events
ALE tab .................................................82
send activity
concept ............................................39, 40
execution .........................................40, 41
send attributes..........................................102
send events
display .......................................91, 97, 99
search...............................................82, 83
send method
creating..................................................60
execution ...............................................40
private........................................47, 60, 76
public.........................................47, 60, 76
Sender, Receiver tab
classification configuration ...................68
sequential activity
General tab ............................................73
Stages tab ..............................................73
stage dialog................................................74
Configuration tab...................................75
General tab ............................................74
Stages tab, sequential activity ...................73
Start Up tab, ALE transfer adapter task.....45
Status update completed successfully
ALE status.............................................95
Properties tab.........................................94
Transfer report tab.................................95
synchronous call
to BAPI................................................158
to SAP function module ..................8, 158
synchronous call to a SAP Function Module
example .................................................33
synchronous dialog
with SAP ...............................................32
system number ........................ 16, 53, 93, 96
Index
165
tables ......................................................... 32
Task Manager, concept ............................. 39
tasks
ALE transfer adapter ............................. 43
ALE transfer classifier .......................... 46
tasks, creating............................................ 43
TCP/IP host name, or .............. 16, 53, 93, 96
trace......................................................... 105
transaction code
of SAP transaction................................. 36
transactional RFC.................................... 115
UnpackReceiveAttribute .........................101
UnpackReceiveAttribute function ...........101
Index
166