Views

Difference between revisions of "OpenScape UC Application Web Client SDK - Deep Dive"

The Wiki of Unify contains information on clients and devices, communications systems and unified communications. - Unify GmbH & Co. KG is a Trademark Licensee of Siemens AG.

Jump to: navigation, search
 
(40 intermediate revisions by one other user not shown)
Line 1: Line 1:
 +
{{Breadcrumb|0|0|Unified Communications|OpenScape UC Application}}
 +
 
'''***THIS SECTION IS WORK IN PROGRESS 25th Aug 2009***'''
 
'''***THIS SECTION IS WORK IN PROGRESS 25th Aug 2009***'''
  
 
+
This section is intended to give background technical information into the WebClient SDK. It is not intended as an instructional guide as how to use the Web Client SDK.
This section is intended to give background technical information into the WebClient SDK. It is not intended as an instructions as how to use the Web Client SDK.
 
  
 
Detailed instructions for using the OpenScape UC Application Web Client SDK can be found in the "Web Client SDK Programming Guide A31003-S5031-R102-3-7620". Please contact your account manager for further information.
 
Detailed instructions for using the OpenScape UC Application Web Client SDK can be found in the "Web Client SDK Programming Guide A31003-S5031-R102-3-7620". Please contact your account manager for further information.
Line 11: Line 12:
 
Customisation of the WebClient is supported on the following Web Browsers:
 
Customisation of the WebClient is supported on the following Web Browsers:
  
• Microsoft Internet Explorer 6.x and 7.x
+
''• Microsoft Internet Explorer 6.x and 7.x''
 
 
• Firefox 2.x and 3.x
 
  
 +
''• Firefox 2.x and 3.x''
  
 
==When should I use the Web Client SDK?==
 
==When should I use the Web Client SDK?==
Line 20: Line 20:
 
The Web Client SDK allows:
 
The Web Client SDK allows:
  
'''Rebranding''' - Customize and change the appearance of the OpenScape UC Application's Web Client interface according customer branding needs.
+
 
 +
'''Rebranding''' - Customize and change the appearance of the OpenScape UC Application's Web Client interface according to customer branding needs.
  
 
Key Features:
 
Key Features:
  
Graphical modifications
+
''• Graphical modifications''
Background colours of the web portal
+
 
Background images in the web portal
+
''• Background colours of the web portal''
Logo in the web portal
+
 
 +
''• Background images in the web portal''
 +
 
 +
''• Logo in the web portal''
  
  
Line 34: Line 38:
 
Key Features:
 
Key Features:
  
HTTP Requests
+
''• HTTP Requests''
Java Script
+
 
 +
''• Java Script''
  
 
==Rebranding==
 
==Rebranding==
 +
[[Image:Rebrandjpeg.jpeg]]
  
 
Web Client SDK provides a mechanism to change the look and feel with out directly editing the CSS.
 
Web Client SDK provides a mechanism to change the look and feel with out directly editing the CSS.
  
Configuration file sits on top of the CSS files
+
''• Configuration file sits on top of the CSS files''
Pictures/Logos can be edited/replaces
 
Colors can be modified
 
Provides a procedure so changes survives software updates
 
  
For inspiration and ideas on rebranding the web client see the [[Web Client SDK examples page]]
+
''• Pictures/Logos can be edited/replaced''
 +
 
 +
''• Colours can be modified''
 +
 
 +
''• Provides a procedure so changes survive software updates''
 +
 
 +
 
 +
For inspiration and ideas on rebranding the web client see the [[Web Client SDK examples page]]
  
 
==Integration==
 
==Integration==
 +
[[Image:Integratejpeg.jpeg]]
 +
 +
The Web Client SDK is ideal for simple web based integrations. The current release of the Web Client SDK supports the following UC features (via both HTTP requests and Java Script):
 +
 +
 +
''• Click to call''
 +
 +
''• Click to hangup''
  
The Web Client SDK is ideal for simple web based integrations. The current release of the Web Client SDK supports the following UC features (via both HTTP request and Java Script):
+
''• Click to answer''
  
Click to call
+
==Try it out for yourself!==
Click to hangup
 
Click to answer
 
  
=Try it out for yourself!=
+
UC enabling via the Web Client SDK is easy. The following examples show how to make a call via both HTTP requests and Java Script:
  
