epadmin-operator

epadmin operator target — Manages StreamBase operators in a running EventFlow module.

SYNOPSIS

epadmin [globalparameters] command operator [commandparameters]

DESCRIPTION

Use the operator target to view the current operators in a running module, or to manage custom written operators in a running EventFlow module in a node.

Changing the operation of individual operators should never be needed in an active cluster, but this target's commands might be useful for development, debugging, and troubleshooting purposes. EventFlow operators do not have a defined start-stop life cycle like the one for nodes. This target's commands other than display are restricted to custom Java operators, and do not operate on Spotfire-provided operators.

These commands are not cluster aware, and thus affect only one node at a time; changes to one node are not propagated to peer nodes in a cluster. Consider using the cluster awareness feature of your operator to let it start and stop based on cluster conditions.

The operator target has seven commands:

The designation [sn|ad] in syntax examples is a reminder that this command requires either the global parameter ‑‑servicename or the ‑‑adminport and ‑‑hostname combination to identify the node or cluster of interest.

epadmin display operator

Displays information lines about operators in a node. This command reports similar information to the legacy sbc list operators command. 

epadmin [sn|ad] display operator
epadmin [sn|ad] display operator --type=map
epadmin [sn|ad] display operator --engine=JVMengine1
epadmin [sn|ad] display operator --path=default.myModule.myOperator
epadmin [sn|ad] display operator --engine=JVMengine1 --path=default.myModule.myOperator

Example output:

Engine = JVMEngineA
Path = default.PreserveBidInfo
Type = map
Status = STARTED
Cluster Aware =
Command Parameter Description Required
engine Engine name filter. No. The default is to display all operators on all engines.
path Path filter, using StreamBase path notation. No. The default is to display all operators at all paths.
type Operator type filter, most usefully using the lowercase name of an operator type as seen in the Palette View in StreamBase Studio. However, any string can be a type, to accommodate custom-written operators with custom types. No. The default is to display all operator types.

epadmin get operator

Gets a report of the properties and their current settings for custom operators. 

get operator
get operator --engine=JVMengine1
get operator --path=default.myModule.myOperator
get operator --property=myProperty
Command Parameter Description Required
engine Engine name filter. No. The default is to get all properties for all engines.
path Path filter, using StreamBase path notation. No. The default is to get all properties at all paths.
property Property name filter. No. The default is to get all properties.

epadmin resume operator

Resumes a previously suspended custom operator. Spotfire-provided operators cannot be resumed. 

epadmin [sn|ad] resume operator
epadmin [sn|ad] resume operator --engine=JVMengine1
epadmin [sn|ad] resume operator --path=default.myModule.myOperator
epadmin [sn|ad] resume operator --engine=JVMengine1 --path=default.myModule.myOperator
Command Parameter Description Required
engine Engine name filter. No. The default is to resume all custom operators on all engines.
path Path filter, using StreamBase path notation. No. The default is to resume all custom operators at all paths.

epadmin set operator

Sets property values for custom operators. 

epadmin [sn|ad] set operator --property=myProperty --value=hello
epadmin [sn|ad] set operator --engine=JVMengine1 --property=myProperty --value=hello
epadmin [sn|ad] set operator --path=default.myModule.myOperator --property=myProperty --value=hello
Command Parameter Description Required
engine Engine name filter. No. The default is to set the property for all engines.
path Path filter, using StreamBase path notation. No. The default is to set the property at all paths.
property Property name. Yes.
value Property value. Yes.

epadmin start operator

Starts a previously stopped custom operator. Spotfire-provided operators cannot be started. 

epadmin [sn|ad] start operator
epadmin [sn|ad] start operator --engine=JVMengine1
epadmin [sn|ad] start operator --path=default.myModule.myOperator
epadmin [sn|ad] start operator --engine=JVMengine1 --path=default.myModule.myOperator
Command Parameter Description Required
engine Engine name filter. No. The default is to start all custom operators on all engines.
path Path filter, using StreamBase path notation. No. The default is to start all custom operators at all paths.

epadmin stop operator

Stops a previously started custom operator. Spotfire-provided operators cannot be stopped. 

epadmin [sn|ad] stop operator
epadmin [sn|ad] stop operator --engine=JVMengine1
epadmin [sn|ad] stop operator --path=default.myModule.myOperator
epadmin [sn|ad] stop operator --engine=JVMengine1 --path=default.myModule.myOperator
Command Parameter Description Required
engine Engine name filter. No. The default is to stop all custom operators on all engines.
path Path filter, using StreamBase path notation. No. The default is to stop all custom operators at all paths.

epadmin suspend operator

Suspends a previously started custom operator. Spotfire-provided operators cannot be suspended. 

epadmin [sn|ad] suspend operator
epadmin [sn|ad] suspend operator --engine=JVMengine1
epadmin [sn|ad] suspend operator --path=default.myModule.myOperator
epadmin [sn|ad] suspend operator --engine=JVMengine1 --path=default.myModule.myOperator
Command Parameter Description Required
engine Engine name filter. No. The default is to suspend all custom operators on all engines.
path Path filter, using StreamBase path notation. No. Default suspend all custom operators at all paths.

SEE ALSO

Help System for epadmin
epadmin(1)
epadmin-globals(1)