You are on page 1of 11

SAP Integration Gateway for CPI on premise –

Starter Package
The purpose of the document is to provide you a fast and guided start with the SAP
Integration Gateway, which enables you the additional usage of the Cloud Integration
Management Cockpit on SAP PO.

This document covers following sections:

1. General/ Definition
2. Installation Steps
3. Cloud Integration Management Cockpit
3.1 Prerequisites
3.2 How To Start The Cloud Integration Content Management Cockpit
3.3 Deploying Integration Content
3.4 Configure Cloud Integration Content
3.5 Versioning
3.6 Monitoring
4. Restrictions/ Additional Information

1. General/ Definition
The SAP Integration Gateway enables the Deployment of Integration Content artifacts from
SAP Platform Cloud Integration Content catalog or from an archive in the file system to an
on premise environment which is performed in the Cloud Integration Content (CIC)
Management Cockpit (such as integration flows, value mappings, and security artifacts).

In order to use the Cloud Integration Management Cockpit, the Integration Gateway
Component must be enabled first.

The next sections will guide you through the steps that are needed to be performed to
enable the usage of Cloud Integration Management Cockpit.

2. Installation Steps
When configuring Process Integration after installation, it is recommended to enable the
Integration Gateway component in the CTC wizard. If not, the following procedure provides
how to enable it manually.

1. Log in to SAP NetWeaver Administrator at http://[host]:[port]/nwa and navigate


to Configuration → Scenarios → Configuration Wizard.

2. Enter “PI Cloud Integration Content” in the Find field and click Go.

3. Click Start.

4. Choose Enable option in the PI Cloud Integration Content screen and click Next.
For more information on Integration Gateway Component CTC, see SAP note 2197483.
Note: After having enabled the Cloud Integration Content on your NW750 PI/ PO/ AAE, you
are not able to execute the Cloud Integration scenarios in case if you have not met the
prerequisites mentioned in note 2239708.

3. Cloud Integration Management Cockpit


3.1 Prerequisites
In order to deploy Integration Content on SAP PO, some prerequisites must be considered
that are described in this section.

➢ You must have an SAP CPI tenant. For more information, see the
documentation SAP Cloud Platform Integration For Process
Integration → Getting Started section at http://help.sap.com/cloudintegration.

➢ You must enable the Integration Gateway component in SAP Process Integration as
described above in section 2.

➢ In order to deploy Cloud Integration, you need at least one of the following roles:
• SAP_XI_CONFIGURATOR_J2EE
• SAP_XI_DEVELOPER_J2EE
• SAP_XI_ADMINISTRATOR_J2EE
For more information, see Roles.

➢ The role SAP_XI_ADMINISTRATOR_J2EE is needed to start and stop integration


flows.

➢ Deployment from an archive file in the file system requires a download or an export
of the Cloud Integration Content from the SAP Integration Content Catalog (make all
the necessary sender and receiver channel configurations for the integration flow).

For more information, see Enable Cloud Integration Content in SAP Process
Integration.

➢ Deploy the required security material.

For more information, see Manage Security Material.

3.2 How To Start the Cloud Integration Content Management Cockpit

To start the Cloud Integration Content Management Cockpit, choose one of the following
options:
➢ Enter http://[host]:[port]/dir in any supported browser. This will open the SAP
NetWeaver Process Integration Tools. Under Integration Directory, choose Cloud
Integration Content.
➢ Enter http://[host]:[port]/IGWGBDeploy/Admin in any supported browser to go to
the Cloud Integration Content Management Cockpit page directly.

3.3 Deploying Integration Content


In order to deploy Cloud Integration Content on SAP Process Orchestration you need to
make sure that you have already copied an Integration Package to the workspace in your
SAP Cloud Platform Integration tenant, and that you have done the required configuration
such as selecting the right product profile, maintaining the communication settings,
maintaining the proxy, etc.
You can find more details regarding the enablement of Cloud Integration Content in SAP
Process Integration here.
Furthermore, it is possible to enable the message archiving for the Cloud Integration
Content. The detailed indication can be found here.
After having enabled the Integration Gateway and after the installation of the Cloud
Integration Content, the additional button on your main screen login of PI/ PO appears.

After clicking on the Cloud Integration Content button, you will get to following screen
where you can manage your Integration Content. To deploy new content in the Cloud
Integration Content Management Cockpit, select Deploy. The Deploy Integration Content
pane opens.
There are three options to deploy:

1. Deploy Integration Content from Cloud Tenant via Destination


For this option you must make sure you have created a destination in the NWA first.
The destination type must be HTTP. You can find more details here.

2. Deploy Integration content from Cloud Tenant via URL


Provide the URL of a tenant system, from which the application imports the
integration content. For example, https://<domain name>:<port>.
Deployment via URL only allows basic authentication.

3. Deploy Integration Content from File System


Choose Browse, to browse to the Cloud Integration Content *.zips file. Enter a
package name to deploy the artifacts or leave it empty to deploy to the default
package.

