You are on page 1of 28

OR

ACL
E
SUP
POR
T
SER
VIC
ES

ORACLE E-Business Suite (EBS) 12.1


Integrated SOA Gateway (ISG)
Invoking an External Web Service
Using the Service Invocation Framework (SIF)

Prepared by:
Author:
Creation Date: Thursday, November 05, 2009
Last Updated: Tuesday, June 15, 2010

Definition:
This is an example of how to obtain information from an external source using a published web
service using ISG in EBS.

Method:
The web service will be invoked (launched) from a workflow process. Oracle Workflow is a
mature product with a large number of experienced Developers. This allows ISG to be easily
understood if it is presented in the context of being integrated into a workflow process. The
Service Invocation Framework (SIF) is an enhancement to the Business Event System (BES)
with the introduction of seeded web service subscriptions and additional User Interfaces (UI) for
specifying the location of the Web Service Definition Language (WSDL) that has been
deployed by companies that for others to subscribe and use.

Proxy Setup:

In order to point to an external URL containing a WSDL, you need to be able to connect
through Oracle’s proxy. Update the autoconfig Applications Tier $CONTEXT_FILE with the
proxyhost and proxyport.

· Login to E-Business as a user assigned the System Administrator responsibility and navigate:
System Administrator > Oracle Applications Manager > AutoConfig

In Applications click Edit Parameters

oacore and oafm oc4j.properties

Query OA_VAR = proxy

s_proxyhost= <HOST>
s_proxyport= <PORT>

Concurrent Manager Node running Workflow Services adovars.env

Query OA_VAR = s_appsjreopts

s_appsjreopts= -Dhttp.proxyHost=<HOST> -Dhttp.proxyPort=<PORT>

· Run autoconfig:

sh $ADMIN_SCRIPTS_HOME/adautocfg.sh

• Shutdown and restart the Web Server components:

sh $ADMIN_SCRIPTS_HOME/adstpall.sh
sh $ADMIN_SCRIPTS_HOME/adstrtal.sh

Business Event (SIF) Setup:

The Business Event System menu UI has been enhanced to enable a web service to be defined
and invoked from the UI. A seeded Invoke Web Service Action Type has been created for a
Local Java Subscription that will invoke the web service. A new WFERROR Process
Subscription DEFAULT_EVENT_ERROR2 has been created and must be added to the event
defined to invoke the web service.

The Local Java Subscription with the seeded Invoke Web Service Action Type will include the
following parameters to invoke the web service:

· SERVICE_WSDL_URL - The URL where the Web Services Description Language


(WSDL) description for the Web service is located. If the Web service is a BPEL process, you
can specify the path of the WSDL description on the BPEL server.
· SERVICE_NAME - The name of the Web service.
· SERVICE_PORTTYPE - The port type, or set of abstract operations, that includes the
operation to invoke.
· SERVICE_OPERATION - The operation to invoke.
· SERVICE_PORT - A single communication endpoint defined by a combination of a
network address and a binding. The binding specifies concrete protocol and data format
specifications for the operations and messages defined by the port type.

SIF Demo:

Business Event SIF UI:

This demonstration will show how to a workflow can be used to invoke a web service and
retrieve information from an external Internet site. This is a demo created by Vijay Workflow
Development Product Manager.

Workflow Administrator Web Applications > Business Events

Create oracle.apps.wf.movie.invoke event.


Add Subscriptions to the oracle.apps.wf.movie.invoke event.

Create Local Java Subscription to use seeded Invoke Web Service Action Type.

· RACLE' Administrator Workflow


Diagnostics Horne Logout Preferences Help

come Developer Studio Business Events Status Monitor Notifications Administ


E v e nt s I S u b scrip t ion s I Ag en t s I S y st ems
Business Events Events > Business Events Events > Subscriptions >

Cancel

Update Event Subscriptions


An event subscription is a registration indicating that a particular event is significant to a particular system. An event subscription specifies the processing to perform when the triggering event occurs.
Indicates required field
Click Next to add the WSDL URL to be invoked.

