Você está na página 1de 266

Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

s a
h a
l c l)
e nte uide
Siebel 8.1.x e z @ nt G
Integration
s q u tude
( f cva this S
e d aVolumesIIe Student Guide
s t a e to u
z Ca cens
s q ue le li
e V ferab
e l ip rans
F n-t
no

D71810GC10
Edition 1.0
April 2011
D72828
Copyright 2011, Oracle and/or its affiliates. All rights reserved.

Disclaimer

This document contains proprietary information and is protected by copyright and other intellectual property laws. You may copy and
print this document solely for your own use in an Oracle training course. The document may not be modified or altered in any way.
Except where your use constitutes "fair use" under copyright law, you may not use, share, download, upload, copy, print, display,
perform, reproduce, publish, license, post, transmit, or distribute this document in whole or in part without the express authorization
of Oracle.
Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

The information contained in this document is subject to change without notice. If you find any problems in the document, please
report them in writing to: Oracle University, 500 Oracle Parkway, Redwood Shores, California 94065 USA. This document is not
warranted to be error-free.

Restricted Rights Notice

If this documentation is delivered to the United States Government or anyone using the documentation on behalf of the United
States Government, the following notice is applicable:

U.S. GOVERNMENT RIGHTS


The U.S. Governments rights to use, modify, reproduce, release, perform, display, or disclose these training materials are restricted
by the terms of the applicable Oracle license agreement and/or the applicable U.S. Government contract.

Trademark Notice s a
h a
c l)
Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective
l
nte uide
owners.

e
@ nt G
Author e z
u tude
Neil Lang s q
( f cva this S
Technical Contributors and Reviewers da e
e u s
Siebel CRM Team
a sta se to
C Oracle
This book was published using:
z c en Tutor
e l i
squ rable
e V fe
e l i p a n s
F n-t r
no
Table of Contents
Siebel 8.1.x Integration: Course Introduction .......................................................................................... 1-1
Siebel 8.1.x Integration: Course Introduction ............................................................................................ 1-2
Lesson Agenda ....................................................................................................................................... 1-3
Instructor and Class Participants ............................................................................................................. 1-4
Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

Training Site Information ......................................................................................................................... 1-5


Course Audience .................................................................................................................................... 1-6
Course Prerequisites............................................................................................................................... 1-7
Course Goal ........................................................................................................................................... 1-8
Course Objectives................................................................................................................................... 1-9
Course Methodology ............................................................................................................................... 1-10
Course Materials..................................................................................................................................... 1-11
Siebel Documentation ............................................................................................................................. 1-12
Feedback ............................................................................................................................................... 1-13
Course Agenda ....................................................................................................................................... 1-14
s a
h a
Introduction to Siebel Application Integration ......................................................................................... 2-1

l c l)
Introduction to Siebel Application Integration............................................................................................ 2-2
nte uide
Objectives............................................................................................................................................... 2-3
e
e z @ nt G
Patterns for Siebel Application Integration................................................................................................ 2-4

s q u tude
Peer Application Integration..................................................................................................................... 2-5

cva this S
Consumer of Services ............................................................................................................................. 2-6
( f
Alternate User Interfaces (UIs) ................................................................................................................ 2-7

e da use
Alternate User Interface: Examples.......................................................................................................... 2-8

sta se to
Siebel Application Integration Choices ..................................................................................................... 2-9
a
Data-Layer Integration............................................................................................................................. 2-10
C cen
e z
u le li
Business-Layer Integration ...................................................................................................................... 2-11

s q
Siebel Enterprise Application Integration (EAI) ......................................................................................... 2-12
V ferab
Closely Coupled Integrations ................................................................................................................... 2-13
e
l ip rans
Loosely Coupled Integrations .................................................................................................................. 2-14
e
F n-t
UI-Layer Integration ................................................................................................................................ 2-15

no
UI Integration: Example ........................................................................................................................... 2-16
Common Steps in Implementing Integration ............................................................................................. 2-17
Overview of This Course ......................................................................................................................... 2-18
Lesson Highlights.................................................................................................................................... 2-19
Overview of Integration Workflows .......................................................................................................... 3-1
Overview of Integration Workflows........................................................................................................... 3-2
Objectives............................................................................................................................................... 3-3
Data Exchange ....................................................................................................................................... 3-4
Data Exchange Scenarios ....................................................................................................................... 3-5
Siebel Send ............................................................................................................................................ 3-6
Siebel Send/Receive ............................................................................................................................... 3-7
Siebel Receive ........................................................................................................................................ 3-8
Siebel Receive/Respond ......................................................................................................................... 3-9
Integration Processing for Send............................................................................................................... 3-10
Integration Processing for Receive .......................................................................................................... 3-11
Transporting Data in Integration Workflows .............................................................................................. 3-12
Types of Transports ................................................................................................................................ 3-13
Additional Integration Processing............................................................................................................. 3-14
Copyright 2011, Oracle and/or its affiliates. All rights reserved.

Siebel 8.1.x Integration Table of Contents


i
Prebuilt EAI Business Services................................................................................................................ 3-15
Example of a Siebel Integration Workflow ................................................................................................ 3-16
Review: XML (Extensible Markup Language) ........................................................................................... 3-17
XML Documents: Review ........................................................................................................................ 3-18
XML Schema Definition (XSD): Review.................................................................................................... 3-19
XML Namespaces: Review...................................................................................................................... 3-20
Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

Using XML Namespaces Review ............................................................................................................. 3-21


Lesson Highlights.................................................................................................................................... 3-22
Practice 3 Overview: Overview of Integration Workflows.......................................................................... 3-23
Integration Objects ................................................................................................................................... 4-1
Integration Objects .................................................................................................................................. 4-2
Objectives............................................................................................................................................... 4-3
Integration Objects .................................................................................................................................. 4-4
Integration Object.................................................................................................................................... 4-5
Types of Integration Objects .................................................................................................................... 4-6
Internal Integration Object ....................................................................................................................... 4-7
s a
a
External Integration Object ...................................................................................................................... 4-8
h
c l)
Integration Components (ICs) .................................................................................................................. 4-9
l
nte uide
Integration Component Key ..................................................................................................................... 4-11
e
e z @ nt G
Status Key .............................................................................................................................................. 4-12

s q u tude
Creating an Internal Integration Object..................................................................................................... 4-13
1. Identify the Siebel Data to be Exchanged ............................................................................................. 4-14

f cva this S
2. Create the Integration Object ............................................................................................................... 4-15
(
e da use
2. Specify the Business Object ................................................................................................................ 4-16
3. Select the Integration Components ...................................................................................................... 4-17

a sta se to
3. Review messages ............................................................................................................................... 4-18
z C cen
3. Select the Integration Components: Wizard Action .............................................................................. 4-19

q e
u le li
4. Inactivate Unneeded Integration Component Fields.............................................................................. 4-20
s
V ferab
5. Inactivate Unneeded Integration Component Keys ............................................................................... 4-21
e
e l ip rans
Deploying New and Modified Integration Objects...................................................................................... 4-22
F n-t
Directly Deploying an Integration Object .................................................................................................. 4-23

no
Refreshing the Run-Time Database ......................................................................................................... 4-24
Synchronizing Integration Objects ........................................................................................................... 4-25
Creating an External Integration Object.................................................................................................... 4-26
1. Obtain a Schema of the External Data ................................................................................................. 4-27
2. Create the External Integration Object ................................................................................................. 4-28
2. Create the External Integration Object: Specify the Root Level Node ................................................... 4-29
3. Select Integration Components ............................................................................................................ 4-30
4. Verify the Integration Object ................................................................................................................ 4-31
Lesson Highlights.................................................................................................................................... 4-32
Practice 4 Overview: Integration Objects................................................................................................. 4-33
EAI Siebel Adapter .................................................................................................................................... 5-1
EAI Siebel Adapter .................................................................................................................................. 5-2
Objectives............................................................................................................................................... 5-3
EAI Business Services ............................................................................................................................ 5-4
Property Sets and Business Services ...................................................................................................... 5-5
Property Set............................................................................................................................................ 5-6
Hierarchical Data Structures .................................................................................................................... 5-7
Property Set for Hierarchical Data ........................................................................................................... 5-8
Copyright 2011, Oracle and/or its affiliates. All rights reserved.

Siebel 8.1.x Integration Table of Contents


ii
EAI Siebel Adapter .................................................................................................................................. 5-9
Using the EAI Siebel Adapter to Read Siebel Data ................................................................................... 5-10
Integration Object Instance...................................................................................................................... 5-11
Using the EAI Siebel Adapter to Write Siebel Data ................................................................................... 5-12
EAI Siebel Adapter Methods.................................................................................................................... 5-13
Query Method ......................................................................................................................................... 5-14
Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

QueryPage Method ................................................................................................................................. 5-16


Synchronize Method ............................................................................................................................... 5-17
Insert Method.......................................................................................................................................... 5-19
Update Method ....................................................................................................................................... 5-20
Upsert Method ........................................................................................................................................ 5-21
Delete Method ........................................................................................................................................ 5-23
Execute Method ...................................................................................................................................... 5-24
Business Object Layer Considerations..................................................................................................... 5-25
Transaction-Based Processing ................................................................................................................ 5-26
Lesson Highlights.................................................................................................................................... 5-27
s a
Practice 5 Overview: EAI Siebel Adapter................................................................................................. 5-28
) h 6-1a
c l
Data Conversion .......................................................................................................................................

t el ide 6-2
Data Conversion .....................................................................................................................................
n
e G u 6-3
Objectives...............................................................................................................................................
@
ez den t
Processing Integration Object Instances .................................................................................................. 6-4
s q u tu
EAI XML Converter ................................................................................................................................. 6-5
v a S
a (fc e this
Siebel XML ............................................................................................................................................. 6-6

e d
EAI XML Converter Methods ...................................................................................................................
s 6-8

s t a e to u
IntObjHierToXMLDoc Method.................................................................................................................. 6-9

C a ns
XMLDocToIntObjHier Method.................................................................................................................. 6-10

e z l i c e
XML Hierarchy Converter ........................................................................................................................ 6-11

squ.......................................................................................................................
b l e
XML Converter........................................................................................................................................

ra Service ................................................................................................ 6-14


6-12

e VService fBusiness
Character Set Conversion
e
6-13

elip -tran
The Transcode s
F
Attachments............................................................................................................................................
n
6-15

no
Handling Attachments .............................................................................................................................
Embedded Attachments .......................................................................................................................... 6-17
6-16

MIME...................................................................................................................................................... 6-18
MIME: Example ...................................................................................................................................... 6-19
Writing XML Strings to Files .................................................................................................................... 6-20
EAI File Transport ................................................................................................................................... 6-21
EAI XML Write to File .............................................................................................................................. 6-22
EAI XML Read from File.......................................................................................................................... 6-23
Lesson Highlights.................................................................................................................................... 6-24
Practice 6 Overview: Data Conversion .................................................................................................... 6-25
Integration Workflows .............................................................................................................................. 7-1
Integration Workflows.............................................................................................................................. 7-2
Objectives............................................................................................................................................... 7-3
Integration Workflow ............................................................................................................................... 7-4
Integration Workflows.............................................................................................................................. 7-5
Process Properties.................................................................................................................................. 7-6
Process Property Types .......................................................................................................................... 7-7
Inputs to Business Services..................................................................................................................... 7-8
Copyright 2011, Oracle and/or its affiliates. All rights reserved.

Siebel 8.1.x Integration Table of Contents


iii
Outputs of Business Services .................................................................................................................. 7-9
Building an Integration Workflow.............................................................................................................. 7-10
1. Define the Workflow Processing .......................................................................................................... 7-11
2. Create the Workflow Process............................................................................................................... 7-12
3. Add Steps to the Workflow Process ..................................................................................................... 7-13
4. Add Workflow Process Properties ........................................................................................................ 7-14
Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

5. Configure the Inputs and Outputs ........................................................................................................ 7-15


6. Test the Workflow ............................................................................................................................... 7-16
Invoking a Workflow ................................................................................................................................ 7-18
Workflow Policy ...................................................................................................................................... 7-19
Run-Time Event ...................................................................................................................................... 7-20
Declarative Call....................................................................................................................................... 7-21
Scripting ................................................................................................................................................. 7-22
Considerations for Invoking Workflow ...................................................................................................... 7-23
Lesson Highlights.................................................................................................................................... 7-24
Practice 7 Overview: Integration Workflows............................................................................................. 7-25
s a
a
EAI HTTP Transport .................................................................................................................................. 8-1
h
c l)
EAI HTTP Transport................................................................................................................................ 8-2
l
nte uide
Objectives............................................................................................................................................... 8-3
e
e z @ nt G
Using HTTP Transport ............................................................................................................................ 8-4

s q u tude
Fundamentals of HTTP Transport: Review............................................................................................... 8-5
Communication Modes Review............................................................................................................... 8-6

f cva this S
Data Transmission: Review .................................................................................................................... 8-7
(
e da use
Siebel Architecture for HTTP Transport.................................................................................................... 8-8
Sending (Siebel Application as the Client) ................................................................................................ 8-9

a sta se to
Configuring Outbound HTTP Transport .................................................................................................... 8-10
z C cen
1. Add the HTTP Transport Step.............................................................................................................. 8-11

q e
u le li
2. Assign Inputs and Outputs................................................................................................................... 8-12
s
V ferab
3. Assign Request Methods and URLs: Sessionless................................................................................. 8-13
e
e l ip rans
3. Assign Request Methods and URLs: Session Mode ............................................................................. 8-14
F n-t
Receiving (Siebel Application as the Server) ............................................................................................ 8-15

no
Processing Incoming HTTP Requests...................................................................................................... 8-16
Profile Configurations for HTTP Services ................................................................................................. 8-17
Profile Configurations for HTTP Service: Parameters ............................................................................... 8-18
URLs for Siebel EAI Object Manager ....................................................................................................... 8-19
Configuring a New HTTP Service ............................................................................................................ 8-20
1. Identify the Workflow or Business Service ............................................................................................ 8-21
2. Create the Profile Configuration ........................................................................................................... 8-22
3. Assign the Parameters ........................................................................................................................ 8-23
4. Modify the eai.cfg File.......................................................................................................................... 8-24
Lesson Highlights.................................................................................................................................... 8-25
Practice 8 Overview: EAI HTTP Transport .............................................................................................. 8-26
EAI Message Queue Transport ................................................................................................................. 9-1
EAI Message Queue Transport ............................................................................................................... 9-2
Objectives............................................................................................................................................... 9-3
Message Queues .................................................................................................................................... 9-4
Benefits of Message Queues ................................................................................................................... 9-5
Properties of Message Queues ............................................................................................................... 9-6
How Siebel CRM Supports Message Queues .......................................................................................... 9-7
Copyright 2011, Oracle and/or its affiliates. All rights reserved.

Siebel 8.1.x Integration Table of Contents


iv
Example: Order Management .................................................................................................................. 9-8
Siebel-Supported Messaging Systems..................................................................................................... 9-9
Siebel Messaging Transports .................................................................................................................. 9-10
Sending Messages ................................................................................................................................. 9-12
Configure Outbound Transport ................................................................................................................ 9-13
1. Create a Transport Connection Subsystem Profile ............................................................................... 9-14
Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

2. Add an EAI Transport Business Service Step to an Integration Workflow .............................................. 9-15
3. Add Process Properties ....................................................................................................................... 9-16
4. Add Input and Output Arguments ......................................................................................................... 9-17
Receiving Messages: Direct Reads ......................................................................................................... 9-18
Receiving Messages: Receiver Tasks...................................................................................................... 9-19
Receiving Messages: Receiver Components and Methods....................................................................... 9-20
Receiving Messages: Transport Data Handling Subsystems .................................................................... 9-21
Available Dispatch Targets ...................................................................................................................... 9-22
Configure Inbound Transport ................................................................................................................... 9-23
1. Create Profiles .................................................................................................................................... 9-24
s a
2. Create a Workflow or Business Service to Process the Message .......................................................... 9-25
)h a
c l
3. Start a Receiver Task .......................................................................................................................... 9-26

t el ide
Summary: Siebel CRM Messaging System Support ................................................................................. 9-27
n
e
Additional Configuration: Java Support in Siebel CRM.............................................................................. 9-28
@ G u
ez den t
The JVMSubsys Profile ........................................................................................................................... 9-29

s q u tu
The jndi.properties File............................................................................................................................ 9-30
v a S
(fc e this
Lesson Highlights.................................................................................................................................... 9-31
a
Practice 9 Overview: Using JMS Message Queues ................................................................................. 9-32
ed o us
t a
Data Mapping ............................................................................................................................................
t 10-1
s
a nse
Data Mapping ......................................................................................................................................... 10-2
z C e
Objectives...............................................................................................................................................
c 10-3
e l i
Choices for Data squ.......................................................................................................................
b l e
Data Mapping .........................................................................................................................................

ra ............................................................................................................. 10-6
10-4

e V feEngine
Mapping 10-5

eMap
Transformation
an s
lip................................................................................................................................................
EAI Data
F
Data
n - t r 10-7

no
Data Map Components ...........................................................................................................................
Data Map Components: Example ............................................................................................................ 10-9
10-8

Data Map Editor ...................................................................................................................................... 10-10


Conditional Mapping ............................................................................................................................... 10-11
Creating a Data Map ............................................................................................................................... 10-12
1. Create an Integration Object Map ........................................................................................................ 10-13
2. Auto-Map the Components .................................................................................................................. 10-14
3. Create Integration Component Maps.................................................................................................... 10-15
4. Create Integration Field Maps.............................................................................................................. 10-16
5. Validate the Map ................................................................................................................................. 10-17
Purging the Cache .................................................................................................................................. 10-18
Using a Data Map ................................................................................................................................... 10-19
EAI Value Maps ...................................................................................................................................... 10-20
Using EAI Value Maps ............................................................................................................................ 10-21
Custom Mapping..................................................................................................................................... 10-22
Lesson Highlights.................................................................................................................................... 10-23
Practice 10 Overview: Data Mapping ...................................................................................................... 10-24
The EAI Dispatch Service ......................................................................................................................... 11-1
Copyright 2011, Oracle and/or its affiliates. All rights reserved.

Siebel 8.1.x Integration Table of Contents


v
The EAI Dispatch Service........................................................................................................................ 11-2
Objectives............................................................................................................................................... 11-3
EAI Dispatch Service .............................................................................................................................. 11-4
EAI Dispatch Service Methods ................................................................................................................ 11-5
Modifying Messages ............................................................................................................................... 11-6
Rules ...................................................................................................................................................... 11-7
Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

Search Expression Notation for Rules...................................................................................................... 11-8


Structure of Rules ................................................................................................................................... 11-9
Rule Set ................................................................................................................................................. 11-10
Rule ....................................................................................................................................................... 11-11
Transform ............................................................................................................................................... 11-12
Benefits of the EAI Dispatch Service........................................................................................................ 11-14
Creating a Dispatch Rule Set .................................................................................................................. 11-15
1. Create the Rule Set ............................................................................................................................. 11-16
2. Create the Rule ................................................................................................................................... 11-17
3. Create the Transforms......................................................................................................................... 11-18
s a
4. Update Run-Time Memory................................................................................................................... 11-19
)h a
c l
5. Test the Rule Set ................................................................................................................................ 11-20

t el ide
Using a Dispatch Rule Set ....................................................................................................................... 11-21
n
e u
Outbound Processing: Overview of Steps ................................................................................................ 11-22
@ G
ez den t
Inbound Processing: Overview of Steps ................................................................................................... 11-24

