Document Conventions
Document Conventions
This document uses certain stylistic and typographical conventions—introduced here—that serve as shorthands for particular kinds of information.
Document Version Number
A version number appears at the bottom of the inside front cover of this document. Version numbers change as new information is added to this document. Here is a sample version number:
80fr_ref_06-2008_v8.0.001.00
You will need this number when you are talking with Genesys Customer Care about this product.
Screen Captures Used in This Document
Screen captures from the product graphical user interface (GUI), as used in this document, may sometimes contain minor spelling, capitalization, or grammatical errors. The text accompanying and explaining the screen captures corrects such errors except when such a correction would prevent you from installing, configuring, or successfully using the product. For example, if the name of an option contains a usage error, the name would be presented exactly as it appears in the product GUI; the error would not be corrected in any accompanying text.
Type Styles
Table 127 describes and illustrates the type conventions that are used in this
document.
SIP Server—Deployment Guide 759
Document Conventions
Table 127: Type Styles
Type Style Used For Examples
Italic • Document titles
• Emphasis
• Definitions of (or first references to) unfamiliar terms
• Mathematical variables
Also used to indicate placeholder text within code samples or commands, in the special case where angle brackets are a required part of the syntax (see the note about angle brackets on
page 760
).
Please consult the Genesys Migration
Guide for more information.
Do not use this value for this option.
A customary and usual practice is one that is widely accepted and used within a particular industry or profession.
The formula, x +1 = 7 where x stands for . . .
Monospace font
(Looks like teletype
or typewriter text
)
All programming identifiers and GUI elements. This convention includes:
• The names of directories, files, folders, configuration objects, paths, scripts, dialog boxes, options, fields, text and list boxes, operational modes, all buttons (including radio buttons), check boxes, commands, tabs, CTI events, and error messages.
• The values of options.
• Logical arguments and command syntax.
• Code samples.
Also used for any text that users must manually enter during a configuration or installation procedure, or on a command line.
Select the
Show variables on screen check box.
In the
Operand
text box, enter your formula.
Click
OK
to exit the
Properties
dialog box.
T-Server distributes the error messages in
EventError
events.
If you select true
for the inbound-bsnscalls
option, all established inbound calls on a local agent are considered business calls.
Enter exit
on the command line.
Square brackets ([ ])
A particular parameter or value that is optional within a logical argument, a command, or some programming syntax. That is, the presence of the parameter or value is not required to resolve the argument, command, or block of code. The user decides whether to include this optional information.
smcp_server -host [/flags]
Angle brackets
(< >)
A placeholder for a value that the user must specify. This might be a DN or a port number specific to your enterprise.
Note: In some cases, angle brackets are required characters in code syntax (for example, in XML schemas). In these cases, italic text is used for placeholder values.
smcp_server -host <confighost>
760 Framework 8.1
