Skip to main content

Effect badges legend

This page lists every kind of rule effect the app shows, with its label, icon and colours. The same colours are used for the badges on fields, the effect badges on rule cards and in the Trace tab, the edges in the Graph tab, and the rows of the Server effects dialog.

Where you see effect badges​

  • On a field: next to the field label. A field shows one badge, for the last rule effect on it in the latest evaluation. Hover over the badge to see the action type and the rule, for example "ASSIGN from rule: PRT-E07 ASSIGN number x 2 to data element". See Read field badges and hidden-field placeholders.
  • On a rule card in the Rules tab: one badge per action, such as "ASSIGN · Assigned value (number x 2)". See Find out why a rule did or didn't fire.
  • In the Graph tab: the toolbar shows the graph legend, limited to the kinds of effect on the current edges. Each edge uses the graph edge colour. See Map rule dependencies.

The field badge words (Hidden, Shown, Assigned, ...) are not the same as the graph legend words (Hide, Show, Assign, ...). Both are listed below.

On-complete badges​

WARNINGONCOMPLETE and ERRORONCOMPLETE use the warning and error colours with a dashed border, and the field badge reads On complete: warning or On complete: error. The badge shows as soon as the rule fires, not only when you complete the form. See Test on-complete rules.

Legend​

The tables below are generated from the app's own legend, so they match what the app shows. The "Meaning" column is the app's description text. Where it says "blocks saving", remember that the playground saves nothing: a rule error blocks saving in a data entry app, and the server reports it during Verify with server.

In the graph legend​

Graph legendField badgeAction typesIconBadge colourGraph edgeMeaning
ReadNone. Graph edges only.None. The condition reads the field.LinkTeal #00796bThe rule reads this field in its condition.
HideHIDEFIELD, HIDEOPTION, HIDEOPTIONGROUP: Hidden. HIDESECTION and HIDEPROGRAMSTAGE: none.HIDEFIELD, HIDEOPTION, HIDEOPTIONGROUP, HIDESECTION, HIDEPROGRAMSTAGEEye, crossed outGrey #494949The rule hides a field, section, option or stage.
ShowShownSHOWFIELD, SHOWOPTION, SHOWOPTIONGROUPEyeGreen #388e3cThe rule shows a field or option.
AssignAssignedASSIGNPencilBlue #1565c0The rule assigns a value to a field.
RequiredRequired by ruleSETMANDATORYFIELD, UNSETMANDATORYFIELDStarYellow #e56408The rule makes a field required or optional.
WarningSHOWWARNING: Warning. WARNINGONCOMPLETE: On complete: warning.SHOWWARNING, WARNINGONCOMPLETEWarningYellow #ff8302The rule shows a warning message.
ErrorSHOWERROR: Error. ERRORONCOMPLETE: On complete: error.SHOWERROR, ERRORONCOMPLETEErrorRed #c62828The rule shows an error and blocks saving.
FeedbackNone. Shown in the Feedback or Indicators card.DISPLAYTEXT, DISPLAYKEYVALUEPAIRSpeech bubblesPurple #9c27b0The rule displays text or a key-value pair in the feedback widget.

Not in the graph legend​

These variants have an icon and colours, but no entry in the legend.

VariantField badgeAction typesIconBadge colourGraph edge
messageNone. Shown in the Server effects dialog.SENDMESSAGE, SCHEDULEMESSAGE, SCHEDULEEVENT, CREATEEVENTEnvelopeTeal #00796b
defaultNone.Any other action typeInfoGrey #494949

Notes​

  • HIDESECTION shows no badge. The section shows a placeholder, "Section hidden by" and the rule name, instead.
  • HIDEPROGRAMSTAGE shows in the Rules, Trace and Graph tabs only. It has no effect on the form or the Enrollment rail.
  • UNSETMANDATORYFIELD shows the Required by rule badge, because it changes whether the field is required.