TIBCO ActiveMatrix Plug-in for SAP Ariba User's Guide

TIBCO ActiveMatrix BusinessWorks™ Plug-in for SAP Ariba

User's GuideVersion 6.0.0

February 2021

Copyright © 2021. TIBCO Software Inc. All Rights Reserved.

Contents

Figures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3

TIBCO ActiveMatrix BusinessWorks™ Plug-in for SAP Ariba Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4

Getting Started . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

TIBCO Business Studio for BusinessWorks Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

Creating a Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

Preparing the SAP Ariba System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

Creating and Configuring the SAP SaaS Connection Resource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .8

Configuring a Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9

Testing a Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

Deploying Applications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

Generating an EAR File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

SAP SaaS Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

Schema . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

SAP Ariba Palette . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .16

Consume SAP Ariba Service Activity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

Job Tuning . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

Working with Sample Projects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

Importing Sample Projects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

Running the Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

Troubleshooting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

Managing Logs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

Log Levels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

Setting Up Log Levels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .22

Exporting Logs to a File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

Error Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

TIBCO Documentation and Support Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

Legal and Third-Party Notices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

2

TIBCO ActiveMatrix BusinessWorks™ Plug-in for SAP Ariba User's Guide

Figures

Workbench UI Elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5

Creating a Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7

SAP SaaS Connection: Configuration Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

SAP SaaS Connection: Schema Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

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

SAP SaaS Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .13

SAP SaaS Schema . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .15

Working with Sample Projects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

3


TIBCO ActiveMatrix BusinessWorks™ Plug-in for SAP AribaOverview

TIBCO ActiveMatrix BusinessWorks™ is an easy to use integration product suite for enterprise, web, andmobile applications. TIBCO ActiveMatrix BusinessWorks uses the Eclipse graphical user interface (GUI)and TIBCO Business Studio for BusinessWorks™ for defining business processes and the process engine toexecute the business processes.

SAP Ariba is a cloud-based procurement and supply-chain solution.

TIBCO ActiveMatrix BusinessWorks™ Plug-in for SAP Ariba provides the interoperability between TIBCOActiveMatrix BusinessWorks and SAP Ariba. With the plug-in, you can invoke REST services published bySAP for SAP Ariba.

TIBCO ActiveMatrix BusinessWorks Plug-in for SAP Ariba extends TIBCO ActiveMatrix BusinessWorksand adds an SAP SaaS Connection shared resource and an SAP Ariba Palette to TIBCO Business Studio™for BusinessWorks™ (hereinafter referred to as "TIBCO Business Studio").

With this plug-in, you can perform operations using services supported by SAP Ariba. The plug-insupports public APIs available on the SAP API Business Hub. For specific information on APIs supported,refer to the Release Notes.

4


Getting Started

A typical workflow for the plug-in (to achieve different goals) includes creating a process, testing it in thedebugger, and deploying the application.

Most procedures in a typical workflow are performed in TIBCO Business Studio for BusinessWorks. See TIBCO Business Studio for BusinessWorks Overview if you are not familiar with it.

The following list has the sequence of topics that can help you get started with TIBCO ActiveMatrixBusinessWorks Plug-in for SAP Ariba:

1. Creating a Project

2. Preparing the SAP Ariba System

3. Creating a SAP SaaS Connection Resource

4. Configuring a Process

5. Testing a process

6. Deploying applications

When configuring the shared resources or activities, some fields might inherit the module properties. Tomodify the value of such fields, you must specify the values on the Module Properties tab of the ModuleProperties editor.

TIBCO Business Studio for BusinessWorks OverviewTIBCO Business Studio for BusinessWorks is an Eclipse-based integration development environment that isused to design, develop, and test ActiveMatrix BusinessWorks applications. The studio provides aworkbench in which you can create, manage, and navigate resources in your workspace. A workspace is thecentral location on your computer where all data files are stored.

Workbench UI Elements

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

5


UI Element Description

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

Toolbar Contains buttons for frequently used commands such as:

● New

● Save

● Enable/Disable Business Studio Capabilities

● Create a new BusinessWorks Application Module

● Debug

● Run

Perspectives Contains an initial set and layout of views that are required toperform a certain task. TIBCO Business Studio for BusinessWorkslaunches the Design perspective by default. Use the Designperspective when designing a process and the Debug perspectivewhen testing and debugging a process. To change the perspective,select Window > Open Perspective > perspective_name from themain menu. Or, you can click the icon at the top right-hand side ofthe workbench and select the perspective to open.

