Xacli – special commands – xpreferences (i), The xpreferences options, Xpreferences xpathwrite – TANDBERG 6000MXP User Manual

Page 59: Xpreferences xmlcommandresult, Xpreferences detaillevel, Xpreferences xmlconfigfeedback, Xacli – special commands – xpreferences, Xpreferences

Advertising
background image

59

D 13887.08
MAY 2008

TANDBERG 3000

MXP

&

6000

MXP

REFERENCE GUIDE FOR SYSTEM INTEGRATORS

A command of great importance,

xpreferences

lets the

user/control application individually configure the Telnet/
RS 232 session in use. When parsing data sent from the co-
dec using a control system it is important to set preferences
to match the parser in use.
The xpreferences is a session specific command, i.e.
different RS 232/Telnet sessions can define preferences
individually. This also implies that the preferences must be
set each time the control application connects to the codec,
i.e. the control application should always set the necessary
preferences when connecting to the system (or after system
reboot when using RS 232).

The xpreferences Options

xpreferences ?

usage: xpreferences xpathwrite <on/off>

or: xpreferences detaillevel <1..2>

or: xpreferences xmlconfigfeedback <on/off>

or: xpreferences xmlstatusfeedback <on/off>

or: xpreferences xmlcommandresult <on/off>

or: xpreferences itemnumber <on/off>

or: xpreferences completepath <on/off>

OK

XACLI – Special Commands – xpreferences (I)

About the TANDBERG API

About xpreferences

xpreferences xpathwrite

xpreferences xpathwrite <on/off>
Disables/enables the XPath search engine when issuing con-
figurations. When the XPath search engine is disabled, the
user/control application must supply the complete path to
the configurations to be set (no “double slashes” allowed).
This will improve the performance of the system when issu-
ing many consecutive configurations.

NOTE!

It is always recommended to supply the complete

path for configurations to be set when issuing commands
from an external control application.

xpreferences detaillevel

xpreferences detaillevel <1..2>
Most information elements accessible by the status-type
commands are defined to be level 1 information. However
there are some information elements defined to be level 2
information. When reading status information, only the infor-
mation elements with a detail level equal to or less than the
detaillevel defined for the interface will be listed.
The detaillevel is by default set to 1 when connecting to an
RS 232/Telnet session.

xpreferences xmlconfigfeedback <on/off>
If xmlconfigfeedback is set to on, feedback on configura-
tions will be returned in XML-format instead of the standard
XACLI configuration format.

EXAMPLE

XACLI-format:
*c xConfiguration SerialPort 1 BaudRate: 2400
XML format
<Configuration>

<SerialPort item=”1”>

<BaudRate item=”1”>2400</BaudRate>

</SerialPort>

</Configuration>

xpreferences xmlconfigfeedback

xpreferences xmlcommandresult <on/off>
If xmlcommandresult is set to on, response for commands
will be returned in XML-format.

EXAMPLE

XACLI-format:
xcom dial 10.47.15.127
*r Result (status=OK):

CallRef: 1

LogTag: 8

*r/end

XML format
xcom dial 10.47.15.127
<Result item=”1” status=”OK”>

<CallRef item=”1”>1</CallRef>

<LogTag item=”1”>8</LogTag>

</Result>

xpreferences xmlcommandresult

Advertising
This manual is related to the following products: