Available Parameters for Reporting
Parameters available for use with SetParameter in the API
2 minute read
The value passed to SetParameter always has to be a string. It will get casted to the appropriate datatype as needed.
The datatype mentioned in the documentation only specifies the range of values that are expected to be provided in the passed string. The case of the passed parameter is inconsequential as it is transformed to uppercase whenever it’s used.
Numbertype Ranges (in order of appearance):
- Integer: -2,147,483,648 to 2,147,483,647
- Single: 7 significant digits, exponent -38 to +38
| Name | Datatype | Value Range | Description |
|---|---|---|---|
| SUBEXTRA | boolean | “TRUE”, “FALSE” | If set to “TRUE” toggles SubMainPositions for inside and outside view (default = false). Also groups SubElevations separately. |
| SHOW_GLASS_COLORS | boolean | “TRUE”, “FALSE” | If set to “True” custom filling colors will be displayed for glasses. |
| STEP_GLASS_PICTURE | boolean | “TRUE”, “FALSE” | If set to “TRUE” defines a glass picture as a stepglass (one glass pane is larger than the other(s)). |
| SHAPED_GLASS_PICTURE | boolean | “TRUE”, “FALSE” | If set to “TRUE” defines a glass picture as a shaped glass (presumably a non-square / -rectangle). |
| BWELEVATIONPICTURE | boolean | “TRUE”, “FALSE” | If set to “TRUE” defines a picture as black and white. |
| NOCALCULATION | boolean | “TRUE”, “FALSE” | If set to “TRUE” does not perform a calculation. |
| PRICECLASSES | boolean | “TRUE”, “FALSE” | If set to “TRUE” uses priceclasses. |
| REPORTOFFERTEXTS | boolean | “TRUE”, “FALSE” | If set to “TRUE” exports the report offer texts. This will override the settings from interface file 1. |
| CHANGE_OPTI_VALUES | boolean | “ON”, “OFF” | If set to “ON” performs optimization. Must be “ON” to configure: CUTFACTOR, WHOLE_PACKING_UNITS, ASSIGN_REST_TO_WASTAGE, MODE_UNROLLED_PROFILES |
| CE_DATA | boolean | “TRUE”, “FALSE” | If set to “TRUE” uses CE Data. |
| MODE_UNROLLED_PROFILES | string | “NEVER”, “NORMAL”, “ALWAYS” | Sets roll profile value. |
| SINGLE_ITEMS_NO_KITS | boolean | “TRUE”, “FALSE” | If set to “TRUE” the calculation info uses single items only. |
| CUTOPTIMIZATION | boolean | “TRUE”, “FALSE” | If set to “TRUE” will attempt to minimize wastage on cuts. |
| CUTFACTOR | single | Single range | If CUTFACTOR = -1 sets OptimizedWastage to true or, if CUTFACTOR >= 0 and calculation data is returned, sets the wastage and writes the data to a file. |
| ASSIGN_REST_TO_WASTAGE | string | “ON”, “OFF” | If set to “ON” includes any residual length in wastage. |
| WHOLE_PACKING_UNITS | string | “ON”, “OFF” | If set to “ON” adds accessory options. |
| CALCULATE_OPTIMIZED_WASTAGE_INCLUDING_NOT_SELECTED_ELEVATIONS | boolean | “TRUE”, “FALSE” | If set to “TRUE” includes not selected elevations in wastage optimization. |
| EXPORT_FORMAT | string | Any string | Defines the export format of the Database. |
| VIEW | enum | “INSIDE”, “OUTSIDE”, “NONE” | Set the view for the picture. |