| ### Showing:
Annotations
Attributes
Diagrams
Facets
Identity Constraints
Instances
Model
Properties
Used by

Main schema LiveViewConfig.xsd

Properties |
attribute form default | unqualified
element form default | qualified
version | 2.0

Element liveview-configuration

Annotations |
    Top level element for all LiveView configuration types
Diagram |
Properties |
content | complex
Model | data-table | external-server-connection | alert-table | application | expr-macro | table-space | publisher | jdbc-table
Children | alert-table, application, data-table, expr-macro, external-server-connection, jdbc-table, publisher, table-space
Instance |
    <liveview-configuration>
      <data-table description="" group="" id="" publish-interval-millis="" short-description="" snapshot-concurrency="0" snapshot-parallelism="" table-space-ref="">{1,1}</data-table>
      <external-server-connection id="" table-provider-class="" type="">{1,1}</external-server-connection>
      <alert-table description="" group="" id="" publish-interval-millis="" short-description="" snapshot-concurrency="0" snapshot-parallelism="" table-space-ref="">{1,1}</alert-table>
      <application filename="" id="" module="">{1,1}</application>
      <expr-macro id="">{1,1}</expr-macro>
      <table-space id="" snapshot-concurrency="0" snapshot-parallelism="1" table-group="">{1,1}</table-space>
      <publisher description="" filename="" id="" module="" short-description="">{1,1}</publisher>
      <jdbc-table description="" group="" id="" short-description="">{1,1}</jdbc-table>
    </liveview-configuration>

Element liveview-configuration / data-table

Annotations |
    Specify a data-table for storing base level and aggregated data in LiveView.
Diagram |
Type | extension of table-type
Type hierarchy | table-type
Properties |
content | complex
Model | fields{0,1} , import-schema{0,1} , row-delete-rule{0,1} , table-delete-rule* , (primary-key{0,1} | custom-id-generation{0,1}) , indices{0,1} , variables{0,1} , field-rules{0,1} , (preprocessor-chain{0,1} | data-sources{0,1}) , filtered-table-aliases{0,1}
Children | custom-id-generation, data-sources, field-rules, fields, filtered-table-aliases, import-schema, indices, preprocessor-chain, primary-key, row-delete-rule, table-delete-rule, variables
Instance |
    <data-table description="" group="" id="" publish-interval-millis="" short-description="" snapshot-concurrency="0" snapshot-parallelism="" table-space-ref="">
      <fields>{0,1}</fields>
      <import-schema from="" schema="">{0,1}</import-schema>
      <row-delete-rule>{0,1}</row-delete-rule>
      <table-delete-rule>{0,unbounded}</table-delete-rule>
      <primary-key>{0,1}</primary-key>
      <custom-id-generation builder="" module="" template="">{0,1}</custom-id-generation>
      <indices>{0,1}</indices>
      <variables>{0,1}</variables>
      <field-rules>{0,1}</field-rules>
      <preprocessor-chain>{0,1}</preprocessor-chain>
      <data-sources>{0,1}</data-sources>
      <filtered-table-aliases>{0,1}</filtered-table-aliases>
    </data-table>
Attributes |
QName | Type | Default | Use | Annotation
--- | --- | --- | --- | ---
description | xs:string |  | optional |
    Long description.
group | name-type |  | optional |
    Optional logical grouping for a table.
id | name-type |  | required |
    Identifier for this table, , which must be the same as the basename of the file that defines this table.
publish-interval-millis | xs:positiveInteger |  | optional |
    This setting applies to all table types, and is used to specify in milliseconds the amount
    of delay before publishing data from the table; this condition is known as conflation of data.
    Set this attribute to a positive, non-zero integer ≥ 5 to specify conflation for this table.
    A value below 5, including zero and all negative numbers, is forced equal to 5.
    Static aggregation tables have an internal setting that is the equivalent of setting
    publish-interval-millis=1000 (1 second). For such tables, you cannot disable conflation,
    but you can change the conflation interval by setting publish-interval-millis to a different
    integer value. For all other table types, specify a value for publish-interval-millis to both
    enable conflation and to specify the conflation interval. To disable conflation for
    non-aggregation tables, remove the publish-interval-millis attribute entirely from your
    table’s lvconf entry.
    Without conflation, data is published from a table as soon as it is received. With conflation
    enabled, all downstream components see conflated data, including alerts, LiveView Desktop,
    clients built with the Java or .NET APIs, or another table in a transformation sequence.
    If an alert is set for a conflated table, be aware that it is possible for conditions that
    would otherwise trigger an alert to occur briefly during a conflation period; in this case,
    the trigger conditions are conflated away and the alert does not trigger.
    See the Data Conflation topic in the LiveView Reference Guide for further information.
short-description | xs:string |  | optional |
    Short description.
snapshot-concurrency | xs:nonNegativeInteger | 0 | optional |
    Defines the maximum number of snapshot queries (one per thread) within a partition that are executed at once. This attribute overrides the same attribute defined in the table's tablespace.
snapshot-parallelism | xs:int |  | optional |
    Defines the number of table partitions, and the number parallel regions used to scan a table during the snapshot portion of a query. This attribute overrides the same attribute defined in the table's tablespace.
table-space-ref | xs:string |  | optional |
    A reference to a defined table-space.

Element table-type / fields

Annotations |
    Table field definitions.
Diagram |
Type | fields
Properties |
content | complex
minOccurs | 0
Model | field+
Children | field
Instance |
    <fields>
      <field description="" ignore-case="false" name="" short-name="" type="">{1,unbounded}</field>
    </fields>

Element fields / field

Annotations |
    Field in the table.
Diagram |
Type | field-type
Type hierarchy | typed-field-type base-field-type field-type
Properties |
content | complex
maxOccurs | unbounded
Model | insert-rule{0,1} , update-rule{0,1}
Children | insert-rule, update-rule
Instance |
    <field description="" ignore-case="false" name="" short-name="" type="">
      <insert-rule>{0,1}</insert-rule>
      <update-rule use-insert-rule="false">{0,1}</update-rule>
    </field>
Attributes |
QName | Type | Default | Use | Annotation
--- | --- | --- | --- | ---
description | xs:string |  | optional |
    Longer description of the field.
ignore-case | xs:boolean | false | optional |
    For string fields. If set to true, then searches on this field are case insensitive by default.
name | name-type |  | required |
    Unique field name within the table.
short-name | xs:string |  | optional |
    Short description of the field.
type | data-type-type |  | required |
    Field data type.

Element field-type / insert-rule

Annotations |
    Expression (or reference to expr-macro) to be applied to new incoming rows. You cannot use insert-rule in a field that is designated as a primary key.
Diagram |
Type | extension of xs:string
Properties |
content | complex
minOccurs | 0

Element field-type / update-rule

Annotations |
    Expression (or reference to expr-macro) to be applied on incoming row updates. You cannot use update-rule in a field that is designated as a primary key.
Diagram |
Type | extension of xs:string
Properties |
content | complex
minOccurs | 0
Attributes |
QName | Type | Default | Use | Annotation
--- | --- | --- | --- | ---
use-insert-rule | xs:boolean | false | optional |
    Use the same rule specified in the insert-rule.

Element table-type / import-schema

Diagram |
Type | import-schema
Properties |
content | complex
minOccurs | 0
Attributes |
QName | Type | Use | Annotation
--- | --- | --- | ---
from |  | required |
    Path to the sbapp or sbint file from which to import the schema. The path is relative to the project root (where the top-level lvconf must reside). If you specify a simple file name, LiveView searches for the file on the current project's module search path.
schema |  | required |
    The name of the schema within the specified sbapp or sbint file.

Element table-type / row-delete-rule

Annotations |
    An optional rule specifying a predicate that is evaluated against the data in any incoming insert or update. If the incoming data satisfies the predicate and a row with a matching primary key exists, then no update occurs and the row is deleted. If the incoming data satisfies the predicate and no row with a matching primary key exists, then no insert occurs. If the incoming data does not satisfy the predicate, then an insert or update occurs as normal.
Diagram |
Type | xs:string
Properties |
content | simple
minOccurs | 0

Element table-type / table-delete-rule

Annotations |
    An optional rule specifying a predicate that is evaluated against this table. The predicate is used to register a query against the table where the rows added to the result set are deleted through the publish data path. For this reason, the predicate usually has a time component (see WHEN and FOR). Also see row-delete-rule. For more general table trimming see Alerts and the Delete rows action
Diagram |
Type | xs:string
Properties |
content | simple
minOccurs | 0
maxOccurs | unbounded

Element table-type / primary-key

Annotations |
    A natural key just lists the field or fields in the table that make rows unique.
Diagram |
Type | index-type
Properties |
content | complex
minOccurs | 0
maxOccurs | 1
Model | field+
Children | field
Instance |
    <primary-key>
      <field ref="">{1,unbounded}</field>
    </primary-key>

Element index-type / field

Annotations |
    Reference to a field in the table.
Diagram |
Properties |
content | complex
maxOccurs | unbounded
Attributes |
QName | Type | Use | Annotation
--- | --- | --- | ---
ref | xs:string | required |
    Field name in the table.

