scimport¶
Forward messages across two SeisComP systems.
Description¶
scimport is responsible to forward messages from one system to another. The difference to scimex is that scimport does not handle the messages event based. scimport supports two different modes. The relay mode does a simple mapping from GROUP:SYSTEM_A to GROUP:SYSTEM_B. This mode is default.
In case GROUP is not defined in the second system the message is forwarded to IMPORT_GROUP. The import mode supports custom mapping and filter functionality. It is possible to forward GROUP1:SYSTEM_A to GROUP2:SYSTEM_B. In addition the forwarded objects can be filtered by:
- Pick
Status
Mode
Phase
AgencyID
- Amplitude
Amplitude
- Origin
Location
Depth
AgencyID
Status
Mode
- Event
Type
- StationMagnitude
Type
- Magnitude
Type
Examples¶
Example scimport.cfg
# The address of the importing system
sink = sinkAddress
# This option has to be set if the application runs in import mode.
# The routing table has to be defined in the form of source_group:sink_group
routingtable = PICK:PICK
# List of sink groups to subscribe to. If this option is not set the message
# groups will be determined automatically. If this option is set but not
# needed for a setup it can be ignored with the option --ignore-groups
msggroups = GROUP_ONE, GROUP_TWO
# Available filter options
filter.pick.mode = manual
filter.pick.status = confirmed
filter.pick.phase = P
filter.pick.agencyID = GFZ
# Values: eq (==), lt (<=) ,gt (>=), *
filter.amplitude.operator = gt
filter.amplitude.amplitude = 100
# Values: lat0:lat1 (range)
filter.origin.latitude = -90:90
# Values: lon0:lon1 (range)
filter.origin.longitude = -180:180
filter.origin.depth = 0:100
filter.origin.agencyID = GFZ
# Values: automatic, manual
filter.origin.mode = manual
filter.origin.status = confirmed
# Values: earthquake, explosion, quarry blast, chemical explosion,
# nuclear explosion, landslide, debris avalanche, rockslide,
# mine collapse, volcanic eruption, meteor impact, plane crash,
# building collapse, sonic boom, other
filter.event.type = earthquake
# Values: Whatever your magnitudes are named
filter.stationMagnitude.type = MLv
# Values: Whatever your magnitudes are named
filter.magnitude.type = MLv
# Values: latency, delay, timing quality, gaps interval, gaps length,
# spikes interval, spikes amplitude, offset, rms
filter.qc.type = latency
Configuration¶
etc/defaults/global.cfg
etc/defaults/scimport.cfg
etc/global.cfg
etc/scimport.cfg
~/.seiscomp/global.cfg
~/.seiscomp/scimport.cfg
scimport inherits global options.
-
sink
¶ Type: string
URI of receiving host which runs scmaster. The URI contains the host name with an optional protocol and port.
Format: protocol://host:port
Examples:
- proc
- scmp://proc:18180
-
routingtable
¶ Type: list:string
This option has to be set if the application runs in import mode. The routing table has to be defined in the form of source_group:sink_group
-
msggroups
¶ Type: list:string
Defines a list of message groups of the source system (connection.server). If not specified the source system is queried for a list of message groups which are then used to check each subscription extracted from the routing table. This parameter allows to override to source query result.
-
useFilter
¶ Type: boolean
Default is
true
.
Note
filter.* Define filter criteria before sending
Note
filter.pick.* Criteria for filtering picks
-
filter.pick.mode
¶ Type: string
The mode of picks to filter for. Allowed values: “automatic” and “manual”.
-
filter.pick.status
¶ Type: string
The status of picks to filter for. Allowed values: “preliminary”, “confirmed”, “reviewed”, “final”, “rejected” and “reported”.
-
filter.pick.phase
¶ Type: string
The pick phase hint to filter for. Allowed values: all possible phase codes.
-
filter.pick.agencyIDs
¶ Type: list:string
The pick agencyIDs to filter for. Allowed values: all possible agency ids;
-
filter.pick.networkCode
¶ Type: string
The pick network code of the processed waveforms. Allowed values: all possible network codes.
Note
filter.amplitude.* Criteria for filtering amplitudes
-
filter.amplitude.operator
¶ Type: string
The amplitude comparison operator. Allowed values: “eq”, “lt”, “gt” and “*”.
-
filter.amplitude.amplitude
¶ Type: double
The amplitude threshold to filter for. The operator configured with “operator” is used to compare this threshold with the incoming value. If “operator” is “*” then values will pass.
-
filter.amplitude.agencyIDs
¶ Type: list:string
The amplitude agencyIDs to filter for. Allowed values: all possible agency ids.
Note
filter.origin.* Criteria for filtering origins
-
filter.origin.latitude
¶ Type: string
The latitude range in format [min]:[max].
-
filter.origin.longitude
¶ Type: string
The longitude range in format [min]:[max].
-
filter.origin.depth
¶ Type: string
The depth range in format [min]:[max].
-
filter.origin.agencyIDs
¶ Type: list:string
The origin agencyIDs to filter for. Allowed values: all possible agency ids;
-
filter.origin.mode
¶ Type: string
The origin evaluation mode to filter for. Allowed values: “automatic” and “manual”.
-
filter.origin.status
¶ Type: string
The origin status to filter for. Allowed values: “preliminary”, “confirmed”, “reviewed”, “final”, “rejected” and “reported”.
-
filter.origin.arrivalcount
¶ Type: string
The minimum number of arrivals of an origin to pass the filter.
Note
filter.event.* Criteria for filtering events
-
filter.event.type
¶ Type: string
The event type to filter for, e.g. “earthquake”, “explosion” …
Note
filter.stationMagnitude.* Criteria for filtering station magnitudes
-
filter.stationMagnitude.type
¶ Type: string
The station magnitude type. Allowed values: all possible magnitude types such as “MLv”.
Note
filter.magnitude.* Criteria for filtering network magnitudes
-
filter.magnitude.type
¶ Type: string
The magnitude type. Allowed values: all possible magnitude types such as “MLv”.
Note
filter.qc.* Criteria for filtering QC parameters
-
filter.qc.type
¶ Type: string
The QC parameter type. Allowed values: all possible types such as “latency”, “delay” …
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.
-
--content-type
arg
¶ Overrides configuration parameter
connection.contentType
.
-
--start-stop-msg
arg
¶ Sets sending of a start- and a stop message.
Import¶
-
-i
,
--import
¶
Switch to import mode (default is relay). Im import mode the routing table has to be specified whereas in relay the routing table will be calculated automatically.
-
--no-filter
¶
Disable message filtering and ignore all configured filters.
-
--routeunknowngroup
¶
Route unknown groups to the default group IMPORT_GROUP.
-
--ignore-groups
¶
Ignore user specified groups.
-
--test
¶
Do not send any messages.