This is the multi-page printable view of this section. Click here to print.

Return to the regular view of this page.

D

1 - Dashboard

A Dashboard is a configurable entity for querying one or more Data Sources and displaying the results as a table, a visualisation or some other form.

2 - Data source

The source of data for a Query, e.g. a Lucene based Index, a SQL Statistics Data source, etc.

There are three types of Data source:

  • Lucene based search index data sources.
  • Stroom’s SQL Statistics data sources.
  • Searchable data sources for searching the internals of Stroom.

A data source will have a Doc Ref Doc Ref A Doc Ref (or Document Reference) is an identifier used to identify most documents/entities in Stroom, e.g. an XSLT will have a Doc Ref.Click to see more details... to identify it and will define the set of Fields Field A named data Field within some form of record or entity, and where each Field can have an associated value. In Stroom, Fields can be the Fields in an Index (or other queryable Data Source or the fields of Metadata associated with a Stream, e.g. Stream ID, Feed, creation time, etc.Click to see more details... that it presents. Each Field will have:

  • A name
  • A set of Conditions Condition A Condition in an query expression term, e.g. =, >, in, etc.Click to see more details... that it supports. E.g. a Feed field would likely support is but not >.
  • A flag to indicate if it is queryable or not. I.e. a queryable field could be referenced in the query expression tree and in a Dashboard Dashboard A Dashboard is a configurable entity for querying one or more Data Sources and displaying the results as a table, a visualisation or some other form.Click to see more details... table, but a non-queryable field could only be referenced in the Dashboard table.

3 - Data splitter

Data Splitter is a pipeline element for converting text data (e.g. CSV, fixed width, delimited, multi-line) into XML for onward processing.

4 - Dictionary

A entity for storing static content, e.g. lists of terms for use in a query with the in dictionary condition. They can also be used to hold arbitrary text for use in XSLT with the dictionary function.

5 - Doc Ref

A Doc Ref (or Document Reference) is an identifier used to identify most documents/entities in Stroom, e.g. an XSLT will have a Doc Ref.

It is comprised of the following parts:

  • UUID UUID A Universally Unique Identifier for uniquely identifying something. UUIDs are used as the identifier in Doc Refs. An example of a UUID is 4ffeb895-53c9-40d6-bf33-3ef025401ad3.Click to see more details... - A Universally Unique Identifier to uniquely identify the document/entity.
  • Type - The type of the document/entity, e.g. Index, XSLT, Dashboard, etc.
  • Name - The name given to the document/entity.

Doc Refs are used heavily in the REST API for identifying the document/entity to be acted on.

6 - Document

Typically refers to an item that can be created in the Explorer Tree, e.g. a Feed, a Pipeline, a Dashboard, etc. May also be known as an Entity.

7 - Document permission

Document permissions control the access that users and/or groups have to a Document.