Skip to content
SmartFACT HelpHandbooksWatch and practise
Handbooks: KitProof

How to hold a kit for a combination of options

Use a starter rule to stop kits whose order has two options together from being planned, with your reason shown on the job.

Review edition · 13 November 2026 · For Author, Reviewer

On this page

Some combinations should never be kitted: outdoor kits ordered with plasterboard fixings, say, because outdoor kits need masonry fixings. The starter rule Hold a kit for a combination of options holds kits whose order has two options together, with your short code and explanation.

Use the starter rule

You need the Author role, and the draft needs a saved revision whose configuration passes its checks: a draft with no revision yet, or one whose configuration has errors, has nothing for the blanks to offer. The rule goes into the draft's next revision. Nothing changes at the stations until a Reviewer activates a release that contains it, and kits already started stay on the plan they began with.

  1. Open Configuration and find the draft.
  2. Under Starter rules in the draft's section, choose the kit in Kit if the draft has more than one. Find Hold a kit for a combination of options. It is in Kits to hold. You can also type a word from its title in Search starter rules and Help.
  3. Fill in the blanks in the card's sentence, "Hold a kit whose order has … together with …, with the code … and this explanation: …":
    • First option and Second option: one value each of two different options of the kit. One order cannot have two values of the same option, so the card refuses that.
    • Short code: lower-case letters, digits and underscores, starting with a letter, such as masonry_fixings_needed. It is shown on the job.
    • Explanation: up to 200 characters, saying why the kit is held. Leave out names and other personal details.
  4. Choose Use this rule. The button waits until every blank has a value.

KitProof saves the draft's next revision, with the rule added to the kit as its next rule (R08 after R07) and a note naming the starter rule and its version. It is the same rule you would get by writing it into Configuration JSON yourself and choosing Save revision. No AI is asked, and nothing is made live. Beside the draft, the page says which starter rule the revision began from.

If someone saved a newer revision of the draft after you opened the page, the card is refused: reload the page, check what changed, then use the card again.

Where SmartFACT Automation is connected to KitProof, you can also arrive here from New requirement there, which offers the cards of the draft saved most recently, for its first kit that a card fits. Its Use this rule makes nothing: it opens Configuration on that draft and kit with this card alone and its blanks filled in, and the page names the kit. Check the kit and the blanks, then choose Use this rule on the page. See every starter rule shows all the cards.

Where describing conditions in words is switched on for your site, the card also offers Reword with AI. It adds the same rule, then opens Describe in words under Rule conditions on that rule with the card's sentence in When does this rule apply?. It sends nothing: you change the sentence and choose Propose condition yourself, and that request counts against the limits shown like any other. Where describing in words is not available, the card offers Use this rule alone.

What the rule does

A kit whose order has both options gets no checklist and cannot be started, and its job shows it as blocked with your code and explanation. A Supervisor imports the corrected order as a new job revision and accepts the change, and KitProof plans the kit again. KitProof never changes the order itself. Handle source revisions and configuration changes describes that part.

For the Control box installation kit at Brighouse works, "Hold a kit whose order has mount PANEL together with region UK, with the code panel_guide_pending and this explanation: UK panel kits wait for the new panel mounting guide." holds every UK panel-mounted kit until the rule is changed or removed.

Check the examples

A starter rule saves no example, because an expected kit is yours to state from the approved specification: KitProof never works it out for you. Before you create a candidate, save examples under Independent examples that show the rule working, each with its complete expected outcome:

  • one order with both options, whose expected outcome is blocked with your short code;
  • one order with only the first option, and one with only the second, whose expected kits are ready.

Mark each one reviewed as a separate step. Your existing examples are run again against the new revision. An example written before the rule may now fail, and that is the point: decide whether the rule or the example is wrong before you change either, and give a reason when you change an expectation.

Publish it

Under Release candidates, choose Create candidate from revision, which names the revision the starter rule made, then Verify. Every current example is run, every one must be reviewed, and the proof also needs every rule seen both matching and not matching, so the new rule needs both kinds of example. Then a Reviewer, another person, checks the proof and activates the candidate with an authenticator code from the last five minutes. Prove and activate configuration describes the review. A rule from a starter rule is reviewed like any other.

Change it later

Nothing about a starter rule makes its rule permanent. Change the rule's values or its condition in Configuration JSON, or remove it, and save the change as a new revision; set its condition with Build it yourself under Rule conditions if you prefer. Prove and activate the new revision in the same way. Kits already checked keep the requirements they were checked against.

If the card is refused

A refused card saves nothing, and the page says why:

  • "Not done: that card no longer fits this revision of the draft, or its starter rule has changed." The draft's revision or KitProof's starter rule changed after the page was opened. Reload the page and fill the card in again.
  • "Not done: draft changed", with the draft's current revision number under it: another author saved the draft after you opened the page. Reload it, check what they changed, then use the card again.
  • "Not done: choose two different options for a combination: one order cannot have two values of the same option." Both blanks name values of the same option.
  • "Not done: the short code is lower-case letters, digits and underscores, starting with a letter, such as panel_guide_pending." Change the code to one that follows that pattern.
  • "Not done: the kit already has that rule, so the card would change nothing." A hold for the same combination is already there.