Views Lists the resources and helps you navigate within the workbench.For example, the Project Explorer view displays the ActiveMatrixBusinessWorks applications, modules, and other resources in yourworkspace, and the Properties view displays the properties for theselected resource. To open a view, select Window > Show View >view_name from the main menu.

Editors Provides a canvas to configure, edit, or browse a resource. Double-click a resource in a view to open the appropriate editor for theselected resource. For example, double-click on a process(MortgageAppConsumer.bwp) in the Project Explorer view to openthe process in the editor.

Palette Contains a set of widgets and a palette library. A palette groupsactivities that perform similar tasks, and provides quick access toactivities when configuring a process.

Creating a ProjectProjects are TIBCO ActiveMatrix BusinessWorks application modules that are created in TIBCO BusinessStudio for BusinessWorks. Begin by creating a project, and then add resources and processes.

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 of anapplication.

6


When importing an existing project to the current workspace of TIBCO Business Studio for BusinessWorks,if you click Select root directory in the Import Projects dialog box, you must select the Copy projects intoworkspace check box.

Procedure

1. Start TIBCO Business Studio for BusinessWorks in one of the following ways:

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

● macOS and Linux: Run the TIBCO Business Studio executable file located at TIBCO_HOME/studio/version_number/eclipse.

On macOS, to load the environment variables in the launchd.conf file correctly, ensurethat the shell is bash when you start TIBCO Business Studio on a command line.

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

3. On the Select a wizard page, click BusinessWorks Application Module and click Next to open theProject page.

4. On the Project page, configure the project that you want to create:a) In the Project name field, enter a project name.b) If you do not want to use the default location (current workspace) for the project, clear the Use

default location check box and click Browse to select a new location.c) In the Version field, retain the default version of the application module or enter a new version.d) To automatically create an empty process and an application when creating the project, ensure that

the Create empty process and Create Application check boxes are selected.e) Optional: To create a Java module, select the Use Java configuration check box.f) Click Finish.

Result

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

Creating a Project

7


Preparing the SAP Ariba System

SAP Business API Hub

The SAP API Business Hub website is used to download all publicly available SAP Ariba APIs and also totest the APIs in a sandbox environment provided by SAP.Before using the plug-in, create an account to the SAP API Business Hub using the following steps. If alogin has already been created, you can skip these steps.

1. Open a web browser, and navigate to https://api.sap.com.

2. In the upper-right corner of the SAP API Business Hub home page, click Log On.

3. On Log On dialog box, click Register and complete the registration information.

The user name and password provided during registration is used to configure the repository on theConfiguration tab of SAP SaaS Connection shared resource.

SAP Ariba Test/Production Tenant

For each required SAP Ariba API, ensure that the corresponding configuration has been completed. Thisconfiguration includes the creation of Application for generating the API Key, approval for using the API inappropriate SAP Ariba Realm(s), and the generation of OAuth Client Secret.

To invoke services in SAP Ariba, the Test/Production tenant supports OAuth 2.0. To enable OAuth 2.0configuration, configure the user accordingly.

Creating and Configuring the SAP SaaS Connection ResourceCreate an SAP SaaS Connection shared resource to establish the connection with your SAP Ariba instance.

You can use the SAP SaaS connection to perform the following tasks:

● Choose the Product Type as SAP Ariba.

● Choose the Type. The Type is either a Sandbox or Test/Production.

● Choose the Authentication Type - OAuth 2.0.

● View the available APIs.

● Download the schema for a particular API.

Procedure

1. In the Project Explorer view, right-click Resources folder and select New > SAP SaaS Connection.Hint: The project must be expanded to display all the folders.

2. In the SAP SaaS Connection Resource dialog box, fill the Resource Name field and click Finish. Tocreate the shared resource in a resources folder of a different project or in a different package, selectResource Folder or Package accordingly.The SAP SaaS Connection shared resource is created. The shared resource consists of two tabs:Configuration and Schema.

8


SAP SaaS Connection: Configuration Tab

SAP SaaS Connection: Schema Tab

3. Configure the SAP SaaS Connection resource in the displayed editor, as described in SAP SaaSConnection.

Configuring a ProcessA newly created project contains an empty process. Configure the process by adding activities, conditions,and services to complete a task.

Prerequisites

1. Ensure that an empty process is created when creating a project. See Creating a Project for details.