(.‘ Consume WSDL in Event Subscription - Windows Internet Explorer r-10)[L(j

jar tg • C http://<HOST>:<PORT>0/0A_HTMLIOA.jsp?page=loraclelapc vj {4t)) X) GoogIe P

File Edit View Favorites Mole Help

0 Consume WSDL in Event Subscription 1 a- ®1 -ir Page • (cif

ORACLE® Administrator Workflow


Diagnostics Home Logout Preferences Help

Home Developer Studio _ Busbess Events Status Monitor _ Notifications _ Administration


Events I Subscriptio - - -ems

',...) 0 3 O 0
Load WSDL Select Service Select Service Port Select Operation Subscription Documentation
Select a WSDL Source

Cancel Step 1 of 5
Next
Enter the URL of the WSDL to consume in the Business Event Subscription
* Indicates required field
* WSDL URL http://www.ignyte.com/webservices/name=<.whatsshowing.webservice/movie
Example: http://supplier.company.corn:8888/webservicm/supprierservicemsdl

Cancel Step 1 of 5 Next

Developer Business Status


Home Notifications Administration Diagnostics Home Logout Preferences
Help
Studio Events Monitor
About this Page Privacy Statement Copyright (02008. Orade. All rights reserved.

Done S Local intranet +, 100%

NOTE: The following are all contained in the WSDL and can be obtained by using the WSDL
URL in a web browser to see the definition.
C l i c k N e x t t o a d d t h e W S D L S e r v i c e N a m e .

Cp. e Ez
Consume WSDL in Event Subscription - Windows Internet Explorer
http://<HOST>:<PORT>/0A_HTMLIOA.jsp?page=loraclelapd

File Edit View Favorites Tools Help

a& *Consume WSDL in Event Subscription a - ID 0 - D, Page • 4 Tools • '


ORACLE® Administrator Workflow
Diagnostics Home Logout Preferences Help

Home Developer Studio Business Events Status Monitor Notifications Administration _


Events I Subscriptions I Agents I
Systems
0 0
Load WSDL Select Service Select Service Port Select Operation Subscription Documentation
Select Service

Cancel Back Step 2 of 5 Next


Select a service to consume in Business Event Subscription
* Indicates required field
WSDL Source URA
WSDLDescription
wsdl
* Service Name MovieInformation http:/<HOST>/webservioes/name=<NAME>.whatsshowing.webserviceimovief
unctions.asmx?
Cancel Back Step 2 of 5 Next

Developer Business Status


Home Notifications Administration Diagnostics Home Logout Preferences Help
Studio Events Monitor
About this Page Privacy Statement Copyright (02006. Orade. All rights reserveo.

< WI >

Done Local intranet -*, 100%-


Click Next to add WSDL Service Port.

( Consume WSDL in Event Subscription - Windows Internet Explorer r-Jf-'111 x


1077‘, C http://<HOST>:<PORT>/0A_HTMLIOA.jsp?page=loraclelapQsfl R ,) P
File Edit View Favorites Tools Help

& I a Consume WSDL in Event Subscription a - tu - Page -


Tools
ORACLE' Administrator Workflow d
Diagnostics Home Logout Preferences
Help
Home Developer Studio Business Events Status Monitor Notifications Administration
0 0 0

Load WSDL Select Service Select Service Port Select Operation Subscription
Select Service Port

Cancel ' Back Step 3 of 5 Next


Select a service port to consume in Business Event Subscription
WSDL Source URL
WSDL Descriptionhttp://<HOST>/webservices/ignyte.whatsshowing.webservice/moviefunctions.asmx?
wsdl
Selected Service
Select Service Port Port End Point
0 MovielnformationSoap http://<HOST>/webservices/ignyte.whatsshowing.webservice/moviefunctions.asmx
0 MovielnformationSoap12 http://<HOST>/webservices/ignyte.whatsshowing.webservice/moviefunctions.asmx

Cancel Badc Step 3 of 5

Developer Business Status


Home Notifications Administration Diagnostics Home Logout
Preferences Help
Studio Events Monitor v
< I 1

Lj Local intranet t 100% • .::


Click Next to add WSDL Operation, Port Type and Operation Response.
4 Consume

) v C http://<HOST>:<PORT>,10A_HTMLJOA.jsp?page=ioraclejap ,-,

File Edit View


Favorites
6r /
*Consume WSDL in Event Subscription ffk - gii IS • 6). Page • 4 Tools • '

/ORACLE' Administrator Workflow


Diagnostics Home Logout Preferences Help

Home Developer Studio Business Events Status Monitor Notifications Administration


Events I Subscriptions I Agents I Systems
0 0 0 0 0
Load WSDL Select Service Select Service Port Select Operation Subscription Documentation
Select Service Operation

Cancel Badc Step 4 of 5 Next


Select a service to consume in Business Event Subscription
wsrm sniirrp IIRI
WSDL Description http://<HOST>/ webservices/name=<NAME>.whatsshowing.webservice/moviefunctions.asmx?
wsdl
Selected Service Movieinformation
Selected Port MovieinformationSoap
Select Operation Port Type Operation Type
0 GetUpcomingMovies MovielnformationSoap REQUEST_RESPONSE
0 GetTheatersAndMovies MovielnformationSoap REQUEST_RESPONSE

Cancel Back 1 Step 4 of 5 Next

Developer Business Status me Notifications Administration Diac nostics Home Logout Preferences Hel.
I>
_ Local intranet
1
Click Next to add oracle.apps.fnd.wf.bes.WebServiceInvokerSubscription Java Rule Function
and the Optional Callback Parameters so the result of the web service invocation will be returned
back.

WFBES_CALLBACK_EVENT – receive event


WFBES_CALLBACK_AGENT – WF_WS_JMS_IN or any other Inbound Queue
Create a Workflow Error Subscription to capture web service invocation failures.

(- Create Event Subscription - Windows Internet Explorer

File Edit View Favorites Tools Help

4171 0 Create Event Subscription · a Page • Tools


CD RAC LE Administrator Workflow


Diagnostics Home Logout Preferences Help

Home Developer Stud i o BusMess Events Status Monitor Notifications Administration

I Business Events: Events > Business Events : Events > Subscriptions >
lig Local intranet ft 100% •
The SIF invocation demo now contains 2 subscriptions.

Subscriptions - Windows Internet Explorer COD


File Edit View Favorites Tools Help
.
4 4? Subscriptions - 6)- .age - Tools
-

ORACLE' Administrator Workflow

H o m e De v e l o p e r S tu d i o Bu si ne ss Ev e
Events ! Subscriptions Agents Systems
Business Events E.ent Subscription Launch Workflow > Update Event Subscriptiors >
Subscriptions: Event: oracle.apps.vvf.movie.invoke ____________________________________________________
An event subscription is a registration indicating that a particular event is significant to a particular system. An event subscription specifies the processing to
perform whet the triggering event occurs.
Create Subscription

System Source Type Out Agent To Agent Function Workflow Status


<HOST> Error v,trule.defaultrule WFERROR/DEFAULT_EVENT_ERROR2 Enabled J
<HOST> Local Enabled

Return to Events

Home Developer Studio Business Events Status Monitor Notifications Administration Diagnostics Home Logout Preferences Help About
this Page
C r e a t e W F B E S _ C A L L B A C K _ E V E N T o r a c l e . a p p s . w f . m o v i e . r e c e i v e r e c e i v e e v e n t .

Update Event - Windows Internet Explorer


httpill<HOST>ooloA_Krm0A.jspLrc=w3E5EDITEvENTPAGEkr=osiEventGuiD=77A1967mBoFF34AEoiosooA3598omi
Fi l e E d i t View Fa v o r i t es To o l s He l p
McAfee hi
Home Developer Studio Business Even:s Status Monitor Notifications Administration Diagnostics Home Logout Preferences Help Personalize Page
About this Page Privacy Statement Ocpyript (02008. Oracle. All righ •
Create the oracle.apps.wf.movie.receive event subscription. The subscription will continue the
workflow process that has stopped at the RECEIVE_SERVICE (Receive Service) receive event
activity. The phase is set to 100 so it is deferred to the WF_ AVA_DEFERRED queue after
being processed from the WF_WS_ MS_IN queue by the Web Services IN Agent. This is a
demo of asynchronous processing and is not required.
The RECEIVE_SERVICE (Receive Service) receive event activity within the JBES_INVOKER
(JBES Web Service Invoker) workflow process will accept the response data from the external
web service so it can be accessed and sent in a notification.

Workflow Type/Name: WFINVDEM

Workflow Process: JBES_INVOKER


The oracle.apps.wf.movie.receive event subscription.
Workflow Process:

A workflow process is used to invoke the web service using SIF.


Graphical Design Model:

=Oracle Workflow Builder 2.6.3.0A - [Navigator]


Arai File Edit View Window Help
Dielital 4, I e
- WSINVTST
ff2 WFINVDEM (Workflow Web Service Invocation Demo]
— ______ .Attributes
RECIPIENT [Notification Recipient]
WS_RESPONSE [Web Service Response]
CALLBACK_EVENT (Web Service Callback Event)
INVOKER_EVENT [Invoker Event)
INVOKER_KEY (Invoker Key]
, 3
1 t .1
, 3 INVOKER_DATA [Invoker Event Data)
1 t .1 CALLBACK_AGENT [Web Service Callback Agent]
1.(tc.1
0
ZIP_CODE [Zip Code]
RADIUS (Radius around the Zip in miles)
- a P ro c e s se s
JBES_INVOKER [JBES Web Service Invoker]
- r . :3 Notifications
tT SE RV I CE_ I NV OK E D (We b Se rvice In vo ke d )
- G Fun ctions
SET_SOAP_MSG (Set SOAP Message)
SET_SOAP_MSG_BPEL (Set SOAP Message for BPEL)
- 5' Events
- INVOKE_SERVICE [Invoke Web Service)
ES UEVENTMESSAGE2 (Invoker Event Message)
WFBES_C.ALLBACK_AGENT (Workflow Callback Agent Name)
WFBES_C.ALLBACK_EVENT [Workflow Callback Event Name]
RECEIVE_SERVICE (Receive Service]
I ta Messages
I - t a S E RV I CE _ I NV O K E D ( We b S e r vi ce I n vo ke d )
ES WS_RESPONSE (Web Service Response]
ES RESPONSE_CONTENT (Response Content]
Lookup Types
ff! WFSTD (Standard)
CLi Directory Service
T h e w o k f l o w c a n be l a u nc h e d u s i n g D e v e l o p e r S t u d i o i n s i d e E B S R e l e a s e 1 2 . 1 .

W o r k f l o w A d m i n i s t r a t o r W e b A p p l i c a t i o n s > D e v e l o p e r S t u d i o

Type Internal Name: WFINVDEM

(2 Oracle Workflow: Workflow Types - Windows Internet Explorer 00


- http:ll<HOST>:<PORT>0A_HTMLIRF.jsp?function jd=1015514&resp jd=216158tresp_appl

He Edit View Favorites Tools Help


Oracle Workflow: Workflow Types ffit • cS • D. Page • Ct Tools -
ORACLE' Administrator Workflow
Home Logout Preferences Help Diagnostics

Home Developer Studio Business Events Status Monitor

Notifications Administration Workflow Types


Enter Workflow Type (select from list) or Type Internal Name and select "Go" to find workflow definitions.

Search

workflow Type

Type Internal Name WFINVDEMI


(Examp:e: WFDE6MO. VJFERROR)
11 Clear

11P The "Run" icon is disabled if the workflow type has no runnable processes.
Workflow Type Internal name Description run
(No workflow types found)

Home Developer Studio Business Events Status Monitor Notifications Administration Home Logout Preferences Help Diagnostics
About this Page Privacy Statement Copyright (0)2008. Orade. All rights resented
Launch Parameters Example:

Item Key: invoke1

Notification Recipient: SYSADMIN


Web Service Callback Event: oracle.apps.wf.movie.receive
Invoker Event: oracle.apps.wf.movie.invoke
Invoker Key: garyinvoke1
Web Service Callback Agent: WF_WS_JMS_IN
Zip Code: 32822
Radius around the Zip in miles: 10
S t a t us M on i t or S t a t u s D i a g ra m V i e w :

The launche d workfl ow process is waiti ng for the cal lbac k.

I Oracle Workflow: Status Monitor - Windows Internet Explorer qiitOJITC1

erg • iti http://<HOST>:<PORT>/0A_HTML/OA.jsp?_rc=WF_MONITOR_HISTORY_P IA s El Google P'


File Edit View Favorites Tools Help

0Oracle Workflow: Status Monitor -® LI, Page • 41 Tools • .

ORACLE' Administrator Workflow


Diagnostics Home Logout Preferences Help

Home Developer Studio Business Events Status Monitor _ NotificationsAdministration


Status Monitor > Monitor Search > Monitor Activities History >
Status Diagram: WFINVDEM, invoke
Workflow Type Workflow Web Service Invocation Demo Started 10-Nov-2009
21:01:27

Current Status

4-rll, Status Diagram Time Zone Central Time


JBES Web Service Invoker : WFINVDEM,invoke Zoom In

±
III 01r
_I D
Start Set SOAP Invoke Web Rec ore Service Web Service End
Message Service Invoked

Definition 1 I> r, I,'1pof.


Current Location :JBES Web Service Invoker/JBES Web Service Invoker
Item Type : Workflow Web Service Invocation Demo
Activity Name : JBES Web Service Invoker
Description :
Activity Type : Process
Result Type :

Copyright ©1998, 1999, 2000, 2001, 2002 Oracle Corporation

Update Attributes Rewind Suspend Workflow Cancel Workflow


I
- - . .
ii Local intranet *k 100% • .::
-
Noti fica tion in the Worklist showing a listing of the all Cine mas in a 10 mile a rea of zi p code

32822 and the show tim es of thei r movies.

1
Notification Details - Windows Internet Explorer 0

<HOST>:<PORT>/0AHTML/OA.jsp,CARnc,ND_WFNTF_DETAILSNaffd.,6808428,add13,eacCrumb=nretairal... 43E 3ing


Rle Edt View Favorites Tools Heir
O Mk A f oo .

ORACLE E-Business Suite


D a)no5t,os I lone L,gout Preferences I leID Personal], Page

Information
This edification dues riot require a resporae.
Web Service Invoked
OK Reassign Request information
To name=<NAME>
Sent 1b-JIM-20W 1/:42:11/
ID 4600842
Colonial Pmmerade 6 - Tnuchsta• Cinemas
4672 East Colonial Dive Orlando, FL
PG Ake in Wonderland 1 hr v 9 mins PG-13 Clash of the Titans 1 hr EO mins PG Diary or a Wimpy Kd 1 Fr 33 m ns PG Furry Vengeance ' hr 32 mins R Hot Tub Tiff., Machine 1 hr
mins R Kick-Ass 1 hr mins R MacGruber ' hr 23 mins PG-13 The Back-up Pal 1 hr 38 mins PG-13 The Bounty HLn:er 1 ir 46 mins PG —he Last Sonq 1 hr 47 mins PG-13 Tie Losers 1
hr 4) mins PG 13 Tyler Parry's Why Dd I Got Marriod Too 2 hrs 01 m n P'cmicrc Odando
32W East Colonial Uwe. Orlando, I-L
PG-13 Iron Man 2 2 hrs OG mins PG _etters to Juliet 1 hr 4!: mins PG-13 .rirce of Persia: The Ea-ids of Time 1 hr 55 mins PG-13 Robin I lood 2 .irs 20 mins R Sex anc the City 2 2 hrs 27
mins DG Shre< Forever Afle• 1 hr 33 rrirs PG Shrek Forever Ater 3D 1 h• 33 mils Plaza Cinema CafD
155 South Orange Meow. Orlando, FL
PG 13 Date Night 1 hr 28 mins a Go: Hill to :he Grcc< 1 hr L9 mins PG 13 Iron Man 2 2 hrs CS mi. PG 13 Killers 1 hr 40 mins PG Marmaduke hr 27 mins PG 13 Prince of Persia: The
Sands of I me 1 F r 55 m ns PG-13 Robin Hood 2 hrs 2U nuns H Sex and the City Z 2 hrs 2/ mins Shrek Forever After 1 hr 33 mins R Splice 1 hr 44 mins PG-13 the A-lean 1
hr 51
mins .G The Karate <id 2 hrs 20 mins Regal Waterford Lakes 20
541 North Alafaya Trail Orlando, FL
R Get Him to the G•eek 1 ir 49 mins PG-13 Iron Man 2 2 hrs 05 rrirs FG-'3 Kit ws 1 Fr 40 rn ns .G Letters to Juliet 1 hr 45 mins PG Marmaduke ' hr 27 mins PG-13 Rine of Persia: The
Sands of Tmo 1 Fr 55 m n3 PG 13 Robin Hood 2 hrs 20 mi. R Sex and the City 2 2 hrs 27 mins PG Shrek Forcvcr Aftcr 1 hr 33 min PG Shrk Forever Aftar 3D 1 Fr 33 in noPG Sh•ck
Forever After. An WAX 3J Expenence 1 Fr 34 niis R SDI ce 1 hr L4 mins PG-13 he A-learn 1 hr 5/ mins PG I he Karate Kid 2 hrs 23 mins Alorra Cirema Grill
2155 Al01713 Avenue, VVinter Pa*, rL
PG Sleek Forever After 1 hr 33 mins PG The Karate Kid 9 Frs 70 mils Regal Winter Park Vi lege 70
510 hicalh Orlando Aveuce, Wider Park, FL
PG-13 Crazy Like a Fox 1 h• 38 mils R Get Him to the S•siek 1 ir 49 mins PG-13 Iron Man 2 2 hrs 05 mins PG-13 Killers 1 hr .10 mins DG Letters to Juliet 1 hr 45 mins PG Marmaduke '
hr 27 mins PG-13 Friice of Persia: The Sands of Time 1 hr 55 mins PG-13 Robin -locd 2 hrs 20 mins R Sex and the City 2 2 hrs 27 rrirs FG Srrek Forever Ater 1 Fr 33 mins PG Sirek
Forever After 3D 1 Fr 33 m n3 II Sp ice 1 hr 4, mins ,C-13 The A-Team 1 Fr 57 in n3 PO The Karate Kid 2 hrs 20 mins Enzian Theatre
MOO %nth Nan& Avanna Maitland, F!
R The Secie. in Their Eyes (El serae.0 de SJS UjUS) 2 his 35 mins Ciiienterk al Festival Bay
5150 ,nterrational Drive, Cdando, FL
R Get Him to the week 1 ir 49 mins PG Hotel for Does 1 hr 40 mins .G-13 Iron Man 2 2 hrs 05 mils PG-13 Killers 1 M40 mins PG Marnaduke 1 hr 27 mins PG-13 Prnce of Persia: The
Sands of T me 1 Fr SS m n3 PO-13 Robin Hood 2 hrs 20 mins R Sex and the City 2 2 hrs 27 mins PC Shrek Forever .After 1 hr 33 mins PC Shrek Forever After 3D 1 Fr 33 m na R Sp ice 1 hr
44 mins PG-13 TF A A-Team 1 hr 57 mins PG The Karate Kid 9 hm 90 mins Sniithohase 7 - Truchstar Cinemas vl
Completion of the process after the callback response is received.

References:

· This document of the SIF component of ISG is based on the sample demo written by
Vijay and is published in his blog entry:

“Invoking Web Service from Oracle Workflow process”

http://blogs.oracle.com/ebusinesssuiteintegration/2009/07/invoking_web_service_from_orac_1.html
· Note 736404.1 How To Troubleshoot Service Invocation Framework(SIF) In
12.1.1 Integrated SOA Gateway

You might also like