Configuring report content¶
MIKE Workbench can produce Text, Table, Image and Report contents from many different sources. This section will describe configuration and formatting of each built-in content source.
Text¶
This is the simplest content source. It simply produces the text that user specifies.
Configuration - Text: this is the text that should be produced.
Formatting - No formatting for this content source.
Example output of text content source.
Indicator value¶
This content source returns a value that is represented by an indicator.
Configuration - Indicator: a path to a single indicator whose value should be returned as the content. (indicator can be dragged and dropped from indicator explorer or the indicator path can be entered by hand).
Formatting - Number format: specifies the precision with which indicator value will be displayed. - Boolean text: not applicable to indicator values. - Date format: not applicable to indicator values.
Example output of indicator content source.
Script text output¶
This content source returns text that is produced by a script.
Configuration - Script: a path to a script which will be executed to return text (script can be dragged and dropped from script explorer or the script path can be entered by hand). - Parameters: values of each script parameter that will be used when executing a script.
Formatting - No formatting for script text output (the script should format text as desired).
Example script. Input parameters are optional but the return value has to be of type string.
Example output of script text output content source.
Feature class attributes table¶
This content source returns a table of all feature attributes in a given feature class.
Configuration - Feature Class: A path to a single feature class whose features and attributes should be returned as the content. (feature class can be dragged and dropped from GIS explorer or the feature class path can be entered by hand).
Formatting - Number format: specifies the precision with which numeric attributes will be formatted. - Boolean text: specifies the text used for Boolean attributes. - Date format: specifies the formatting of date time attributes. - Include header names: if checked attribute names will be included as the first row of the table, otherwise only attribute values will be returned.
Example output of indicator content source.
Script table output¶
This content source returns a table that is produced by a script.
Configuration - Script: a path to a script which will be executed to return a table (script can be dragged and dropped from script explorer or the script path can be entered by hand). - Parameters: values of each script parameter that will be used when executing a script.
Formatting - No formatting for script table output (the script should format content of the table as desired).
Example script. Input parameters are optional but the return value has to be of type string[,].
Example output of script table output content source.
Spreadsheet table¶
This content source returns a table based on a cell range in a spreadsheet.
Configuration - Spreadsheet: a path to a single spreadsheet from where tabular data will be taken (spreadsheet can be dragged and dropped from the spreadsheet explorer or the spreadsheet path can be entered by hand) - Sheet name: Name of the sheet within the spreadsheet from where the tabular data will be taken. If left empty tabular data from first sheet will be taken. - Cell range: a range of cells within a sheet within a spreadsheet that define the range of data to be included in the result table. If left empty the whole used range within the selected sheet will be taken.
Formatting - Use original spreadsheet formatting: When checked, tabular data will be returned exactly as it appears in the spreadsheet (number formatting, date formatting, etc.). Otherwise data will be formatted according to Number format, Bollean text and Date format options. - Number format: specifies the precision with which numeric cells will be formatted. - Boolean text: specifies the text used for Boolean cells. - Date format: specifies the formatting of date time cells.
Example output of spreadsheet table content source.
Time series table¶
This content source returns a table of time series values.
Configuration - Time series: a path to one or more time series whose values should be returned as the content (time series can be dragged and dropped from time series explorer or the time series path can be entered by hand; in order to add more than one time series right click on the time series grid and select Add Time series or hold ++Ctrl++ key while dropping time series from time series exporer).
Formatting - Number format: specifies the precision with which time series values will be formatted. - Boolean text: not applicable. - Date format: specifies the formatting of date time time steps. - Include header names: if checked time series names will be included as the first row of the table, otherwise only values will be returned.
Example output of time series table content source.
Favorite image¶
This content source returns an image based on a saved favorite (gis map or time series plot).
Configuration - Favorite: a path to a single favorite from where the image will be generated (favorite can be dragged and dropped from the favorites explorer or the favorite path can be entered by hand).
Formatting - Image type: type of image that will be generated (Bmp, Gif, Jpeg, Png, Tiff). - Image width: Width (in pixels) of the created image. - Image height: Height (in pixels) of the created image
Example output of favorites image content source.
Script image output¶
This content source returns an image that is produced by a script.
Configuration - Script: a path to a script which will be executed to return an image (script can be dragged and dropped from script explorer or the script path can be entered by hand). - Parameters: values of each script parameter that will be used when executing a script.
Formatting - No formatting for script image output (the script should return the image of desired type and size).
Example script. Input parameters are optional but the return value has to be of type byte[].
Example output of script image output content source.
Spreadsheet image¶
This content source returns an image based on a spreadsheet cell range.
Configuration - Spreadsheet: a path to a single spreadsheet from where the image will be generated (spreadsheet can be dragged and dropped from the spreadsheet explorer or the spreadsheet path can be entered by hand).
Formatting - Image type: type of image that will be generated (Bmp, Gif, Jpeg, Png, Tiff).
Example output of favorites image content source.
Time series plot¶
This content source returns a time series plot image.
Configuration - Time series: a path to one or more time series which should be included in the plot (time series can be dragged and dropped from time series explorer or the time series path can be entered by hand; in order to add more than one time series right click on the time series grid and select Add Time series or hold ++Ctrl++ key while dropping time series from time series exporer). - Plot template: name of a time series plot template to be applied.
Formatting - Image type: type of image that will be generated (Bmp, Gif, Jpeg, Png, Tiff). - Image width: Width (in pixels) of the created image. - Image height: Height (in pixels) of the created image.
Example output of time series plot content source.
Report¶
This content source returns a report that will be used as a sub-report.
Configuration - Report definition: a path to a single report definition which will be used to generate the sub-report (report definition can be dragged and dropped from the report explorer or the report definition path can be entered by hand).
Formatting - No formatting for Report content source.
Report script output¶
This content source returns a report that is produced by a script.
Configuration - Script: a path to a script which will be executed to return a report (script can be dragged and dropped from script explorer or the script path can be entered by hand). - Parameters: values of each script parameter that will be used when executing a script.
Formatting - No formatting for Report script output content source.
Example script. Input parameters are optional but the return value has to be of type DHI.Solutions.ReportManager.Interfaces.IreportHandle.