2. Ensure that you have established an SAP SaaS connection. See Creating and Configuring SAP SaaSConnection Resource for details.

9


Procedure

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

2. Select an activity from the Palette view and drag it to the Process editor.For example, select and drop the Timer activity from the General Activities palette.

3. Click and drag to create the new activity. In this manner, create links between the activities andconfigure the condition types.

Configuring a Process

4. Configure the added Consume SAP Ariba Service activity. See as described in SAP Ariba Palette.

An SAP SaaS Connection shared resource is required when configuring the Consume SAPAriba Service activity. For details on creating the SAP SaaS Connection shared resource, see Creating and Configuring SAP SaaS Connection Resource.

5. Save the project.

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

Prerequisites

Ensure that you have configured a process. For details, see Configuring a Process.

Procedure

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

2. Click BusinessWorks Application > BWApplication in the left pane.

10


By default, all the applications in the current workspace are selected on the Applications tab. Ensurethat only the application you want to debug is selected on the Applications tab in the right pane.

3. Click Debug to test the process in the selected application.TIBCO Business Studio for BusinessWorks changes to the Debug perspective. The debug information isdisplayed in the Console view.

4. On 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.

Deploying ApplicationsAfter testing, if the configured process works as expected, you can deploy the application that contains theconfigured process to a runtime environment. After deploying applications, you can manage TIBCOActiveMatrix BusinessWorks applications by using TIBCO® Enterprise Administrator.

Prerequisites

The following tasks are required before deploying applications:

● Creating a Project

● Generating an EAR file

You can deploy an application EAR file in the command-line mode with the bwadmin utility. See TIBCOActiveMatrix BusinessWorks Administration for more details about how to deploy an application.

Deploying an application involves the following tasks:

Procedure

1. Upload an EAR file.

2. Deploy an application.

3. Configure an application.

4. Start an application.

Generating an EAR FileApplication archives are enterprise archive (EAR) files that are created in TIBCO Business Studio forBusinessWorks. An EAR file is required when deploying an application.

Prerequisites

Create a project by following the steps described in Creating a Project.

Apart from the method described here, there are other ways to generate an EAR file, the following is onemethod. For more information, see TIBCO ActiveMatrix BusinessWorks Administration.

Procedure

1. In the File Explorer view, click the Open Directory to Browse icon.

2. Select the folder where you want to generate the EAR file and click OK.The new folder is displayed in the File Explorer view.

3. Drag the application from the Project Explorer view to the new folder in the File Explorer view.

11


The EAR file is generated with the name <name>.<application>_<version>.ear.

12


SAP SaaS Connection

You can use the SAP SaaS Connection shared resource to establish inbound connections to the SAP Aribasystem and download the schemas at design time.

The SAP SaaS Connection window has two tabs - Configuration and Schema.

SAP SaaS Connection

The SAP SaaS connection created in the shared module is not set to default when SAP Ariba plug-inactivities are created in the application module. You must manually select the SAP Ariba connection fromthe shared module.

ConfigurationOn the Configuration tab you can specify information to connect to SAP API Business Hub fordownloading and testing of public SAP Ariba APIs and to connect to the Test/Production tenant. TheConfiguration tab has the following sections: General, Repository, Tenant, and Advanced.

General

In the General panel, you can specify the package where the shared resource is stored in the Package fieldand provide a short description for this shared resource in the Description field. The panel also shows theshared resource name which you defined when creating the shared resource.

Repository

In the Repository panel of the Configuration tab, you can specify the options for connecting to the SAP APIBusiness Hub for downloading SAP Ariba APIs and testing the APIs in an SAP-provided sandbox. Thefollowing table lists the configurations in the Repository panel:

13


Field Module Property Description

URL Yes URL of SAP API Business Hub.

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

The URL property is editable. However, modifythis field only if there is a change in the SAP APIBusiness Hub URL.

User Name Yes The user name to log in to the SAP API Business Hub.

Password Yes The password to log in to the SAP API Business Hub.

After you provide the repository credentials, you can download the SAP Ariba APIs from the Schema tab.

Tenant

In the Tenant panel of the Configuration tab, you can specify the connection information for the plug-inruntime to call the SAP Ariba APIs in the Sandbox or Test/Production tenant.

FieldModuleProperty Description

Product Type No The type of the SAP product.

Default value: SAP SuccessFactors. Select SAP Ariba.

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