Element table-type / custom-id-generation

Annotations |
    A custom ID calls a custom application to determine whether an arriving tuple is new, or an update.
Diagram |
Type | custom-id-generation
Properties |
content | complex
minOccurs | 0
maxOccurs | 1
Model | properties*
Children | properties
Instance |
    <custom-id-generation builder="" module="" template="">
      <properties name="" value="">{0,unbounded}</properties>
    </custom-id-generation>
Attributes |
QName | Type | Use |
--- | --- | --- | ---
builder | xs:string | optional |
module | xs:string | optional |
template | xs:string | optional |

Element custom-id-generation / properties

Diagram |
Type | property-type
Properties |
content | complex
minOccurs | 0
maxOccurs | unbounded
Attributes |
QName | Type | Use |
--- | --- | --- | ---
name | xs:string | required |
value | xs:string | required |

Element table-type / indices

Annotations |
    Indices defined on the table to improve query response time.
Diagram |
Type | indices
Properties |
content | complex
minOccurs | 0
Model | index+
Children | index
Instance |
    <indices>
      <index>{1,unbounded}</index>
    </indices>

Element indices / index

Annotations |
    Identifies one of the fields in the table that is to be indexed.
Diagram |
Type | index-type
Properties |
content | complex
minOccurs | 1
maxOccurs | unbounded
Model | field+
Children | field
Instance |
    <index>
      <field ref="">{1,unbounded}</field>
    </index>

Element table-type / variables

Annotations |
    Typed variables can be defined that will be used in the table-level rules. Use these to save intermediate calculations which otherwise would have to be re-calculated.
Diagram |
Type | variables
Properties |
content | complex
minOccurs | 0
maxOccurs | 1
Model | variable*
Children | variable
Instance |
    <variables>
      <variable name="" type="">{0,unbounded}</variable>
    </variables>

Element table-type / field-rules

Annotations |
    Table-level rules for modifying field content.
Diagram |
Type | field-rules
Properties |
content | complex
minOccurs | 0
maxOccurs | 1
Model | rule*
Children | rule
Instance |
    <field-rules>
      <rule description="">{0,unbounded}</rule>
    </field-rules>

Element table-type / preprocessor-chain

Annotations |
    An optional preprocessor-chain defines one or more preprocessors that intercept incoming data to the table, transform it, then pass it along to the table. The current version supports only one preprocessor.
Diagram |
Type | preprocessor-chain
Properties |
content | complex
minOccurs | 0
Model | preprocessor | join
Children | join, preprocessor
Instance |
    <preprocessor-chain>
      <preprocessor filename="" id="" input-stream="DataIn" module="" output-stream="DataOut" typecheck="true">{1,1}</preprocessor>
      <join foreign-key-table="" liveness="half-active">{1,1}</join>
    </preprocessor-chain>

Element preprocessor-chain / preprocessor

Annotations |
    A preprocessing app that intercepts data going into the table, processes it, and forwards it to the table. Currently only one preprocessor is supported.
Diagram |
Type | extension of embedded-application-type
Type hierarchy | application-type embedded-application-type
Properties |
content | complex
Model | parameters{0,1} , embedded-dependencies{0,1}
Children | embedded-dependencies, parameters
Instance |
    <preprocessor filename="" id="" input-stream="DataIn" module="" output-stream="DataOut" typecheck="true">
      <parameters>{0,1}</parameters>
      <embedded-dependencies>{0,1}</embedded-dependencies>
    </preprocessor>
Attributes |
QName | Type | Default | Use | Annotation
--- | --- | --- | --- | ---
filename | xs:string |  | optional |
    Deprecated; use module instead. Filename of the StreamBase application. This file will be located using the project's module search path.
id | xs:string |  | optional |
    Used by the StreamBase interface generator to identify the preprocessor.
input-stream | restriction of xs:string | DataIn | optional |
    The input stream to send the intercepted data into. The current version only allows this to be "DataIn".
module | xs:string |  | optional |
    Module name of the StreamBase application. This module will be located using the project's module search path.
output-stream | restriction of xs:string | DataOut | optional |
    The output stream that the transformed data is emitted from. The current version only allows this to be "DataOut".
typecheck | xs:boolean | true | optional |
    There are certain unusual situations where a start-up artifact from a preprocessing app is not available early in LiveView server start-up. In these rare cases, in order to allow LiveView to run, you can skip typechecking of the referenced preprocessing app by setting this attribute to false. The downside is that you will no longer receive compile-time typecheck warnings, and may get runtime exceptions if your configuration is wrong.

Element application-type / parameters

Annotations |
    Parameters for the StreamBase application.
Diagram |
Properties |
content | complex
minOccurs | 0
Model | parameter+
Children | parameter
Instance |
    <parameters>
      <parameter name="" value="">{1,unbounded}</parameter>
    </parameters>

Element application-type / parameters / parameter

Annotations |
    Name-value pair property definitions.
Diagram |
Type | property-type
Properties |
content | complex
minOccurs | 1
maxOccurs | unbounded
Attributes |
QName | Type | Use |
--- | --- | --- | ---
name | xs:string | required |
value | xs:string | required |

Element embedded-application-type / embedded-dependencies

Annotations |
    Since StreamBase applications can have container connections defined within them, it is possible to have a container connection from this application to another LiveView table. Explicitly stating these dependencies here allows LiveView to know about them such that LiveView will load tables in the proper order on startup.
Diagram |
Properties |
content | complex
minOccurs | 0
Model | table+
Children | table
Instance |
    <embedded-dependencies>
      <table table-ref="">{1,unbounded}</table>
    </embedded-dependencies>

Element embedded-application-type / embedded-dependencies / table

Diagram |
Properties |
content | complex
maxOccurs | unbounded
Attributes |
QName | Type | Use | Annotation
--- | --- | --- | ---
table-ref | xs:string | required |
    Valid ID of a LiveView table or application.

Element preprocessor-chain / join

Annotations |
    When a new row or update is happening on the local table, the join preprocessor can look up a row in a foreign table, based on its primary key, to augment the information in the local row.
Diagram |
Properties |
content | complex
Model | join-keys , target-fields
Children | join-keys, target-fields
Instance |
    <join foreign-key-table="" liveness="half-active">
      <join-keys>{1,1}</join-keys>
      <target-fields>{1,1}</target-fields>
    </join>
Attributes |
QName | Type | Default | Use | Annotation
--- | --- | --- | --- | ---
foreign-key-table | xs:string |  | required |
    A reference to the foreign table.
liveness | join-liveness-type | half-active | optional |
    A table join can be half-active or full active. For a half-active join of two tables, a local table and a foreign table, when a row in the local table is inserted or updated, a lookup of a row in the foreign table is performed based on the join keys, and the lookup results update the data in the local row. A full-active join performs an update of the local table when either the local or the foreign table is updated.

Element preprocessor-chain / join / join-keys

Annotations |
    The set of equi-join keys used to look up the row in the foreign table.
Diagram |
Properties |
content | complex
Model | join-key+
Children | join-key
Instance |
    <join-keys>
      <join-key foreign-key="">{1,unbounded}</join-key>
    </join-keys>

Element preprocessor-chain / join / join-keys / join-key

Annotations |
    This element contains the name of a field in the local table that is to be used to equi-join with the foreign-key attribute.
Diagram |
Type | extension of xs:string
Properties |
content | complex
maxOccurs | unbounded
Attributes |
QName | Type | Use | Annotation
--- | --- | --- | ---
foreign-key | xs:string | required |
    A field from the primary key in the foreign table.

Element preprocessor-chain / join / target-fields

Annotations |
    The set of target values to copy from the foreign table to the local table.
Diagram |
Properties |
content | complex
Model | target-field+
Children | target-field
Instance |
    <target-fields>
      <target-field ref="">{1,unbounded}</target-field>
    </target-fields>

Element preprocessor-chain / join / target-fields / target-field

Annotations |
    The contents of the target-field is an expression from the source table to populate in the local table ref field.
Diagram |
Type | field-expr-type
Properties |
content | complex
maxOccurs | unbounded
Attributes |
QName | Type | Use | Annotation
--- | --- | --- | ---
ref | xs:string | required |
    The target field in the local table to populate with the results of the expression.

Element table-type / data-sources

Annotations |
    A table can be populated by one or more data sources.
Diagram |
Type | data-sources
Properties |
content | complex
minOccurs | 0
Model | data-source+
Children | data-source
Instance |
    <data-sources>
      <data-source enabled="true">{1,unbounded}</data-source>
    </data-sources>

Element data-sources / data-source

Annotations |
    A data-source can be either a globally defined application, an aggregation from another table, or a transformation of data from another table.
Diagram |
Properties |
content | complex
maxOccurs | unbounded
Model | application | aggregation | transform
Children | aggregation, application, transform
Instance |
    <data-source enabled="true">
      <application application-ref="" output-stream="" typecheck="true">{1,1}</application>
      <aggregation table-ref="" use-snapshot-parallelism="true">{1,1}</aggregation>
      <transform allow-cycle="false" filename="" id="" input-stream="DataIn" module="" output-stream="DataOut" table-ref="" typecheck="true" use-snapshot-parallelism="true">{1,1}</transform>
    </data-source>
