36
TIBCO ActiveMatrix BusinessWorks Plug-in for OData Services for SAP S/ 4HANA User's Guide Software Release 6.2.0 June 2020

Plug-in for OData Services for SAP S/ 4HANA TIBCO ......This tutorial is designed for the beginners who want to use ActiveMatrix BusinessWorks Plug-in for OData Services for SAP S/4HANA

  • Upload
    others

  • View
    6

  • Download
    0

Embed Size (px)

Citation preview

Page 1: Plug-in for OData Services for SAP S/ 4HANA TIBCO ......This tutorial is designed for the beginners who want to use ActiveMatrix BusinessWorks Plug-in for OData Services for SAP S/4HANA

TIBCO ActiveMatrix BusinessWorks™

Plug-in for OData Services for SAP S/4HANA

User's GuideSoftware Release 6.2.0June 2020

Page 2: Plug-in for OData Services for SAP S/ 4HANA TIBCO ......This tutorial is designed for the beginners who want to use ActiveMatrix BusinessWorks Plug-in for OData Services for SAP S/4HANA

Important Information

SOME TIBCO SOFTWARE EMBEDS OR BUNDLES OTHER TIBCO SOFTWARE. USE OF SUCHEMBEDDED OR BUNDLED TIBCO SOFTWARE IS SOLELY TO ENABLE THE FUNCTIONALITY (ORPROVIDE LIMITED ADD-ON FUNCTIONALITY) OF THE LICENSED TIBCO SOFTWARE. THEEMBEDDED OR BUNDLED SOFTWARE IS NOT LICENSED TO BE USED OR ACCESSED BY ANYOTHER TIBCO SOFTWARE OR FOR ANY OTHER PURPOSE.

USE OF TIBCO SOFTWARE AND THIS DOCUMENT IS SUBJECT TO THE TERMS ANDCONDITIONS OF A LICENSE AGREEMENT FOUND IN EITHER A SEPARATELY EXECUTEDSOFTWARE LICENSE AGREEMENT, OR, IF THERE IS NO SUCH SEPARATE AGREEMENT, THECLICKWRAP END USER LICENSE AGREEMENT WHICH IS DISPLAYED DURING DOWNLOADOR INSTALLATION OF THE SOFTWARE (AND WHICH IS DUPLICATED IN THE LICENSE FILE)OR IF THERE IS NO SUCH SOFTWARE LICENSE AGREEMENT OR CLICKWRAP END USERLICENSE AGREEMENT, THE LICENSE(S) LOCATED IN THE “LICENSE” FILE(S) OF THESOFTWARE. USE OF THIS DOCUMENT IS SUBJECT TO THOSE TERMS AND CONDITIONS, ANDYOUR USE HEREOF SHALL CONSTITUTE ACCEPTANCE OF AND AN AGREEMENT TO BEBOUND BY THE SAME.

ANY SOFTWARE ITEM IDENTIFIED AS THIRD PARTY LIBRARY IS AVAILABLE UNDERSEPARATE SOFTWARE LICENSE TERMS AND IS NOT PART OF A TIBCO PRODUCT. AS SUCH,THESE SOFTWARE ITEMS ARE NOT COVERED BY THE TERMS OF YOUR AGREEMENT WITHTIBCO, INCLUDING ANY TERMS CONCERNING SUPPORT, MAINTENANCE, WARRANTIES,AND INDEMNITIES. DOWNLOAD AND USE OF THESE ITEMS IS SOLELY AT YOUR OWNDISCRETION AND SUBJECT TO THE LICENSE TERMS APPLICABLE TO THEM. BY PROCEEDINGTO DOWNLOAD, INSTALL OR USE ANY OF THESE ITEMS, YOU ACKNOWLEDGE THEFOREGOING DISTINCTIONS BETWEEN THESE ITEMS AND TIBCO PRODUCTS.

This document is subject to U.S. and international copyright laws and treaties. No part of thisdocument may be reproduced in any form without the written authorization of TIBCO Software Inc.

TIBCO, the TIBCO logo, the TIBCO O logo, TIB, Information Bus, Rendezvous, TIBCO Rendezvous,TIBCO ActiveMatrix BusinessWorks, TIBCO Business Studio and TIBCO Enterprise Administrator areeither registered trademarks or trademarks of TIBCO Software Inc. in the United States and/or othercountries.

Java and all Java based trademarks and logos are trademarks or registered trademarks of Oracle and/orits affiliates.

All other product and company names and marks mentioned in this document are the property of theirrespective owners and are mentioned for identification purposes only.

This software may be available on multiple operating systems. However, not all operating systemplatforms for a specific software version are released at the same time. Please see the readme.txt file forthe availability of this software version on a specific operating system platform.

THIS DOCUMENT IS PROVIDED “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSOR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OFMERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT.

THIS DOCUMENT COULD INCLUDE TECHNICAL INACCURACIES OR TYPOGRAPHICALERRORS. CHANGES ARE PERIODICALLY ADDED TO THE INFORMATION HEREIN; THESECHANGES WILL BE INCORPORATED IN NEW EDITIONS OF THIS DOCUMENT. TIBCOSOFTWARE INC. MAY MAKE IMPROVEMENTS AND/OR CHANGES IN THE PRODUCT(S)AND/OR THE PROGRAM(S) DESCRIBED IN THIS DOCUMENT AT ANY TIME.

THE CONTENTS OF THIS DOCUMENT MAY BE MODIFIED AND/OR QUALIFIED, DIRECTLY ORINDIRECTLY, BY OTHER DOCUMENTATION WHICH ACCOMPANIES THIS SOFTWARE,INCLUDING BUT NOT LIMITED TO ANY RELEASE NOTES AND "READ ME" FILES.

This and other products of TIBCO Software Inc. may be covered by registered patents. Please refer toTIBCO's Virtual Patent Marking document (https://www.tibco.com/patents) for details.

2

TIBCO ActiveMatrix BusinessWorks™ Plug-in for OData Services for SAP S/4HANA User's Guide

Page 3: Plug-in for OData Services for SAP S/ 4HANA TIBCO ......This tutorial is designed for the beginners who want to use ActiveMatrix BusinessWorks Plug-in for OData Services for SAP S/4HANA

Copyright © 2018-2020. TIBCO Software Inc. All Rights Reserved.

3

TIBCO ActiveMatrix BusinessWorks™ Plug-in for OData Services for SAP S/4HANA User's Guide

Page 4: Plug-in for OData Services for SAP S/ 4HANA TIBCO ......This tutorial is designed for the beginners who want to use ActiveMatrix BusinessWorks Plug-in for OData Services for SAP S/4HANA

Contents

TIBCO Documentation and Support Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

Getting Started . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7

TIBCO Business Studio Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7

Creating a Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

Creating and Configuring a SAP S/4HANA Cloud Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

Configuring a Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

Testing a Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

Deploying an Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

Preparing the SAP S/4HANA Cloud System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

SAP S/4HANA Cloud Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .14

SAP S/4HANA Cloud Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

SAP S/4HANA Cloud Schema . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

General . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

Environment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .14

Repository . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .16

Tenant . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

OAuth 2.0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

Schema . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

SAP S/4HANA Cloud Palette . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

