Copyright 2010-2017 Obihai Technology, Inc.
13
Notational Conventions
A device configuration parameter and its value is represented in the format:
Parameter Group Name
::
ParameterName
=
Parameter Value
Parameter Group Name
::
ParameterName
= {
replace-this-with-actual-value
}
Parameter Group Name
is the heading of the parameter group on the left side panel of the device local configuration
or
“
OBi
TALK Configuration”
web page and may contain spaces. When a group heading has more than one level, each
level is separated with a
–
, such as:
Services Providers - ITSP Profile A
–
SIP
::
ParameterName
is the name of the parameter as shown on the web page and MUST NOT CONTAIN ANY SPACES.
Parameter Value
is the literal value to assign to the named parameter and may contain spaces.
Group Name
or its
top-level headings may be omitted when the context is clear. For example:
SP1 Service
::
AuthUserName
=
4082224312
ITSP Profile A - SIP
::
ProxyServer
=
sip.myserviceprovider.com
ProxyServerPort
=
5082
[
optional values
]
Boolean Values
Parameters that take a Boolean (true or false) value can be identified on the phone native configuration web pages (or
OBi Expert) by a check box / tick box (instead of an input-box or drop-down list) next to the parameter name.
Throughout the document we may loosely refer to a Boolean value as enable/disable or yes/no, but the only valid
Boolean parameter values to use in a phone configuration file that is recognized by the phone is either
true
/
false
or
True
/
False
(case-sensitive). This is equivalent to checked/unchecked on the configuration web pages.
Multiple Choice Values
Parameters that take one of several valid options from a drop-down list on the device message must be provisioned
with string values that match exactly one of those choices. Otherwise the device will use the default choice. The
matching of provisioned value against valid strings is case-sensitive and does not allow extra spaces.
Parameter Values
When entering a parameter value from the web page or via provisioning, you should avoid adding extra white spaces
before or after the parameter value. If the value is a comma separated list of strings, or may contain attributes after a
comma or semi-colon, etc, you should also avoid adding extra white space before and after the delimiter. For example:
CertainParameter
=
1,2,3,4;a;b;c
If a parameter value can include white spaces, such as
X_DisplayLabel
, you should use just a single space
character and no extra space before and after the value. For example:
X_DisplayLabel
=
My New Service