Attributes |
QName | Type | Default | Use | Annotation
--- | --- | --- | --- | ---
enabled | xs:boolean | true | optional |
    Set to false to disable this data-source.

Element data-sources / data-source / application

Diagram |
Properties |
content | complex
Attributes |
QName | Type | Default | Use | Annotation
--- | --- | --- | --- | ---
application-ref | xs:string |  | required |
    Reference to a defined application.
output-stream | xs:string |  | required |
    A valid output stream of the application to receive data from.
    Application streams that are intended to send data to LiveView or receive data from LiveView must be marked public; that is, the stream property "Always expose Stream for Dequeue" or "Always expose Stream for Enqueue" must be set.
typecheck | xs:boolean | true | optional |

Element data-sources / data-source / aggregation

Diagram |
Properties |
content | complex
Model | query
Children | query
Instance |
    <aggregation table-ref="" use-snapshot-parallelism="true">
      <query>{1,1}</query>
    </aggregation>
Attributes |
QName | Type | Default | Use | Annotation
--- | --- | --- | --- | ---
table-ref | xs:string |  | required |
    A reference to a table from which aggregated data is received.
use-snapshot-parallelism | xs:boolean | true | optional |
    When a table is configured with snapshot-parallelism, setting this attribute to true pushes the processing of this aggregation into the same parallel region as snapshot processing. In general, performance should be better by running inside the parallel region. If a particular aggregate function specified in the configuration cannot be run in parallel, this setting is ignored.

Element data-sources / data-source / aggregation / query

Annotations |
    The StreamBase CEP expressions that will be used to select rows from the base table and populate the fields of the aggregate table.
Diagram |
Properties |
content | complex
Model | projection* , predicate* , groupby* , pivot{0,1} , for{0,1} , values{0,1}
Children | for, groupby, pivot, predicate, projection, values
Instance |
    <query>
      <projection>{0,unbounded}</projection>
      <predicate>{0,unbounded}</predicate>
      <groupby>{0,unbounded}</groupby>
      <pivot>{0,1}</pivot>
      <for>{0,1}</for>
      <values>{0,1}</values>
    </query>

Element data-sources / data-source / aggregation / query / projection

Annotations |
    The projection expression that is used to populate the fields of this aggregate table. i.e. max(price) as MaxPrice, avg(price) as AvgPrice
Diagram |
Type | xs:string
Properties |
content | simple
minOccurs | 0
maxOccurs | unbounded

Element data-sources / data-source / aggregation / query / predicate

Annotations |
    The predicate used to filter rows from the base table. i.e. area=='US' AND price>100 when transactionTime between now()-minutes(1) and now()
Diagram |
Type | xs:string
Properties |
content | simple
minOccurs | 0
maxOccurs | unbounded

Element data-sources / data-source / aggregation / query / groupby

Annotations |
    The group name(s) or aliase(s) must be a primary key field of this table. By default, the base table has column name(s) that match this tables primary key(s) will be used as group by keys.
Diagram |
Type | xs:string
Properties |
content | simple
minOccurs | 0
maxOccurs | unbounded

Element data-sources / data-source / aggregation / query / pivot

Annotations |
    The pivot aggregate expression that is used to populate the fields of this pivot table. i.e. max(price) as MaxPrice, avg(price) as AvgPrice
Diagram |
Type | xs:string
Properties |
content | simple
minOccurs | 0
maxOccurs | 1

Element data-sources / data-source / aggregation / query / for

Annotations |
    The pivot for clause is used to provide a pivot column if any literals are used in the values clause. Each literal in the values clause is interpreted as the value for the pivot column
Diagram |
Type | xs:string
Properties |
content | simple
minOccurs | 0
maxOccurs | 1

Element data-sources / data-source / aggregation / query / values

Annotations |
    The values clause should have comma separated values where each value can either be a literal or an expression resulting in the boolean value. If even a single value is literal, the for clause becomes mandatory
Diagram |
Type | xs:string
Properties |
content | simple
minOccurs | 0
maxOccurs | 1

Element data-sources / data-source / transform

Annotations |
    A transform is a transformation of the data from another table. Unlike an aggregation, the transform does not combine multiple rows from the other table. It can be used to add calculated fields, to modify fields, or to filter out unwanted rows.
Diagram |
Type | extension of embedded-application-type
Type hierarchy | application-type embedded-application-type
Properties |
content | complex
Model | parameters{0,1} , embedded-dependencies{0,1}
Children | embedded-dependencies, parameters
Instance |
    <transform allow-cycle="false" filename="" id="" input-stream="DataIn" module="" output-stream="DataOut" table-ref="" typecheck="true" use-snapshot-parallelism="true">
      <parameters>{0,1}</parameters>
      <embedded-dependencies>{0,1}</embedded-dependencies>
    </transform>
Attributes |
QName | Type | Default | Use | Annotation
--- | --- | --- | --- | ---
allow-cycle | xs:boolean | false | optional |
    Under normal circumstances, cycles in the configuration graph are not allowed. Under certain advanced cases it might be necessary to have a cycle in the graph. A simple example would be table A publishing to table B and table B publishing back to table A. If a scenario like this is required, a custom transform should be introduced and the “allow-cycle” attribute should be set to true. This setting should be made with great care.
filename | xs:string |  | optional |
    Deprecated; use module instead. Filename of the StreamBase application. This file will be located using the project's module search path.
id | xs:string |  | optional |
    Used by the StreamBase interface generator to identify the transform.
input-stream | restriction of xs:string | DataIn | optional |
    The input stream to receive the row events. The current version of LiveView only allows "DataIn".
module | xs:string |  | optional |
    Module name of the StreamBase application. This module will be located using the project's module search path.
output-stream | restriction of xs:string | DataOut | optional |
    The output stream to get the postprocessed row events from for sending to the target table. The current version of LiveView only allows "DataOut".
table-ref | xs:string |  | required |
    A reference to the source table.
typecheck | xs:boolean | true | optional |
    There are certain unusual situations where a start-up artifact from a preprocessing app is not available early in LiveView server start-up. In these rare cases, in order to allow LiveView to run, you can skip typechecking of the referenced preprocessing app by setting this attribute to false. The downside is that you will no longer receive compile-time typecheck warnings, and may get runtime exceptions if your configuration is wrong. If typechecking is enabled, the system attempts to coerce fields to be the correct type, such as converting an integer to a long, or filling in empty fields with null.
use-snapshot-parallelism | xs:boolean | true | optional |
    When a table is configured with snapshot-parallelism, setting this attribute to true pushes the processing of this transform into the same parallel region as snapshot processing. In general, performance should be better by running inside the parallel region.

Element table-type / filtered-table-aliases

Diagram |
Type | filtered-table-aliases-type
Properties |
content | complex
minOccurs | 0
maxOccurs | 1
Model | filtered-table-alias+
Children | filtered-table-alias
Instance |
    <filtered-table-aliases>
      <filtered-table-alias filter="" table-name-formatter="">{1,unbounded}</filtered-table-alias>
    </filtered-table-aliases>

Element liveview-configuration / external-server-connection

Diagram |
Type | external-server-connection-type
Properties |
content | complex
Model | parameters{0,1} , mappings{0,1} , retry-parameters{0,1}
Children | mappings, parameters, retry-parameters
Instance |
    <external-server-connection id="" table-provider-class="" type="">
      <parameters>{0,1}</parameters>
      <mappings>{0,1}</mappings>
      <retry-parameters maximum-failed-attempts="0" wait-seconds="10">{0,1}</retry-parameters>
    </external-server-connection>
Attributes |
QName | Type | Use | Annotation
--- | --- | --- | ---
id | xs:string | required |
    Identifier for this table provider, which must be the same as the basename of the file that defines this table provider.
table-provider-class | xs:string | optional |
    The Java class that implements TableProvider and will manage the connection to some remote source of tables. This field is required if you have specified a type of custom-table-provider.
type | external-connection-type-type | required |
    The type of external connection: CEP-query-tables, LiveView, jdbc-tables, active-spaces-tables or custom-table-provider.
    uri (required): CEP-query-tables expects the URI parameter, stating the URI of the server. Sample:
    sb://com.streambase.liveview:10000.
    uri (required): LiveView expects the same URI parameter, but with the LiveView port. Sample:
    lv://com.streambase.liveview:10080
    username: The username for connecting to the CEP server that the external LiveView server is based on.
    password (optional): The password for connecting to the CEP server that the external LiveView server is based on.
    liveview.streambase.connection.pool.max.connections
    (optional): default = 200
    liveview.streambase.connection.pool.queries.per.connections
    (optional): default = 10000
    liveview.streambase.connection.pool.publishers.per.connections
    (optional): default = 10000
    liveview.streambase.connection.pool.connection.xmlrpc.timeout.millis
    (optional): default = 5000

Element liveview-configuration / alert-table

Annotations |
    An alert-table can store everything a data-table can, but has additional configuration for defining alerts to populate in the table.