Consume OData Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

Mapping Data for SAP S/4HANA Cloud Palette Activities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

Supported EDM Core Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .25

Job Tuning . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

Working with Sample Projects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27

Importing Sample Projects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .28

Running the Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

Troubleshooting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30

Managing Logs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31

Log Levels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31

Setting Up Log Levels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31

Exporting Logs to a File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32

Error Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

4

TIBCO ActiveMatrix BusinessWorks™ Plug-in for OData Services for SAP S/4HANA User's Guide

Page 5: Plug-in for OData Services for SAP S/ 4HANA TIBCO ......This tutorial is designed for the beginners who want to use ActiveMatrix BusinessWorks Plug-in for OData Services for SAP S/4HANA

TIBCO Documentation and Support Services

How to Access TIBCO Documentation

Documentation for TIBCO products is available on the TIBCO Product Documentation website, mainlyin HTML and PDF formats.

The TIBCO Product Documentation website is updated frequently and is more current than any otherdocumentation included with the product. To access the latest documentation, visit https://docs.tibco.com.

Documentation for TIBCO ActiveMatrix BusinessWorks™ Plug-in for OData Services for SAP S/4HANA is available on the TIBCO ActiveMatrix BusinessWorks™ Plug-in for OData Services for SAP S/4HANA Product Documentation page.

Product-Specific Documentation

The following documents for this product can be found on the TIBCO Documentation site:

● TIBCO ActiveMatrix BusinessWorks™ Plug-in for OData Services for SAP S/4HANA User's Guide

● TIBCO ActiveMatrix BusinessWorks™ Plug-in for OData Services for SAP S/4HANA Installation

● TIBCO ActiveMatrix BusinessWorks™ Plug-in for OData Services for SAP S/4HANA Release Notes

How to Contact TIBCO Support

You can contact TIBCO Support in the following ways:

● For an overview of TIBCO Support, visit http://www.tibco.com/services/support.

● For accessing the Support Knowledge Base and getting personalized content about products you areinterested in, visit the TIBCO Support portal at https://support.tibco.com.

● For creating a Support case, you must have a valid maintenance or support contract with TIBCO.You also need a user name and password to log in to https://support.tibco.com. If you do not have auser name, you can request one by clicking Register on the website.

How to Join TIBCO Community

TIBCO Community is the official channel for TIBCO customers, partners, and employee subject matterexperts to share and access their collective experience. TIBCO Community offers access to Q&A forums,product wikis, and best practices. It also offers access to extensions, adapters, solution accelerators, andtools that extend and enable customers to gain full value from TIBCO products. In addition, users cansubmit and vote on feature requests from within the TIBCO Ideas Portal. For a free registration, go to https://community.tibco.com.

5

TIBCO ActiveMatrix BusinessWorks™ Plug-in for OData Services for SAP S/4HANA User's Guide

Page 6: Plug-in for OData Services for SAP S/ 4HANA TIBCO ......This tutorial is designed for the beginners who want to use ActiveMatrix BusinessWorks Plug-in for OData Services for SAP S/4HANA

Overview

TIBCO ActiveMatrix BusinessWorks™ Plug-in for OData Services for SAP S/4HANA provides theinteroperability between TIBCO ActiveMatrix BusinessWorks™ and ODATA Services for SAP S/4HANA. With the plug-in, you can invoke OData services published by SAP for SAP S/4HANA Cloudand OData services available in SAP S/4HANA On-Premise/Private Cloud. This plug-in was formerlyknown as TIBCO ActiveMatrix BusinessWorks™ Plug-in for SAP S/4HANA Cloud.

ActiveMatrix BusinessWorks™ Plug-in for OData Services for SAP S/4HANA extends TIBCOActiveMatrix BusinessWorks and adds an SAP S/4HANA Cloud Connection shared resource and anSAP S/4HANA Cloud Palette to TIBCO Business Studio (hereinafter referred to as "TIBCO BusinessStudio").

● SAP S/4HANA Cloud Connection

You can use the SAP S/4HANA Cloud Connection shared resource to establish inbound connectionsto the SAP S/4HANA Cloud system and On-Premise/Private Cloud system, and download schemasat design time.

● SAP S/4HANA Cloud Palette

— Consume Odata Service: You can use this activity to invoke OData services published by SAPfor SAP S/4HANA Cloud. Further, OData services exist in SAP S/4HANA On-Premise/PrivateCloud.

6

TIBCO ActiveMatrix BusinessWorks™ Plug-in for OData Services for SAP S/4HANA User's Guide

Page 7: Plug-in for OData Services for SAP S/ 4HANA TIBCO ......This tutorial is designed for the beginners who want to use ActiveMatrix BusinessWorks Plug-in for OData Services for SAP S/4HANA

Getting Started

This tutorial is designed for the beginners who want to use ActiveMatrix BusinessWorks Plug-in forOData Services for SAP S/4HANA in TIBCO Business Studio.

All the operations are performed in TIBCO Business Studio. See TIBCO Business Studio Overview toget familiar with TIBCO Business Studio.

A basic procedure of using ActiveMatrix BusinessWorks Plug-in for OData Services for SAP S/4HANAincludes:

● TIBCO Business Studio Overview

● Creating a Project

● Creating and Configuring an SAP S/4HANA Cloud Connection

● Configuring a Process

● Testing a Process

● Deploying an Application

When configuring the shared resources or activities, you might find that some fields inherit the moduleproperties. If you want to specify those fields, you have to specify the corresponding module propertiesin the Module Properties tab of the Module Properties editor.

TIBCO Business Studio OverviewTIBCO Business Studio is an Eclipse-based integration development environment that is used todesign, develop, and test ActiveMatrix BusinessWorks applications.

TIBCO Business Studio provides a workbench in which you can create, manage, and navigate resourcesin your workspace. A workspace is the central location on your machine where all data files are stored.

The following table introduces the workbench UI elements highlighted in the image:

Sl. No. UI Element Description

1. Menu Contains menu items such as File, Edit, Navigate,Search, Project, Run, Window, and Help.

7

TIBCO ActiveMatrix BusinessWorks™ Plug-in for OData Services for SAP S/4HANA User's Guide

Page 8: Plug-in for OData Services for SAP S/ 4HANA TIBCO ......This tutorial is designed for the beginners who want to use ActiveMatrix BusinessWorks Plug-in for OData Services for SAP S/4HANA

Sl. No. UI Element Description

2. Toolbar Contains buttons for frequently used commands suchas:

● New

● Save

● Enable/Disable Business Studio Capabilities

● Create a new BusinessWorks Application Module

● Debug

● Run

3. Perspectives Contains an initial set and layout of views that arerequired to perform a certain task. TIBCO BusinessStudio launches the Design perspective by default. Usethe Design perspective when designing a process andthe Debug perspective when testing and debugging aprocess. To change the perspective, select Window >Open Perspective > perspective_name from the mainmenu. Or, you can click the icon at the top right-handside of the workbench and select the perspective toopen.

4. Views Displays resources and allow for navigation in theworkbench. For example, the Project Explorer viewdisplays the ActiveMatrix BusinessWorks applications,modules, and other resources in your workspace, andthe Properties view displays the properties for theselected resource. To open a view, select Window >Show View > view_name from the main menu.

