adeptia suite 6.2 sap integration guide · pdf fileviewing logs and status details ... the...

Adeptia Suite 6.2

SAP Integration Guide

Release Date March 17, 2015

343 West Erie, Suite 440 Chicago, IL 60654, USA

Phone: (312) 229-1727 x111 Fax: (312) 229-1736

Document Information

2 Adeptia Incorporation Adeptia

DOCUMENT INFORMATION Adeptia Inc.

SAP Integration Guide

Printed September 2014

Printed in USA

Adeptia Support Information

For support queries, please contact us at [email protected].

Access the Adeptia Web site at the following URL:

www.adeptia.com

Copyright

Copyright © 2000-2015 Adeptia, Inc. All rights reserved.

Trademarks

Adeptia™ is a trademark of Adeptia, Inc. All other trademarks and registered trademarks are the property of their respective owners.

Confidentiality

This document is the confidential and proprietary information of Adeptia. The information set forth herein represents the confidential and proprietary information of Adeptia. Such information shall only be used for the express purpose authorized by Adeptia and shall not be published, communicated, disclosed or divulged to any person, firm, corporation or legal entity, directly or indirectly, or to any third person without the prior written consent of Adeptia.

Disclaimer

Adeptia, Inc. provides this publication "as is" without warranty of any kind, either express or implied. In no event shall Adeptia be liable for any loss of profits, loss of business, loss of use or data, interruption of business, indirect, special, punitive, incidental, or consequential damages of any kind.

No part of this work should be reproduced in any form or by any means—graphic, electronic, or mechanical—including photocopying, recording, taping, or storage in an information retrieval system, without prior written permission of Adeptia Inc.

This publication is subject to replacement by a later edition. To determine if a later edition exists, contact www.adeptia.com.

mailto:[email protected]

http://www.adeptia.com/

Table of Contents

Adeptia Incorporation Adeptia Suite SAP Integration Guide 3

TABLE OF CONTENTS Document Information .................................................................................................................................................. 2

Table Of Contents .......................................................................................................................................................... 3

Preface ........................................................................................................................................................................... 4

Introduction ................................................................................................................................................................... 7

Configuring Adeptia Suite for Sap Integration ............................................................................................................... 7

Adeptia Sap Integration ................................................................................................................................................. 9

Receiving IDoc From Sap Server ................................................................................................................................ 9

Creating a SAP Client ............................................................................................................................................. 9

Creating a process flow ....................................................................................................................................... 11

Creating a SAP Server .......................................................................................................................................... 14

Sending IDoc to Sap Server ..................................................................................................................................... 16

Create a SAP IDoc Schema .................................................................................................................................. 17

Steps to Create an IDOC Schema ........................................................................................................................ 17

Create a Process Flow ......................................................................................................................................... 19

Steps to create a Process Flow ........................................................................................................................... 19

Viewing Logs And Status Details ............................................................................................................................. 22

Preface


.1. PREFACE The SAP Integration guide enables you to send or receive Intermediate Document (IDoc), which is a SAP document format for business transaction data transfers.

Target Audience

This document is intended for the users willing to Integrate SAP, i.e., exchanging SAP information among business partners for e.g. receiving IDoc from SAP server or sending IDoc to SAP server.

HOW IS THIS GUIDE ORGANIZED?

This guide is organized into the following sections:

Section Description

Preface Introduction to this document

Introduction Need for SAP Integration, Adeptia’s SAP Integration service and Benefits of using it

Configuring Adeptia Suite for SAP Integration

Prerequisites, Starting SAP Integration service, Downloading and configuring SAP Connector

Adeptia Sap Integration Steps to send and receive IDoc. Creating required activities and viewing logs

Preface


CONVENTIONS

The following tables list the various conventions used in Adeptia documentation. We follow these conventions to help you quickly and easily identify particular elements, processes, and names that occur frequently in documents.

Typographical conventions

This guide uses the following typographical conventions:

Convention Description

Bold text Indicates one of the following:

Screen element

New terminology

A file or folder name

A control in an application’s user interface

Important information

Italic text Indicates a reference or the title of a publication.

Monospaced text Indicates code examples or system messages.

Monospaced bold text Indicates system commands that you enter.

Hyperlink Indicates an Internet link to target material.

Graphical conventions

This guide uses the following graphical conventions:

Convention Description

Indicates additional information that may be of interest to the reader.

Preface


CONTACTS/REPORTING PROBLEMS

These sections present contact information for a variety of situations.

Sales

In case of any sales queries, please contact us at [email protected].