● Sandbox. (Default)

Read-only operations such as GET are only supported.

● Test/Production

For SAP Ariba, DELETE, GET, PUT, POST, andPATCH operations are supported.

URL Yes URL of Sandbox or Test/Production tenant

Realm Yes Realm of SAP Ariba tenant

The following fields are available when the Type is Test/Production.

Authentication Type No The type of authentication.

The plug-in supports the following authentication type:

● OAuth 2.0

OAuth 2.0 URL Yes URL of OAuth 2.0 authentication

Advanced

In the Advanced panel of the Configuration tab, you can specify additional information about the numberof threads needed for processing requests.

14


Field Module Property Description

Service No. ofThreads

Yes The number of concurrent threads for processing requeststo the activity.

Default value: 8. (A value less than 1 is automaticallychanged to the default value.)

See the Job Tuning section for more informationabout how to configure this field.

SchemaOn the Schema tab, you can browse and download SAP Ariba APIs. The content of this tab is populatedonly after you enter the credentials in the Repository panel of the Configuration tab.

To filter on specific APIs, enter the search string for the API column.

To get information on the services available for a specific API, expand the API.

To download a specific API, select the API Name and click Download APIs.

Only one API can be downloaded at a time.

To refresh the API list and metadata, click Refresh APIs. When you refresh APIs, the plug-in refreshes boththe metadata and the APIs.

SAP SaaS Schema

15


SAP Ariba Palette

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

An SAP Ariba palette is added after installing TIBCO ActiveMatrix BusinessWorks Plug-in for SAP Ariba.The SAP Ariba palette contains the Consume SAP Ariba Service Activity

Consume SAP Ariba Service ActivityYou can use SAP Ariba to interact with third-party applications and use the REST services to performoperations on SAP Ariba entities. Ariba uses REST API for extracting and manipulating most data entities.The Consume SAP Ariba Service Activity helps you consume the REST entities from TIBCO ActiveMatrixBusinessWorks.

General

The General tab contains the following fields.

FieldModuleProperty? Description

Name No The name to be displayed as the label for the activity in theprocess.

SAP SaaSConnection

YesClick to select an SAP SaaS Connection shared resource. TheSAP SaaS Connection shared resource establishes connectionsbetween the plug-in and the SAP Ariba.

If no matching SAP SaaS Connection shared resources are found,click Create Shared Resource to create one. For more details, see Creating and Configuring the SAP SaaS Connection Resource.

SAP Ariba API No Click Fetch API to fetch the SAP Ariba APIs that you hadpreviously downloaded from the Schema tab.

Service No After fetching the SAP Ariba API, select a service.

Underscores are used only for parameters. If the servicenode name contains an underscore (_), the underscore isautomatically removed from the displayed servicename.

Operation No Select the operation. The operation visible depends on the type ofthe service. It can be one of the following: GET, POST, PATCH, PUT,and DELETE.

Select OutputFields

No This UI element is applicable only in CATALOGCONTENT API and tothose services, which has select as one of its attribute in inputschema.

File Path Yes The path of file, which is supposed to send in input payload. Thisfield is visible when a particular API has file as one of the Input.

16


Description

On the Description tab, provide a short description for the activity.

Input

The input is generated based on the SAP Ariba API Service and the Operation selected by the user.The Input tab displays the input schema of the activity as a tree structure. The information in the schemavaries based on the fields selected on the General tab. You must enter information as required for themandatory fields.

Output

The Output tab shows the response of the invoked service. The Output tab displays the output schema ofthe activity as a tree structure. The output is read-only. The information in the schema varies based on thefields selected on the General tab.

Fault

The Fault tab lists exceptions that are thrown by this activity. There are two types of exceptions thrown bythe Consume SAP Ariba Service activity:

● AribaSystemFault: Thrown when the error originates from the SAP Ariba system.

● AribaPluginFault: Thrown when the error originates from the plug-in.

Error SchemaElement Datatype Description

msg string The error message returned by the plug-in.

msgCode string The error code returned by the plug-in.

17


Job Tuning

You can configure the SAP Ariba activities to control the number of messages being processed concurrently.

For details on job tuning, see "Engine and Job Tuning" in TIBCO ActiveMatrix BusinessWorks Administration.To control the number of messages being processed concurrently, you can use the Service No. of Threadsproperty.

