You are on page 1of 14

AEDAPTIVe AS2 for SAP NetWeaver

Release 3.0
Installation Guide
Target Audience

System Administrators
Technology Consultants

Document version: 31 March 2010

Copyright 20072010, AEDAPTIVe Solutions BV.


All rights reserved. No part of this publication may
be reproduced or transmitted in any form or for
any purpose without the express permission of
AEDAPTIVe. The information contained herein may
be changed without prior notice. Some software
products marketed by AEDAPTIVe and its
distributors
contain
proprietary
software
components of other software vendors.
Microsoft, Windows, Outlook, and PowerPoint are
registered trademarks of Microsoft Corporation.
IBM, DB2, DB2 Universal Database, OS/2, Parallel
Sysplex, MVS/ESA, AIX, S/390, AS/400, OS/390,
OS/400, iSeries, pSeries, xSeries, zSeries, System i,
System i5, System p, System p5, System x, System
z, System z9, z/OS, AFP, Intelligent Miner,
WebSphere, Netfinity, Tivoli, Informix, i5/OS,
POWER, POWER5, POWER5+, OpenPower and
PowerPC are trademarks or registered trademarks
of IBM Corporation. Adobe, the Adobe logo,
Acrobat, PostScript, and Reader are either
trademarks or registered trademarks of Adobe
Systems Incorporated in the United States and/or
other countries. Oracle is a registered trademark
of Oracle Corporation.
UNIX, X/Open, OSF/1, and Motif are registered
trademarks of the Open Group.
Citrix, ICA, Program Neighborhood, MetaFrame,
WinFrame, VideoFrame, and MultiWin are
trademarks or registered trademarks of Citrix
Systems, Inc. HTML, XML, XHTML and W3C are
trademarks or registered trademarks of W3C,
World Wide Web Consortium, Massachusetts
Institute of Technology. Java is a registered
trademark of Sun Microsystems, Inc.

AEDAPTIVe Solutions BV
P.O. Box 2011
4200 BA Gorinchem
The Netherlands
T +31/183/693738
www.aedaptive.com

About This Guide | AEDAPTIVe Solutions

SAP, R/3, mySAP, mySAP.com, xApps, xApp, SAP


NetWeaver, MaxDB, and other SAP products and
services mentioned herein as well as their
respective logos are trademarks or registered
trademarks of SAP AG in Germany and in several
other countries all over the world. All other
product and service names mentioned are the
trademarks of their respective companies. Data
contained in this document serves informational
purposes only. National product specifications may
vary.
These materials are subject to change without
notice. These materials are provided by
AEDAPTIVe Solutions and its affiliated companies
(AEGroup) for informational purposes only,
without representation or warranty of any kind,
and AEDAPTIVe shall not be liable for errors or
omissions with respect to the materials. The only
warranties for AEDAPTIVe products and services
are those that are set forth in the express warranty
statements accompanying such products and
services, if any. Nothing herein should be
construed as constituting an additional warranty.
Some components of this product are based on
Java. Any code change in these components may
cause unpredictable and severe malfunctions and
is therefore expressively prohibited, as is any
decompilation of these components. Any Java
Source Code delivered with this product is only to
be used by AEDAPTIVes Support Services and may
not be modified or altered in any way.
AEDAPTIVe AS2 incorporates code copyrighted by
The Legion of the Bouncy Castle
(www.bouncycastle.org). Used with permission.

Contents

About This Guide............................................................................................................................. 4


1.1

References .............................................................................................................................. 4

1.2

Prerequisites ........................................................................................................................... 4

Installing AEDAPTIVe AS2................................................................................................................ 6


2.1

Prepare the Installation .......................................................................................................... 6

2.2

Installing Unlimited Strength Security JCE Files ...................................................................... 7

2.3

Deploying the AS2 Software Component Archive .................................................................. 7

2.4

Installing the Adapter Metadata ............................................................................................. 8

2.5

Configure the Web Front End ................................................................................................. 9

2.6

Installing the License Key ...................................................................................................... 11

2.7

Restarting all AEDAPTIVe Software Components ................................................................. 11

About This Guide | AEDAPTIVe Solutions

1 About This Guide