Diagram |
Type | extension of table-type
Type hierarchy | table-type
Properties |
content | complex
Model | fields{0,1} , import-schema{0,1} , row-delete-rule{0,1} , table-delete-rule* , (primary-key{0,1} | custom-id-generation{0,1}) , indices{0,1} , variables{0,1} , field-rules{0,1} , (preprocessor-chain{0,1} | data-sources{0,1}) , filtered-table-aliases{0,1} , alerts{0,1}
Children | alerts, custom-id-generation, data-sources, field-rules, fields, filtered-table-aliases, import-schema, indices, preprocessor-chain, primary-key, row-delete-rule, table-delete-rule, variables
Instance |
    <alert-table description="" group="" id="" publish-interval-millis="" short-description="" snapshot-concurrency="0" snapshot-parallelism="" table-space-ref="">
      <fields>{0,1}</fields>
      <import-schema from="" schema="">{0,1}</import-schema>
      <row-delete-rule>{0,1}</row-delete-rule>
      <table-delete-rule>{0,unbounded}</table-delete-rule>
      <primary-key>{0,1}</primary-key>
      <custom-id-generation builder="" module="" template="">{0,1}</custom-id-generation>
      <indices>{0,1}</indices>
      <variables>{0,1}</variables>
      <field-rules>{0,1}</field-rules>
      <preprocessor-chain>{0,1}</preprocessor-chain>
      <data-sources>{0,1}</data-sources>
      <filtered-table-aliases>{0,1}</filtered-table-aliases>
      <alerts>{0,1}</alerts>
    </alert-table>
Attributes |
QName | Type | Default | Use | Annotation
--- | --- | --- | --- | ---
description | xs:string |  | optional |
    Long description.
group | name-type |  | optional |
    Optional logical grouping for a table.
id | name-type |  | required |
    Identifier for this table, , which must be the same as the basename of the file that defines this table.
publish-interval-millis | xs:positiveInteger |  | optional |
    This setting applies to all table types, and is used to specify in milliseconds the amount
    of delay before publishing data from the table; this condition is known as conflation of data.
    Set this attribute to a positive, non-zero integer ≥ 5 to specify conflation for this table.
    A value below 5, including zero and all negative numbers, is forced equal to 5.
    Static aggregation tables have an internal setting that is the equivalent of setting
    publish-interval-millis=1000 (1 second). For such tables, you cannot disable conflation,
    but you can change the conflation interval by setting publish-interval-millis to a different
    integer value. For all other table types, specify a value for publish-interval-millis to both
    enable conflation and to specify the conflation interval. To disable conflation for
    non-aggregation tables, remove the publish-interval-millis attribute entirely from your
    table’s lvconf entry.
    Without conflation, data is published from a table as soon as it is received. With conflation
    enabled, all downstream components see conflated data, including alerts, LiveView Desktop,
    clients built with the Java or .NET APIs, or another table in a transformation sequence.
    If an alert is set for a conflated table, be aware that it is possible for conditions that
    would otherwise trigger an alert to occur briefly during a conflation period; in this case,
    the trigger conditions are conflated away and the alert does not trigger.
    See the Data Conflation topic in the LiveView Reference Guide for further information.
short-description | xs:string |  | optional |
    Short description.
snapshot-concurrency | xs:nonNegativeInteger | 0 | optional |
    Defines the maximum number of snapshot queries (one per thread) within a partition that are executed at once. This attribute overrides the same attribute defined in the table's tablespace.
snapshot-parallelism | xs:int |  | optional |
    Defines the number of table partitions, and the number parallel regions used to scan a table during the snapshot portion of a query. This attribute overrides the same attribute defined in the table's tablespace.
table-space-ref | xs:string |  | optional |
    A reference to a defined table-space.

Element liveview-configuration / alert-table / alerts

Annotations |
    If specified, one or more alerts can be configured for this alert-table.
Diagram |
Properties |
content | complex
minOccurs | 0
Model | alert+
Children | alert
Instance |
    <alerts>
      <alert enabled="true" name="" publish-interval-millis="" table-ref="">{1,unbounded}</alert>
    </alerts>

Element liveview-configuration / alert-table / alerts / alert

Annotations |
    An alert is continuously tested. When the test transitions from false to true, a new record is created.
Diagram |
Properties |
content | complex
maxOccurs | unbounded
Model | key , active-condition , clear-condition{0,1} , field-map{0,1}
Children | active-condition, clear-condition, field-map, key
Instance |
    <alert enabled="true" name="" publish-interval-millis="" table-ref="">
      <key>{1,1}</key>
      <active-condition>{1,1}</active-condition>
      <clear-condition>{0,1}</clear-condition>
      <field-map>{0,1}</field-map>
    </alert>
Attributes |
QName | Type | Default | Use | Annotation
--- | --- | --- | --- | ---
enabled | xs:boolean | true | optional |
    Flag for enabling or disabling this alert.
name | xs:string |  | required |
    Unique name for the alert.
publish-interval-millis | xs:positiveInteger |  | optional |
    This setting applies to all table types, and is used to specify in milliseconds the amount of delay before publishing data from the table; this condition is known as conflation of data. Set this attribute to a positive, non-zero integer ≥ 5 to specify conflation for this table. A value below 5, including zero and all negative numbers, is forced equal to 5. Static aggregation tables have an internal setting that is the equivalent of setting publish-interval-millis=1000 (1 second). For such tables, you cannot disable conflation, but you can change the conflation interval by setting publish-interval-millis to a different integer value. For all other table types, specify a value for publish-interval-millis to both enable conflation and to specify the conflation interval. To disable conflation for non-aggregation tables, remove the publish-interval-millis attribute entirely from your table’s lvconf entry.
    Without conflation, data is published from a table as soon as it is received. With conflation enabled, all downstream components see conflated data, including alerts, LiveView Desktop, clients built with the Java or .NET APIs, or another table in a transformation sequence. If an alert is set for a conflated table, be aware that it is possible for conditions that would otherwise trigger an alert to occur briefly during a conflation period; in this case, the trigger conditions are conflated away and the alert does not trigger. See the Data Conflation topic in the LiveView Reference Guide for further information.
table-ref | xs:string |  | required |
    Reference to a source table where data is coming to evaluate a possible alert.

Element liveview-configuration / alert-table / alerts / alert / key

Annotations |
    An expression that becomes the CQSAlertKey in this alert-table.
Diagram |
Type | xs:string
Properties |
content | simple

Element liveview-configuration / alert-table / alerts / alert / active-condition

Annotations |
    The condition that fires the alert if it is true.
Diagram |
Type | xs:string
Properties |
content | simple

Element liveview-configuration / alert-table / alerts / alert / clear-condition

Annotations |
    The condition that changes the CQSAlertType to "Cleared".
Diagram |
Type | xs:string
Properties |
content | simple
minOccurs | 0

Element liveview-configuration / alert-table / alerts / alert / field-map

Annotations |
    Additional fields that should propagate from the source table to the alert table when the active-condition is satisfied.
Diagram |
Properties |
content | complex
minOccurs | 0
Model | field+
Children | field
Instance |
    <field-map>
      <field ref="">{1,unbounded}</field>
    </field-map>

Element liveview-configuration / alert-table / alerts / alert / field-map / field

Annotations |
    The body of this element contains an expression from the source table.
Diagram |
Type | field-expr-type
Properties |
content | complex
minOccurs | 1
maxOccurs | unbounded
Attributes |
QName | Type | Use | Annotation
--- | --- | --- | ---
ref | xs:string | required |
    The target field in the local table to populate with the results of the expression.

Element liveview-configuration / application

Annotations |
    Configuring a StreamBase global application at this level allows you to specify parameters one time and then reference the global application within other configuration areas in LiveView. For example, one or more tables can be configured to receive data from this global application. Streams that are intended to send data to LiveView or receive data from LiveView must be marked public; that is, the stream property "Always expose Stream for Dequeue" or "Always expose Stream for Enqueue" must be set.
Diagram |
Type | extension of application-type
Type hierarchy | application-type
Properties |
content | complex
Model | parameters{0,1}
Children | parameters
Instance |
    <application filename="" id="" module="">
      <parameters>{0,1}</parameters>
    </application>
Attributes |
QName | Type | Use | Annotation
--- | --- | --- | ---
filename | xs:string | optional |
    Deprecated; use module instead. Filename of the StreamBase application. This file will be located using the project's module search path.
id | name-type | required |
    Identifier for this application, which must be the same as the basename of the file that defines this app.
module | xs:string | optional |
    Module name of the StreamBase application. This module will be located using the project's module search path.

Element liveview-configuration / expr-macro

Annotations |
    An expr-macro allows you to specify an expression once and reference it elsewhere in LiveView configuration. The expression can optionally contain embedded parameters identifiable by a dollar sign prefix within the expression. The parameters must also be formally declared in the XML configuration and can have optional default values. The macro can then be called in other applicable LiveView configuration files using a function syntax. The applicable areas would be anywhere that an expression can be specified, with comma-separated argument values in parentheses.
    For example:
    <insert-rule>MyMacro(3, 4)</insert-rule>
    Macros cannot be combined within expressions and cannot be nested. For example, the following are NOT valid:
    <insert-rule>MyMacro(3)+MyMacro(4) </insert-rule> <expr-macro id="MyMacro">
      <expr>SumIf($x+$y)</expr>
      <parameters>
        <parameter name="x"/>
        <parameter default-value="2" name="y"/>
      </parameters>
    </expr-macro>