5. Editors Provides a canvas to configure, edit, or browse aresource. Double-click a resource in a view to open theappropriate editor for the selected resource. Forexample, double-click on a process(MortgageAppConsumer.bwp) in the Project Explorerview to open the process in the editor.

6. Palette Contains a set of widgets and a palette library. A palettegroups activities that perform similar tasks, andprovides quick access to activities when configuring aprocess.

8

TIBCO ActiveMatrix BusinessWorks™ Plug-in for OData Services for SAP S/4HANA User's Guide

Page 9: Plug-in for OData Services for SAP S/ 4HANA TIBCO ......This tutorial is designed for the beginners who want to use ActiveMatrix BusinessWorks Plug-in for OData Services for SAP S/4HANA

Creating a ProjectThe first task using the plug-in is creating a project. After creating a project, you can add resources andprocesses.

An Eclipse project is an application module configured for TIBCO ActiveMatrix BusinessWorks. Anapplication module is the smallest unit of resources that is named, versioned, and packaged as part ofan application.

When you import an existing project to the current workspace of TIBCO Business Studio, if you clickSelect root directory in the Import Projects dialog, you must select the Copy projects into workspacecheck box.

Procedure

1. Start TIBCO Business Studio using one of the following ways:

● Microsoft Windows: click Start > All Programs > TIBCO > TIBCO_HOME > TIBCO BusinessStudio version_number > Studio for Designers.

● Mac OS and Linux: run the TIBCO Business Studio executable file located in the TIBCO_HOME/studio/version_number/eclipse directory.

On Mac OS, to load the environment variables in the launchd.conf file correctly,ensure that the shell is bash when you start TIBCO Business Studio on a commandline.

2. From the menu, click File > New > BusinessWorks Resources to open the BusinessWorks Resourcewizard.

3. In the "Select a wizard" dialog, click BusinessWorks Application Module and click Next to openthe New BusinessWorks Application Module wizard.

4. In the Project dialog, configure the project that you want to create:a) In the Project name field, enter a project name.b) By default, the created project is located in the workspace current in use. If you do not want to

use the default location for the project, clear the Use default location check box and click Browseto select a new location.

c) Use the default version of the application module, or enter a new version in the Version field.d) Keep the Create empty process and Create Application check boxes selected to automatically

create an empty process and an application when creating the project.e) Select the Use Java configuration check box if you want to create a Java module.

A Java module provides the Java tooling capabilities.f) Click Finish to create the project.

Result

The project with the specified settings is displayed in the Project Explorer view.

9

TIBCO ActiveMatrix BusinessWorks™ Plug-in for OData Services for SAP S/4HANA User's Guide

Page 10: Plug-in for OData Services for SAP S/ 4HANA TIBCO ......This tutorial is designed for the beginners who want to use ActiveMatrix BusinessWorks Plug-in for OData Services for SAP S/4HANA

Creating and Configuring a SAP S/4HANA Cloud ConnectionAfter creating a project, you can add an SAP S/4HANA Cloud Connection shared resource to establishconnections between the plug-in and the SAP S/4HANA Cloud.

Prerequisites

The SAP S/4HANA Cloud Connection shared resource is available at the Resources level. Ensure thatyou have created a project. See Creating a Project for details.

Procedure

1. In the Project Explorer view, expand the created project.

2. Right-click the Resources folder, and then click New > SAP S/4HANA Cloud Connection to openthe SAP S/4HANA Cloud Connection wizard.

3. In the New SAP Connection dialog, the resource folder, package name, and resource name of theSAP S/4HANA Cloud connection are provided by default. If you do not want to use the defaultconfigurations, change them accordingly. Click Finish to open the SAP S/4HANA CloudConnection editor.

4. Choose environment for a Public or On-Premise/ Private Cloud.

5. Configure the connection properties available from the Configuration tab and click Save.

6. Click Save.

Configuring a ProcessAfter creating a project, an empty process is created. You can add activities to an empty process tocomplete a task.

Prerequisites

Ensure that you have created an empty process when creating a project. See Creating a Project fordetails.

Procedure

1. In the Project Explorer view, click the created project and open the empty process from theProcesses folder.

10

TIBCO ActiveMatrix BusinessWorks™ Plug-in for OData Services for SAP S/4HANA User's Guide

Page 11: Plug-in for OData Services for SAP S/ 4HANA TIBCO ......This tutorial is designed for the beginners who want to use ActiveMatrix BusinessWorks Plug-in for OData Services for SAP S/4HANA

2. Select an activity from the Palette view and drop it in the Process editor.For example, select and drop the Consume OData service from the SAP S/4HANA Cloud palette.

3. Drag the icon to create a transition between the added activities.

4. Configure the added SAP S/4HANA Cloud activity.See SAP S/4HANA Cloud Palette for details.

When mapping the output of the previous activity as the input of the current activity,choose the AutoMap option.

5. Click File > Save to save the project.

Testing a ProcessAfter configuring a process, you can test the process to check whether the process completes your task.

Prerequisites

Ensure that you have configured a process. See Configuring a Process for details.

Procedure

1. On the toolbar, click Debug > Debug Configurations.

2. Click BusinessWorks Application > BWApplication in the left panel.By default, all the applications in the current workspace are selected in the Applications tab. Ensurethat only the application you want to debug is selected in the Applications tab in the right panel.

3. Click Debug to test the process in the selected application.TIBCO Business Studio changes to the Debug perspective. The debug information is displayed inthe Console view.

4. In the Debug tab, expand the running process and click an activity.

5. In the upper-right corner, click the Job Data tab, and then click the Output tab to check the activityoutput.

11

TIBCO ActiveMatrix BusinessWorks™ Plug-in for OData Services for SAP S/4HANA User's Guide

Page 12: Plug-in for OData Services for SAP S/ 4HANA TIBCO ......This tutorial is designed for the beginners who want to use ActiveMatrix BusinessWorks Plug-in for OData Services for SAP S/4HANA

Deploying an ApplicationAfter testing, if the configured process works as expected, you can deploy the application that containsthe configured process into a runtime environment, and then use the bwadmin utility to manage thedeployed application.

Before deploying an application, you must generate an application archive, which is an enterprisearchive (EAR) file that is created in TIBCO Business Studio.

Deploying an application involves the following tasks:

1. Uploading an application archive

2. Deploying an application archive

3. Starting an application

See TIBCO ActiveMatrix BusinessWorks Administration for more details about how to deploy anapplication.

12

TIBCO ActiveMatrix BusinessWorks™ Plug-in for OData Services for SAP S/4HANA User's Guide

Page 13: Plug-in for OData Services for SAP S/ 4HANA TIBCO ......This tutorial is designed for the beginners who want to use ActiveMatrix BusinessWorks Plug-in for OData Services for SAP S/4HANA

Preparing the SAP S/4HANA Cloud System

SAP Business API Hub

The SAP API Business Hub website is used to download all publicly available SAP S/4HANA CloudAPIs and also test the APIs against a Sandbox environment provided by SAP.

Prior to using the plug-in, please make sure to create a login to the SAP API Business Hub using belowsteps. If a login has already been created, then these steps can be skipped.

