Dataset
This defines the location of the XML datafiles which comprise the application’s datasets.
More than one dataset directory may be specified, with a unique combination of:
- Dataset Type.
- Dataset Prefix.
At least one dataset directory must be defined, unless your application really has no datasets. I.e. your application consists entirely of exec and plugin actions.
If multiple dataset_dir
entries are defined, they must each have a unique prefix
.
Attribute | Default | Notes |
---|---|---|
prefix |
<empty-string> |
This is the prefix for incoming dataset names which determine which dataset_dir entry is used for locating the matching datasets. If omitted/empty then all dataset names will match.A trailing . is automatically added to the prefix. If an incoming dataset name matches multiple dataset_dirs the longest-matching prefix is used. |
type |
dbi |
Specify the type of datasets contained within this directory. • dbi (SQL databases using default DBI driver).• sdp (SSAS data pump via SOAP requests).• mongo (MongoDB via MongoDB driver).This is used to locate a suitable database definition for executing the dataset. |
dbname |
default |
Specifies the default database name to use for datasets in this directory. Can be overridden on a per-dataset basis. |
[content] |
(none) | The content inside the <dataset_dir> element is the path to the directory within the server file system. |
Note the following:
- The client-supplied dataset name must not include the
.xml
suffix added by the server. - The matched prefix is stripped from the dataset name before expansion.
- The dataset name specified by the client must consist only of characters from the following list:
a-z
,A-Z
,0-9
,_
(underscore),-
(hyphen) and.
(dot). - A
.
(dot) character in the dataset name is interpreted as a directory separator by Jarvis. On Unix-based systems this is a forward-slash. On Windows-based systems, Perl will translate the forward slash into a backslash. - A dataset name specified by the client may not start or end with a dot.
Consider the following examples for configuration:
<dataset_dir>/path/to/dataset</dataset_dir>
<dataset_dir prefix="other">/another/path</dataset_dir>
The final dataset location would be as follows:
Client Requests | Resulting XML File |
---|---|
my-set |
/path/to/dataset/my-set.xml |
.my-set |
[Error, may not start with dot] |
my-set. |
[Error, may not end with dot] |
folder.myset |
/path/to/dataset/folder/myset.xml |
myset.xml |
/path/to/dataset/myset/xml.xml |
other.set.name |
/another/path/set/name.xml |