This guide describes how to install the AEDAPTIVe AS2 for SAP NetWeaver. This product consists of the
following components:

AS2 Adapter: to send and retrieve data via the AS2 protocol

XML Recognizer: to be able to route XML files more easily then is possible with standard PI.

Web Front End: to monitor the AS2 communication and to configure the software

This guide assumes that you have experience with SAP NetWeaver PI administration. We advice you to
upgrade your NetWeaver installation to the latest service pack before you install the AEDAPTIVe software.
This guide only describes a new installation of AEDAPTIVe AS2. For information about the upgrade of
AEDAPTIVe AS2 from a NetWeaver XI/PI 3.0/7.0 installation, please contact AEDAPTIVe Support.
Note: Some screens and the names of some options differ slightly between SAP NetWeaver PI 7.1 and SAP EHP
1 for SAP NetWeaver 7.1. This documentation follows SAP NetWeaver PI 7.1. AEDAPTIVe AS2 can be installed
on and used with both versions of SAP NetWeaver PI.

1.1

References

The following is a list of additional resources that might be useful in relation to this guide:

AEDAPTIVe AS2 Release Notes

AEDAPTIVe AS2 Users Guide

These guides can be downloaded from the AEDAPTIVe web site at http://www.aedaptive.com.

1.2

Prerequisites

The following are prerequisites for the installation:

The AEDAPTIVe AS2 software bundle or access to the customer part of the AEDAPTIVe web site

A valid AEDAPTIVe license key

Access to the System Landscape Directory

Access to the SAP NetWeaver PI server with the following software:

SAP Logon

Java Support Package Manager

NetWeaver Administrator

Enterprise Services Builder

About This Guide | AEDAPTIVe Solutions

The AS Java and the database have been backed up.

If your database is MaxDB, the overwrite mode for the log area has been set.

About This Guide | AEDAPTIVe Solutions

2 Installing AEDAPTIVe AS2


This chapter describes how to install AEDAPTIVe AS2 on SAP NetWeaver PI 7.1 or SAP EHP 1 for SAP
NetWeaver 7.1.
The installation procedure consists of the following steps:
1.

Prepare the installation

2.

Install the unlimited strength JCE files

3.

Deploy the software

4.

Install the adapter metadata

5.

Configure the web front end

6.

Install the license key

7.

Restart all AEDAPTIVe software components

These steps are described in more detail below.

2.1

Prepare the Installation

Before you can install the AEDAPTIVe software, you need to download the latest version of the software and
obtain a valid license key from AEDAPTIVe Solutions. Although it is possible to install all components without a
license key, the software will not work until you activate the licensed components using a valid license key.
License keys will be provided via email to your contact person.
The latest software version can be downloaded from the AEDAPTIVe Solutions web site:
1.

Go to http://www.aedaptive.com

2.

Log on with the username and password you have received. If you do not have a username and
password for the AEDAPTIVe web site, please contact your AEDAPTIVe Account Manager.

3.

Select Downloads in the Customer Area menu.

4.

Click on AEDAPTIVe Software for SAP NetWeaver PI 7.1.

5.

Click on AEDAPTIVe AS2 for SAP NetWeaver PI 7.1.

6.

Click on Latest Release.

7.

Select the software bundle and click Download to obtain the latest of the software. The AEDAPTIVe
licence end-user agreement is displayed. You have to agree to this license before you can proceed.

8.

Once you have agreed to the end-user agreement, a zip file with the software will be downloaded to
your computer. This zip file contains the following files:

AEDAPTIVe AS2 software:.aedaptive.as2.sca

Installing AEDAPTIVe AS2 | AEDAPTIVe Solutions

9.

AEDAPTIVe AS2 Adapter RA File: AedaptiveAS2RA.xml

AEDAPTIVe XML Recognizer Adapter RA File: AedaptiveXMLRecognizerRA.xml

After you have downloaded the software, you can download additional documentation from the web
site.

2.2

Installing Unlimited Strength Security JCE Files

