Skip to content

StateDMI / Command / SplitStateModReport

Overview

The SplitStateModReport command splits a StateMod report file into separate files for each model node identifier. This output can be used to publish datasets on the web, so that reports are of manageable size and load quickly in a web browser.

Command Editor

The following dialog is used to edit the command and illustrates the command syntax.

SplitStateModReport

SplitStateModReport Command Editor (see also the full-size image)

Command Syntax

The command syntax is as follows:

SplitStateModReport(Parameter="Value",...)

Command Parameters

Parameter                                       Description Default          
ReportFile
required		 The relative or absolute path to the report file. ${Property} syntax is recognized. None – must be specified.
OutputFolder
required		 The relative or absolute path to the report file. ${Property} syntax is recognized. None – must be specified.
OutputFile
required		 The output file name pattern. Use NODEID to indicate the station node ID, which will be replaced with the actual node identifier in the output file name. ${Property} syntax is recognized. None – must be specified.
IfOutputFolderDoesNotExist Action to take if the output folder does not exist:
  • Create - create the folder and if necessary any parent folders
  • Warn - generate a warning message and do not continue running the command
  • Fail - generate a failure message and do not continue running the command
 Warn
ListInResults Whether to list output files in the TSTool Results area. This can lead to a large number of files being listed, but does allow the files to be selected from TSTool for viewing. True

Examples

See the automated tests.

Troubleshooting

See Also