'\" t
'       # that line tells man to use tbl && col
.\" @(#)$Header: /usr/aws/aws/src/bloomS/src/RCS/bloomS.man1,v 1.25 1998/09/15 02:02:05 dank Exp $
.\" **************************************************************
.\" Use this man page as a template for section 1 man pages in 2.0
.\" **************************************************************
.TH bloomS 1J  $Date: 1998/09/15 02:02:05 $
.UC 4
.SH NAME
.\" * name of component followed by a dash and a description (initial cap,
.\" *   no period)
bloomS \- Server that watches instruments in pre-specified producer groups and
sends updates to Bloomberg Multi-Product Contributor Feed
.PP
Part of the JPA Publishing Suite
.SH SYNOPSIS
.\" * command syntax: put command name and parameters in bold and 
.\" *   options in italics
.B bloomS
[\fB\-trace \fITrace\fR{on | off | 0 - 3}\fR]
[\fB\-log \fILogging\fR{on | off}\fR]
[\fB\-tp \fITracePath\fR]
[\fB\-lp \fILogPath\fR]
[\fB\-ep \fIEtcPath\fR]
[\fB\-hn \fIHostName\fR]
[\fB\-port \fIPort\fR]
[\fB\-cc \fICityCode\fR]
[\fB\-bc \fIBankCode\fR]
[\fB\-wt \fIWaitTime\fR]
[\fB\-ms \fIMaxSend\fR]
[\fB\-ht \fIHeartTimeout\fR]
[\fB\-at \fIAckTimeout\fR]
[\fB\-pt \fIPacketTimeout\fR]
[\fB\-tf \fITemplateField\fR]
[\fB\-if \fIIdTypeField\fR]
[\fB\-sf \fISecIdField\fR]
[\fB\-af \fIAddIndField\fR]
[\fB\-pf \fIPageField\fR]
[\fB\-rf \fIRowField\fR]
[\fB\-cf \fICodeField\fR]
[\fB\-cid \fICtrlID\fR]
[\fB\-ccf \fICountryCodeField\fR]
[\fB\-df \fIDateField\fR]
.SH DESCRIPTION
.PP
The
.I bloomS
server watches all the instruments in a number of pre-configured BTRS producer
groups, and sends any relevant updates to Bloomberg using the Multi-Product
Contributor Feed protocol, using packet types 8, 9, 14 and 21.
.PP
The BTRS producer groups are specified in the instrument file,
.I bloomInstrs.txt,
along with the translation templates that are used
to map fields in the BTRS schemata onto Bloomberg field codes.
.PP
The server starts off by reading in the instrument file, and then attempts
to make a connection to the pre-configured port on the
pre-configured Bloomberg host.
If this fails, it waits for a pre-configured time, and then re-tries. If a
connection is broken for any reason, the server drops all
its watches, waits for a pre-configured time
and then attempts to re-connect. If the re-connection attempt is successful,
the watches are re-established.
.PP
The selection of translation template to be used for each instrument
is made according to
the value of a pre-configured field.
.PP
Normally, updates are sent as type 8 Bloomberg packets. However, if the
"Add indicator" is set for the instrument, a type 14 type packet is sent
instead. This indicator is set if a pre-configured field has a non-blank value.
.SH OPTIONS
.\" * parameters (in bold) and options (in italics) followed by a description
.IP "\fB\-trace \fITrace\fR{on | off | 0 - 3}"
Specifies the level of trace to be dumped out. The trace file is called
.I bloomS.out,
and is located in the directory specified by the parameter
.I TracePath
(see below). Normally, trace should be left off, unless otherwise directed
by JPA. The trace level may also be changed dynamically, by requesting the
instrument
.I trace=<level>
from the producer
.I CTRLbloomS.
The request will be denied, but the trace level will be changed.
.IP "\fB\-log \fILogging\fR{on | off}"
Specifies whether significant events and errors are to be logged.
The log file is called
.I bloomS.log,
and is located in the directory specified by the parameter
.I LogPath
(see below).
.IP "\fB\-tp \fITracePath\fR"
Specifies the location of the trace file,
.I bloomS.out.
.IP "\fB\-lp \fILogPath\fR"
Specifies the location of the log file,
.I bloomS.log.
.IP "\fB\-ep \fIEtcPath\fR"
Specifies the location of the instrument file,
.I bloomInstrs.txt
(see below).
.IP "\fB\-hn \fIHostName\fR"
Specifies the name of the Bloomberg host to connect to.
.IP "\fB\-port \fIPort\fR"
Specifies the number of the TCP/IP port on the target Bloomberg host.
.IP "\fB\-cc \fICityCode\fR"
Specifies the Bloomberg city code.
.IP "\fB\-bc \fIBankCode\fR"
Specifies the Bloomberg bank code.
.IP "\fB\-wt \fIWaitTime\fR"
Specifies the time in seconds that the server waits between start-up and
first connection attempt, between connection attempts, between successful
connection and initial watch requests, between connection loss and first
re-connection attempt, between re-connection attempts and between successful
re-connection and watch re-requests.
.IP "\fB\-ms \fIMaxSend\fR"
Specifies the maximum number of times that a packet can be re-sent before
the connection is dropped.
.IP "\fB\-ht \fIHeartTimeout\fR"
Specifies the time in seconds between sent heartbeats.
.IP "\fB\-at \fIAckTimeout\fR"
Specifies the time in seconds that can elapse before an unacknowledged packet is
re-sent.
.IP "\fB\-pt \fIPacketTimeout\fR"
Specifies the time in milliseconds that can elapse before an incompletely
filled type 8 or type 14 packet is sent anyway. Both these packet types can
be used to send multiple updates.
.IP "\fB\-tf \fITemplateField\fR"
Specifies the field containing the name of the template to be used.
.IP "\fB\-if \fIIdTypeField\fR"
Specifies the field containing the ID type.
.IP "\fB\-sf \fISecIdField\fR"
Specifies the field containing the security ID.
.IP "\fB\-af \fIAddIndField\fR"
Specifies the field containing the Add indicator. If this is set, a type 14
packet is sent instead of a type 8 one.
.IP "\fB\-pf \fIPageField\fR"
Specifies the field containing the page name. This is used for page
contribution using type 9 packets.
.IP "\fB\-rf \fIRowField\fR"
Specifies the field containing the row number. This is used for page
contribution using type 9 packets.
.IP "\fB\-cf \fICodeField\fR"
Specifies the field containing the product code. This is used for page
contribution using type 9 packets.
.IP "\fB\-cid \fICtrlID\fR"
Specifies the identifier to be used for control requests. If left unset,
the control producer is defined as
.I CTRLbloomS.
Otherwise, it is defined as
.I CTRLbloomS.n,
where n is the control identifier.
.IP "\fB\-ccf \fICountryCodeField\fR"
Specifies the field containing the country code. This is used for
type 21 packets.
.IP "\fB\-df \fIDateField\fR"
Specifies the field containing the date. This is used for
type 21 packets.
.SH OPTIONS
.\" * table of X11 defaults
The following defaults are recognized by
.I bloomS:
.sp
.TS
box;
c s s s
c c c c
l|l|l|l.
DF Defaults
=
Xdefault	Command Line	Type	Default Value
_
Trace	\-trace	String	off
Logging	\-log	String	off
TracePath	\-tp	Path	/usr/aws/jpa/publish/out
LogPath	\-lp	Path	/usr/aws/jpa/publish/log
EtcPath	\-ep	Path	/usr/aws/jpa/publish/etc
HostName	\-hn	String	NULL
Port	\-port	Integer	0
CityCode	\-cc	String	NULL
BankCode	\-bc	String	NULL
WaitTime	\-wt	Integer	10 seconds
MaxSend	\-ms	Integer	10
HeartTimeout	\-ht	Integer	15 seconds
AckTimeout	\-at	Integer	3 seconds
PacketTimeout	\-pt	Integer	100 milliseconds
TemplateField	\-tf	String	Template_Name
IdTypeField	\-if	String	ID_Type
SecIdField	\-sf	String	SEC_ID
AddIndField	\-af	String	ADD_IND
PageField	\-pf	String	PAGE
RowField	\-rf	String	ROW
CodeField	\-cf	String	CODE
CtrlID	\-cid	Integer	0
CountryCodeField	\-ccf	String	COUNTRY
DateField	\-df	String	DATE
.TE
.SH FILES
.\" * tab-separated list of files used by the component and a description
The instrument configuration file,
.I bloomInstrs.txt
specifies which producers are to
be watched, and what translations are to be made between incoming BTRS field
names and outgoing Bloomberg field codes. These translations are defined in
terms of templates, each of which roughly corresponds to a BTRS schema.
For each producer, a number of templates may be defined, and for each template,
a number of field translations may be defined.
.PP
This is an editable ASCII text file. Each line of this file consists
of a keyword, followed by
one or more parameters, separated by space or TAB characters.
The following keywords may be used:
.IP "\fIProducer\fR"
This takes a single mandatory parameter, the name of a BTRS producer group to
watch, and zero or more optional parameters. At present, the only optional
parameter is "autosuppress". If this is present, a type 14 "add" packet is sent
whenever an instrument is first created, and a type 14 "delete" packet is
sent whenever it is deleted; this is generally used in conjunction with
non-persistent instruments.  All subsequent lines up to the next
.I Producer
keyword relate to this producer group.
.IP "\fITemplate\fR"
This takes four parameters: the name of the template, the Bloomberg
packet type (8, 9 or 21), the Bloomberg record type and (for packet
type 9 only) the contribution identifier or (for packet type 21 only)
the fund type. The fourth parameter is not required for packet type 8.
All subsequent lines up to the next
.I Template
keyword relate to this template.
.IP "\fIField\fR"
In the case of packet types 8 and 21, this takes three parameters:
the inbound name of the BTRS field, the
outbound single-letter Bloomberg field code and (optionally) the name of
a linked field. If a linked field is specified, this field and the linked
field are always contributed together; whenever one of them changes, the
current values for both fields are contributed. In the case of packet
type 9, this keyword takes three paremeters: the column number, the width
of the field and (optionally) the justification. The justification may either
be 'L' (for left) or 'R' (for right).
.SH SEE ALSO
publishP(1J)
.IP "Other documentation"
The JPA Bloomberg Publishing Suite Programmer's Guide
.IP
Bloomberg Multi Product Feed Specification