|
|
<!DOCTYPE html>
|
|
|
|
|
|
<html >
|
|
|
<head>
|
|
|
<meta charset="utf-8" />
|
|
|
<title>scdispatch — SeisComP Release documentation</title>
|
|
|
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
|
|
<link rel="stylesheet" href="../_static/seiscomp.css" type="text/css" />
|
|
|
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css" />
|
|
|
<script type="text/javascript" src="../_static/seiscomp.js"></script>
|
|
|
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
|
|
<script src="../_static/jquery.js"></script>
|
|
|
<script src="../_static/underscore.js"></script>
|
|
|
<script src="../_static/doctools.js"></script>
|
|
|
<script src="../_static/language_data.js"></script>
|
|
|
<link rel="shortcut icon" href="../_static/favicon.ico"/>
|
|
|
<link rel="index" title="Index" href="../genindex.html" />
|
|
|
<link rel="search" title="Search" href="../search.html" />
|
|
|
<link rel="next" title="scdumpcfg" href="scdumpcfg.html" />
|
|
|
<link rel="prev" title="scdbstrip" href="scdbstrip.html" />
|
|
|
</head>
|
|
|
<body>
|
|
|
<div class="header">
|
|
|
<div class="container">
|
|
|
<div class="brand">
|
|
|
<img class="logo" src="../_static/brands/seiscomp/text/white.svg"/>
|
|
|
<!-- span class="title">SeisComP Release</span -->
|
|
|
<span class="version">5.3.0</span>
|
|
|
</div>
|
|
|
</div>
|
|
|
</div>
|
|
|
<div class="nav">
|
|
|
<div class="container">
|
|
|
<div class="content"><a class="pull-right" id="sidebar-toggle">TOC</a>
|
|
|
|
|
|
<div class="related" role="navigation" aria-label="related navigation">
|
|
|
<ul>
|
|
|
<li class="right">
|
|
|
<a href="../genindex.html" title="General Index"
|
|
|
accesskey="I">
|
|
|
index
|
|
|
</a>
|
|
|
</li>
|
|
|
<li class="right">
|
|
|
<a href="scdumpcfg.html" title="scdumpcfg"
|
|
|
accesskey="N">
|
|
|
next
|
|
|
</a>
|
|
|
</li>
|
|
|
<li class="right">
|
|
|
<a href="scdbstrip.html" title="scdbstrip"
|
|
|
accesskey="P">
|
|
|
previous
|
|
|
</a>
|
|
|
</li>
|
|
|
<li class="nav-item nav-item-0">
|
|
|
<a href="../index.html">Home</a>
|
|
|
</li>
|
|
|
<li class="nav-item nav-item-1">
|
|
|
<a href="../modules.html" >Modules</a>
|
|
|
</li>
|
|
|
<li class="nav-item nav-item-2">
|
|
|
<a href="../toc/utilities.html" accesskey="U">Utilities</a>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</div>
|
|
|
</div>
|
|
|
</div>
|
|
|
</div>
|
|
|
<div class="container">
|
|
|
<div class="fitted content" id="anchors-container">
|
|
|
<div class="body" role="main">
|
|
|
|
|
|
<div class="section" id="scdispatch">
|
|
|
<span id="id1"></span><h1>scdispatch<a class="headerlink" href="#scdispatch" title="Permalink to this headline">¶</a></h1>
|
|
|
<p><strong>Read objects (event, origin, etc) from a SCML file and sends the objects
|
|
|
to the messaging system.</strong></p>
|
|
|
<div class="section" id="description">
|
|
|
<h2>Description<a class="headerlink" href="#description" title="Permalink to this headline">¶</a></h2>
|
|
|
<p>scdispatch reads an <a class="reference internal" href="../base/glossary.html#term-scml"><span class="xref std std-term">SCML</span></a> file and creates notifier objects for them that
|
|
|
are sent to the corresponding messaging groups (see <a class="reference internal" href="scimport.html#confval-routingtable"><code class="xref std std-confval docutils literal notranslate"><span class="pre">routingtable</span></code></a>).
|
|
|
In contrast to <a class="reference internal" href="scdb.html#scdb"><span class="std std-ref">scdb</span></a> which writes SCML files directly into the database
|
|
|
scdispatch uses the messaging bus. If <a class="reference internal" href="scmaster.html#scmaster"><span class="std std-ref">scmaster</span></a> is configured with
|
|
|
the database plugin messages will end up in the database as well.</p>
|
|
|
<p>scdispatch can work in two modes. The first mode is used when a concrete
|
|
|
operation is specified such as <em>add</em>, <em>update</em> or <em>remove</em>. In that case all
|
|
|
objects in the SCML 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.</p>
|
|
|
<p>In the second mode scdispatch loads the corresponding objects from the database
|
|
|
and calculates differences. It will then create corresponding notifiers with
|
|
|
operations <em>add</em>, <em>update</em> or <em>remove</em> 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 SCML are left untouched
|
|
|
in the database. It can be used to synchronize event information from one system
|
|
|
with another.</p>
|
|
|
</div>
|
|
|
<div class="section" id="examples">
|
|
|
<h2>Examples<a class="headerlink" href="#examples" title="Permalink to this headline">¶</a></h2>
|
|
|
<ol class="arabic">
|
|
|
<li><p>Send different objects from a <a class="reference internal" href="../base/glossary.html#term-scml"><span class="xref std std-term">SCML</span></a> file because the default behavior is to merge:</p>
|
|
|
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>scdispatch -i test.xml
|
|
|
</pre></div>
|
|
|
</div>
|
|
|
</li>
|
|
|
<li><p>Send new objects:</p>
|
|
|
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>scdispatch -i test.xml -O add
|
|
|
</pre></div>
|
|
|
</div>
|
|
|
</li>
|
|
|
<li><p>Send an update:</p>
|
|
|
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>scdispatch -i test.xml -O update
|
|
|
</pre></div>
|
|
|
</div>
|
|
|
</li>
|
|
|
<li><p>Remove the objects:</p>
|
|
|
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>scdispatch -i test.xml -O remove
|
|
|
</pre></div>
|
|
|
</div>
|
|
|
</li>
|
|
|
<li><p>Subsets of SCML Objects</p>
|
|
|
<p>It can be useful to import a subset of QuakeML objects, e.g. Origins from other
|
|
|
agencies and then allow <a class="reference internal" href="scevent.html#scevent"><span class="std std-ref">scevent</span></a> 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 SCML 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:</p>
|
|
|
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>scdispatch -i test.xml -O add
|
|
|
</pre></div>
|
|
|
</div>
|
|
|
<p>or the <strong>event objects</strong> can be left out of the routing table, e.g.</p>
|
|
|
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>scdispatch -i test.xml -O add <span class="se">\</span>
|
|
|
--routingtable Pick:PICK, <span class="se">\</span>
|
|
|
Amplitude:AMPLITUDE, <span class="se">\</span>
|
|
|
Origin:LOCATION,StationMagnitude:MAGNITUDE, <span class="se">\</span>
|
|
|
Magnitude:MAGNITUDE
|
|
|
</pre></div>
|
|
|
</div>
|
|
|
<div class="admonition hint">
|
|
|
<p class="admonition-title">Hint</p>
|
|
|
<p>The option <code class="docutils literal notranslate"><span class="pre">--no-event</span></code> is a wrapper for removing Event:EVENT from
|
|
|
the routing table. With this option no event objects will be sent which may
|
|
|
be useful if just the origins with magnitudes, amplitudes, arrivals, picks, etc.
|
|
|
shall be integrated, e.g. after XML-based playbacks.</p>
|
|
|
</div>
|
|
|
</li>
|
|
|
<li><p>Testing</p>
|
|
|
<p>For testing it is useful to watch the results of dispatch with <a class="reference internal" href="scolv.html#scolv"><span class="std std-ref">scolv</span></a> or
|
|
|
<a class="reference internal" href="scxmldump.html#scxmldump"><span class="std std-ref">scxmldump</span></a>. It is also useful to clean the database and logs to remove
|
|
|
objects from persistent storage to allow repeated reloading of a file.</p>
|
|
|
<div class="admonition note">
|
|
|
<p class="admonition-title">Note</p>
|
|
|
<p>The following will clear all events from the database and any other
|
|
|
other object persistence. Modify the mysql command to suit your db setup.</p>
|
|
|
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>mysql -u root --password<span class="o">=</span><span class="s1">'my$q1'</span> -e <span class="s2">"DROP DATABASE IF EXISTS seiscomp; \</span>
|
|
|
<span class="s2"> CREATE DATABASE seiscomp CHARACTER SET utf8 COLLATE utf8_bin; \</span>
|
|
|
<span class="s2"> GRANT ALL ON seiscomp.* TO 'sysop'@'localhost' IDENTIFIED BY 'sysop'; \</span>
|
|
|
<span class="s2"> USE seiscomp;source seiscomp/trunk/share/db/mysql.sql;"</span>
|
|
|
|
|
|
seiscomp start
|
|
|
</pre></div>
|
|
|
</div>
|
|
|
</div>
|
|
|
</li>
|
|
|
</ol>
|
|
|
</div>
|
|
|
<div class="section" id="module-configuration">
|
|
|
<span id="scdispatch-configuration"></span><h2>Module Configuration<a class="headerlink" href="#module-configuration" title="Permalink to this headline">¶</a></h2>
|
|
|
<div class="line-block">
|
|
|
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/defaults/global.cfg</span></code></div>
|
|
|
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/defaults/scdispatch.cfg</span></code></div>
|
|
|
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/global.cfg</span></code></div>
|
|
|
<div class="line"><code class="file docutils literal notranslate"><span class="pre">etc/scdispatch.cfg</span></code></div>
|
|
|
<div class="line"><code class="file docutils literal notranslate"><span class="pre">~/.seiscomp/global.cfg</span></code></div>
|
|
|
<div class="line"><code class="file docutils literal notranslate"><span class="pre">~/.seiscomp/scdispatch.cfg</span></code></div>
|
|
|
</div>
|
|
|
<p>scdispatch inherits <a class="reference internal" href="global.html#global-configuration"><span class="std std-ref">global options</span></a>.</p>
|
|
|
</div>
|
|
|
<div class="section" id="command-line-options">
|
|
|
<h2>Command-Line Options<a class="headerlink" href="#command-line-options" title="Permalink to this headline">¶</a></h2>
|
|
|
<p><strong class="program">scdispatch [options]</strong></p>
|
|
|
<div class="section" id="generic">
|
|
|
<h3>Generic<a class="headerlink" href="#generic" title="Permalink to this headline">¶</a></h3>
|
|
|
<dl class="option">
|
|
|
<dt id="cmdoption-scdispatch-h">
|
|
|
<code class="sig-name descname">-h</code><code class="sig-prename descclassname"></code><code class="sig-prename descclassname">, </code><code class="sig-name descname">--help</code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-scdispatch-h" title="Permalink to this definition">¶</a></dt>
|
|
|
<dd><p>Show help message.</p>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="option">
|
|
|
<dt id="cmdoption-scdispatch-v">
|
|
|
<code class="sig-name descname">-V</code><code class="sig-prename descclassname"></code><code class="sig-prename descclassname">, </code><code class="sig-name descname">--version</code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-scdispatch-v" title="Permalink to this definition">¶</a></dt>
|
|
|
<dd><p>Show version information.</p>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="option">
|
|
|
<dt id="cmdoption-scdispatch-config-file">
|
|
|
<code class="sig-name descname">--config-file</code><code class="sig-prename descclassname"> arg</code><a class="headerlink" href="#cmdoption-scdispatch-config-file" title="Permalink to this definition">¶</a></dt>
|
|
|
<dd><p>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. Example:
|
|
|
scautopick -> scautopick2.</p>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="option">
|
|
|
<dt id="cmdoption-scdispatch-plugins">
|
|
|
<code class="sig-name descname">--plugins</code><code class="sig-prename descclassname"> arg</code><a class="headerlink" href="#cmdoption-scdispatch-plugins" title="Permalink to this definition">¶</a></dt>
|
|
|
<dd><p>Load given plugins.</p>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="option">
|
|
|
<dt id="cmdoption-scdispatch-d">
|
|
|
<code class="sig-name descname">-D</code><code class="sig-prename descclassname"></code><code class="sig-prename descclassname">, </code><code class="sig-name descname">--daemon</code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-scdispatch-d" title="Permalink to this definition">¶</a></dt>
|
|
|
<dd><p>Run as daemon. This means the application will fork itself
|
|
|
and doesn’t need to be started with &.</p>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="option">
|
|
|
<dt id="cmdoption-scdispatch-auto-shutdown">
|
|
|
<code class="sig-name descname">--auto-shutdown</code><code class="sig-prename descclassname"> arg</code><a class="headerlink" href="#cmdoption-scdispatch-auto-shutdown" title="Permalink to this definition">¶</a></dt>
|
|
|
<dd><p>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).</p>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="option">
|
|
|
<dt id="cmdoption-scdispatch-shutdown-master-module">
|
|
|
<code class="sig-name descname">--shutdown-master-module</code><code class="sig-prename descclassname"> arg</code><a class="headerlink" href="#cmdoption-scdispatch-shutdown-master-module" title="Permalink to this definition">¶</a></dt>
|
|
|
<dd><p>Set 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.</p>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="option">
|
|
|
<dt id="cmdoption-scdispatch-shutdown-master-username">
|
|
|
<code class="sig-name descname">--shutdown-master-username</code><code class="sig-prename descclassname"> arg</code><a class="headerlink" href="#cmdoption-scdispatch-shutdown-master-username" title="Permalink to this definition">¶</a></dt>
|
|
|
<dd><p>Set 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.</p>
|
|
|
</dd></dl>
|
|
|
|
|
|
</div>
|
|
|
<div class="section" id="verbosity">
|
|
|
<h3>Verbosity<a class="headerlink" href="#verbosity" title="Permalink to this headline">¶</a></h3>
|
|
|
<dl class="option">
|
|
|
<dt id="cmdoption-scdispatch-verbosity">
|
|
|
<code class="sig-name descname">--verbosity</code><code class="sig-prename descclassname"> arg</code><a class="headerlink" href="#cmdoption-scdispatch-verbosity" title="Permalink to this definition">¶</a></dt>
|
|
|
<dd><p>Verbosity level [0..4]. 0:quiet, 1:error, 2:warning, 3:info,
|
|
|
4:debug.</p>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="option">
|
|
|
<dt id="id2">
|
|
|
<code class="sig-name descname">-v</code><code class="sig-prename descclassname"></code><code class="sig-prename descclassname">, </code><code class="sig-name descname">--v</code><code class="sig-prename descclassname"></code><a class="headerlink" href="#id2" title="Permalink to this definition">¶</a></dt>
|
|
|
<dd><p>Increase verbosity level (may be repeated, eg. -vv).</p>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="option">
|
|
|
<dt id="cmdoption-scdispatch-q">
|
|
|
<code class="sig-name descname">-q</code><code class="sig-prename descclassname"></code><code class="sig-prename descclassname">, </code><code class="sig-name descname">--quiet</code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-scdispatch-q" title="Permalink to this definition">¶</a></dt>
|
|
|
<dd><p>Quiet mode: no logging output.</p>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="option">
|
|
|
<dt id="cmdoption-scdispatch-component">
|
|
|
<code class="sig-name descname">--component</code><code class="sig-prename descclassname"> arg</code><a class="headerlink" href="#cmdoption-scdispatch-component" title="Permalink to this definition">¶</a></dt>
|
|
|
<dd><p>Limit the logging to a certain component. This option can
|
|
|
be given more than once.</p>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="option">
|
|
|
<dt id="cmdoption-scdispatch-s">
|
|
|
<code class="sig-name descname">-s</code><code class="sig-prename descclassname"></code><code class="sig-prename descclassname">, </code><code class="sig-name descname">--syslog</code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-scdispatch-s" title="Permalink to this definition">¶</a></dt>
|
|
|
<dd><p>Use syslog logging backend. The output usually goes to
|
|
|
/var/lib/messages.</p>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="option">
|
|
|
<dt id="cmdoption-scdispatch-l">
|
|
|
<code class="sig-name descname">-l</code><code class="sig-prename descclassname"></code><code class="sig-prename descclassname">, </code><code class="sig-name descname">--lockfile</code><code class="sig-prename descclassname"> arg</code><a class="headerlink" href="#cmdoption-scdispatch-l" title="Permalink to this definition">¶</a></dt>
|
|
|
<dd><p>Path to lock file.</p>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="option">
|
|
|
<dt id="cmdoption-scdispatch-console">
|
|
|
<code class="sig-name descname">--console</code><code class="sig-prename descclassname"> arg</code><a class="headerlink" href="#cmdoption-scdispatch-console" title="Permalink to this definition">¶</a></dt>
|
|
|
<dd><p>Send log output to stdout.</p>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="option">
|
|
|
<dt id="cmdoption-scdispatch-debug">
|
|
|
<code class="sig-name descname">--debug</code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-scdispatch-debug" title="Permalink to this definition">¶</a></dt>
|
|
|
<dd><p>Execute in debug mode.
|
|
|
Equivalent to –verbosity=4 –console=1 .</p>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="option">
|
|
|
<dt id="cmdoption-scdispatch-log-file">
|
|
|
<code class="sig-name descname">--log-file</code><code class="sig-prename descclassname"> arg</code><a class="headerlink" href="#cmdoption-scdispatch-log-file" title="Permalink to this definition">¶</a></dt>
|
|
|
<dd><p>Use alternative log file.</p>
|
|
|
</dd></dl>
|
|
|
|
|
|
</div>
|
|
|
<div class="section" id="messaging">
|
|
|
<h3>Messaging<a class="headerlink" href="#messaging" title="Permalink to this headline">¶</a></h3>
|
|
|
<dl class="option">
|
|
|
<dt id="cmdoption-scdispatch-u">
|
|
|
<code class="sig-name descname">-u</code><code class="sig-prename descclassname"></code><code class="sig-prename descclassname">, </code><code class="sig-name descname">--user</code><code class="sig-prename descclassname"> arg</code><a class="headerlink" href="#cmdoption-scdispatch-u" title="Permalink to this definition">¶</a></dt>
|
|
|
<dd><p>Overrides configuration parameter <a class="reference internal" href="global.html#confval-connection.username"><code class="xref std std-confval docutils literal notranslate"><span class="pre">connection.username</span></code></a>.</p>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="option">
|
|
|
<dt id="cmdoption-scdispatch-host">
|
|
|
<code class="sig-name descname">-H</code><code class="sig-prename descclassname"></code><code class="sig-prename descclassname">, </code><code class="sig-name descname">--host</code><code class="sig-prename descclassname"> arg</code><a class="headerlink" href="#cmdoption-scdispatch-host" title="Permalink to this definition">¶</a></dt>
|
|
|
<dd><p>Overrides configuration parameter <a class="reference internal" href="global.html#confval-connection.server"><code class="xref std std-confval docutils literal notranslate"><span class="pre">connection.server</span></code></a>.</p>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="option">
|
|
|
<dt id="cmdoption-scdispatch-t">
|
|
|
<code class="sig-name descname">-t</code><code class="sig-prename descclassname"></code><code class="sig-prename descclassname">, </code><code class="sig-name descname">--timeout</code><code class="sig-prename descclassname"> arg</code><a class="headerlink" href="#cmdoption-scdispatch-t" title="Permalink to this definition">¶</a></dt>
|
|
|
<dd><p>Overrides configuration parameter <a class="reference internal" href="global.html#confval-connection.timeout"><code class="xref std std-confval docutils literal notranslate"><span class="pre">connection.timeout</span></code></a>.</p>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="option">
|
|
|
<dt id="cmdoption-scdispatch-g">
|
|
|
<code class="sig-name descname">-g</code><code class="sig-prename descclassname"></code><code class="sig-prename descclassname">, </code><code class="sig-name descname">--primary-group</code><code class="sig-prename descclassname"> arg</code><a class="headerlink" href="#cmdoption-scdispatch-g" title="Permalink to this definition">¶</a></dt>
|
|
|
<dd><p>Overrides configuration parameter <a class="reference internal" href="global.html#confval-connection.primaryGroup"><code class="xref std std-confval docutils literal notranslate"><span class="pre">connection.primaryGroup</span></code></a>.</p>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="option">
|
|
|
<dt id="cmdoption-scdispatch-subscribe-group">
|
|
|
<code class="sig-name descname">-S</code><code class="sig-prename descclassname"></code><code class="sig-prename descclassname">, </code><code class="sig-name descname">--subscribe-group</code><code class="sig-prename descclassname"> arg</code><a class="headerlink" href="#cmdoption-scdispatch-subscribe-group" title="Permalink to this definition">¶</a></dt>
|
|
|
<dd><p>A group to subscribe to.
|
|
|
This option can be given more than once.</p>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="option">
|
|
|
<dt id="cmdoption-scdispatch-content-type">
|
|
|
<code class="sig-name descname">--content-type</code><code class="sig-prename descclassname"> arg</code><a class="headerlink" href="#cmdoption-scdispatch-content-type" title="Permalink to this definition">¶</a></dt>
|
|
|
<dd><p>Overrides configuration parameter <a class="reference internal" href="global.html#confval-connection.contentType"><code class="xref std std-confval docutils literal notranslate"><span class="pre">connection.contentType</span></code></a>.</p>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="option">
|
|
|
<dt id="cmdoption-scdispatch-start-stop-msg">
|
|
|
<code class="sig-name descname">--start-stop-msg</code><code class="sig-prename descclassname"> arg</code><a class="headerlink" href="#cmdoption-scdispatch-start-stop-msg" title="Permalink to this definition">¶</a></dt>
|
|
|
<dd><p>Set sending of a start and a stop message.</p>
|
|
|
</dd></dl>
|
|
|
|
|
|
</div>
|
|
|
<div class="section" id="database">
|
|
|
<h3>Database<a class="headerlink" href="#database" title="Permalink to this headline">¶</a></h3>
|
|
|
<dl class="option">
|
|
|
<dt id="cmdoption-scdispatch-db-driver-list">
|
|
|
<code class="sig-name descname">--db-driver-list</code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-scdispatch-db-driver-list" title="Permalink to this definition">¶</a></dt>
|
|
|
<dd><p>List all supported database drivers.</p>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="option">
|
|
|
<dt id="cmdoption-scdispatch-database">
|
|
|
<code class="sig-name descname">-d</code><code class="sig-prename descclassname"></code><code class="sig-prename descclassname">, </code><code class="sig-name descname">--database</code><code class="sig-prename descclassname"> arg</code><a class="headerlink" href="#cmdoption-scdispatch-database" title="Permalink to this definition">¶</a></dt>
|
|
|
<dd><p>The database connection string, format:
|
|
|
<a class="reference external" href="service://user:pwd@host/database">service://user:pwd@host/database</a>.
|
|
|
“service” is the name of the database driver which
|
|
|
can be queried with “–db-driver-list”.</p>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="option">
|
|
|
<dt id="cmdoption-scdispatch-config-module">
|
|
|
<code class="sig-name descname">--config-module</code><code class="sig-prename descclassname"> arg</code><a class="headerlink" href="#cmdoption-scdispatch-config-module" title="Permalink to this definition">¶</a></dt>
|
|
|
<dd><p>The config module to use.</p>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="option">
|
|
|
<dt id="cmdoption-scdispatch-inventory-db">
|
|
|
<code class="sig-name descname">--inventory-db</code><code class="sig-prename descclassname"> arg</code><a class="headerlink" href="#cmdoption-scdispatch-inventory-db" title="Permalink to this definition">¶</a></dt>
|
|
|
<dd><p>Load the inventory from the given database or file, format:
|
|
|
[<a class="reference external" href="service://]location">service://]location</a> .</p>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="option">
|
|
|
<dt id="cmdoption-scdispatch-db-disable">
|
|
|
<code class="sig-name descname">--db-disable</code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-scdispatch-db-disable" title="Permalink to this definition">¶</a></dt>
|
|
|
<dd><p>Do not use the database at all</p>
|
|
|
</dd></dl>
|
|
|
|
|
|
</div>
|
|
|
<div class="section" id="dispatch">
|
|
|
<h3>Dispatch<a class="headerlink" href="#dispatch" title="Permalink to this headline">¶</a></h3>
|
|
|
<dl class="option">
|
|
|
<dt id="cmdoption-scdispatch-i">
|
|
|
<code class="sig-name descname">-i</code><code class="sig-prename descclassname"></code><code class="sig-prename descclassname">, </code><code class="sig-name descname">--input</code><code class="sig-prename descclassname"> flag</code><a class="headerlink" href="#cmdoption-scdispatch-i" title="Permalink to this definition">¶</a></dt>
|
|
|
<dd><p>File to dispatch to messaging.</p>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="option">
|
|
|
<dt id="cmdoption-scdispatch-o">
|
|
|
<code class="sig-name descname">-O</code><code class="sig-prename descclassname"></code><code class="sig-prename descclassname">, </code><code class="sig-name descname">--operation</code><code class="sig-prename descclassname"> flag</code><a class="headerlink" href="#cmdoption-scdispatch-o" title="Permalink to this definition">¶</a></dt>
|
|
|
<dd><p>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.</p>
|
|
|
<p>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.</p>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="option">
|
|
|
<dt id="cmdoption-scdispatch-routingtable">
|
|
|
<code class="sig-name descname">--routingtable</code><code class="sig-prename descclassname"> flag</code><a class="headerlink" href="#cmdoption-scdispatch-routingtable" title="Permalink to this definition">¶</a></dt>
|
|
|
<dd><p>Specify routing table as comma separated list of object:group
|
|
|
pairs, e.g. “Origin:LOCATION,Event:EVENT”. When an
|
|
|
object 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.</p>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="option">
|
|
|
<dt id="cmdoption-scdispatch-print-objects">
|
|
|
<code class="sig-name descname">--print-objects</code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-scdispatch-print-objects" title="Permalink to this definition">¶</a></dt>
|
|
|
<dd><p>Print names of routable objects.</p>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="option">
|
|
|
<dt id="cmdoption-scdispatch-test">
|
|
|
<code class="sig-name descname">--test</code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-scdispatch-test" title="Permalink to this definition">¶</a></dt>
|
|
|
<dd><p>Test mode. Does not send any object.</p>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="option">
|
|
|
<dt id="cmdoption-scdispatch-e">
|
|
|
<code class="sig-name descname">-e</code><code class="sig-prename descclassname"></code><code class="sig-prename descclassname">, </code><code class="sig-name descname">--no-events</code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-scdispatch-e" title="Permalink to this definition">¶</a></dt>
|
|
|
<dd><p>Do not send any event object. This is a wrapper to setting a
|
|
|
routing table without EVENT objects</p>
|
|
|
</dd></dl>
|
|
|
|
|
|
</div>
|
|
|
</div>
|
|
|
</div>
|
|
|
|
|
|
|
|
|
<div id="anchors-bottom"></div>
|
|
|
</div>
|
|
|
|
|
|
<div class="sidebar" role="navigation" aria-label="main navigation">
|
|
|
<div id="anchors-top"></div>
|
|
|
<div id="anchors" class="content">
|
|
|
<div id="searchbox" style="display: none" role="search">
|
|
|
<h3 id="searchlabel">Quick search</h3>
|
|
|
<div class="searchformwrapper">
|
|
|
<form class="search" action="../search.html" method="get">
|
|
|
<input type="text" name="q" aria-labelledby="searchlabel" />
|
|
|
<input type="submit" value="Go" />
|
|
|
</form>
|
|
|
</div>
|
|
|
</div>
|
|
|
<script>$('#searchbox').show(0);</script>
|
|
|
<h3><a href="../index.html">Table of Contents</a></h3>
|
|
|
<ul>
|
|
|
<li><a class="reference internal" href="#">scdispatch</a><ul>
|
|
|
<li><a class="reference internal" href="#description">Description</a></li>
|
|
|
<li><a class="reference internal" href="#examples">Examples</a></li>
|
|
|
<li><a class="reference internal" href="#module-configuration">Module Configuration</a></li>
|
|
|
<li><a class="reference internal" href="#command-line-options">Command-Line Options</a><ul>
|
|
|
<li><a class="reference internal" href="#generic">Generic</a></li>
|
|
|
<li><a class="reference internal" href="#verbosity">Verbosity</a></li>
|
|
|
<li><a class="reference internal" href="#messaging">Messaging</a></li>
|
|
|
<li><a class="reference internal" href="#database">Database</a></li>
|
|
|
<li><a class="reference internal" href="#dispatch">Dispatch</a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
</ul>
|
|
|
|
|
|
<h4>Previous topic</h4>
|
|
|
<p class="topless"><a href="scdbstrip.html"
|
|
|
title="previous chapter">scdbstrip</a></p>
|
|
|
<h4>Next topic</h4>
|
|
|
<p class="topless"><a href="scdumpcfg.html"
|
|
|
title="next chapter">scdumpcfg</a></p>
|
|
|
<div role="note" aria-label="source link">
|
|
|
<h3>This Page</h3>
|
|
|
<ul class="this-page-menu">
|
|
|
<li><a href="../_sources/apps/scdispatch.rst.txt"
|
|
|
rel="nofollow">Show Source</a></li>
|
|
|
</ul>
|
|
|
</div>
|
|
|
</div>
|
|
|
</div>
|
|
|
</div>
|
|
|
</div>
|
|
|
<div class="footer">
|
|
|
<div class="container">
|
|
|
<div class="horizontal layout content">
|
|
|
<a class="fade-in" href="https://www.gempa.de" target="_blank">
|
|
|
<img class="brand" src="../_static/brands/gempa.svg"/>
|
|
|
</a>
|
|
|
<div class="stretched align-center fitted content">
|
|
|
<div>
|
|
|
Version <b>5.3.0</b> Release
|
|
|
</div>
|
|
|
<div class="copyright">
|
|
|
Copyright © gempa GmbH, GFZ Potsdam.
|
|
|
</div>
|
|
|
</div>
|
|
|
<a class="fade-in" href="https://www.gfz-potsdam.de" target="_blank">
|
|
|
<img class="brand" src="../_static/brands/gfz.svg"/>
|
|
|
</a>
|
|
|
</div>
|
|
|
</div>
|
|
|
</div>
|
|
|
</body>
|
|
|
</html> |