You are on page 1of 31

ERP Outbound BIP Report Lab guide Oracle Product Management

Oracle Integration
ERP Outbound BIP Report

Contents
EXECUTIVE SUMMARY ........................................................................................................................................................... 2
STORYLINE AND PERSONAS .................................................................................................................................................... 2
OBJECTIVE ............................................................................................................................................................................... 3
Prerequisites ........................................................................................................................................................................... 3
Use case .................................................................................................................................................................................. 3
Logical flow of the integration ................................................................................................................................................ 3
Lab Environments ................................................................................................................................................................... 3
Task Overview ......................................................................................................................................................................... 4
Manage the Agent Group and the On-Premises Connectivity Agent ..................................................................................... 4
Create an Agent Group ....................................................................................................................................................... 4
Download and Run the Connectivity Agent Installer .......................................................................................................... 7
System Requirements ..................................................................................................................................................... 7
Download and Install the Agent.......................................................................................................................................... 8
Steps to download and install the Agent ........................................................................................................................ 8
Create File Connection .......................................................................................................................................................... 11
Create SOAP Connection....................................................................................................................................................... 15
Create Integration Flow ........................................................................................................................................................ 15

Integrating your ERP with Oracle Integration Page 1 of 31


ERP Outbound BIP Report Lab guide Oracle Product Management

EXECUTIVE SUMMARY
Oracle Integration provides native connectivity to Oracle and non-Oracle Software as a Service (SaaS) and On-
premises applications, such as Oracle ERP Cloud, Oracle Service Cloud, HCM Cloud, Salesforce.com, Workday,
EBS, SAP, NetSuite and so on. OIC adapters simplify connectivity by handling the underlying complexities of
connecting to applications using industry-wide best practices. You only need to create a connection that
provides minimal connectivity information for each system.

STORYLINE AND PERSONAS


This use case explores the use of OIC with ERP BIP report. User creates a report in ERP cloud using BIP and
puts/shares it in shared folder. OIC connects to ERP BIP service and pulls the report, decodes the
base64encoded response and writes it into remote file system.

The following diagram illustrates the proposed interaction between the systems involved in this use case.

Integrating your ERP with Oracle Integration Page 2 of 31


ERP Outbound BIP Report Lab guide Oracle Product Management

OBJECTIVE
This document walks you through the steps needed to replicate this use case in your environment

Prerequisites
You will need access to the following applications and products:
 Oracle Integration
 ERP Cloud

Use case
Call BIP Report service, decode the base64encoded response, and write it to a CSV file in a remote file System
(File Adapter using Agent)

Logical flow of the integration


- Create a report in ERP cloud using BIP service and store it under shared folder, and make a note of
folder structure and report name.
- Install Agent for on premise connectivity
- Create a connection using File Adapter and attach it to the Agent
- Create a connection using SOAP adapter
- Create integration flow to call the report, decode it and store it in the local file system using file
adapter

Lab Environments
• ORACLE INTEGRATION Login

– Refer ERPIntegrationWorkshopEnv.txt

• ERP Cloud Login

– Refer ERPIntegrationWorkshopEnv.txt

• Naming convention

– Note that accounts are shared between all users

– To avoid conflict between Lab users, append your class id and student id to artifacts and you
can get these ids from the instructor
Integrating your ERP with Oracle Integration Page 3 of 31
ERP Outbound BIP Report Lab guide Oracle Product Management

Task Overview
• Verify connectivity to ORACLE INTEGRATION and ERP Cloud

• Create 2 connections in ORACLE INTEGRATION

• File Connection

• ERP cloud connection using SOAP adapter

• Build integration in ORACLE INTEGRATION

• Test integration

• Validate results

Important

As the integration is being built, it is important to save it by clicking “Save” button on top-right after each
activity or in-between long activities such as mapping. This makes sure that the changes are preserved in case
of session timeouts.

Manage the Agent Group and the On-Premises Connectivity Agent


You must create an agent group and install the on-premises connectivity agent before you can create an
integration in which messages are exchanges between your on-premises applications and OIC.

Create an Agent Group

You must create an agent group in OIC before you can run the connectivity agent installer. When you install
the connectivity agent in your environment, you associate the connectivity agent with the agent group
identifier. Only one connectivity agent can be associated with an agent group. For a single OIC instance, you
can create up to five agent groups. Creating the agent group also creates the necessary artifacts required for
message exchange

