Deployment Guide

This guide shows the simple way to get started using the SAP PI archiving solution. Each task comes equipped with video instructions. You will notice some screen changes, but the functionality should be the same.

If you are looking for a short way to test how the system works on your system, go to ‘installation’ and then to ‘bucket creation’ and create a file bucket. Then, add the bucket to a module to start testing the application.

If you have any question see the FAQ or try the support.

Install the Program

The SCA files are deployed using JSPM.

Place the downloaded SCA files in in\usr\sap\trans\EPS\in

Then open the go.bat file on \usr\sap\<SYSID>\DVEBMGS00\j2ee\JSPM. This will open the JSPM manager.

Log in with <SYSID>ADM.

Select the ‘new software components’ and the package you have placed in the in folder will be shown.

Selected the Figaf.com/piarchiving solution.

For a video to see how it works.

Create Certificates for Storing Securing Buckets

This step is only necessary if you need to use Amazon S3 to store data in.

In Netweaver administrator http://host:50000/nwa find the certificate and keystore.

Create a view. A view is a place where the keys can be stored.

Create a certificate in the view so you can use it as the key.

Now, you need to add the authorization to use the view, so it can be used by the application.

First, add authorization to the SAP PI archiving component called Figaf.com/com~piarchive~ear.

Then, repeat the steps for the sap.com/com.sap.aii.af.app. In 7.3, this seems to be required to use the certificate when uploading messages in the PI archiving module.

*Note: it is different to use the keystore depending on which version of SAP PI you are using. On PI 7.11 it looks like the following:

Starting the Application

For the web part of the application, go to this url to begin: http://HOST:50000/PIArchiving.

Create an Amazon S3 and SimpleDB Account

If you are going to use Amazon for storing content, you must create an Amazon Web Service account. Log in to http://aws.amazon.com.

Create an account. Then, add your credit card and VAT number.

It may take a few hours to get the account confirmed.

For instructions, see this video:

Create the Domain

The domain is the place where you want to store the meta data about the message. You can either store this data locally, or you can store it in Amazons Simple DB. Both places work the same way, it’s only a matter where you store the data.

The default method is to store the data in the local database.

You can choose to use Amazon Simple DB. For this to work, you need to supply your Amazon web service credentials. The domain on simpleDB is a container, or something similar to a database table, except that it is dynamic.

To see how to configure the table, see:

To change the domain, you must have assigned the j2ee_admin role. The <SYSID>adm user has this role, or you can assign it to your own role.

Creating Buckets

Buckets are the place to store the payload messages.

There are currently two options, listed below.

  • File. In this, the files are stored in the local file system.
  • AmazonS3 Here, the files are encrypted using the encryption key and uploaded to Amazon S3 bucket. Here, you only pay for what you use and the data you upload and download.
  • FTP. This will allow you to store your content much easier on a remote local server.

To see how to fill in the bucket see this video:

You must use the buckets that you have created when configuring the modules on the communication channel.

To add a new bucket, you must have assigned the j2ee_admin role. The <SYSID>adm user has this role, or you can assign it to your own role.

Configure the Module

To start archiving the messages that you are sending, the module PIArchiveModule must be added to the module chain.

The module parameter bucket is required. The bucket must be present and correspond to a message that has been created by the user in the bucket section.

If you are using a conversion, the module should be placed on the side where the document is in its original format. If you are receiving an EDI message, the PIArchiveModule should be placed before the EDI conversion; and, if you are sending EDI documents, then PIArchivingModule should be after the EDI conversion.

Edifact conversion.

In the edifact example, it is only necessary to mention that it is the edifact version that is used.

XML/XPATH

For the XPATH parameter, it is possible to mark the site it is on.

Parameters

Parameter Name Parameter Description
bucket Required. Contains the name of the bucket where the message is stored
parser The parser type to use should be blank, xpath, edifact or X12
xpath.<variable name> <variable name> is the text that should correspond to the value. It is possible to select the value and start to search for it. Then enter the xpath.

Notice the Xpath may give more results. All results are saved and made searchable.

namespace.<namespace def.> The namespace definition is what the prefix is called in the xpaths used.
messagetype This can be used to rename the message, so it is easier to find Purchase orders on for instance XML or EDIFact documents.
bypassIfError Set this to true, if the message should be processes in PI if the PIArchiving fails. There will be an error in the adapter log. Use this if it is more important to process the message than handle it.

To see the video about how to add the module look at .