An operator often needs one value that depends on the unit: the cleaning method for its body material, a torque for its size. In WorkSteps those values live in a reviewed parameter table in the procedure, and a step shows the right row for each unit. The starter rule Show a value from a table on a step adds that parameter to a step.
Use the starter rule
You need the Author role, and the procedure needs a saved draft revision: a procedure you have only just created has nothing for the blanks to offer yet. The rule goes into the next draft revision. Units keep the instructions of the release they were issued with, and new units keep following the published release until a Reviewer publishes a new one.
- Open Procedures and open the procedure.
- Under Starter rules, find Show a value from a table on a step. It is in Recommended and in Values from tables. You can also type a word from its title in Search starter rules and Help.
- Fill in the blanks in the card's sentence, "On …, show … as ….":
- Step: one of the procedure's steps, by its title.
- Value: a value column of one of the procedure's parameter tables, and the unit's detail that picks the row, such as the note from cleaning notes for the unit's body material. Only tables with one key column are offered.
- Label on the traveller: what the operator reads beside the value, such as Cleaning method. It also names the parameter, so a step cannot have two parameters with the same label.
- Choose Use this rule. The button waits until every blank has a value.
WorkSteps saves the next draft revision with the rule in it, with the note "Began from the starter rule Show a value from a table on a step (version 1)". No AI is asked, and nothing is published, assigned or issued. The page then says the revision began from this starter rule and what to check next.
If Draft definition has changes you have not saved, the cards wait: a starter rule always starts from the saved revision. Save your changes or reload the page first.
Where SmartFACT Automation is connected to WorkSteps, you can also arrive here from New requirement there, which offers the cards of the procedure whose draft was saved most recently. Its Use this rule makes nothing: it opens that procedure's page with this card alone and its blanks filled in, and the page names the procedure. Check the procedure and the blanks, then choose Use this rule on the page. See every starter rule shows all the cards.
Describing in words is for a block's condition, so where it is switched on for your site, Reword with AI on this card only says so: use Use this rule, then change the step in Draft definition if you need to.
What the rule does
The rule adds one parameter to the step and gives the step its next revision, because a step's content never changes under a revision already in use. When a unit's traveller includes the step, it shows the value from the table row for that unit's detail, frozen at issue.
A unit whose detail has no row in the table cannot be issued: WorkSteps never borrows a similar row. Add a reviewed row to the table, in a new table revision, before such units are issued.
In the Instrument enclosure EN-400 procedure, "On Fit the wall brackets, show the note from cleaning notes for the unit's body material as Cleaning method" shows the fitter of a stainless wall-mounted unit the stainless method from the cleaning notes. A bench-mounted unit has no wall bracket step, so it shows nothing; an aluminium wall-mounted unit cannot be issued until the cleaning notes have a reviewed row for aluminium.
Check the examples
A starter rule saves no example, because an expected route is yours to state from the approved method: WorkSteps never works it out for you. Before you lock the revision, save examples under Examples that show the rule working:
- one unit whose traveller includes the step, whose expected parameters include the new value;
- if the step is in an optional block, one unit whose route leaves the step out, which shows no value;
- one unit whose detail has no row, if any can arrive, whose expected result is that it cannot be issued.
Beside the new revision the page offers Start an example for each of these. It puts a unit's options in Example JSON and leaves the expected route empty for you to complete; then choose Add example. Check every option and enter the expected steps, requirements and parameters from the approved method before you save it.
Your existing examples are run again against the new revision. An example written for the old rule may now fail, and that is the point: decide whether the rule or the example is wrong before you change either.
Publish it
Under Review, choose Lock revision … and verify, which names the revision the starter rule made. Every saved example is run, and the proof also needs each optional block both included and left out by some example. Then hand the candidate to a Reviewer. Verify and publish a procedure describes the review. A rule from a starter rule is reviewed like any other, and an author who publishes their own revision must have the Reviewer role and give a reason.
Change it later
Nothing about a starter rule makes its rule permanent. Remove or change the parameter in the step's parameter_bindings in Draft definition, and give the step a new revision number, as for any change to a step. Save the change as a new draft revision and publish it in the same way. Units already issued keep the instructions they were issued with.
If the card is refused
- This starter rule has changed since the page was opened. WorkSteps has a newer version of the starter rule. Reload the page and fill the card in again.
- Someone saved a newer revision. Another author saved the draft after you opened the page. Reload it, check what they changed, then use the card again.
- The draft already has this rule, so nothing was saved. The card would make exactly the rule the draft has now.
- A parameter with this label is already on the step. Choose another label, or change the existing parameter in the definition instead.