Versions Compared

Key

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

...

Optional description of import activity. Used for reference purposes only

importStateActivity

Image AddedImage Removed
Elements of the ImportStateActivity section.

...

Root element for importing longitudinal profile time series resulting from the run of the external modules. Multiple elements may be defined. importFile and timeSeriesSet should be defined.

Optional description of import activity. Used for reference purposes only 

importCsvModuleRunTablesActivity (since 2015.01)

Root element for importing csv files that can be displayed using the ModuleRunTableDisplay component. See (TODO link to the gui component)

Elements of the importCsvModuleRunTablesActivity section.

  • charset- Optional charset used for reading the csv file. Defaults to ISO-8859-1.
  • description - Optional description only used for reference.
  • importFile - Path and name of a csv file from the model. This file will be imported.
  • displayName - name used to display the import file name in the ModuleRunTableDisplay component.
  • table - mapping of column names to displayNames and types that will be used to store in the FEWS database. If a column isn't mapped the csv column name is used as displayName and String is used as column type. The following types can be mapped:
    • stringColumn - the name attribute maps the csvColumn name to a displayName and 
  • expiryTime - Optional. When the state is an intermediate result in a forecast run you can make the state expire. By default the expiry time is the same as for the module instance run.
  • synchLevel - Optional synch level for state. Defaults to 0 is not specified (i.e. same as data generated by the forecast run)

Configuration example:

New example that does not use a pi state description xml file. In this case, the output state file paths are configured directly in the importStateActivity as absolute paths:

Code Block
xml
xml
		<importActivities>
			<importCsvModuleRunTablesActivity>
				<charset>UTF-8</charset>
				<description>Csv Module Data Activity Test case.</description>
				<importFile>import_csv_module_test1.csv</importFile>
				<displayName>Import CSV Module Test1</displayName>
				<table>
					<!-- Map de following CSV definition:
								DateTime;Status;Boolean;Integer;Float;Double;String
								2003-02-22 00:00;Ok;yes;14;1.4;1.45;Hello world 1
								2003-02-23 00:00;Not Ok;;true;24;2.4;2.45;Hello world 2
					-->
					<dateTimeColumn name="DateTime" displayName="datum" pattern="yyyy-MM-dd HH:ss"/>
					<stringColumn name="Status" displayName="status field"/>
					<booleanColumn name="Boolean" displayName="Yes or No"/>
					<integerColumn name="Integer" displayName="Int field"/>
					<doubleColumn name="Double" displayName="Double field"/>
					<stringColumn name="String" displayName="String field"/>
				</table>
			</importCsvModuleRunTablesActivity>
		</importActivities>



 

Shutdown Activities


Elements of the Shutdown Activities configuration
This activity is the identical to the startUpActivities. The only difference is that these are carried out after the module run and import of data. See definition of StartUp activities for configuration.