1. Using a web browser, navigate to website https://api.sap.com

2. Click Log On on the upper right-hand corner.

3. On the pop-up window, click Register.

4. Fill the required registration information and click Register.

The user name and password provided during registration is used for configuring the Repositoryconfiguration in the Configuration tab of SAP S/4HANA Cloud Connection shared resource for PublicCloud.

SAP S/4HANA Cloud Production Tenant

This section includes necessary information for using the plug-in against a SAP S/4HANA CloudProduction tenant. Prior to the tenant being used, required configuration is needed in the tenant.

For configuring the Production tenant and invoking services in SAP S/4HANA Cloud tenant, refer toCommunication Management in SAP S/4HANA Cloud documentation.

For each API that is planned to be used with the plug-in, make sure the Communication Arrangementis configured accordingly. For more information, see SAP S/4HANA Cloud documentation.

For invoking services in SAP S/4HANA Cloud, the product tenant supports basic authentication, SSLand OAuth 2.0. For enabling OAuth 2.0 configuration, configure the Technical Communication Userand Business User accordingly.

When using SSL client certificate authentication, ensure that the root CA that signs the certificate isregistered in SAP Load Balancer.

13

TIBCO ActiveMatrix BusinessWorks™ Plug-in for OData Services for SAP S/4HANA User's Guide

Page 14: Plug-in for OData Services for SAP S/ 4HANA TIBCO ......This tutorial is designed for the beginners who want to use ActiveMatrix BusinessWorks Plug-in for OData Services for SAP S/4HANA

SAP S/4HANA Cloud Connection

You can use the SAP S/4HANA Cloud Connection shared resource to establish inbound connections tothe SAP S/4HANA Cloud system or On-Premise/Private Cloud system and download schemas atdesign time.

The SAP S/4HANA Cloud connection created in the shared module is not set to default when SAP S/4HANA Cloud Plugin activities are created in the application module. You need to manually select theSAP S/4HANA Cloud connection from the shared module.

SAP S/4HANA Cloud connection shared resource page displays either one of the two windows basedon the tabs:

● SAP S/4HANA Cloud Configuration window: Configuration tab (default)● SAP S/4HANA Cloud Schema window: Schema tab

SAP S/4HANA Cloud ConfigurationThe Configuration tab allows to specify the connection information for either SAP API Business Hub orOn-Premise/Private Cloud system to download public SAP S/4HANA Cloud APIs. It has four commonpanels:

● General● Environment: This panel allows you to choose between a Public or On-Premise/Private Cloud

Environment. Based on which environment you choose, you will have one or two additional panelsfrom the following three panels:

— Repository: This panel is displayed, if Public Environment is selected.— Tenant: This panel is also displayed, if Public Environment is selected.— System: This panel is displayed, if On-Premise/Private Cloud Environment is selected.

● Security● OAuth 2.0

SAP S/4HANA Cloud SchemaThe Schema tab allows you to browse and download SAP S/4HANA Cloud APIs. It has two panels.

● General● Schema

GeneralIn the General panel, you can specify the package where the shared resource is stored in the Packagefield and provide a short description for this shared resource in the Description field. The panel alsoshows the shared resource name which you defined when creating the shared resource.

The General panel in the Configuration and the Schema tabs are the same.

EnvironmentIn the Environment panel of the Configuration tab, choose betwen Public, and On-Premise/ PrivateCloud.

14

TIBCO ActiveMatrix BusinessWorks™ Plug-in for OData Services for SAP S/4HANA User's Guide

Page 15: Plug-in for OData Services for SAP S/ 4HANA TIBCO ......This tutorial is designed for the beginners who want to use ActiveMatrix BusinessWorks Plug-in for OData Services for SAP S/4HANA

Public Environment shows two panels:

● Repository

● Tenant

On-Premise/ Private Cloud Environment has one panel:

● System

15

TIBCO ActiveMatrix BusinessWorks™ Plug-in for OData Services for SAP S/4HANA User's Guide

Page 16: Plug-in for OData Services for SAP S/ 4HANA TIBCO ......This tutorial is designed for the beginners who want to use ActiveMatrix BusinessWorks Plug-in for OData Services for SAP S/4HANA

RepositoryIn the Repository panel of the Configuration tab, you can specify the options for connecting to the SAPAPI Business Hub for downloading SAP S/4HANA Cloud APIs and testing these same APIs against aSAP-provided sandbox. The following table lists the configurations in the Repository panel:

FieldModuleProperty Description

URL Yes URL of SAP API Hub

Default value is https://api.sap.com.

The URL property is editable but the defaultvalue should not be changed.

User Name Yes The user name for logging in to the SAP API BusinessHub.

Password Yes The password for logging in to the SAP API BusinessHub.

Tenant

In the Tenant panel of the Configuration tab, you can specify the connection information for the plug-inruntime for calling SAP S/4HANA Cloud APIs in a SAP provided sandbox or production tenant.

Field Module Property Description

Type No The type of tenant. The plug-in provides the followingtypes:

● Sandbox

When using the Sandbox environment,only GET operations are supported sincethe Sandbox environment provided bySAP is read-only.

● Production

URL Yes URL of production tenant.

AuthenticationType

No The type of authentication.

The plug-in provides the following authenticationtypes:

● Basic Authentication

● OAuth 2.0

● SSL

16

TIBCO ActiveMatrix BusinessWorks™ Plug-in for OData Services for SAP S/4HANA User's Guide

Page 17: Plug-in for OData Services for SAP S/ 4HANA TIBCO ......This tutorial is designed for the beginners who want to use ActiveMatrix BusinessWorks Plug-in for OData Services for SAP S/4HANA

Field Module Property Description

CommunicationUser Name

Yes The communication user name for connecting to thetenant.

Required if 'Basic Authentication' or 'OAuth2.0' is selected as Authentication Type.

CommunicationUser Password

Yes The communication user password for connecting tothe tenant.

Required if 'Basic Authentication' or 'OAuth2.0' is selected as Authentication Type.

Business UserEmail

Yes The email address of business user in tenant.

Required if 'OAuth 2.0' is selected forAuthentication Type.

Do not configure the same email address inmore than one shared resource.

Service No. ofThreads

Yes The number of concurrent threads for processingrequests to the activity. The default value is 8.

If the value is less than 1 then it woulddefault to 8. See the Job Tuning section formore information in how this field should beconfigured.

System

The System Panel can be seen on selecting On-Premise/Private Cloud Environment of theConfiguration tab.

To download an API and use it for OAuth 2.0, it is necessary to select basic authentication first andpopulate basic authentication connection paramameters, download API and use it for OAuth 2.0.

Field Module Property Description

Host Name Yes Host Name connecting to the On-Premise/Private Cloudsystem.

Port Yes Service port connecting to the On-Premise/PrivateCloud system.

Request URI Yes OData request URI

17

TIBCO ActiveMatrix BusinessWorks™ Plug-in for OData Services for SAP S/4HANA User's Guide

Page 18: Plug-in for OData Services for SAP S/ 4HANA TIBCO ......This tutorial is designed for the beginners who want to use ActiveMatrix BusinessWorks Plug-in for OData Services for SAP S/4HANA

