Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Tag

Description

$CURRENTTIME(dateFormatId)$

The actual time the report was generated. This is the local time.

Arguments: 1
- dateFormatId: specified in the configuration file, sets the formatting for the date to be displayed

$LOCATIONNAME(variableId)$

The location name associated with a time series.

Arguments: 1
- variableId: refers to the variableId assigned to the time series in the report configuration.

$LOCATIONATTRIBUTE( attribute; variableId;<numberFormat>)$

Arguments: 2-3

-attribute: the location attribute to put in the report.

- variableId: refers to the variableId assigned to the time series in the report configuration.

- numberFormatId: specified in the configuration file, sets the formatting for the values to be displayed

$TIMEZERO(variableId; dateFormatId)$

The time zero of the forecast run in which the time series is created.

Arguments: 2
- variableId: refers to the variableId assigned to the time series in the report configuration.
- dateFormatId: specified in the configuration file, sets the formatting for the date to be displayed

$FIRSTVALUE(variableId; numberFormatId)$

the first reliable or doubtful value in the time series

Arguments: 1 or 2
- variableId: refers to the variableId assigned to the time series in the report configuration
- numberFormatId: specified in the report configuration, sets the formatting for the value to be displayed. In case of enumeration parameter, the numberformatId can be omitted and the enumeration label will be displayed

$FIRSTVALUETIME(variableId; dateFormatId)$

the date and time of the first reliable or doubtful value present in given time series array

Arguments: 2
- variableId: refers to the variableId assigned to the time series in the report configuration
- dateFormatId: specified in the report configuration, sets the formatting for the date to be displayed

$FIRSTVALUECOMMENT(variableId)$

the comment of the first reliable or doubtful value present in given time series array

Arguments: 1
- variableId: refers to the variableId assigned to the time series in the report configuration

$FIRSTVALUEATTRIBUTE(variableId; valueAttributeMapId)$

The attribute of the first reliable or doubtful value present in given time series array

Arguments: 2
- variableId: refers to the variableId assigned to the time series in the report configuration
- valueAttributeMapId: valueAttributeMap id from configuration file ValueAttributeMaps.xml

$LASTVALUE(variableId; numberFormatId)$

the most recent reliable or doubtful value in the time series

Arguments: 1 or 2
- variableId: refers to the variableId assigned to the time series in the report configuration
- numberFormatId: specified in the report configuration, sets the formatting for the value to be displayed. In case of enumeration parameter, the numberformatId can be omitted and the enumeration label will be displayed

$LASTVALUETIME(variableId; dateFormatId)$

the date and time of the most recent reliable or doubtful value present in given time series array

Arguments: 2
- variableId: refers to the variableId assigned to the time series in the report configuration
- dateFormatId: specified in the report configuration, sets the formatting for the date to be displayed

$LASTVALUECOMMENT(variableId)$

the comment of the most recent reliable or doubtful value present in given time series array

Arguments: 1
- variableId: refers to the variableId assigned to the time series in the report configuration

$LASTVALUEATTRIBUTE(variableId; valueAttributeMapId)$

The attribute of the most recent reliable or doubtful value present in given time series array

Arguments: 2
- variableId: refers to the variableId assigned to the time series in the report configuration
- valueAttributeMapId: valueAttributeMap id from configuration file ValueAttributeMaps.xml

$MINVALUE(variableId; numberFormatId)$

The minimum value found in the time series

Arguments: 2
- variableId: refers to the variableId assigned to the time series in the report configuration.
- numberFormatId: specified in the configuration file, sets the formatting for the values to be displayed

$MAXVALUE(variableId; numberFormatId)$

The maximum value found in the time series

Arguments: 2
- variableId: refers to the variableId assigned to the time series in the report configuration.
- dateFormatId: specified in the configuration file, sets the formatting for the date to be displayed

$MINTIME(variableId; dateFormatId)$

The date/time of minimum value found in the time series (closest occurrence to T0)

Arguments: 2
- variableId: refers to the variableId assigned to the time series in the report configuration.
- numberFormatId: specified in the configuration file, sets the formatting for the values to be displayed

$MAXTIME(variableId; dateFormatId)$

The date/time of maximum value found in the time series (closest occurrence to T0)

Arguments: 2
- variableId: refers to the variableId assigned to the time series in the report configuration.
- dateFormatId: specified in the configuration file, sets the formatting for the date to be displayed

$MAXWARNINGLEVEL(variableId, defaultThresholdGroupId)$

returns the name of the highest warning level threshold that has been crossed

Arguments: 2
- variableId: refers to the variableId assigned to the time series in the report configuration.
- defaultThresholdGroupId: refers to the thresholdGroup in thresholds.xml for which the defaultThreshold shortName should be used in case no thresholds have been crossed (optional since 2012.01).

$INDEXVALUE(timeSeriesIndex; variableId; numberFormatId)$

Template function to insert the value at a given timeIndex in a given timeSeries. The timeIndex should be specified relative to the index of timeZero of the workflow run. Index of time zero is 0. Configure negative index to get a value before time zero, and positive index to get a value after time zero.

Arguments: 3
- timeSeriesIndex: time index relative to the index of time zero of the workflow run.
- variableId: refers to the variableId assigned to the time series in the report configuration.
- numberFormatId: specified in the configuration file, sets the formatting for the value to be displayed.

