Contents
StreamBase LiveView configuration files are schema-defined XML files that:
-
Define the table space and tables that comprise an instance of LiveView.
-
Define applications, expression macros, and notification channels in a way that can be reused in multiple LiveView table configuration files.
Edit deployment files in Studio with the validating and syntax-aware LiveView Configuration File Editor, as described in ????. The XML syntax of LiveView configuration files is described in the LiveView Configuration XML Reference.
In these pages, LiveView configuration files are sometimes referred to with the shorthand term lvconf files.
Place all related LiveView configuration files that describe the same instance of LiveView in the same Studio project folder. For deployment, make sure all related lvconf files are in the same folder.
When placed in the same folder of your StreamBase Studio project, all
lvconf files can be validated together as a set. For example, a <table-space> definition in one file can be referenced by
table-space ID in the <data-table> files in the
set.
Similarly, the LiveView compiler reads and considers all lvconf files in the same folder when it generates a LiveView instance from a set of lvconf files.
StreamBase LiveView configuration files should be named with the
.lvconf extension, which allows Studio to assign the
correct editor. Using this extension is enforced when creating a new LiveView
configuration file in Studio.
The basename of each LiveView configuration file must be the same as the ID of the
primary element of the file. For example, an lvconf file that defines a <table-space> element as follows is named DefaultTablespace.lvconf:
<table-space id="DefaultTablespace"/>
The ID-as-basename standard is enforced by Studio.
LiveView configuration files use a schema-defined XML syntax. Studio validates each configuration file against its schema and decorates lvconf file icons with a red X in the Package Explorer view if it detects any unrecognized or unbalanced elements in the file:
|
The top-level element of a LiveView configuration file is <liveview-configuration>, which includes two namespace
declarations, as seen in this fragment:
<?xml version="1.0" encoding="UTF-8"?>
<liveview-configuration xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="http://www.streambase.com/schemas/lvconf/">
...
</liveview-configuration>
These declare the xsi namespace for the XML Schema
standard, and the unnamed default namespace for the LiveView configuration file
schema. These namespace declarations are what allow Studio's Deployment File Editor
to provide syntax color coding, autocompletion, and content assistance prompts.
The LiveView Configuration File Editor validates as you type, and places red markers in the right margin to direct you to the location of errors:
- Red square marker
-
Hover the mouse over the red square marker at the top of the right margin to see a count of the errors in the current file.
- Red rectangle marker
-
Hover the mouse over red rectangles in the right margin to see a report of the error at that line. In this example, the value of the
idattribute is missing its closing quote:
To force validation against the schema of each lvconf file individually, select the
file in the Package Explorer view, right-click, and select from the context menu. This places red X (
) markers in the left
margin and on the file's entry in the Package Explorer view. These errors also show
in Studio's Problems view.
To force validation of the full set of lvconf files in the current Studio project, select the project's name in the Package Explorer view, right-click, and select from the context menu.