Versions Compared

Key

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

...

Output file name for this report.

The following tags can be used to customize the file output name:

  • %LOCATIONID%
  •  %TIMESERIES_POSTFIX(dateFormatId)%
  •  %CURRENTTIME(dateFormatId)%
  •  %TIMEZERO(reportVariableId;dateFormatId)%


%LOCATIONID%

If singleLocation is true, then can use tag %LOCATIONID% here, which will be replaced with the id of the location of the report. If singleLocation is true, and the %LOCATIONID% tag is not present, then a "_" sign and the id of the location of the report will be inserted automatically just before the "." sign in the filename.

Additionally, if singleLocation is true, then outputFileName can contain location attribute ids, e.g. "H_ (BASIN)", where tags between "@" signs refer to location attributes that are defined in the locationSets config file. These tags will be replaced with the corresponding attribute values of the location of the report. These values can be different for different locations. See 22 Locations and attributes defined in CSV files, Shape-DBF files or external tables for more information. If required to use a "@" sign in this element without using locationAttributes, then need to add an extra escape character "@" before each "@" sign. In other words "@@" is replaced with a single "@" sign.

%TIMESERIES_POSTFIX%

The TIMESERIES_POSTFIX tag will be replaced by the minimum date of the configured timeSeries in the report. If no timeSeries have been configured, the system date will be usedIt's also possible to generate a Timeseries based postfix in the filename using the %TIMESERIES_POSTFIX% tag. An optional dateFormat id can be specified. For example:%TIMESERIES %TIMESERIES_POSTFIX(dateFormatId)% where dateFormatId is the id of a dateFormat as specified in the reports declarations. 
If  If no dateFormatId is passed: %TIMESERIES_POSTFIX%, the default date format ddmmyyyym will be used. 

%CURRENTTIME%

The CURRENTTIME tag will be replaced by the current system time. An optional dateFormat id can be specified (see TIMESERIES_POSTFIX). 

%TIMEZERO%

The TIMEZERO tag will be replaced by the minimum T0 of the timeSeries configured by the reportVariableId. If no timeseries are configured, the current system time will be used. The reportVariableId is required. The dateFormatid is optional.

N.B.: Be careful in specifying date formats that are compatible with the filesystem. For example and : in the dateformat will not be compatible with the windows filesystem.

The value that will be replaced for TIMESERIES_POSTFIX is set to the minimum date of the configured timeSeries in the report. If no timeSeries have been configured, the system date will be used. 

DefineLocal

The DefineLocal element can be used to enter some information that is valid for a single report. Multiple DefineLocal elements may be defined, as long as the ID attribute is kept unique.

...