Support

For support queries, please contact us at [email protected].

Latest updates and information

For the latest updates and information, please visit us at www.adeptia.com.

Adeptia Website

Access the Adeptia Website at the following URL:

www.adeptia.com





Introduction


.2.

INTRODUCTION At times while working with an Adeptia product, you may come across a situation, where you may need to process information which is in an IDoc format. For this, you need to use SAP Integration service. Problems like IDoc extraction, migration or synchronization between SAP and other systems can be solved through Adeptia’s SAP Integration service. For example, let’s say you have a partner who uses SAP as the platform for business, you need to exchange key business information with that partner. The Adeptia’s SAP Integration service enables you to do so by exchanging IDoc between SAP server and Adeptia Suite.

CONFIGURING ADEPTIA SUITE FOR SAP INTEGRATION

This section describes the steps required to configure Adeptia Suite for SAP Integration.

Requirements

Adeptia SAP Accelerator uses SAP Java Connector (SAP JCo and SAP IDoc) to communicate with SAP server. If

you have a market place account, you can download the SAP installation files from

http://service.sap.com/connectors.

After installing SAP java connectors, you need to configure Adeptia Suite. To communicate with SAP server along

with trading partners, and to process IDocs, Adeptia’s SAP Integration service provides several business

processes that work together. These business processes use activities to retrieve documents, perform IDoc

translations, and send documents. These business processes must be used together in a sequence.

Pre-requisite

Bit version of both JRE and OS should be the same

Adeptia Suite 6.2 or higher version

Download and configure SAP Connector

1. Go to SAP Market Place http://service.sap.com/connectors.

2. Login with your user name and password.

3. Download the SAP Java Connector.

4. Copy the following native files from the downloaded package and drop it under the mentioned locations as per your OS:

http://service.sap.com/connectors

http://service.sap.com/connectors

Introduction


OS File Name Location

Windows sapjco.dll C:\Windows\System32 and C:\Windows\SysWOW64

Linux libsapjco3.so /usr/lib

Adeptia SAP Integration


2 3. ADEPTIA SAP INTEGRATION This section describes:

1. Receiving IDoc from SAP Server

2. Sending IDoc to SAP Server

3. Viewing logs and status details

RECEIVING IDOC FROM SAP SERVER

Adeptia Suite can receive IDoc in XML format from a remote SAP Server. This section provides information on receiving IDocs from SAP server by using Adeptia Suite.

High level steps to receive data from SAP server are as follows:

Creating SAP Client

Creating a process flow

Creating XML Source

Creating IDoc Schema

Creating Target Schema

Mapping IDoc Schema to Target

Creating Target Activity

Creating SAP Server

Creating a SAP Client

A client is an activity created in Adeptia Suite to communicate with the SAP server. While sending IDoc it does not require any gateway, IDoc is directly sent through a Client. However when receiving IDoc from SAP, Adeptia’s SAP Server activity acts as a gateway, and client is the receiving end of a service in a client/server model type of system. Following are the steps to create SAP client with Adeptia Suite:

Steps to Create a SAP Client

1. On the Adeptia Suite home page, click the Develop tab.

Gateway

Adeptia’s SAP Server

Adeptia’s SAP Client

Sending IDoc

to SAP

Receiving IDoc

from SAP



2. Go to Solutions > SAP and then click Client.

3. Click the Create New link. The New Client screen is displayed (see Figure 1).

Figure 1: Create a SAP Client

4. Enter the values for the Client Configuration Properties. Refer Table 1 for help.

Table 1: Client Configuration

Field Name Description Example

Name Name of the Client Activity SAPClient

Description Description of the client Activity Sending Text files to SAP Server

Destination Name Client destination from which to

obtain the repository

CF5DLNL800

Destination Client SAP client 890

Connection Type The number of connections that

should be registered at the

Instance/Group




gateway

Destination Host SAP application server host cpdF511

Destination System Number SAP system number 08

Destination Routing String SAP router string to use for networks being protected by a firewall

/H/128.0.1.1/H/

Destination Username Logon user Adeptia

Destination Password Logon password Password123

To know what values to enter in the above fields, please contact the administrator who manages your SAP server.

5. Enter the values for More Configuration and Advanced Properties fields if required.

To learn about Advanced Properties refer to Changing Advanced Properties section of the Developer Guide.

6. Click Save.

You may click the Test button to check whether all your client credentials are valid and the

connection is established successfully or not. It prompts you in both the cases.

Creating a process flow

A process flow is a set of activities arranged in a sequence to perform a specific task(s). Combining various

