QCG Notification v. 2.6 Technical Guide and Manual

Bartosz Bosak

<$ createdb qcg-ntf

and set up a table structure using the command:

$ createdb qcg-ntf

and set up a table structure using the qcg-ntf-psql.sql file from QCG Notification distribution - it can be found in /opt/qcg/share/tools directory by default.

$ psql -d qcg-ntf -U qcg-ntf < qcg-ntf-psql.sql

Eventually you need to add this database as the ODBC D ata Source Name. You can do this by editing system-wide configuration file (e.g. [string]

URL of the SMTP server. Mandatory element.

//smn:User [string]

Name of the account on SMTP server. Optional element.

//smn:Password [string]

The secret key for the account. Optional element.

//smn:Encryption [string]

Used to enable encryption. The only supported type of encryption is "TLS". Optional element, if not present, encryption will be switched off.

//smn:TrutedCAFile [string]

A path to the file with trusted CAs certificates. Optional element.

//smn:TrutedCAPath [string]

A path to the directory with the files with trusted CAs certificates. Optional element.

//smn:From [string]

Defines a name that will be placed in From field of the e-mail message. Optional element. Default is "QCG-Notification".

//smn:Subject [string]

Defines a Subject of the e-mail message. Optional element. Default is "QCG-Notification message".

//smn:Trace [boolean]

Switches trace logging. Optional element, default is false.

//smn:SendTimeout [int]

The timeout in seconds for stall on the send function. Optional element, default is 10.

5.3. WS-Topics man agement

In the current release, a topics management in QCG Notification is relatively simple. The first step is a preparation of an XML document with a Topic Namespace definition. This step can be done by one of the peers cooperating with QCG Notification. Then the document should be delivered to the computer where QCG Notification is installed. It can be done in two ways: the document may be copied manually by QCG Notification administrator to TopicNamespaces directory in prior to a QCG Notification startup or it can be send through the QCG Notification interface when QCG Notification is already runing. In the last case, the TopicNamespaces are stored also in a files in TopicNamespace directory so they can be automatically loaded after restart of the service. The TopicNamespaces loaded from files may be protected from unwanted removal by unseting write permissions for a certain file.

An XML document describing a sample topic namespace is presented in the Section 3.3.

5.4. Starting QCG Notification

To start QCG Notification as a daemon type:

$ ./qcg-ntfd

If you start QCG Notification with parameter -h you will get an optional parameters list:

$ ./qcg-ntfd -h
usage: ./qcg-ntfd [-d] [-z config_file]

  -d              do not detach and log to stderr
  -D              do not detach and force logging at debug level to stderr
  -z config_file  configuration file, default is /opt/qcg/etc/qcg-ntfd.xml
  -v              print version information
  -h              print this help

Once you run QCG Notification as a daemon, a log file is created. Using various log levels, you can log less or more details.

5.5. Stopping QCG No tification

At the moment, shutdown is performed simply by sending SIGINT signal to the service, e.g.:

$ kill -SIGINT `pidof qcg-ntfd`