In order to use 128 bits encryption in your AS2 communication you need to install the "unlimited strength"
version of JCE (Java Cryptography Extension) in your SAP PI environment. By default, only limited/full
strength jurisdiction is enabled. This chapter describes how to install and enable unlimited strength security
on your SAP XI installation.
Note: Legal restrictions may be applicable for the use of these policy files. Ensure that the required
authorization is given before performing these steps.
To install the JCE files, refer to SAP Note 1240081, "Java Cryptography Extension Jurisdiction Policy" files.
Install the JCE files provided by SUN Microsystems as the JCE files provided by SAP still limit the key length to
some extent.
Note: Please also read SAP Note 1133020, How to import a SAP JVM patch into an AS Java, which helps you to
determine if you need to reinstall the unlimited strength JCE files after deploying a SAP JVM patch.

2.3

Deploying the AS2 Software Component Archive

Note: During the deployment of AEDAPTIVe AS2 the SAP WAS will be restarted.
Before you start make sure that you have fulfilled the JSPM prerequisites. See for more information to the
JSPM documentation:
http://help.sap.com/saphelp_nw04s/helpdata/en/10/017842b3b1173be10000000a155106/frameset
.htm
To install the software, proceed as follows:
1.

Start Java Support Package Manager (JSPM).

2.

Log on to the NetWeaver system with an administrative J2EE user.

3.

A message in JSPM will report the inbox directory. Copy the file com.aedaptive.as2.sca to this
directory.

4.

Select the option New Software Component and click Next.


The second step of the deployment wizard appears. AedaptiveAS2 is available in the list of deployable
objects.

5.

Click Next. After a short while the next step of the wizard appears. Validate that the status is OK.
7

Installing AEDAPTIVe AS2 | AEDAPTIVe Solutions

6.

Click Start. The software will now be deployed. Please be patient as this can take a considerable
amount of time.

7.

When the software is deployed, the last step of the wizard appears.

8.

You can now close JSPM.

2.4

Installing the Adapter Metadata

Note: You should only perform these actions on your development system. To transport the adapter metadata
to other systems, you should use the standard SAP transport tools just as with other PI Repository objects.
Perform the following steps to install the adapter metadata:
1.

Go to the System Landscape Directory:


http://<server>:<port>/sld

2.

Click on the link Products.

3.

Click New.

4.

Select Create a new product and version and click Next.

5.

Provide the following information and click Next:

Product: AEDAPTIVE

Vendor: aedaptive.com

Version: 1.0

6.

Type after Unit Name AEDAPTIVE and click Next.

7.

Now you are asked to create a new software component version. Provide the following information
and click Finish:

Name: AEDAPTIVE

Version: 1.0

Production Status: released

The new software component version is now created.


Note: If you want you can create a product and/or software component with another name and
version number.
8.

Now we have to import the new Software Component Version into the Repository. Start Enterprise
Services Builder using the Process Integration profile.

9.

Choose Object New. The window Create Software Component appears.

10. Select Import from SDL and click Display.


8

Installing AEDAPTIVe AS2 | AEDAPTIVe Solutions

11. A list of software component versions appears. Choose the Software Component Version you have
created and click Import.
12. Select after Original Language the option English and click Save.
13. In the left pane, right click on the Software Component Version and choose Open Namespace
Definitions.
14. Choose Namespace Definition Display/Edit in the menu or click on the Switch between Display
and Edit Modes button.
15. Under Namespaces type the namespace http://aedaptive.com/xi and click on the Save
button.
Note: If you want you can create a product with another name and version number. However you
have to specify the namespace exactly as indicated otherwise the software will not work.
16. Active the change in the Change List.
17. Right click in the namespace in the software component version and select New.
18. Select Adapter Objects Adapter Metadata.
19. Type AS2 after Name and click Create.
20. Choose Adapter Metadata Import XML description.
21. Select the file AedaptiveAS2RA.xml that was part of the software bundle and click Open.
22. Save your changes by clicking on the Save button.
Note: If NetWeaver is not using English as its default language, you will get warnings about the
language tags when you save the adapter metadata. These warnings can be safely ignored.
23. Repeat steps 17 22 with the file AedaptiveXMLRecognizerRA.xml. Use XMLRecognizer as the
name of the adapter metadata.
24. Activate the changes in the Change List.
25. You have now successfully imported the adapter metadata. Close Enterprise Services Builder.

2.5