activities i.e. Source, Target, Schema or Transformer etc. creates a process flow.

This section explains the steps to process IDoc using Adeptia’s process flow and transformation features. You can

design process flow in Adeptia to read the IDoc file from the location where SAP server places it and further can

transform the file using Adeptia Data mapper to text or any data format as per requirement.



To know more about process flows, please refer to the Working with Process Flow section of the Developers Guide.

Alternatively, you may send or receive IDocs Using Data interface method. With this method you don’t need to create a new process flow, you can simply use the Default_Data_Interfaces process flow.

Refer to the Using Data Interface section of the Developers Guide for details.


2. Go to Services > Source to create an xml source activity.

Adeptia Suite enables you to transfer data from any source location to any target location. In order to transfer any data, you need to first fetch the data. To perform the same, you need to create a Source activity. The Source activity enables you to specify the location, where the data is stored.

To know how to create the Source activity, refer to the Creating Source Activity section of the Developer Guide.

Please ensure that the eventContextEnabled property of the source activity is set to true. This overrides the source file with the file received from SAP server.

3. Go to Services > Schema and then click XML.

4. Click the IDoc Schema link to create a SAP IDoc schema.

You use a schema activity to parse data from all the supported data type formats and transform it into any of the supported data types. What a schema actually does is that, it apprehends data from the source, transforms it into XML, and then commits it to the source in the requested format. If you want data transformation then you need to use different types of schema activities both at the source and target end of your Process flow.

To know how to create Schema activity, refer to the Creating Schema Activity section of the Developer Guide.

5. Go to Services > Target to create a Target activity.

Adeptia Suite enables you to transfer data from any source location to any target location. Once you have fetched the data (by creating a source activity) and defined the file format for the source data or the target data (by creating a schema), you will be required to create a target activity. A Target Activity allows you to identify specific data that you can create



and the means to deliver it.

To know how to create the Target activity, refer to the Creating Target Activity section of the Developer Guide.

6. Go to Services > Schema to create a schema for your Target activity.

7. Go to Services > Data Transformation and then click Data Mapping to map the SAP IDoc schema with the Target schema (see Figure 2).

Figure 2: Mapping Activity

Data Mapper is a visual data-mapping tool used for mapping elements in advanced data integration projects. This tool allows you to specify source and target schemas and to map data fields from source schema to target schema.

To know how to Map Source and Target Elements refer to the Map Source and Target

Elements section of the developers Guide.

8. Go to Process > Process Flow to create a new process flow. The Process Designer window is displayed.

9. Arrange these activities in the following sequence through process designer (see Figure 3).

Source > SAP IDoc Schema > Mapping > Target Schema > Target



Figure 3: Process Flow

The Process Designer is easy to use and enables both technical and non-technical users to design processes.

To know how to use process designer, please refer Understanding Process Designer section

of the Developer Guide.

The received files are then transformed in the format you selected.

Creating a SAP Server

SAP server is an activity created in Adeptia Suite to facilitate the communication with SAP and thereby receive IDoc. It is a type of gateway or a proxy server that routes between client and SAP. Following are the steps to create SAP server with Adeptia Suite:

Steps to Create a SAP Server


2. Go to Solutions > SAP and then click Server.

3. Click the Create New link. The New Server screen is displayed (see Figure 4).



Figure 4: Create a SAP Server

4. Enter the values for the Server Configuration Properties. Refer Table 2 for help.

Table 2: Server Configuration


Name Name of the Server Activity SAPServer

Description Description of the client Activity Receiving Text files from SAP Server

Gateway Host Gateway host on which the

server should be registered

CF5CLNT800

/H/127.1.1.3/H/cpcF501

Gateway Server Gateway service, i.e. the port

on which a registration can be

done

Sapgk15

Program Id The program ID with which the

registration is done

ADEPTIDTEST12




Connection Count The number of connections that

should be registered at the

gateway

Instance/Group

SAP Client SAP client 880

Test You may click the Test button

to check whether the

connection with SAP client is

established successfully or not.

If the connection is successfully

established then the Test button

displays Tested, else Failed on it.

Process Flow Name Name of the Process Flow SAPServer_ProcessFlow

5. Enter the values for More Configuration and Advanced Properties fields if required.

To learn about Advanced Properties refer to Changing Advanced Properties section of the Developer Guide.

6. Activate the Server.

IDocs received from the SAP Server are stored in the

[AdeptiaInstallDir]/Serverkernel/web/SAPIDocLocation] folder.

