META-INF.sitewhere-tenant.xsd Maven / Gradle / Ivy
Provides configuration information for a SiteWhere
server tenant.
Global configuration settings for external
services that SiteWhere interacts with.
Provides information about how tenant-specific
SiteWhere data is to be persisted and how the core service
provider interfaces are implemented. Caching of persisted data is
also configured in this section.
Specifies details related to the asset
management subsystem including the asset manager implementation
and the list of asset modules that should be used for device
assignments.
Specifies a list of external search providers
that have indexed SiteWhere data and may be queried via the REST
services, returning a list of SiteWhere events.
Initializes asset model with data if database is
empty.
Initializes schedule model with data if database
is empty.
A placeholder for tenant datastore elements.
Tenant datastore that uses MongoDB for data
persistence.
Use MongoDB bulk APIs to insert events in
batches.
When 'useBulkEventInserts' is true, specifies
the maximum number of events to send in a single call.
Url used to connect.
Username used to connect.
Password used to connect.
Database where events are stored.
Retention identifier for events.
Indicates the amount of logging output for
debugging interactions with InfluxDB.
Enable batch delvery of events.
Max number of events to cache before writing.
Max interval (in ms) to wait before writing.
Hybrid tenant datastore that uses MongoDB for
storing device management data and InfluxDB for storing event data.
Hybrid tenant datastore that uses MongoDB for
storing device management data and Hazelcast for storing event data.
Number of minutes events are kept in memory
before they are evicted.
Datastore that uses Apache HBase for tenant data
persistence.
A placeholder for device management cache
elements.
Device management cache that uses Ehcache for the
underlying cache
mechanism.
Maximum number of entries in the site cache.
Maximum number of entries in the device
specification cache.
Maximum number of entries in the device cache.
Maximum number of entries in the device
assignment cache.
Time to live for site cache entries.
Time to live for device specification cache
entries.
Time to live for device cache entries.
Time to live for device assignment cache
entries.
Device management cache that uses Hazelcast for
the underlying cache
mechanism.
A placeholder for device model initializer
elements.
Device model initializer that loads the default
device data
referenced in many examples.
Device model initializer that delegates creation
logic to a Groovy
script.
Path to a Groovy script that executes logic
needed to create
device model.
A placeholder for event processing subsystem
implementation
elements.
The inbound processing strategy controls how
events are moved from
event sources into the inbound processing
chain.
A chain of processors through which all inbound
device information
is passed. Each processor handles some piece of
processing and passes information on
to the next.
The outbound processing strategy controls how
stored events are
moved into the outbound processing chain.
A chain of processors through which all outbound
device events are
passed. Each processor handles some piece of
processing and passes information on to
the next.
Specifies the default device communication
subsystem implementation.
A placeholder for inbound processing strategy
elements.
DEPRECATED: Equivalent of
blocking-queue-inbound-processing-strategy.
Configures the default inbound processing strategy
Controls the maximum number of inbound events
that can be queued
before blocking occurs.
Controls the number of threads that submit
queued events to the
inbound processing chain.
Enables monitoring output for debugging event
processing.
Number of seconds between monitoring log
statements. The
'enableMonitoring' attribute must be set to true
for this to have an effect.
A placeholder for outbound processing strategy
elements.
DEPRECATED: Equivalent of
blocking-queue-outbound-processing-strategy.
Uses a fixed-length queue to store events to be
submitted to the
outbound processing chain and a fixed pool of
threads to process the queue.
Controls the maximum number of outbound events
that can be queued
before blocking occurs.
Controls the number of threads that submit
queued events to the
outbound processing chain.
A placeholder for inbound processor elements.
References a custom inbound event processor
implementation.
Stores device events via the device management
implementation. If
not configured, all events from inbound processing
will be ignored. This does not
affect ability to create events via
REST calls.
Provides device registration functionality. If
this processor is not
enabled, device registration requests will be
ignored.
Provides support for creating and writing to
device streams. If this
processor is not enabled, device stream
requests will be ignored.
Sends all events to a Hazelcast queue. Generally,
if this processor
is configured, the other processors such as storage
and registration are not used
since the subordinate SiteWhere
instances listening on the queue will be taking care
of storage and
registration.
A placeholder for outbound processor filter
elements.
Includes or excludes device events depending on
whether the device
is associated with a given site.
Unique token for the site to be filtered.
Indicates whether matches should be included or
excluded from the
result set.
Includes or excludes device events depending on
whether the device
is based on a given specififation.
Unique token for the specification to be
filtered.
Indicates whether matches should be included or
excluded from the
result set.
Executes a Groovy script which should return a
boolean result. True
indicates the event is to be included in the
result set, false indicates it should be
filtered.
Script that determines whether events are
included or filtered.
The script should return true if the event
is to be included or false if the event
is to be filtered.
A placeholder for outbound multicaster elements.
Multicasts to all devices that use a given
specification.
Unique token for device specification.
Path to a Groovy script that returns a String
value indicating
the calculated route or null if event should not
be routed.
A placeholder for outbound route builder elements.
Uses Groovy script to build outbound route.
Path to a Groovy script that returns a String
value indicating
the calculated route.
A placeholder for outbound processor elements.
List of filters that will be applied to
outbound traffic.
References a custom outbound event processor
implementation.
DEPRECATED: Use 'command-delivery-event-processor'
instead.
Hands off outbound device command events to the
device communication
subsystem. If this event processor is not
configured, no commands will be sent to
devices.
Sets the number of threads used to process
provisioning commands.
Increase for situations where the load of
device commands is high.
For each location event, applies a series of tests
to determine
whether the location meets a condition of being inside
or outside of a given zone. If
the condition is met, an alert is
fired.
Tests a location for inclusion/exclusion from
a zone and fires
an alert if the condition is met.
Sends outbound events to an MQTT topic.
Allows a multicaster to be configured so that
events can be
broadcast to many different topics.
Allows customization of route building logic.
MQTT topic used if no multicaster or route
builder is configured.
Sends outbound events to a RabbitMQ exchange.
Allows a multicaster to be configured so that
events can be
broadcast to many different exchanges.
Allows customization of route building logic.
URI that provides information about the
RabbitMQ instance to
connect to.
Name of topic to publish to if route builder is
not
configured.
Sends outbound events to Hazelcast topics for
processing by external
consumers.
Delegates event processing to a Groovy script. The
script can apply
conditional logic or interact with SiteWhere
interfaces to create new events or
perform other tasks.
Path to script used for processing each event.
Sends outbound events to Apache Solr for indexing.
Sends outbound events to an Azure EventHub using
AMQP 1.0.
Sets the identity used for SAS authentication.
Sets the key used for SAS authentication.
Set the service bus to connect to (e.g.
xxx.servicebus.windows.net).
Name of EventHub to connect to.
Sends events to the InitialState.com cloud service
where they can be
viewed in a customized dashboard.
Access key obtained from the InitialState.com
website that
specifies the account that the events will be
associated with.
Sends events to the Dweet.io cloud service where
they can be viewed
and integrated with other services.
Forwards outbound events to Amazon SQS.
Amazon AWS access key for account owning SQS
queue.
Amazon AWS secret key for account owning SQS
queue.
Unique URL for SQS queue.
Sends events to streams on an external WSO2 CEP
instance for
processing.
Hostname for external WSO2 CEP instance.
Port number for external WSO2 CEP instance.
Username for external WSO2 CEP instance.
Password for external WSO2 CEP instance.
Processes events through an embedded Siddhi
instance to allow
complex event processing (CEP) funcitonality.
A Siddhi query that executes selector logic.
A placeholder for Siddhi callback elements.
Name of stream for which a callback will be
registered.
Debugs Siddhi streams by printing events to the
log.
Processes events from a Siddhi stream using a
Groovy script.
Path to script used for processing each event.
Selector expression that contains processing
logic.
A placeholder for device communication subsystem
implementation
elements.
Event sources receive and decode events so that
they may be
processed by SiteWhere.
DEPRECATED: Inbound processing strategy has been
moved into the
event processing subsystem.
DEPRECATED: Outbound processing strategy has
been moved into the
event processing subsystem.
DEPRECATED: Registration has been renamed to
'device services' to
allow for the addition of other services.
Contains various device-related services such as
registration and
symbology management.
Batch operations are operations executed on a
large number of
devices concurrently in an asynchronous fashion.
Command routing determines which destination is
used for
processing a given command invocation.
Command destinations process command invocation
events, encoding
them then delivering them to devices.
DEPRECATED: Left for backward compatibility. Use
'device-communication' element instead.
Specifies the default device communication
subsystem implementation.
A placeholder for decoder elements.
References a decoder defined in an external bean
Decoder that expects a message in the SiteWhere
Google Protocol
Buffer format.
Decoder that parses requests from devices.
DEPRECATED: Use json-batch=event-decoder for JSON
batch event
processing.
Decoder that parses batches of device events.
Decoder that uses a Groovy script to parse a
binary payload into
decoded events.
Path to script used for decoding payload.
Decoder that uses a Groovy script to parse a
String payload into
decoded events.
Path to script used for decoding payload.
Decoder for event receivers with String payloads
that simply echoes
the payload to the log.
A placeholder for device metadata extractor
elements.
Uses a Groovy script to extract device/payload
information from a message.
Path to a Groovy script that extracts metadata
such as hardware id from the message.
A placeholder a choice available to a composite
decoder.
Decoder used if choice criteria is met.
Uses device specification token as the criteria
for choosing the associated decoder.
Token for device specification to match.
Decoder that extracts metadata from the initial
message in order to determine which of a list of sub-decoders should
be used to decode the message.
List of choices available for the composite
decoder.
A placeholder for deduplicator elements.
Event deduplicator that uses a Groovy script to
determine whether an event is a duplicate of an existing event.
Path to script used for deduplicating event.
Event deduplicator that checks the alternate id
(if present) in an event against the existing list of alternate ids
in the datastore.
A placeholder for event source elements.
Unique identifier for event source.
Event source defined externally as a Spring bean
Event source that pulls binary information from an
MQTT topic and
decodes it
MQTT topic used to deliver inbound events.
MQTT protocol (defaults to tcp).
MQTT broker hostname.
MQTT broker port.
MQTT broker username.
MQTT broker password.
For secured connections. Provides the full path
to the Java
TrustStore used for the secure connection.
For secured connections. Provides the password to
the Java
TrustStore used for the secure connection.
Event source that pulls binary information from a
RabbitMQ queue and
decodes it.
URI that provides information about the
RabbitMQ instance to
connect to.
Name of RabbitMQ queue to be consumed.
Indicates whether the queue should survive
broker restarts.
Number of consumer threads used to consume the
queue.
Event source that pulls binary information from an
Azure EventHub
endpoint and
decodes it
EventHub targetFqn address.
EventHub namespace.
EventHub entityPath.
EventHub partition count.
zookeeper store url for EventHub state
persistence.
username for EventHub connection.
password for EventHub connection.
Event source that creates an embedded ActiveMQ
broker and listens
for messages on a transport specified by the
transport URI.
URI used to configure the transport for the
embedded ActiveMQ
broker.
Data directory used to store persistent message
queues.
Name of JMS queue for consumers to pull
messages from.
Number of consumers used to read data from the
queue into
SiteWhere.
Event source connects to a remote broker and
consumes messages from
it.
URI of remote broker to connect to.
Name of JMS queue for consumers to pull
messages from.
Number of consumers used to read data from the
queue into
SiteWhere.
Event source that pulls decoded events from a
Hazelcast queue.
Primarily used to allow one instance of SiteWhere to
decode events and feed them to
multiple subordinate instances for
processing.
Event source that supports connecting to REST
services and parsing
the response data with a Groovy script in order
to generate event payloads.
Interval (in milliseconds) to wait between
polling requests.
Path to a Groovy script that executes logic
needed to generate REST request and parse response.
Base URL used for REST requests. Within Groovy
script, any REST
calls are assumed relative to this base value.
Username if REST services requires
authentication.
Password if REST services requires
authentication.
Bean that implements the
ISocketInteractionHandler interface.
Path to a Groovy script that handles socket
interactions.
Event source that pulls binary information from
connections to a
TCP/IP server socket.
Reference to an interaction handler factory
defined in an
external Spring bean. Factory must implement
ISocketInteractionHandlerFactory
interface.
Interaction handler that reads all content
from the client
socket and delivers it to the decoder as a byte
array.
Interaction handler that treats a socket
request as an HTTP
message and delivers the entity payload to
the decoder as a byte array. A 200 OK
response is sent back to
the requestor.
Interaction handler that hands off socket
interactions to a
Groovy script.
Port on which the server socket will listen.
Number of threads used to handle client
connections to the server
socket.
Header name.
Header value.
Event source that pulls data from a web socket.
Header that is passed to the web socket for
configuration.
URL of the web socket to connect to.
Event source that accepts CoAP requests for
SiteWhere resources.
Hostname used when binding CoAP server socket.
Port used when binding CoAP server socket.
Configures the symbol generator manager.
A placeholder for registration manager elements.
Allows a custom registration manager to be
installed.
Identifies bean that implements registration
manager.
Installs the default registration manager
implementation.
Indicates whether new devices should be allowed
to register. If
set
to false, devices not already in the system
will be rejected.
Indicates whether the site should automatically
be chosen if not
passed with registration request.
Token for site used in auto assignment. If not
set and
'autoAssignSite' is set to true, the first site will be
used.
A placeholder for symbol generator elements.
Generates QR-Code symbols for SiteWhere entities.
Unique id for generator.
Name for generator.
Width of QR code image.
Height of QR code image.
Background color for QR code image.
Foreground color for QR code image.
A placeholder for presence manager elements.
Default presence manager implementation.
Amount of time to wait between presence check
cycles. Uses
ISO8601 duration format. (e.g. T1H30M is 1 hour and
30 minutes)
Amount of time since last interaction date at
which a device is
considered non-present. Uses ISO8601 duration
format. (e.g. P2DT3H5M20S is 2 days,
3 hours, 5 minutes, and 20
seconds)
References a custom batch operation manager
implementation.
Configures the default batch operation manager
implementation.
Indicates the amount of time in milliseconds
between command invocations when invoking a batch of commands. Used
to lower system load generated by submitting a large number of
command invocations concurrently.
References a custom command router
implementation.
Command router that distributes commands to
destinations based on a mapping of specification token to command
agent id.
Command router that defers decision logic to a
Groovy script that decides which command destination is to be
used.
Mapping of a specification token to a
destination id.
Allows a default destination to be set for
specifications that do
not have a specific mapping.
Path to a Groovy script that executes logic
needed to choose destination for a command.
References a custom command destination
implementation.
Destination that delivers commands via MQTT.
Destination that delivers commands via CoAP
client request.
Destination that delivers commands via Twilio
SMS messages.
Unique identifier for command destination.
A placeholder for command encoder elements.
References a command encoder defined in an
external bean
Command encoder that encodes commands based on
standard SiteWhere
Google Protocol Buffer naming convention.
Command encoder that encodes system commands using
protocol buffers but encodes custom commands using serialized Java
objects. This allows Java clients to use the commands directly
rather than having to recompile stubs based on a proto.
Command encoder that encodes both system and
custom commands as JSON for simplified client use.
Command encoder that hands off system and custom
commands to a Groovy script which applies logic to encode the
payload to a byte array.
Path to a Groovy script that executes logic
needed to encode system and custom commands.
Command encoder that hands off system and custom
commands to a Groovy script which applies logic to encode the
payload to a String.
Path to a Groovy script that executes logic
needed to encode system and custom commands.
References a custom command delivery parameter
extractor implementation that extracts MQTT delivery information
from the device.
Substitutes device hardware id into expressions
to determine the
outbound topics to which MQTT messages will be
sent.
References a custom command delivery parameter
extractor implementation that extracts CoAP delivery information
from the device.
Extracts CoAP connection information from
device metadata.
Metadata field that holds hostname for CoAP
client connection.
Metadata field that holds port for CoAP client
connection.
Metadata field that holds URL for CoAP client
connection.
Path to a Groovy script that executes logic
needed to extract SMS parameters from the current assignment.
References a custom command delivery parameter
extractor implementation that extracts CoAP delivery information
from the device.
Extracts SMS parameter information using a
Groovy script.
References a custom asset module
implementation.
Configures an asset module that pulls
information from WSO2
Identity Server.
Configures a filesystem device asset module
instance.
Configures a filesystem hardware asset module
instance.
Configures a filesystem person asset module
instance.
Configures a filesystem location asset module
instance.
Unique asset module id.
SCIM URL for accessing the list of users.
Basic authentication username for web service
calls.
Basic authentication password for web service
calls.
Indicates whether an invalid SSL certificate on
the server should
be ignored.
A placeholder for search provider elements.
Unique id for referencing the search provider.
Name shown in user interface for search provider.
Search provider that sends search requests to
Apache Solr and
returns the results as matching SiteWhere events.
© 2015 - 2025 Weber Informatics LLC | Privacy Policy