Diagram |
Properties |
content | complex
Model | expr , parameters{0,1}
Children | expr, parameters
Instance |
    <expr-macro id="">
      <expr>{1,1}</expr>
      <parameters>{0,1}</parameters>
    </expr-macro>
Attributes |
QName | Type | Use | Annotation
--- | --- | --- | ---
id | name-type | required |
    Identifier for this expression.

Element liveview-configuration / expr-macro / expr

Annotations |
    The LiveView expression.
Diagram |
Type | xs:string
Properties |
content | simple

Element liveview-configuration / expr-macro / parameters

Annotations |
    Parameters can be specified for a macro. Parameters are embedded into the macro expr by prefixing them with a dollar sign (for example, $myParam). Macros are called with positional parameter specification (for example, myMacro(paramVal)).
Diagram |
Properties |
content | complex
minOccurs | 0
Model | parameter+
Children | parameter
Instance |
    <parameters>
      <parameter default-value="" name="">{1,unbounded}</parameter>
    </parameters>

Element liveview-configuration / expr-macro / parameters / parameter

Diagram |
Properties |
content | complex
maxOccurs | unbounded
Attributes |
QName | Type | Use | Annotation
--- | --- | --- | ---
default-value | xs:string | optional |
    Optional default value for this parameter. Since parameters are fulfilled in order, if one parameter is unspecified (using the default), then all parameters after it must also be left unspecified.
name | name-type | required |
    Case-sensitive parameter name.

Element liveview-configuration / table-space

Annotations |
    A table-space defines certain physical properties that can be shared by one or more tables. A table definition must reference a table-space.
Diagram |
Properties |
content | complex
Model | memory{0,1} , persistence{0,1}
Children | memory, persistence
Instance |
    <table-space id="" snapshot-concurrency="0" snapshot-parallelism="1" table-group="">
      <memory max-eval-cache-entries="1000" memory-for-sbargen="512m" min-eval-cache-entries="1000" stacksize-for-sbargen="512k">{0,1}</memory>
      <persistence folder="" peer-uri-list="" persist-data="" restore-data-on-start="">{0,1}</persistence>
    </table-space>
Attributes |
QName | Type | Default | Use | Annotation
--- | --- | --- | --- | ---
id | name-type |  | required |
    Identifier for this table-space, which must be the same as the basename of the file that defines this table-space.
snapshot-concurrency | xs:nonNegativeInteger | 0 | optional |
    Defines the maximum number of snapshot queries (one per thread) within a partition that are executed at once.
snapshot-parallelism | xs:positiveInteger | 1 | optional |
    Defines the number of table partitions and the number of parallel regions used to scan a table during the snapshot portion of a query.
table-group | xs:string |  | optional |
    Expose this table to the named table groups (comma-separated). A remote configuration can then query this table.

Element liveview-configuration / table-space / memory

Diagram |
Properties |
content | complex
minOccurs | 0
Attributes |
QName | Type | Default | Use | Annotation
--- | --- | --- | --- | ---
max-eval-cache-entries | xs:positiveInteger | 1000 | optional |
    Optional setting for optimizing the cache size used for storing query predicates against a table in this table-space. The size is allocated for each table in the table-space.
memory-for-sbargen | xs:string | 512m | optional |
    Maximum amount of memory used to generate an SBAR for the table.
min-eval-cache-entries | xs:positiveInteger | 1000 | optional |
    Optional setting for optimizing the cache size used for storing query predicates against a table in this table-space. The size is allocated for each table in the table-space.
stacksize-for-sbargen | xs:string | 512k | optional |
    Maximum stack size used to generate an SBAR for the table.

Element liveview-configuration / table-space / persistence

Diagram |
Properties |
content | complex
minOccurs | 0
Attributes |
QName | Type | Use | Annotation
--- | --- | --- | ---
folder | restriction of xs:string | optional |
    If persistence is enabled, this is the base folder where a table's data is stored.
peer-uri-list | xs:string | optional |
    If persistence is enabled, this is the comma seperated list of LiveView URIs that should be used as recovery peers.
persist-data | xs:boolean | optional |
    If true, a table's data is to be persisted to a transaction log.
restore-data-on-start | xs:boolean | required |
    If true, a table is to be re-populated from its persisted log.

Element liveview-configuration / publisher

Diagram |
Type | extension of publisher-type
Type hierarchy | publisher-type
Properties |
content | complex
Model | tables
Children | tables
Instance |
    <publisher description="" filename="" id="" module="" short-description="">
      <tables>{1,1}</tables>
    </publisher>
Attributes |
QName | Type | Use | Annotation
--- | --- | --- | ---
description | xs:string | optional |
    Long description.
filename | xs:string | optional |
    Filename of the embedded publisher StreamBase application. This file is located using the project's module search path.
id | name-type | required |
    Identifier for this publisher.
module | xs:string | optional |
    Module for the embedded publisher StreamBase application. This module is located using the project's module search path.
short-description | xs:string | optional |
    Short description.

Element publisher-type / tables

Annotations |
    The set of LiveView tables being published to.
Diagram |
Properties |
content | complex
Model | table+
Children | table
Instance |
    <tables>
      <table table-ref="">{1,unbounded}</table>
    </tables>

Element publisher-type / tables / table

Annotations |
    A LiveView table being published to.
Diagram |
Properties |
content | complex
maxOccurs | unbounded
Attributes |
QName | Type | Use | Annotation
--- | --- | --- | ---
table-ref | xs:string | required |
    A reference to a table being published to.

Element liveview-configuration / jdbc-table

Annotations |
    A jdbc-table is a table that executes queries against data stored in a remote SQL database via JDBC. A reference to a data source defined in sbd.sbconf is required.
Diagram |
Properties |
content | complex
Model | data-source-ref , sql , fields{0,1}
Children | data-source-ref, fields, sql
Instance |
    <jdbc-table description="" group="" id="" short-description="">
      <data-source-ref name="">{1,1}</data-source-ref>
      <sql>{1,1}</sql>
      <fields>{0,1}</fields>
    </jdbc-table>
Attributes |
QName | Type | Use | Annotation
--- | --- | --- | ---
description | xs:string | optional |
    Long description.
group | name-type | optional |
    Optional logical grouping for a table.
id | name-type | required |
    Identifier for this jdbc-table, which must be the same as the basename of the file that defines this jdbc-table.
short-description | xs:string | optional |
    Short description.

Element liveview-configuration / jdbc-table / data-source-ref

Annotations |
    The name of a data source defined in sbd.sbconf.
Diagram |
Type | data-source-ref-type
Properties |
content | complex
Attributes |
QName | Type | Use | Annotation
--- | --- | --- | ---
name | xs:string | required |
    Reference to a data source defined in sbd.sbconf.

Element liveview-configuration / jdbc-table / sql

Annotations |
    SQL statement (that must return a result set) that LiveView queries will execute against. LiveView queries are executed against the result of this statement as a sub-query. Wrapping this with the CDATA tag is recommended.
Diagram |
Type | xs:string
Properties |
content | simple

Element liveview-configuration / jdbc-table / fields

Annotations |
    Optionally define the fields of this table. When specified, field names and types that match the result set from the sql statement must be compatible; fields that do not match by name will always return null. Additionally, defining fields here will skip type checking the SQL statement on startup.
Diagram |
Type | defined-field-set
Properties |
content | complex
minOccurs | 0
maxOccurs | 1
Model | field+
Children | field
Instance |
    <fields>
      <field description="" name="" short-name="" type="">{1,unbounded}</field>
    </fields>

Element defined-field-set / field

Diagram |
Type | typed-field-type
Properties |
content | complex
minOccurs | 1
maxOccurs | unbounded
Attributes |
QName | Type | Use | Annotation
--- | --- | --- | ---
description | xs:string | optional |
    Longer description of the field.
name | name-type | required |
    Unique field name within the table.
short-name | xs:string | optional |
    Short description of the field.
type | data-type-type | required |
    Field data type.

Complex Type table-type

Annotations |
    Common configuration for all types of LiveView tables.
Diagram |
Used by |
Elements | liveview-configuration/alert-table, liveview-configuration/data-table
Model | fields{0,1} , import-schema{0,1} , row-delete-rule{0,1} , table-delete-rule* , (primary-key{0,1} | custom-id-generation{0,1}) , indices{0,1} , variables{0,1} , field-rules{0,1} , (preprocessor-chain{0,1} | data-sources{0,1}) , filtered-table-aliases{0,1}
Children | custom-id-generation, data-sources, field-rules, fields, filtered-table-aliases, import-schema, indices, preprocessor-chain, primary-key, row-delete-rule, table-delete-rule, variables
Attributes |
QName | Type | Default | Use | Annotation
--- | --- | --- | --- | ---
description | xs:string |  | optional |
    Long description.
group | name-type |  | optional |
    Optional logical grouping for a table.
id | name-type |  | required |
    Identifier for this table, , which must be the same as the basename of the file that defines this table.