The Service No. of Threads must be configured accordingly based on the number of ActiveMatrixBusinessWorks engine threads 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 ofActiveMatrix BusinessWorks Engine threads. If the response time for generating output by the activity isgreater, then tune the Service No. of Threads accordingly.

18


Working with Sample Projects

The plug-in packages sample projects with the installer which help to understand how TIBCO ActiveMatrixBusinessWorks Plug-in for SAP Ariba works.

After installing the plug-in, you can locate the SAP_Ariba_Examples project in the TIBCO_HOME/bw/palettes/ariba/<version_number>/examples directory.

Working with Sample Projects

The SAP_Ariba_Example

The SAP_Ariba_Examples project demonstrates the use of Consume SAP Ariba Service activity with SAPAriba. The following processes are included as a part of this project:

Multiple_operationThis ActiveMatrix BusinessWorks process provides an example where a REST service is used to invokeGET, POST, and PATCH operations on a sandbox tenant. Before running this process, modify the moduleproperties based on the employee background data available in the sandbox tenant.

Importing Sample ProjectsBefore running the project, you need to import the sample projects to TIBCO Business Studio forBusinessWorks.

Procedure

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

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

● macOS 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 box, expand the General folder and select the Existing Studio Projects intoWorkspace item. Click Next.

19


4. Select 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/ariba/version_number/examplesdirectory.

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

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 SAPConnectionResource.sapconnectionResource and configure them in the sharedresources editor.

3. On the toolbar, click the Save icon ( ).

4. To run the selected process, from the menu, click Run > Run Configurations .

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

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

7. Click Run to run the process.

8. Click the icon to stop the process.

20


Troubleshooting

This topic contains basic troubleshooting information for a project.If errors occur when you run a process in TIBCO Business Studio for BusinessWorks, first clean up theproject. Cleaning deletes all the old files and reorganizes the project.

Procedure

1. In the Project Explorer view, right-click the project and click Refresh.

2. Select Project > Clean to start the cleaning process.

21


Managing Logs

Logs are used to trace and troubleshoot plug-in exceptions.

When an error occurs, you can check the 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 changethe log level of the plug-in to trace different messages and export logs to a file. Different log levelscorrespond to different messages. For details, see log levels

A logback.xml file is located in the TIBCO_HOME\bw\<version_number>\config\design\logbackdirectory.

Log LevelsThe plug-in captures logs at different levels.

Log Level Description

Info Indicates normal plug-in operations. No action is needed. A tracing messagetagged with Info indicates that a significant processing step is reached and loggedfor tracking or auditing purposes. Only info messages preceding a trackingidentifier are considered as significant steps.

Warn Indicates that an abnormal condition is found. Processing continues, but specialattention from an administrator is recommended.

Error Indicates that an unrecoverable error has occurred. Depending on the errorseverity, the plug-in may continue with the next operation or may stop altogether.

Debug Indicates a developer-defined tracing message.

Trace Includes all the information regarding the running process.

Setting Up Log LevelsBy default, the log level is Error. You can set the log level to change the log level to trace differentmessages.

If neither the plug-in log nor the ActiveMatrix BusinessWorks log is configured in the logback.xml file, theerror logs of the plug-in will be displayed in the Console view by default.

If the plug-in log is not configured but the ActiveMatrix BusinessWorks log is configured in thelogback.xml file, the configuration for the ActiveMatrix BusinessWorks log is implemented by the plug-in.

Procedure

1. Navigate to the TIBCO_HOME\bw\<version_number>\config\design\logback directory and open thelogback.xml file.

2. Add the following node in the Console Appender area to specify the log level for the plug-in.<logger name="com.tibco.bw.palette.ariba.runtime"> <level value="DEBUG"/></logger>

The level tag defines the log level and the value is one of the values mentioned in log levels.

When the level is set 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.

22


3. Optional: Add the following node in Console Appender area to specify the log level for an activity.<logger name="com.tibco.bw.palette.ariba.runtime.consumearibadata"> <level value="DEBUG"/></logger>

The activities that are not configured with specific log levels also inherit log level configuredfor the plug-in or ActiveMatrix BusinessWorks.

4. Optional: Add the following node in Console Appender area to specify the log level for SAP SaaSConnection.<logger name="com.tibco.bw.sharedresource.sapsaasconnection.runtime"> <level value="DEBUG"/> </logger>

5. Save the file.

Exporting Logs to a FileModify 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 open thelogback.xml file.

