Page History

h4. ExportTimeSeriesActivity

!ExportTimeSeriesActivityComplexType.png!
Figure 71 Elements of the exportTimeSeries section
\\

h5. description

Optional description of the timeSeries export configuration.
\\

h5. exportFile

Name (and location) of the PI-XML file with exported time series. If the directory location is not explicitly specified the file will be written in the exportDir defined in the general section.
\\

h5. exportBinFile

When true the events in the PI time series file are written to a binary file instead of the xml file. The written xml file will only contain the time series headers and optionally a time zone. The binary file has the same name as the xml file only the extension is "bin" instead of "xml". During PI time series import the bin file is automatically read when available. The byte order in the bin file is always Intel x86.

h5. ignoreRunPeriod

When true the run period, written in the pi run file, will not be extended.

h5. includeThresholds

When true any thresholds for the exported timeseries will be written in the timeserie headers

h5. timeSerieSets

Root element for defining timeSerieSets to be exported.
\\

h5. timeSerieSets: timeSerieSet

TimeSeriesSets to be exported. These may contain either a (list of) locations or a locationSet. Multiple entries may be defined.

h5. omitMissingValues

Are missing values to be written to the export file or should they be left out.

h5. omitEmptyTimeSeries

When true, a series is not exported when the time series is empty (or when omitMissingValues = true, when the time series is empty after removing the missing values.)

h5. forecastSelectionPeriod

Can be used to select all approved forecasts with a forecast start time lying within this period
\\
\\

h4. ExportMapStacksActivity

\\

!image015.png!
Figure 72 Elements of the ExportMapStacksActivity.
\\

h5. description

Optional description of the timeSeries export configuration.
\\

h5. exportFile

Name (and location) of the PI-XML file describing the map stack of the exported grid time series. If the directory location is not explicitly specified the file will be written in the exportDir defined in the general section.
\\

h5. gridFile

Root element for defining file name of grid to be exported
\\

h5. locationId

LocationId for grid to be exported.
\\

h5. gridName

Name of the files for the grid to be exported. For grid files where each time slice is stored in a different file, this name is the prefix for the full file name. The final file name is created using an index of files exported (e.g the file name for the 4^th\^ time step is grid00000.004).
\\

h5. gridFormat

Format of the exported grid. Enumeration of options include;
* _asc_ : for exporting to ARC-INFO ASCII grid format
* _pcrgrid_ : for exporting to PCRaster native grid file format
* _usgsdem_ : for exporting to USGS DEM format (BIL)
\\
h5. timeSerieSet

TimeSeriesSets to be exported. These should contain only one locationId. For exporting multiple grids, multiple exportMapStack activities should be defined.

\\

h4. exportProfilesActivity

Configuration of the exportProfiles activity is identical to the exportTimeSeries Activity.
!image016.png!\\
\\

h4. ExportDataSetActvity

!image017.png!
Figure 73 Elements of the exportDataSets section
\\

h5. description

Optional description of the module dataset export configuration.
\\

h5. moduleInstanceId

Optional reference to the moduleInstanceId of the moduleDataSet to be exported. If not defined the moduleInstanceId of the current module instance is taken as a default (see section on Module Datasets and Parameters).
\\
\\

h4. ExportParameterActivity

!image018.png!
Figure 74 Elements of the exportParameter section
\\

h5. description

Optional description of the module parameter configuration.
\\

h5. moduleInstanceId

Optional reference to the moduleInstanceId of the moduleParameter to be exported. If not defined the moduleInstanceId of the current module instance is taken as a default (see section on Module Datasets and Parameters)
\\

h5. fileName

Name (and location) of the PI-XML file with exported parameters. If the directory location is not explicitly specified the file will be written in the exportDir defined in the general section.
\\
\\

h4. ExportTableActivity

!ExportTableActivity.png!
Figure 1 Elements of the ExportTableActivity configuration

h5. description

Optional description of the ExportTableActivity configuration.
\\

h5. exportFile

File to which the table will be exported. This file is always placed in exportDir.
\\

h5. tableType

Type of table to be exported. Currently enumeration must be "ratingCurve"
\\

h5. operation

ID of the table to be exported.
\\

h5. parameters

Parameters for the convertEquation operation. Must include minimumLevel, maximumLevel and stepSize
\\

h5. locationId/locationSetId

location id to select the rating curve
\\
\\

h4. exportNetcdfActivity

!ExportNetcdfActivity.png!
Figure 2 Elements of the ExportNetcdfActivity configuration

h5. description

Optional description of the ExportNetcdfActivity configuration.
\\

h5. exportFile

File to which the data will be exported. This file is always placed in exportDir.
\\

h5. timeSeriesSets

TimeSeriesSet that defines what data is to be exported.
\\

h5. omitMissingValues

Are missing values to be written to the export file or should they be left out.
\\

h5. omitEmptyTimeSeries

The time series is not exported when the time series is empty or when; omitMissingValues = true and the time series is empty after removing the missing values.
\\
\\

h4. ExportRunFileActivity

!ExportRunFileActivity.png!
Figure 3 Elements of the ExportRunFileActivity configuration

h5. description

Optional description of the ExportRunFileActivity configuration.
\\

h5. exportFile

File to which the data will be exported. This file is always placed in exportDir.
\\

h5. properties

Kind of environment variables for the pre and post adapters. These properties are copied to the run file. This is also a convenient way to pass global properties to a pre or post adapter. An adapter is not allowed to access the FEWS global.properties directly. Global properties (between $) are replace by there literal values before copied to the run file. These extra options makes an additional pre or post adapter configuration file unnecessary.

Options:

* string
* int
* float
* bool

\\

example of exported run file
{code:xml}
<?xml version="1.0" encoding="UTF-8"?>
<Run xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.wldelft.nl/fews/PI" xsi:schemaLocation="http://www.wldelft.nl/fews/PI http://fews.wldelft.nl/schemas/version1.0/pi-schemas/pi_run.xsd" version="1.5">
	<logLevel>info</logLevel>
    <timeZone>0.0</timeZone>
    <startDateTime date="1900-01-01" time="00:00:00"/>
    <endDateTime date="2100-01-01" time="00:00:00"/>
    <time0 date="2000-01-01" time="00:00:00"/>
    <workDir>workdir</workDir>
    <outputDiagnosticFile>diagnostic</outputDiagnosticFile>
</Run>