publish-interval-millis | xs:positiveInteger |  | optional |
    This setting applies to all table types, and is used to specify in milliseconds the amount
    of delay before publishing data from the table; this condition is known as conflation of data.
    Set this attribute to a positive, non-zero integer ≥ 5 to specify conflation for this table.
    A value below 5, including zero and all negative numbers, is forced equal to 5.
    Static aggregation tables have an internal setting that is the equivalent of setting
    publish-interval-millis=1000 (1 second). For such tables, you cannot disable conflation,
    but you can change the conflation interval by setting publish-interval-millis to a different
    integer value. For all other table types, specify a value for publish-interval-millis to both
    enable conflation and to specify the conflation interval. To disable conflation for
    non-aggregation tables, remove the publish-interval-millis attribute entirely from your
    table’s lvconf entry.
    Without conflation, data is published from a table as soon as it is received. With conflation
    enabled, all downstream components see conflated data, including alerts, LiveView Desktop,
    clients built with the Java or .NET APIs, or another table in a transformation sequence.
    If an alert is set for a conflated table, be aware that it is possible for conditions that
    would otherwise trigger an alert to occur briefly during a conflation period; in this case,
    the trigger conditions are conflated away and the alert does not trigger.
    See the Data Conflation topic in the LiveView Reference Guide for further information.
short-description | xs:string |  | optional |
    Short description.
snapshot-concurrency | xs:nonNegativeInteger | 0 | optional |
    Defines the maximum number of snapshot queries (one per thread) within a partition that are executed at once. This attribute overrides the same attribute defined in the table's tablespace.
snapshot-parallelism | xs:int |  | optional |
    Defines the number of table partitions, and the number parallel regions used to scan a table during the snapshot portion of a query. This attribute overrides the same attribute defined in the table's tablespace.
table-space-ref | xs:string |  | optional |
    A reference to a defined table-space.

Complex Type fields

Diagram |
Used by |
Element | table-type/fields
Model | field+
Children | field

Complex Type field-type

Annotations |
    Definition of a field including type and optional insert or update rules. A field that is designated as a primary key cannot have insert or update rules.
Diagram |
Type | extension of base-field-type
Type hierarchy | typed-field-type base-field-type field-type
Used by |
Element | fields/field
Model | insert-rule{0,1} , update-rule{0,1}
Children | insert-rule, update-rule
Attributes |
QName | Type | Default | Use | Annotation
--- | --- | --- | --- | ---
description | xs:string |  | optional |
    Longer description of the field.
ignore-case | xs:boolean | false | optional |
    For string fields. If set to true, then searches on this field are case insensitive by default.
name | name-type |  | required |
    Unique field name within the table.
short-name | xs:string |  | optional |
    Short description of the field.
type | data-type-type |  | required |
    Field data type.

Complex Type import-schema

Annotations |
    An existing schema, imported from an sbapp or sbint file.
Diagram |
Used by |
Element | table-type/import-schema
Attributes |
QName | Type | Use | Annotation
--- | --- | --- | ---
from |  | required |
    Path to the sbapp or sbint file from which to import the schema. The path is relative to the project root (where the top-level lvconf must reside). If you specify a simple file name, LiveView searches for the file on the current project's module search path.
schema |  | required |
    The name of the schema within the specified sbapp or sbint file.

Complex Type index-type

Annotations |
    Index definition.
Diagram |
Used by |
Elements | indices/index, table-type/primary-key
Model | field+
Children | field

Complex Type custom-id-generation

Diagram |
Used by |
Element | table-type/custom-id-generation
Model | properties*
Children | properties
Attributes |
QName | Type | Use |
--- | --- | --- | ---
builder | xs:string | optional |
module | xs:string | optional |
template | xs:string | optional |

Complex Type property-type

Diagram |
Used by |
Elements | application-type/parameters/parameter, custom-id-generation/properties
Attributes |
QName | Type | Use |
--- | --- | --- | ---
name | xs:string | required |
value | xs:string | required |

Complex Type indices

Diagram |
Used by |
Element | table-type/indices
Model | index+
Children | index

Complex Type preprocessor-chain

Diagram |
Used by |
Element | table-type/preprocessor-chain
Model | preprocessor | join
Children | join, preprocessor

Complex Type embedded-application-type

Diagram |
Type | extension of application-type
Type hierarchy | application-type embedded-application-type
Used by |
Elements | data-sources/data-source/transform, preprocessor-chain/preprocessor
Model | parameters{0,1} , embedded-dependencies{0,1}
Children | embedded-dependencies, parameters
Attributes |
QName | Type | Use | Annotation
--- | --- | --- | ---
filename | xs:string | optional |
    Deprecated; use module instead. Filename of the StreamBase application. This file will be located using the project's module search path.
module | xs:string | optional |
    Module name of the StreamBase application. This module will be located using the project's module search path.

Complex Type application-type

Annotations |
    Definitions of a Streambase application with optional parameters.
Diagram |
Used by |
Complex Type | embedded-application-type
Element | liveview-configuration/application
Model | parameters{0,1}
Children | parameters
Attributes |
QName | Type | Use | Annotation
--- | --- | --- | ---
filename | xs:string | optional |
    Deprecated; use module instead. Filename of the StreamBase application. This file will be located using the project's module search path.
module | xs:string | optional |
    Module name of the StreamBase application. This module will be located using the project's module search path.

Complex Type field-expr-type

Annotations |
    A LiveView expression for populating a referenced field with the expression specified in the body of the element.
Diagram |
Type | extension of xs:string
Used by |
Elements | liveview-configuration/alert-table/alerts/alert/field-map/field, preprocessor-chain/join/target-fields/target-field
Attributes |
QName | Type | Use | Annotation
--- | --- | --- | ---
ref | xs:string | required |
    The target field in the local table to populate with the results of the expression.

Simple Type join-liveness-type

Diagram |
Type | restriction of xs:string
Facets |
enumeration | half-active |
enumeration | full-active |
Used by |
Attribute | preprocessor-chain/join/@liveness

Complex Type data-sources

Diagram |
Used by |
Element | table-type/data-sources
Model | data-source+
Children | data-source

Complex Type publisher-type

Annotations |
    Configures an embedded publisher.
Diagram |
Used by |
Element | liveview-configuration/publisher
Model | tables
Children | tables
Attributes |
QName | Type | Use | Annotation
--- | --- | --- | ---
description | xs:string | optional |
    Long description.
filename | xs:string | optional |
    Filename of the embedded publisher StreamBase application. This file is located using the project's module search path.
id | name-type | required |
    Identifier for this publisher.
module | xs:string | optional |
    Module for the embedded publisher StreamBase application. This module is located using the project's module search path.
short-description | xs:string | optional |
    Short description.

Complex Type data-source-ref-type

Diagram |
Used by |
Element | liveview-configuration/jdbc-table/data-source-ref
Attributes |
QName | Type | Use | Annotation
--- | --- | --- | ---
name | xs:string | required |
    Reference to a data source defined in sbd.sbconf.

Complex Type defined-field-set

Diagram |
Used by |
Element | liveview-configuration/jdbc-table/fields
Model | field+
Children | field

Attribute field-type / update-rule / @use-insert-rule

Annotations |
    Use the same rule specified in the insert-rule.
Type | xs:boolean
Properties |
default | false
Used by |
Element | field-type/update-rule

Attribute import-schema / @from

Annotations |
    Path to the sbapp or sbint file from which to import the schema. The path is relative to the project root (where the top-level lvconf must reside). If you specify a simple file name, LiveView searches for the file on the current project's module search path.
Properties |
use | required
Used by |
Complex Type | import-schema

Attribute import-schema / @schema

Annotations |
    The name of the schema within the specified sbapp or sbint file.
Properties |
use | required
Used by |
Complex Type | import-schema

Attribute index-type / field / @ref

Annotations |
    Field name in the table.
Type | xs:string
Properties |
use | required
Used by |
Element | index-type/field

Attribute property-type / @name

Type | xs:string
Properties |
use | required
Used by |
Complex Type | property-type

Attribute property-type / @value

Type | xs:string
Properties |
use | required
Used by |
Complex Type | property-type

Attribute custom-id-generation / @module

Type | xs:string
Properties |
content | simple
Used by |
Complex Type | custom-id-generation

Attribute custom-id-generation / @builder

Type | xs:string
Properties |
content | simple
Used by |
Complex Type | custom-id-generation

Attribute custom-id-generation / @template

Type | xs:string
Properties |
content | simple
Used by |
Complex Type | custom-id-generation

Attribute application-type / @filename

Annotations |
    Deprecated; use module instead. Filename of the StreamBase application. This file will be located using the project's module search path.
Type | xs:string
Properties |
use | optional
Used by |
Complex Type | application-type

Attribute application-type / @module

Annotations |
    Module name of the StreamBase application. This module will be located using the project's module search path.
Type | xs:string
Properties |
use | optional
Used by |
Complex Type | application-type

Attribute embedded-application-type / embedded-dependencies / table / @table-ref

Annotations |
    Valid ID of a LiveView table or application.
Type | xs:string
Properties |
use | required
Used by |
Element | embedded-application-type/embedded-dependencies/table