When deploying an application in TIBCO Enterprise Administrator, you must 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 location.<appender name="FILE" class="ch.qos.logback.core.FileAppender"> <file>c:/bw6-sapariba.log</file> <encoder> <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36}-%msg%n</pattern> </encoder></appender>

The file tag defines the location to which the log is exported and its value is the absolute path to thefile.

The file path must include the file name.

3. Add the following node to the root node at the bottom of the logback.xml file to enable exporting thelogs to a file. <appender-ref ref="FILE" />

<root level="DEBUG"> <appender-ref ref="STDOUT" /> <appender-ref ref="FILE" /></root>

4. Save the file.

23


Error Codes

The exceptions that are thrown by the plug-in are listed with corresponding descriptions and resolutions.

Error Code Type TIBCO-BW-PALETTE-SAP_ARIBA

Error Code and ErrorMessage Role Description Solution

TIBCO-BW-PALETTE-SAP_ARIBA-100001

{0}

TRACE Used to print informational tracemessages

This is the trace messageand resolution is notapplicable.


\nStart of the Activity{0}, service {1},operation {2} \nInputreceived: \n {3} \n

DEBUG Show details of Input data This is the debug messageand resolution is notapplicable.


\nActivity {0}, service{1}, operation {2}Output data: \n {3} \nExit of Activity {4}

DEBUG Show details of Output data This is the debug messageand resolution is notapplicable.


\nJSON input forservice: {0}, operation:{1}, Activity Name={2},Process={3},Module={4},DeploymentUnit={5}:{6}\n{7}

DEBUG Shows JSON Input data whensending request

This is the debug messageand resolution is notapplicable.


Fields present inOutput schema butabsent in Output JSONresponse are: \n{0}

WARN Shows mismatch of fields are presentin Output schema but absent inOutput JSON response

This is the warn messageand resolution is notapplicable.


Fields present inOutput JSON responsebut absent in Outputschema are: \n{0}

WARN Shows mismatch of fields are presentin Output JSON response but absentin Output schema


24




Unexpected erroroccurred. {0}

ERROR Shows the error when request is notsuccessful

Check the appendedmessage to Unexpectederror occurred andcheck accordingly.


Failed to initializeConsumeSAPAribaService activity.{0}\nActivityName={1}\nProcess={2}\nModule={3}\nDeploymentUnit={4}:{5}.

ERROR When activity intilization fails thiserror message occurs

Verify the input details inShared resource and ininput tab.


Failed to decryptobfuscated passwordfor field : {0}

ERROR When obfuscated passworddecryption fails, this error messageoccurs

Make sure that passwordis obfuscated.


Failed to access outputschema.{0}

ERROR When there is no access to outputschema this error message occurs

Make sure that .xsd file ispresent in Schema folderfor respective API.


Failed to read the data.Status: {0} Error: {1}

ERROR When GET operation is failed thenthis error message occurs

Check correspondingerror message and takethe action accordingly.


Failed to post the data.Status: {0} Error: {1}

ERROR When POST operation is failed thenthis error message occurs



Failed to put the data.Status: {0} Error: {1}

ERROR When PUT operation is failed thenthis error message occurs



Failed to patch the data.Status: {0} Error: {1}

ERROR When PATCH operation is failedthen this error message occurs


25




Failed to delete thedata. Status: {0} Error:{1}

ERROR When DELETE operation is failedthen this error message occurs



Error occurred whengenerating XML Outputfor activity.{0}.

ERROR When output creation is failed thenthis error message occurs

Generate schema gain andtry to run the activity withrefreshed schema.


Following field/fieldsare empty: {0}. {1}environment need thesefields.

ERROR shows the empty fields which arerequired to execute operation

Check the console and actaccordingly.

Error Code Type TIBCO-BW-SR-SAPSAASCONNECTION


TIBCO-BW-SR-SAPSAASCONNECTION-200001

Creating SharedResource {0}.

DEBUG Debug level message when creatingshared resource



Starting SharedResource {0}.

DEBUG Debug level message when startingshared resource



Updating SharedResource {0}.

DEBUG Debug level message when updatingshared resource



Stopping SharedResource {0}.

DEBUG Debug level message when stoppingshared resource


26




Deleting SharedResource {0}.

DEBUG Debug level message when deletingshared resource



Number of thread is {0}.

DEBUG Shows the number of threads This is the debug messageand resolution is notapplicable.