Configure the Web Front End

Before you can use the Web Front End you need to authorize users. To do this you need to create roles and
assign users to these roles. These steps will be described in detail below.
Proceed as follows:
1.

Log on to NetWeaver Administrator.

2.

Click on Identity Management.

Installing AEDAPTIVe AS2 | AEDAPTIVe Solutions

3.

After Search Criteria select Role and click Create Role.

4.

After Unique Name type Z_AEDAPTIVE_AS2_MONITOR and specify a description for this role, e.g.
Allows monitoring of AS2 messages. This role is used to access the AS2 message monitoring.

5.

Click on the tab Assigned Actions.

6.

Specify Z_AEDAPTIVE_AS2* in the Get input box and click Go. A list of actions appears.

7.

Select the action Z_AEDAPTIVE_AS2_MONITOR and click Add.

8.

Click Save.

9.

Repeat the previous steps and create the role Z_AEDAPTIVE_AS2_CONFIG with assigned action
Z_AEDAPTIVE_AS2_CONFIG. This role is used to access the AS2 configuration settings. Type after
description Allows configuration of the AEDAPTIVE AS2 Adapter.

10. Select the newly create role Z_AEDAPTIVE_AS2_MONITOR in the list. You can use the search
functionality to limit the displayed roles in the list.

10

Installing AEDAPTIVe AS2 | AEDAPTIVe Solutions

11. Click Modify.


12. Click on Assigned Users or Assigned Groups and add one or more users and/or groups to this role.
13. Click Save.
14. Repeat the previous steps for the role Z_AEDAPTIVE_AS2_CONFIG.
15. You can now close NetWeaver Administrator.
Note: If you want, you can always update the user assignments for these roles later.

2.6

Installing the License Key

To activate the installed adapters and modules you need to add the following file to your adapter installation:

license.xml

These files have been sent to you via email. If you have not received these files, please contact your
AEDAPTIVe Account Manager.
To activate the software, proceed as follows:
1.

Copy the two license files in the following directory of your XI installation:
/usr/sap/<SID>/<ID>/j2ee/cluster/apps/aedaptive.com

2.

If you run NetWeaver PI in a cluster, also install the license files in the other servers of the cluster.

Note: The name and location of the licence files are very critical. Do not rename these files as this can lead to
license issues with the software.

2.7

Restarting all AEDAPTIVe Software Components

Perform the following steps to restart all AEDAPTIVe software components:


1.

Start NetWeaver Administrator.

2.

Log on to the NetWeaver PI system with a user with NWA Administrator rights.

3.

Click on the option Systems under Operation Management.

11

Installing AEDAPTIVe AS2 | AEDAPTIVe Solutions

4.

Click on the option Start and Stop.

5.

Click on J2EE Applications in the right menu.

6.

A list of deployed applications appears. Type in the filter under Name com.aedaptive to limit the
list to AEDAPTIVe software components. Press Enter.

Which components are available in the list depends on the AEDAPTIVe software components you
have installed.
7.

One by one select the AEDAPTIVe software components. If you select one of the components, in the
bottom pane details about the selected application appear.

8.

For all AEDAPTIVe components on your system, click Stop -> On All Instances.

9.

Check that all applications are stopped by refreshing the application list.

10. Start all AEDAPTIVe components: one by one select the components and click Start -> On All
Instances.
11. Verify that all applications have been started, by refreshing the application list.

12

Installing AEDAPTIVe AS2 | AEDAPTIVe Solutions

12. You can now close NetWeaver Administrator and start using AEDAPTIVe AS2.
Note: If one or all application fails to start, please recheck the names and location of the license files. Most
installation issues are due to an incorrectly placed or named license files.

13

Installing AEDAPTIVe AS2 | AEDAPTIVe Solutions

AEDAPTIVe Solutions B.V.


P.O. Box 2011
4200 BA GORINCHEM
The Netherlands

(T) +31-183-693738
(F) +31-183-693747
(I) www.aedaptive.com

AEDAPTIVe Solutions B.V. is a private limited company of the AEgroup and is registered at the Chamber of
Commerce with number 11065386.

14

Installing AEDAPTIVe AS2 | AEDAPTIVe Solutions