251 lines
		
	
	
		
			8.6 KiB
		
	
	
	
		
			XML
		
	
	
	
	
	
			
		
		
	
	
			251 lines
		
	
	
		
			8.6 KiB
		
	
	
	
		
			XML
		
	
	
	
	
	
<?xml version="1.0" encoding="UTF-8"?>
 | 
						|
<seiscomp>
 | 
						|
	<module name="scimport" category="Utilities">
 | 
						|
		<description>Forward messages across two SeisComP systems.</description>
 | 
						|
		<configuration>
 | 
						|
			<parameter name="sink" type="string">
 | 
						|
				<description>
 | 
						|
				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
 | 
						|
				</description>
 | 
						|
			</parameter>
 | 
						|
			<parameter name="routingtable" type="list:string">
 | 
						|
				<description>
 | 
						|
				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
 | 
						|
				</description>
 | 
						|
			</parameter>
 | 
						|
			<parameter name="msggroups" type="list:string">
 | 
						|
				<description>
 | 
						|
				Define 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.
 | 
						|
				</description>
 | 
						|
			</parameter>
 | 
						|
			<parameter name="useFilter" type="boolean" default="true">
 | 
						|
				Enable/Disable filtering of messages
 | 
						|
			</parameter>
 | 
						|
			<group name="filter">
 | 
						|
				<description>Define filter criteria before sending.</description>
 | 
						|
				<group name="pick">
 | 
						|
					<description>Criteria for filtering picks.</description>
 | 
						|
					<parameter name="mode" type="string">
 | 
						|
						<description>
 | 
						|
						The mode of picks to filter for. Allowed values:
 | 
						|
						"automatic" and "manual".
 | 
						|
						</description>
 | 
						|
					</parameter>
 | 
						|
					<parameter name="status" type="string">
 | 
						|
						<description>
 | 
						|
						The status of picks to filter for. Allowed values:
 | 
						|
						"preliminary", "confirmed",
 | 
						|
						"reviewed", "final",
 | 
						|
						"rejected" and "reported".
 | 
						|
						</description>
 | 
						|
					</parameter>
 | 
						|
					<parameter name="phase" type="string">
 | 
						|
						<description>
 | 
						|
						The pick phase hint to filter for. Allowed values:
 | 
						|
						all possible phase codes.
 | 
						|
						</description>
 | 
						|
					</parameter>
 | 
						|
					<parameter name="agencyIDs" type="list:string">
 | 
						|
						<description>
 | 
						|
						The pick agencyIDs to filter for. Allowed values:
 | 
						|
						all possible agency ids;
 | 
						|
						</description>
 | 
						|
					</parameter>
 | 
						|
					<parameter name="networkCode" type="string">
 | 
						|
						<description>
 | 
						|
						The pick network code of the processed waveforms.
 | 
						|
						Allowed values: all possible network codes.
 | 
						|
						</description>
 | 
						|
					</parameter>
 | 
						|
				</group>
 | 
						|
				<group name="amplitude">
 | 
						|
					<description>Criteria for filtering amplitudes</description>
 | 
						|
					<parameter name="operator" type="string">
 | 
						|
						<description>
 | 
						|
						The amplitude comparison operator. Allowed values:
 | 
						|
						"eq", "lt", "gt" and "*".
 | 
						|
						</description>
 | 
						|
					</parameter>
 | 
						|
					<parameter name="amplitude" type="double">
 | 
						|
						<description>
 | 
						|
						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.
 | 
						|
						</description>
 | 
						|
					</parameter>
 | 
						|
					<parameter name="agencyIDs" type="list:string">
 | 
						|
						<description>
 | 
						|
						The amplitude agencyIDs to filter for. Allowed values:
 | 
						|
						all possible agency ids.
 | 
						|
						</description>
 | 
						|
					</parameter>
 | 
						|
				</group>
 | 
						|
				<group name="origin">
 | 
						|
					<description>Criteria for filtering origins</description>
 | 
						|
					<parameter name="latitude" type="string">
 | 
						|
						<description>
 | 
						|
						The latitude range in format [min]:[max].
 | 
						|
						</description>
 | 
						|
					</parameter>
 | 
						|
					<parameter name="longitude" type="string">
 | 
						|
						<description>
 | 
						|
						The longitude range in format [min]:[max].
 | 
						|
						</description>
 | 
						|
					</parameter>
 | 
						|
					<parameter name="depth" type="string">
 | 
						|
						<description>
 | 
						|
						The depth range in format [min]:[max].
 | 
						|
						</description>
 | 
						|
					</parameter>
 | 
						|
					<parameter name="agencyIDs" type="list:string">
 | 
						|
						<description>
 | 
						|
						The origin agencyIDs to filter for. Allowed values:
 | 
						|
						all possible agency ids;
 | 
						|
						</description>
 | 
						|
					</parameter>
 | 
						|
					<parameter name="mode" type="string">
 | 
						|
						<description>
 | 
						|
						The origin evaluation mode to filter for. Allowed values:
 | 
						|
						"automatic" and "manual".
 | 
						|
						</description>
 | 
						|
					</parameter>
 | 
						|
					<parameter name="status" type="string">
 | 
						|
						<description>
 | 
						|
						The origin status to filter for. Allowed values:
 | 
						|
						"preliminary", "confirmed",
 | 
						|
						"reviewed", "final",
 | 
						|
						"rejected" and "reported".
 | 
						|
						</description>
 | 
						|
					</parameter>
 | 
						|
					<parameter name="arrivalcount" type="string">
 | 
						|
						<description>
 | 
						|
						The minimum number of arrivals of an origin to pass
 | 
						|
						the filter.
 | 
						|
						</description>
 | 
						|
					</parameter>
 | 
						|
				</group>
 | 
						|
				<group name="event">
 | 
						|
					<description>Criteria for filtering events</description>
 | 
						|
					<parameter name="type" type="string">
 | 
						|
						<description>
 | 
						|
						The event type to filter for, e.g. "earthquake",
 | 
						|
						"explosion" ...
 | 
						|
						</description>
 | 
						|
					</parameter>
 | 
						|
				</group>
 | 
						|
				<group name="stationMagnitude">
 | 
						|
					<description>Criteria for filtering station magnitudes</description>
 | 
						|
					<parameter name="type" type="string">
 | 
						|
						<description>
 | 
						|
						The station magnitude type. Allowed values: all possible
 | 
						|
						magnitude types such as "MLv".
 | 
						|
						</description>
 | 
						|
					</parameter>
 | 
						|
				</group>
 | 
						|
				<group name="magnitude">
 | 
						|
					<description>Criteria for filtering network magnitudes</description>
 | 
						|
					<parameter name="type" type="string">
 | 
						|
						<description>
 | 
						|
						The magnitude type. Allowed values: all possible
 | 
						|
						magnitude types such as "MLv".
 | 
						|
						</description>
 | 
						|
					</parameter>
 | 
						|
				</group>
 | 
						|
				<group name="qc">
 | 
						|
					<description>Criteria for filtering QC parameters</description>
 | 
						|
					<parameter name="type" type="string">
 | 
						|
						<description>
 | 
						|
						The QC parameter type. Allowed values: all possible
 | 
						|
						types such as "latency", "delay" ...
 | 
						|
						</description>
 | 
						|
					</parameter>
 | 
						|
				</group>
 | 
						|
			</group>
 | 
						|
		</configuration>
 | 
						|
		<command-line>
 | 
						|
		<synopsis>
 | 
						|
		scimport [options]
 | 
						|
		</synopsis>
 | 
						|
			<group name="Generic">
 | 
						|
				<optionReference>generic#help</optionReference>
 | 
						|
				<optionReference>generic#version</optionReference>
 | 
						|
				<optionReference>generic#config-file</optionReference>
 | 
						|
				<optionReference>generic#plugins</optionReference>
 | 
						|
				<optionReference>generic#daemon</optionReference>
 | 
						|
				<optionReference>generic#auto-shutdown</optionReference>
 | 
						|
				<optionReference>generic#shutdown-master-module</optionReference>
 | 
						|
				<optionReference>generic#shutdown-master-username</optionReference>
 | 
						|
			</group>
 | 
						|
 | 
						|
			<group name="Verbosity">
 | 
						|
				<optionReference>verbosity#verbosity</optionReference>
 | 
						|
				<optionReference>verbosity#v</optionReference>
 | 
						|
				<optionReference>verbosity#quiet</optionReference>
 | 
						|
				<optionReference>verbosity#component</optionReference>
 | 
						|
				<optionReference>verbosity#syslog</optionReference>
 | 
						|
				<optionReference>verbosity#lockfile</optionReference>
 | 
						|
				<optionReference>verbosity#console</optionReference>
 | 
						|
				<optionReference>verbosity#debug</optionReference>
 | 
						|
				<optionReference>verbosity#log-file</optionReference>
 | 
						|
			</group>
 | 
						|
 | 
						|
			<group name="Messaging">
 | 
						|
				<optionReference>messaging#user</optionReference>
 | 
						|
				<optionReference>messaging#host</optionReference>
 | 
						|
				<optionReference>messaging#timeout</optionReference>
 | 
						|
				<optionReference>messaging#primary-group</optionReference>
 | 
						|
				<optionReference>messaging#subscribe-group</optionReference>
 | 
						|
				<optionReference>messaging#content-type</optionReference>
 | 
						|
				<optionReference>messaging#start-stop-msg</optionReference>
 | 
						|
			</group>
 | 
						|
 | 
						|
			<group name="Import">
 | 
						|
				<option flag="o" long-flag="sink" param-ref="sink"/>
 | 
						|
				<option flag="i" long-flag="import">
 | 
						|
					<description>
 | 
						|
					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.
 | 
						|
					</description>
 | 
						|
				</option>
 | 
						|
				<option long-flag="no-filter">
 | 
						|
					<description>
 | 
						|
					Disable message filtering and ignore all configured filters.
 | 
						|
					</description>
 | 
						|
				</option>
 | 
						|
				<option long-flag="routeunknowngroup">
 | 
						|
					<description>
 | 
						|
					Route unknown groups to the default group IMPORT_GROUP.
 | 
						|
					</description>
 | 
						|
				</option>
 | 
						|
				<option long-flag="ignore-groups">
 | 
						|
					<description>
 | 
						|
					Ignore user specified groups.
 | 
						|
					</description>
 | 
						|
				</option>
 | 
						|
				<option long-flag="test">
 | 
						|
					<description>
 | 
						|
					Do not send any messages.
 | 
						|
					</description>
 | 
						|
				</option>
 | 
						|
			</group>
 | 
						|
		</command-line>
 | 
						|
	</module>
 | 
						|
</seiscomp>
 |