C About the wlevs.Admin Command-Line Reference

You can use the wlevs.Admin to administer Oracle Stream Analytics, dynamically configure rules for Oracle Continuous Query Language (Oracle CQL) processors, and monitor event latency and throughput.

This appendix includes the following sections:

• Overview of the wlevs.Admin Utility

• Configure the wlevs.Admin Utility Environment

• Running the wlevs.Admin Utility Remotely

• Run wlevs.Admin Utility in SSL Mode

• Syntax for Calling the wlevs.Admin Utility

• Connection Arguments

• User Credentials Arguments

• Common Arguments

• HELP Command

• SHUTDOWN Command

• Commands to Manage Oracle CQL Rules

• Commands to Manage MBeans

• Commands for Controlling Event Record and Playback

• Commands for Monitoring Throughput and Latency

• Commands for Managing Configuration History.

C.1 Overview of the wlevs.Admin Utility

The wlevs.Admin utility is a command-line interface to administer Oracle Stream Analytics, to dynamically configure the rules for Oracle CQL processors, and to monitor the event latency and throughput of an application. The utility uses JMX to query the configuration and run time MBeans of servers and deployed applications.

The Oracle Stream Analytics configuration framework enables concurrent changes to the application and server configuration by multiple users. The framework does not use locking to manage this concurrency, but uses optimistic version-based concurrency. This means that two users can always view the configuration of the same object with the intention to update it, but only one user can commit their changes. The other user get an error when they try to update the same configuration object and must refresh their session to view the updated configuration.

Each wlevs.Admin utility command runs in its own transaction, which means that there is an implicit commit after each execution of a command. If you want to batch multiple configuration changes in a single transaction, use JMX directly to make these changes rather than the wlevs.Admin utility.

C.2 Configure the wlevs.Admin Utility Environment

Before you can use the wlevs.Admin utility, you must configure your environment appropriately.

Configure the wlevs.Admin Utility Environment

1. Configure JMX connectivity for the domain you want to administer. See JMX.
2. Set your CLASSPATH in one of the following ways:

   • Implicitly set your CLASSPATH by using the -jar argument when you run the utility.

     Set the -jar argument to the /Oracle/Middleware/my_oep/oep/bin/wlevsadmin.jar file.

     When you use the -jar argument, you do not specify the wlevs.Admin utility name at the command line. For example:

     java -jar d:/Oracle/Middleware/my_oep/oep/bin/wlevsadmin.jar
          -url service:jmx:msarmi://localhost:9002/jndi/jmxconnector 
          UPLOAD -application helloworld -processor helloworldProcessor
          -sourceURL file:///d:/test/newrules2.xml 
     

   • Explicitly update your CLASSPATH by adding the following files to the CLASSPATH environment variable:

     /Oracle/Middleware/my_oep/oep/bin/wlevsadmin.jar
     /Oracle/Middleware/my_oep/oep/bin/wlevs.jar
     /Oracle/Middleware/my_oep/oep/modules/com.bea.wlevs.deployment.server_12.1.2.0_0.jar
     /Oracle/Middleware/my_oep/oep/modules/com.bea.wlevs.ede_12.1.2.0_0.jar
     /Oracle/Middleware/my_oep/oep/modules/com.bea.wlevs.management_12.1.2.0_0.jar
     /Oracle/Middleware/my_oep/wlserver/modules/com.bea.core.jndi.context_8.0.0.0.jar
     /Oracle/Middleware/my_oep/wlserver/modules/com.bea.core.jmx_8.0.0.0.jar
     /Oracle/Middleware/my_oep/wlserver/modules/com.bea.core.rmi_8.0.0.0.jar
     /Oracle/Middleware/my_oep/wlserver/modules/com.bea.core.i18n_3.0.0.0.jar
     /Oracle/Middleware/my_oep/wlserver/modules/com.bea.core.diagnostics.core_4.0.0.0.jar
     /Oracle/Middleware/my_oep/wlserver/modules/javax.xml.stream_1.1.1.0.jar
     /Oracle/Middleware/my_oep/wlserver/modules/com.bea.core.bootbundle_13.0.0.0.jar

C.3 Running the wlevs.Admin Utility Remotely

You can run the wlevs.Admin utility on a computer that is different from the computer on which Oracle Stream Analytics is installed and running.

Run the wlevs.Admin utility Remotely

1. Copy the following JAR files from the computer on which Oracle Stream Analytics is installed to the computer on which you want to run wlevs.Admin; you can copy the JAR files to the directory name of your choice:

   /Oracle/Middleware/my_oep/oep/bin/wlevsadmin.jar
   /Oracle/Middleware/my_oep/oep/bin/wlevs.jar
   /Oracle/Middleware/my_oep/oep/modules/com.bea.wlevs.deployment.server_12.1.2.0_0.jar
   /Oracle/Middleware/my_oep/oep/modules/com.bea.wlevs.ede_12.1.2.0_0.jar
   /Oracle/Middleware/my_oep/oep/modules/com.bea.wlevs.management_12.1.2.0_0.jar
   /Oracle/Middleware/my_oep/wlsever/modules/com.bea.core.jndi.context_8.0.0.0.jar
   /Oracle/Middleware/my_oep/wlserver/modules/com.bea.core.jmx_8.0.0.0.jar
   /Oracle/Middleware/my_oep/wlserver/modules/com.bea.core.rmi_8.0.0.0.jar
   /Oracle/Middleware/my_oep/wlserver/modules/com.bea.core.i18n_3.0.0.0.jar
   /Oracle/Middleware/my_oep/wlserver/modules/com.bea.core.diagnostics.core_4.0.0.0.jar
   /Oracle/Middleware/my_oep/wlserver/modules/javax.xml.stream_1.1.1.0.jar
   

2. Set your CLASSPATH in one of the following ways:

   • Implicitly set your CLASSPATH by using the -jar argument when you run the utility. Set the argument to the NEW_DIRECTORY/wlevsadmin.jar file, where NEW_DIRECTORY refers to the directory on the remote computer into which you copied the required JAR files. When you use the -jar argument, you do not specify the wlevs.Admin utility name at the command line.

   • Explicitly update your CLASSPATH by adding all the files you copied to the remote computer to your CLASSPATH environment variable:

3. Run the wlevs.Admin utility in SSL mode as described in Run wlevs.Admin Utility in SSL Mode.

C.4 Run wlevs.Admin Utility in SSL Mode

To use SSL when using the wlevs.Admin command-line utility, you must first create a trust key store.

For more information, see SSL to Secure Network Traffic.

Run wlevs.Admin utility in SSL Mode

1. If not already running, start the Oracle Stream Analytics server.

   See Start and Stop Servers.

2. Change to ssl directory.

   By default the ssl directory is in Oracle/Middleware/my_oep/user_projects/domains/<domainname>/<servername>.

3. Generate a trust key store by specifying the following command on one line:

   java -classpath Oracle\Middleware\my_oep\oep\
   common\lib\evspath.jar;Oracle\Middleware\my_oep\oep\utils\security\
   wlevsgrabcert.jar com.bea.wlevs.security.util.GrabCert host:secureport 
   -alias=alias truststorepath
   

   host: The computer on which myServer2 is running.

   secureport: The SSL network I/O port configured for myServer2. The default value is 9003. For more information, see Configure SSL Manually.

   alias: The alias for the certificate in the trust key store. Default value is the host name.

   truststorepath: The full path name of the generated trust key store file. The default is evstrust.jks.

   For example:

   java -classpath C:\Oracle\Middleware\my_oep\oep\
   common\lib\evspath.jar;C:\Oracle\Middleware\my_oep\utils\security\
   wlevsgrabcert.jar com.bea.wlevs.security.util.GrabCert myServer2:9003 -alias=myServer2 evstrust.jks
   

4. Use the following properties and specify the secure port in the URL as shown in the following example.

   -Djavax.net.ssl.trustStore: The name of the trust key store file you created in the preceding step.

   -Djavax.net.ssl.trustStorePassword: The password of the trust key store file.

   java -Djavax.net.ssl.trustStore=clitrust.jks
        -Djavax.net.ssl.trustStorePassword=secret 
        -jar wlevsadmin.jar
        -url service:jmx:msarmis://localhost:9003/jndi/jmxconnector
        -username wlevs -password wlevs
        SHUTDOWN -scheduleAt 600

C.5 Syntax for Calling the wlevs.Admin Utility

This topic describes the syntax for using the wlevs.Admin utility.

java wlevs.Admin 
    [ Connection Arguments ] 
    [ User Credentials Arguments ]
    [ Common Arguments ] 
    COMMAND-NAME command-arguments 

The command names and arguments are not case sensitive.

The following sections provide detailed syntax information about the arguments you can supply to the wlevs.Admin utility:

• Connection Arguments

• User Credentials Arguments

• Common Arguments

The following sections provide detailed syntax information about the supported commands of the wlevs.Admin utility:

• HELP Command

• SHUTDOWN Command

• Commands to Manage Oracle CQL Rules

• Commands to Manage MBeans

• Commands for Controlling Event Record and Playback

• Commands for Monitoring Throughput and Latency.

C.5.1 Example Environment

In many of the examples in the following sections the environment has the following setup:

• The Oracle Stream Analytics server instance listens to JMX requests on port 9002.

• The Oracle Stream Analytics server instance is installed on a host machine named ariel and uses this host name for its listen address.

• The wlevs user name has system administrator privileges and uses wlevs for the administrator password.

Also, all of the examples are shown on multiple lines. When you run the command, enter all arguments and commands on a single line.

C.5.2 Exit Codes Returned by wlevs.Admin

All wlevs.Admin commands return an exit code of 0 when the command succeeds and an exit code of 1 when the command fails.

To view the exit code from a Windows command prompt, enter echo%ERRORLEVEL% after you run a wlevs.Admin command. To view the exit code in a bash shell, enter echo $?.

wlevs.Admin calls System.exit(1) when an exception is raised while processing a command, which causes Ant and other Java client JVMs to exit.

C.6 Connection Arguments

When you invoke most wlevs.Admin commands, you must specify the arguments in this topic to connect to an Oracle Stream Analytics server instance.

java wlevs.Admin 
    [ {-url URL} | -protocol protocol | {-listenAddress hostname -listenPort port} ]
    [ User Credentials Arguments ]
    [ Common Arguments ]
    COMMAND-NAME command-arguments

Table C-1 Connection Arguments

Argument	Definition
-url service:jmx:msarmi://host:port/jndi/jmxconnector	Specifies the URL that establishes a JMX connection to the Oracle Stream Analytics instance that you want to administer, where: host refers to the name of the computer on which the Oracle Stream Analytics instance is running port refers to the Oracle Stream Analytics server JNDI port If you use this argument, do not specify -listenAddress or -listenPort. Other than host, you specify the remainder of the URL as written. For example, if Oracle Stream Analytics is running on a computer with host name ariel, and the JMX listening port is 9002, then the URL would be: -url service:jmx:msarmi://ariel:9002/jndi/jmxconnector See JMX for details about configuring JMX, JNDI, and RMI for Oracle Stream Analytics.
-listenAddress hostname	Specifies the name of computer on which the Oracle Stream Analytics instances is running. This argument, together with -listenPort, is used to build the URL that establishes a JMX connection to the server you want to administer. You use this argument, together with -listenPort, instead of -url. For example, if Oracle Stream Analytics is running on a computer with host name ariel, then this argument would be: -listenAddress ariel
-listenPort port	Specifies the port configured for Oracle Stream Analytics that listens to JMX connections. This argument, together with -listenAddress, is used to build the URL that establishes a JMX connection to the server you want to administer. You use this argument, together with -listenAddress, instead of -url. The JMX port is configured in the config.xml file of the Oracle Stream Analytics domain you are administering. In particular, the port is the <port> child element of the <netio> element, as shown: <netio> <name>NetIO</name> <port>9002</port> </netio> In the example, the port is 9002 and you specify as an argument as follows: -listenPort 9002 See JMX for details about configuring JMX, JNDI, and RMI for Oracle Stream Analytics.

