Page History

...

Configuration

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

...

If used, only manual changed to the data will be exported.

properties

Here properties for specific serializers can be configured. For example for the NetCDFSerializers the following properties will be taken into account:

includecomments

Export comment for each time step to NetCDF, default false

 includeFlags 

Export flag for each time step to NetCDF, default false

 includeTSProperties

Export time series properties for each time step to NetCDF, default false

 tryCompactingNetCDFData

Depending on the difference between the minimum and maximum and the value resolution of a netcdf variable, try to use smaller sized integer variables like short or byte to compact the data. A scale factor and offset will be used to fit the data in the smaller sized variable and will added to the netCDF variable as attributes. All standard netCDF viewers will take these attributes into account automatically, but other tools and especially scripts might not. This property will be false by default.

<properties>
   <bool key="includeComments" value="true"/>
   <bool key="includeFlags" value="true"/>
   <bool key="includeTSProperties" value="true"/>
   <bool key="tryCompactingNetCDFData" value="true"/>
</properties>

metadata

Optional metadata that is written in the exported file. The options netcdfMapDPhase and alertMapDPhase are deprecated (do not use these). For the other options it is possible to use the following tags:
%TIME_ZERO% the T0 of this time series export run.
%CURRENT_TIME% the current time.
%MODULE_INSTANCE_ID% the id of this module instance.
%MODULE_INSTANCE_NAME% the name of this module instance.
%MODULE_INSTANCE_DESCRIPTION% the configured description of this module instance.
%WORKFLOW_ID% the id of the workflow in which this export runs.
%WORKFLOW_NAME% the name of the workflow in which this export runs.
%WORKFLOW_DESCRIPTION% the configured description of the workflow in which this export runs.
%USER_ID% the id of the user by which this export run is executed.

Configuration example of metadata:

<metadata>
	<title>title</title>
	<institution>  institution  </institution>
	<source>source</source>
	<history>Exported at time zero = %TIME_ZERO(yyyy/MM/dd HH:mm:ss z)% in module instance %MODULE_INSTANCE_ID% as part of workflow %WORKFLOW_NAME% by user %USER_ID%.</history>
	<references>references</references>
	<comment>The actual time of writing was %CURRENT_TIME(yyyy-MM-dd HH:mm:ss z)%</comment>
	<summary>A summary of the data</summary>
	<keyword>keyword1</keyword>
	<keyword>  keyword  with  lots  of  spaces  </keyword>
	<keyword>keyword 3</keyword>
	<customAttributes>
		<string key="emptyAttribute" value="    "/>
		<int key="  custom2  " value="123456"/>
		<string key="custom_3" value="This is a custom attribute with 'quotes' in it."/>
		<string key="    " value="attribute with empty key specified is not written"/>
		<float key="just_another_float" value="3.5"/>
		<bool key="truth" value="true"/>
	</customAttributes>
</metadata>

...