Field Module Property Description

AuthenticationType

No The type of authentication.

The plug-in provides the following authenticationtypes:

● Basic Authentication

● OAuth 2.0

User Name Yes The user name for logging in to the On-Premise/PrivateCloud system.

Required if 'Basic Authentication' or 'OAuth2.0' is selected as Authentication Type.

Password Yes The password for logging in to the On-Premise/PrivateCloud system.

Required if 'Basic Authentication' is selectedas the Authentication Type.

Service User Name Yes The service user name for receiving the access token toconnect to the ODATA system.

Required if 'OAuth 2.0' is selected asAuthentication Type.

Service UserPassword

Yes The service user password for receiving the accesstoken to connect to the ODATA system.

Required if 'OAuth 2.0' is selected asAuthentication Type.

Scope Yes Restricting the resource that is allowed for service userto access.

Required if 'OAuth 2.0' is selected asAuthentication Type.

Service No. ofThreads

Yes The number of concurrent threads for processingrequests to the activity. The default value is 8.

If the value is less than 1 then it woulddefault to 8. See the Job Tuning section formore information in how this field should beconfigured.

Test Connection No Test your connection to the On-Premise/Private Cloudsystem when using basic authentication.

Test connection is only applicable for basicauthentication.

18

TIBCO ActiveMatrix BusinessWorks™ Plug-in for OData Services for SAP S/4HANA User's Guide

Page 19: Plug-in for OData Services for SAP S/ 4HANA TIBCO ......This tutorial is designed for the beginners who want to use ActiveMatrix BusinessWorks Plug-in for OData Services for SAP S/4HANA

Security

In the Security panel of the Configuration tab, you can specify additional connection information that isrequired when the Authentication Type is 'SSL'.

Field Module Property Description

Confidentiality No Needs to be selected when Authentication Type is 'SSL'.

When the check box is selected, the SSLClient reference would be appear.

SSL Client Yes Reference to SSL Client Configuration shared resource.

Required if 'SSL' is selected forAuthentication Type.

SSL Authentication type is not supported for On-Premise/Private Cloud system.

OAuth 2.0

In the OAuth 2.0 panel of the Configuration tab, you can specify additional connection information thatis required when the Authentication Type is 'OAuth 2.0'. We support OAuth 2.0 SAML bearer assertionflow to request an OAuth access token.

Field Module Property Description

Keystore Type No The type of keystore being used.

Required if 'OAuth 2.0' is selected forAuthentication Type.

JKS, JCEKS and PKCS#12 keystore types aresupported.

Keystore URL Yes The location of the keystore file.

Required if 'OAuth 2.0' is selected forAuthentication Type.

When doing configuration for cloudenvironment, you must store the keystore filein the workspace and use relative paths whenspecifying the keystore URL.

Keystore Password Yes The password used when creating the keystore file.

Required if 'OAuth 2.0' is selected forAuthentication Type.

19

TIBCO ActiveMatrix BusinessWorks™ Plug-in for OData Services for SAP S/4HANA User's Guide

Page 20: Plug-in for OData Services for SAP S/ 4HANA TIBCO ......This tutorial is designed for the beginners who want to use ActiveMatrix BusinessWorks Plug-in for OData Services for SAP S/4HANA

Field Module Property Description

Key Alias Name Yes The key alias name.

Required if 'OAuth 2.0' is selected forAuthentication Type.

SchemaIn the Schema panel, you can browse and download SAP S/4HANA Cloud APIs.

For filtering on specific APIs, enter search string for the API column.

For getting information on the operations available for a specific APIs or service, click the Servicecolumn to expand.

For downloading a specific API or service, select the API Name and select the Download API at bottomof panel. To refresh the API list, click Refresh APIs.

Only one API can be downloaded at a time.

20

TIBCO ActiveMatrix BusinessWorks™ Plug-in for OData Services for SAP S/4HANA User's Guide

Page 21: Plug-in for OData Services for SAP S/ 4HANA TIBCO ......This tutorial is designed for the beginners who want to use ActiveMatrix BusinessWorks Plug-in for OData Services for SAP S/4HANA

SAP S/4HANA Cloud Palette

A palette groups the activities that connect the same external applications together.

A SAP S/4HANA Cloud palette is added after installing ActiveMatrix BusinessWorks Plug-in for ODataServices for SAP S/4HANA. The SAP S/4HANA Cloud palette contains the following activities:

● Consume OData Service

Consume OData ServiceYou can use the Consume OData Service activity to invoke a SAP S/4HANA Cloud OData service.

General Tab

The following table lists the configurations on the General tab of the Consume OData activity:

FieldModuleProperty Description

Name No Specify the name to be displayed as the labelfor the activity in the process.

SAP S/4HANA Cloud Conn. YesClick to select an SAP S/4HANA CloudConnection shared resource. The SAP S/4HANA Cloud Connection shared resourceestablishes connections between the plug-inand the SAP S/4HANA Cloud system.

If no matching SAP S/4HANA CloudConnection shared resources are found, clickCreate Shared Resource to create one. Formore details, see Creating and Configuring anSAP S/4HANA Cloud Connection.

SAP S/4HANA API No Click Fetch API to select a SAP S/4HANACloud API.

Service No Select the service.

Operation No Select the operation.

Description Tab

On the Description tab, you can enter a short description for the Consume OData Service activity.

Input Tab

The input is generated based on the SAP S/4HANA Cloud API Service and Operation selected by theuser.

Output Tab

The Output tab shows the response of the invoked service.

21

TIBCO ActiveMatrix BusinessWorks™ Plug-in for OData Services for SAP S/4HANA User's Guide

Page 22: Plug-in for OData Services for SAP S/ 4HANA TIBCO ......This tutorial is designed for the beginners who want to use ActiveMatrix BusinessWorks Plug-in for OData Services for SAP S/4HANA

Output Item Data Type Description

ResultCount Integer This ResultCount output counts how many records are returnedafter the Consume OData Service activity is invoked.

22

TIBCO ActiveMatrix BusinessWorks™ Plug-in for OData Services for SAP S/4HANA User's Guide

Page 23: Plug-in for OData Services for SAP S/ 4HANA TIBCO ......This tutorial is designed for the beginners who want to use ActiveMatrix BusinessWorks Plug-in for OData Services for SAP S/4HANA

Mapping Data for SAP S/4HANA Cloud Palette Activities

Consume OData Service

This section contains information concerning the various services and operations supported by theConsume OData Service activity.

Service Property

When selecting the service from the Service drop down in the General tab of the activity, the service caneither be unqualified or qualified. If you use API_PRODUCT_SRV as an example API, the followingservices are available.

Product_Product: When using this service, a specific product would be retrieved using the product asthe key.

In this example, only one key is used but more than one key can be used for a service if needed.

Operation Property

This section contains information concerning the various operations supported by the Consume ODataService activity.

GET: The GET operation is used for reading data from the tenant. When using the GET operation, thebelow attributes can be mapped in the input schema.

Attribute Description

top Allows the return of at most top entries.

skip Allows skipping the first skip entries.

filter Allows to specify filter criteria.

orderby Allows to sort the return set by one or more columns.

select Allows one or more columns from the result set to be returned.