C.7 User Credentials Arguments

When you invoke most wlevs.Admin commands, you must specify the arguments in this topic to provide the user credentials of an Oracle Stream Analytics user who has permission to invoke the command. If security has not been enabled for your Oracle Stream Analytics domain, then you do not have to provide user credentials.

java wlevs.Admin
    [ Connection Arguments ]
    [ -username username [-password password] ] 
    [ Common Arguments ]
    COMMAND-NAME command-arguments 

Table C-2 User Credentials Arguments

Argument	Definition
-username username	The name of the user who is issuing the command. This user must have appropriate permission to view or modify the target of the command.
-password password	The password that is associated with the username.

Note:

The exit code for all commands is 1 when the wlevs.Admin utility cannot connect to the server or when the Oracle Stream Analytics server instance rejects the user name and password.

C.8 Common Arguments

This section lists the common arguments.

java wlevs.Admin 
    [ Connection Arguments ]
    [ User Credentials Arguments ] 
    [ -verbose ] 
    COMMAND-NAME command-arguments 

All wlevs.Admin commands support the argument in Table C-3 to get verbose output.

Table C-3 Common Arguments

Argument	Definition
-verbose	Specifies that wlevs.Admin should output additional verbose information.

C.9 HELP Command

The HELP command provides syntax and usage information for all Oracle Stream Analytics commands or for a single command if a command value is specified on the HELP command line.

You can issue this command from any computer on which Oracle Stream Analytics is installed. You do not need to start a server instance to invoke this command, nor do you need to supply user credentials, even when security is enabled for the server.

Syntax

java wlevs.Admin HELP [COMMAND]

The COMMAND argument can be:

• The keyword ALL, which returns usage information about all commands.

• One of the keywords MBEAN, RULES, or LIFECYCLE, which returns usage information about the three different groups of commands.

• A command such as UPLOAD, which returns usage information about the particular command.

Example

In the following example, information about using the UPLOAD command is requested:

java wlevs.Admin HELP UPLOAD

The command returns the following output:

Description:
Uploads rules to be configured in the processor.

Usage:
java wlevs.Admin
   [-url | -listenAddress <host-name> -listenPort <port>]
  -username <username> -password <password>
   UPLOAD -application <application name> -processor <processor name> -sourceURL "source url"

Where:
-application = Name of the application.
-processor = Name of the processor.
-sourceURL = source URL containing the rules in an XML format.

java wlevs.Admin -url service:jmx:msarmi://localhost:9002/jndi/jmxconnector 
     -username wlevs -password wlevs UPLOAD -application myapplication 
     -processor processor -sourceURL file:/d:/test/rules.xml

C.10 SHUTDOWN Command

The SHUTDOWN command manages the life cycle of a server instance by gracefully shutting down the specified Oracle Stream Analytics server instance. A graceful shutdown gives Oracle Stream Analytics time to complete certain application processing currently in progress.

The -url connection argument specifies the particular Oracle Stream Analytics server instance that you want to shut down, based on the host and jmxport values. See Connection Arguments for details.

Syntax

java wlevs.Admin 
    [ Connection Arguments ]
    [ User Credentials Arguments ]
    [ Common Arguments ] 
    SHUTDOWN [-scheduleAt seconds] 

Table C-4 SHUTDOWN Arguments

Argument	Definition
-scheduleAt seconds	Specifies the number of seconds after which the Oracle Stream Analytics instance shuts down. If you do not specify this parameter, the server instance shuts down immediately.

Example

The following example instructs the specified Oracle Stream Analytics instance to shut down in ten minutes:

java wlevs.Admin 
     -url service:jmx:msarmi://localhost:9002/jndi/jmxconnector 
     -username wlevs -password wlevs 
     SHUTDOWN -scheduleAt 600

After you issue the command, the server instance prints messages to its log file and to its standard out. The messages indicate that the server state is changing and that the shutdown sequence is starting.

C.11 Commands to Manage Oracle CQL Rules

This section lists the commands to manage Oracle CQL Rules.

Table C-5 is an overview of commands that manage the Oracle CQL rules for a particular processor of an Oracle Stream Analytics application.

Table C-5 Overview of Commands for Managing Application Oracle CQL Rules

Command	Description
GETRULE	Returns the text of an existing Oracle CQL rule, query, or view of the processor of an Oracle Stream Analytics application.
ADDRULE	Adds a new Oracle CQL rule, query, or view to the processor of an Oracle Stream Analytics application.
DELETERULE	Deletes an existing Oracle CQL rule, query, or view from the processor of an Oracle Stream Analytics application.
REPLACERULE	Replaces an existing Oracle CQL rule, query, or view with new Oracle CQL text.
STARTRULE	Starts a previously stopped Oracle CQL rule or query.
STOPRULE	Stops a previously started Oracle CQL rule or query.
UPLOAD	Configures a set of Oracle CQL rules, queries, or views for a processor of an Oracle Stream Analytics application by uploading the rules from a component configuration XML file.
DOWNLOAD	Downloads the set of Oracle CQL rules, queries, or views associated with a processor of an Oracle Stream Analytics application to a component configuration XML file.

C.11.1 GETRULE

Returns the full text of an Oracle CQL rule, query, or view from the specified Oracle CQL processor of an Oracle Stream Analytics application.

Syntax

java wlevs.Admin 
    [ Connection Arguments ]
    [ User Credentials Arguments ]
    [ Common Arguments ] 
    GETRULE -application application -processor processor -rule rulename

Table C-6 GETRULE Arguments

Argument	Definition
-application application	Specifies the name of the Oracle Stream Analytics application whose Oracle CQL rules you want to manage. To get the exact name of your application, you can: Use wlevs.Admin to query for the name (see Query for Application and Processor Names). Use the Oracle Stream Analytics Visualizer: Start the Oracle Stream Analytics Visualizer (see Using Visualizer for Oracle Stream Analytics). In the left pane, navigate to and expand the Applications node of the Oracle Stream Analytics instance to which the application is deployed. Each node under the Applications node is named with the exact application name. Look at the MANIFEST.MF file of the application; the application name is specified by the Bundle-SymbolicName header.
-processor processor	Specifies the name of the particular Oracle CQL processor, attached to the Oracle Stream Analytics application specified with the -application argument, whose Oracle CQL rules you want to manage. See Query for Application and Processor Names for details on getting the exact name if you do not know it.
-rule rulename	Specifies the name of the Oracle CQL rule, query, or view you want to see. See Query for Application and Processor Names for details on querying for the rule, query, or view name if you do not know it. You can also use the DOWNLOAD command to get the list of rules for a particular processor.

Example

The following example shows how to get the full text of the Oracle CQL view called myview from the Oracle CQL helloworldProcessor of the helloworld application:

java wlevs.Admin 
     -url service:jmx:msarmi://localhost:9002/jndi/jmxconnector 
     -username wlevs -password wlevs 
     GETRULE -application helloworld -processor helloworldProcessor 
     -rule myview

C.11.2 ADDRULE

Adds a new Oracle CQL rule, query, or view to the specified processor of an Oracle Stream Analytics application. If a rule, query, or view with the same name (identified with the rulename, queryname, or viewname parameter) already exists, then the ADDRULE command replaces the existing rule, query, or view with the new one.

Note:

An Oracle CQL query immediately begins to output events when its input channels provides input events. If you plan to use a query selector on a channel with an upstream Oracle CQL processor, then you might observe unwanted query results on the downstream channel between the time you add the query to the upstream Oracle CQL processor and the time you configure the query selector on the downstream channel.

Syntax

java wlevs.Admin 
    [ Connection Arguments ]
    [ User Credentials Arguments ]
    [ Common Arguments ] 
    ADDRULE -application application -processor processor 
        -rule  [rulename]  rulestring  | 
        -query [queryname] querystring | 
        -view  [viewname]  viewstring [-schema comma-separated-names]
        [-active true | false]

Table C-7 ADDRULE Arguments

Argument	Definition
-application application	Specifies the name of the Oracle Stream Analytics application whose Oracle CQL rules you want to manage. To get the exact name of your application, you can: Use wlevs.Admin to query for the name (see Query for Application and Processor Names). Use the Oracle Stream Analytics Visualizer: Start the Oracle Stream Analytics Visualizer (see Using Visualizer for Oracle Stream Analytics). In the left pane, navigate to and expand the Applications node of the Oracle Stream Analytics instance to which the application is deployed. Each node under the Applications node is named with the exact application name. Look at the MANIFEST.MF file of the application; the application name is specified by the Bundle-SymbolicName header.
-processor processor	Specifies the name of the particular processor, attached to the Oracle Stream Analytics application specified with the -application argument, whose Oracle CQL rules you want to manage. See Query for Application and Processor Names for details on getting the exact name if you do not know it.
-rule [rulename] rulestring	Specifies the Oracle CQL rule you want to add to the specified processor of your application. An Oracle CQL rules include: REGISTER|CREATE FUNCTION (aggregate and single-row functions) REGISTER|CREATE WINDOW The rulename parameter is not required; if you do not specify it, Oracle Stream Analytics generates a name for you. Enter the Oracle CQL rulestring using double quotes.
-query [queryname] querystring	Specifies the Oracle CQL query you want to add to the specified processor of your application. The queryname parameter is not required; if you do not specify it, Oracle Stream Analytics generates a name for you. Enter the Oracle CQL querystring using double quotes.
-view [viewname] viewstring [-schema comma-separated-names]	Specifies the Oracle CQL view you want to add to the specified processor of your application. The viewname parameter is not required; if you do not specify it, Oracle Stream Analytics generates a name for you. Enter the Oracle CQL viewstring using double quotes. The comma-separated-names parameter is not required; if you do not specify it, Oracle Stream Analytics generates the schema based on the select statement in the viewstring.
-active true | false	Specifies if the rule should be started and ready to process events after being added. Valid values for this argument are true (start rule after adding) or false (do not start rule after adding); default value is true. If set to false, use STARTRULE to start the rule.

Example

The following example shows how to add the Oracle CQL query SELECT * FROM Withdrawal [Rows 5], with name myquery, to the Oracle CQL processor helloworldProcessor of the helloworld application:

java wlevs.Admin 
     -url service:jmx:msarmi://localhost:9002/jndi/jmxconnector 
     -username wlevs -password wlevs 
     ADDRULE -application helloworld -processor helloworldProcessor 
     -query myquery "SELECT * FROM Withdrawal [Rows 5]"

C.11.3 DELETERULE

Deletes an existing Oracle CQL rule from the specified processor of an Oracle Stream Analytics application.

Syntax

java wlevs.Admin 
    [ Connection Arguments ]
    [ User Credentials Arguments ]
    [ Common Arguments ] 
    DELETERULE -application application -processor processor -rule rulename

Table C-8 DELETERULE Arguments

Argument	Definition
-application application	Specifies the name of the Oracle Stream Analytics application whose Oracle CQL rules you want to manage. To get the exact name of your application, you can: Use wlevs.Admin to query for the name (see Query for Application and Processor Names). Use the Oracle Stream Analytics Visualizer: Start the Oracle Stream Analytics Visualizer (see Using Visualizer for Oracle Stream Analytics). In the left pane, navigate to and expand the Applications node of the Oracle Stream Analytics instance to which the application is deployed. Each node under the Applications node is named with the exact application name. Look at the MANIFEST.MF file of the application; the application name is specified by the Bundle-SymbolicName header.
-processor processor	Specifies the name of the particular processor, attached to the Oracle Stream Analytics application specified with the -application argument, whose Oracle CQL rules, queries, and views you want to manage. See Query for Application and Processor Names for details on getting the exact name if you do not know it.
-rule rulename	Specifies the name of the Oracle CQL rule, query, or view you want to delete. See Query for Application and Processor Names for details on querying for the rule name if you do not know it. You can also use the DOWNLOAD command to get the list of rules, queries, or views for a particular Oracle CQL processor.

Example

The following example shows how to delete the Oracle CQL view called myview from the Oracle CQL helloworldProcessor of the helloworld application:

