5 Event Record and Playback Schema

This chapter provides a reference to the elements of the wlevs_eventstore_config.xsd schema. This schema is behind the XML files you use to configure Oracle Stream Analytics event record and play back.

This chapter includes the following sections:

5.1 batch-size

Use this element to define the number of updates that are picked up from the store buffer to write back to the backing store. This element can be changed dynamically. The batch-size element has no child elements and no attributes.

The following example shows how to use the batch-size element in the component configuration file:

<record-parameters>
    <dataset-name>tuple1</dataset-name>
    <event-type-list>
        <event-type>TupleEvent1</event-type>
    </event-type-list>
    <provider-name>test-rdbms-provider</provider-name>
    <store-policy-parameters>
        <parameter>
            <name>timeout</name>
            <value>300</value>
        <parameter>
    </store-policy-parameters>
    <batch-size>1</batch-size>
    <batch-time-out>10</batch-time-out>
</record-parameters>

5.2 batch-time-out

Use this element to define The number of seconds event buffer will wait to accumulate batch-size number of events before to write to the event store. This element has no child elements and no attributes.

<record-parameters>
    <dataset-name>tuple1</dataset-name>
    <event-type-list>
        <event-type>TupleEvent1</event-type>
    </event-type-list>
    <provider-name>test-rdbms-provider</provider-name>
    <store-policy-parameters>
        <parameter>
            <name>timeout</name>
            <value>300</value>
        <parameter>
    </store-policy-parameters>
    <batch-size>1</batch-size>
    <batch-time-out>10</batch-time-out>
</record-parameters>

The following example shows how to use the batch-time-out element in the component configuration file:

5.3 dataset-name

Use the dataset-name element to define the group of data that the user wants to group together. In the case of the Oracle RDBMS-based provider, it specifies the database area, or schema, in which the tables that store the recorded events are created. When configuring the Oracle RDBMS-based provider, you are required to specify this element.

This element has no child elements and no attributes.

The following example shows how to use the dataset-name element in the component configuration file:

<record-parameters>
    <dataset-name>tuple1</dataset-name>
        <event-type-list>
            <event-type>TupleEvent1</event-type>
        </event-type-list>
        <provider-name>test-rdbms-provider</provider-name>
    <batch-size>1</batch-size>
    <batch-time-out>10</batch-time-out>
</record-parameters>

5.4 event-type-list

Use the event-type-list element to define one or more events for record or playback for a component. This element has the event-type child element and no attributes.

The following example shows how to use the event-type-list element in the component configuration file:

<record-parameters>
    <dataset-name>tuple1</dataset-name>
        <event-type-list>
            <event-type>TupleEvent1</event-type>
        </event-type-list>
        <provider-name>test-rdbms-provider</provider-name>
    <batch-size>1</batch-size>
    <batch-time-out>10</batch-time-out>
</record-parameters>

5.5 playback-speed

Use the playback-speed element to define 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 at half the speed.

This element has no child elements an no attributes.

The following example shows how to use the duration element in the component configuration file:

<playback-parameters>
    <dataset-name>tuple1</dataset-name>
    <event-type-list>
        <event-type>TupleEvent1</event-type>
    </event-type-list>
    <provider-name>test-rdbms-provider</provider-name>
    <store-policy-parameters>
        <parameter>
            <name>timeout</name>
            <value>300</value>
        <parameter>
    </store-policy-parameters>
    <time-range-offset>
        <start>2010-01-20T05:00:00</start>
        <duration>03:00:00</duration>
    </time-range-offset>
    <playback-speed>100</playback-speed>
</playback-parameters>

5.6 provider-name

Use the provider-name element in the following parent elements:

  • netio: Use the provider-name element to define which provider to use for the underlying socket implementation. Valid value is an Oracle Stream Analytics server file netio child element provider-type.

  • record-parameters: Use the provider-name element to define the name of the event store provider. The value of this element corresponds to the value of the name child element of the rdbms-event-store-provider element in the file of the Oracle Stream Analytics server instance.

    When configuring the Oracle RDBMS-based provider, you are required to specify this element. When the provider-name element is blank, the default Berkeley database provider is used.

This element has no child elements and no attributes.

The following example shows how to use the provider-name element in the component configuration file:

<netio>
        <provider-name>providerCache</provider-name>
        <num-threads>1000</num-threads>
</netio>

5.7 recording-session-name

Use the recording-session-name element to specify a name for the recording session so that you can access the session programmatically. This element has no child elements and no attributes.

The following example shows how to use this element in a configuration file.

 <record-parameters>
    <dataset-name>tuple1</dataset-name>
    <recording-session-name>sessionname</recording-session-name>
    <event-type-list>
        <event-type>TupleEvent1</event-type>
    </event-type-list>
    <provider-name>test-rdbms-provider</provider-name>
    <store-policy-parameters>
        <parameter>
            <name>timeout</name>
            <value>300</value>
        </parameter>
    </store-policy-parameters>
    <schedule-time-range>
        <start>2010-01-20T05:00:00</start>
        <end>2010-01-20T18:00:00</end>
    </schedule-time-range>
    <batch-size>1</batch-size>
    <batch-time-out>10</batch-time-out>
