scdispatch

Reads objects (event, origin, etc) from a SC3ML file and sends the objects to the messaging system.

Description

scdispatch reads an SC3ML file and creates notifier objects for them that are sent to the corresponding messaging groups (see routingtable). In contrast to scdb which writes SC3ML files directly into the database scdispatch uses the messaging bus. If scmaster is configured with the database plugin messages will end up in the database as well.

scdispatch can work in two modes. The first mode is used when a concrete operation is specified such as add, update or remove. In that case all objects in the SC3ML are encapsulated in a notifier with that specific operation and sent to the messaging. No check is performed if the object is already in the database or not.

In the second mode scdispatch loads the corresponding objects from the database and calculates differences. It will then create corresponding notifiers with operations add, update or remove and sent them to the messaging. That mode is quite close to a sync operation with the exception that top level objects (such as origin or event) that are not part of the input SC3ML are left untouched in the database. It can be used to synchronize event information from one system with another.

Examples

1. Send different objects from a SC3ML file because the default behavior is to merge:

   scdispatch -i test.xml
   

2. Send new objects:

   scdispatch -i test.xml -O add
   

3. Send an update:

   scdispatch -i test.xml -O update
   

4. Remove the objects:

   scdispatch -i test.xml -O remove
   

5. Subsets of SC3ML Objects

   It can be useful to import a subset of QuakeML objects, e.g. Origins from other agencies and then allow scevent to associate them to existing events (and possibly prefer them based on the rules in scevent) or create new events for the origins. If the event objects from a SC3ML file are not required to be sent to the messaging then either they should be removed (e.g. using XSLT) and all the remaining objects in the file added:

   scdispatch -i test.xml -O add
   

   or the event objects can be left out of the routing table, e.g.

   scdispatch -i test.xml -O add \
              --routingtable Pick:PICK, \
                             Amplitude:AMPLITUDE, \
                             Origin:LOCATION,StationMagnitude:MAGNITUDE, \
                             Magnitude:MAGNITUDE
   

6. Testing

   For testing it is useful to watch the results of dispatch with scolv or scxmldump. It is also useful to clean the database and logs to remove objects from persistent storage to allow repeated reloading of a file.

   Note

   The following will clear all events from the database and any other other object persistence. Modify the mysql command to suit your db setup.

   mysql -u root --password='my$q1' -e "DROP DATABASE IF EXISTS seiscomp3; \
     CREATE DATABASE seiscomp3 CHARACTER SET utf8 COLLATE utf8_bin; \
     GRANT ALL ON seiscomp3.* TO 'sysop'@'localhost' IDENTIFIED BY 'sysop'; \
     USE seiscomp3;source seiscomp3/trunk/share/db/mysql.sql;"
   
   seiscomp start
   

Configuration

etc/defaults/global.cfg

etc/defaults/scdispatch.cfg

etc/global.cfg

etc/scdispatch.cfg

~/.seiscomp3/global.cfg

~/.seiscomp3/scdispatch.cfg

scdispatch inherits global options.

Command-line

Generic

-h, --help

show help message.

-V, --version

show version information

--config-file arg

Use alternative configuration file. When this option is used the loading of all stages is disabled. Only the given configuration file is parsed and used. To use another name for the configuration create a symbolic link of the application or copy it, eg scautopick -> scautopick2.

--plugins arg

Load given plugins.

-D, --daemon

Run as daemon. This means the application will fork itself and doesn’t need to be started with &.

--auto-shutdown arg

Enable/disable self-shutdown because a master module shutdown. This only works when messaging is enabled and the master module sends a shutdown message (enabled with –start-stop-msg for the master module).

--shutdown-master-module arg

Sets the name of the master-module used for auto-shutdown. This is the application name of the module actually started. If symlinks are used then it is the name of the symlinked application.

--shutdown-master-username arg

Sets the name of the master-username of the messaging used for auto-shutdown. If “shutdown-master-module” is given as well this parameter is ignored.

Verbosity

--verbosity arg

Verbosity level [0..4]. 0:quiet, 1:error, 2:warning, 3:info, 4:debug

-v, --v

Increase verbosity level (may be repeated, eg. -vv)

-q, --quiet

Quiet mode: no logging output

--component arg

Limits the logging to a certain component. This option can be given more than once.

-s, --syslog

Use syslog logging back end. The output usually goes to /var/lib/messages.

-l, --lockfile arg

Path to lock file.

--console arg

Send log output to stdout.

--debug

Debug mode: –verbosity=4 –console=1

--log-file arg

Use alternative log file.

Messaging

-u, --user arg

Overrides configuration parameter connection.username.

-H, --host arg

Overrides configuration parameter connection.server.

-t, --timeout arg

Overrides configuration parameter connection.timeout.

-g, --primary-group arg

Overrides configuration parameter connection.primaryGroup.

-S, --subscribe-group arg

A group to subscribe to. This option can be given more than once.

--encoding arg

Overrides configuration parameter connection.encoding.

--start-stop-msg arg

Sets sending of a start- and a stop message.

Database

--db-driver-list

List all supported database drivers.

-d, --database arg

The database connection string, format: service://user:pwd@host/database. “service” is the name of the database driver which can be queried with “–db-driver-list”.

--config-module arg

The configmodule to use.

--inventory-db arg

Load the inventory from the given database or file, format: [service://]location

--db-disable

Do not use the database at all

Dispatch

-i, --input flag

File to dispatch to messaging.

-O, --operation flag

Operation to use: add, update, remove, merge or merge-without-remove. Merge and merge-without-remove are special operations and require a database connection. Both will read a corresponding object from the database and calculate the differences which will be sent to the messaging. Merge-no-remove behaves like merge with the exception that remove operations will be filtered out that no objects in the database will be removed.

If add, update or remove is specified then all objects in XML are sent with the given operation regardless of their existence in the database or not.

--routingtable flag

Specify routing table as comma separated list of object:group pairs, e.g. “Origin:LOCATION,Event:EVENT”. When an objects should be routed to a group and no table entry for that perticular class type is available, all parent objects are checked for valid routing entries and the first found is used. E.g. if only “Origin:LOCATION” is specified but the input file contains also Arrivals which are child objects of Origin then the routing entry of Origin is used because of the parent-child relationship between Origin and Arrival.

--print-objects

Print names of routable objects.

--test

Test mode. Does not send any object.