Attribute preprocessor-chain / preprocessor / @id

Annotations |
    Used by the StreamBase interface generator to identify the preprocessor.
Type | xs:string
Properties |
content | simple
Used by |
Element | preprocessor-chain/preprocessor

Attribute preprocessor-chain / preprocessor / @input-stream

Annotations |
    The input stream to send the intercepted data into. The current version only allows this to be "DataIn".
Type | restriction of xs:string
Properties |
default | DataIn
Facets |
pattern | DataIn |
Used by |
Element | preprocessor-chain/preprocessor

Attribute preprocessor-chain / preprocessor / @output-stream

Annotations |
    The output stream that the transformed data is emitted from. The current version only allows this to be "DataOut".
Type | restriction of xs:string
Properties |
default | DataOut
Facets |
pattern | DataOut |
Used by |
Element | preprocessor-chain/preprocessor

Attribute preprocessor-chain / preprocessor / @typecheck

Annotations |
    There are certain unusual situations where a start-up artifact from a preprocessing app is not available early in LiveView server start-up. In these rare cases, in order to allow LiveView to run, you can skip typechecking of the referenced preprocessing app by setting this attribute to false. The downside is that you will no longer receive compile-time typecheck warnings, and may get runtime exceptions if your configuration is wrong.
Type | xs:boolean
Properties |
default | true
Used by |
Element | preprocessor-chain/preprocessor

Attribute preprocessor-chain / join / join-keys / join-key / @foreign-key

Annotations |
    A field from the primary key in the foreign table.
Type | xs:string
Properties |
use | required
Used by |
Element | preprocessor-chain/join/join-keys/join-key

Attribute field-expr-type / @ref

Annotations |
    The target field in the local table to populate with the results of the expression.
Type | xs:string
Properties |
use | required
Used by |
Complex Type | field-expr-type

Attribute preprocessor-chain / join / @foreign-key-table

Annotations |
    A reference to the foreign table.
Type | xs:string
Properties |
use | required
Used by |
Element | preprocessor-chain/join

Attribute preprocessor-chain / join / @liveness

Annotations |
    A table join can be half-active or full active. For a half-active join of two tables, a local table and a foreign table, when a row in the local table is inserted or updated, a lookup of a row in the foreign table is performed based on the join keys, and the lookup results update the data in the local row. A full-active join performs an update of the local table when either the local or the foreign table is updated.
Type | join-liveness-type
Properties |
default | half-active
Facets |
enumeration | half-active |
enumeration | full-active |
Used by |
Element | preprocessor-chain/join

Attribute data-sources / data-source / application / @application-ref

Annotations |
    Reference to a defined application.
Type | xs:string
Properties |
use | required
Used by |
Element | data-sources/data-source/application

Attribute data-sources / data-source / application / @output-stream

Annotations |
    A valid output stream of the application to receive data from.
    Application streams that are intended to send data to LiveView or receive data from LiveView must be marked public; that is, the stream property "Always expose Stream for Dequeue" or "Always expose Stream for Enqueue" must be set.
Type | xs:string
Properties |
use | required
Used by |
Element | data-sources/data-source/application

Attribute data-sources / data-source / application / @typecheck

Type | xs:boolean
Properties |
default | true
Used by |
Element | data-sources/data-source/application

Attribute data-sources / data-source / aggregation / @table-ref

Annotations |
    A reference to a table from which aggregated data is received.
Type | xs:string
Properties |
use | required
Used by |
Element | data-sources/data-source/aggregation

Attribute data-sources / data-source / aggregation / @use-snapshot-parallelism

Annotations |
    When a table is configured with snapshot-parallelism, setting this attribute to true pushes the processing of this aggregation into the same parallel region as snapshot processing. In general, performance should be better by running inside the parallel region. If a particular aggregate function specified in the configuration cannot be run in parallel, this setting is ignored.
Type | xs:boolean
Properties |
default | true
Used by |
Element | data-sources/data-source/aggregation

Attribute data-sources / data-source / transform / @id

Annotations |
    Used by the StreamBase interface generator to identify the transform.
Type | xs:string
Properties |
content | simple
Used by |
Element | data-sources/data-source/transform

Attribute data-sources / data-source / transform / @table-ref

Annotations |
    A reference to the source table.
Type | xs:string
Properties |
use | required
Used by |
Element | data-sources/data-source/transform

Attribute data-sources / data-source / transform / @input-stream

Annotations |
    The input stream to receive the row events. The current version of LiveView only allows "DataIn".
Type | restriction of xs:string
Properties |
default | DataIn
Facets |
pattern | DataIn |
Used by |
Element | data-sources/data-source/transform

Attribute data-sources / data-source / transform / @output-stream

Annotations |
    The output stream to get the postprocessed row events from for sending to the target table. The current version of LiveView only allows "DataOut".
Type | restriction of xs:string
Properties |
default | DataOut
Facets |
pattern | DataOut |
Used by |
Element | data-sources/data-source/transform

Attribute data-sources / data-source / transform / @typecheck

Annotations |
    There are certain unusual situations where a start-up artifact from a preprocessing app is not available early in LiveView server start-up. In these rare cases, in order to allow LiveView to run, you can skip typechecking of the referenced preprocessing app by setting this attribute to false. The downside is that you will no longer receive compile-time typecheck warnings, and may get runtime exceptions if your configuration is wrong. If typechecking is enabled, the system attempts to coerce fields to be the correct type, such as converting an integer to a long, or filling in empty fields with null.
Type | xs:boolean
Properties |
default | true
Used by |
Element | data-sources/data-source/transform

Attribute data-sources / data-source / transform / @use-snapshot-parallelism

Annotations |
    When a table is configured with snapshot-parallelism, setting this attribute to true pushes the processing of this transform into the same parallel region as snapshot processing. In general, performance should be better by running inside the parallel region.
Type | xs:boolean
Properties |
default | true
Used by |
Element | data-sources/data-source/transform

Attribute data-sources / data-source / transform / @allow-cycle

Annotations |
    Under normal circumstances, cycles in the configuration graph are not allowed. Under certain advanced cases it might be necessary to have a cycle in the graph. A simple example would be table A publishing to table B and table B publishing back to table A. If a scenario like this is required, a custom transform should be introduced and the “allow-cycle” attribute should be set to true. This setting should be made with great care.
Type | xs:boolean
Properties |
default | false
Used by |
Element | data-sources/data-source/transform

Attribute data-sources / data-source / @enabled

Annotations |
    Set to false to disable this data-source.
Type | xs:boolean
Properties |
default | true
Used by |
Element | data-sources/data-source

Attribute table-type / @id

Annotations |
    Identifier for this table, , which must be the same as the basename of the file that defines this table.
Type | name-type
Properties |
use | required
Facets |
pattern | [a-zA-Z]\S* |
Used by |
Complex Type | table-type

Attribute table-type / @table-space-ref

Annotations |
    A reference to a defined table-space.
Type | xs:string
Properties |
content | simple
Used by |
Complex Type | table-type

Attribute table-type / @group

Annotations |
    Optional logical grouping for a table.
Type | name-type
Properties |
content | simple
Facets |
pattern | [a-zA-Z]\S* |
Used by |
Complex Type | table-type

Attribute table-type / @short-description

Annotations |
    Short description.
Type | xs:string
Properties |
content | simple
Used by |
Complex Type | table-type

Attribute table-type / @description

Annotations |
    Long description.
Type | xs:string
Properties |
content | simple
Used by |
Complex Type | table-type

Attribute table-type / @publish-interval-millis

Annotations |
    This setting applies to all table types, and is used to specify in milliseconds the amount
    of delay before publishing data from the table; this condition is known as conflation of data.
    Set this attribute to a positive, non-zero integer ≥ 5 to specify conflation for this table.
    A value below 5, including zero and all negative numbers, is forced equal to 5.
    Static aggregation tables have an internal setting that is the equivalent of setting
    publish-interval-millis=1000 (1 second). For such tables, you cannot disable conflation,
    but you can change the conflation interval by setting publish-interval-millis to a different
    integer value. For all other table types, specify a value for publish-interval-millis to both
    enable conflation and to specify the conflation interval. To disable conflation for
    non-aggregation tables, remove the publish-interval-millis attribute entirely from your
    table’s lvconf entry.
    Without conflation, data is published from a table as soon as it is received. With conflation
    enabled, all downstream components see conflated data, including alerts, LiveView Desktop,
    clients built with the Java or .NET APIs, or another table in a transformation sequence.
    If an alert is set for a conflated table, be aware that it is possible for conditions that
    would otherwise trigger an alert to occur briefly during a conflation period; in this case,
    the trigger conditions are conflated away and the alert does not trigger.
    See the Data Conflation topic in the LiveView Reference Guide for further information.
Type | xs:positiveInteger
Properties |
content | simple
Used by |
Complex Type | table-type

Attribute table-type / @snapshot-parallelism

Annotations |
    Defines the number of table partitions, and the number parallel regions used to scan a table during the snapshot portion of a query. This attribute overrides the same attribute defined in the table's tablespace.
Type | xs:int
Properties |
content | simple
Used by |
Complex Type | table-type

Attribute table-type / @snapshot-concurrency