UC enabling via the Web Client SDK is easy. The follow to examples show how to make a call via both HTTP requests and Java Script:
 
  
HTTP Requests
+
'''HTTP Requests:'''
  
 
Make Call: http://<hostname>/tweb/portal/req?call=<number>&returntype=text  
 
Make Call: http://<hostname>/tweb/portal/req?call=<number>&returntype=text  
  
Java Script
+
 
 +
'''Java Script:'''
  
 
1. Load JavaScript from OpenScape UC Application Web Client Server.
 
1. Load JavaScript from OpenScape UC Application Web Client Server.
<script src="http://<OscServer>:7789/tweb/public/req?getClickToDialScript=" type="text/javascript">
+
''<script src="http://<OscServer>:7789/tweb/public/req?getClickToDialScript=" type="text/javascript">
</script>
+
</script>''
  
2. Implememt initOnLoad Method to initialize the OpenScape web server for the ClickToDial script.
+
2. Implememt ''initOnLoad'' Method to initialize the OpenScape web server for the ClickToDial script.
<script>function onLoad(){
+
''<script>function onLoad(){
 
setCallServerUrl( "http://www.OscServer.com:7789" );
 
setCallServerUrl( "http://www.OscServer.com:7789" );
 
setHiddenCallEnabled(true); //needed when SSO is not installed
 
setHiddenCallEnabled(true); //needed when SSO is not installed
}</script>
+
}</script>''
  
3. Now can use the JavaScript makeCall function loaded with the script in step 1.
+
3. Now you can use the JavaScript ''makeCall'' function loaded with the script in step 1.
<a href="javascript:makeCall('')">Call </a>
+
''<a href="javascript:makeCall('')">Call </a>''

Latest revision as of 17:02, 26 April 2011

***THIS SECTION IS WORK IN PROGRESS 25th Aug 2009***

This section is intended to give background technical information into the WebClient SDK. It is not intended as an instructional guide as how to use the Web Client SDK.

Detailed instructions for using the OpenScape UC Application Web Client SDK can be found in the "Web Client SDK Programming Guide A31003-S5031-R102-3-7620". Please contact your account manager for further information.


Supported Browsers

Customisation of the WebClient is supported on the following Web Browsers:

• Microsoft Internet Explorer 6.x and 7.x

• Firefox 2.x and 3.x

When should I use the Web Client SDK?

The Web Client SDK allows:


Rebranding - Customize and change the appearance of the OpenScape UC Application's Web Client interface according to customer branding needs.

Key Features:

• Graphical modifications

• Background colours of the web portal

• Background images in the web portal

• Logo in the web portal


Integration - Allows UC functionality to be embedded quickly and easily into other web applications for Communication Enabled Business Processes (CEBP).

Key Features:

• HTTP Requests

• Java Script

Rebranding

Rebrandjpeg.jpeg

Web Client SDK provides a mechanism to change the look and feel with out directly editing the CSS.

• Configuration file sits on top of the CSS files

• Pictures/Logos can be edited/replaced

• Colours can be modified

• Provides a procedure so changes survive software updates


For inspiration and ideas on rebranding the web client see the Web Client SDK examples page

Integration

Integratejpeg.jpeg

The Web Client SDK is ideal for simple web based integrations. The current release of the Web Client SDK supports the following UC features (via both HTTP requests and Java Script):


• Click to call

• Click to hangup

• Click to answer

Try it out for yourself!

UC enabling via the Web Client SDK is easy. The following examples show how to make a call via both HTTP requests and Java Script:


HTTP Requests:

Make Call: http://<hostname>/tweb/portal/req?call=<number>&returntype=text


Java Script:

1. Load JavaScript from OpenScape UC Application Web Client Server. <script src="http://<OscServer>:7789/tweb/public/req?getClickToDialScript=" type="text/javascript"> </script>

2. Implememt initOnLoad Method to initialize the OpenScape web server for the ClickToDial script. <script>function onLoad(){ setCallServerUrl( "http://www.OscServer.com:7789" ); setHiddenCallEnabled(true); //needed when SSO is not installed }</script>

3. Now you can use the JavaScript makeCall function loaded with the script in step 1. <a href="javascript:makeCall()">Call </a>