What a rule must return, by parameter type — gull system handbook
Reference table: what a rule must return for a dimension, angle, count, suppression, configuration, colour, texture, material, property and sketch text, and what an empty result means.
What a rule must return, by parameter type
Each type of captured parameter expects a different kind of result. An empty result usually means "change nothing" — except for a configuration.
- Parameter: Dimension - The rule returns: a number in the model's units, usually mm: `[Length] - 20` - Empty result: nothing is written
- Parameter: Angle - The rule returns: a number in degrees - Empty result: nothing is written
- Parameter: Count - The rule returns: a whole number of pattern instances - Empty result: nothing is written
- Parameter: Suppression (feature, mate, component) - The rule returns: `TRUE`, a non-zero number, `"U"` or `"Unsuppress"` = active; `FALSE`, `0`, `"S"` or `"Suppress"` = suppressed - Empty result: the feature is left as it is; other text is refused
- Parameter: Configuration - The rule returns: the name of one of the captured configurations, exactly, case included - Empty result: refused — there must always be a configuration
- Parameter: Colour - The rule returns: `#RRGGBB`, or an item name from the Colours list - Empty result: change nothing
- Parameter: Texture - The rule returns: an item name from the Textures list, or an image path - Empty result: change nothing
- Parameter: Texture rotation (°) - The rule returns: a number in degrees - Empty result: change nothing
- Parameter: Material - The rule returns: an item name from the Materials list - Empty result: change nothing
- Parameter: Property - The rule returns: any text: `"P-" & [Order number]` - Empty result: empty text
- Parameter: Sketch text - The rule returns: text - Empty result: empty text
Suppression
Configuration
The rule is checked before anything is sent to the CAD: a name that is not in the model is refused with a hint of the closest one — "The configuration "stainless" is not in the model. Closest is "Stainless" — configuration names are case-sensitive." The simplest way is to let Create an input with these configurations make an input whose choices are the captured configurations; the rule is then just `[Configuration]`.
If you add a new configuration to the model, the app does not know it until you capture the parameter again in step 1 — the list of configurations is stored at capture time.
An empty result means skip
For everything except a configuration, a rule that returns nothing runs fine: the order is not failed, documents are generated, and the Log shows "returned nothing" on the rule. The part keeps what it had. It is not a reset — there is no "no material" command; it would have to decide how much the part weighs.