Access Token RequestBody [{0}], SharedResource Name=[{1}]

DEBUG Shows the access token request body This is the debug messageand resolution is notapplicable.


Configured the sharedresource {0} with typeSandbox

INFO Shows the shared resource namewhen configured with Sandbox typeenvironment

This is the info messageand resolution is notapplicable.


Configured the sharedresource {0} with typeTest/Production andauthentication type [{1}]

INFO Shows the shared resource name andauthentication type when configuredwith Test/Production typeenvironment

This is the info messageand resolution is notapplicable.


Number of thread isinvalid, default to 8.

WARN Warning message when number ofthread is invalid



Creating SharedResource {0} failed dueto [{1}].

ERROR When shared resource creation failsthen this error message occurs

Check the correspondingerror message and takeaction accordingly.

27


TIBCO Documentation and Support Services

How to Access TIBCO Documentation

Documentation for TIBCO products is available on the TIBCO Product Documentation website, mainly inHTML 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.

Product-Specific Documentation

Documentation for TIBCO ActiveMatrix BusinessWorks™ Plug-in for SAP Ariba is available on the TIBCOActiveMatrix BusinessWorks™ Plug-in for SAP Ariba documentation page.

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

● TIBCO ActiveMatrix BusinessWorks™ Plug-in for SAP Ariba Release Notes

● TIBCO ActiveMatrix BusinessWorks™ Plug-in for SAP Ariba User's Guide

● TIBCO ActiveMatrix BusinessWorks™ Plug-in for SAP Ariba Installation

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. Youalso need a user name and password to log in to https://support.tibco.com. If you do not have a username, 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.

28


https://docs.tibco.com

https://docs.tibco.com/products/tibco-activematrix-businessworks-plug-in-for-sap-ariba

https://docs.tibco.com/products/tibco-activematrix-businessworks-plug-in-for-sap-ariba

http://www.tibco.com/services/support

https://support.tibco.com

https://support.tibco.com

https://ideas.tibco.com/

https://community.tibco.com

Legal and Third-Party Notices

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 AND CONDITIONSOF A LICENSE AGREEMENT FOUND IN EITHER A SEPARATELY EXECUTED SOFTWARE LICENSEAGREEMENT, OR, IF THERE IS NO SUCH SEPARATE AGREEMENT, THE CLICKWRAP END USERLICENSE AGREEMENT WHICH IS DISPLAYED DURING DOWNLOAD OR INSTALLATION OF THESOFTWARE (AND WHICH IS DUPLICATED IN THE LICENSE FILE) OR IF THERE IS NO SUCHSOFTWARE LICENSE AGREEMENT OR CLICKWRAP END USER LICENSE AGREEMENT, THELICENSE(S) LOCATED IN THE “LICENSE” FILE(S) OF THE SOFTWARE. USE OF THIS DOCUMENT ISSUBJECT TO THOSE TERMS AND CONDITIONS, AND YOUR USE HEREOF SHALL CONSTITUTEACCEPTANCE OF AND AN AGREEMENT TO BE BOUND BY THE SAME.

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

TIBCO, the TIBCO logo, the TIBCO O logo, ActiveMatrix BusinessWorks, Business Studio, TIBCO BusinessStudio, TIB, Information Bus, and Rendezvous are either registered trademarks or trademarks of TIBCOSoftware Inc. in the United States and/or other countries.

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

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 system platformsfor a specific software version are released at the same time. Please see the readme.txt file for the availabilityof this software version on a specific operating system platform.

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

THIS DOCUMENT COULD INCLUDE TECHNICAL INACCURACIES OR TYPOGRAPHICAL ERRORS.CHANGES ARE PERIODICALLY ADDED TO THE INFORMATION HEREIN; THESE CHANGES WILLBE INCORPORATED IN NEW EDITIONS OF THIS DOCUMENT. TIBCO SOFTWARE INC. MAY MAKEIMPROVEMENTS AND/OR CHANGES IN THE PRODUCT(S) AND/OR THE PROGRAM(S) DESCRIBEDIN 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, INCLUDINGBUT 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.

Copyright © 2021. TIBCO Software Inc. All Rights Reserved.

29


https://www.tibco.com/patents

TIBCO ActiveMatrix Plug-in for SAP Ariba User's Guide

Documents

Transcript of TIBCO ActiveMatrix Plug-in for SAP Ariba User's Guide