Skip to content

Latest commit

 

History

History
134 lines (106 loc) · 8.61 KB

README.md

File metadata and controls

134 lines (106 loc) · 8.61 KB
Raw

FUSE SAP Queued IDoc List Destination Endpoint Quick Start

Demonstrates the sap-qidoc-destination component running in a Fuse camel runtime.
SAP Tool Suite

Author: William Collins - Fuse Team
Level: Intermediate
Technologies: Fuse, SAP, Camel, Blueprint
Summary: This quickstart demonstrates how to configure and use the sap-qidoclist-destination component in a Fuse environment to send Intermediate Document (IDoc) Lists to SAP. This component sends IDoc document lists to SAP using the Queued RFC (qRFC) protocol.
Target Product: Fuse
Source: http://github.com/punkhorn/sap-quickstarts/

What is it?

This quick start shows how to integrate Apache Camel with SAP using the JBoss Fuse SAP Queued IDoc List Destination Camel component. This component and its endpoints should be used in cases where a camel route is required to send a list of Intermediate documents (IDocs) list to an SAP system and ensure that the document lists are processed in the SAP system in the same order that they were sent.

This quick start contains a route with an initial timer endpoint which triggers and executes that route once. The route uses processor beans to build IDoc document lists containing FLCUSTOMER_CREATEFROMDATA01 type IDoc documents to create Customer records in SAP. These document lists are routed to sap-qidoclist-destination endpoints which use the qRFC protocol to send these document lists to the inbound queue QUICKSTARTQUEUE in SAP. When this queue is triggered, the document lists are delivered in order to the ALE subsystem in SAP which creates the Customer records. The route logs to the console the serialized contents of the document lists it sends.

In studying this quick start you will learn:

  • How to configure the Fuse runtime environment in order to deploy the JBoss Fuse SAP Queued IDoc Destination Camel component.
  • How to define a Camel route containing the JBoss Fuse SAP Queued IDoc List Destination Camel component using the Blueprint XML syntax.
  • How to use the JBoss Fuse SAP Queued IDoc List Destination Camel component to send IDoc Lists to SAP.
  • How to configure connections used by the component.

For more information see:

System requirements

Before building and running this quick start you will need:

  • Maven 3.1.1 or higher
  • JDK 1.8
  • A JBoss Fuse 7.0.0 container
  • SAP JCo3 and IDoc3 libraries (sapjco3.jar, sapidoc3.jar and JCo native library for your OS platform)
  • SAP instance with Flight Data Application setup.

Configuring the ALE Subsystem

To send IDoc Lists from the quick start's route to your SAP system, you must first configure the Application Linking Enabling (ALE) subsystem in your SAP system:

  1. Using the SAP GUI, run transaction SALE, the ALE Implementation Guide.

  2. Ensure that Logical Systems for the quick start and your SAP client have been defined:
    a. Run the Define Logical System step (Basic Systems > Logical Systems > Define Logical System).
    b. Click New Entries and create and save the following logical systems:

     | Log.System | System     |   
 | ---------- | ---------- |     
 | QUICKSTART | QUICKSTART |      
 | QUICKCLNT  | QUICKCLNT  |

    c. Return to the SALE transaction main screen (Goto > Back).

  3. Ensure the QUICKCLNT logical system has been assigned to you SAP client:
    a. Run the Assign Logical System to Client step (Basic Settings > Logical Systems > Assign Logical System to Client).
    b. Select the QUICKCLNT for your client's Logical system and save your changes.
    c. Return to the SALE transaction main screen (Goto > Back).

  4. Ensure the destination QUICKSTART has been defined:
    a. Run the Create RFC Connections step (Communication > Create RFC Connections).
    b. Create a new destination (Edit > Create):
    1. RFC Destination : QUICKSTART.
    2. Connection Type : T.
    3. Technical Settings :
    i. Activation Type : Registered Server Program.
    ii.Program ID : QUICKSTART.
    4. Unicode:
    i. Communication Type with Target System : Unicode
    c. Return to the SALE transaction main screen (Goto > Back).

  5. Ensure that a Model View for the message flow from the quick start to your SAP system has been defined:
    a. Run the Maintain Distribution Model and Distribute Views step (Modelling and Implementing Business Processes > Maintain Distribution Model and Distribute Views).
    b. Ensure a QUICKSTART model view has been created with the technical name QUICKSTART (Edit > Model view > Create).
    c. Ensure the QUICKSTART model view has a BAPI call configured (Edit > Add BAPI):

    1. Sender/client : QUICKSTART.
    2. Reciever/server : QUICKCLNT.
    3. Obj.name/interface : FlightCustomer.
    4. Method : CreateFromData.
      d. Ensure Partner Profiles have been generated for the quick start and your SAP client (Environment > Generate Partner Profiles).

Configuring the Quickstart for your environment

To configure the quick start for your environment:

  1. Deploy the JCo3 library jar and native library (for your platform) and IDoc3 library jar to the lib folder of your JBoss Fuse installation.
  2. In your JBoss Fuse installation, copy the org.osgi.framework.system.packages.extra property from the config properties file (etc/config.properties) to the custom properties file (etc/custom.properties) and append the following packages to the copied property:

org.osgi.framework.system.packages.extra = \

... \
com.sap.conn.idoc, \
com.sap.conn.idoc.jco, \
com.sap.conn.jco, \
com.sap.conn.jco.ext, \
com.sap.conn.jco.monitor, \
com.sap.conn.jco.rt, \
com.sap.conn.jco.server

  1. Ensure that the SAP Instance Configuration Configuration Parameters in the parent pom.xml file (../../.pom.xml) of quick starts project has been set to match the connection configuration for your SAP instance.

Build and Run the Quickstart

To build and run the quick start:

  1. Change your working directory to the sap-qidoclist-destination-fuse directory.
  • Run mvn clean install to build the quick start.
  • In your JBoss Fuse installation directory run, ./bin/fuse to start the JBoss Fuse runtime.
  • In the JBoss Fuse console, run install -s mvn:org.fusesource/camel-sap to install the JBoss Fuse SAP Synchronous Remote Function Call Destination Camel component. Note the bundle number for the component bundle returned by this command.
  • In the JBoss Fuse console, run install -s mvn:org.jboss.quickstarts.fuse/sap-qidoclist-destination-fuse to install the quick start. Note the bundle number for the quick start returned by this command.
  • In the JBoss Fuse console, run log:tail to monitor the JBoss Fuse log.
  • In the JBoss Fuse console observe the document lists sent by the endpoint.
  • Execute the queued IDoc lists waiting in the inbound queue QUICKSTARTQUEUE. Using the SAP GUI, run transaction SMQ2, the Inbound Queue qRFC Monitor:
    a. Select the QUICKSTARTQUEUE queue.
    b. Display the queue contents (Edit > Display Selection).
    c. Select the entry for your Client connection and activate the queue (Edit > Activate).
  • Using the SAP GUI, run transaction SE16, Data Browser, and display the contents of the table SCUSTOM.
  • Search the table (Edit > Find..) for the newly created Customer records: Fred Flintstone, Wilma Flintstone, Barney Rubble, and Betty Rubble.

Stopping and Uninstalling the Quickstart

To uninstall the quick start and stop the JBoss Fuse run-time perform the following in the JBoss Fuse console:

  1. Enter Ctrl-c to stop monitoring the JBoss Fuse log.
  • Run uninstall <quickstart-bundle-number> providing the bundle number for the quick start bundle.
  • Run uninstall <camel-sap-bundle-number> providing the bundle number for the component bundle.
  • Run shutdown -f to shutdown the JBoss Fuse runtime.