SENDING IDOC TO SAP SERVER

Adeptia Suite can send IDoc in XML format to a remote SAP Server. This section provides information on sending IDocs to SAP server by using Adeptia Suite.

High level steps to send data to SAP Server are as follows:

Creating a Process flow

Creating Source activity

Creating Source Schema

Creating SAP IDoc Schema

Map Source to IDoc Schema

Creating SAP Client



Create a SAP IDoc Schema

SAP IDoc definition files can be uploaded in Adeptia (offline definition mode) or can be created by selecting an IDoc from the existing IDoc list from SAP (online definition mode) to create Schemas. Adeptia SAP Integration service uses these schemas to generate and validate IDocs in inbound and outbound processes. Follow below steps to create schema using IDoc definition file:

Steps to Create an IDOC Schema



3. Click the IDoc Schema link. The New IDoc Schema screen is displayed (see Figure 5).

Figure 5: Creating New IDoc Schema – Offline Definition Mode

4. Enter the Name and Description of the Schema in respective fields.

5. Select a Definition Mode for your schema.

6. If you have the required IDoc schema definition file, then select the Offline definition mode and click

the Browse button to upload the IDoc schema (see Figure 5).

Offline mode is used when you do not need to communicate with the SAP server for

creating Schemas. That is, when you already have the required definition file.

7. If you do not have the required definition file, follow the steps below:

Enable the Online definition mode.

Select a SAP client from the dropdown list.



You may click the Test button to check whether your connection with the selected SAP

Client is established successfully or not. If the connection is successfully established then

the Test button displays Tested, else Failed on it.

Change the value for System Release and Application Release fields if required.

You may need to change these values in case you want to access a specific

System/Application released schema.

Select an IDOC type from the dropdown list (see Figure 6).

Figure 6: Creating New IDoc Schema - Online Definition Mode

The generated IDoc Schema list is based on the system release and application release

values.

8. Expand the Advance Properties section of the New IDoc schema to change its advance properties (see Figure 7).



Figure 7: Advanced Properties of IDoc Schema

To learn about Advanced Properties refer to Changing Advanced Properties section of the Developers Guide.

9. Click Save. This will create an IDoc schema of XML Type.

Create a Process Flow

You can design a process flow in Adeptia to send data of any format from your end to the SAP server by

transforming it to the IDoc file using Adeptia Data mapper.

To know more about process flows, please refer to the Working with Process Flow section of the Developers Guide.

Alternatively, you may send or receive IDocs Using Data interface method. With this method you don’t need to create a new process flow, you can simply use the Default_Data_Interfaces process flow.

Refer to the Using Data Interface section of the Developers Guide for details.

Steps to create a Process Flow




2. Go to Services > Source to create a source activity.

Adeptia Suite enables you to transfer data from any source location to any target location. In order to transfer any data, you need to first fetch the data. To perform the same, you need to create a Source activity. The Source activity enables you to specify the location, where the data is stored.

To know how to create the Source activity, refer to the Creating Source Activity section of the Developer Guide.

3. Go to Services > Schema to create a schema for your source activity.


5. Click the IDoc Schema link to create a SAP IDoc schema (see Figure 8).

Figure 8: IDoc Schema Link

You can use a schema activity to parse data from all the supported data type formats and transform it into any of the supported data types. What a schema actually does is that, it apprehends data from the source, transforms it into XML, and then commits it to the source in the requested format. If you want data transformation then you need to use different types of schema activities both at the source and target end of your Process flow.

To know how to create Schema activity, refer to the Creating Schema Activity section of the Developer Guide.



6. Go to Services > Data Transformation and then click Data Mapping to map the source schema with the SAP IDoc schema (see Figure 9).

Figure 9: Mapping Activity

7. Go to Process > Process Flow to create a new process flow. The Process Designer window is displayed.

8. Arrange these activities in the following sequence (see Figure 10).

Source > Source Schema > Mapping > IDoc Schema > SAP Client

Figure 10: of Activities in the Process Flow

9. Execute the process flow.

To know the steps to view the logs, refer the Viewing Logs And Status Details section.



VIEWING LOGS AND STATUS DETAILS

Logs play an important role for any application. They give you a means to trace what's been happening in a particular request or a user's activity. All the information about an IDoc that is received from a remote SAP Server or being sent to a remote SAP Server is being logged in the configured log tables. You may go to Monitor->History->SAP Logs to view these logs.

Figure 11: SAP TID Management Configuration

adeptia suite 6.2 sap integration guide · pdf fileviewing logs and status details ... the...

Documents