Views

Difference between revisions of "Keypad input into XML Application fields"

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
(Created page with '<accesscontrol>horemu,,Hans.zeiner,,Gunnar.boll</accesscontrol> {{FD-Sytematics-Box | family = {{FD-Cat|OpenStage}} | model = {{FD-Cat|OpenStage 60}}<br />{{FD-Cat|OpenStage…')
 
 
(12 intermediate revisions by the same user not shown)
Line 1: Line 1:
−
<accesscontrol>horemu,,Hans.zeiner,,Gunnar.boll</accesscontrol>
+
{{Breadcrumb|0|0|{{dev-en}}|OpenStage}}
−
{{FD-Sytematics-Box
+
{{OS-FD-Access}}{{FD-Sytematics-Box
 
| family  = {{FD-Cat|OpenStage}}
 
| family  = {{FD-Cat|OpenStage}}
 
| model    = {{FD-Cat|OpenStage 60}}<br />{{FD-Cat|OpenStage 80}}
 
| model    = {{FD-Cat|OpenStage 60}}<br />{{FD-Cat|OpenStage 80}}
−
| type    = {{FD-Cat|SIP}}
+
| relation = {{FD-Cat|API/SDK related}}
−
| release  = {{FD-Cat|V1R5.11.0}}
+
| release  = {{FD-Cat|V1 R5}}
−
| platform = {{FD-Cat|Asterisk}}
 
 
}}
 
}}
  