s q u tu
Lesson Highlights.................................................................................................................................... 11-26
v a S
(fc e this
Practice 11 Overview: The EAI Dispatch Service..................................................................................... 11-27

e d a
Using Siebel Inbound Web Services ........................................................................................................
s 12-1

s t a e to u
Using Siebel Inbound Web Services ........................................................................................................ 12-2

Ca cens
Objectives............................................................................................................................................... 12-3

e z
Web Services .........................................................................................................................................
l i 12-4

squ r....................................................................................................................
Standards for Web Services
a b l e 12-5

e VExamplefe........................................................................................................................
SOAP Message ...................................................................................................................................... 12-6

l i p
SOAP Message
n s 12-7
FeServices
Web
n - ra Language (WSDL) Document.......................................................................... 12-8
tinDescription
no Siebel Applications ........................................................................................................ 12-9
Web Services
Structure of Siebel Web Services ............................................................................................................ 12-10
Service ................................................................................................................................................... 12-11
Service Ports .......................................................................................................................................... 12-12
Operations .............................................................................................................................................. 12-13
Working with Siebel Inbound Web Services ............................................................................................. 12-14
Administering Inbound Web Services....................................................................................................... 12-15
Completing the Service Address .............................................................................................................. 12-16
Generating the WSDL Document............................................................................................................. 12-18
Invoking Inbound Web Services............................................................................................................... 12-20
Prebuilt Integration Using Web Services .................................................................................................. 12-22
Lesson Highlights.................................................................................................................................... 12-23
Practice 12 Overview: Using Siebel Inbound Web Services ..................................................................... 12-24
Configuring Siebel Inbound Web Services .............................................................................................. 13-1
Configuring Siebel Inbound Web Services ............................................................................................... 13-2
Objectives............................................................................................................................................... 13-3
Inbound Web Service Architecture........................................................................................................... 13-4
Inbound Web Services: Service Ports ...................................................................................................... 13-5
Copyright 2011, Oracle and/or its affiliates. All rights reserved.

Siebel 8.1.x Integration Table of Contents


vi
Inbound Web Services: Operations.......................................................................................................... 13-6
Execution of an Inbound Web Service ..................................................................................................... 13-7
Web Service Inbound Dispatcher............................................................................................................. 13-8
Publishing a Siebel Inbound Web Service ................................................................................................ 13-9
1. Create the Web Service Definition ....................................................................................................... 13-10
2. Create a Service Port .......................................................................................................................... 13-11
Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

2. Create a Service Port: Binding ............................................................................................................. 13-12


3. Publish the Operations ........................................................................................................................ 13-13
4. Generate the WSDL File...................................................................................................................... 13-14
Transports for Web Services ................................................................................................................... 13-16
Publishing from Siebel Tools ................................................................................................................... 13-17
Default Web Service Security .................................................................................................................. 13-18
Enhancing Security ................................................................................................................................. 13-19
Sessions................................................................................................................................................. 13-20
Sessionless" Sessions ............................................................................................................................ 13-21
Stateless Sessions.................................................................................................................................. 13-22
s a
a
Stateful Sessions .................................................................................................................................... 13-23
)h
c l
Configure Siebel Inbound Web Sessions ................................................................................................. 13-24

t el ide
Web Service Security .............................................................................................................................. 13-26
n
e
Implementing WS-Security for Inbound Web Services .............................................................................. 13-27
@ G u
ez den t
Implementing HTTPS .............................................................................................................................. 13-30

s q u tu
Lesson Highlights.................................................................................................................................... 13-31
v a S
(fc e this
Practice 13 Overview: Siebel Inbound Web Services ............................................................................... 13-32

e d a
Siebel Outbound Web Services ................................................................................................................
s 14-1

s t a e to u
Siebel Outbound Web Services ............................................................................................................... 14-2

C a ns
Objectives............................................................................................................................................... 14-3

e z l i c e
Outbound Web Services.......................................................................................................................... 14-4
u le........................................................................................................ 14-5
sqSpecification
Outbound Web Service Architecture
Outbound Web Service
e

f e rab ....................................................................................................... 14-6
VService...........................................................................................................................
l i p
Proxy Business
n s 14-7
Fe Business
Proxy
n - a Arguments ......................................................................................................... 14-8
trService
no
Proxy Business Service Class ................................................................................................................. 14-9
Creating an Outbound Web Service......................................................................................................... 14-10
1. Create the Proxy Business Service ...................................................................................................... 14-11
2. Import the WSDL File .......................................................................................................................... 14-12
3. Inspect the Objects Created: Business Service .................................................................................... 14-13
3. Inspect the Objects Created: Business Service Arguments ................................................................... 14-14
3. Inspect the Objects Created: Integration Objects .................................................................................. 14-15
3. Inspect the Objects Created: Business Service User Properties ............................................................ 14-16
4. Compile the Objects Created ............................................................................................................... 14-17
5. Create the Outbound Web Service....................................................................................................... 14-18
Invoking a Proxy Business Service .......................................................................................................... 14-19
Options for Mapping to/from the Integration Objects ................................................................................. 14-20
Implementing Session-Based Security ..................................................................................................... 14-21
Lesson Highlights.................................................................................................................................... 14-22
Practice 14 Overview: Siebel Outbound Web Services ............................................................................ 14-23
Overview of Data Federation .................................................................................................................... 15-1
Overview of Data Federation ................................................................................................................... 15-2
Objectives............................................................................................................................................... 15-3
Copyright 2011, Oracle and/or its affiliates. All rights reserved.

Siebel 8.1.x Integration Table of Contents


vii
Data Federation ...................................................................................................................................... 15-4
Advantages of Data Federation ............................................................................................................... 15-5
Data Federation ...................................................................................................................................... 15-6
Siebel External Table .............................................................................................................................. 15-7
External Business Component (EBC) ...................................................................................................... 15-8
Distributed Join ....................................................................................................................................... 15-9
Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

Virtual Business Component (VBC) ......................................................................................................... 15-10


Business Component Behavior................................................................................................................ 15-11
Limitations of EBCs and VBCs ................................................................................................................ 15-12
Additional Limitations .............................................................................................................................. 15-13
Lesson Highlights.................................................................................................................................... 15-14
Practice 15 Overview: Overview of Data Federation ................................................................................ 15-15
External Business Components ............................................................................................................... 16-1
External Business Components ............................................................................................................... 16-2
Objectives............................................................................................................................................... 16-3
External Business Component................................................................................................................. 16-4
s a
a
Structure of an External Business Component ......................................................................................... 16-5
h
c l)
System Fields ......................................................................................................................................... 16-6
l
nte uide
Data Source Property.............................................................................................................................. 16-7
e
e z @ nt G
DataSource ............................................................................................................................................ 16-8

s q u tude
Creating an External Business Component .............................................................................................. 16-9
1. Create an ODBC Connection............................................................................................................... 16-10

f cva this S
2. Generate a Schema File for the External Table .................................................................................... 16-11
(
e da use
3. Create the Table Object in the Siebel Repository.................................................................................. 16-12
3. Examine the Table and Columns Created ............................................................................................ 16-13

a sta se to
4. Map System Fields as Required .......................................................................................................... 16-14
z C cen
5. Specify the Data Source ...................................................................................................................... 16-15

q e
u le li
6. Create the External Business Component ............................................................................................ 16-16
s
V ferab
7. Identify the Data Source in the Application ........................................................................................... 16-17
e
e l ip rans
Using an External Business Component .................................................................................................. 16-20
F n-t
Distributed Join ....................................................................................................................................... 16-21

no
Considerations........................................................................................................................................ 16-22
Lesson Highlights.................................................................................................................................... 16-23
Practice 16 Overview: External Business Components ............................................................................ 16-24
Virtual Business Components .................................................................................................................. 17-1
Virtual Business Components.................................................................................................................. 17-2
Objectives............................................................................................................................................... 17-3
Virtual Business Component (VBC) ......................................................................................................... 17-4
Data Access and Manipulation ................................................................................................................ 17-5
Required Methods................................................................................................................................... 17-6
Optional Methods.................................................................................................................................... 17-7
Business Services................................................................................................................................... 17-8
XML Gateway Business Service .............................................................................................................. 17-9
Custom Business Service........................................................................................................................ 17-10
Custom Business Service Considerations ................................................................................................ 17-11
Creating a Virtual Business Component ................................................................................................... 17-12
1. Create a Business Component ............................................................................................................ 17-13
2. Create Fields for the VBC .................................................................................................................... 17-14
3. Create the Custom Business Service if Necessary ............................................................................... 17-15
Copyright 2011, Oracle and/or its affiliates. All rights reserved.

Siebel 8.1.x Integration Table of Contents


viii
4. Associate the Business Service with the VBC ...................................................................................... 17-16
5. Implement the Methods (Custom Service) ............................................................................................ 17-18
5. Configure the Target (XML Gateway) ................................................................................................... 17-19
Using a Virtual Business Component ....................................................................................................... 17-20
Restrictions on Virtual Business Components .......................................................................................... 17-21
Lesson Highlights.................................................................................................................................... 17-22
Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

Practice 17 Overview: Virtual Business Components............................................................................... 17-23


Embedding Web Content in a Siebel View ............................................................................................... 18-1
Embedding Web Content in a Siebel View ............................................................................................... 18-2
Objectives............................................................................................................................................... 18-3
Displaying External Web Content ............................................................................................................ 18-4
Aggregate View ...................................................................................................................................... 18-5
Detail View ............................................................................................................................................. 18-6
Key Concepts ......................................................................................................................................... 18-7
Symbolic URL ......................................................................................................................................... 18-8
Business Component Field...................................................................................................................... 18-9
s a
a
Specialized Applet .................................................................................................................................. 18-10
h
c l)
Display External Web Content in a Siebel Application .............................................................................. 18-11
l
nte uide
Display External Web Content in a Siebel Application (Real-Time Quotes)................................................ 18-12
e
e z @ nt G
1. Determine the Required URL............................................................................................................... 18-13

s q u tude
2. Add a Field to the Business Component............................................................................................... 18-14
3. Create the Applet ................................................................................................................................ 18-15

f cva this S
3. Assign a Web Template ...................................................................................................................... 18-16
(
e da use
3. Map the Field ...................................................................................................................................... 18-17
3. Delete the Controls ............................................................................................................................. 18-18

a sta se to
3. Adjust the Applet Class ....................................................................................................................... 18-19
z C cen
3. Modify the Default List Column Configuration ....................................................................................... 18-20

q e
u le li
4. Create the View .................................................................................................................................. 18-21
s
V ferab
5. Add the View to the Screen ................................................................................................................. 18-22
e
e l ip rans
6. Complete the Configuration ................................................................................................................. 18-23
F n-t
7. Administer the Symbolic URL .............................................................................................................. 18-24

no
Test the Configuration ............................................................................................................................. 18-26
Considerations........................................................................................................................................ 18-29
Symbolic URLs in the Dedicated Web Client ............................................................................................ 18-30
Host Aliases............................................................................................................................................ 18-31
Lesson Highlights.................................................................................................................................... 18-32
Practice 18 Overview: Embedding Web Content in a Siebel View ............................................................ 18-33
Embedding Siebel Content in an External Application ............................................................................ 19-1
Embedding Siebel Content in an External Application .............................................................................. 19-2
Objectives............................................................................................................................................... 19-3
Options for Embedding Siebel Content in External Applications ................................................................ 19-4
Review: Rendering a Siebel Web Application ........................................................................................... 19-5
The Siebel Web Engine XML Web Interface............................................................................................. 19-6
Architecture: Application Request ............................................................................................................ 19-7
Architecture: Siebel CRM Response ........................................................................................................ 19-8
Invoking the XML Web Interface .............................................................................................................. 19-9
Customize the AOM ................................................................................................................................ 19-10
Example: Siebel Sales Wireless .............................................................................................................. 19-11
Add Commands to the URL ..................................................................................................................... 19-12
Copyright 2011, Oracle and/or its affiliates. All rights reserved.

Siebel 8.1.x Integration Table of Contents


ix
Example 1: Raw XML.............................................................................................................................. 19-14
Example 2: Apply a Stylesheet ................................................................................................................ 19-15
Example 3: Programmatic Access ........................................................................................................... 19-16
Example 3: Result ................................................................................................................................... 19-18
Add an XML Request to the Body of an HTTP POST Command............................................................... 19-19
XML Interface vs. Web Services .............................................................................................................. 19-20
Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

Lesson Highlights.................................................................................................................................... 19-21


Practice 19 Overview: Exploring the XML Interface ................................................................................. 19-22
Siebel Workflow Appendix ....................................................................................................................... 20-1
Siebel Workflow Appendix ....................................................................................................................... 20-2
Objectives............................................................................................................................................... 20-3
Workflow Process ................................................................................................................................... 20-4
Basic Workflow Process Steps ................................................................................................................ 20-5
Process Properties.................................................................................................................................. 20-6
Creating a Workflow Process................................................................................................................... 20-7
Create a Workflow Process Definition ...................................................................................................... 20-8
s a
a
Start the Designer ................................................................................................................................... 20-9
h
c l)
Create the Steps ..................................................................................................................................... 20-10
l
nte uide
Connect the Steps .................................................................................................................................. 20-11
e
e z @ nt G
Set Property Values ................................................................................................................................ 20-12

s q u tude
Multi Value Property Window (MVPW) ..................................................................................................... 20-13
Set Input and Output Arguments.............................................................................................................. 20-14

f cva this S
Testing a Workflow Process .................................................................................................................... 20-15
(
e da use
Set Property Values ................................................................................................................................ 20-16
Start the Simulator .................................................................................................................................. 20-17

a sta se to
Start the Simulation................................................................................................................................. 20-18
z C cen
Run the Simulation.................................................................................................................................. 20-19

q e
u le li
Watch Window........................................................................................................................................ 20-20
s
V ferab
Verify the Result ..................................................................................................................................... 20-21
e
e l ip rans
Deploying a Workflow Process ................................................................................................................ 20-22
F n-t
Publish the Workflow............................................................................................................................... 20-23

no
Activate the Workflow.............................................................................................................................. 20-24
Publish and Activate Workflow................................................................................................................. 20-25
Lesson Highlights.................................................................................................................................... 20-26

Copyright 2011, Oracle and/or its affiliates. All rights reserved.

Siebel 8.1.x Integration Table of Contents


x
Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

s a
h a
l c l)
e nte uide
The EAI Dispatchz @ nService
t G
q e
u tude
s
( f cva this S
Chapter 11

e da use
a sta se to
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

The EAI Dispatch Service


Chapter 11 - Page 1
The EAI Dispatch Service
Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

The EAI Dispatch Service

s a
h a
l c l)
e nte uide
e z @ nt G
s q u tude
( f cva this S
e da use
a sta se to
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

The EAI Dispatch Service


Chapter 11 - Page 2
Objectives

Objectives
Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

After completing this lesson, you should be able to:


Describe the purpose and architecture of the EAI Dispatch
Service
Create a set of dispatch rules

s a
h a
l c l)
e nte uide
e z @ nt G
s q u tude
( f cva this S
e da use
a sta se to
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

The EAI Dispatch Service


Chapter 11 - Page 3
EAI Dispatch Service

EAI Dispatch Service


Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

Is an EAI business service that invokes other business


services or workflows based on the properties of the input
property set
Is driven by a set of customer-configurable rules
Is used in both inbound and outbound integration
workflows to route messages based on their content:
tos
Example: route incoming message from multiple suppliersa a
h
the corresponding workflow cl) el ide
Message 1
e n t u
(Supplier 1)
@ t G
q u ezWorkflow
d e n Supplier 1
for
EAI Dispatch
Service v a s S tu
Message 2
a (fc e this
(Supplier 2)
a ed o us
a st se t Workflow for Supplier 2

z C cen
q e
u le li
Reference:V
s
eand
Creating rabUsing Dispatch Rules in Business Processes and Rules: Siebel
l e
ip Application
Enterprise n f
s Integration
e
F n-t r a
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

The EAI Dispatch Service


Chapter 11 - Page 4
EAI Dispatch Service Methods

EAI Dispatch Service Methods


Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

Execute:
Examines the incoming message
Dispatches the message according to the rules
Is used in production systems
Lookup
Evaluates the incoming message a
a s
Does not dispatch the message
c l )h
Is used for testing
n t el ide
Process Aggregate Request @ e G u
einz business
e t
n services
Allows multiple invocations of methods
s q u tu d
in a single request v a S
Formats the output into a
a
(fc emessage
single t his
a ed o us
a st se t
z C cen
q e
u le li
s raisbdefined in the repository but is tagged as hidden. In previous
V (Purge)
A fourth method
e f e
l ip it was
releases
e a n s to update the run-time cache of dispatch rules. It has been superseded
used
by
n r
F the addition
-t in the Siebel client of a Clear Cache button.
n o

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

The EAI Dispatch Service


Chapter 11 - Page 5
Modifying Messages

Modifying Messages
Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

The EAI Dispatch service can also modify the property set
before the target service is invoked
Examples:
Can manipulate the message hierarchy
Example: remove a top-level message envelope and dispatch
the remaining child hierarchy
Can add or modify a property value in the root node of the as a
h
output hierarchy
el ide cl)

e t
Example: add the name of a workflow to be executed
n u
@ t G
q u ez den
v a s S tu
a (fc e this
a ed o us
a st se t
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

The EAI Dispatch Service


Chapter 11 - Page 6
Rules

Rules
Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

Are used by the EAI Dispatch Service to process messages


Are created and administered in the Siebel client
Consist of:
One or more conditions used to evaluate an incoming
property set
A target business service to execute when a condition is
satisfied s a
) h a
lclset
Zero, one, or more transforms to apply to the property
e e
nt based
Are expressed using a search expression notation
e u id
on traversing a hierarchical structure ez@ ent
G
s q u tud
( f cva this S
e da use
a sta se to
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

The EAI Dispatch Service


Chapter 11 - Page 7
Search Expression Notation for Rules

Search Expression Notation for Rules


Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

Uses an XPATH-like notation to examine contents of the


property set
Includes several symbols to specify navigation to a desired
component in the property set hierarchy :
/ : refers to a level in the hierarchy
@ : refers to an attribute

s a
/aaa Select the root element aaa a
)h
l c l
/*/bbb nte uide
Select the child element bbb of the rooteelement
e z @ nt G
q e second
u bbbtuatdthe
/*/bbb@aa s
Select the aa attribute of element
level of the hierarchy
( f cva this S
e da useattribute of the child element
/*/SiebelMessage Select the IntObjectName
@IntObjectName SiebelMessage
a sta se oftothe root element
z C cen
q e
u le li
Examples: V
s rab
e
ip means f e
sto select the root element aaa
l/aaa n
e
F /*/bbb r a
-tmeans to select the child element bbb of the root element
o n
n/*/bbb@aa means to select the aa attribute of the element bbb at the second level of the
hierarchy
/*/SiebelMessage@IntObjectName means to select the IntObjectName attribute of the
child element SiebelMessage of the root element.

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

The EAI Dispatch Service


Chapter 11 - Page 8
Structure of Rules

Structure of Rules
Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

Rule Set
Rule
Transform

Rule Sets

s a
h a
l c l)
nte uide
Rules
e
@ nt G
e z
u tude
s q
( f cva this S
Transforms

e da use More

a sta se to
z C cen
q e
u le li
s ab rules which may contain many transforms.
Vcontain
Rule Sets may
e f e rmany
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

The EAI Dispatch Service


Chapter 11 - Page 9
Rule Set

Rule Set
Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

Is a collection of rules to be evaluated in a specified


sequence
Rules are evaluated in sequence
First rule that satisfies is applied and rule evaluation stops
Is specified as an input argument to the EAI Dispatch
Service
s a
h a
l c l)
e nte uide
e z @ nt G
s q u tude
( f cva this S
e da use
a sta se to
z C cen
q e
u le li
s
erab- Integration > EAI Dispatch Service View.
Navigate to V
Administration
l i p e n s f
Fe n-tra
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

The EAI Dispatch Service


Chapter 11 - Page 10
Rule

Rule
Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

Examines an input property set


Message to be dispatched must be a property set
May require a conversion step
Specifies:
An expression that evaluates incoming property sets
An optional property value used when then expression refers
s a
to an attribute
h a
c
A business service and method to execute if the property
l l) set
e e
satisfies the expression ent @ nt G uid
e z
u tude
s q
( f cva this S
Evaluate incoming e difaattributeuhas
Check se Service and method to
property set
a sta sthis
e to
value executed if rule is satisfied

z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

The EAI Dispatch Service


Chapter 11 - Page 11
Transform

Transform
Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

Is an optional expression that modifies the structure or


content of a property set before dispatching it
Is a child record of a rule
References a target (the part of the message to be
modified)
Important transform target types:
s a
Root Hierarchy
h a
Used to remove envelope from message

l c l)
Property

e nte uide