Annotations |
    Defines the maximum number of snapshot queries (one per thread) within a partition that are executed at once. This attribute overrides the same attribute defined in the table's tablespace.
Type | xs:nonNegativeInteger
Properties |
default | 0
Used by |
Complex Type | table-type

Attribute liveview-configuration / alert-table / alerts / alert / @table-ref

Annotations |
    Reference to a source table where data is coming to evaluate a possible alert.
Type | xs:string
Properties |
use | required
Used by |
Element | liveview-configuration/alert-table/alerts/alert

Attribute liveview-configuration / alert-table / alerts / alert / @name

Annotations |
    Unique name for the alert.
Type | xs:string
Properties |
use | required
Used by |
Element | liveview-configuration/alert-table/alerts/alert

Attribute liveview-configuration / alert-table / alerts / alert / @enabled

Annotations |
    Flag for enabling or disabling this alert.
Type | xs:boolean
Properties |
default | true
Used by |
Element | liveview-configuration/alert-table/alerts/alert

Attribute liveview-configuration / alert-table / alerts / alert / @publish-interval-millis

Annotations |
    This setting applies to all table types, and is used to specify in milliseconds the amount of delay before publishing data from the table; this condition is known as conflation of data. Set this attribute to a positive, non-zero integer ≥ 5 to specify conflation for this table. A value below 5, including zero and all negative numbers, is forced equal to 5. Static aggregation tables have an internal setting that is the equivalent of setting publish-interval-millis=1000 (1 second). For such tables, you cannot disable conflation, but you can change the conflation interval by setting publish-interval-millis to a different integer value. For all other table types, specify a value for publish-interval-millis to both enable conflation and to specify the conflation interval. To disable conflation for non-aggregation tables, remove the publish-interval-millis attribute entirely from your table’s lvconf entry.
    Without conflation, data is published from a table as soon as it is received. With conflation enabled, all downstream components see conflated data, including alerts, LiveView Desktop, clients built with the Java or .NET APIs, or another table in a transformation sequence. If an alert is set for a conflated table, be aware that it is possible for conditions that would otherwise trigger an alert to occur briefly during a conflation period; in this case, the trigger conditions are conflated away and the alert does not trigger. See the Data Conflation topic in the LiveView Reference Guide for further information.
Type | xs:positiveInteger
Properties |
content | simple
Used by |
Element | liveview-configuration/alert-table/alerts/alert

Attribute liveview-configuration / application / @id

Annotations |
    Identifier for this application, which must be the same as the basename of the file that defines this app.
Type | name-type
Properties |
use | required
Facets |
pattern | [a-zA-Z]\S* |
Used by |
Element | liveview-configuration/application

Attribute liveview-configuration / expr-macro / parameters / parameter / @name

Annotations |
    Case-sensitive parameter name.
Type | name-type
Properties |
use | required
Facets |
pattern | [a-zA-Z]\S* |
Used by |
Element | liveview-configuration/expr-macro/parameters/parameter

Attribute liveview-configuration / expr-macro / parameters / parameter / @default-value

Annotations |
    Optional default value for this parameter. Since parameters are fulfilled in order, if one parameter is unspecified (using the default), then all parameters after it must also be left unspecified.
Type | xs:string
Properties |
content | simple
Used by |
Element | liveview-configuration/expr-macro/parameters/parameter

Attribute liveview-configuration / expr-macro / @id

Annotations |
    Identifier for this expression.
Type | name-type
Properties |
use | required
Facets |
pattern | [a-zA-Z]\S* |
Used by |
Element | liveview-configuration/expr-macro

Attribute liveview-configuration / table-space / memory / @memory-for-sbargen

Annotations |
    Maximum amount of memory used to generate an SBAR for the table.
Type | xs:string
Properties |
default | 512m
Used by |
Element | liveview-configuration/table-space/memory

Attribute liveview-configuration / table-space / memory / @stacksize-for-sbargen

Annotations |
    Maximum stack size used to generate an SBAR for the table.
Type | xs:string
Properties |
default | 512k
Used by |
Element | liveview-configuration/table-space/memory

Attribute liveview-configuration / table-space / memory / @min-eval-cache-entries

Annotations |
    Optional setting for optimizing the cache size used for storing query predicates against a table in this table-space. The size is allocated for each table in the table-space.
Type | xs:positiveInteger
Properties |
default | 1000
Used by |
Element | liveview-configuration/table-space/memory

Attribute liveview-configuration / table-space / memory / @max-eval-cache-entries

Annotations |
    Optional setting for optimizing the cache size used for storing query predicates against a table in this table-space. The size is allocated for each table in the table-space.
Type | xs:positiveInteger
Properties |
default | 1000
Used by |
Element | liveview-configuration/table-space/memory

Attribute liveview-configuration / table-space / persistence / @persist-data

Annotations |
    If true, a table's data is to be persisted to a transaction log.
Type | xs:boolean
Properties |
content | simple
Used by |
Element | liveview-configuration/table-space/persistence

Attribute liveview-configuration / table-space / persistence / @peer-uri-list

Annotations |
    If persistence is enabled, this is the comma seperated list of LiveView URIs that should be used as recovery peers.
Type | xs:string
Properties |
content | simple
Used by |
Element | liveview-configuration/table-space/persistence

Attribute liveview-configuration / table-space / persistence / @folder

Annotations |
    If persistence is enabled, this is the base folder where a table's data is stored.
Type | restriction of xs:string
Properties |
content | simple
Facets |
pattern | [^\\]* |
Used by |
Element | liveview-configuration/table-space/persistence

Attribute liveview-configuration / table-space / persistence / @restore-data-on-start

Annotations |
    If true, a table is to be re-populated from its persisted log.
Type | xs:boolean
Properties |
use | required
Used by |
Element | liveview-configuration/table-space/persistence

Attribute liveview-configuration / table-space / @id

Annotations |
    Identifier for this table-space, which must be the same as the basename of the file that defines this table-space.
Type | name-type
Properties |
use | required
Facets |
pattern | [a-zA-Z]\S* |
Used by |
Element | liveview-configuration/table-space

Attribute liveview-configuration / table-space / @table-group

Annotations |
    Expose this table to the named table groups (comma-separated). A remote configuration can then query this table.
Type | xs:string
Properties |
content | simple
Used by |
Element | liveview-configuration/table-space

Attribute liveview-configuration / table-space / @snapshot-parallelism

Annotations |
    Defines the number of table partitions and the number of parallel regions used to scan a table during the snapshot portion of a query.
Type | xs:positiveInteger
Properties |
default | 1
Used by |
Element | liveview-configuration/table-space

Attribute liveview-configuration / table-space / @snapshot-concurrency

Annotations |
    Defines the maximum number of snapshot queries (one per thread) within a partition that are executed at once.
Type | xs:nonNegativeInteger
Properties |
default | 0
Used by |
Element | liveview-configuration/table-space

Attribute publisher-type / tables / table / @table-ref

Annotations |
    A reference to a table being published to.
Type | xs:string
Properties |
use | required
Used by |
Element | publisher-type/tables/table

Attribute publisher-type / @id

Annotations |
    Identifier for this publisher.
Type | name-type
Properties |
use | required
Facets |
pattern | [a-zA-Z]\S* |
Used by |
Complex Type | publisher-type

Attribute publisher-type / @description

Annotations |
    Long description.
Type | xs:string
Properties |
content | simple
Used by |
Complex Type | publisher-type

Attribute publisher-type / @short-description

Annotations |
    Short description.
Type | xs:string
Properties |
content | simple
Used by |
Complex Type | publisher-type

Attribute publisher-type / @filename

Annotations |
    Filename of the embedded publisher StreamBase application. This file is located using the project's module search path.
Type | xs:string
Properties |
use | optional
Used by |
Complex Type | publisher-type

Attribute publisher-type / @module

Annotations |
    Module for the embedded publisher StreamBase application. This module is located using the project's module search path.
Type | xs:string
Properties |
use | optional
Used by |
Complex Type | publisher-type

Attribute data-source-ref-type / @name

Annotations |
    Reference to a data source defined in sbd.sbconf.
Type | xs:string
Properties |
use | required
Used by |
Complex Type | data-source-ref-type

Attribute liveview-configuration / jdbc-table / @id

Annotations |
    Identifier for this jdbc-table, which must be the same as the basename of the file that defines this jdbc-table.
Type | name-type
Properties |
use | required
Facets |
pattern | [a-zA-Z]\S* |
Used by |
Element | liveview-configuration/jdbc-table

Attribute liveview-configuration / jdbc-table / @description

Annotations |
    Long description.
Type | xs:string
Properties |
content | simple
Used by |
Element | liveview-configuration/jdbc-table

Attribute liveview-configuration / jdbc-table / @group

Annotations |
    Optional logical grouping for a table.
Type | name-type
Properties |
content | simple
Facets |
pattern | [a-zA-Z]\S* |
Used by |
Element | liveview-configuration/jdbc-table

Attribute liveview-configuration / jdbc-table / @short-description

Annotations |
    Short description.
Type | xs:string
Properties |
content | simple
Used by |
Element | liveview-configuration/jdbc-table