NOTE: Because of the restriction with Agent groups, we will have to group the students (Number of students
per group will be decided based on the participants in that workshop but, max number of groups should not
be more than 4(5th one is for instructor) ) and then ask group leader to create the agent group, agent and
connect to the agent group by following the steps given below. Moreover, create one file connection among
the group and ask everybody in that group to use the same connection and others in the group can sit with
group leader and monitor the steps to create agent group, agent and file connection and once this is done, all
the students can go back to their seats and follow the steps to create SOAP connection and then rest of the
steps.
Integrating your ERP with Oracle Integration Page 4 of 31
ERP Outbound BIP Report Lab guide Oracle Product Management

To create an agent group:

1. In the navigation pane, click Integrations, and then click Agents.

2. Click Create Agent Group.

The New Agent Group — Information dialog is displayed.


3. Enter the following information, then click Create.

Field Description
Agent Group Name Provide a meaningful name so that others can
understand the agent name. The name must be
unique among all agent names in the system. The
name can consist of the following:
 Letters (A-Z, a-z)
 Numbers (0-9)
 Spaces ( )
 Special characters ( _ - )
The name must not begin or end with a space and
cannot be longer than 50 characters.

Integrating your ERP with Oracle Integration Page 5 of 31


ERP Outbound BIP Report Lab guide Oracle Product Management

Field Description
Identifier Accept the default identifier value or change it, if
necessary. The identifier is initially the same as the
agent group name you provided, but in upper
case. When you install the agent, you must specify
the identifier value.
Note: After creating the agent group, you cannot
edit the agent group identifier. Instead, you must
delete and recreate another agent group to
associate with a different agent group identifier.
Agent Type Connectivity Agent is displayed and cannot be
edited. The connectivity agent supports
integrating with on-premises systems. The agent
group references only connectivity agents.
Description Provide a meaningful description so that others
can understand the responsibilities of the agent
group

Note: Please make a note of Identifier; you will be using it in the later steps.

4. You can see the agent group created as per the below screen.

Integrating your ERP with Oracle Integration Page 6 of 31


ERP Outbound BIP Report Lab guide Oracle Product Management

5. Please note that in above screen, agents are showing as zero for ConnectityAgent group, which means
there are no agents registered with this group as of now.

Download and Run the Connectivity Agent Installer

You must download and run the connectivity agent installer to install the agent in your local environment

System Requirements

Satisfy the following system requirements before installing the on-premises connectivity agent.

 The agent is certified with JDK Version 8 and 9. The JDK installation can be shared with other products
installed on the same host. However, ensure that the JDK installation is not modified for use with these
other products.

 The agent is certified on the following operating systems:


 Oracle Enterprise Linux 6.x

 Oracle Enterprise Linux 7.2

 RedHat Enterprise Linux 6.6

 RedHat Enterprise Linux 7.2, 7.5

 Suse Linux Enterprise Edition 12 SP2

 Windows Standard Edition 2016

Note:

If you install the agent on Windows, automatic upgrade of the agent is not supported. You must
manually upgrade the agent after your instance is upgraded to the latest version.

See Running the Connectivity Agent on a Windows Host Requires a Manual Upgrade.
Integrating your ERP with Oracle Integration Page 7 of 31
ERP Outbound BIP Report Lab guide Oracle Product Management

 Note:
 Open JDK is not supported.
 Provide a minimum of 8 GB memory with 4 GB of heap size dedicated for the agent JVM. If you want to
include any other processes on that host besides the on-premises agent, it is strongly recommended
that you increase physical memory to a value greater than 8 GB.

Refer documentation for latest information on system Requirements:

Download and Install the Agent

Install the connectivity agent installer to install the agent in your local environment. During installation, you
associate the connectivity agent with the agent group identifier you generated when creating an agent group
in OIC.

Note:
You must have the ServiceAdministrator, ServiceUser, or ServiceDeveloper role to download the agent.
See Grant Access and Secure of Administering OIC.

Steps to download and install the Agent


1. Create a directory in for connectivity agent installation on your on-premises host. And please pass the
directory location to your group members
Note:

 Do not install the agent in a directory path that includes /tmp.


 Agent installation is not supported with use of an SSL proxy.
2. In the left navigation pane, click Integrations, then click Agents.
3. Click Download > Connectivity Agent.

Integrating your ERP with Oracle Integration Page 8 of 31


ERP Outbound BIP Report Lab guide Oracle Product Management

4. Download the connectivity agent installer to the directory on your on-premises host.
5. Unzip oic_connectivity_agent.zip.
6. Modify InstallerProfile.cfg to include the following information. Some of the optional parameters might
not be there in the file, but you can copy and paste it from here like user and password.

1. Copy oic_URL from ERPIntegrationWorkshopEnv.txt


2. You should have noted Identifier while creating Agent group, you need to use it in the
InstallerProfile.cfg
3. You must have received OIC credentials, please use those credentials in this file
4. Can leave other values as blank

