Create Input and Result Data Shapes
If an analysis provider does not support the auto-generation of the input and result data structures, you can create these data shapes manually.
Complete the following steps to create input and results data shapes:
1. Click > , or select a model and click Edit.
2. Under Configure Data Shapes, select Create Data Shapes from the Data Shape Generation drop-down list.
3. Depending on the type of data shape you are creating, select either Input Data Shape or Result Data Shape from the left navigation pane.
The Create Data Shapes window contains four different sections:
◦ Data Structure — Displays the data structure that has been defined in the form of a tree.
◦ Composed Data Fields — A table that lists the direct descendants of the field selected in the data structure tree, if any exists.
◦ Selected Field Properties — Displays the properties of the field selected in the data structure tree.
◦ Composed Field Properties — Allows you to add or update a field to the parent field selected in the data structure tree.
▪ Ordinal — Must be an integer and unique within the parent data structure. A sequence number for the field that is used in arranging the data structure for display.
▪ Field Name — The name of the field to add. The name must be unique across the entire data structure.
▪ Base Type — The type of the field. Allowed values are INTEGER, LONG, NUMBER, STRING, and INFOTABLE. This must be entered in all capital letters.
▪ Unit — A string representing unit of the field. For example, the unit of velocity is m/s or ft/sec.
▪ Default Value — The default value of the field. If not provided, the system defaults to an equivalent of zero or empty string based on the data type.
▪ Min Value — Minimum value for the field value.
▪ Max Value — Maximum value for the field value.
▪ Description — Description for the field.
4. Once you have entered the necessary values in the Composed Field Properties section, click Add or Update Field.
5. After adding or updating fields, click Save to create the data shapes.
|
|
The default naming convention of the data shape is the provider name, model name, and either InputParamsDataShape or ResultDataShape separated by '.'. This allows data shape names to be easily recognizable. This is also recommended if data shapes are created manually.
For example, the default name of an input data shape for MyModel associated with MyProvider is MyProvider.MyModel.InputParamsDataShape, and the default name of the result data shape is MyProvider.MyModel.ResultDataShape.
|