Line 11: Line 10:
  
 
The ''IppKey'' element enables or disables sending keypad input and defines the key part of the key-value pair for the keypad key. The value part consists of the number (0 to 9) or character (* or #).  It also defines the buffering of the keypad key presses.
 
The ''IppKey'' element enables or disables sending keypad input and defines the key part of the key-value pair for the keypad key. The value part consists of the number (0 to 9) or character (* or #).  It also defines the buffering of the keypad key presses.
 +
 +
== Attributes of IppKey element ==
  
 
The following table defines the attributes in the ''IppKey'' element:
 
The following table defines the attributes in the ''IppKey'' element:
 +
 +
{|
 +
! Description
 +
! Attribute Name
 +
! Attribute Values
 +
! Mandatory or Optional
 +
! Default Value
 +
|-
 +
| Defines if keypad key presses are handled
 +
| Keypad
 +
| NO or YES
 +
| Mandatory
 +
| NO
 +
|-
 +
| Defines if keys are sent
 +
| SendKeys
 +
| NO or YES
 +
| Mandatory
 +
| NO
 +
|-
 +
| Defines if keys are buffered
 +
| BufferKeys
 +
| NO, YES, or SUB-SEQUENT
 +
| Optional
 +
| NO
 +
|-
 +
| Defines the length of the buffer
 +
| BufferLength
 +
| A positive number including 0
 +
| Optional
 +
| 0
 +
|-
 +
| Defines the terminating keypad key for the buffer
 +
| TermKey
 +
| 0 to 9, *, #, or left blank
 +
| Optional
 +
| blank
 +
|-
 +
| Defines the key part of the key-value pair sent in the URL to the remote server for the next XML document
 +
| UrlKey
 +
| User defined string
 +
| Mandatory
 +
| digit
 +
|}
 +
 +
To enable sending keypad key presses, set ''Keypad'' = ''YES'' and ''SendKeys'' = ''YES''.
 +
 +
To disable sending keypad key presses, set ''Keypad'' = ''NO'' or ''SendKeys'' = ''NO''.
 +
 +
To buffer keypad key presses and subsequently send them en bloc, set ''Keypad'' = ''YES'', ''SendKeys'' = ''YES'', ''BufferKeys'' = ''YES'', and ''BufferLength'' is greater than 1 or ''TermKey'' is set to one of the keypad keys.
 +
 +
To enable sending the first keypad key press and buffer the subsequent keypad key presses until the response to the first request has been handled then send them en bloc (providing the new XML document also has sending keypad input enabled), set ''Keypad'' = ''YES'', ''SendKeys'' = ''YES'', ''BufferKeys'' = ''SUBSEQUENT'', and ''BufferLength'' is greater than 0 or ''TermKey'' is set to one of the keypad keys.
 +
 +
The ''IppScreen'' element may contain either: ''IppAlert'', ''IppList'', ''IppTextBox'' or ''IppForm''.  The ''IppKey'' element is only appropriate to ''IppList''.
 +
 +
If ''IppKey'' element is missing, invalid or set for ''IppAlert'', ''IppTextBox'' or ''IppForm'', it will default to sending keypad key presses disabled.
 +
 +
If any of the ''IppKey'' attributes are missing or invalid, they will default to their default value as shown above in table.
 +
The syntax for ''IppScreen'' is:
 +
 +
<pre>
 +
<IppScreen ID=”i” HiddenCount=”m” CommandCount=”n” Sound=”s”>
 +
    <IppKey Keypad=”NO|YES” SendKeys=”NO|YES” BufferKeys=”NO|YES|SUBSEQUENT”
 +
    BufferLength=”n” TermKey=”c” UrlKey =”k” />
 +
</IppScreen>
 +
</pre>
 +
 +
The format of the URL for the next XML document when a digit key is pressed is:
 +
<nowiki>
 +
<protocol>://<address>:<port>/<program name>?<key-value pair for digit key>&<key-value pairs for any IppHiddens>
 +
</nowiki>
 +
 +
For example:
 +
<pre>
 +
http://137.223.238.174:8080/servlet/IppGenericServlet?digit=3&contextkey=contextvalue
 +
</pre>
 +
 +
The format of the URL for the next XML document when buffered digit keys are sent is:
 +
<pre>
 +
<protocol>://<address>:<port>/<program name>?<key-value pair for buffered digit keys>
 +
&<key-value pairs for any IppHiddens>
 +
</pre>
 +
 +
For example:
 +
<pre>
 +
http://137.223.238.174:8080/servlet/IppGenericServlet?digit=357&contextkey=contextvalue
 +
</pre>
 +
 +
Note: The value for keypad digits * and # will be URL encoded.

Latest revision as of 19:08, 22 April 2011

You are here:  

Icon linkarrow.gif Home  Icon linkarrow.gif Devices  Icon linkarrow.gif OpenStage  Icon linkarrow.gif Keypad input into XML Application fields
Systematics
Family: OpenStage
Model: OpenStage 60
OpenStage 80
Relation: API/SDK related
Release: V1 R5

The IppScreen element will be enhanced with an additional element IppKey.

The IppKey element enables or disables sending keypad input and defines the key part of the key-value pair for the keypad key. The value part consists of the number (0 to 9) or character (* or #). It also defines the buffering of the keypad key presses.

Attributes of IppKey element

The following table defines the attributes in the IppKey element:

Description Attribute Name Attribute Values Mandatory or Optional Default Value
Defines if keypad key presses are handled Keypad NO or YES Mandatory NO
Defines if keys are sent SendKeys NO or YES Mandatory NO
Defines if keys are buffered BufferKeys NO, YES, or SUB-SEQUENT Optional NO
Defines the length of the buffer BufferLength A positive number including 0 Optional 0
Defines the terminating keypad key for the buffer TermKey 0 to 9, *, #, or left blank Optional blank
Defines the key part of the key-value pair sent in the URL to the remote server for the next XML document UrlKey User defined string Mandatory digit

To enable sending keypad key presses, set Keypad = YES and SendKeys = YES.

To disable sending keypad key presses, set Keypad = NO or SendKeys = NO.

To buffer keypad key presses and subsequently send them en bloc, set Keypad = YES, SendKeys = YES, BufferKeys = YES, and BufferLength is greater than 1 or TermKey is set to one of the keypad keys.

To enable sending the first keypad key press and buffer the subsequent keypad key presses until the response to the first request has been handled then send them en bloc (providing the new XML document also has sending keypad input enabled), set Keypad = YES, SendKeys = YES, BufferKeys = SUBSEQUENT, and BufferLength is greater than 0 or TermKey is set to one of the keypad keys.

The IppScreen element may contain either: IppAlert, IppList, IppTextBox or IppForm. The IppKey element is only appropriate to IppList.

If IppKey element is missing, invalid or set for IppAlert, IppTextBox or IppForm, it will default to sending keypad key presses disabled.

If any of the IppKey attributes are missing or invalid, they will default to their default value as shown above in table. The syntax for IppScreen is: 

<IppScreen ID=”i” HiddenCount=”m” CommandCount=”n” Sound=”s”>
    <IppKey Keypad=”NO|YES” SendKeys=”NO|YES” BufferKeys=”NO|YES|SUBSEQUENT” 
    BufferLength=”n” TermKey=”c” UrlKey =”k” />
</IppScreen>

The format of the URL for the next XML document when a digit key is pressed is: <protocol>://<address>:<port>/<program name>?<key-value pair for digit key>&<key-value pairs for any IppHiddens>

For example: 

http://137.223.238.174:8080/servlet/IppGenericServlet?digit=3&contextkey=contextvalue

The format of the URL for the next XML document when buffered digit keys are sent is: 

<protocol>://<address>:<port>/<program name>?<key-value pair for buffered digit keys>
&<key-value pairs for any IppHiddens>

For example: 

http://137.223.238.174:8080/servlet/IppGenericServlet?digit=357&contextkey=contextvalue

Note: The value for keypad digits * and # will be URL encoded.

Retrieved from "http://wiki.unify.com/index.php?title=Keypad_input_into_XML_Application_fields&oldid=31453"