expand Allows additional information to be returned along with the original result set.

For syntax on specifying the filter criteria, see URI conventions in OData documentation. This isapplicable for filter, orderby, select, and expand attributes.

The fields available from the service are not available in the Input mapper. For information on the fieldsavailable, either refer to the Output schema or the documentation for the API available on SAP APIBusiness Hub. This is applicable for filter, orderby, select and expand attributes.

POST: The POST operation is used for posting data to the tenant, or On-Premise/Private Cloud.

The POST operation is used only for a production tenant, or On-Premise/Private Cloud.

The POST operation is used only in the case of creating a new record in the tenant, or On-Premise/Private Cloud.

PATCH: The PATCH operation is used for updating data in the tenant, or On-Premise/Private Cloud.

The PATCH operation is used only for a production tenant, or On-Premise/Private Cloud.

DELETE: The DELETE operation is used for deleting data from the tenant, or On-Premise/Private Cloud.

23

TIBCO ActiveMatrix BusinessWorks™ Plug-in for OData Services for SAP S/4HANA User's Guide

Page 24: Plug-in for OData Services for SAP S/ 4HANA TIBCO ......This tutorial is designed for the beginners who want to use ActiveMatrix BusinessWorks Plug-in for OData Services for SAP S/4HANA

The DELETE operation is used only for a production tenant, or On-Premise/Private Cloud.

24

TIBCO ActiveMatrix BusinessWorks™ Plug-in for OData Services for SAP S/4HANA User's Guide

Page 25: Plug-in for OData Services for SAP S/ 4HANA TIBCO ......This tutorial is designed for the beginners who want to use ActiveMatrix BusinessWorks Plug-in for OData Services for SAP S/4HANA

Supported EDM Core Types

Consume OData Service

The following table enlists all the supported EDM core types along with their descriptions.

EDM Core Types Description

Edm.Binary Fixed- or variable- length binary data

Edm.Boolean Represents the mathematical concept of binary-valued logic

Edm.Byte Unsigned 8-bit integer value

Edm.DateTime Date and time with values

Edm.DateTimeOffset Offset in minutes from GMT

Edm.Decimal Numeric values with fixed precision and scale

Edm.Double A floating point number with 15 digits precision

Edm.Guid A 16-byte (128-bit) unique identifier value

Edm.Int16 A signed 16-bit integer value

Edm.Int32 A signed 32-bit integer value

Edm.Int64 A signed 64-bit integer value

Edm.SByte A signed 8-bit integer value

Edm.Single A floating point number with 7 digits precision

Edm.String Fixed- or variable-length character data

Edm.Time Time of day with values ranging from 0:00:00.x to 23:59:59

edm.float core type is not supported by the plugin.

edm.datetime core type precision to milliseconds

Sample data:<d:UpdTmstmp>2020-03-14T23:41:11.123</d:UpdTmstmp>

25

TIBCO ActiveMatrix BusinessWorks™ Plug-in for OData Services for SAP S/4HANA User's Guide

Page 26: Plug-in for OData Services for SAP S/ 4HANA TIBCO ......This tutorial is designed for the beginners who want to use ActiveMatrix BusinessWorks Plug-in for OData Services for SAP S/4HANA

Job Tuning

You can configure the SAP S/4HANA Cloud activities to control the number of messages beingprocessed concurrently.

See "Engine and Job Tuning" in TIBCO ActiveMatrix BusinessWorks Administration for relatedinformation about job tuning. To control the number of messages being processed concurrently, you canchoose the required configuration:

● Consume OData Service

The Service No. of Threads should be configured accordingly based on the number of BW enginethreads available and the response time for completing the operation.

For example, if the response time for generating output by the activity is similar to the throughput forinvoking the activity then the number for Service No. of Threads should match the number of BWEngine threads. If the response time for generating output by the activity is greater, then tune theService No. of Threads accordingly.

26

TIBCO ActiveMatrix BusinessWorks™ Plug-in for OData Services for SAP S/4HANA User's Guide

Page 27: Plug-in for OData Services for SAP S/ 4HANA TIBCO ......This tutorial is designed for the beginners who want to use ActiveMatrix BusinessWorks Plug-in for OData Services for SAP S/4HANA

Working with Sample Projects

The plug-in packages sample projects with the installer which help to understand how ActiveMatrixBusinessWorks Plug-in for OData Services for SAP S/4HANA works.

After installing the plug-in, you can locate the following sample project in the TIBCO_HOME/bw/palettes/s4hanacloud/version_number/examples directory.

SAP_S4HANA_Cloud_Examples

The SAP_S4HANA_Cloud_Examples project shows how to use the Consume OData Service activitywith SAP S/4HANA Cloud. The following processes are included as part of this project.

● Check_Products_in_SAPECC

This ActiveMatrix BusinessWorks process provides an example of integration between SAP S/4HANA Cloud and SAP ECC or SAP S/4HANA(On-Premise/Private Cloud). In this example,products are retrieved from SAP S/4HANA Cloud and checked against SAP usingBAPI_MATERIAL_EXISTENCECHECK.

● DELETE_operation

This ActiveMatrix BusinessWorks process provides an example of the DELETE operation against aproduction tenant. Before running this process, modify the module properties accordingly based onthe product catalog available in your production tenant.

● GET_operation

This ActiveMatrix BusinessWorks process provides an example of GET operation against aproduction tenant. Before running this process, modify the module properties accordingly based onthe product catalog available in your production tenant.

● Multiple_operation

This ActiveMatrix BusinessWorks process provides an example where a REST service is used toinvoke DELETE, GET, PATCH, and POST operations against a production tenant. Before runningthis process, modify the module properties accordingly based on the product catalog available inyour production tenant.

● PATCH_operation

This ActiveMatrix BusinessWorks process provides an example of PATCH operation against aproduction tenant. Before running this process, modify the module properties accordingly based onthe product catalog available in your production tenant.

● POST_operation

This ActiveMatrix BusinessWorks process provides an example of POST operation against aproduction tenant. Before running this process, modify the module properties accordingly based onthe product catalog available in your production tenant.

● Replication_Sandbox_to_Production

This ActiveMatrix BusinessWorks process provides an example of replicating data across tenants. Inthis example, product descriptions are retrieved from SAP Sandbox available from SAP APIBusiness Hub and replicated to a production tenant.

27

TIBCO ActiveMatrix BusinessWorks™ Plug-in for OData Services for SAP S/4HANA User's Guide

Page 28: Plug-in for OData Services for SAP S/ 4HANA TIBCO ......This tutorial is designed for the beginners who want to use ActiveMatrix BusinessWorks Plug-in for OData Services for SAP S/4HANA

Importing Sample ProjectsTo run the sample project, you must import it to TIBCO Business Studio.

Procedure

1. Start TIBCO Business Studio using one of the following ways:

● Microsoft Windows: Click Start > All Programs > TIBCO > TIBCO_HOME > TIBCO BusinessStudio version_number > Studio for Designers

● Mac OS or Linux: Run the TIBCO Business Studio executable file located in the TIBCO_HOME/studio/version_number/eclipse directory.

2. From the menu, click File > Import.

3. In the Import dialog, expand the General folder and select the Existing Studio Projects intoWorkspace item. Click Next.

