Versions Compared

Key

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

...

Excerpt
hiddentrue

Exports data to several file formats

Table of Contents

Configuration

The export module can export timeseries for use in other systems. The configuration of the module is split into three sections:

...

In the sections below the different elements of the configuration are described

General

description

An optional description

exportTypeStandard

This type specifies which reader should be used to read the file. The type must be one from the enumeration. Presently (2007/02) only bfg and pi are included in this list.

exportType

This type specifies which reader should be used to read the file. It may be any string as long as this type is supported by the TimeSeriesExport module. The list of supported types is given below.

folder

Folder (directory) in which to store the exported files.

exportFileName

This elements describes how to construct the filename(s) of the exported file(s).

If only the name element is given a fixed name is used for each export. The prefix and suffix elements describe how to create a filename prefix and/or suffix. The temporaryPrefix is used to generate a prefix for the temporary file as it is being written. After that the fine is renamed.

validate

Optional element. Only applicable if the data are exported to the xml-file. This option activates the validation of the exported file against a XML schema.

idmapId

Id of IdMap to be used for parameterId and locationId mapping

unitConversionsId

Id of UnitConversions to be used for unit mapping

flagConversionsId

Id of flagConversions to be used for flag mapping

exportMissingValue/exportMissingValueString

Missing value definition for this time series. Either a string or a number. Defaults to NaN if not defined.

omitMissingValues

If set to true records with missing values are not exported

exportTimeZone

TimeZone in which to export the data. Can either be a string (timeZoneName) or an offset (timeZoneOffset).

convertDatum

Convert datum to local datum during import. The conversion will be done for all parameters which use datum (as configured in Parameters.xml) The local datum is defined in the z element in the locations.xml file.

metadata

TO BE COMPLETED

timeseriesSet

Define the timesereisset to be exported. Please make sure that no all exports support all timeseriestypes (e.g. csv only supports scalar type)