Validation and flag rules - j5 - 28.0 - Administration & Configuration - Hexagon

j5 IndustraForm Designer Help
ft:locale
en-US
Product
j5
Search by Category
Administration & Configuration
j5 Version
2019

  • Validation - Highlights invalid or impossible values considering the equipment or environment associated with the input cell. When a form contains invalid values, the invalid values prevent:

    • The form from being saved.

    • A section from being submitted.

    • A workflow transition from being implemented.

    For example, an invalid input can often be the result of a typo. The absolute capacity of a tank is 1,000 liters. Currently, the volume of water in the tank is 730 liters. The user completing the task accidentally enters 7,300 liters. If a valid limit of 1,000 liters has been configured for the task, a validation error appears, and the section cannot be submitted until the entered value is corrected.

  • Flag - Highlights the concerning values. Flags normally indicate that something is wrong with the equipment or environment and the issue must be addressed before the problem escalates. A section can be submitted when there are flagged values.

    For example,

    • The tank level is lower than expected; there could be a leak or faulty valve.

    • The temperature is higher than expected; more grease may be required so that the equipment doesn't burnout or cause a fire.

Configure invalid if and raise flag if rules

  1. Select the cell you want to apply the rule or rules to.

  2. In the Invalid If and Raise Flag If section on the Properties tab, select the relevant rule type. The configuration points for the rule type appear.

  3. Enter the rule details.

Multiple Invalid If and Raise Flag If rules can be configured on a single input cell. You can select the same rule type multiple times or different rule types for each cell.

Invalid If and Raise Flag If rule options

An input value is marked as invalid or flagged, when:

  • List - The selected option matches the specified option. This rule type can be used for Choice and Checklist Item type cells.

  • Range range icon - The entered value is outside of the specified range (Min to Max). This rule type can be used for Number and Integer type cells.

    What happens when multiple ranges are configured on one input cell?

    Only one Invalid If range rule can be configured on a single cell. Multiple Raise Flag If range rules can be configured on one cell.

    If an input value triggers all the configured ranges, you can have all the configured ranges raise a flag (multiple flags on the same input value) or you can have only the closest triggered range raise a flag (one flag on the input value even when all the ranges are triggered).

    Example one - All the ranges raise a flag

    A cell has three range rules configured:

    • Range rule one: 15 - 45

    • Range rule two: 10 - 50

    • Range rule three: 5 - 55

    The user enters 60. Because 60 is greater than 45, 50 and 55, all the ranges raise a flag. All three ranges (15 - 45, 10 - 50, and 5 - 55) along with their flag messages (when configured) appear below the input value.

    Example two - Closest range raises a flag only

    A cell has three range rules configured:

    • Range rule one: 15 - 45

      Range group for rule one: Temperature

    • Range rule two: 10 - 50

      Range group for rule two: Temperature

    • Range rule three: 5 - 55

      Range group for rule three: Temperature

    The user enters 60. Because 60 is greater than 45, 50 and 55, all the ranges are triggered, but range rule three (5 - 55) raises a flag only because it's closest to the input value. Range rule three (5 - 55) along with its flag message (when configured) appear below the input value.

    If the user enters 52, range rules one and two are triggered, but range rule two (10 - 50) raises a flag only because it's closest to the input value.

    Select Edit below each range rule to enter a range group and flag message.

  • Equal - The entered value is equal to the specified value or calculation. This rule type can be used for any cell type other than Choice and Checklist Item type cells.

  • Less than - The entered value is less than the specified value or calculation. This rule type can be used for Number and Integer type cells.

  • Greater than - The entered value is greater than the specified value or calculation. This rule type can be used for Number and Integer type cells.

  • Function - The entered value meets the conditions specified in the formula. The formula needs to evaluate to True to trigger the invalidation or flag (for example, =IF(D1>10,"True", "False"). This rule type can be used for any cell type (except Chart and Sparkline cells).

  • Time - The entered date is not in the configured time range. This rule type can be used to compare the entered date-and-time to the current date-and-time. It can be set to trigger if the date is in the PAST (before the current time) or FUTURE (after the current time).

Edit rules

Select Edit under a rule to access more configuration points for the rule. The following options appear:

  • Value - The rule is evaluated against these input values. These are the same values that appear on the panel.

  • Message - Appears when the rule condition is met. Both the rule and the message appear below the triggered input cell.

The configured Raise Flag If rules have the following additional options:

  • Category - Select the category you want to apply to the flag.

  • Priority - Select the priority you want to apply to the flag.

  • Range group (appears for Range flag if rules) - Enter the name of the range group when you want to group multiple configured ranges on a cell.

  • Hidden - Select Hidden to hide the flag. The flag isn’t displayed on the IndustraForm when it is triggered, but it is still logged on the flag history table.