4. Click the Select archive file radio button and then click Browse to locate the sample project. Thesample project is located in the TIBCO_HOME/bw/palettes/s4hanacloud/version_number/examples directory.

5. In the Projects list, all the sample projects are selected. You can clear the sample projects that you donot want to import and then click Finish.The sample project is imported to TIBCO Business Studio.

28

TIBCO ActiveMatrix BusinessWorks™ Plug-in for OData Services for SAP S/4HANA User's Guide

Page 29: Plug-in for OData Services for SAP S/ 4HANA TIBCO ......This tutorial is designed for the beginners who want to use ActiveMatrix BusinessWorks Plug-in for OData Services for SAP S/4HANA

Running the ProjectAfter importing the sample project, you can run the project to see how the plug-in works.

Prerequisites

Ensure that you have imported the sample project to TIBCO Business Studio as described in ImportingSample Projects.

Procedure

1. In the Project Explorer view, expand the shared resource package.

2. Double-click the following shared resources and configure them in the shared resources editors.a) Production.s4hanaconnectionResourceb) Sandbox.s4hanaconnectionResourcec) SAPConnectionResource.sapconnectionResource

3. On the toolbar, click the icon to save your changes.

4. From the menu, click Run > Run Configurations to run the selected process.

5. In the Run Configurations dialog, expand BusinessWorks Application, and then clickBWApplication.

6. In the Applications tab, all the sample applications are selected. You can clear the sampleapplications that you do not want to run.

7. Click Run to run the process.

8. Click the icon to stop the process.

29

TIBCO ActiveMatrix BusinessWorks™ Plug-in for OData Services for SAP S/4HANA User's Guide

Page 30: Plug-in for OData Services for SAP S/ 4HANA TIBCO ......This tutorial is designed for the beginners who want to use ActiveMatrix BusinessWorks Plug-in for OData Services for SAP S/4HANA

Troubleshooting

When you encounter problems with the project, ensure that you have cleaned up the project.If errors occur when you run a process in TIBCO Business Studio, you can do a cleaning first. Cleaningdeletes all the old files and reorganizes the project.

Procedure

1. Right-click the project in the Project Explorer view and click Refresh.

2. Select Project > Clean to start the cleaning.

30

TIBCO ActiveMatrix BusinessWorks™ Plug-in for OData Services for SAP S/4HANA User's Guide

Page 31: Plug-in for OData Services for SAP S/ 4HANA TIBCO ......This tutorial is designed for the beginners who want to use ActiveMatrix BusinessWorks Plug-in for OData Services for SAP S/4HANA

Managing Logs

When an error occurs, you can check logs to trace and troubleshoot the plug-in exceptions.

By default, error logs are displayed in the Console view when you run a process in the debug mode.You can change the log level of the plug-in to trace different messages and export logs to a file. Differentlog levels correspond to different messages. See Log Levels for details.

Log LevelsDifferent log levels include different information.

The plug-in supports the following log levels:

Log Level Description

Trace Includes all information regarding the running process.

Debug Indicates a developer-defined tracing message.

Info Indicates normal plug-in operations. No action is required. A tracing messagetagged with Info indicates that a significant processing step is reached, andlogged for tracking or auditing purposes. Only info messages preceding atracking identifier are considered as significant steps.

Warn Indicates that an abnormal condition occurred. Processing continues, but forbest practice, you can contact the administrator to investigate it.

Error Indicates that an unrecoverable error occurred. Depending on the severity ofthe error, the plug-in might continue with the next operation or might stop.

Setting Up Log LevelsYou can configure a different log level for the plug-in and plug-in activities to trace different messages.

If you do not configure any log levels, the plug-in uses the default log level of TIBCO ActiveMatrixBusinessWorks. The default log level is Error.

Procedure

1. Navigate to the TIBCO_HOME/bw/version_number/config/design/logback directory and openthe logback.xml file.

2. Add the following node in the BusinessWorks Palette and Activity loggers area to specify a loglevel for the plug-in:<logger name="com.tibco.bw.palette.s4hana.runtime"> <level value="DEBUG"/></logger>

The value of the level element can be Error, Info, or Debug.

If you set the log level to Debug, the input and output for the plug-in activities are alsodisplayed in the Console view. See Log Levels for more details regarding each log level.

3. Optional. Add one of following nodes in the BusinessWorks Palette and Activity loggers area tocontrol a log level for the activity.

31

TIBCO ActiveMatrix BusinessWorks™ Plug-in for OData Services for SAP S/4HANA User's Guide

Page 32: Plug-in for OData Services for SAP S/ 4HANA TIBCO ......This tutorial is designed for the beginners who want to use ActiveMatrix BusinessWorks Plug-in for OData Services for SAP S/4HANA

● For example to control the log level for the IDoc Acknowledgment activity, set the followingparameters:

<logger name="com.tibco.bw.palette.s4hana.runtime.consumeodata"> <level value="TRACE"/></logger>

The value of the level element can be Trace, Warn, Error, Info, or Debug.

The activities that are not configured with specific log levels use the log level configuredfor the plug-in.

Logger names for each activity are as follows:

● Consume OData Service

com.tibco.bw.palette.s4hana.runtime.consumeodata

Logger names for shared resources

● SAP S/4HANA Cloud Connection

com.tibco.bw.sharedresource.s4hanaconnection.runtime

4. Save the file.

Exporting Logs to a FileYou can update the logback.xml file to export plug-in logs to a file.

Procedure

1. Navigate to the TIBCO_HOME/bw/version_number/config/design/logback directory and openthe logback.xml file.

After deploying an application in TIBCO Enterprise Administrator, navigate to theTIBCO_HOME/bw/version_number/domains/domain_name/appnodes/space_name/

node_name directory to find the logback.xml file.

2. Add the following node to specify the file where the log is exported:<appender name="FILE" class="ch.qos.logback.core.FileAppender"> <file>c:/bw6-sap.log</file> <encoder> <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36}-%msg%n</pattern> </encoder></appender>

The value of the file element is the absolute path of the file that stores the exported log.

3. Add the following node to the root node at the bottom of the logback.xml file:<root level="DEBUG"> <appender-ref ref="STDOUT" /> <appender-ref ref="FILE" /></root>

4. Save the file.

32

TIBCO ActiveMatrix BusinessWorks™ Plug-in for OData Services for SAP S/4HANA User's Guide

Page 33: Plug-in for OData Services for SAP S/ 4HANA TIBCO ......This tutorial is designed for the beginners who want to use ActiveMatrix BusinessWorks Plug-in for OData Services for SAP S/4HANA

Error Codes

The following tables list error codes, detailed explanation of each error, and where applicable, ways tosolve different errors.

SAP S/4HANA Cloud Connection Error Codes

Error Code and ErrorMessage Role Category Description Solution

TIBCO-BW-PALETTE-S4HANACLOUD-200002\nStart of the

Activity {0}, service

[{1}], operation [{2}]

\nInput received: \n

{3} \n

DEBUG BW-Plug-in Show the details oninput data

This is a debugmessage andresolution is notapplicable.

TIBCO-BW-PALETTE-S4HANACLOUD-200003\nActivity {0},