java wlevs.Admin 
     -url service:jmx:msarmi://localhost:9002/jndi/jmxconnector 
     -username wlevs -password wlevs 
     DELETERULE -application helloworld -processor helloworldProcessor -rule myview

C.11.4 REPLACERULE

Replaces an existing Oracle CQL rule, query, or view with another rule, query, or view. Oracle Stream Analytics first destroys the original rule, query, or view and then inserts the new one in its place.

Syntax

java wlevs.Admin 
    [ Connection Arguments ]
    [ User Credentials Arguments ]
    [ Common Arguments ] 
    REPLACERULE -application application -processor processor 
        -rule rulename rulestring 

Table C-9 REPLACERULE Arguments

Argument	Definition
-application application	Specifies the name of the Oracle Stream Analytics application whose Oracle CQL rules you want to manage. To get the exact name of your application, you can: Use wlevs.Admin to query for the name (see Query for Application and Processor Names). Use the Oracle Stream Analytics Visualizer: Start the Oracle Stream Analytics Visualizer (see Oracle Stream Analytics Using Visualizer for Oracle Stream Analytics). In the left pane, navigate to and expand the Applications node of the Oracle Stream Analytics instance to which the application is deployed. Each node under the Applications node is named with the exact application name. Look at the MANIFEST.MF file of the application; the application name is specified by the Bundle-SymbolicName header.
-processor processor	Specifies the name of the particular Oracle CQL processor, attached to the Oracle Stream Analytics application specified with the -application argument, whose Oracle CQL rules you want to manage. See Query for Application and Processor Names for details on getting the exact name if you do not know it.
-rule rulename rulestring	Specifies the name of the Oracle CQL rule, query, or view you want to replace. Oracle Stream Analytics deletes the old rule, query, or view and then inserts a new one, with the same name but with the new rule text. In the case of a view, Oracle Stream Analytics generates the schema based on the select statement in the rulestring. Enter the Oracle CQL rulestring using double quotes.

Example

The following example shows how to replace an Oracle CQL query called myquery with the Oracle CQL text SELECT * FROM Withdrawal [Rows 10] in the Oracle CQL helloworldProcessor of the helloworld application:

java wlevs.Admin 
     -url service:jmx:msarmi://localhost:9002/jndi/jmxconnector 
     -username wlevs -password wlevs 
     REPLACERULE -application helloworld -processor helloworldProcessor 
     -rule myquery "SELECT * FROM Withdrawal [Rows 10]"

C.11.5 STARTRULE

Starts an existing Oracle CQL rule or query that was previously stopped in the specified processor of an Oracle Stream Analytics application.

Syntax

java wlevs.Admin 
    [ Connection Arguments ]
    [ User Credentials Arguments ]
    [ Common Arguments ] 
    STARTRULE -application application -processor processor -rule rulename

Table C-10 STARTRULE Arguments

Argument	Definition
-application application	Specifies the name of the Oracle Stream Analytics application whose Oracle CQL rules you want to manage. To get the exact name of your application, you can: Use wlevs.Admin to query for the name (see Query for Application and Processor Names). Use the Oracle Stream Analytics Visualizer: Start the Oracle Stream Analytics Visualizer (see Oracle Stream Analytics Using Visualizer for Oracle Stream Analytics). In the left pane, navigate to and expand the Applications node of the Oracle Stream Analytics instance to which the application is deployed. Each node under the Applications node is named with the exact application name. Look at the MANIFEST.MF file of the application; the application name is specified by the Bundle-SymbolicName header.
-processor processor	Specifies the name of the particular processor, attached to the Oracle Stream Analytics application specified with the -application argument, whose Oracle CQL rules, queries, and views you want to manage. See Query for Application and Processor Names for details on getting the exact name if you do not know it.
-rule rulename	Specifies the name of the Oracle CQL rule or query you want to start. NOTE: You cannot stop and start a view. Views are always active. See Query for Application and Processor Names for details on querying for the rule name if you do not know it. You can also use the DOWNLOAD command to get the list of rules, queries, or views for a particular Oracle CQL processor.

Example

The following example shows how to start the Oracle CQL query called myquery from the Oracle CQL helloworldProcessor of the helloworld application:

java wlevs.Admin 
     -url service:jmx:msarmi://localhost:9002/jndi/jmxconnector 
     -username wlevs -password wlevs 
     STARTRULE -application helloworld -processor helloworldProcessor -rule myquery

C.11.6 STOPRULE

Stops an existing Oracle CQL rule or query that was previously started in the specified processor of an Oracle Stream Analytics application.

Syntax

java wlevs.Admin 
    [ Connection Arguments ]
    [ User Credentials Arguments ]
    [ Common Arguments ] 
    STOPRULE -application application -processor processor -rule rulename

Table C-11 STOPRULE Arguments

Argument	Definition
-application application	Specifies the name of the Oracle Stream Analytics application whose Oracle CQL rules or queries you want to manage. See Query for Application and Processor Names for details on using wlevs.Admin to get the exact name of your application if you do not currently know it. You can also get the exact application name by looking at the MANIFEST.MF file of the application; the application name is specified by the Bundle-SymbolicName header.
-processor processor	Specifies the name of the particular processor, attached to the Oracle Stream Analytics application specified with the -application argument, whose Oracle CQL rules, queries, and views you want to manage. See Query for Application and Processor Names for details on getting the exact name if you do not know it.
-rule rulename	Specifies the name of the Oracle CQL rule or query you want to stop. NOTE: You cannot stop and start a view. Views are always active. See Query for Application and Processor Names for details on querying for the rule name if you do not know it. You can also use the DOWNLOAD command to get the list of rules, queries, or views for a particular Oracle CQL processor.

Example

The following example shows how to stop the Oracle CQL query called myquery from the Oracle CQL helloworldProcessor of the helloworld application:

java wlevs.Admin 
     -url service:jmx:msarmi://localhost:9002/jndi/jmxconnector 
     -username wlevs -password wlevs 
     STOPRULE -application helloworld -processor helloworldProcessor -rule myquery

C.11.7 UPLOAD

Replaces the configured Oracle CQL rules for a specified processor with the Oracle CQL rules from an uploaded component configuration file.

The component configuration file that contains the list of Oracle CQL rules conforms to the component configuration file schema (see Schema Reference for Oracle Stream Analytics). This file contains one or more Oracle CQL rules that replace those currently configured for the specified processor. An example of such a component configuration file follows:

