Structure of the retrieval styles file

The retrieval styles file has the following structure:

XML header

Style collection

Retrieval style 1

Style names for different locales

Duration range 1

Retrieval type 1

...

Retrieval type n

Duration range 2

...

Duration range n

Retrieval style 2

...

Retrieval style n

End of style collection

That is:

• The file contains exactly one style collection, represented by the styleCollection XML element. For more information, see styleCollection XML Element.

• The style collection contains one or more retrieval styles, represented by the retrievalStyle XML element. Each of these represents a style that is available for use in the Trend application. For more information, see retrievalStyle XML Element.

• Each retrieval style contains one or more duration ranges, represented by the duration XML element. A duration range defines the retrieval types that are to be used for trend queries whose duration is within a specified range. Duration ranges should be arranged in descending length. For more information, see duration XML Element.

• Each duration range contains one or more retrieval types, represented by the retrieval XML element. The retrieval type defines the retrieval options that are to be used for tags of a certain type. For more information, see retrieval XML Element.

The retrieval type that gets used for a given tag is determined as follows:

1. You select a retrieval style in the Trend application.

2. The Trend application searches that retrieval style for a duration range that covers the duration of your trend. This would be the first duration range with a time period that is shorter than the trend duration.

3. When it has found a suitable duration range, it searches that duration range for a retrieval type that suits the type of the tag.

A simple example file might look like this:

<?xml version="1.0" encoding="utf-8" ?>

<styleCollection version="9.2" xmlns="urn:retrievalstyle-schema">

<retrievalStyle server="InSQL" minVersion="8.0" maxVersion="9.0" enabled="true">

<styleName locale="en">My style</styleName>

<styleName locale="ja">My style in Japanese</styleName>

<styleName locale="zh-CN">My style in Chinese</styleName>

<styleName locale="de">My style in German</styleName>

<styleName locale="fr">My style in French</styleName>

<duration minSpan="P0Y0M1DT0H0M0S">

<retrieval tagType="Discrete" source="History" retrievalMode="Delta" stateCalc="*" resolution="0" pixels="0" movingAverageValues="0" />

<retrieval tagType="All" source="History" retrievalMode="Cyclic" stateCalc="*" resolution="0" pixels="5" movingAverageValues="0" />

</duration>

<duration minSpan="P0Y0M0DT0H0M0S">

<retrieval tagType="All" source="History" retrievalMode="Delta" stateCalc="*" resolution="0" pixels="0" movingAverageValues="0" />

</duration>

</retrievalStyle>

</styleCollection>

In this case, the file only defines one style named My style. When querying two days of data for a discrete tag using this style, delta retrieval is used (the first retrieval element in the first duration element). For an analog tag, cyclic retrieval with one cycle for every five pixels of the trend width is used instead (the second retrieval element in the first duration element). For queries that are shorter than one day, delta retrieval is used regardless of the tag type (the only retrieval element in the second duration element).