service [{1}],

operation [{2}] Output

data: \n {3} \n Exit

of Activity {4}

DEBUG BW-Plug-in Show the details onoutput data

This is a debugmessage andresolution is notapplicable.

TIBCO-BW-PALETTE-S4HANACLOUD-200004Generate HTTP Request

URL: [{0}], Activity

Name=[{1}],

Process=[{2}],

Module=[{3}],

DeploymentUnit=[{4}:

{5}]

DEBUG BW-Plug-in Show the info onHTTP request URL

This is a debugmessage andresolution is notapplicable.

TIBCO-BW-PALETTE-S4HANACLOUD-400002Refresh the access

token using the

refresh token [{0}],

Activity Name=[{1}],

Process=[{2}],

Module=[{3}],

DeploymentUnit=[{4}:

{5}]

WARN BW-Plug-in Show the warningmessage onrefreshing token afteraccess token expires

Not applicable

TIBCO-BW-PALETTE-S4HANACLOUD-500002

Error occurred when

generating XML Output

for activity. Error:

[{0}]

ERROR BW-Plug-in Error occurred whengenerating XMLOutput for activity.

Check the consolelog for outputdata and XSDSchema of output.

33

TIBCO ActiveMatrix BusinessWorks™ Plug-in for OData Services for SAP S/4HANA User's Guide

Page 34: Plug-in for OData Services for SAP S/ 4HANA TIBCO ......This tutorial is designed for the beginners who want to use ActiveMatrix BusinessWorks Plug-in for OData Services for SAP S/4HANA

Error Code and ErrorMessage Role Category Description Solution

TIBCO-BW-PALETTE-S4HANACLOUD-500003

Failed to retrieve the

token information from

server. Error:[{0}]

ERROR BW-Plug-in Failed to retrieve thetoken informationfrom server.

Checkconnectivity fromSAP server.

TIBCO-BW-PALETTE-S4HANACLOUD-500004

Not found the entity,

URL: [{0}]

ERROR BW-Plug-in Entity not found Verify the inputdata and makesure it is correct.

TIBCO-BW-PALETTE-S4HANACLOUD-500005

Failed to read the

entity, error: [{0}],

URL: [{1}]

ERROR BW-Plug-in Failed to read theentity

Not applicable

TIBCO-BW-PALETTE-S4HANACLOUD-500006

Failed to read the

feed, error: [{0}]

ERROR BW-Plug-in Failed to read thefeed

Verify the inputdata and makesure it is correct.

TIBCO-BW-PALETTE-S4HANACLOUD-500007

Failed to create the

entity, URL: [{0}],

Error Message: \n[{1}]

ERROR BW-Plug-in Failed to create theentity

Verify the inputdata and makesure the requiredfields areprovided.

TIBCO-BW-PALETTE-S4HANACLOUD-500008

Failed to update the

entity, URL: [{0}],

Error Message: \n[{1}]

ERROR BW-Plug-in Failed to update theentity

Verify the inputdata and makesure it is correct.

TIBCO-BW-PALETTE-S4HANACLOUD-500009

Failed to delete the

entity, error: [{0}],

URL: [{1}]

ERROR BW-Plug-in Failed to delete theentity

Verify the inputdata and makesure it is correct.

TIBCO-BW-PALETTE-S4HANACLOUD-500010

Failed to initialize

the connection

ERROR BW-Plug-in Failed to initializethe connection

Verify theconnectionproperties andmake sure theyare correct.

34

TIBCO ActiveMatrix BusinessWorks™ Plug-in for OData Services for SAP S/4HANA User's Guide

Page 35: Plug-in for OData Services for SAP S/ 4HANA TIBCO ......This tutorial is designed for the beginners who want to use ActiveMatrix BusinessWorks Plug-in for OData Services for SAP S/4HANA

Error Code and ErrorMessage Role Category Description Solution

TIBCO-BW-PALETTE-S4HANACLOUD-500011

Sorry! For this API,

the 'Try-it-out'

feature is only

supported for GET

operations. To test a

write operation,

please test the API

against your own SAP

S/4HANA Cloud system

using the production

URL available in the

Overview tab

ERROR BW-Plug-in Tried to execute thewrite operationagainst Sandbox

Not applicable

TIBCO-BW-PALETTE-S4HANACLOUD-500012

Failed to initialize

OData service due to

[{0}], Activity

Name=[{1}],

Process=[{2}],

Module=[{3}],

DeploymentUnit=[{4}:

{5}]

ERROR BW-Plug-in Show the error onthe activityinitialization failure

Check the errorinformation andtake the actionaccordingly.

TIBCO-BW-SR-S4HANACONNECTION-200007

Generate SAML 2.0

Bearer Assertion

[{0}], Shared Resource

Name=[{1}]

DEBUG BW-Plug-in Show the info onSAML 2.0 BearerAssertion

This is a debugmessage andresolution is notapplicable.

TIBCO-BW-SR-S4HANACONNECTION-200008

Generate Access Token

Request Body [{0}],

Shared Resource

Name=[{1}]

DEBUG BW-Plug-in Show the HTTPrequest body to getthe access token

This is a debugmessage andresolution is notapplicable.

TIBCO-BW-SR-S4HANACONNECTION-200009

Generate Refresh Token

Request Body [{0}],

Shared Resource

Name=[{1}]

DEBUG BW-Plug-in Show the HTTPrequest body to get anew pair of accesstoken and refreshtoken

This is a debugmessage andresolution is notapplicable.

35

TIBCO ActiveMatrix BusinessWorks™ Plug-in for OData Services for SAP S/4HANA User's Guide

Page 36: Plug-in for OData Services for SAP S/ 4HANA TIBCO ......This tutorial is designed for the beginners who want to use ActiveMatrix BusinessWorks Plug-in for OData Services for SAP S/4HANA

Error Code and ErrorMessage Role Category Description Solution

TIBCO-BW-SR-S4HANACONNECTION-300002

Configured the shared

resource {0} with

tenant type Production

and authentication

type [{1}]

INFO BW-Plug-in Show the connectioninfo

This is aninformationalmessage andresolution is notapplicable.

TIBCO-BW-SR-S4HANACONNECTION-300003

Configured the shared

resource {0} with

tenant type Sandbox

INFO BW-Plug-in Show the connectioninfo

This is aninformationalmessage andresolution is notapplicable.

TIBCO-BW-SR-S4HANACONNECTION-300004

Configured the shared

resource {0} with the

private system and

authentication type

[{1}]

INFO BW-Plug-in Show the connectioninfo

This is aninformationalmessage andresolution is notapplicable.

TIBCO-BW-SR-S4HANACONNECTION-500001

Creating Shared

Resource {0} failed

due to [{1}]

ERROR BW-Plug-in Show the error onthe connectioninitialization failure

Check the errorinformation andtake the actionaccordingly.

TIBCO-BW-SR-S4HANACONNECTION-500013

Invalid Shared

Resource reference

ERROR BW-Plug-in Show the error onaccessing theconnection sharedresource

Check theconfiguration ofconnection sharedresource.

36

TIBCO ActiveMatrix BusinessWorks™ Plug-in for OData Services for SAP S/4HANA User's Guide