# Required Parameters
# oic_URL format should be https://oicpmdemoumic-oicpm.uscom-central-1.oraclecloud.com:443
oic_URL=https://Oracle Integration_host:ssl_port
agent_GROUP_IDENTIFIER=AGENT_GROUP_5_96_06
#Optional Parameters
oic_USER=xxxxx
oic_PASSWORD=xxxxxxxxxx

#Proxy Parameters
proxy_HOST=
proxy_PORT=
proxy_USER=
proxy_PASSWORD=
proxy_NON_PROXY_HOSTS=

7. Set the JAVA_HOME property to the location of the JDK installation.


8. Set the PATH property.

setenv PATH = $JAVA_HOME/bin:$PATH

9. Run the connectivity agent installer from the command prompt:


If using JDK 8:
Integrating your ERP with Oracle Integration Page 9 of 31
ERP Outbound BIP Report Lab guide Oracle Product Management

java –jar connectivityagent.jar

If using JDK 9:

java --add-modules java.xml.ws,java.xml.bind -jar connectivityagent.jar

10. Wait for a successful installation message to appear.

Done with Agent installation & configuration... Starting agent for message processing.
Agent started successfully... listening for new messages...

Please find the below screenshot for your reference of properties file and system messages

If errors occur, review the agent diagnostic logs which is at <<Agent installation folder>>\Oracle
Integration_connectivity_agent\agenthome\logs .

Integrating your ERP with Oracle Integration Page 10 of 31


ERP Outbound BIP Report Lab guide Oracle Product Management

11. Now, Go to the Integration service console, click on Agents and see that Agent is registered for the
group which you have specified

After you have installed the on-premises agent, you can create a connection that uses the agent group and its
associated on-premises agent. Only agent groups whose monitoring status is green on the Agent Monitoring
page.

Create File Connection

To create a connection with an agent group:


1. On the Oracle Integration home page, click Connections.
2. Click “Create” button on top-right
3. Search for File, System displays File adapter  click “Select” button

Integrating your ERP with Oracle Integration Page 11 of 31


ERP Outbound BIP Report Lab guide Oracle Product Management

4. Provide Connection properties and then click on ‘Create’


Field Action

Connection Name Enter value

File CONN_<ClassID>_<StudentID>

e.g. File CONN_96_06

Identifier Nothing to enter.

Automatically generated from the connection name:

Version Nothing to enter.

Use the default value of 01.00.0000.

Connection Role Invoke

Integrating your ERP with Oracle Integration Page 12 of 31


ERP Outbound BIP Report Lab guide Oracle Product Management

5. In the Agent Group section, click Configure Agents to select the agent group to associate with the
adapter. This enables you to access your on-premises applications.

Integrating your ERP with Oracle Integration Page 13 of 31


ERP Outbound BIP Report Lab guide Oracle Product Management

6. Select the agent group to use with this adapter, and click Use.
7. Click Test. This test executes the ping command on the on-premises instance when the connection is
associated with an agent.

8. Click Save, then click Close.

Integrating your ERP with Oracle Integration Page 14 of 31


ERP Outbound BIP Report Lab guide Oracle Product Management

Create SOAP Connection


Note: Participants are requested to use existing connection (ERPBIP CONN 96 06) instead of creating
new connection.

Create Integration Flow


1. Go to Integration Cloud console Designer  Integrations Click on Create

2. Select “Scheduled Orchestration” Style and click on Select

3. Provide Integration name “ERP BIP Extract File Sys ””+<<ClassID>>+<<Studentid>> and package name
as erp.report.lab and click on Create

Eg: ERP BIP Extract File Sys 96 06

Integrating your ERP with Oracle Integration Page 15 of 31


ERP Outbound BIP Report Lab guide Oracle Product Management

4. System displays the following screen

5. Click on Invokes which is on right side of the screen  Expand SOAP adapter  Select the adapter
which you have created and drag and drop as per the below screen

Integrating your ERP with Oracle Integration Page 16 of 31


ERP Outbound BIP Report Lab guide Oracle Product Management

6. Enter the information as per the below screen and click on Next  Select runReport operation and
click Next Click Next and Click Done

Integrating your ERP with Oracle Integration Page 17 of 31


ERP Outbound BIP Report Lab guide Oracle Product Management

Integrating your ERP with Oracle Integration Page 18 of 31


ERP Outbound BIP Report Lab guide Oracle Product Management

7. System displays the screen given below

8. Click on Edit of ‘Map to GetBIPReport’ component