<?xml version="1.0" encoding="UTF-8" ?> 
<config>
  <processor>
  <name>helloworldProcessor</name> 
    <rules>
      <query id="helloworldRule1">
          <![CDATA[  SELECT * FROM HelloWorldEvent [Rows 2] > 
      </query>
    </rules>
  </processor>
</config>

In the preceding example, the component configuration file configures a single Oracle CQL query, with name helloworldRule1, and its Oracle CQL query text is SELECT * FROM HelloWorldEvent [Rows 2].

Caution:

When you use the UPLOAD command of the wlevs.Admin utility, use the -processor argument to specify the name of the Oracle CQL processor to which you want to add the Oracle CQL rules, as you do with the other Oracle CQL commands. This means that the utility ignores any <name> elements in the component configuration file to avoid any naming conflicts.

For details about and examples of creating the component configuration file, Developing Event Processing Applications for Oracle Stream Analytics.

You can obtain a copy of a processor's component configuration file using the DOWNLOAD command as DOWNLOAD describes.

Syntax

java wlevs.Admin 
    [ Connection Arguments ]
    [ User Credentials Arguments ]
    [ Common Arguments ] 
    UPLOAD -application application -processor processor -sourceURL sourcefileURL

Table C-12 UPLOAD Arguments

Argument	Definition
-application application	Specifies the name of the Oracle Stream Analytics application whose Oracle CQL rules you want to manage. To get the exact name of your application, you can: Use wlevs.Admin to query for the name (see Query for Application and Processor Names). Use the Oracle Stream Analytics Visualizer: Start the Oracle Stream Analytics Visualizer (see Oracle Stream Analytics Using Visualizer for Oracle Stream Analytics). In the left pane, navigate to and expand the Applications node of the Oracle Stream Analytics instance to which the application is deployed. Each node under the Applications node is named with the exact application name. Look at the MANIFEST.MF file of the application; the application name is specified by the Bundle-SymbolicName header.
-processor processor	Specifies the name of the particular Oracle CQL processor, attached to the Oracle Stream Analytics application specified with the -application argument, whose Oracle CQL rules you want to manage. See Query for Application and Processor Names for details on getting the exact name if you do not know it.
-sourceURL sourcefileURL	Specifies the URL of the component configuration file that contains the Oracle CQL rules in the form: file:///path-to-file

Example

The following example shows how upload the Oracle CQL rules from the c:\processor\config\myrules.xml file to the Oracle CQL helloworldProcessor of the helloworld application:

java wlevs.Admin 
     -url service:jmx:msarmi://localhost:9002/jndi/jmxconnector 
     -username wlevs -password wlevs 
     UPLOAD -application helloworld -processor helloworldProcessor 
     -sourceURL file:///c:/processor/config/myrules.xml

C.11.8 DOWNLOAD

Downloads the set of Oracle CQL rules associated with the specified Oracle CQL processor of an Oracle Stream Analytics application to an XML component configuration file.

The XML file is of the same format as described in UPLOAD.

Syntax

java wlevs.Admin 
    [ Connection Arguments ]
    [ User Credentials Arguments ]
    [ Common Arguments ] 
    DOWNLOAD -application application -processor processor 
    -file destinationfile [-overwrite overwrite]

Table C-13 DOWNLOAD Arguments

Argument	Definition
-application application	Specifies the name of the Oracle Stream Analytics application whose Oracle CQL rules you want to manage. To get the exact name of your application, you can: Use wlevs.Admin to query for the name (see Query for Application and Processor Names). Use the Oracle Stream Analytics Visualizer: Start the Oracle Stream Analytics Visualizer (see Using Visualizer for Oracle Stream Analytics). In the left pane, navigate to and expand the Applications node of the Oracle Stream Analytics instance to which the application is deployed. Each node under the Applications node is named with the exact application name. Look at the MANIFEST.MF file of the application; the application name is specified by the Bundle-SymbolicName header.
-processor processor	Specifies the name of the particular processor, attached to the Oracle Stream Analytics application specified with the -application argument, whose Oracle CQL rules you want to manage. See Query for Application and Processor Names for details on getting the exact name if you do not know it.
-file destinationfile	Specifies the name of the component configuration XML file to which you want the wlevs.Admin utility to download the Oracle CQL rules. Be sure you specify the full pathname of the file.
-overwrite overwrite	Specifies whether the wlevs.Admin utility should overwrite an existing file. Valid values for this argument are true or false; default value is false.

Example

The following example shows how download the set of Oracle CQL rules currently attached to the Oracle CQL helloworldProcessor of the helloworld application to the file c:\processor\config\myrules.xml; the utility overwrites any existing file:

java wlevs.Admin 
     -url service:jmx:msarmi://localhost:9002/jndi/jmxconnector 
     -username wlevs -password wlevs 
     DOWNLOAD -application helloworld -processor helloworldProcessor 
     -file c:\processor\config\myrules.xml -overwrite true

C.12 Commands to Manage MBeans

This section lists the commands to manage MBeans.

The following sections describe wlevs.Admin commands for managing Oracle Stream Analytics MBeans.

• Specifying MBean Types

• MBean Management Commands

See the Java API Reference for Oracle Stream Analytics for the full description of the Oracle Stream Analytics MBeans.

C.12.1 Specifying MBean Types

To specify which MBean or MBeans you want to access, view, or modify, all of the MBean management commands require either the -mbean argument or the -type argument.

Use the -mbean argument to operate on a single instance of an MBean.

Use the -type argument to operate on all MBeans that are an instance of a type that you specify. An MBean's type refers to the interface class of which the MBean is an instance. All Oracle Stream Analytics MBeans are an instance of one of the interface classes defined in the com.bea.wlevs.management.configuration, com.bea.wlevs.management.runtime, com.bea.wlevs.deployment.mbean and com.bea.wlevs.server.management.mbean packages. For a complete list of all Oracle Stream Analytics MBean interface classes, see the Java API Reference for Oracle Stream Analytics for the respective packages.

To determine the value that you provide for the -type argument, do the following: Find the MBean's interface class and remove the MBean suffix from the class name. For example, for an MBean that is an instance of the com.bea.wlevs.management.configuration.CQLProcessorMBean, use CQLProcessor.

C.12.2 MBean Management Commands

Table C-14 is an overview of the MBean management commands.

Table C-14 MBean Management Command Overview

Command	Description
GET	Displays properties of MBeans.
INVOKE	Invokes management operations that an MBean exposes for its underlying resource.
QUERY	Searches for MBeans whose ObjectName matches a pattern that you specify.
SET	Sets the specified property values for the named MBean instance.

C.12.3 GET

Displays MBean properties and JMX object names in the format described at.http://docs.oracle.com/javase/7/docs/api/javax/management/ObjectName.html

The output of the command follows:

{MBeanName object-name {property1 value} {property2 value}. . .} 
. . .

Note that the properties and values are expressed as name-value pair where each pair is returned within curly brackets. This format facilitates output parsing by a script.

If -pretty is specified, each property-value pair is displayed on a new line and curly brackets are not used to separate the pairs:

MBeanName: object-name
property1: value
property2: value
.
.
.
MBeanName: object-name
property1: value
abbribute2: value

Syntax

java wlevs.Admin 
    [ Connection Arguments ]
    [ User Credentials Arguments ]
    [ Common Arguments ] 
    GET [-pretty] {-type mbeanType| -mbean objectName} [-property property1] [-property property2]...

Table C-15 GET Arguments

Argument	Definition
-type mbeanType	Returns information for all MBeans of the specified type. For more information, see Specifying MBean Types.
-mbean objectName	Fully qualified object name of an MBean in the http://java.sun.com/j2se/1.5.0/docs/api/javax/management/ObjectName.html format. For example, if you want to look up an MBean for a processor stage, the naming is as follows (in practice, the string should be on one line): "com.bea.wlevs:Name=<name of the Stage>,Type=<type of Mbean>, Application=<name of the application>"
-pretty	Places property-value pairs on separate lines.
-property property	The name of the MBean property (attribute) or properties to be listed. If -property is not specified, all properties are displayed.

Example

The following example displays all properties of the CQLProcessorMBean that was registered for the Processor Stage when the application called helloworld was deployed in Oracle Stream Analytics.

java wlevs.Admin
     -url service:jmx:msarmi://localhost:9002/jndi/jmxconnector
     -username wlevs -password wlevs
     GET -pretty
     -mbean com.bea.wlevs:Name=cqlprocessor,Type=CQLProcessor,Application=helloworld

The following example displays all instances of all CQLProcessorMBean MBeans.

java wlevs.Admin 
     -url service:jmx:msarmi://localhost:9002/jndi/jmxconnector 
     -username wlevs -password wlevs 
     GET -pretty -type CQLProcessor

C.12.4 INVOKE

Invokes a management operation for one or more MBeans. For Oracle Stream Analytics MBeans, you usually use this command to invoke operations other than the getAttribute and setAttribute that most Oracle Stream Analytics MBeans provide.

Syntax

java wlevs.Admin 
    [ Connection Arguments ]
    [ User Credentials Arguments ]
    [ Common Arguments ] 
    INVOKE {-type mbeanType | -mbean objectName} -method methodname [argument . . .]

Table C-16 INVOKE Arguments

Arguments	Definition
-type mbeanType	Invokes the operation on all MBeans of a specific type. For more information, see Specifying MBean Types.
-mbean objectName	Fully qualified object name of an MBean in the http://java.sun.com/j2se/1.5.0/docs/api/javax/management/ObjectName.html format. For example, if you want to invoke an MBean for an processor stage, the naming is as follows "com.bea.wlevs:Name=<name of the Stage>,Type=<type of Mbean>, Application=<name of the application>"
-method methodname	Name of the method to be invoked.
argument	Arguments to be passed to the method call. When the argument is a String array, the arguments must be passed in the following format: "String1;String2;. . . "

Example

The following example invokes the addRule method of MBean com.bea.wlevs.management.configuration.CQLProcessorMBean:

java wlevs.Admin 
    -url service:jmx:msarmi://localhost:9002/jndi/jmxconnector 
    -username wlevs -password wlevs 
    INVOKE -mbean com.bea.wlevs:Name=cqlprocessor,Type=CQLProcessor,Application=helloworld 
    -method addRule "SELECT * FROM Withdrawal RETAIN ALL"

C.12.5 QUERY

Searches for Oracle Stream Analytics MBeans where the pattern matches the pattern that you specify according to the ObjectName class conventions at: http://docs.oracle.com/javase/1.5.0/docs/api/javax/management/ObjectName.html.

All MBeans that are created from an Oracle Stream Analytics MBean type are registered in the MBean Server under a name that conforms to the ObjectName class conventions. You must know the ObjectName of an MBean to use wlevs.Admin commands to retrieve or modify specific MBean instances.

The output of the command follows:

{MBeanName object-name {property1 value} {property2 value}. . .} 
. . .

The properties and values are expressed as name-value pairs, each of which is returned within curly brackets. This format facilitates parsing of the output by a script.

If -pretty is specified, each property-value pair is displayed on a new line and curly brackets are not used to separate the pairs:

MBeanName: object-name
property1: value
property2: value
.
.
.
MBeanName: object-name
property1: value
abbribute2: value

Syntax

java wlevs.Admin 
    [ Connection Arguments ]
    [ User Credentials Arguments ]
    [ Common Arguments ] 
    QUERY -pretty -pattern object-name-pattern 

Table C-17 QUERY Arguments

Argument	Definition
-pretty	Places property-value pairs on separate lines.
-pattern object-name-pattern	A partial http://java.sun.com/j2se/1.5.0/docs/api/javax/management/ObjectName.html for which the QUERY command searches. The value must conform to the following pattern: property-list where property-list specifies one or more components (property-value pairs) of a http://java.sun.com/j2se/1.5.0/docs/api/javax/management/ObjectName.html. You can specify these property-value pairs in any order. Within a given naming property-value pair, there is no pattern matching. Only complete property-value pairs are used in pattern matching. However, you can use the * wildcard character in the place of one or more property-value pairs. For example, type=epl* is not valid, but type=CQLProcessor,* is valid. If you provide at least one property-value pair in the property-list, you can locate the wildcard anywhere in the given pattern, provided that the property-list is still a comma-separated list.

Example

The following example searches for all com.bea.wlevs.management.configuration.CQLProcessorMBean MBeans:

java wlevs.Admin 
     -url service:jmx:msarmi://localhost:9002/jndi/jmxconnector 
     -username wlevs -password wlevs 
     QUERY -pattern *:Type=CQLProcessor,*

If the command succeeds, it returns the attributes of the MBeans found (lines broken here for readability):

{MBeanName="com.bea.wlevs:Name=MonitorProcessor,Type=CQLProcessor,Application=com.bea.wlevs.dataservices"{
 AllRules=defaultRule = select * from DSMonitorEvent retain 1 event where metric > 10000}{
 AllRulesInfo=defaultRule = {RULE_TYPE=RULE, STARTED=true, VALUE=select * from DSMonitorEvent 
 retain 1 event where metric > 10000, ID=defaultRule}}{Databases=}{Name=MonitorProcessor}
 {NotificationInfo=[Ljavax.management.MBeanNotificationInfo;@20d319}
 {ObjectName=com.bea.wlevs:Name=MonitorProcessor,Type=CQLProcessor,
 Application=com.bea.wlevs.dataservices}{PlaybackConfiguration=}{PlayingBack=false}
 {RecordConfiguration=}{RecordPlayback=com.bea.wlevs:Name=MonitorProcessor,
 Type=RecordPlayback,Application=com.bea.wlevs.dataservices}{Recording=false}
 {Type=CQLProcessor}}

C.12.6 Query for Application and Processor Names

All the commands for managing the CQL rules of an Oracle Stream Analytics application require you to know the name of the application, and the particular processor to which you want to apply the rules. Typically you know these names, but if you do not, you can use the QUERY command to get the information from the MBean instances that represent applications and their attached processors.

In particular, use the following -pattern argument to get a list of all applications, processors, and rules for a given Oracle Stream Analytics instance:

-pattern  com.bea.wlevs:*,Type=CQLProcessor 

For example:

java wlevs.Admin 
     -url service:jmx:msarmi://localhost:9002/jndi/jmxconnector 
     -username wlevs -password wlevs 
     QUERY -pretty 
     -pattern com.bea.wlevs:*,Type=CQLProcessor

A sample output of this command is shown below:

Command Output
------------------------------------------------------
MBeanName: "com.bea.wlevs:Name=helloworldProcessor,Type=CQLProcessor,Application=helloworld,"
       AllRules:
       helloworldRule =  select * from HelloWorldEvent retain 1 event 
--end of command output -------- 

In the sample output above:

• The name of the application is helloworld.

• The helloworld application has a processor called helloworldProcessor.

• The helloworldProcessor has a rule called helloworldRule.

C.12.7 SET

Sets the specified property (attribute) values for an MBean.

If the command is successful, it returns OK and saves the new values to the server configuration.

Syntax

java wlevs.Admin 
    [ Connection Arguments ]
    [ User Credentials Arguments ]
    [ Common Arguments ] 
    SET {-type mbeanType | -mbean objectName}
    -property property1 property1_value 
    [-property property2 property2_value] . . .

Table C-18 SET Arguments

Argument	Definition
-type mbeanType	Sets the properties for all MBeans of a specific type. For more information, see Specifying MBean Types.
-mbean objectName	Fully qualified object name of an MBean in the http://java.sun.com/j2se/1.5.0/docs/api/javax/management/ObjectName.html format: "com.bea.wlevs:Name=<name of the stage>,Type=<MBean type>,Application=<name of the deployed application>"
-property property	The name of the property to be set.
property _value	The value to be set. Some properties require you to specify the name of an Oracle Stream Analytics MBean. In this case, specify the fully qualified object name of an MBean in the http://java.sun.com/j2se/1.5.0/docs/api/javax/management/ObjectName.html format. For example (in practice, the string should be on one line): "com.bea.wlevs:Name=<name of the stage>,Type=<type of MBean>, Application=<name of the application>" When the property value is an MBean array, separate each MBean object name by a semicolon and surround the entire property value list with quotes. For example: "com.bea.wlevs:Application=<name of the application>,Type=<type of MBean>,Name=<name of the Stage>;Type=<type of MBean>,Name=<name of the stage>" When the property value is a String array, separate each string by a semicolon and surround the entire property value list with quotes: "String1;String2;. . . " When the property value is a String or String array, you can set the value to null by using either of the following: -property property-name "" -property property-name If the property value contains spaces, surround the value with quotes: "-Da=1 -Db=3"

Example

The following example shows how to set the MaxSize property of the channel named helloworldOutstream of the helloworld application:

java wlevs.Admin 
     -url service:jmx:msarmi://localhost:9002/jndi/jmxconnector 
     -username wlevs -password wlevs 
     SET -mbean com.bea.wlevs:Name=helloworldOutstream,Type=Channel,Application=helloworld 
     -property  MaxSize 1024

C.13 Commands for Controlling Event Record and Playback

This section explains the commands for controlling event record and playback.

Table C-19 is an overview of commands for managing event record and playback for a particular stage of an Oracle Stream Analytics application. Subsequent sections describe command syntax and arguments, and provide an example for each command.

Note:

Before you can use commands to control event record and playback on a stage, you must configure the stage with the appropriate event record and playback options. See CONFIGURERECORD.

Table C-19 Overview of Commands for Controlling Event Record and Playback

Command	Description
STARTRECORD	Starts the recording of events for a stage in an Oracle Stream Analytics application.
STOPRECORD	Stops the recording of events for a stage in an Oracle Stream Analytics application.
CONFIGURERECORD	Configures the parameters for the event recording of a stage in an Oracle Stream Analytics application.
SCHEDULERECORD	Schedules the recording of events for a stage in an Oracle Stream Analytics application.
LISTRECORD	List the event recording configuration for a stage in an Oracle Stream Analytics application.
STARTPLAYBACK	Starts playing back events for a stage in an Oracle Stream Analytics application.
STOPPLAYBACK	Stops playing back events for a stage in an Oracle Stream Analytics application.
CONFIGUREPLAYBACK	Configures the parameters for the event playback of a stage in an Oracle Stream Analytics application.
SCHEDULEPLAYBACK	Schedules the playback of events for a stage in an Oracle Stream Analytics application.
LISTPLAYBACK	List the event playback configuration for a stage in an Oracle Stream Analytics application.

C.13.1 STARTRECORD

Starts recording events for a particular stage of an Oracle Stream Analytics application.

Note:

Before you can use commands for controlling event record and playback on a stage, you must first configure the stage with the appropriate event record and playback options. See CONFIGURERECORD.

If you configured the stage to start recording at a later time, that configuration is ignored and recording starts immediately.

Syntax

java wlevs.Admin 
    [ Connection Arguments ]
    [ User Credentials Arguments ]
    [ Common Arguments ] 
    STARTRECORD -application application -stage stage

Table C-20 STARTRECORD Arguments

Argument	Definition
-stage stage	Specifies the name of the particular stage, attached to the Oracle Stream Analytics application specified with the -application argument, whose event record and playback you want to manage.
-application application	Specifies the name of the Oracle Stream Analytics application whose event record and playback you want to manage. To get the exact name of your application, you can: Use wlevs.Admin to query for the name (see Query for Application and Processor Names). Use the Oracle Stream Analytics Visualizer: Start the Oracle Stream Analytics Visualizer (see Oracle Stream Analytics Using Visualizer for Oracle Stream Analytics). In the left pane, navigate to and expand the Applications node of the Oracle Stream Analytics instance to which the application is deployed. Each node under the Applications node is named with the exact application name. Look at the MANIFEST.MF file of the application; the application name is specified by the Bundle-SymbolicName header.

Example

The following example shows how to start the recording of events on the helloworldAdapter stage of the helloworld application deployed to the specified Oracle Stream Analytics instance:

java wlevs.Admin 
     -url service:jmx:msarmi://localhost:9002/jndi/jmxconnector 
     -username wlevs -password wlevs 
     STARTRECORD -application helloworld -stage helloworldAdapter 

Note:

Before you can use commands for controlling event record and playback on a stage, you must first configure the stage with the appropriate event record and playback options. See CONFIGURERECORD.

C.13.2 STOPRECORD

Stops the recording of events for a stage of an Oracle Stream Analytics application in which the recording of events has been previously started.

Syntax

java wlevs.Admin 
    [ Connection Arguments ]
    [ User Credentials Arguments ]
    [ Common Arguments ] 
    STOPRECORD -application application -stage stage

Table C-21 STOPRECORD Arguments

Argument	Definition
-application application	Specifies the name of the Oracle Stream Analytics application whose event record and playback you want to manage. To get the exact name of your application, you can: Use wlevs.Admin to query for the name (see Query for Application and Processor Names). Use the Oracle Stream Analytics Visualizer: Start the Oracle Stream Analytics Visualizer (see Oracle Stream Analytics Using Visualizer for Oracle Stream Analytics). In the left pane, navigate to and expand the Applications node of the Oracle Stream Analytics instance to which the application is deployed. Each node under the Applications node is named with the exact application name. Look at the MANIFEST.MF file of the application; the application name is specified by the Bundle-SymbolicName header.
-stage stage	Specifies the name of the particular stage, attached to the Oracle Stream Analytics application specified with the -application argument, whose event record and playback you want to manage.

Example

The following example shows how to stop the recording of events on the helloworldAdapter stage of the helloworld application deployed to the specified Oracle Stream Analytics instance; it is assumed that the recording of events was previously started for the stage:

java wlevs.Admin 
     -url service:jmx:msarmi://localhost:9002/jndi/jmxconnector 
     -username wlevs -password wlevs 
     STOPRECORD -application helloworld -stage helloworldAdapter 

C.13.3 CONFIGURERECORD

Configures the parameters associated with the recording of events for a stage of an Oracle Stream Analytics application. Use this command to configure a stage for the first time for event recording or to change the data set name or provider name.

Syntax

java wlevs.Admin 
    [ Connection Arguments ]
    [ User Credentials Arguments ]
    [ Common Arguments ] 
    CONFIGURERECORD -application application -stage stage
        [-datasetName datasetname] 
        [-storeProvider storeprovidername] 
        [-eventTypes eventtypes] 
        [-scheduleStartTime startime] 
        [-scheduleEndTime endtime | -scheduleDuration duration]

Table C-22 CONFIGURERECORD Arguments

Argument	Definition
-application application	Specifies the name of the Oracle Stream Analytics application whose event record and playback you want to manage. To get the exact name of your application, you can: Use wlevs.Admin to query for the name (see Query for Application and Processor Names). Use the Oracle Stream Analytics Visualizer: Start the Oracle Stream Analytics Visualizer (see Using Visualizer for Oracle Stream Analytics). In the left pane, navigate to and expand the Applications node of the Oracle Stream Analytics instance to which the application is deployed. Each node under the Applications node is named with the exact application name. Look at the MANIFEST.MF file of the application; the application name is specified by the Bundle-SymbolicName header.
-stage stage	Specifies the name of the particular stage, attached to the Oracle Stream Analytics application specified with the -application argument, whose event record and playback you want to manage.
-datasetName datasetname	Specifies the name of the dataset in which events are recorded.
-storeProvider storeprovidername	Specifies a valid data-source name defined in the Oracle Stream Analytics server config.xml file. To select the default BDB provider, leave this argument empty or specify an argument value of default-provider. For more information, see Schema Reference for Oracle Stream Analytics.
-eventTypes eventtypes	Specifies the comma-separated list of valid event type names to be recorded. Event types must be defined in the event type repository.
-scheduleStartTime starttime	Specifies the time when the recording should start. Express the start time as an XMLSchema dateTime value of the form: mm-dd-yyyy:hh:mm:ss For example, to specify that recording should start on October 20, 2013, at 11:22:07 am, use the following value: 10-20-2013:11:22:07 For complete details of the XMLSchema dateTime format, see http://www.w3.org/TR/xmlschema-2/#dateTime-lexical-representation.
-scheduleEndTime endtime	Specifies the actual time when the recording should end. Express the end time as an XMLSchema dateTime value of the form: mm-dd-yyyy:hh:mm:ss For example, to specify that recording should end on October 20, 2013, at 6:00pm, use the following value: 10-20-2013:18:00:00 For complete details of the XMLSchema dateTime format, see http://www.w3.org/TR/xmlschema-2/#dateTime-lexical-representation. Specify null if you want the recording to run forever. You can specify either -scheduleEndTime or -scheduleDuration, but not both.
-scheduleDuration duration	Specifies the duration of time after which event recording for this stage ends. Specify null if you want the recording to run forever. The format is HH:mm:ss, such as 01:00:00. You can specify either -scheduleEndTime or -scheduleDuration, but not both.

Example

The examples in this section show how to configure the recording of events of the helloworldAdapter of the helloworld application deployed to the specified Oracle Stream Analytics instance.

The following example specifies a start and end time for recording:

java wlevs.Admin 
     -url service:jmx:msarmi://localhost:9002/jndi/jmxconnector 
     -username wlevs -password wlevs 
     CONFIGURERECORD -application helloworld -stage helloworldAdapter 
     -datasetName myds -storeProvider mysp
     -scheduleStartTime 10-20-2013:11:22:07 -scheduleEndTime 10-20-2013:18:00:00

The following example specifies a start time and a duration for recording:

java wlevs.Admin 
     -url service:jmx:msarmi://localhost:9002/jndi/jmxconnector 
     -username wlevs -password wlevs 
     CONFIGURERECORD -application helloworld -stage helloworldAdapter
     -datasetName myds -storeProvider mysp
     -scheduleStartTime 10-20-2013:11:22:07 -scheduleDuration 01:00:00

The following example specifies a start time and a duration of null, which means recording runs forever:

java wlevs.Admin 
     -url service:jmx:msarmi://localhost:9002/jndi/jmxconnector 
     -username wlevs -password wlevs 
     CONFIGURERECORD -application helloworld -stage helloworldAdapter 
     -datasetName myds -storeProvider mysp
     -scheduleStartTime 10-20-2013:11:22:07 -scheduleDuration null

C.13.4 SCHEDULERECORD

Configures the schedule parameters associated with the recording of events for a stage of an Oracle Stream Analytics application.

Syntax

java wlevs.Admin 
    [ Connection Arguments ]
    [ User Credentials Arguments ]
    [ Common Arguments ] 
    SCHEDULERECORD -application application -stage stage
        [-scheduleStartTime startime] 
        [-scheduleEndTime endtime | -scheduleDuration duration]

Table C-23 SCHEDULERECORD Arguments

Argument	Definition
-application application	Specifies the name of the Oracle Stream Analytics application whose event record and playback you want to manage. To get the exact name of your application, you can: Use wlevs.Admin to query for the name (see Query for Application and Processor Names). Use the Oracle Stream Analytics Visualizer: Start the Oracle Stream Analytics Visualizer (see Oracle Stream Analytics Using Visualizer for Oracle Stream Analytics). In the left pane, navigate to and expand the Applications node of the Oracle Stream Analytics instance to which the application is deployed. Each node under the Applications node is named with the exact application name. Look at the MANIFEST.MF file of the application; the application name is specified by the Bundle-SymbolicName header.
-stage stage	Specifies the name of the particular stage, attached to the Oracle Stream Analytics application specified with the -application argument, whose event record and playback you want to manage.
-scheduleStartTime starttime	Specifies the time when the recording should start. Express the start time as an XMLSchema dateTime value of the form: mm-dd-yyyy:hh:mm:ss For example, to specify that recording should start on October 20, 2013, at 11:22:07 am, use the following value: 10-20-2013:11:22:07
-scheduleEndTime endtime	Specifies the actual time when the recording should end. Express the end time as an XMLSchema dateTime value of the form: mm-dd-yyyy:hh:mm:ss For example, to specify that recording should end on October 20, 2013, at 6:00 pm, use the following value: 10-20-2013:18:00:00 For complete details of the XMLSchema dateTime format, see http://www.w3.org/TR/xmlschema-2/#dateTime-lexical-representation. Specify null if you want the recording to run forever. You can specify either -scheduleEndTime or -scheduleDuration, but not both.
-scheduleDuration duration	Specifies the duration of time after which event recording for this stage ends. Specify null if you want the recording to run forever. The format is HH:mm:ss, such as 01:00:00. You can specify either -scheduleEndTime or -scheduleDuration, but not both.

Example

The examples in this section show how to configure the scheduling of recording of events of the helloworldAdapter of the helloworld application deployed to the specified Oracle Stream Analytics instance.

The following example specifies a start and end time for recording:

java wlevs.Admin 
     -url service:jmx:msarmi://localhost:9002/jndi/jmxconnector 
     -username wlevs -password wlevs 
     SCHEDULERECORD -application helloworld -stage helloworldAdapter 
     -scheduleStartTime 10-20-2013:11:22:07 -scheduleEndndTime 10-20-2013:18:00:00

C.13.5 LISTRECORD

Lists the event recording configuration for any particular stage of an Oracle Stream Analytics application.

Syntax

java wlevs.Admin 
    [ Connection Arguments ]
    [ User Credentials Arguments ]
    [ Common Arguments ] 
    LISTRECORD -application application -stage stage

Table C-24 LISTRECORD Arguments

Argument	Definition
-application application	Specifies the name of the Oracle Stream Analytics application whose event record and playback you want to manage. To get the exact name of your application, you can: Use wlevs.Admin to query for the name (see Query for Application and Processor Names). Use the Oracle Stream Analytics Visualizer: Start the Oracle Stream Analytics Visualizer (see Using Visualizer for Oracle Stream Analytics). In the left pane, navigate to and expand the Applications node of the Oracle Stream Analytics instance to which the application is deployed. Each node under the Applications node is named with the exact application name. Look at the MANIFEST.MF file of the application; the application name is specified by the Bundle-SymbolicName header.
-stage stage	Specifies the name of the particular stage, attached to the Oracle Stream Analytics application specified with the -application argument, whose event record and playback you want to manage.

Example

The following example shows how to list the event recording configuration on the helloworldAdapter stage of the helloworld application deployed to the specified Oracle Stream Analytics instance:

java wlevs.Admin 
     -url service:jmx:msarmi://localhost:9002/jndi/jmxconnector 
     -username wlevs -password wlevs 
     LISTRECORD -application helloworld -stage helloworldAdapter 

C.13.6 STARTPLAYBACK

Starts the playback of events of a particular stage of a Oracle Stream Analytics application.

Syntax

java wlevs.Admin 
    [ Connection Arguments ]
    [ User Credentials Arguments ]
    [ Common Arguments ] 
    STARTPLAYBACK -application application -stage stage
        [-filterStartTime starttime] 
        [-filterEndTime endtime | -filterDuration duration]        [-speed speed]         [-repeat true | false]

Table C-25 STARTPLAYBACK Arguments

Argument	Definition
-application application	Specifies the name of the Oracle Stream Analytics application whose event record and playback you want to manage. To get the exact name of your application, you can: Use wlevs.Admin to query for the name (see Query for Application and Processor Names). Use the Oracle Stream Analytics Visualizer: Start the Oracle Stream Analytics Visualizer (see Using Visualizer for Oracle Stream Analytics). In the left pane, navigate to and expand the Applications node of the Oracle Stream Analytics instance to which the application is deployed. Each node under the Applications node is named with the exact application name. Look at the MANIFEST.MF file of the application; the application name is specified by the Bundle-SymbolicName header.
-stage stage	Specifies the name of the particular stage, attached to the Oracle Stream Analytics application specified with the -application argument, whose event record and playback you want to manage.
-filterStartTime startime	Specifies that only events with record-time greater than or equal to this value will be selected for playback. Express the start time as an XMLSchema dateTime value of the form: yyyy-mm-ddThh:mm:ss For example, to play back only events with record-time greater than or equal to January 20, 2010, at 5:00am, use the following value: 2010-01-20T05:00:00 For complete details of the XMLSchema dateTime format, see http://www.w3.org/TR/xmlschema-2/#dateTime-lexical-representation. Specify null if you want to select all events for playback.
-filterEndTime endtime	Specifies only events with record-time less than or equal to this value will be selected for playback. Express the end time as an XMLSchema dateTime value of the form: yyyy-mm-ddThh:mm:ss For example, to play back only events with record-time less than or equal to January 20, 2010, at 6:00pm, use the following value: 2010-01-20T18:00:00 For complete details of the XMLSchema dateTime format, see http://www.w3.org/TR/xmlschema-2/#dateTime-lexical-representation. You can specify either -filterEndTime or -filterDuration, but not both.
-filterDuration duration	Specifies the filter applied to events in the event store. Only events that were recorded during the filter time will be selected for play back. Specify null if you want to select all events for playback. The format is HH:mm:ss, such as 01:00:00. You can specify either -filterEndTime or -filterDuration, but not both.
-speed speed	Specifies the playback speed as a positive float. The default value is 1, which corresponds to normal speed. A value of 2 means that events will be played back 2 times faster than the original record speed. Similarly, a value of 0.5 means that events will be played back 2 times slower than the original record speed.
-repeat repeat	Specifies whether to playback events again after the playback of the specified time interval is over. Valid values are true or false. Default value is false. A value of true means that the repeat of playback continues an infinite number of times until it is deliberately stopped (see STOPPLAYBACK). A value of false means that events will be played back only once.

Example

The following example shows how to start the playback of events on the helloworldAdapter stage of the helloworld application deployed to the specified Oracle Stream Analytics instance:

java wlevs.Admin 
     -url service:jmx:msarmi://localhost:9002/jndi/jmxconnector 
     -username wlevs -password wlevs 
     STARTPLAYBACK -application helloworld -stage helloworldAdapter 

C.13.7 STOPPLAYBACK

Stops the playback of events for a stage of an Oracle Stream Analytics application in which the playback of events has been previously started.

Syntax

Table C-26 STOPPLAYBACK Arguments

Argument	Definition
-application application	Specifies the name of the Oracle Stream Analytics application whose event record and playback you want to manage. To get the exact name of your application, you can: Use wlevs.Admin to query for the name (see Query for Application and Processor Names). Use the Oracle Stream Analytics Visualizer: Start the Oracle Stream Analytics Visualizer (see Using Visualizer for Oracle Stream Analytics). In the left pane, navigate to and expand the Applications node of the Oracle Stream Analytics instance to which the application is deployed. Each node under the Applications node is named with the exact application name. Look at the MANIFEST.MF file of the application; the application name is specified by the Bundle-SymbolicName header.
-stage stage	Specifies the name of the particular stage, attached to the Oracle Stream Analytics application specified with the -application argument, whose event record and playback you want to manage.

java wlevs.Admin 
    [ Connection Arguments ]
    [ User Credentials Arguments ]
    [ Common Arguments ] 
    STOPPLAYBACK -application application -stage stage

Example

The following example shows how to stop the playback of events on the helloworldAdapter stage of the helloworld application deployed to the specified Oracle Stream Analytics instance; it is assumed that the playback of events was previously started for the stage:

java wlevs.Admin 
     -url service:jmx:msarmi://localhost:9002/jndi/jmxconnector 
     -username wlevs -password wlevs 
     STOPPLAYBACK -application helloworld -stage helloworldAdapter 

C.13.8 CONFIGUREPLAYBACK

Configures the parameters associated with the playback of events for a stage of an Oracle Stream Analytics application.

Syntax

java wlevs.Admin 
    [ Connection Arguments ]
    [ User Credentials Arguments ]
    [ Common Arguments ] 
    CONFIGUREPLAYBACK -application application -stage stage
      [-datasetName datasetname] 
      [-storeProvider storeprovidername] 
      [-eventTypes eventtypes] 
      [-scheduleStartTime sstart] 
      [-scheduleEndTime send | -scheduleDuration sduration]
      [-filterStartTime fstart] [-filterEndTime fend | -filterDuration fduration]
      [-speed speed] 
      [-repeat true | false]

Table C-27 CONFIGUREPLAYBACK Arguments

Argument	Definition
-application application	Specifies the name of the Oracle Stream Analytics application whose event record and playback you want to manage. To get the exact name of your application, you can: Use wlevs.Admin to query for the name (see Query for Application and Processor Names). Use the Oracle Stream Analytics Visualizer: Start the Oracle Stream Analytics Visualizer (see Using Visualizer for Oracle Stream Analytics). In the left pane, navigate to and expand the Applications node of the Oracle Stream Analytics instance to which the application is deployed. Each node under the Applications node is named with the exact application name. Look at the MANIFEST.MF file of the application; the application name is specified by the Bundle-SymbolicName header.
-stage stage	Specifies the name of the particular stage, attached to the Oracle Stream Analytics application specified with the -application argument, whose event record and playback you want to manage.
-datasetName datasetname	Specifies the name of the dataset in which events are recorded.
-storeProvider storeprovidername	Specifies a valid data-source name defined in the Oracle Stream Analytics server config.xml file. To select the default BDB provider, leave this argument empty or specify an argument value of default-provider. For more information, see Schema Reference for Oracle Stream Analytics.
-eventTypes eventtypes	Specifies the comma-separated list of valid event type names for playing back. Event types must be defined in the event type repository.
-scheduleStartTime sstart	Specifies the time when play back should start. Express the start time as an XMLSchema dateTime value of the form: mm-dd-yyyy:hh:mm:ss For example, to specify that recording should start on October 20, 2013, at 11:22:07 am, use the following value: 10-20-2013:11:22:07 For complete details of the XMLSchema dateTime format, see http://www.w3.org/TR/xmlschema-2/#dateTime-lexical-representation.
-scheduleEndTime send	Specifies the actual time when the play back should end. Express the end time as an XMLSchema dateTime value of the form: mm-dd-yyyy:hh:mm:ss For example, to specify that play back should end on January 20, 2013, at 6:00pm, use the following value: 10-20-2013:18:00:00 For complete details of the XMLSchema dateTime format, see http://www.w3.org/TR/xmlschema-2/#dateTime-lexical-representation. Specify null if you want the recording to run forever. You can specify either -scheduleEndTime or -scheduleDuration, but not both.
-scheduleDuration sduration	Specifies the duration of time after which event playback for this stage ends. Specify null if you want the event playback to run forever. The format is HH:mm:ss, such as 01:00:00. You can specify either -scheduleEndTime or -scheduleDuration, but not both.
-filterStartTime fstart	Specifies that only events with record-time greater than or equal to this value will be selected for playback. Express the start time as an XMLSchema dateTime value of the form: yyyy-mm-ddThh:mm:ss For example, to play back only events with record-time greater than or equal to January 20, 2010, at 5:00am, use the following value: 2010-01-20T05:00:00 For complete details of the XMLSchema dateTime format, see http://www.w3.org/TR/xmlschema-2/#dateTime-lexical-representation. Specify null if you want to select all events for playback.
-filterEndTime fend	Specifies only events with record-time less than or equal to this value will be selected for playback. Express the end time as an XMLSchema dateTime value of the form: yyyy-mm-ddThh:mm:ss For example, to play back only events with record-time less than or equal to January 20, 2010, at 6:00pm, use the following value: 2010-01-20T18:00:00 For complete details of the XMLSchema dateTime format, see http://www.w3.org/TR/xmlschema-2/#dateTime-lexical-representation. You can specify either -filterEndTime or -filterDuration, but not both.
-filterDuration fduration	Specifies the filter applied to events in the event store. Only events that were recorded during the filter time will be selected for play back. Specify null if you want to select all events for playback. The format is HH:mm:ss, such as 01:00:00. You can specify either -filterEndTime or -filterDuration, but not both.
-speed speed	Specifies the playback speed as a positive float. The default value is 1, which corresponds to normal speed. A value of 2 means that events will be played back 2 times faster than the original record speed. Similarly, a value of 0.5 means that events will be played back 2 times slower than the original record speed.
-repeat repeat	Specifies whether to playback events again after the playback of the specified time interval is over. Valid values are true or false. Default value is false. A value of true means that the repeat of playback continues an infinite number of times until it is deliberately stopped (see STOPPLAYBACK). A value of false means that events will be played back only once.

Example

The examples in this section show how to configure the playback of events of the helloworldAdapter of the helloworld application deployed to the specified Oracle Stream Analytics instance.

The following example specifies a start and end time for playback and that the speed of playback should be twice the normal speed and that once the playback of events for the time interval is over, the playback should start again:

java wlevs.Admin 
     -url service:jmx:msarmi://localhost:9002/jndi/jmxconnector 
     -username wlevs -password wlevs 
     CONFIGUREPLAYBACK -application helloworld -stage helloworldAdapter 
     -scheduleStartTime 10-20-2013:11:22:07 -scheduleEndTime 10-20-2013:18:00:00
      -speed 2 -repeat true

The following example specifies a start and a duration for playback, that the speed of playback is 2 times slower than normal, and that the playback of events should occur only once:

java wlevs.Admin 
     -url service:jmx:msarmi://localhost:9002/jndi/jmxconnector 
     -username wlevs -password wlevs 
     CONFIGUREPLAYBACK -application helloworld -stage helloworldAdapter 
     -scheduleStartTime 10:20:2013:11:22:07 -scheduleEndTime 10-20-2013:18:00:00
     -speed 0.5 -repeat false

The following example specifies a start and a duration of null, which means playback will run forever at normal speed:

java wlevs.Admin 
     -url service:jmx:msarmi://localhost:9002/jndi/jmxconnector 
     -username wlevs -password wlevs 
     CONFIGUREPLAYBACK -application helloworld -stage helloworldAdapter 
     -scheduleStartTime 10:20:2013:11:22:07 -scheduleDuration null

C.13.9 SCHEDULEPLAYBACK

Configures the schedule parameters associated with playing back of events for a stage of an Oracle Stream Analytics application.

Syntax

java wlevs.Admin 
    [ Connection Arguments ]
    [ User Credentials Arguments ]
    [ Common Arguments ] 
    SCHEDULEPLAYBACK -application application -stage stage
        [-scheduleStartTime startime] 
        [-scheduleEndTime endtime | -scheduleDuration duration]

Table C-28 SCHEDULEPLAYBACK Arguments

Argument	Definition
-application application	Specifies the name of the Oracle Stream Analytics application whose event record and playback you want to manage. To get the exact name of your application, you can: Use wlevs.Admin to query for the name (see Query for Application and Processor Names). Use the Oracle Stream Analytics Visualizer: Start the Oracle Stream Analytics Visualizer (see Using Visualizer for Oracle Stream Analytics). In the left pane, navigate to and expand the Applications node of the Oracle Stream Analytics instance to which the application is deployed. Each node under the Applications node is named with the exact application name. Look at the MANIFEST.MF file of the application; the application name is specified by the Bundle-SymbolicName header.
-stage stage	Specifies the name of the particular stage, attached to the Oracle Stream Analytics application specified with the -application argument, whose event record and playback you want to manage.
-scheduleStartTime starttime	Specifies the time when play back should start. Express the start time as an XMLSchema dateTime value of the form: mm-dd-yyyy:hh:mm:ss For example, to specify that recording should start on October 20, 2013, at 11:22:07 am, use the following value: 10-20-2013:11:22:07 For complete details of the XMLSchema dateTime format, see http://www.w3.org/TR/xmlschema-2/#dateTime-lexical-representation. For complete details of the XMLSchema dateTime format, see http://www.w3.org/TR/xmlschema-2/#dateTime-lexical-representation.
-scheduleEndTime endtime	Specifies the actual time when the play back should end. Express the start time as an XMLSchema dateTime value of the form: mm-dd-yyyy:hh:mm:ss For example, to specify that recording should end on October 20, 2013, at 6:00 pm, use the following value: 10-20-2013:18:00:00 Specify null if you want the recording to run forever. You can specify either -scheduleEndTime or -scheduleDuration, but not both.
-scheduleDuration duration	Specifies the duration of time after which event playback for this stage ends. Specify null if you want the recording to run forever. The format is HH:mm:ss, such as 01:00:00. You can specify either -scheduleEndTime or -scheduleDuration, but not both.

Example

The examples in this section show how to configure the schedule of playback of events of the helloworldAdapter of the helloworld application deployed to the specified Oracle Stream Analytics instance.

The following example specifies a start and end time for event playback:

java wlevs.Admin 
     -url service:jmx:msarmi://localhost:9002/jndi/jmxconnector 
     -username wlevs -password wlevs 
     SCHEDULEPLAYBACK -application helloworld -stage helloworldAdapter 
     -scheduleStartTime 10-20-2013:11:22:07 -scheduleEndndTime 10-20-2013:18:00:00

C.13.10 LISTPLAYBACK

Lists the event playback configuration for any particular stage of an Oracle Stream Analytics application.

Syntax

java wlevs.Admin 
    [ Connection Arguments ]
    [ User Credentials Arguments ]
    [ Common Arguments ] 
    LISTPLAYBACK -application application -stage stage

Table C-29 LISTPLAYBACK Arguments

Argument	Definition
-application application	Specifies the name of the Oracle Stream Analytics application whose event record and playback you want to manage. To get the exact name of your application, you can: Use wlevs.Admin to query for the name (see Query for Application and Processor Names). Use the Oracle Stream Analytics Visualizer: Start the Oracle Stream Analytics Visualizer (see Oracle Stream Analytics Using Visualizer for Oracle Stream Analytics). In the left pane, navigate to and expand the Applications node of the Oracle Stream Analytics instance to which the application is deployed. Each node under the Applications node is named with the exact application name. Look at the MANIFEST.MF file of the application; the application name is specified by the Bundle-SymbolicName header.
-stage stage	Specifies the name of the particular stage, attached to the Oracle Stream Analytics application specified with the -application argument, whose event record and playback you want to manage.

Example

The following example shows how to list the event playback configuration on the helloworldAdapter stage of the helloworld application deployed to the specified Oracle Stream Analytics instance:

java wlevs.Admin 
     -url service:jmx:msarmi://localhost:9002/jndi/jmxconnector 
     -username wlevs -password wlevs 
     LISTPLAYBACK -application helloworld -stage helloworldAdapter 

C.14 Commands for Monitoring Throughput and Latency

This section explains the commands for monitoring throughput and latency.

Table C-30 is an overview of commands for monitoring throughput and latency in an Oracle Stream Analytics application. Subsequent sections describe command syntax and arguments, and provide an example for each command.

Table C-30 Overview of Commands for Monitoring Throughput and Latency

Command	Description
MONITORAVGLATENCY	Monitors the average amount of time it takes an event to pass through specified path of the EPN, or latency.
MONITORMAXLATENCY	Monitors the maximum amount of time it takes an event to pass through specified path of the EPN, or latency.
MONITORAVGLATENCYTHRESHOLD	Monitors whether the average latency of events flowing through a path of the EPN crosses a specified threshold.
MONITORAVGTHROUGHPUT	Monitors the number of events flowing through the entry or exit points of a specified stage.

C.14.1 MONITORAVGLATENCY

Monitors the average amount of time, or latency, it takes an event to pass through a specified path of the EPN of the specified application.

You specify the start and end stages of the path, and whether it should start or end at the entry or exit points of each respective stage. If you specify the same stage for the start and end of the path, you can monitor the latency of events flowing through a single stage.

Syntax

java wlevs.Admin 
     [ Connection Arguments ]
     [ User Credentials Arguments ]
     [ Common Arguments ]
     MONITORAVGLATENCY -application application 
     -startStage startStage -startStagePoint stagePoint
     -endStage endStage -endStagePoint stagePoint
     -avgInterval avgInterval -timeUnit timeUnit

Table C-31 MONITORAVGLATENCY Arguments

Argument	Definition
-application application	Specifies the name of the Oracle Stream Analytics application whose throughput and latency you want to monitor. To get the exact name of your application, you can: Use wlevs.Admin to query for the name (see Query for Application and Processor Names). Use the Oracle Stream Analytics Visualizer: Start the Oracle Stream Analytics Visualizer (see Using Visualizer for Oracle Stream Analytics). In the left pane, navigate to and expand the Applications node of the Oracle Stream Analytics instance to which the application is deployed. Each node under the Applications node is named with the exact application name. Look at the MANIFEST.MF file of the application; the application name is specified by the Bundle-SymbolicName header.
-startStage startStage	Specifies the name of the stage that starts the path for which you want to monitor latency. The stage is in the application specified by the -application option.
-startStagePoint startStagePoint	Specifies the specific starting point for monitoring latency of the specified start stage. You can start monitoring from the entry or exit point of the start stage. Valid values are entry and exit. Default value is entry.
-endStage endStage	Specifies the name of the stage that ends the path for which you want to monitor latency. The stage is in the application specified by the -application option.
-endStagePoint endStagePoint	Specifies the specific ending point for monitoring latency of the specified end stage. You can end monitoring from the entry or exit point of the end stage. Valid values are entry and exit. Default value is entry.
-avgInterval avgInterval	Specifies the average interval across which average latency is calculated. Specify the units with the -timeUnit option; default is milliseconds. Default value is 100.

Example

The following example shows how to monitor the average latency of events flowing through the cqlprocessor component, from entry point to exit point, of the helloworld application. Note that because the same stage is specified for both the start and end stages (cqlprocessor), the latency monitoring is happening for just the events flowing through a single stage:

java wlevs.Admin 
     -url service:jmx:msarmi://localhost:9002/jndi/jmxconnector 
     -username wlevs -password wlevs 
     MONITORAVGLATENCY -application helloworld -startStage cqlprocessor
     -startStagePoint entry -endStage cqlprocessor -endStagePoint exit 
     -avgInterval 100 -timeUnit MILLISECONDS

C.14.2 MONITORAVGLATENCYTHRESHOLD

Specifies whether the average latency of events between the start- and end-points of a path crosses a specified threshold.

You specify the start and end stages of the path, and whether it should start or end at the entry or exit points of each respective stage. If you specify the same stage for the start and end of the path, you can monitor the latency threshold of events flowing through a single stage.

Syntax

java wlevs.Admin 
    [ Connection Arguments ]
    [ User Credentials Arguments ]
    [ Common Arguments ] 
    MONITORAVGLATENCYTHRESHOLD -application application 
    -startStage startStage -startStagePoint stagePoint 
    -endStage endStage -endStagePoint stagePoint 
    -avgInterval avgInterval -timeUnit timeUnit -threshold threshold

Table C-32 MONITORAVGLATENCYTHRESHOLD Arguments

Argument	Definition
-application application	Specifies the name of the Oracle Stream Analytics application whose throughput and latency you want to monitor. To get the exact name of your application, you can: Use wlevs.Admin to query for the name (see Query for Application and Processor Names). Use the Oracle Stream Analytics Visualizer: Start the Oracle Stream Analytics Visualizer (see Using Visualizer for Oracle Stream Analytics). In the left pane, navigate to and expand the Applications node of the Oracle Stream Analytics instance to which the application is deployed. Each node under the Applications node is named with the exact application name. Look at the MANIFEST.MF file of the application; the application name is specified by the Bundle-SymbolicName header.
-startStage startStage	Specifies the name of the stage that starts the path for which you want to monitor the latency threshold. The stage is in the application specified by the -application option.
-startStagePoint startStagePoint	Specifies the specific starting point for monitoring the latency threshold of the specified start stage. You can start monitoring from the entry or exit point of the start stage. Valid values are entry and exit. Default value is entry.
-endStage endStage	Specifies the name of the stage that ends the path for which you want to monitor the latency threshold. The stage is in the application specified by the -application option.
-endStagePoint endStagePoint	Specifies the specific ending point for monitoring the latency threshold of the specified end stage. You can end monitoring from the entry or exit point of the end stage. Valid values are entry and exit. Default value is entry.
-avgInterval avgInterval	Specifies the average interval across which average the latency threshold is calculated. Default value is 100. Specify the units with the -timeUnit option; default is milliseconds.
-threshold threshold	Specifies the threshold value above which the metric event will be outputted at the end of every average interval. Default is 100. Specify the units with the -timeUnit option; default is milliseconds.

Example

The following example shows how to monitor the average latency threshold of events above 10 seconds average latency on the cqlprocessor stage, from entry point to exit point, of the helloworld application.

java wlevs.Admin 
     -url service:jmx:msarmi://localhost:9002/jndi/jmxconnector 
     -username wlevs -password wlevs 
     MONITORAVGLATENCY -application helloworld -startStage cqlprocessor
     -startStagePoint entry -endStage cqlprocessor -endStagePoint exit 
     -avgInterval 100 -timeUnit MILLISECONDS -threshold 100

C.14.3 MONITORMAXLATENCY

Monitors the maximum latency of events flowing through a specified path of the EPN of the specified application.

You specify the start and end stages of the path, and whether it should start or end at the entry or exit points of each respective stage. If you specify the same stage for the start and end of the path, you can monitor the maximum latency of events flowing through a single stage.

Syntax

java wlevs.Admin 
    [ Connection Arguments ]
    [ User Credentials Arguments ]
    [ Common Arguments ] 
    MONITORMAXLATENCY -application application 
    -startStage startStage -startStagePoint stagePoint 
    -endStage endStage -endStagePoint stagePoint 
    -maxInterval maxInterval -timeUnit timeUnit

Table C-33 MONITORMAXLATENCY Arguments

Argument	Definition
-application application	Specifies the name of the Oracle Stream Analytics application whose throughput and latency you want to monitor. To get the exact name of your application, you can: Use wlevs.Admin to query for the name (see Query for Application and Processor Names). Use the Oracle Stream Analytics Visualizer: Start the Oracle Stream Analytics Visualizer (see Using Visualizer for Oracle Stream Analytics). In the left pane, navigate to and expand the Applications node of the Oracle Stream Analytics instance to which the application is deployed. Each node under the Applications node is named with the exact application name. Look at the MANIFEST.MF file of the application; the application name is specified by the Bundle-SymbolicName header.
-startStage startStage	Specifies the name of the stage that starts the path for which you want to monitor the maximum latency. The stage is in the application specified by the -application option.
-startStagePoint startStagePoint	Specifies the specific starting point for monitoring the maximum latency of the specified start stage. You can start monitoring from the entry or exit point of the start stage. Valid values are entry and exit. Default value is entry.
-endStage endStage	Specifies the name of the stage that ends the path for which you want to monitor the maximum latency. The stage is in the application specified by the -application option.
-endStagePoint endStagePoint	Specifies the specific ending point for monitoring the maximum latency of the specified end stage. You can end monitoring from the entry or exit point of the end stage. Valid values are entry and exit. Default value is entry.
-maxInterval maxInterval	Specifies the interval across which maximum latency is calculate. Default value is 100. Specify the units with the -timeUnit option; default is milliseconds.

Example

The following example shows how to monitor the maximum latency of events flowing through the cqlprocessor stage, from entry point to exit point, of the helloworld application:

java wlevs.Admin 
     -url service:jmx:msarmi://localhost:9002/jndi/jmxconnector 
     -username wlevs -password wlevs 
     MONITORMAXLATENCY -application helloworld -startStage cqlprocessor
     -startStagePoint entry -endStage cqlprocessor -endStagePoint exit 
     -maxInterval 100 -timeUnit MILLISECONDS

C.14.4 MONITORAVGTHROUGHPUT

Monitors the average number of events flowing through the entry or exit point of a stage of the EPN of the specified application.

Syntax

java wlevs.Admin 
    [ Connection Arguments ]
    [ User Credentials Arguments ]
    [ Common Arguments ] 
    MONITORAVGTHROUGHPUT -application application 
    -stage stage -StagePoint stagePoint 
    -throughputInterval throughputInterval -avgInterval avgInterval
    -timeUnit timeUnit

Table C-34 MONITORAVGLATENCY Arguments

Argument	Definition
-application application	Specifies the name of the Oracle Stream Analytics application whose throughput and latency you want to monitor. To get the exact name of your application, you can: Use wlevs.Admin to query for the name (see Query for Application and Processor Names). Use the Oracle Stream Analytics Visualizer: Start the Oracle Stream Analytics Visualizer (see Using Visualizer for Oracle Stream Analytics). In the left pane, navigate to and expand the Applications node of the Oracle Stream Analytics instance to which the application is deployed. Each node under the Applications node is named with the exact application name. Look at the MANIFEST.MF file of the application; the application name is specified by the Bundle-SymbolicName header.
-stage stage	Specifies the name of the stage for which you want to monitor throughput of events. The stage is in the application specified by the -application option.
-stagePoint stagePoint	Specifies whether you want to monitor throughput at the entry- or exit- point of the specified stage. Valid values are entry and exit. Default value is entry.
-throughputInterval throughputInterval	Specifies the throughput interval across which throughput is calculated. Default value is 100. Specify the units with the -timeUnit option; default is milliseconds.
-avgInterval avgInterval	Specifies the average interval across which average throughput is calculated. Default value is 100. Specify the units with the -timeUnit option; default is milliseconds.

Example

The following example shows how to monitor the number of events flowing through the entry point of the cqlprocessor stage of the helloworld application:

java wlevs.Admin 
     -url service:jmx:msarmi://localhost:9002/jndi/jmxconnector 
     -username wlevs -password wlevs 
     MONITORMAXLATENCY -application helloworld 
     -stage cqlprocessor -stagePoint entry 
     -throughputInterval 100 -avgInterval 100 -timeUnit MILLISECONDS

C.15 Commands for Managing Configuration History

This section explains the commands for managing configuration history.

Table C-35 is an overview of commands that manage the configuration history of Oracle Stream Analytics components. For more information, see Manage Configuration History.

Subsequent sections describe command syntax and arguments, and provide an example for each command.

Table C-35 Overview of Commands for Managing Configuration History

Command	Description
CONFIGHISTORY	Returns the list of configuration history management commands.
DELETECONFIGCHANGEHISTORY	Removes change records for a specified time period.
LISTCHANGERECORDS	Returns a list of the change records of an application.
LISTRESOURCEREVISIONS	Returns a list of the configuration resource revisions of an application.
UNDOCONFIGCHANGE	Rolls back a change record specified by change record ID.

C.15.1 CONFIGHISTORY

Returns the list of configuration history management commands.

Syntax

java wlevs.Admin 
    [ Connection Arguments ]
    [ User Credentials Arguments ]
    [ Common Arguments ] 
    LISTCHANGERECORDS
    LISTRESOURCEREVISIONS     UNDOCONFIGCHANGE
    DELETECONFIGCHANGEHISTORY

Example

The following example shows how to list the configuration history management commands:

java wlevs.Admin 
     -url service:jmx:msarmi://localhost:9002/jndi/jmxconnector 
     -username wlevs -password wlevs 
     LISTCHANGERECORDS

C.15.2 DELETECONFIGCHANGEHISTORY

Returns the list of configuration history management commands.

Syntax

java wlevs.Admin 
    [ Connection Arguments ]
    [ User Credentials Arguments ]
    [ Common Arguments ]
    DELETECONFIGCHANGEHISTORY -application application -startTime starttime -endTime endtime

Table C-36 DELETECONFIGCHANGEHISTORY Arguments

Argument	Definition
-application application	Specifies the name of the Oracle Stream Analytics application whose Oracle CQL rules you want to manage. To get the exact name of your application, you can: Use wlevs.Admin to query for the name (see Query for Application and Processor Names). Use the Oracle Stream Analytics Visualizer: Start the Oracle Stream Analytics Visualizer (see Oracle Stream Analytics Using Visualizer for Oracle Stream Analytics). In the left pane, navigate to and expand the Applications node of the Oracle Stream Analytics instance to which the application is deployed. Each node under the Applications node is named with the exact application name. Look at the MANIFEST.MF file of the application; the application name is specified by the Bundle-SymbolicName header.
-startTime starttime	Specifies the beginning of the time period to delete change records. The format is MM-dd-yyyy:HH:mm:ss, such as 10-20-2007:11:22:07.
-endTime end-ime	Specifies the end of the time period to delete change records. The format is MM-dd-yyyy:HH:mm:ss, such as 10-20-2007:11:22:07.

Example

The following example shows how to list the configuration history management commands:

java wlevs.Admin 
     -url service:jmx:msarmi://localhost:9002/jndi/jmxconnector 
     -username wlevs -password wlevs 
     CONFIGHISTORY

C.15.3 LISTCHANGERECORDS

Returns a list of the change records of an application.

Syntax

java wlevs.Admin 
    [ Connection Arguments ]
    [ User Credentials Arguments ]
    [ Common Arguments ] 
    LISTCHANGERECORDS -application application -startTime starttime -endTime endtime

Table C-37 GETRULE Arguments

Argument	Definition
-application application	Specifies the name of the Oracle Stream Analytics application whose change records you want to browse. To get the exact name of your application, you can: Use wlevs.Admin to query for the name (see Query for Application and Processor Names). Use the Oracle Stream Analytics Visualizer: Start the Oracle Stream Analytics Visualizer (see Oracle Stream Analytics Using Visualizer for Oracle Stream Analytics). In the left pane, navigate to and expand the Applications node of the Oracle Stream Analytics instance to which the application is deployed. Each node under the Applications node is named with the exact application name. Look at the MANIFEST.MF file of the application; the application name is specified by the Bundle-SymbolicName header.
-startTime starttime	Specifies the beginning of the time period to filter the display of change records. The format is MM-dd-yyyy:HH:mm:ss, such as 10-20-2007:11:22:07.
-endTime end-ime	Specifies the end of the time period to filter the display of change records. The format is MM-dd-yyyy:HH:mm:ss, such as 10-20-2007:11:22:07.

Example

The following example shows how to list all the change records created between 11:10:07 and 11:22:07 on 20 November 2007 for the application helloworld:

java wlevs.Admin 
     -url service:jmx:msarmi://localhost:9002/jndi/jmxconnector 
     -username wlevs -password wlevs 
     LISTCHANGERECORDS -application helloworld -startTime 10-20-2007:11:10:07 
     -endTime 10-20-2007:11:22:07

C.15.4 LISTRESOURCEREVISIONS

Returns a list of the configuration resource revisions of an application.

Syntax

java wlevs.Admin 
    [ Connection Arguments ]
    [ User Credentials Arguments ]
    [ Common Arguments ] 
    LISTRESOURCEREVISIONS -application application -startTime starttime -endTime endtime

Table C-38 GETRULE Arguments

Argument	Definition
-application application	Specifies the name of the Oracle Stream Analytics application whose resource revisions you want to browse. To get the exact name of your application, you can: Use wlevs.Admin to query for the name (see Query for Application and Processor Names). Use the Oracle Stream Analytics Visualizer: Start the Oracle Stream Analytics Visualizer (see Oracle Stream Analytics Using Visualizer for Oracle Stream Analytics). In the left pane, navigate to and expand the Applications node of the Oracle Stream Analytics instance to which the application is deployed. Each node under the Applications node is named with the exact application name. Look at the MANIFEST.MF file of the application; the application name is specified by the Bundle-SymbolicName header.
-startTime starttime	Specifies the beginning of the time period to filter the list of resource revisions. The format is MM-dd-yyyy:HH:mm:ss, such as 10-20-2007:11:22:07.
-endTime end-ime	Specifies the end of the time period to filter the list of resource revisions. The format is MM-dd-yyyy:HH:mm:ss, such as 10-20-2007:11:22:07.

Example

The following example shows how to list all the resource revisions created between 11:10:07 and 11:22:07 on 20 November 2007 for the application helloworld:

java wlevs.Admin 
     -url service:jmx:msarmi://localhost:9002/jndi/jmxconnector 
     -username wlevs -password wlevs 
      LISTRESOURCEREVISIONS -application helloworld -startTime 10-20-2007:11:10:07 
     -endTime 10-20-2007:11:22:07

C.15.5 UNDOCONFIGCHANGE

Rolls back the changes defined by the change record specified by change record ID.

Syntax

java wlevs.Admin 
    [ Connection Arguments ]
    [ User Credentials Arguments ]
    [ Common Arguments ] 
    UNDOCONFIGCHANGE -application application -recordId changerecordid

Table C-39 GETRULE Arguments

Argument	Definition
-application application	Specifies the name of the Oracle Stream Analytics application whose change records you want to undo. To get the exact name of your application, you can: Use wlevs.Admin to query for the name (see Query for Application and Processor Names). Use the Oracle Stream Analytics Visualizer: Start the Oracle Stream Analytics Visualizer (see Using Visualizer for Oracle Stream Analytics). In the left pane, navigate to and expand the Applications node of the Oracle Stream Analytics instance to which the application is deployed. Each node under the Applications node is named with the exact application name. Look at the MANIFEST.MF file of the application; the application name is specified by the Bundle-SymbolicName header.
-recordId changerecordid	Specifies the identifier of the change record to undo. To get the change record identifier, you can use: LISTCHANGERECORDS LISTRESOURCEREVISIONS.

Example

The following example shows how to roll back all the resource revisions created between 11:10:07 and 11:22:07 on 20 November 2007 for the application helloworld:

java wlevs.Admin 
     -url service:jmx:msarmi://localhost:9002/jndi/jmxconnector 
     -username wlevs -password wlevs 
     UNDOCONFIGCHANGE -application helloworld -recordId tr.1267607521409.10110