</record-parameters>

5.8 schedule-time-range

Use the schedule-time-range element to define the time during which events will be played back to the stage. Playing back starts at the specified start time and continues until all of the events are played back or until the specified end time. When repeat is set to true, playback continues until the specified end time or until playback is explicitly stopped by the user. This element applies only to the playback-parameters element.

This element has the following child elements and no attributes.

The following example shows how to use the schedule-time-range element in the component configuration file:

<record-parameters>
    <dataset-name>tuple1</dataset-name>
    <event-type-list>
        <event-type>TupleEvent1</event-type>
    </event-type-list>
    <provider-name>test-rdbms-provider</provider-name>
    <store-policy-parameters>
        <parameter>
            <name>timeout</name>
            <value>300</value>
        </parameter>
    </store-policy-parameters>
    <schedule-time-range>
        <start>2010-01-20T05:00:00</start>
        <end>2010-01-20T18:00:00</end>
    </schedule-time-range>
    <batch-size>1</batch-size>
    <batch-time-out>10</batch-time-out>
</record-parameters>

5.9 schedule-time-range-offset

Use this element to define the time during which events will be played back to the stage. Playing back will start at the specified start time and will continue until all the events are played back or specified end time. If repeat is set to true, playback will continue until the specified end time or until playback is explicitly stopped by the user. This element applies only to the playback-parameters element.

This element has the following child elements and no attributes.

The following example shows how to use the schedule-time-range-offset element in the component configuration file:

<record-parameters>
    <dataset-name>tuple1</dataset-name>
    <event-type-list>
        <event-type>TupleEvent1</event-type>
    </event-type-list>
    <provider-name>test-rdbms-provider</provider-name>
    <store-policy-parameters>
        <parameter>
            <name>timeout</name>
            <value>300</value>
        <parameter>
    </store-policy-parameters>
    <schedule-time-range-offset>
        <start>2010-01-20T05:00:00</start>
        <duration>03:00:00</duration>
    </schedule-time-range-offset>
    <batch-size>1</batch-size>
    <batch-time-out>10</batch-time-out>
</record-parameters>

5.10 store-policy-parameters

Use the store-policy-parameters element to define one or more store policy parameters that are specific to the event store provider. This element has the parameter element and no attributes.

The following example shows how to use the store-policy-parameter element in the component configuration file:

<record-parameters>
    <dataset-name>tuple1</dataset-name>
        <event-type-list>
            <event-type>TupleEvent1</event-type>
        </event-type-list>
        <provider-name>test-rdbms-provider</provider-name>
       <store-policy-parameters>
           <parameter>
               <name>timeout</name>
               <value>300</value>
           <parameter>
       </store-policy-parameters>
    <batch-size>1</batch-size>
    <batch-time-out>10</batch-time-out>
</record-parameters>

5.11 time-range

Use the time-range element to define a filter that the Oracle Stream Analytics server applies to the events in the event store. Only events with a record-time in this time range are played back to the stage.

Note:

Use either time-range-offset or time-range, but not both.

This element has the following child elements and no attributes.

The following example shows how to use the time-range element in the component configuration file:

<record-parameters>
    <dataset-name>tuple1</dataset-name>
    <event-type-list>
        <event-type>TupleEvent1</event-type>
    </event-type-list>
    <provider-name>test-rdbms-provider</provider-name>
    <store-policy-parameters>
        <parameter>
            <name>timeout</name>
            <value>300</value>
        <parameter>
    </store-policy-parameters>
    <time-range>
        <start>2010-01-20T05:00:00</start>
        <end>2010-01-20T18:00:00</end>
    </time-range>
    <batch-size>1</batch-size>
    <batch-time-out>10</batch-time-out>
</record-parameters>

5.12 time-range-offset

Use the time-range-offset element to define a filter that the Oracle Stream Analytics server applies to the events in the event store. Only events with a record-time in this time range are played back to the stage.

Note:

Use either time-range or time-range-offset, but not both.

This element has the following child elements and no attributes.

The following example shows how to use the time-range-offset element in the component configuration file:

<record-parameters>
    <dataset-name>tuple1</dataset-name>
    <event-type-list>
        <event-type>TupleEvent1</event-type>
    </event-type-list>
    <provider-name>test-rdbms-provider</provider-name>
    <store-policy-parameters>
        <parameter>
            <name>timeout</name>
            <value>300</value>
        <parameter>
    </store-policy-parameters>
    <time-range-offset>
        <start>2010-01-20T05:00:00</start>
        <duration>03:00:00</duration>
    </time-range-offset>
    <batch-size>1</batch-size>
    <batch-time-out>10</batch-time-out>
</record-parameters>