You have the possibility to select only one integration flow or even a couple of integration
flows to be deployed on SAP PI/ PO at once.
Click on Next and SAP PI/ PO will load all Packages on SAP CPI available.
After having deployed the Integration Content, you will be able to see the respective
endpoints.
In order to test the functionality of the process, you can copy the URL of the respective
endpoint to which the sender should send the request and perform your test using e.g.,
SOAP UI for SOAP calls.

The Cloud Integration Management Cockpit contains several tabs. Below you can find a
short description of each of them:
➢ The Security Material area provides an overview of security related artifacts.
• Import keys into the key store by using SAP NetWeaver.
Administrator.igw_default_keystore is the key store view created for
Integration Gateway. Go to SAP NetWeaver Administrator
at http://[host]:[port]/nwa, choose Configuration Certificate and Keys for
importing entries into key store view igw_default_keystore.

• Import trust certificates into the trust store by using SAP NetWeaver
Administrator.

You can find further information here.

➢ Use End Points tab to view end points of services that are configured using SOAP,
HTTP or OData adapter.
You can find further information here.

➢ Use Locks tab to view and release locks created during message processing.
You can find further information here.

➢ Use Number Ranges tab to view number ranges related artifacts. Number ranges
can be used when sending out documents where a unique number must be added to
each document, e.g., in case of EDIFACT, the outgoing EDIFACT messages should
have an Interchange Control Reference with length 1 to 9 digits, with the minimum
length being 1 digit and the maximum length ranging to 9 digits.
You can find further information here.

➢ JDBC Data Sources allow you to create and manage artifact connections to interact
with a database. Each data source contains information on database specific
configuration parameters.
You can find further information here.

➢ The JMS tab allows you to configure the messaging runtime by creating a
destination. The JMS configuration provides the following options for destination
types:

• JNDI
Use JNDI to look up a JMS connection factory.
More details can be found here.

• Generic
Provider specific APIs to create a JMS connection factory.
More details can be found here.
For specific JMS provider configurations, please refer to note 2577695.

➢ Use JMS Queues tab to open the queue monitoring. All message queues that are
active, that means, that are used by integration flows, are displayed in a table.
Please note, that message queues are only supported by the following adapter
types: JMS adapter, XI adapter.

Further information can be found here.

➢ Use Compatibility tab to check the Integration Runtime compatibility.

Please refer to note 2935394 for further information.

3.4 Configure Cloud Integration Content


As of release 7.5 SP10, it is possible to configure Integration Flows from within the
deployment cockpit of SAP Process Orchestration in case that externalized parameters have
been defined for the respective Integration Flow. This way, you can configure your
Integration Flow parameters without the need of accessing the package on your Cloud
Platform Integration tenant. For this purpose, you find the button called Configure in the
Integration Content details of an Integration Flow.

In the upcoming pop-up, all externalized parameters are displayed. You can maintain the
parameters and redeploy.
3.5 Versioning
What if I have several versions of my iFlow in SAP CPI and would like to deploy a specific
one?

If you create a version of your iFlow in SAP CPI, you see only the latest version in SAP CPI
(more precisely the current version in SAP CPI). If you want to revert to an older version in
SAP PO, you will have to go back to an older version in SAP CPI and make it the “current
version”.

By clicking on the version link in the overview of your artifacts in SAP CPI you see the
different versions of your iFlow. By selecting which one becomes the current one, you would
revert the version, and in the SAP CPI list this new current version would be displayed. As
you can see version 1.0.2 is the current one, and therefore I see in the screenshot above
this version as deployable version.
3.6 Monitoring
Use SAP NetWeaver Administrator or SAP Process Integration Tools to monitor the
Integration Gateway component and messages related to the deployment of cloud
Integration Content.
To monitor cloud integration content messages, you need the NWA_READONLY role.
In this blog post from Alexander Bundschuh you can find a detailed description of the
different Monitoring options.

4. Restrictions/ Additional information


➢ You have the options to start, stop or restart integration flows. Select the integration
flow, and then select either option. Note, if you restart an integration flow with run
once scheduling, it won’t schedule again since it would then violate the run once
settings. Here, you need to undeploy and deploy again.

➢ In SAP CPI you have the option to change the Product Profile of your Integration
Flow navigating to tab Runtime Configuration.
First it seems that you have the chance to choose an on premise solution and to
deploy it on CPI but when trying to deploy it, below error will show up. Mixing up is
not allowed.
Choose the correct version of the on premise solution that you have with the correct
SP level and it will work.

➢ Below you can find a comparison between SAP CPI Development Objects and SAP
PI/ PO Development Objects. All of them can be used on both systems, this means
e.g., even groovy script will work on SAP PO and it will stay as groovy and will not be
converted to Java Mapping or UDF.
➢ Additional information/ summary of frequently asked questions can be found in note
2428801.

You might also like