z @with the
Creates or changes a property in the root node
n t G
name
e
u tude
Property Name and the value of the Source
q Expression
s
( f cva this S
e da use
a sta se to
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

The EAI Dispatch Service


Chapter 11 - Page 12
Transform

Transform
Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

Is used to:
Pass the existing hierarchy as is or modify it
Example: remove a message envelope when required
Set business service arguments
Set input arguments for a generic workflow

s a
a
)h
c l
n t el ide
@ e G u
ez den t
s q u tu
v a S
Passes the original
a (fcProcess
Adds a property
e t his
message hierarchy Name
d sets itsuvalue
eand s to
to the target service a
st se t
Process o
External Contacts
a
C cen
e z
u le li
s q
In the example
e Vdisplayedf e rainbthe screenshot in the slide, the rule examines the incoming
property
e l ip set a n s the value of the IntObjectName attribute of the SiebelMessage
to determine
F n-t
element. If r
the value is ExtContact, the dispatch service then invokes the Workflow Process
no business service.
Manager
The transforms specify what is passed to the target business service. The root transform (/*)
specifies that the message is passed as is without any modification to the hierarchy. The
property transform specifies that a new property is added to the top level of the property set.
In this case a property with name "Process name" and value "Process External Contacts" is
added. This property is treated by the Workflow Process manager as an argument that
specifies the name of the workflow to be executed.

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

The EAI Dispatch Service


Chapter 11 - Page 13
Benefits of the EAI Dispatch Service

Benefits of the EAI Dispatch Service


Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

The dispatch service uses conditional processing to


implement business policy
Conditional processing is more general than that in workflow
Based on the entire message while workflow can branch only on
the values of business component fields
Is better designed for choosing among multiple targets
Can reduces the number of individual workflows that must be s a
developed to handle a set of incoming messages h a
l c l)
Allows for reuse of business logic in workflows te
e n u ide
@ G
Use dispatch service as a branch after executing common logic
t
ez debusiness
n

The dispatch service (like workflow) s q u


expresses
tu
v a S
logic declaratively
a (fc e this
Easier to develop and
a edmaintain
o u s than custom script
a st se t
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

The EAI Dispatch Service


Chapter 11 - Page 14
Creating a Dispatch Rule Set

Creating a Dispatch Rule Set


Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

1. Create the rule set


2. Create the rules
3. Create the transforms
4. Update run-time memory
5. Test the rule set
s a
Example: Create a rule set to dispatch an outbound Siebel h a
l c l)
message based on the integration object
e nte uide
e z @ nt G
s q u tude
( f cva this S
e da use More

a sta se to
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

The EAI Dispatch Service


Chapter 11 - Page 15
1. Create the Rule Set

1. Create the Rule Set


Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

Navigate to Siebel Administration - Integration > EAI


Dispatch Service View
In the Rule Sets list, create a new rule set
Enter a name for the rule set
Enter a brief description

s a
h a
l c l)
e nte uide
e z @ nt G
s q u tude
( f cva this S
e da use
a sta se to
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

The EAI Dispatch Service


Chapter 11 - Page 16
2. Create the Rule

2. Create the Rule


Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

In the Rules list, create one or more rules


For each rule specify
Sequence number
Search expression and optionally a property value
Dispatch service and method

s a
a
)h
c l
n t el ide
@ e G u
ez den t
s q u tu
v a S
a (fc e this
a ed o us
a st se t
z C cen
q e
u le li
The search V
s ab the fragment of the input property set to be examined. In the
eridentifies
expression
example
l e
ip shown, nthe f
s fragment is the IntObjectName property of the SiebelMessage child
e
F n-t
property. r
The a
first rule checks whether the value of the property is ExtContact and if so,
nothe Execute Process of the Workflow process Manager business service .
invokes

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

The EAI Dispatch Service


Chapter 11 - Page 17
3. Create the Transforms

3. Create the Transforms


Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

In the Transforms list, create one or more transforms


For each transform specify
The target (part of the property set to be modified)
If the target = Property, specify the name of the property
A source expression that specifies the value to assign to the
target
Express value either in XPATH format or as a literal value s a

a
)h
c l
n t el ide
@ e G u
ez den t
s q u tu
v a S
a (fc e this
a ed o us
a st se t
z C cen
q e
u le li
s ab is passed to the target business service. The root transform (/*)
The transforms
e Vspecify
f e rwhat
l ip thatra
specifies
e s
thenmessage is passed as is without any modification to the hierarchy. The
F ntransform
property - t specifies that a new property is added to the top level of the property set.
n
In this o
case a property with name "Process name" and value "Process External Contacts" is
added. This property is treated by the Workflow Process manager as an argument that
specifies the name of the workflow to be executed.

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

The EAI Dispatch Service


Chapter 11 - Page 18
4. Update Run-Time Memory

4. Update Run-Time Memory


Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

Dispatch rules are cached in the client application


After a rule has been created or modified, cache must be
cleared
In the EAI Dispatch Service View, click Clear Cache to
update the run-time cache

s a
h a
l c l)
e nte uide
e z @ nt G
s q u tude
( f cva this S
e da use
a sta se to
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

The EAI Dispatch Service


Chapter 11 - Page 19
5. Test the Rule Set

5. Test the Rule Set


Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

Create a test input file with the message to be dispatched


Use the Business Service Simulator to test the rule set
Create a new Simulator record
Set Method Name to either Lookup or Dispatch
Load the test input file
Add the name of rule set as an input argument
Run the business service s a
h a
l c l)
e nte uide
e z @ nt G
s q u tude
( f cva this S
e da use
a sta se to
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

The EAI Dispatch Service


Chapter 11 - Page 20
Using a Dispatch Rule Set

Using a Dispatch Rule Set


Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

Outbound Processing
Inbound Processing

s a
h a
l c l)
e nte uide
e z @ nt G
s q u tude
( f cva this S
e da use More

a sta se to
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

The EAI Dispatch Service


Chapter 11 - Page 21
Outbound Processing: Overview of Steps

Outbound Processing:
Overview of Steps
Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

Example: Send an order to a vendor using a transport


specific to the vendor
Identify (or create) the transport workflows and business
services specific to each vendor
May have to add vendor-specific data mapping
Create a rule set that:
Searches the outbound message for the vendor
s a
Dispatches the message to the corresponding workflow or a
)h

c l
business service
EAI XML n t el ide
@ e G u
Write to File
ez den t
EAI Dispatch
s q u tuEAI HTTP
EAIaData S
Service rule set v
(fcMapper his Transport
a e t
a ed o usAnother Workflow
a st se t
z C cen
q e
u le li
s
the raEAIb Dispatch Service rule set will dispatch to either the EAI XML
The example
e Vshows f e
pFile orathe
Writelito
e n sEAI Data Mapper followed by the EAI HTTP Transport or another workflow.
F n-t r
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

The EAI Dispatch Service


Chapter 11 - Page 22
Outbound Processing: Overview of Steps

Outbound Processing:
Overview of Steps
Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

Include the EAI Dispatch Service as the last step in a


general workflow that processes outgoing vendor
messages
Specify the rule set as a business service argument

EAI XML
s a
Write to File h a
l c l)
nteHTTP uide
EAI Siebel EAI Dispatch
Adapter Service EAI Data eEAI
G
Mapper z@ Transport
n t
q e
u tude
v s
a is Workflow
Another S
( f c h
e d a se t
s t a e to u
z Ca cens
s q ue le li
VDispatch b is the EAI Siebel Adapter.
raService
Prior to the EAI
e
ip rans f e
e
F n-tl
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

The EAI Dispatch Service


Chapter 11 - Page 23
Inbound Processing: Overview of Steps

Inbound Processing:
Overview of Steps
Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

Example: Dispatch message from several types of vendors


to vendor-specific workflows
Create the vendor-type specific workflows
Create a rule set that:
Searches the incoming messages for vendor type
Dispatches the message to the corresponding workflow
s a
h a
l c l)
Workflow for Vendor Type 1
e nte uide
Vendor
e z @ nt G
Rule Set
s q u tude
( f cva this S
e da use
a sta sWorkflow
e to for Vendor Type 2
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

The EAI Dispatch Service


Chapter 11 - Page 24
Inbound Processing: Overview of Steps

Inbound Processing:
Overview of Steps
Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

Create a profile for processing received vendor messages


Set Dispatch Service Rule Set = Rule set name

Service to Execute = EAI Dispatch Service


Service Method to Execute = EAI Dispatch Service

s a
a
)h
c l
n t el ide
@ e G u
ez den t
s q u tu
v a S
a (fc e this
a ed o us
a st se t
z C cen
q e
u le li
Navigate to V
s
erab- Server Configuration > Enterprises > Profile Configuration.
Administration
To e l e
ip rthe
configure n s f parameter, Dispatch Rule Set (alias DispatchRuleSet), you must first
third
click - t a button. To display additional [profile parameters.
F thenAdvanced
You n
o
also must leave the DispatchService, DispatchMethod, and DispatchWorkflow
parameters blank as well.

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

The EAI Dispatch Service


Chapter 11 - Page 25
Lesson Highlights

Lesson Highlights
Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

The EAI Dispatch Service is an EAI business service that


routes messages based on their content
Can be invoked in both inbound and outbound processing
Consists of rules, transforms, and rule sets
To create a dispatch rule set:
Create a rule set
s a
Create the rules h a
Create the transforms l c l)
Update the run-time cache e nte uide
e z @ nt G
Test the rule set
s q u tude
( f cva this S
e da use
a sta se to
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

The EAI Dispatch Service


Chapter 11 - Page 26
Practice 11 Overview: The EAI Dispatch Service

Practice 11 Overview:
The EAI Dispatch Service
Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

This practice covers the following topics:


Creating a dispatch rule
Invoking the EAI Dispatch service

s a
h a
l c l)
e nte uide
e z @ nt G
s q u tude
( f cva this S
e da use
a sta se to
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

The EAI Dispatch Service


Chapter 11 - Page 27
Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

s a
h a
l c l)
e nte uide
e z @ nt G
s q u tude
( f cva this S
e da use
a sta se to
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

The EAI Dispatch Service


Chapter 11 - Page 28
Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

s a
h a
l c l)
e nte uide
Using Siebel z @
Inbound
n t GWeb
q e
u tude
Services s
( f c va his S
e d aChapterse12 t
s t a e to u
z Ca cens
s q ue le li
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Using Siebel Inbound Web Services


Chapter 12 - Page 1
Using Siebel Inbound Web Services
Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

Using Siebel Inbound Web Services

s a
h a
l c l)
e nte uide
e z @ nt G
s q u tude
( f cva this S
e da use
a sta se to
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Using Siebel Inbound Web Services


Chapter 12 - Page 2
Objectives

Objectives
Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

After completing this lesson, you should be able to:


Identify the components of a web service
Examine a Siebel inbound web service
Administer an as-delivered Siebel web service
Invoke an as-delivered Siebel web service
s a
h a
l c l)
e nte uide
e z @ nt G
s q u tude
( f cva this S
e da use
a sta se to
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Using Siebel Inbound Web Services


Chapter 12 - Page 3
Web Services

Web Services
Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

Are software components that provide well-defined units of


application functionality
Are typically made available on web servers
Are independent of the clients platform, operating system,
and programming language
Use message-based communication instead of remote
invocation s a
h
) a
Have published descriptions of the interface lcl te de
e n theui
Allow clients to import the descriptions that specify
z@ ent G
structure of the invoking and responseemessages
u tud
s q
( f cva this S
e da use
a sta se to
z C cen
q e
u le li
s ab Technologies: Siebel Enterprise Application Integration: Web
V ferPlatform
Reference: Intgration
e
e l ip rans
Services
F services
Web n -t are one of several technologies that are provided for service-based integration.
n o

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Using Siebel Inbound Web Services


Chapter 12 - Page 4
Standards for Web Services

Standards for Web Services


Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

Web services use industry standards and protocols:


XML for representing the messages
Simple Object Access Protocol (SOAP) for formatting the
message
Is a message-based protocol for exchanging data among
applications
Is based on XML
s a
Is transport layerindependent h a

Is used in Web services to format the message to thel c l)


service
nte uide

and the response from the service e G


@ forndescribing
Web Services Description Language (WSDL) e z t
the service s q u tude
( f cva this S
e da use
a sta se to
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Using Siebel Inbound Web Services


Chapter 12 - Page 5
SOAP Message

SOAP Message
Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

Is an XML document with


SOAP Envelope
some required elements
SOAP Envelope
SOAP Body SOAP Header (optional)
Contains the request or
response message
May also contain an optional a
SOAP Header element h a s
l c l)
Can be used to convey
SOAPe te uide
nBody
credentials and other
e z @ nt G
security information
s q u tude
( f cva this S
e da use
a sta se to
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Using Siebel Inbound Web Services


Chapter 12 - Page 6
SOAP Message Example

SOAP Message
Example
Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

SOAP messages for a credit check Web service

SOAP Message
s a
(input) a
)h
c l
n t el ide
@ e G u
ez den t
s q u tu
v a S
a (fc e this
a ed o us SOAP Message
a st se t (output)

z C cen
q e
u le li
s ranabexample of a SOAP message requesting a validation check for a
e Vshows
The screenshot
f e
p andathe
creditlicard
e n sresulting SOAP response. The body of the request message includes two
F n-t
elements r
ccType with a value of AMEX and ccNum with a value of 1234567890. The body of
no message contains a single element valid with a value of true.
the response

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Using Siebel Inbound Web Services


Chapter 12 - Page 7
Web Services Description Language (WSDL) Document

Web Services Description Language (WSDL)


Document
Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

Is a document in XML that describes for a web service:


What the service does (the operations with inputs/outputs)
How to compose the request message
How and where to send the message
Provides details on how clients use the web service

s a
a
)h
WSDL for credit
check service
c l
n t el ide
@ e G u
ez den t
s q u tu
v a S
a (fc e this
a ed o us
a st se t
z C cen
q e
u le li
s rab elements:
A WSDL fileV containsemultiple
e
ip rconsists f
s of the definitions of the data structures used in request and response
elTypes: a n
F messages
n -t
o
nMessage: consists of the definitions of the structure of the request and response
message for each operation, and optionally that of a fault message
PortType: consists of the definitions of one or more operations associated with the web
service
Binding: consists of the specification of how the service is accessed
Service: consists of a specification of the actual web location of the service and the
previously-defined bindings.

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Using Siebel Inbound Web Services


Chapter 12 - Page 8
Web Services in Siebel Applications

Web Services in Siebel Applications


Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

Siebel applications are delivered with multiple prebuilt


inbound web services
Allow external applications to access Siebel functionality and
data
Typically expose Siebel business services or workflows

s a
a
)h
c l
n t el ide
@ e G u
ez den t
s q u tu
v a S
a (fc e this
a ed o us
a st se t
z C cen
q e
u le li
s
erab- Web Services > Inbound Web Services.
Navigate to V Administration
l i p e n s f
Fe nare:
Siebel
examples
CRM
- tra many prebuilt published web services in several industry areas. Some
includes
o
nOrder Management
- ABOWebService
- AssetWebService
- CatalogWebService
- ProductConfigurator
Field Service
- ServiceRequest
- VerifyEntitlement
CME
- NetworkOrderEntry
- TroubleTicket.

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Using Siebel Inbound Web Services


Chapter 12 - Page 9
Structure of Siebel Web Services

Structure of Siebel Web Services


Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

Service
Service ports
Operations

s a
h a
l c l)
e nte uide
e z @ nt G
s q u tude
( f cva this S
e da use
sta se to
More
a
C cen
e z
u le li
s q
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Using Siebel Inbound Web Services


Chapter 12 - Page 10
Service

Service
Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

A service is a set of one or more related operations that


can be invoked
Examine a service by navigating to Administration - Web
Services > Inbound Web Services
Definition specifies the namespace for the web service
Typically is concatenated from the corporate URL and a service-
related name s a
h a
l c l)
e nte uide
e z @ nt G
s q u tude
( f cva this S
da use
Namespace for
the "Contact"
e
web service
a sta se to
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Using Siebel Inbound Web Services


Chapter 12 - Page 11
Service Ports

Service Ports
Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

A service has one or more ports


A port represents one or more operations for the service
executed by an underlying business service or workflow
Each port has its associated URL
Examine the service ports in the Service Ports applet

s a
h a
l c l)
e nte uide
e z @ nt G
s q u tude
cva this S
Business service for the port
( f
e da use
a sta se to
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Using Siebel Inbound Web Services


Chapter 12 - Page 12
Operations

Operations
Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

A port has one or more operations


Each operation corresponds to a method of the underlying
business service or workflow
Scroll to the bottom of the view to examine the operations
associated with a specific service port
The Method Display Name displays the name of the method
to be executed for the underlying business service/workflows a
l ) ha
n t elc ide
@ e G u
ez den t
s q u tu
v a S
a (fc e this
a ed o us
a st se t
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Using Siebel Inbound Web Services


Chapter 12 - Page 13
Working with Siebel Inbound Web Services

Working with Siebel Inbound Web Services


Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

Administering inbound web services


Invoking inbound web services

s a
h a
l c l)
e nte uide
e z @ nt G
s q u tude
( f cva this S
e da use
sta se to
More

a
C cen
e z
u le li
s q
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Using Siebel Inbound Web Services


Chapter 12 - Page 14
Administering Inbound Web Services

Administering Inbound Web Services


Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

As-delivered inbound Web services require some


administration before the service can be used
Completing the service address
Generating the WSDL document

s a
h a
l c l)
e nte uide
e z @ nt G
s q u tude
( f cva this S
e da use
sta se to
More

a
C cen
e z
u le li
s q
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Using Siebel Inbound Web Services


Chapter 12 - Page 15
Completing the Service Address

Completing the Service Address


Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

The address is specific to a given customer installation


To complete the service address:
Navigate to Administration - Web Services > Inbound Web
Services
Select the web service to administer
Specify:
The name of the webserver s a

h a
The language for the EAI object manager
l c l)

e nte uide
The credentials to allow an external application to log into a
Siebel application
e z @ nt G
If necessary, set the service statusqtouActive
s t u de
( f cva this S
e da use
a sta se to
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Using Siebel Inbound Web Services


Chapter 12 - Page 16
Completing the Service Address

Completing the Service Address


Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

Click Clear Cache to update runtime memory

4. Click
Clear Cache

s a
h a
l c l)
e nte uide
e z @ nt G
s q u tude
1. Specify 2. Specify
( f cva this 3.SSpecify
webserver EAI obj mgr
e d a se credentials
host name language
s t a e to u
z Ca cens
s q ue le li
Since the URL
e Vcontainsf e ratheblogin credentials in plain text, Siebel administrators will likely
create
e l ipa dedicated
a n slogin for the EAI object manager with limited privileges and
F n-t r
responsibilities.
The n o
screenshot shows the steps to administer a web service in the Administration - Web
Services Inbound Web Services view:
1. In the address field in the Service Ports applet, specify the host name of the webserver.
2. Specify the language suffix for the EAI Object Manager.
3. Add the credentials to log into the EAI Object Manager.
4. Click the Clear Cache button at the top of the view.
Note that the address field for as-delivered inbound web services may have several of these
parameters already specified.

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Using Siebel Inbound Web Services


Chapter 12 - Page 17
Generating the WSDL Document

Generating the WSDL Document


Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

Client applications require a WSDL document to specify


how to invoke the web service
To generate the WSDL
Navigate to Administration - Web Services > Inbound Web
Services
Query for the Service
a
Click Generate WSDL
)h as
c l
n t el ide
@ e G u
ez den t
s q u tu
v a S
a (fc e this
a ed o us
a st se t
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Using Siebel Inbound Web Services


Chapter 12 - Page 18
Generating the WSDL Document

Generating the WSDL Document


Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

The WSDL document describes the web service details

Tail end of
WSDL file
Operations as
specified in the
s a
operations records
a
)h
c l
n t el ide
@ e G u
ez den t
s q u tu
v a S
ina
(fcspecified his
Address as
port recorde t

a ed o us
a st se t
z C cen
q e
u le li
s ratheboperations as specified in the operations records. The address as
e Vcontains
The WSDL file
f e
e l ip in the
specified
a n s record.
port
F n-t r
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Using Siebel Inbound Web Services


Chapter 12 - Page 19
Invoking Inbound Web Services

Invoking Inbound Web Services


Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

Optionally, use a SOAP web service utility to test the web


service
Import the WSDL to generate message templates

s a
a
)h
c l
Example
n t el ide
utility SOAP response
(with RowId of e
@
message
G
the new record)
u
ez den t
s q u tu
v a S
a (fc e this
a edSOAP
o usa contact)
request message
t
as nse t (create
C
z lice
u e
sq rable
i p
panelshows
e Vthendisplays
The screenshot
s fe the soapUI SOAP utility. The left pane shows the request. The right
response.
Fe n-tra
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Using Siebel Inbound Web Services


Chapter 12 - Page 20
Invoking Inbound Web Services

Invoking Inbound Web Services


Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

Create code in the client application to invoke the service


Import the WSDL document into a development environment
to generate the source code

Example Oracle
JDeveloper development
environment

s a
h a
l c l)
e
e
ntfragments u ide
e z @ nt G
Source code to

q u e
be used in constructing
u tthe dapplication
s
( f cva this S
e da use
a sta se to
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Using Siebel Inbound Web Services


Chapter 12 - Page 21
Prebuilt Integration Using Web Services

Prebuilt Integration Using Web Services


Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

Siebel CRM includes several inbound web services used


to support prebuilt integration with:
Siebel CRM desktop
Siebel self-services applications
BI Publisher reports server
BIPDataService : retrieves report data from Siebel application
s
BIPSiebelSecurityService: verifies user responsibilities a

h a
l c l)
e nte uide
e z @ nt G
s q u tude
( f cva this S
e da use
a sta se to
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Using Siebel Inbound Web Services


Chapter 12 - Page 22
Lesson Highlights

Lesson Highlights
Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

Web services are software components that provide well


defined units of application functionality
Are operating-system and programming-language
independent
Web services depend upon:
SOAP protocol to format the message
WSDL files to describe the web service s a
h a
Siebel applications are delivered with many prebuilt l c l)
web
services e nte uide
Typically require some amount of administration
e z @ nt G
Complete the customer-specificawebs quaddresses
t u de

f cv for tclient S
is applications

a (
Generate the WSDL document
e h to import
Siebel web services
d us using a SOAP utility
e beotested
can
t a t
C as nse
u e z lice
sq rable
e V fe
e l i p a n s
F n-t r
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Using Siebel Inbound Web Services


Chapter 12 - Page 23
Practice 12 Overview: Using Siebel Inbound Web Services

Practice 12 Overview:
Using Siebel Inbound Web Services
Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

This practice covers the following topics:


Administering an inbound web service
Generating a WSDL file
Invoking a Siebel inbound web service using a SOAP utility

s a
h a
l c l)
e nte uide
e z @ nt G
s q u tude
( f cva this S
e da use
a sta se to
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Using Siebel Inbound Web Services


Chapter 12 - Page 24
Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

s a
h a
l c l)
e nte uide
Configuring zSiebel G
@ ntInbound
e
qu Stude
Web a Services
s
( f cv 13 this
e da use
Chapter

a sta se to
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Configuring Siebel Inbound Web Services


Chapter 13 - Page 1
Configuring Siebel Inbound Web Services
Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

Configuring Siebel Inbound Web Services

s a
h a
l c l)
e nte uide
e z @ nt G
s q u tude
( f cva this S
e da use
a sta se to
z C cen
q e
u le li
s Copyright 2011, Oracle and/or its affiliates. All rights reserved.

e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Configuring Siebel Inbound Web Services


Chapter 13 - Page 2
Objectives

Objectives
Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

After completing this lesson, you should be able to:


Describe how Siebel applications support inbound web
services
Administer inbound web services
Describe authentication approaches available for inbound
web services
s a
h a
l c l)
e nte uide
e z @ nt G
s q u tude
( f cva this S
e da use
a sta se to
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Configuring Siebel Inbound Web Services


Chapter 13 - Page 3
Inbound Web Service Architecture

Inbound Web Service Architecture


Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

Structure of an inbound web service


Execution of an inbound web service

s a
a
)h
c l
n t el ide
@ e G u
ez den t
s q u tu
v a S
a (fc e this
a ed o us More

a st se t
z C cen
q e
u le li
Reference:V
s ab Technologies: Siebel Enterprise Application Integration: Web
erPlatform
Integration
e
ip rans
Services.
l f
e
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Configuring Siebel Inbound Web Services


Chapter 13 - Page 4
Inbound Web Services: Service Ports

Inbound Web Services: Service Ports


Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

An inbound web service exposes one or more business


services or workflows as service ports
Each port maps to a single business service or workflow

The Forecast web service exposes the


s a
a
Forecast Detail and Forecast Series
h
l c l)
business services as service ports

e nte uide
e z @ nt G
s q u tude
( f cva this S
e da use
a sta se to
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Configuring Siebel Inbound Web Services


Chapter 13 - Page 5
Inbound Web Services: Operations

Inbound Web Services: Operations


Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

Each operation for a port exposes a method of the


business service or workflow
Not all methods need to be exposed

s a
h a
l c l)
e nte uide
User-created names
e z @ nt G
that are unique across
s q u tude
cva this S
all web services
( f
Names from
the repository e da use
a sta se to
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Configuring Siebel Inbound Web Services


Chapter 13 - Page 6
Execution of an Inbound Web Service

Execution of an Inbound Web Service


Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

The HTTP receiver in the EAI object manager receives


and dispatches incoming web service requests
Invokes the Web Service Inbound Dispatcher business
service
Specified in the WebService profile configuration

s a
a
)h
c l
n t el ide
@ e G u
ez den t
s q u tu
v a S
a (fc e this Business service
invoked by the
e d
to u s WebService profile
t a
C as nse
u e z lice
Reference:V sq erPlatform
Integration a ble Technologies: Siebel Enterprise Application Integration: Web
i p
Services.
l e nsf
Fe n-tra
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Configuring Siebel Inbound Web Services


Chapter 13 - Page 7
Web Service Inbound Dispatcher

Web Service Inbound Dispatcher


Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

Is a business service that:


Converts an incoming SOAP message to Siebel-structured
data
Invokes the appropriate business service or workflow
Executes the method contained in the SOAP message
Converts the data returned by the service to a SOAP
message s a
h a
l c l)
e nte uide
e z @ nt G
s q u tude
( f cva this S
e da use
a sta se to
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Configuring Siebel Inbound Web Services


Chapter 13 - Page 8
Publishing a Siebel Inbound Web Service

Publishing a Siebel Inbound Web Service


Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

1. Create the web service definition


2. Create a service port
3. Publish the operations
4. Generate the WSDL file

s a
Example: Expose a business service to manage membership h a
l c l) in
a rewards plan
e nte uide
e z @ nt G
s q u tude
( f cva this S
e da use More

a sta se to
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Configuring Siebel Inbound Web Services


Chapter 13 - Page 9
1. Create the Web Service Definition

1. Create the Web Service Definition


Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

In the Siebel client, navigate to Administration - Web


Services > Inbound Web Services
Create a record in the Inbound Web Services list
Namespace: Enter the namespace for your web service
Is required for generating various XML documents
Distinguishes this web service from others
Name: Enter the name of the inbound web service s a
h a
l c l)the
Status: Select Active to enable external systems to call
web service
e u nte ide
@ t G
q u ez den
v a s S tu
a (fc e this
a ed o us
a st se t
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Configuring Siebel Inbound Web Services


Chapter 13 - Page 10
2. Create a Service Port

2. Create a Service Port


Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

A service port identifies the underlying Siebel service to be


deployed as a web service
Can be a workflow process or a business service
In the Inbound Web Services view specify:
Business Service: name of the business service or workflow
Transport: HTTP
a
Address: the URL to be used by clients as )h
c l
n t el ide
@ e G u
ezwithConfigure
e t
ndefault URL
Underlying s q u t d
u and credentials
host name, language
a
cv this
business service Ssuffix,
( f
e da use
a sta se to
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Configuring Siebel Inbound Web Services


Chapter 13 - Page 11
2. Create a Service Port: Binding

2. Create a Service Port: Binding


Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

Select an appropriate binding:


SOAP_RPC_ENCODED
SOAP_RPC_LITERAL
SOAP_DOC_LITERAL

s a
a
)h
c l
n t el ide
@ e G u
ez den t
s q u tu
v a S
a (fc e this
a ed o us
a st se t
z C cen
q e
u le li
The bindingV
s rabthe style of the SOAP message to be sent by a client to invoke the
specifies
value
e
ipand outputs
web service. RPC f e
sbindings specify a message style in which the names and types of the
e l
F n-t
inputs r a n of the methods appear explicitly. The message resembles a remote
no call (RPC). RPC binding typically reduces the overhead of processing in the web
procedure
service call.
Document (DOC) binding specifies a more abstract message structure in which the types are
defined separately in the WSDL document. DOC binding typically better encapsulates the
implementation and allows for modification of the implementation without affecting the web
service calls.

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Configuring Siebel Inbound Web Services


Chapter 13 - Page 12
3. Publish the Operations

3. Publish the Operations


Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

Specify an operations record for each method of the


service that can be invoked by a web service client
Not all service methods must be published
Only published methods can be invoked
Only the RunProcess method can be published for workflows

s a
h a
l c l)
e nte uide
e z @ nt G
s q u tude
( f cva this S
Select one orda
Operation name must
be unique across all e
more methods u se
web services
a staservicese to
from

z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Configuring Siebel Inbound Web Services


Chapter 13 - Page 13
4. Generate the WSDL File

4. Generate the WSDL File


Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

In the Inbound Web Services view:


Click Clear Cache to update the cached service definitions
Click Generate WSDL to create the WSDL file

s a
h a
l c l)
e nte uide
e z @ nt G
s q u tude
( f cva this S
e da use
a sta se to
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Configuring Siebel Inbound Web Services


Chapter 13 - Page 14
4. Generate the WSDL File

4. Generate the WSDL File


Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

Distribute the WSDL file to web service clients

s a
h a
l c l)
e nte uide
e z @ nt G
s q u tude
( f cva this S
e da use
a sta se to
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Configuring Siebel Inbound Web Services


Chapter 13 - Page 15
Transports for Web Services

Transports for Web Services


Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

Siebel applications support publishing web services that


can be invoked by a variety of transports
MQSeries, MSMQ, and JMS, in addition to HTTP

s a
a
)h
c l
n t el ide
@ e G u
ez den t
s q u tu
v a S
a (fc e this
a ed o us
a st se t
z C cen
q e
u le li
s ranotbconstrained to being invoked by HTTP. They have been designed
e V fare
Siebel web services
e
ipJMS).rans and can be invoked through any of the EAI transports (HTTP, MQ,
to beltransport-neutral,
e
F n-t
MSMQ,
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Configuring Siebel Inbound Web Services


Chapter 13 - Page 16
Publishing from Siebel Tools

Publishing from Siebel Tools


Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

A business service or workflow process can be published


directly as a web service in Siebel Tools
Right-click the business service or workflow process, and
select Deploy as a Web Service
Creates the web service, ports, and operations definitions

s a
h a
l c l)
nte uide
Select methods
e
@ nt G
e z
s q de names
u tuModify
( f cva this S
e da use Configure URL
a
st se t o
a
C cen
e z
u le li
s q
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Configuring Siebel Inbound Web Services


Chapter 13 - Page 17
Default Web Service Security

Default Web Service Security


Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

By default, web services are insecure:


The username and password are included in the URL
The message body is sent in plain text
To provide some security, create and use a user with
extremely limited responsibility
The username and password
s
are included in the URL a
h a
l c l)
e n te uide
user G
@responsibilities
Create a "WSUSER"
has e z n t who

s q u tude
limited

( f cva this S
e da use The content is readable
a
st se t o (unencrypted)
a
C cen
e z
u le li
s q
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Configuring Siebel Inbound Web Services


Chapter 13 - Page 18
Enhancing Security

Enhancing Security
Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

To enhance web service security:


Move the username and password to the message header
instead of the URL by using:
Session headers
Web service security
An industry-standard alternative to session headers
Encrypt the entire transaction by enabling HTTPS
s a
a
)h
This is the only supported mechanism that encrypts the

c l
password
n t el ide
@ e G u
ez den t
s q u tu
v a S
a (fc e this
a ed o us
a st se t
z C cen
q e
u le li
Reference:V
s ab Technologies: Siebel Enterprise Application Integration: Web
erPlatform
Integration
e
ip rans
Services.
l f
e
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Configuring Siebel Inbound Web Services


Chapter 13 - Page 19
Sessions

Sessions
Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

Web services support three session types:


None
Also referred to as a "sessionless" session
Stateless
Stateful
Every session type supports including the username and
a
password in the SOAP header instead of the URL
l) has
l c
e nte uide
e z @ nt G
s q u tude
( f cva this S
e da use More

a sta se to
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Configuring Siebel Inbound Web Services


Chapter 13 - Page 20
"Sessionless" Sessions

"Sessionless" Sessions
Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

Are short-duration sessions:


A new session is created to service the request
The session is closed after the Siebel application sends a
response
Support anonymous logins
Omit the username and password from the URL or message
header s a
h a
l c l)
Requires additional Siebel Web Engine (SWE) and server
configuration nte e ide u
Are specified by either: @ t G
q u ez den
Omitting the SessionType element
v a s in SOAPS tuheader
Setting the SessionType element is
(fc e tothNONE
a
ed o us
a
a st se t
z C cen
q e
u le li
s b on implementing anonymous logins, consult the Siebel
eForradetails
Anonymous
e VLogin: f
e l ip Guide.
Security
a n s
F nHeader:
Example -t r An Initial Session Request. The next few notes pages provide example
o
n The header shown is a header for an initial stateless session request. Set the
headers.
SessionType element to "None", or omit it, for a sessionless session. Note the username and
password provided in plain text.
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Header>
<UsernameToken
xmlns="http://siebel.com/webservices">WSUSER</UsernameToken>
<PasswordText
xmlns="http://siebel.com/webservices">WSUSER</PasswordText>
<SessionType
xmlns="http://siebel.com/webservices">Stateless</SessionType>
</soap:Header>
<soap:Body>
<!-- request data here -->
</soap:Body>
</soap:Envelope>

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Configuring Siebel Inbound Web Services


Chapter 13 - Page 21
Stateless Sessions

Stateless Sessions
Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

Are opened with the initial request


The initial request must contain a user name and password
Anonymous login is not supported for stateless sessions
Remain open for subsequent requests
Allows a client to submit multiple requests without the
overhead of verifying credentials for each request
s a
Re-login automatically if the session is closed h a
Occurs transparently to user l c l)
e n te uide
Are specified by: @ nt G
e z
Setting the SessionType element in
s q uthe SOAP
t u deheader to
Stateless
( f cva this S
e da use
a sta se to
z C cen
q e
u le li
s ab Stateful or Stateless Session Response: The server
V fAn
Example Headers:
e e rInitial
l ip to the
responds
e a n s request for a stateful or stateless session with a session token:
session
r
F n-t xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Envelope
o
n<siebel-header:SessionToken
<soap:Header>
xmlns:siebel-header="http://siebel.com/
webservices">2-Y-AGulpMN9SxI9Any9zWMBTFIuJEJfCXjfI0G-
9bOTH4lJjbSdgF.Gd07Sz957sFeJxUA0WFSh_</siebel-header:SessionToken>
</soap:Header>
<soap:Body>
<!- response data here -->
</soap:Body>
</soap:Envelope>

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Configuring Siebel Inbound Web Services


Chapter 13 - Page 22
Stateful Sessions

Stateful Sessions
Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

Are opened with the initial request


The initial request must contain a user name and password
Anonymous login is not supported for stateful sessions
Remain open for subsequent requests
Allows a client to submit multiple requests without the
overhead of verifying credentials for each request
s a
Do not re-login automatically if the session is closed a
)h
c l
This is the difference between stateless and stateful
n t el ide
sessions
@ e G u
Are specified by: ez den t
q u
sin the S tu header to
Setting the SessionType element v a SOAP
Stateful a (fc e this
Have an authentication a edprocess
o usidentical to stateless
t
as nse t
C
z lice
u e
sq rable
V fSubsequent
Example Headers:
e e future requests,
Stateful or Stateless Session Responses: The client uses
i p s
Fel nwould n
the session token in all until the token or the session expires. A stateless
session - t r a
then request a new token, sending the username and password once again.
n o
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Header>
<SessionType
xmlns=http://siebel.com/webservices>Stateless</SessionType>
<SessionToken xmlns="http://siebel.com/webservices">2-Y-
AGulpMN9SxI9Any9zWMBTFIuJEJfCXjfI0G-9bOTH4lJjbSdgF.G
d07Sz957sFeJxUA0WFSh_</SessionToken>
</soap:Header>
<soap:Body>
<!- request data here -->
</soap:Body>
</soap:Envelope>

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Configuring Siebel Inbound Web Services


Chapter 13 - Page 23
Configure Siebel Inbound Web Sessions

Configure Siebel Inbound Web Sessions


Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

To support sessions for an inbound Siebel web service:


In the Siebel application, modify the service port URL so that:
It does not include a user name or password
It includes the WSSOAP=1 tag, indicating that it uses sessions
In the exported WSDL, add appropriate tags to the SOAP
Header:
UsernameToken: The user ID of the Siebel user s a

h a

l l)
PasswordText: The password of the Siebel user
c

e nte uide
SessionType: None, Stateless, Stateful, or ServerDetermine

e z @ nt G
SessionToken: Used in subsequent web service requests during
the same session
s q u tude
( f cva this S
The tags all use xmlns="http://siebel.com/webservices"

e da use
a sta se to
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Configuring Siebel Inbound Web Services


Chapter 13 - Page 24
Configure Siebel Inbound Web Sessions

Configure Siebel Inbound Web Sessions


Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

In the URL, set WSSOAP=1 instead


of a username and password

s a
h a
l c l)
e nte uide
e z @ nt G
s q u tude
( f cvaUsernameToken,
i s
Within
h
S
the request, add

e d a seandtSessionTypePasswordText,
t a to u these are not included to the header;
in the WSDL
a s se
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Configuring Siebel Inbound Web Services


Chapter 13 - Page 25
Web Service Security

Web Service Security


Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

Siebel applications partially support the Web Services


Security (WS-Security) standard
An industry standard for web services security
The header is NOT encrypted, so the password is still sent in
plain text
WS-Security is incompatible with session headers
Use one or the other s a
h a
WS-Security is implemented in different ways: l c l)
For inbound web services, configure the inbound e nteweb uide
service to use the secure web servicee z @ nt G
profile
For outbound web services, theaimported s qu SWSDL
t ude must
(
include WS-Security information f cv this
e da use
a sta se to
z C cen
q e
u le li
s rab
e VSiebel
At the moment,
f eapplications support only the UserName token of the WS-Security
ip
standard. s
Fel n-tran
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Configuring Siebel Inbound Web Services


Chapter 13 - Page 26
Implementing WS-Security for Inbound Web Services

Implementing WS-Security for Inbound Web


Services
Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

For inbound web services:


Modify eapps.cfg by setting UseAnonPool = TRUE
Usually set for eai_anon_<lang>; for example, eai_anon_enu
Modify the SecureWebService profile:
Set DispatchMethod=Dispatch
Set DispatchService=Web Service Inbound Dispatcher
Set Impersonate=True s a

h a
Modify the web service:
l c l)
Change the Authentication Type on at least onen

e te utoide
operation
"Username/Password - clear text"
e z @ nt G
This automatically resets the URL to

s q t u de
uuse eai_anon_<lang> and
SWEExtSource=SecureWebService
( f cva this S
e da use
a sta se to
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Configuring Siebel Inbound Web Services


Chapter 13 - Page 27
Implementing WS-Security for Inbound Web Services

Implementing WS-Security for Inbound Web


Services
Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

Set the URL to use eai_anon_enu


and SecureWebService

s a
h a
l c l)
e nte uide
Change the authentication
z @ nt G
to Username/Password
e
s q u tude
( f cva this S
e da use
a sta se to
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Configuring Siebel Inbound Web Services


Chapter 13 - Page 28
Implementing WS-Security for Inbound Web Services

Implementing WS-Security for Inbound Web


Services
Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

Once the external application has imported the WSDL, add


a <wsse> section to the header identifying the username
and password:
<wsse:Security
xmlns:wsse="http://schemas.xmlsoap.org/ws/2002/07/secext">
http://schemas.xmlsoap.org/ws/2002/07/secext
<wsse:UsernameToken
s a
a
xmlns:wsu="http://schemas.xmlsoap.org/ws/2002/07/utility">
h
<wsse:Username>WSUSER</wsse:Username>
<wsse:Password
l c l)
nte uide
Type="wsse:PasswordText">WSUSER</wsse:Password>
e
@ nt G
</wsse:UsernameToken>
</wsse:Security>
e z
u tude
s q
( f cva this S
e da use
a sta se to
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Configuring Siebel Inbound Web Services


Chapter 13 - Page 29
Implementing HTTPS

Implementing HTTPS
Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

The only way to encrypt the username, password, and all


transmitted data is to enable secure HTTP (HTTPS)
To do this:
Add an SSL certificate to the web server to support HTTPS
In the EAI Object Manager, set SecureBrowse=TRUE
Caveat: This will force all web services to use HTTPS
Consider creating a separate "secure" object manager for s a

a
)h
secure web services
c l
n t el ide
@ e G u
ez den t
s q u tu
v a S
a (fc e this
a ed o us
a st se t
z C cen
q e
u le li
Reference:VFor
s rab on implementing HTTPS for a particular application object
moreeinformation
e f
ip seerathensSiebel Security Guide.
manager,
l
e
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Configuring Siebel Inbound Web Services


Chapter 13 - Page 30
Lesson Highlights

Lesson Highlights
Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

Inbound web services allow external applications to invoke


a published Siebel web service
A published web service consists of definitions of the:
Web service
Service port(s)
Published operations
s a
Web services can be published either by: h a
l c l)
Configuring the service in the Siebel client
e n te uide
Deploying the web service directly from Siebel
z @ Toolsn t G
Siebel CRM supports authentication q e de headers
uand session
s t u
( f cva this S
e da use
a sta se to
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Configuring Siebel Inbound Web Services


Chapter 13 - Page 31
Practice 13 Overview: Siebel Inbound Web Services

Practice 13 Overview:
Siebel Inbound Web Services
Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

This practice covers the following topics:


Examining an as-delivered web service
Deploying a business service as a web service

s a
h a
l c l)
e nte uide
e z @ nt G
s q u tude
( f cva this S
e da use
a sta se to
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Configuring Siebel Inbound Web Services


Chapter 13 - Page 32
Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

s a
h a
l c l)
e nte uide
Siebel Outbound z @ Web
n t G
q e
u tude
Services s
( f c va his S
e d aChapterse14 t
s t a e to u
z Ca cens
s q ue le li
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Siebel Outbound Web Services


Chapter 14 - Page 1
Siebel Outbound Web Services
Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

Siebel Outbound Web Services

s a
h a
l c l)
e nte uide
e z @ nt G
s q u tude
( f cva this S
e da use
a sta se to
z C cen
q e
u le li
s Copyright 2011, Oracle and/or its affiliates. All rights reserved.

e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Siebel Outbound Web Services


Chapter 14 - Page 2
Objectives

Objectives
Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

After completing this lesson, you should be able to:


Create a proxy business service that invokes an external
web service
Invoke the proxy business service in an integration
workflow

s a
h a
l c l)
e nte uide
e z @ nt G
s q u tude
( f cva this S
e da use
a sta se to
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Siebel Outbound Web Services


Chapter 14 - Page 3
Outbound Web Services

Outbound Web Services


Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

Allow Siebel applications to invoke a web service


published by an external application
Example: Siebel clients use the PublicReportServiceService
to invoke reporting services on a BI Publisher server

s a
a
)h
c l
Name of
n t el ide
the service
@ e G u
ez den t
s q u tu
v a S
a (fc e this
a ed o usAddress of

st se t
the service
a
C cen
e z
u le li
s q
Reference:V
Integration
f ab Technologies: Siebel Enterprise Application Integration: Web
erPlatform
e
ip rans
Services.
l
e
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Siebel Outbound Web Services


Chapter 14 - Page 4
Outbound Web Service Architecture

Outbound Web Service Architecture


Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

Outbound web service specification


Proxy business service

s a
h a
l c l)
e nte uide
e z @ nt G
s q u tude
( f cva this S
e da use
sta se to
More

a
C cen
e z
u le li
s q
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Siebel Outbound Web Services


Chapter 14 - Page 5
Outbound Web Service Specification

Outbound Web Service Specification


Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

Captures the details of the external web service


Is typically derived from the WSDL file for the web service
Is managed in Administration - Web Services > Outbound
Web Services
Administrators can update address details as needed

s a
h a
l c l)
e nte uide
e z @ nt G
s q
theuservice tude
Address of

( f cva this S
e da use
a sta se to
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Siebel Outbound Web Services


Chapter 14 - Page 6
Proxy Business Service

Proxy Business Service


Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

Each outbound web service requires an associated


underlying business service
Referred to as a proxy business service
Provides the mechanism for invoking the web service
In a workflow
In an action set for a runtime event
And so forth s a
h a
l
Proxy businessc l)
e te uide
nservice
e z @ nt G
s q u tude
( f cva this S
e da use
a sta se to
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Siebel Outbound Web Services


Chapter 14 - Page 7
Proxy Business Service Arguments

Proxy Business Service Arguments


Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

The input and output of the proxy business service are


integration objects (IO)
Structure of the IOs correspond to the structure of the
request and response message for the web service
Specified in the WSDL for the web service

s a
h a
l c l)
e nte uide
e z @ nt G
s q u tude
( f cva this S
e da usInput
e and
a sta se to output IOs
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Siebel Outbound Web Services


Chapter 14 - Page 8
Proxy Business Service Class

Proxy Business Service Class


Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

Proxy business services are based on the


CSSWSOutboundDispatcher class which:
Converts the service input to an outbound SOAP request
Sends the request to the external web service
Receives the SOAP response and converts the response
data to an output of the proxy business service
a
Class required) h
as
c l
n t
businesseservice ide
l
for a proxy

@ e G u
ez den t
s q u tu
v a S
a (fc e this
a ed o us
a st se t
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Siebel Outbound Web Services


Chapter 14 - Page 9
Creating an Outbound Web Service

Creating an Outbound Web Service


Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

1. Create the proxy business service


2. Import the WSDL file
3. Inspect the objects created
4. Compile the objects created
5. Create the outbound web service
s a
Example: Create an outbound web service to invoke a l) h a
temperature conversion web service: n t elc ide
@ e G u
(Fahrenheit to/from Celsius) t
q u ez den
v a s S tu
a (fc e this
a ed o us More

a st se t
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Siebel Outbound Web Services


Chapter 14 - Page 10
1. Create the Proxy Business Service

1. Create the Proxy Business Service


Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

In Siebel Tools, use the WSDL Import Wizard to create the


proxy business service
Select File > New Object > EAI > Web Service to invoke the
wizard

s a
h a
l c l)
e nte uide
e z @ nt G
s q u tude
( f cva this S
e da use
a sta se to
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Siebel Outbound Web Services


Chapter 14 - Page 11
2. Import the WSDL File

2. Import the WSDL File


Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

Import the external WSDL file


Specifies the methods and data structures for the proxy
business service

Publicly available

s
WSDL file for the a
h a web service

l c l)
e nte uide
e z @ nt G
s q u tude
( f cva this S
e da use
a sta se to
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Siebel Outbound Web Services


Chapter 14 - Page 12
3. Inspect the Objects Created: Business Service

3. Inspect the Objects Created:


Business Service
Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

A proxy business service for the external web service is


created

Proxy business
service created
by the wizard

s a
h a
l c l)
e nte uide
e z @ nt G
s q u tude
( f cva this S
e da use
a sta se to
z C cen
q e
u le li
s
einrathisbexample is TemperatureConvertor with Class =
The business
e Vservicef
e l i p a n s
CSSWSOutboundDispatcher and method = process.
F n-t r
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Siebel Outbound Web Services


Chapter 14 - Page 13
3. Inspect the Objects Created: Business Service Arguments

3. Inspect the Objects Created:


Business Service Arguments
Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

The input and output for the proxy business service are
created as integration objects

s a
h a
l c l)
e nte uide
e z @ nt G
s
Arguments q u
created tu
de
( f cvbyathe twizard
h is S
e da use
a sta se to
z C cen
q e
u le li
s rab two integration objects as arguments:
includes
The processVmethod e
l e
ip rans f
TemperatureConvertorProcessRequest and TemperatureConvertorProcessResponse.
e
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Siebel Outbound Web Services


Chapter 14 - Page 14
3. Inspect the Objects Created: Integration Objects

3. Inspect the Objects Created:


Integration Objects
Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

The integration objects reflect the structure of the input and


output messages as specified in the WSDL file

IOs created
by the wizard

s a
h a
l c l)
e nte uide
e z @ nt G
s q u tude
( f cva this S
e da use
a sta se to
z C cen
q e
u le li
s
e V ferab
The TemperatureConvertorProcessResponse Integration Object contains and integration
i p s
Fel n-tran
component with one field. The field is "result" with Data Type of text.

no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Siebel Outbound Web Services


Chapter 14 - Page 15
3. Inspect the Objects Created: Business Service User Properties

3. Inspect the Objects Created:


Business Service User Properties
Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

Business service user properties are also created


Are used by web services administration in the Siebel client

s a
a
)h
c l
n t el ide
@ e G u
ez den t
s q u tu
v a S
a (fc e this
a ed o us Values determined
by the WSDL file
a st se t
z C cen
q e
u le li
s
euser rabprop values are determined by the WSDL file. In this example they
The business
e Vservicef
l ipthe port
specify
e a n s web service name, and web service namespace.
name,
F n-t r
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Siebel Outbound Web Services


Chapter 14 - Page 16
4. Compile the Objects Created

4. Compile the Objects Created


Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

Compile the new objects into the Siebel repository file

s a
h a
l c l)
e nte uide
e z @ nt G
s q u tude
( f cva this S
e da use
a sta se to
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Siebel Outbound Web Services


Chapter 14 - Page 17
5. Create the Outbound Web Service

5. Create the Outbound Web Service


Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

In the Siebel client, navigate to Administration - Web


Services > Outbound Web Services
Click the Import button to import the XML file created by
the WSDL Import wizard

s a
h a
l c l)
e nte uide
e z @ nt G
s q u tude
(
Proxy businessf va his S
cservice
e d a se t
t method
aservice t o u
s
Proxy business

z Ca cense
s q ue le li
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Siebel Outbound Web Services


Chapter 14 - Page 18
Invoking a Proxy Business Service

Invoking a Proxy Business Service


Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

Add a business service step to the integration workflow


Add process properties of type Integration Object for
assigning inputs and outputs to the proxy business service

Invokes the proxy


business service

s a
h a
l c l)
e nte uide
e z @ nt G
s q u tude Add process
( f cva this S properties of type
Integration Object

e da use
a sta se to
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Siebel Outbound Web Services


Chapter 14 - Page 19
Options for Mapping to/from the Integration Objects

Options for Mapping to/from the Integration


Objects
Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

Use the EAI Data Mapper to map between the internal


integration object (associated with the EAI Siebel Adapter)
and the external integration object for the proxy business
service
Replace the external integration objects with matching
internal integration objects
Is an option when the external web service uses a Siebel s a
a
data structure l) h lc
nte uide
Create an integration object instance from a populated
e
XML string using the EAI XML Converter
e z@ nt G e
qu services
Can be used for testing outboundsweb tud
( f cva this S
e da use
a sta se to
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Siebel Outbound Web Services


Chapter 14 - Page 20
Implementing Session-Based Security

Implementing Session-Based Security


Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

For Siebel outbound web services, configure the


CustomHeaderContext input argument parameter for the
proxy business service with the SOAP header information

s a
h a
l c l)
e nte uide
e z @ nt G
For outbound web services, qu
s t u de
cva this S
use CustomHeaderContext
( f
e da use
a sta se to
z C cen
q e
u le li
s
V ferab argument adds an XML string to the SOAP header of the
The CustomHeaderContext
e
e l ip rans
request.
F example,
For n -t to enable WS-Security login, add the string:
o
n<wsse:Security xmlns:wsse="http://schemas.xmlsoap.org/ws/2002/07/secext">
http://schemas.xmlsoap.org/ws/2002/07/secext
<wsse:UsernameToken xmlns:wsu="http://schemas.xmlsoap.org/ws/2002/07/utility">
<wsse:Username>WSUSER</wsse:Username>
<wsse:Password
Type="wsse:PasswordText">WSUSER</wsse:Password>
</wsse:UsernameToken>
</wsse:Security>

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Siebel Outbound Web Services


Chapter 14 - Page 21
Lesson Highlights

Lesson Highlights
Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

Outbound web services allow Siebel applications to invoke


a web service published by an external application
The web service is invoked by a proxy business service
Outbound web services are built by importing the published
WSDL
The outbound web service references the proxy business
a
service has )
lcl client
Outbound web services are administered in the Siebel
te uidtoe
Add a business service step to an integration e nworkflow
invoke the web service e z @ nt G
s q u tude
Inputs and outputs of the proxy
( f c vabusiness
h i s Sservice are
integration objects
e d a se t
s t a e to u
z Ca cens
s q ue le li
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Siebel Outbound Web Services


Chapter 14 - Page 22
Practice 14 Overview: Siebel Outbound Web Services

Practice 14 Overview:
Siebel Outbound Web Services
Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

This practice covers the following topics:


Creating an outbound proxy business service for an
external web service
Testing the proxy business service

s a
h a
l c l)
e nte uide
e z @ nt G
s q u tude
( f cva this S
e da use
a sta se to
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Siebel Outbound Web Services


Chapter 14 - Page 23
Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

s a
h a
l c l)
e nte uide
e z @ nt G
s q u tude
( f cva this S
e da use
a sta se to
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Siebel Outbound Web Services


Chapter 14 - Page 24
Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

s a
a
)h
c l
n t el ide
@ e G u
Overview of Data
ez den t
Federation
q u tu
v
Chaptera15s S
a (fc e this
a ed o us
a st se t
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Overview of Data Federation


Chapter 15 - Page 1
Overview of Data Federation
Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

Overview of Data Federation

s a
h a
l c l)
e nte uide
e z @ nt G
s q u tude
( f cva this S
e da use
a sta se to
z C cen
q e
u le li
s Copyright 2011, Oracle and/or its affiliates. All rights reserved.

e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Overview of Data Federation


Chapter 15 - Page 2
Objectives

Objectives
Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

After completing this lesson, you should be able to:


Describe the integration strategy of data federation
Identify the two major ways to implement data federation in
Siebel applications

s a
h a
l c l)
e nte uide
e z @ nt G
s q u tude
( f cva this S
e da use
a sta se to
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Overview of Data Federation


Chapter 15 - Page 3
Data Federation

Data Federation
Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

Is the combining of data from various data sources into


one single virtual data source or data service
Data can then be accessed, managed, and viewed as if it
were part of a single system
Is an integration strategy that allows Siebel CRM to access
data outside the Siebel application
Data appears to users to be within the Siebel application s a
Data can be edited as well as displayed l ) ha
Does not require copying and storing the data n t elctheide
within
@ e G u
Siebel database z n t
s q ue tude
( f cva this S
e da use
a sta se to
z C cen
q e
u le li
s ab Technologies: Siebel Enterprise Application Integration.
V ferPlatform
Reference: Integration
e
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Overview of Data Federation


Chapter 15 - Page 4
Advantages of Data Federation

Advantages of Data Federation


Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

Avoids duplicating large amounts of data in a Siebel


database
Avoids the need to handle a large amount of data traffic
resulting from:
Large volumes of data
Frequent updates
a
Avoids the overhead involved in invoking web services has
l)
n t elc ide
Data may be accessed directly from an external database
services u
rather than by invoking another applicationse
ez denlogic in an
Allows a Siebel application to use theubusiness
@ tG
q u
vas s St it
external application without re-implementing
(application fc i
a
For instance, the external
d e th might have special
s
ae newly
processing to validate
st se t o ucreated records
a
C cen
e z
u le li
s q
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Overview of Data Federation


Chapter 15 - Page 5
Data Federation

Data Federation
Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

Can be implemented by directly associating:


A table object definition with an external data source
External business component (EBC)
Distributed join
A business component object definition with an external data
source
Virtual business component (VBC)
s a
h a
l c l)
e nte uide
e z @ nt G
s q u tude
( f cva this S
e da use
sta se to
More

a
C cen
e z
u le li
s q
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Overview of Data Federation


Chapter 15 - Page 6
Siebel External Table

Siebel External Table


Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

Is a relational database table outside the Siebel database


Has a corresponding table object definition in the Siebel
repository
Has column definitions that map to columns in the external
table

s a
h a
l c l)
e nte uide
e z @ nt G
s q u tude
( f cva this S
e da use
a sta se to
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Overview of Data Federation


Chapter 15 - Page 7
External Business Component (EBC)

External Business Component (EBC)


Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

Is a business component that derives its data from an


external table
The base table property identifies the external table

s a
h a
l c l)
e nte uide
e z @ nt G
s q u tude
( f cva this S
e da use
a sta se to
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Overview of Data Federation


Chapter 15 - Page 8
Distributed Join

Distributed Join
Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

Is a join from a business component to an external table


The table property identifies the external table
Allows a single business component record to span
multiple databases

Example of data from external tables


joined into a Siebel business component
s a
h a
l c l)
e nte uide
e z @ nt G
s q u tude
(
Joinedf va data
caccount h i s S Joined contact data
Service request
d afrom external
e t
table from external table
e s
s t a e to u
z Ca cens
s q ue le li
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Overview of Data Federation


Chapter 15 - Page 9
Virtual Business Component (VBC)

Virtual Business Component (VBC)


Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

Is a business component that maps directly to an external


data source
Can access data from many types of external data
Files
Spreadsheets
Tables
s a
Other structured content
h a
Does not map to a table object l c l)
The base table property is blank e nte uide
e z @ nt G
Requires a business service to access
s q u data
t u dethe external
in
data source
( f cva this S
e da use
a sta se to
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Overview of Data Federation


Chapter 15 - Page 10
Business Component Behavior

Business Component Behavior


Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

Both VBCs and EBCs are similar to regular Siebel


business components
Manage data (create, retrieve, update, and delete records)
Can participate in business objects as parent or child
Can be exposed in applets
Can be configured with:
Validation properties s a

h a
Search and sort specifications
l c l)
e nte uide
e z @ nt G
s q u tude
( f cva this S
e da use
a sta se to
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Overview of Data Federation


Chapter 15 - Page 11
Limitations of EBCs and VBCs

Limitations of EBCs and VBCs


Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

Data resides outside of the Siebel database


Cannot be populated using EIM
These tables have no EIM or user tables in the Siebel database
Cannot be synchronized with mobile users
Data is not stored in the server database
Cannot be monitored with workflow policies
s
There are no tables in the Siebel database in which to install a

triggers h a
l c l)
e nte uide
e z @ nt G
s q u tude
( f cva this S
e da use
a sta se to
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Overview of Data Federation


Chapter 15 - Page 12
Additional Limitations

Additional Limitations
Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

Cannot participate in M:M relationships


EBCs can participate if the intersection and child table exist
in the same database instance
Cannot incorporate specialized business class logic or
processing
Must use CSSBusComp class for EBCs
Must use CSSBCVExtern class for VBCs s a
h a
l c l)
e nte uide
e z @ nt G
s q u tude
( f cva this S
e da use
a sta se to
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Overview of Data Federation


Chapter 15 - Page 13
Lesson Highlights

Lesson Highlights
Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

Siebel applications can obtain data from external sources


using:
External business components (EBCs) to obtain data from
external tables and columns
Virtual business components (VBCs) to obtain data from
other external sources, such as file or other structured data
s a
h a
l c l)
e nte uide
e z @ nt G
s q u tude
( f cva this S
e da use
a sta se to
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Overview of Data Federation


Chapter 15 - Page 14
Practice 15 Overview: Overview of Data Federation

Practice 15 Overview:
Overview of Data Federation
Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

This practice covers the following topics:


Examining several EBCs and VBCs used in as-delivered
Siebel applications to access data outside the Siebel
database

s a
h a
l c l)
e nte uide
e z @ nt G
s q u tude
( f cva this S
e da use
a sta se to
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Overview of Data Federation


Chapter 15 - Page 15
Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

s a
h a
l c l)
e nte uide
e z @ nt G
s q u tude
( f cva this S
e da use
a sta se to
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Overview of Data Federation


Chapter 15 - Page 16
Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

s a
h a
l c l)
e nte uide
External Business
e z @ nt G
Componentss q u tude
( f c va his S
e d aChapterse16 t
s t a e to u
z Ca cens
s q ue le li
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

External Business Components


Chapter 16 - Page 1
External Business Components
Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

External Business Components

s a
h a
l c l)
e nte uide
e z @ nt G
s q u tude
( f cva this S
e da use
a sta se to
z C cen
q e
u le li
s Copyright 2011, Oracle and/or its affiliates. All rights reserved.

e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

External Business Components


Chapter 16 - Page 2
Objectives

Objectives
Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

After completing this lesson, you should be able to:


Describe an external business component (EBC), its
purpose, structure, and limitations
Create and configure an EBC

s a
h a
l c l)
e nte uide
e z @ nt G
s q u tude
( f cva this S
e da use
a sta se to
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

External Business Components


Chapter 16 - Page 3
External Business Component

External Business Component


Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

Is a business component that derives its data from an


external table
Uses a standard Siebel database connector to access the
external table
Supported platforms include those supported for Siebel CRM
as specified in the System Requirements and Supported
Platforms (SRSP) Guide s a
l ) ha
n t elc ide
@ e G u
ez den t
s q u tu
v a S
a (fc e this
a ed o us
a st se t
z C cen
q e
u le li
Reference:V
s ab Technologies: Siebel Enterprise Application Integration:
erPlatform
Integration
l e
ip Business
External n f
sComponents
e
F n-t r a
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

External Business Components


Chapter 16 - Page 4
Structure of an External Business Component

Structure of an External Business Component


Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

An external business component is structured almost


identically to a regular business component
Major differences:
Must specify a Data Source
Some system fields may be unmapped Additional
property
s a
a
)h
c l
n t el ide
@ e G u
ez den t
s q u tu
v a S
a (fc e this
a ed o us
a st se t
z C cen
q e
u le li
s rab
ecomponent,
The externalVbusiness DQ NSA table BC, shown in the screenshot is used in the
i p e s f
Fel UCM n
Siebel Universal Customer Master (UCM) application as part of the integration between the
t r a
on- and cleansing services for Siebel data.
Siebel application and Informatica's Identity Resolution (IIR) application. IIR provides
datanmatching

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

External Business Components


Chapter 16 - Page 5
System Fields

System Fields
Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

Not all system fields in an external business component


are mapped to columns
External tables do not necessarily have all the Siebel-
required system columns (such as CREATED, LAST_UPD)
Only the Id field must be mapped

s a
h a
c l)Additional
n t l
e property i d e
@ e G u
ez den t
s q u tu
v a S
a (fc e this
a ed o us
a st se t
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

External Business Components


Chapter 16 - Page 6
Data Source Property

Data Source Property


Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

References a specification of the connection details to the


external table
Specifically refers to a DataSource defined in:
Profile configuration for Web client
.cfg file for Mobile and Developer Web clients

s a
h a
l c l)
e nte uide
e z @ nt G
s q u tude
( f cva this S
e da use
a sta se to
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

External Business Components


Chapter 16 - Page 7
DataSource

DataSource
Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

Includes a ConnectString parameter that refers to:


An Oracle TNS name for Oracle databases
An ODBC connection for MSSQL or IBM DB2 databases

s a
a
)h
c l
n t el ide
@ e G u
ez den t
s q u tu
v a S
Oracle connect strings refer a (fc e this
to Oracle instances rather
than ODBC connections ta
ed o us
a s se t
z C cen
q e
u le li
s ratheb screenshot, the external table is in a table space that is in the
e Vshown
In the example
f e in
samelidatabase
e s
p an(SIEBELDB) as the table space for the Siebel database.
F n-t r
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

External Business Components


Chapter 16 - Page 8
Creating an External Business Component

Creating an External Business Component


Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

1. Create an ODBC connection


2. Generate a schema file for the external table
3. Create the table object in the Siebel repository
4. Map system fields as required
5. Specify the data source
6. Create the external business component s a
h a
7. Identify the data source in the application
l c l)
e nte uide
z @ based
n t G
Example: Create an external business componente
u tude on
an external table that contains productss q
a for aSsupplier
f c v
( e th i s
d a
t a e to us More

C as nse
u e z lice
sq rable
e V fe
e l i p a n s
F n-t r
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

External Business Components


Chapter 16 - Page 9
1. Create an ODBC Connection

1. Create an ODBC Connection


Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

For Microsoft SQL Server or IBM DB2 databases, create


an ODBC connection to the external database system
Assign a unique name to the data source

s a
h a
l c l)
e nte uide
e z @ nt G
s q u tude
( f cva this S
e da use
a sta se to
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

External Business Components


Chapter 16 - Page 10
2. Generate a Schema File for the External Table

2. Generate a Schema File for the External Table


Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

Use a RDBMS vendor-supplied utility to generate a file that


specifies the schema of the external table

For example, use Oracle


Enterprise Manager to show the
DDL for a table, then copy and
s a
paste it into a text file
h a
l c l)
e nte uide
e z @ nt G
s q u tude
( f cva this S
e da use
a sta se to
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

External Business Components


Chapter 16 - Page 11
3. Create the Table Object in the Siebel Repository

3. Create the Table Object in the Siebel


Repository
Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

Use the External Table Schema Import wizard to import


the definition of the external table

Select from

s
DDL or ODBC a
h a
c
Specify prefix for
l l)
nte uide
object definitions
e
Select File > New
e z @ nt G
Object and click
External Table s q u tude
Schema Import
( f cva this S
e da use
a sta se to
z C cen
q e
u le li
For schemaV
s
select
source rabDDL or ODBC to match the source system.
e
ip rans f e
e
F n-tl
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

External Business Components


Chapter 16 - Page 12
3. Examine the Table and Columns Created

3. Examine the Table and Columns Created


Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

Generated column names are prefixed with X_


Column names in the external table are stored in the Alias
property

s a
h a
l c l)
Names of columns fromnte
external table e u ide
e z @ nt G
s q u tude
( f cva this S
e da use
a sta se to
z C cen
q e
u le li
s
eranab
The columnV names for external table generated by the External Table Schema Import
i p e s f
Fel n-tran
wizard are in the form X_<3-letter code>_<external table number>_<column number>.

no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

External Business Components


Chapter 16 - Page 13
4. Map System Fields as Required

4. Map System Fields as Required


Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

Identify the primary key column in the external table


Set System Field Mapping = Id
Map additional Siebel system fields as required

s a
a
)h
c l
n t el ide
@ e G u
ez den t
s q u tu
v a S
a (fc e this
a ed o us
a st se t
z C cen
q e
u le li
s
V ferabauditing regulations might require that the Updated and Updated By
In some implementations,
e
l
field be
e ippopulated
a n sas well.
F n-t r
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

External Business Components


Chapter 16 - Page 14
5. Specify the Data Source

5. Specify the Data Source


Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

Create a child Data Source object definition to specify the


external data source
Enter the name of the data source that you will configure

s a
h a
l c l)
e nte uide
e z @ nt G
s q u tude
( f cva this S
e da use
a sta se to
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

External Business Components


Chapter 16 - Page 15
6. Create the External Business Component

6. Create the External Business Component


Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

Create a business component object definition that refers


to the table object definition
Specify the data source for the Data Source property
Create single value fields as required

s a
h a
l c l)
e nte uide
e z @ nt G
s q u tude
( f cva this S
e da use
a sta se to
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

External Business Components


Chapter 16 - Page 16
7. Identify the Data Source in the Application

7. Identify the Data Source in the Application


Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

For Developer and Mobile Web clients add the data source
to .cfg files
Copy an existing data source and modify as required

s a
h a
Names of l c l)
data source in
e nte uide
the repository
e z @ nt G
s q u tude
( f cva this S
e da use
a sta se to
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

External Business Components


Chapter 16 - Page 17
7. Identify the Data Source in the Application

7. Identify the Data Source in the Application


Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

For the Siebel Web client, create a profile configuration


that refers to the data source
Navigate to Administration - Server Configuration >
Enterprises > Profile Configuration
Copy an existing record of subsystem type InfraDatasources
Modify the Profile and Alias fields
s a
h a
l c l)
e nte uide
e z @ nt G
s q u tude
( f cva this S
e da use
a sta se to
z C cen
q e
u le li
The value ofV
s
forethe
Alias
b must be the same as that used for the Data Source in
raprofile
e
ip the
configuring
l f
s business component.
external
n
e
F n-t r a
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

External Business Components


Chapter 16 - Page 18
7. Identify the Data Source in the Application

7. Identify the Data Source in the Application


Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

In the Profile Parameters applet, modify the profile


parameters as required
Modify and reconfigure object managers to refer to the
data source

s a
h a
l c l)
e nte uide
e z @ nt G
s q u tude
( f cva this S
e da use
a sta se to
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

External Business Components


Chapter 16 - Page 19
Using an External Business Component

Using an External Business Component


Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

An EBC can be configured similarly to regular business


components:
Add it to a business object
The external business component can be a child or a parent
business component
Create an applet that maps to it
Create a link that includes the EBC s a
h a
l c l)
e nte uide
e z @ nt G
s q u tude
( f cva this S
e da use
a sta se to
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

External Business Components


Chapter 16 - Page 20
Distributed Join

Distributed Join
Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

Allows a business component to display data from both a


Siebel and an external table
Is configured exactly the same way as a regular join
Need to know:
The foreign key field in the source business component
The primary key column in the target external table
s a
)h a
c l
n t el ide
@ e G u
ez den t
s q u tu
v
c this a S Primary key
a ( f column in
d
eForeign okey ufields e external table
a
a st sinesourcet BC
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

External Business Components


Chapter 16 - Page 21
Considerations

Considerations
Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

Creating associations with records in the external table:


Is required to support links for adding business components
to business objects
Requires identifying or creating columns in tables that can
serve as a foreign key
Requires identifying ways to populate such foreign key
columns
s a
h a
l c l)
e nte uide
e z @ nt G
s q u tude
( f cva this S
e da use
a sta se to
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

External Business Components


Chapter 16 - Page 22
Lesson Highlights

Lesson Highlights
Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

An external table refers to a table outside of the Siebel


database
Import a DDL using Siebel Tools
Add a data source property
Build an external business component based on the external
table
OR s a
h a
Join data from the external table to an existing business
l c l)
component
e nte u ide
G
ez@
An external business component requires:
q u d e n t
A data source
v a s S tu
An external table
a (fc e this
At least the Id system
a edfieldo us
a st se t
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

External Business Components


Chapter 16 - Page 23
Practice 16 Overview: External Business Components

Practice 16 Overview:
External Business Components
Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

This practice covers the following topics:


Creating an external business component based on a table
in another relational database
Displaying the records from the external table in a Siebel
application

s a
h a
l c l)
e nte uide
e z @ nt G
s q u tude
( f cva this S
e da use
a sta se to
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

External Business Components


Chapter 16 - Page 24
Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

s a
h a
l c l)
e nte uide
Virtual Business
e z @ nt G
Componentss q u tude
( f c va his S
e d aChapterse17 t
s t a e to u
z Ca cens
s q ue le li
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Virtual Business Components


Chapter 17 - Page 1
Virtual Business Components
Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

Virtual Business Components

s a
h a
l c l)
e nte uide
e z @ nt G
s q u tude
( f cva this S
e da use
a sta se to
z C cen
q e
u le li
s Copyright 2011, Oracle and/or its affiliates. All rights reserved.

e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Virtual Business Components


Chapter 17 - Page 2
Objectives

Objectives
Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

After completing this lesson, you should be able to:


Describe a virtual business component (VBC), its
structure, and its limitations
List the methods the supporting business service must
implement
Configure a VBC
s a
h a
l c l)
e nte uide
e z @ nt G
s q u tude
( f cva this S
e da use
a sta se to
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Virtual Business Components


Chapter 17 - Page 3
Virtual Business Component (VBC)

Virtual Business Component (VBC)


Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

Is a business component that derives its data from an


external data source, such as:
Files
Spreadsheets
Tables
Does not reference a table object definition in the Siebel
repository s a
h
) a
Uses a business service for: lcl te e
n id
Data access and manipulation e
z@ ent Gu
Data mapping u e
q Stud
Data transport v a s
a (fc e this
a ed o us More

a st se t
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Virtual Business Components


Chapter 17 - Page 4
Data Access and Manipulation

Data Access and Manipulation


Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

The supporting business service may provide these


methods for data access
Init
Required
Query
Preinsert
Insert
Update
Optional
s a
h a
Delete l c l)
e nte uide
e z @ nt G
s q u tude
( f cva this S
e da use
a sta se to
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Virtual Business Components


Chapter 17 - Page 5
Required Methods

Required Methods
Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

The business service must implement:


Init
Query

Init Invoked when the VBC is instantiated


Returns a list of fields from the external data source
s a
Query Invoked when the user navigates to an applet based h a
on the VBC or queries in the applet l c l)
e ntethe query
Returns a list of fields and values matching u ide
e z @ nt G
s q u tude
( f cva this S
e da use
a sta se to
z C cen
q e
u le li
s
Init: e V ferab
e l ip rawhen
n s
F n-t
Invoked the VBC is instantiated.
o a list of fields from the external data source.
nReturns

Query:
Invoked when the user navigates to an applet based on the VBC or queries in the applet.
Returns a list of fields and values matching the query.

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Virtual Business Components


Chapter 17 - Page 6
Optional Methods

Optional Methods
Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

Implement the methods required to meet the business


needs

Preinsert Invoked when the user creates a new record


Returns any default values for fields in the record

Insert Invoked when the user saves a new record a


Returns the fields inserted
h a s
l c l)
Update Invoked when the user updates an existing
e nterecorduide
Returns all fields with update status
e z @ nt G
s q u tude
Delete cvadeletes
Invoked when thefuser
( t h i saSrecord
Returns thed
e a ofsthe
values e deleted record
u
a sta se to
z C cen
q e
u le li
s
erab
e V f
Preinsert:
l i p n s
F e Invoked
n - trawhen the user creates a new record.
o any default values for fields in the record.
nReturns

Insert:
Invoked when the user saves a new record.
Returns the fields inserted.

Update:
Invoked when the user updates an existing record.
Returns all fields with update status.

Delete:
Invoked when the user deletes a record.
Returns the values of the deleted record.

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Virtual Business Components


Chapter 17 - Page 7
Business Services

Business Services
Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

A virtual business component can use either:


The XML Gateway business service
A custom business service

s a
h a
l c l)
e nte uide
e z @ nt G
s q u tude
( f cva this S
e da use
sta se to
More
a
C cen
e z
u le li
s q
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Virtual Business Components


Chapter 17 - Page 8
XML Gateway Business Service

XML Gateway Business Service


Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

Is an as-delivered Siebel business service


Provides all the data access methods
Can use these transports:
HTTP
IBM MQ Message Queue Series
Microsoft MSMQ Message Queues
s a
Does not transform data structures h a
The target application or middleware must performl
anyc l)
required mapping e nte uide
e z @ nt G
s q u tude
( f cva this S
e da use
a sta se to
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Virtual Business Components


Chapter 17 - Page 9
Custom Business Service

Custom Business Service


Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

Is created by the customer


Is based on the CSSService class
Contains custom script in the ServicePreInvokeMethod to
implement methods
Must include Init and Query methods
May also include Update, PreInsert, Insert, and Delete
a
methods
) has
lcl
Can be written in eScript or Siebel Visual Basic (VB)
te d e
Can connect to the external data source via:en u i
e z @ nt G
COM interfaces
s q u tude
SQL functions using an ODBC
( f c vaconnection
h i s S

d a business
Consider using an external e t component instead
e s
s t a e to u
z Ca cens
s q ue le li
V Object
The Component
f e ab (COM) was introduced by Microsoft as a language-independent
rModel
method
l e n s objects such that they can be used in multiple environments.
ipof implementing
e
F n-t r a
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Virtual Business Components


Chapter 17 - Page 10
Custom Business Service Considerations

Custom Business Service Considerations


Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

Use a custom business service when:


The external application cannot handle the XML produced by
the XML Gateway business service
The external source is an RDBMS table that is not supported
for external business components
The external source is a document or file
s a
h a
l c l)
e nte uide
e z @ nt G
s q u tude
( f cva this S
e da use
a sta se to
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Virtual Business Components


Chapter 17 - Page 11
Creating a Virtual Business Component

Creating a Virtual Business Component


Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

1. Create a business component


2. Create fields for the VBC
3. Create the custom business service if necessary
4. Associate the business service with the VBC
5. Implement the methods (custom service)
OR a
h a s
Configure the target (XML Gateway) l)
l c
e nte uide
Example: Create a VBC that displays credit z @ approval
card n t G
q e
u tude
details s
( f cva this S
e da use More

a sta se to
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Virtual Business Components


Chapter 17 - Page 12
1. Create a Business Component

1. Create a Business Component


Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

Create the new business component object definition


Set the Class property to CSSBCVExtern
Required to support VBCs
Do not specify a Table property
Do not specify a Data Source

s a
h a
l c l)
e nte uide
e z @ nt G
q e No data
uto tNoudtable
s
Change class

( f cva this S specified source


CSSBCVExtern

e da use
a sta se to
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Virtual Business Components


Chapter 17 - Page 13
2. Create Fields for the VBC

2. Create Fields for the VBC


Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

Create a single value field for each field in the data source
Field names do not have to match the external field names
Caveat: When scripting a new business service it may be easier
if the names do match
Names are used as element tags in the integration message
Names should conform to XML specifications

s a
h a
l c l)
e nte uide
z @ the column
Leave
n t G
q e deblank
u property
s t u
( f cva this S
e da use
a sta se to
z C cen
q e
u le li
s rabblank.
e V property
Leave the column
f e
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Virtual Business Components


Chapter 17 - Page 14
3. Create the Custom Business Service if Necessary

3. Create the Custom Business Service if


Necessary
Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

Create a new business service


Set Class property to CSSService
Specify the desired methods and their arguments

s a
h a
l c l)
e nte uide
e z @ nt G
Only Init and Queryas
qu Stude
f cv this
methods are (required;

e da optional
others are
u se
a sta se to
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Virtual Business Components


Chapter 17 - Page 15
4. Associate the Business Service with the VBC

4. Associate the Business Service with the VBC


Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

Create a Service Name business component user property


to specify the business service
Your custom service OR
XML Gateway

s a
h a
l c l)
e nte uide
e z @ nt G
s q u tude
( f cva this S
e da Nameu sofebusiness service
a sta se to
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Virtual Business Components


Chapter 17 - Page 16
4. Associate the Business Service with the VBC

4. Associate the Business Service with the VBC


Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

Create a Service Parameters user property to specify


arguments that are passed into the business service
For instance, the XML Gateway service requires additional
parameters to completely specify the transport
VBC that uses XML Gateway
business service

s a
a
)h
c l
n t el ide
@ e G u
ez den t
s q u tu
v a S
a (fc e this
a edfor o us
Additional parameters required

a st se t
XML Gateway business service

z C cen
q e
u le li
The serviceV
s
eraconsist
parameters
b of a sequence of Name=Value pairs. Each parameter
specifies
l e
ip an input
n f
smethod argument and its value. In the example in the slide, the XML
e
F n-t
Gateway r a
business service uses HTTP transport; accordingly additional parameters specifying
no URL and the HTTP method are provided.
the target

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Virtual Business Components


Chapter 17 - Page 17
5. Implement the Methods (Custom Service)

5. Implement the Methods (Custom Service)


Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

Develop a script to implement the methods required to


support the VBC
Scripts handle data mapping between the VBC fields and
external fields

s a
h a
l c l)
e nte uide
e z @ nt G
s q u tude
( f cva this S
e da use
a sta se to
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Virtual Business Components


Chapter 17 - Page 18
5. Configure the Target (XML Gateway)

5. Configure the Target (XML Gateway)


Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

Create processing on the target (external application or


middleware) to:
Parse the Siebel-formatted XML messages and execute the
specified processing
Init and Query methods must be supported
Transform from Siebel data structures to external data
structures as required a
Return the required response has l)
n t elc ide
@ e G u
ez den t
s q u tu
v a S
a (fc e this
a ed o us
a st se t
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Virtual Business Components


Chapter 17 - Page 19
Using a Virtual Business Component

Using a Virtual Business Component


Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

A VBC can be used in other object configuration such as:


Adding it to a business object
The external business component can be a child or a parent
business component
Creating a link
Creating an applet that maps to it
Considerations s a
h
) a
Managing the primary keys for records in the external
l c ldata
source when creating new records
e nte uide
Incorporating foreign keys in external records
z G
@ thatntreference
Siebel data q e
u tude
s
( f cva this S
e da use
a sta se to
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Virtual Business Components


Chapter 17 - Page 20
Restrictions on Virtual Business Components

Restrictions on Virtual Business Components


Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

VBCs:
Cannot be extracted to mobile clients
Do not support many-to-many relationships
Cannot contain MVGs
Applets based on VBCs must use CSSFrame (Form) and
CSSFrameList (List) as their base classes
s a
h a
l c l)
e nte uide
e z @ nt G
s q u tude
( f cva this S
e da use
a sta se to
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Virtual Business Components


Chapter 17 - Page 21
Lesson Highlights

Lesson Highlights
Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

Virtual business components (VBCs) use business


services to access data outside the Siebel database
Files
Spreadsheets
Tables
To create a VBC:
Create a business component with no base table and add as
a
fields c l )h
n
Create a custom business service, if necessary t el ide
e
@ nt G u

e z
Can use the XML Gateway service to send/receive raw XML
u tude
s q
The custom service must support Init and Query methods
cinvathethbusiness
is S components

( f
Specify the business service
user properties
e da use
ta eservice,
For the XMLsGateway
a to include the transport parameters
C cens

z
ue le li
s q
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Virtual Business Components


Chapter 17 - Page 22
Practice 17 Overview: Virtual Business Components

Practice 17 Overview:
Virtual Business Components
Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

This practice covers the following topics:


Creating a virtual business component using a custom
business service
Exposing the virtual business component in an applet to
display records from the external data source

s a
h a
l c l)
e nte uide
e z @ nt G
s q u tude
( f cva this S
e da use
a sta se to
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Virtual Business Components


Chapter 17 - Page 23
Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

s a
h a
l c l)
e nte uide
e z @ nt G
s q u tude
( f cva this S
e da use
a sta se to
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Virtual Business Components


Chapter 17 - Page 24
Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

s a
a
)h
c l
n t el ide
@ e G u
Embedding e zWeb
e n t
Content in a
Siebel s u
q Stud
View
a
cv 18 this
( f
e da use
Chapter

a sta se to
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Embedding Web Content in a Siebel View


Chapter 18 - Page 1
Embedding Web Content in a Siebel View
Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

Embedding Web Content in a Siebel View

s a
h a
l c l)
e nte uide
e z @ nt G
s q u tude
( f cva this S
e da use
a sta se to
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Embedding Web Content in a Siebel View


Chapter 18 - Page 2
Objectives

Objectives
Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

After completing this lesson, you should be able to:


Explain how external web content is displayed in a Siebel
application
Configure an applet to display a web page

s a
h a
l c l)
e nte uide
e z @ nt G
s q u tude
( f cva this S
e da use
a sta se to
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Embedding Web Content in a Siebel View


Chapter 18 - Page 3
Displaying External Web Content

Displaying External Web Content


Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

Applets can be configured to embed web content from an


external source
Such applets can be displayed in:
Aggregate views
Detail views

s a
h a
l c l)
e nte uide
e z @ nt G
s q u tude
( f cva this S
e da use More

a sta se to
z C cen
q e
u le li
Reference:V
s
Portal
Siebel rabFramework Guide: Integrating External Content
e
ip rans f e
e l
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Embedding Web Content in a Siebel View


Chapter 18 - Page 4
Aggregate View

Aggregate View
Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

Consists of a single applet with external web content


Example: The My Jobs view displays a web page from the
BI Publisher reports server with a list of scheduled jobs

s a
h a
c
Users can navigate
l l) in this
t
web page
n ethe reports
as if e
idserver
they are
e
directly
@ nt G
in u
e z
u tude
s q
( f cva this S
e da use
a sta se to
z C cen
q e
u le li
s ratheb Oracle BI Publisher reports server application is installed..
V when
This view appears
e f e
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Embedding Web Content in a Siebel View


Chapter 18 - Page 5
Detail View

Detail View
Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

Consists of a regular form applet and a second applet that


displays web content specific to the selected record

s a
h a
l c l)
nte record ide
Web content corresponds
e
to the selected
@ nt G u
e z
u tude
s q
( f cva this S
e da use
a sta se to
z C cen
q e
u le li
s rabcreated using the portal framework.
This view isV
a customeview
l e
ip rshows
n f
s Google maps as a child applet showing the address for the account.
Theeexample a
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Embedding Web Content in a Siebel View


Chapter 18 - Page 6
Key Concepts

Key Concepts
Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

Symbolic URL
Business component field
Specialized applet

s a
h a
l c l)
e nte uide
e z @ nt G
s q u tude
( f cva this S
e da use More

a sta se to
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Embedding Web Content in a Siebel View


Chapter 18 - Page 7
Symbolic URL

Symbolic URL
Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

Is an alias that specifies the URL for the connection to the


external content
Allows multiple fields to easily reference the same content
Allows the host name or other URL details to be maintained
in a single location
Is administered in the Siebel client by navigating to
Administration - Integration > WI Symbolic URL List s a
h a
l c l)
e nte uide
e z @ nt G
s q u tude
( f cva this S
Actual URL ed
a se
a e to u

Symbolic URL
s t
z Ca cens
s q ue le li
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Embedding Web Content in a Siebel View


Chapter 18 - Page 8
Business Component Field

Business Component Field


Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

A business component includes a calculated field whose


value references the symbolic URL

s a
h a
l c l)
e nte uide
e z @ nt G
s q t u dethe
u References
( f cva this symbolic
S URL
e da use
a sta se to
z C cen
q e
u le li
s b
e Vquotation
You must use
f e ramarks.
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Embedding Web Content in a Siebel View


Chapter 18 - Page 9
Specialized Applet

Specialized Applet
Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

An applet with a single control displays the web content


Typically a list applet with a single column is used
Allows full width of the applet for display of content
Class must be set to CSSFrameListWeb
List column references the business component field
Field Retrieval Type must be set to Symbolic URL
s a
h a
l c l)
e nte uide
z @ nMust t Gbe set to
theq
e
Field that references
u URL de Symbolic URL
s symbolic
t u
( f cva this S
e da use
a sta se to
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Embedding Web Content in a Siebel View


Chapter 18 - Page 10
Display External Web Content in a Siebel Application

Display External Web Content in a Siebel


Application
Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

1. Determine the required URL


2. Add a field to the business component
3. Create the applet
4. Create the view
5. Add the view to a screen
6. Complete the configuration a
h a s
7. Administer the symbolic URL l)
l c
e nte uide
z
Example: Configure a detailed view that includes t G that
@ annapplet
q e
u tude
displays stock quote information s
( f cva this S
e da use More

a sta se to
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Embedding Web Content in a Siebel View


Chapter 18 - Page 11
Display External Web Content in a Siebel Application (Real-Time
Quotes)

Display External Web Content in a Siebel


Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

Application (Real-Time Quotes)

s a
a
)h
c l
n t el ide
@ e G u
e z e n tReal-time content

s q u t u d for Account =finance


from Yahoo

c v a is S ORCL

a f
( e th
d
e to us
t a
C as nse
u e z lice
sq rable
e V fe
l i p
The example
e n
shows
a s an account form applet at the top. At the bottom is an applet that displays
n r
aFYahoo finance
-t page with the stock quote that corresponds to the account record.
n o

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Embedding Web Content in a Siebel View


Chapter 18 - Page 12
1. Determine the Required URL

1. Determine the Required URL


Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

In a browser examine the URL that retrieves the desired


web page
Identify any additional arguments (name, value pairs) that
need to be part of the URL
Arguments appear after the "?"
Actual URL Account parameter to be added to
the URL (parameter name = s)
s a
h a
l c l)
e nte uide
e z @ nt G
s q u tude
( f cva this S
e da use
a sta se to
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Embedding Web Content in a Siebel View


Chapter 18 - Page 13
2. Add a Field to the Business Component

2. Add a Field to the Business Component


Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

Identify the relevant business component


Create a calculated field in the business component to
reference the external web content
Set the calculated value to a quoted string
The value in the string will be administered as a symbolic URL
Set type to DTYPE_TEXT
s a
h a
l c l)
e nte uide
e z @ nt G
s q u tude
( f cva this S
e da use Symbolic URL (must
a sta se to be quoted)

z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Embedding Web Content in a Siebel View


Chapter 18 - Page 14
3. Create the Applet

3. Create the Applet


Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

Use the List Applet wizard to create the applet

s a
h a
l c l)
e nte uide
e z @ nt G
s q u tude
( f cva this S
e da use
a sta se to
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Embedding Web Content in a Siebel View


Chapter 18 - Page 15
3. Assign a Web Template

3. Assign a Web Template


Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

Assign an appropriate web template


Suggestion: use the ePortal URL Applet template

s a
h a
l c l)
e nte uide
e z @ nt G
s q u tude
( f cva this S
e da use
a sta se to
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Embedding Web Content in a Siebel View


Chapter 18 - Page 16
3. Map the Field

3. Map the Field


Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

Select the business component field that references the


symbolic URL

s a
h a
l c l)
e nte uide
e z @ nt G
s q u tude
( f cva this S
e da use
a sta se to
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Embedding Web Content in a Siebel View


Chapter 18 - Page 17
3. Delete the Controls

3. Delete the Controls


Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

De-assign the controls assigned by default


These applets do not require controls

s a
h a
l c l)
e nte uide
Move all Select
e z @ nt G
Controls to the
Available Controls list sq
u tude
( f cva this S
e da use
a sta se to
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Embedding Web Content in a Siebel View


Chapter 18 - Page 18
3. Adjust the Applet Class

3. Adjust the Applet Class


Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

Complete the wizard configuration


Change the default applet class to CSSFrameListWeb

s a
h a
l c l)
e nte uide
e z @ nt G
s q u tude
( f cva this S
e da use
a sta se to
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Embedding Web Content in a Siebel View


Chapter 18 - Page 19
3. Modify the Default List Column Configuration

3. Modify the Default List Column Configuration


Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

Set Field Retrieval Type = Symbolic URL


Indicates that source of data for the field is external web
content
Set HTML Display Mode = DontEncodeData to make sure
that reserved HTML characters in the content are passed
to the browser
s a
h a
l c l)
e nte uide
e z @ nt G
s q u tude
( f cva this S
e da use
a sta se to
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Embedding Web Content in a Siebel View


Chapter 18 - Page 20
4. Create the View

4. Create the View


Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

Create a view
Add one or more applets to the view

s Web content a
h a applet
l c l)
e nte uide
e z @ nt G
s q u tude
( f cva this S
e da use Reuse an existing
a
st se t o form applet
a
C cen
e z
u le li
s q
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Embedding Web Content in a Siebel View


Chapter 18 - Page 21
5. Add the View to the Screen

5. Add the View to the Screen


Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

Create a new screen view object definition

s a
h a
l c l)
e nte uide
e z @ nt G
s q u tude
( f cva this S
e da use
a sta se to
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Embedding Web Content in a Siebel View


Chapter 18 - Page 22
6. Complete the Configuration

6. Complete the Configuration


Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

Compile all new and modified object definitions


Administer the new view in the Siebel client

s a
h a
l c l)
e nte uide
e z @ nt G
s q u tude
( f cva this S
e da use
a sta se to
z C cen
q e
u le li
Navigate to V
s
erab- Application > Views.
Administration
l i p e n s f
Fe n-tra
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Embedding Web Content in a Siebel View


Chapter 18 - Page 23
7. Administer the Symbolic URL

7. Administer the Symbolic URL


Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

In the Siebel client, navigate to Administration - Integration


> WI Symbolic URL List > Symbolic URL Administration
Create a new record and set:
Name = Symbolic URL value used in the field properties
URL = the target URL
SSO Disposition = IFrame
s a

h a
Displays retrieved web content in its own separate frame
l c l)
e nte uide
e z @ nt G
s q u tude
( f cva this S
e da use
a sta se to
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Embedding Web Content in a Siebel View


Chapter 18 - Page 24
7. Administer the Symbolic URL

7. Administer the Symbolic URL


Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

In the Symbolic URL Arguments applet, add arguments:


iframe command to specify the size of the frame
Additional arguments to be appended to the URL
IsrecordSensitive command to reload the applet when the
record changes

s a
h a
l c l)
e nte uide
e z @ nt G
s q u tude
( f cva this S
e da use Appends the name of the

s t a e to account to the URL

z Ca cens
s q ue le li
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Embedding Web Content in a Siebel View


Chapter 18 - Page 25
Test the Configuration

Test the Configuration


Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

Refresh the symbolic URLs


Log out of the Siebel client
Log back into the Siebel client
Create several test accounts
Set Name to a stock symbol

s a
h a
l c l)
e nte uide
e z @ nt G
s q u tude
( f cva this S
e da use
a sta se to
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Embedding Web Content in a Siebel View


Chapter 18 - Page 26
Test the Configuration

Test the Configuration


Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

Select an account and navigate to the AAA Stock Info view

s a
h a
l c l)
e nte uide
e z @ nt G
s q u tude
( f cva this S
e da use
a sta se to
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Embedding Web Content in a Siebel View


Chapter 18 - Page 27
Test the Configuration

Test the Configuration


Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

Navigate to another account and verify that the portal


applet is updated with the corresponding stock information

s a
h a
l c l)
e nte uide
e z @ nt G
s q u tude
( f cva this S
e da use
a sta se to
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Embedding Web Content in a Siebel View


Chapter 18 - Page 28
Considerations

Considerations
Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

Symbolic URLs in the Dedicated Web Client


Host aliases

s a
h a
l c l)
e nte uide
e z @ nt G
s q u tude
( f cva this S
e da use More

a sta se to
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Embedding Web Content in a Siebel View


Chapter 18 - Page 29
Symbolic URLs in the Dedicated Web Client

Symbolic URLs in the Dedicated Web Client


Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

Note for the Developer Web Client, the symbolic URL is


appended with _Demo
Suffix is specified in the client.cfg file

s a
h a
l c l)
e nte uide
e z @ nt G
s q u tude
( f cva this S
e da use
a sta se to
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Embedding Web Content in a Siebel View


Chapter 18 - Page 30
Host Aliases

Host Aliases
Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

URLs can be specified using a host alias


Useful when there are multiple symbolic URLS that reference
the same host
Use the Host Administration view to specify host aliases

s a
h a
l c l)
e nte uide
e z @ nt G
s q u tude
( f cva this S
e da use
a sta se to
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Embedding Web Content in a Siebel View


Chapter 18 - Page 31
Lesson Highlights

Lesson Highlights
Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

Applets can be configured to display external web content


Enabled using:
Symbolic URLs (alias for the address of the external content)
Calculated fields in a business component that references the
symbolic URL
Applets that display web content:
Have a single list column/control s a
h a
Require the CSSFrameListWeb class
l c l)
Use one of the ePortal Web templates
e nte uide
Symbolic URLs are administered in theez @ Client
Siebel n t G
s
Can add arguments to the symbolicq uURL tude
( f cva this S
e da use
a sta se to
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Embedding Web Content in a Siebel View


Chapter 18 - Page 32
Practice 18 Overview: Embedding Web Content in a Siebel View

Practice 18 Overview:
Embedding Web Content in a Siebel View
Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

This practice covers the following topics:


Configuring an aggregate view to display a web page
Configuring a detail view to display record-specific web
content

s a
h a
l c l)
e nte uide
e z @ nt G
s q u tude
( f cva this S
e da use
a sta se to
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Embedding Web Content in a Siebel View


Chapter 18 - Page 33
Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

s a
h a
l c l)
e nte uide
e z @ nt G
s q u tude
( f cva this S
e da use
a sta se to
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Embedding Web Content in a Siebel View


Chapter 18 - Page 34
Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

s a
a
)h
c l
n t el ide
@ e G u
Embedding e zSiebel
e n t
Content in
an External
s u t ud
q SApplication
a
cv 19 this
( f
e da use
Chapter

a sta se to
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Embedding Siebel Content in an External Application


Chapter 19 - Page 1
Embedding Siebel Content in an External Application
Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

Embedding Siebel Content in an External


Application
s a
h a
l c l)
e nte uide
e z @ nt G
s q u tude
( f cva this S
e da use
a sta se to
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Embedding Siebel Content in an External Application


Chapter 19 - Page 2
Objectives

Objectives
Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

After completing this lesson, you should be able to:


Use the XML Interface of the Siebel Web Engine (SWE) to
deliver content to external applications

s a
h a
l c l)
e nte uide
e z @ nt G
s q u tude
( f cva this S
e da use
a sta se to
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Embedding Siebel Content in an External Application


Chapter 19 - Page 3
Options for Embedding Siebel Content in External Applications

Options for Embedding Siebel Content in External


Applications
Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

Use Siebel inbound web services


Discussed in a previous lesson
Use the Siebel XML Web Interface
Subject of this lesson

s a
a
)h
c l
n t el ide
@ e G u
ez den t
s q u tu
v a S
a (fc e this
a ed o us
a st se t
z C cen
q e
u le li
s rab options, such as programmatic access to Siebel data, are
V feAdditional
Additional Options:
e
beyond
e l ipthe scope
a n sof this course, and are not discussed here.
F n-t r
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Embedding Siebel Content in an External Application


Chapter 19 - Page 4
Review: Rendering a Siebel Web Application

Review: Rendering a Siebel Web Application


Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

Recall: To render a Siebel Web application:


The user navigates within the application using a supported
web browser
For example, navigate to the Account List View
The Siebel Web Server Extension (SWSE), installed on the
web server, forwards the request to a Siebel Server that has
the appropriate application object manager (AOM) running s a
For example, the Call Center Object Manager

l ) ha
The AOM includes a Siebel Web Engine (SWE)tfor
c e
elcorrectly
e n u id
formatting the response
z@ views,n t G
The SWE formats a response using q u e
applets, d e and web
s t u
templates
( f cva this S
The SWE generates the
e daresponse
u s e and returns it to the
SWSE, that forwards
a sta siteontoto the user
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Embedding Siebel Content in an External Application


Chapter 19 - Page 5
The Siebel Web Engine XML Web Interface

The Siebel Web Engine XML Web Interface


Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

Provides access to Siebel business applications through


the Siebel Web Engine
Requests sent to the web server are forwarded to the AOM
The AOM's SWE returns XML, rather than HTML
Exposes Siebel data at the user interface (UI) level
For example, applets, views, and Siebel web templates may
be accessed using the XML Web Interface s a
h a
XSL stylesheets provided with the Siebel application
l c l) be
may
used as-is or modified to format the data nte uide e
z@user
Supports the same business logic as ifethe t using
were
n G
u d e
the HTML UI asq Stu v
a e t his fields, and so
(fcpre-populated
For example, required fields,
forth ed us
a sta se to
z C cen
q e
u le li
Reference:V
s ab to External Web Applications" in the Siebel Portal Framework
erContent
"Delivering
Guide.
l e
ip rans f
e
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Embedding Siebel Content in an External Application


Chapter 19 - Page 6
Architecture: Application Request

Architecture: Application Request


Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

When an application requests Siebel data:


1. The application sends a request to the Siebel Web Server
For example, "Provide me with an account list", or "Update
these fields for this contact"
2. The Siebel Web Server forwards the request to the
appropriate application object manager (AOM)
a
2. The Siebel Web Serverl) h
as
1. The application sends a
forwards the request to c e
elthe
request to the Siebel Web Server
n
application object
e t
manager
u id
z@ enSiebel t G
External u e
Application Siebel asq
S t ud Enterprise
Webcv
(f e this
Server
a
a ed o us
a st se t
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Embedding Siebel Content in an External Application


Chapter 19 - Page 7
Architecture: Siebel CRM Response

Architecture: Siebel CRM Response


Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

The Siebel Enterprise responds:


3. The SWE responds with a web template, view, applet, and
data
Formats data into XML or HTML
4. The SWE returns the XML or HTML through the web server
5. (Not shown) The external application displays the data to
the user s a
For example, it may transform the data using a stylesheet ) a
hand
l
elc ide

then display Siebel fields in an external application


e n t u
@ t G
External
q u ez deEnterprise
nSiebel
Application Siebel
Web vas 3. The AOM's
S tu SWE responds
(fc e thiswith XML or HTML
Server
a
a edServeroreturns
us the response
t
4. The Siebel
as nse
Web t
C
z lice
u e
sq rable
e V fe
e l i p a n s
F n-t r
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Embedding Siebel Content in an External Application


Chapter 19 - Page 8
Invoking the XML Web Interface

Invoking the XML Web Interface


Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

To invoke the XML Web Interface:


Create a custom AOM that returns all requests in XML
OR
Add XML interface parameters to the URL
OR
Add an XML request to the body of an HTTP post command
to the Siebel Web Server
s a
Parsing the response and displaying it in an externall)userh a
interface is beyond the scope of this course ntel
c e
e u id
@ nt
Implementation depends on the externalzapplicationG
q u e de
The practice shows one such implementation
s t u
( f cva this S
e da use More

a sta se to
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Embedding Siebel Content in an External Application


Chapter 19 - Page 9
Customize the AOM

Customize the AOM


Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

To create a custom application object manager to provide


XML responses to all requests:
Copy an existing AOM
In the component parameters, set MarkupLanguage=XML
Modify eapps.cfg and the web server to enable the additional
object manager
The external application then uses XSL stylesheets to as a
display the Siebel data c l )h
n t
Example: This technique is used by Siebel wireless el to ide
@ e G u
allow a wide array of devices to display n t
ezSiebeleapplications
s q u tud
( f cva this S
e da use
a sta se to
z C cen
q e
u le li
s b
e V feraCommands
Command Precedence: passed in the URL take precedence over those set as

e p an
AOMliparameters; sfor example, if a user added a SWESetMarkup=HTML command to the end
F n-t
of the URL, r
this would take precedence over the MarkupLanguage parameter of the AOM.
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Embedding Siebel Content in an External Application


Chapter 19 - Page 10
Example: Siebel Sales Wireless

Example: Siebel Sales Wireless


Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

The Siebel Sales Wireless (ENU)


s a
AOM has MarkupLanguage=XML a
)h
c l
n t el ide
@ e G u
ez den t
q u
s The S tu
v a application is rendered using

a (fc e this stylesheets,


the returned XML and XSL

e d us and looks very

sta se to
different from the "standard" UI
a
C cen
e z
u le li
s q b
V - Server
In Administration
e f e raConfiguration > Enterprises > Component Definitions, the Siebel
p
SalesliWireless
e -tran s
(ENU) AOM has MarkupLanguage = XML.
F
non and looks very different from the "standard" user interface.
The Siebel Sales Wireless application is rendered using the returned XML and XSL
stylesheets

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Embedding Siebel Content in an External Application


Chapter 19 - Page 11
Add Commands to the URL

Add Commands to the URL


Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

The Siebel Web Engine supports appending commands to


the end of the URL; for example:
SWECmd
Used to perform specific commands, for example, ExecuteLogin
or GotoView
SWEUserName and SWEPassword
Used in combination with SWECmd=ExecuteLogin to log in to s a

the application object manager a


)h
c l
SWEView
n t el ide
Used in combination with SWECmd=GotoView @ eto navigate
G u to a

specific view ez den t


s q u tu
SWEMethod v a S
Execute a method before a fc tdata;
(returning
e his for example,
ed o utosperform a query


SWEMethod=ExecuteQuery
a
a st se t
z C cen
q e
u le li
s
ofrmost ab commonly-used SWE commands, see "Delivering Content to
Reference:VFor a liste
l
External
e n s f
ip WebraApplications" in the Siebel Portal Framework Guide.
e
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Embedding Siebel Content in an External Application


Chapter 19 - Page 12
Add Commands to the URL

Add Commands to the URL


Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

Some commands more specific to the XML Interface are:


SWESetMarkup
Set to XML, HTML, or WML to specify response format
SWEDataOnly
Set to 1 to avoid returning applet or view rendering information;
for example, menu items, button commands, and so forth
The applet and view names and column headers are always s a
h
returned to assist in searching for and formatting dataa
l c l)
SWESetNoTempl
e n te uide

e z @ nt G
Set to 1 to avoid returning web template information
SWEXslStyleSheet
s q u tude
Specify a style sheet to apply

( f cvtoathethXML
is S
e da use
a sta se to
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Embedding Siebel Content in an External Application


Chapter 19 - Page 13
Example 1: Raw XML

Example 1: Raw XML


Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

The URL
http://localhost/callcenter_enu/start.swe?SWECmd=Goto
View&SWEView=Account+Detail+-
+Contacts+View&SWEDataOnly=1&SWESetMarkup=XML

Produces raw XML as its output:


s a
)h aAdding &SWESetMarkup=XML

c l to the URL generates a raw

n t el ide XML response

@ e G u
eThez raw datae t
n includes the
q u
s application d XML
u name, screen, view,
tapplet(s),
v a
c this S
and along with the
( f
da use
Siebel data

e
a sta se to
z C cen
q e
u le li
s
ertheabapplication name, screen, view, and applets along with the Siebel
The raw XML
e Vincludes
f
data.lip n s
Fe n-tra
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Embedding Siebel Content in an External Application


Chapter 19 - Page 14
Example 2: Apply a Stylesheet

Example 2: Apply a Stylesheet


Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

Remove the "data only" tag and apply SWLSEdit_html.xsl


from ../siebsrvr/WEBTEMPL to get an editable form:

The same URL with


&SWEXslStyleSheet=SWLSEdit_html.
xsl (and SWEDataOnly removed)
s
produces more formatted output a
h a
l c l)
e nte uide
e z @ nt G
s q u tude
( f cva this S
e da use
a sta se to
z C cen
q e
u le li
s rab output.
Vmorefformatted
This produces
e e
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Embedding Siebel Content in an External Application


Chapter 19 - Page 15
Example 3: Programmatic Access

Example 3: Programmatic Access


Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

Use standard coding techniques to generate the URL and


parse the response:
// Generate the URL to access the SWE interface
String _urlString = null;
URL _xmlURL = null;
String qryRecord = null;
if ((pRecordID != null) && (!pRecordID.equals(""))) {
qryRecord = "&SWERowId0=" + pRecordID;
}
s a
else {
h a
l
qryRecord = "&SWERowId0=" + defaultRecord; l)
if ((defaultRecord != null) && (!defaultRecord.equals(""))) {
c
}
e nte uide
Dynamically generate the URL string
}
e z @ nt G
u tude
_urlString = "http://" + siebelHost + "/" + moduleName + "_" +
q
viewLanguage + "/start.swe?SWECmd=ExecuteLogin&SWEUsername=" +
s
cva this S
siebelAccount + "&SWEPassword=" + siebelAccount +
( f
"&SWECmd=GotoView&SWEView=" + viewName + "&SWEApplet0=" +

e da use
appletName + qryRecord + "&SWESetMarkup=XML&SWEDataOnly=TRUE";

a sta se to
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Embedding Siebel Content in an External Application


Chapter 19 - Page 16
Example 3: Programmatic Access

Example 3: Programmatic Access


Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

Parse the response:


// Create an XML Document based on the URL generated above
DOMParser domDoc = new DOMParser();
domDoc.setPreserveWhitespace(false);
try {
domDoc.parse(_xmlURL); Create and populate an XML document
} parser object to contain the response
catch (IOException spe) {
System.out.println("Error: Cannot Read XML Document");
}
s a
catch (SAXException spe) {
h a
l c l)
System.out.println("Error: SWE data is not well formed");

nte uide
}
// Cast getDocument() to an XMLDocument to have selectNodes() Method
MLDocument xmldoc e
@ nt G
= (XMLDocument)domDoc.getDocument();
e z
u tude
// Parse the XML Document using an XPATH Query to return the data
// from the defined view.
s q
cva this S
(Not Shown) Add code that reads through the

( f XML document and stores the data in fields to be

e da use displayed or edited in the external application

a sta se to
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Embedding Siebel Content in an External Application


Chapter 19 - Page 17
Example 3: Result

Example 3: Result
Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

The application displays and interacts with Siebel data:

The sample application used in the


practice accepts an Account Id as input...

s a
h a
...and displays account order
l c l)
nte uide
information as output
e
@ nt G
e z
u tude
s q
( f cva this S
e da use
a sta se to
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Embedding Siebel Content in an External Application


Chapter 19 - Page 18
Add an XML Request to the Body of an HTTP POST Command

Add an XML Request to the Body of an HTTP


POST Command
Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

For simplicity and security, the same URL commands can


be embedded in the body of an HTTP message
The commands are no longer shown in the URL
More complex commands are easier to build using multiple
strings in the message body
Example:
<?xml version="1.0" encoding="UTF-8"?>
s a
<EXEC PATH="/callcenter/start.swe"> a
)h
c l
<CMD NAME="SWECmd" VALUE="GotoView">
n t el ide
e
<ARG NAME="SWEView">SWEView=Account+Detail+-
@ G u
+Contacts+View</ARG>
ez den t
q
<ARG NAME="SWESetMarkup">XML</ARG>
s u tu
v a S
(fc e this
</CMD>
</EXEC> a
ed o uas s a previous slide
Executes the sameacommand

t
as nse t
C
z lice
u
q blee
scomplete
e V fera list of available tags, commands, and arguments, see, "Delivering
Reference: For a

e l ip ransWeb Applications" in the Siebel Portal Framework Guide.


Content to External
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Embedding Siebel Content in an External Application


Chapter 19 - Page 19
XML Interface vs. Web Services

XML Interface vs. Web Services


Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

The XML Interface interacts at the UI level; web services


interact at the business logic level
You may leverage existing XSL stylesheets to display XML
Interface data
These stylesheets use the UI information to present the data
Web services do not provide any user interface information, and
would require significant revision of existing stylesheets a
The XML Interface does not require any additional l) h
as
configuration n t elc ide
@ e theGXML u
Any enabled application object managerzsupports
e den t
Interface
s q u tu
v a S
a (fc e this
Web services must be enabled and configured
The XML Interface can
a edaccess
o u sany screen, view, or applet
t IDe used
accessible to thesUser
a t to log in
C cen s
e z
u le li
s q
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Embedding Siebel Content in an External Application


Chapter 19 - Page 20
Lesson Highlights

Lesson Highlights
Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

The Siebel Web Server Extension XML Interface provides


an alternative to traditional web services for displaying and
manipulating Siebel data in an external application
To invoke the XML Interface:
Provide commands in the URL request, OR
Provide an XML command structure in an HTTP POST
request s a
h a
l c l)
e nte uide
e z @ nt G
s q u tude
( f cva this S
e da use
a sta se to
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Embedding Siebel Content in an External Application


Chapter 19 - Page 21
Practice 19 Overview: Exploring the XML Interface

Practice 19 Overview:
Exploring the XML Interface
Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

This practice covers the following topics:


Adding XML Interface commands to a URL
Exploring an application that uses the XML Interface

s a
h a
l c l)
e nte uide
e z @ nt G
s q u tude
( f cva this S
e da use
a sta se to
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Embedding Siebel Content in an External Application


Chapter 19 - Page 22
Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

s a
h a
l c l)
e nte uide
Siebel Workflow z @ Appendix
n t G
q e
u tude
s
( f cva this S
Chapter 20

e da use
a sta se to
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Siebel Workflow Appendix


Chapter 20 - Page 1
Siebel Workflow Appendix
Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

Siebel Workflow Appendix

s a
h a
l c l)
e nte uide
e z @ nt G
s q u tude
( f cva this S
e da use
a sta se to
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Siebel Workflow Appendix


Chapter 20 - Page 2
Objectives

Objectives
Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

After completing this lesson, you should be able to:


Create a workflow process
Publish and activate a workflow process

s a
h a
l c l)
e nte uide
e z @ nt G
s q u tude
( f cva this S
e da use
a sta se to
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Siebel Workflow Appendix


Chapter 20 - Page 3
Workflow Process

Workflow Process
Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

Is an ordered set of steps executed in response to a


defined set of conditions
Is used to automate parts of a business process

s a
a
)h
c l
n t el ide
@ e G u
ez den t
s q u tu
v a S
a (fc e this
a ed o us
a st se t
z C cen
q e
u le li
s rab "Siebel Business Process Framework: Workflow Guide" in
V fereference
For more information
e
Siebel
e l ipBookshelf.
a n s
F n-t r
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Siebel Workflow Appendix


Chapter 20 - Page 4
Basic Workflow Process Steps

Basic Workflow Process Steps


Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

Every workflow process must have Start and End steps


Start provides an entry point into the workflow
End specifies when a process is finished
Decision Point provides branching capability
Siebel Operation manipulates business component
records a
Business Service runs a business service h a s
l c l)
e nte uide
e z @ nt G
s q u tude
( f cva this S
Decision Point
e da useOperation
Connector Siebel Business
Service
t a t o
C as nse
u e z lice
sq rable
e V fe
e l i p a n s
F n-t r
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Siebel Workflow Appendix


Chapter 20 - Page 5
Process Properties

Process Properties
Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

Are variables used to process input and outputs while the


workflow is executing
Are populated at start, when step completes, or at end
Some are specific to the WF; some appear in all WFs

s a
h a
l c l)
e nte uide
e z @ nt G
s q u tude
( f cva thisthisSpecific
S to
workflow
d a e
t a e to us
C as nse
u e z lice
sq rable
e V fe
e l i p a n s
F n-t r
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Siebel Workflow Appendix


Chapter 20 - Page 6
Creating a Workflow Process

Creating a Workflow Process


Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

Create a Workflow Process definition


Enter the designer
Create the steps
Connect the steps
Set property values
s a
h a
Example: Create a workflow to write out the account name
l c l) and
location to a file
e nte uide
e z @ nt G
s q u tude
( f cva this S
e da use More

a sta se to
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Siebel Workflow Appendix


Chapter 20 - Page 7
Create a Workflow Process Definition

Create a Workflow Process Definition


Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

Click the Workflow Process object type


Create a record and set:
Process Name: unique name
Business Object: sets context for the workflow
Project: adds the definition to the project

s a
h a
l c l)
e nte uide
e z @ nt G
s q u tude
( f cva this S
e da use
a sta se to
z C cen
q e
u le li
s
erabset to In Progress.
e Vautomatically
The Status is
f
l i p n s
Fe n-tra
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Siebel Workflow Appendix


Chapter 20 - Page 8
Start the Designer

Start the Designer


Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

Right-click the definition and select Edit Workflow Process

s a
h a
l c l)
e nte uide
e z @ nt G
s q u tude
( f cva this S
e da use
a sta se to
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Siebel Workflow Appendix


Chapter 20 - Page 9
Create the Steps

Create the Steps


Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

Drag and drop the required steps (Start and End)


Drag and drop other steps

s a
h a
l c l)
Drag from the palette and te
e n u ide
e z @ nt G
drop onto the designer

s q u tude
( f cva this S
e da use
a sta se to
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Siebel Workflow Appendix


Chapter 20 - Page 10
Connect the Steps

Connect the Steps


Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

Drag and drop connectors between steps


Each end will be red when properly connected

Properly connected
s a
h a
l c l)
e nte uide
e z @ nt G
s q u tudeImproperly connected
( f cva this S
e da use
a sta se to
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Siebel Workflow Appendix


Chapter 20 - Page 11
Set Property Values

Set Property Values


Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

Select the step


Use the Properties window to set values
Properties are specific to the type of step
Selected step highlighted

s a
h a
Specifies the name of the step
l c l)
Name of selected step displayed e nte uide
e z @ nt G
s q u tude
( f cva this S
e daMinimaluproperties
se for the
a sta se to End step
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Siebel Workflow Appendix


Chapter 20 - Page 12
Multi Value Property Window (MVPW)

Multi Value Property Window


(MVPW)
Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

Appears below the designer


Use to set overall properties for the workflow

MVPW appears below


the designer
s a
a
Click the designer canvas
)h
to see overall properties
c l
n t el ide for the workflow

@ e G u
ez den t
s q u tu
v a S
a (fc e this
a ed o us
a st se t
z C cen
q e
u le li
s rainbthe application-level menu, select View > Windows > Multi Value
e Vwindow,
To view the MVP
f e
Property
e l ipWindow.
a n s
F n-t r
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Siebel Workflow Appendix


Chapter 20 - Page 13
Set Input and Output Arguments

Set Input and Output Arguments


Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

Use the MVPW to set input and output arguments for


individual steps

s a
h a Select the step

l c l)
e nte uide
e z @ nt G
s q u tuSetdevalues
cva this S
Select the Input Arguments
or Output Arguments tab
( f
e da use
a sta se to
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Siebel Workflow Appendix


Chapter 20 - Page 14
Testing a Workflow Process

Testing a Workflow Process


Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

Set property values


Start the simulator
Run the simulation

s a
h a
l c l)
e nte uide
e z @ nt G
s q u tude
( f cva this S
e da use More

a sta se to
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Siebel Workflow Appendix


Chapter 20 - Page 15
Set Property Values

Set Property Values


Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

The simulator needs a record to operate on


Specify using the Object Id process property

s a
h a
l c l)
e nte uide
e z @ nt G
s q u tude
( f cva this S Row Id for a test

e da use account record

a sta se to
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Siebel Workflow Appendix


Chapter 20 - Page 16
Start the Simulator

Start the Simulator


Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

Right-click the designer and select Simulate

s a
h a
l c l)
e nte uide
e z @ nt G
s q u tude
( f cva this S
e da use
a sta se to
z C cen
q e
u le li
s rab> Options > Debug parameters have been set correctly.
theeView
e Vthat
This requires
f
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Siebel Workflow Appendix


Chapter 20 - Page 17
Start the Simulation

Start the Simulation


Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

Use the Simulate toolbar to start the simulation


A version of the client application is started
The workflow runs in the context of the client application

Simulate toolbar

s a
h a
l c l)
e nte uide
e z @ nt G
s q u tude
Active step
f
highlighted in(redcva this S
e da use
a sta se to
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Siebel Workflow Appendix


Chapter 20 - Page 18
Run the Simulation

Run the Simulation


Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

Use the Simulate toolbar to control the simulation

s a
h a
l c l)
e nte uide
e z @ nt G
s q u tude
( f cva this S
e da use
a sta se to
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Siebel Workflow Appendix


Chapter 20 - Page 19
Watch Window

Watch Window
Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

Select View > Debug Windows > Watch to view the watch
window
Allows you to view and
edit data values

s a
h a
l c l)
e nte uide
e z @ nt G
s q u tude
( f cva this S
e da use
a sta se to
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Siebel Workflow Appendix


Chapter 20 - Page 20
Verify the Result

Verify the Result


Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

Verify the behavior of the workflow

s a
h a
Verify the data is
l c l)
written to the file
e nte uide
e z @ nt G
s q u tude
( f cva this S
e da use
a sta se to
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Siebel Workflow Appendix


Chapter 20 - Page 21
Deploying a Workflow Process

Deploying a Workflow Process


Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

Transfers the workflow from the repository to run-time


tables to make it available for use
Consists of:
Developer setting the workflow to complete in Siebel Tools
Administrator activating the workflow in the run-time client

s a
h a
l c l)
e nte uide
e z @ nt G
s q u tude
( f cva this S
e da use More

a sta se to
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Siebel Workflow Appendix


Chapter 20 - Page 22
Publish the Workflow

Publish the Workflow


Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

Click the Publish button in the Workflow toolbar


Sets the status to Completed
Prevents any further editing of the workflow process
Makes the workflow available for activation

s a
h a
l c l)
e nte uide
e z @ nt G
s q u tude
( f cva this S
e da use
a sta se to
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Siebel Workflow Appendix


Chapter 20 - Page 23
Activate the Workflow

Activate the Workflow


Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

Navigate to Administration - Business Process > Workflow


Deployment > Active Workflow Processes
Select the newly deployed workflow and click Activate
Transfers the workflow definitions in the repository tables into
corresponding run-time tables

s a
h a
l c l)
e nte uide
e z @ nt G
s q u tude
( f cva this S
e da use
a sta se to
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Siebel Workflow Appendix


Chapter 20 - Page 24
Publish and Activate Workflow

Publish and Activate Workflow


Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

Developers can use the Publish/Activate button during


testing to complete both steps

s a
h a
l c l)
e nte uide
e z @ nt G
s q u tude
( f cva this S
e da use
a sta se to
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Siebel Workflow Appendix


Chapter 20 - Page 25
Lesson Highlights

Lesson Highlights
Unauthorized reproduction or distribution prohibited Copyright 2016, Oracle and/or its affiliates

A workflow process is an ordered set of steps executed in


response to a defined set of conditions
Workflows are created in Siebel Tools
Deploy (publish/activate) a workflow to make it available
Use the workflow simulator to verify that the workflow
behaves as designed
s a
h a
l c l)
e nte uide
e z @ nt G
s q u tude
( f cva this S
e da use
a sta se to
z C cen
q e
u le li
s
e V ferab
e l ip rans
F n-t
no

Copyright 2011, Oracle and/or it affiliates. All rights reserved.

Siebel Workflow Appendix


Chapter 20 - Page 26

Você também pode gostar