9. Expand reportRequest  Right click on reportAbsolutePath Click on ‘Create Target Node’  Enter
absolute path of the report as ““/Custom/Financials/GLCCReport.xdo“ and click on Save and close the
expression editor.
Integrating your ERP with Oracle Integration Page 19 of 31
ERP Outbound BIP Report Lab guide Oracle Product Management

Integrating your ERP with Oracle Integration Page 20 of 31


ERP Outbound BIP Report Lab guide Oracle Product Management

10. Expand parameterNameValues  expand item  right click on name  click on ‘Target Node’ 
enter “LedgerName" and click on Save and close

11. Expand values as per the below screen

Integrating your ERP with Oracle Integration Page 21 of 31


ERP Outbound BIP Report Lab guide Oracle Product Management

12. Right click on item  Click on ‘Create Target Node’  Enter "US Primary Ledger" and click on Save,
click on close

13. Right click on userId Click on ‘Create Target Node’  Enter ERP Cloud User ID (Get ERP Cloud User ID
and password from ERPIntegrationWorkshopEnv.txt which is under Lab4 section) and click on Save and
close the expression editor and repeat for password element also

14. Click on Validate  If successful click on Test Click on Generate Inputs Click on Execute and check
the Target if you have all the values mapped correctly. If Validation fails, then please cross check your
mappings

Integrating your ERP with Oracle Integration Page 22 of 31


ERP Outbound BIP Report Lab guide Oracle Product Management

15. Click on Close


16. Click on Actions  Drag and Drop Assign activity below the ‘GetBIPReport’ activity as shown below.

Integrating your ERP with Oracle Integration Page 23 of 31


ERP Outbound BIP Report Lab guide Oracle Product Management

17. Enter name of the activity as ‘DecodeResponse’

18. Click on + icon

19. Click on Expression Editor under Value

20. Enter ‘decode’ in search box and click on Search  Select ‘decodeBase64’ function  click on >

Integrating your ERP with Oracle Integration Page 24 of 31


ERP Outbound BIP Report Lab guide Oracle Product Management

21. Delete inputString from the expression editor  expand GetBIPReport  expand runReportResponse
 expand runReportReturn  select reportBytes  Click on >
Please cross check the below screenshot for your reference.

Integrating your ERP with Oracle Integration Page 25 of 31


ERP Outbound BIP Report Lab guide Oracle Product Management

22. Click on Validate and Click on Close. System displays the following screen.

23. Click on Validate and Click on Close. System displays the following screen.

24. Click on Invokes  Drag and Drop the File connection which you have created after DecodeResponse
activity
25. Enter Basic Info as per the below screen and click on Next

Integrating your ERP with Oracle Integration Page 26 of 31


ERP Outbound BIP Report Lab guide Oracle Product Management

26. Configure the File Operation parameters as per the below screenshot and append the File Name
pattern with your name/last name so that it would be unique for all the participants and click on Next
Output Directory: D:\ORACLE INTEGRATION\output (You must have received this from your group
leader )
Fila Name Pattern as: Oracle%SEQ%File<<your initials or student id>>.csv

Integrating your ERP with Oracle Integration Page 27 of 31


ERP Outbound BIP Report Lab guide Oracle Product Management

27. You must have received ‘outputFile.csv’ along with this document. Please upload outputFile.csv in
‘Define the structure of the file contents’ section

28. Enter Record Name and Recordset Name as per the report. Here we are entering Ledger and LedgerSet
as Record Name and Recordset Name and click on Next and click on Done

Integrating your ERP with Oracle Integration Page 28 of 31


ERP Outbound BIP Report Lab guide Oracle Product Management

29. System displays the below screen

30. Select ‘Map to RemoteFileWrite’ activity and click on Edit  Map the source element
($DecodeResponse_assignment_1) with target element (Ledger/Report) as per the below screenshot
and click on Validate and click on Close.

31. Click on Actions Click on Tracking select startTime as a Business Identifier and click on > and click
on Save

Integrating your ERP with Oracle Integration Page 29 of 31


ERP Outbound BIP Report Lab guide Oracle Product Management

32. Integration Flow should like the below screen shot  Click on Save and Click on Close

Integrating your ERP with Oracle Integration Page 30 of 31


ERP Outbound BIP Report Lab guide Oracle Product Management

33. Activate the integration, select ‘Enable Tracing’ option and select ‘Include payload’ option and click on
Activate button  click on Submit Now under Actions Menu after integration flow has been activated.

34. Go to Monitors section and click on Tracking  Check the status of the integration

35. Check the file in remote file path (In group leader’s machine) and if you have a file in the remote file
system then you have successfully completed this lab. Congratulations!!!

Integrating your ERP with Oracle Integration Page 31 of 31

You might also like