$INDEXTIME(timeSeriesIndex; variableId; dateFormatId)$

Template function to insert the time at a given timeIndex in a given timeSeries. The timeIndex should be specified relative to the index of timeZero of the workflow run. Index of time zero is 0. Configure negative index to get a value before time zero, and positive index to get a value after time zero.

Arguments: 3
- timeSeriesIndex: time index relative to the index of time zero of the workflow run.
- variableId: refers to the variableId assigned to the time series in the report configuration.
- dateFormatId: specified in the configuration file, sets the formatting for the date and time to be displayed.

$INDEXMAXWARNINGLEVEL(timeSeriesIndex; variableId; defaultThresholdGroupId)$

Template function to insert the name of the most severe warning level of all thresholds that have been crossed for a given timeIndex in a given timeSeries. The timeIndex should be specified relative to the index of timeZero of the workflow run. Index of time zero is 0. Configure negative index to get a value before time zero, and positive index to get a value after time zero. If only one thresholdGroup or no thresholdGroups configured, then can leave out the optional argument defaultThresholdGroupId.

Arguments: 2 or 3
- timeSeriesIndex: time index relative to the index of time zero of the workflow run.
- variableId: refers to the variableId assigned to the time series in the report configuration.
- defaultThresholdGroupId: (optional) refers to the id of the thresholdGroup that should be used to get the name of the defaultThreshold when no threholds are crossed.

$INDEXMAXWARNINGLEVELCOLOR(timeSeriesIndex; variableId)$

Template function to insert the html color code (e.g. #FFFF00) of the most severe warning level of all thresholds that have been crossed for a given timeIndex in a given timeSeries. The timeIndex should be specified relative to the index of timeZero of the workflow run. Index of time zero is 0. Configure negative index to get a value before time zero, and positive index to get a value after time zero.

Arguments: 2
- timeSeriesIndex: time index relative to the index of time zero of the workflow run.
- variableId: refers to the variableId assigned to the time series in the report configuration.

$EXTERNALFORECASTINGSTARTTIME(variableId; dateFormatId)$

returns the start of the external forecast

Arguments: 2
- variableId: refers to the variableId assigned to the time series in the report configuration.
- dateFormatId: specified in the configuration file, sets the formatting for the date to be displayed

$FORECASTNAME(variableId)$

The name or description of the forecast.

Arguments: 1
- variableId: refers to the variableId assigned to the time series in the report configuration.

$DEFINITION(definitionId)$

The definition tag provides a means to enter some additional textual information into a report. This information can be set for all reports at once, through the defineGlobal element of the declarations section or for each report through the defineLocal element in the reports section.

Arguments: 1
- definitionId: refers to ID provided in either the defineLocal or defineGlobal elements. The defineLocalId takes preference over the defineGlobalId when both are the same.

$FILERESOURCE(resourceId)$

The fileresource tag provides a means to include an external file into the report. This may be any file, as long as it is permissible in the report file. The inclusion is

Arguments: 1
- resourceId: Refers to the ID given to the fileResource element in the reports section. The fileResource element specifies the location of the file to be included relative to the region 'home' directory.

$TABLE(tableId)$

Inserts a table. The layout of the table is defined in the report configuration files.

Arguments: 1
- tableId: ID of the table definition

$CHART(chartId)$

Inserts a reference to the filename of the chart. The chart is created in the same directory as the report file. The reference is inserted without any path prefixes. This feature will only be useful in XML or HTML report files.

Arguments: 1
- chartedchartId: ID of the chart definition (<chart /> or <displayChart /> element)

$SUMMARY(summaryId)$

Inserts a map with overlying text, symbols or values of configured timeseries. This is  a complex tag that requires substantial preparation in the configuration.

Arguments: 1
- summaryId: ID of the summary definition

$STATUS(statusId)$

Inserts a table created using a SQL query on the database. The table may be additionally formatted.

IMPORTANT: the HTML table header is not created by this TAG. The TAG only creates the records of the table. This has been made to enable the user to provide more user friendly header info than the field names.

Arguments: 1
- statusId: ID of the status definition

$LOGENTRY(eventCode)$

Inserts a log message using the eventCode as a 'filter' to retrieve certain types or error messages.

Arguments: 1
- logEntryEventCode: textual (case-sensitive) reference to a specific type of log message (e.g. TaskRun.Completed)

$FILECONTENT(fileName)$The filecontent tag provides a means to merge a referenced file into the report. Intended use is the possibility to merge different reports into one report that can be imported in for example MS Word.
 
  Arguments: 1  
- fileName:  Name of the file whose content will be Included. The location of the file to be included has to be relative to the template output directory.
$USERNAME()$

Inserts the users display name.

  Arguments: 0
 

 

$STATISTICS(statistical function; variableId;numberFormatId)$ Template function to insert the result of the given statistical function for the given timeSeries.
 
  Arguments: 2-3  
- statistical function  :  name of the statistical function to evaluate. Presently the followig functions are available:
COUNT, KURTOSIS, MEAN, MEDIAN, MIN, RMSQ, RSQUARED, SKEWNESS, STANDARD_DEVIATION, SUM, VARIANCE
- variableId  : refers to the variableId assigned to the time series in the report configuration.
- numberFormatId  :  optional, specified in the configuration file, sets the formatting for the values to be displayed
  

...