Scripts & Templates

What are scripts and script templates

A script is an executable checklist — a structured procedure (for example a test or commissioning protocol) where you record Pass/Fail results, measured data, notes, evidence, and signatures. A script TEMPLATE is the reusable definition a script is created from.

Scripts and templates live inside the Documentation module as documents in the tree — there is no separate Scripts page anymore; old script links simply redirect into Documentation and open the right script.

Note: by default, scripts are visible and usable by PROJECT ADMINS ONLY (see the permissions section).

How to create a script from a template

1. In Documentation, open the New menu and choose New script (requires the scripts.create permission).
2. Pick the template to run — only PUBLISHED templates can be used (drafts must be published first).
3. The new script is created as a document in the tree and opens ready to fill in.

Scripts can also live in Asset Docs tracker cells as script slots, tying a procedure to a specific asset.

Recording results: Pass, Fail, N/A

Each checklist item has result toggles: click Pass, Fail, or N/A to record the outcome — click the same result again to clear it (requires the scripts.execute permission).

Items marked as required show a required marker, and each completed item shows the avatar of who completed it. Your entries save automatically; a save-status indicator at the top shows when everything is stored.

Data fields, validation, and notes

Items can include typed data fields for measurements and readings. Enter the value in the field; fields with a defined range are validated, and out-of-range values are flagged.

A flagged value does not stop you from finishing. When you complete the script, required fields left empty and out-of-range values are listed as warnings. You can go back and fix them, or accept them with Complete anyway (see the completing section).

Always record the value you actually measured — validation exists to surface problems, not to force a "good" number. Each item also has a notes area for observations and context.

Attaching evidence to a script item

Checklist items accept evidence attachments — photos or files that prove the step was done. Use the attachment control on the item to upload or pick evidence; attached files are visible to everyone working the script.

Navigating a script: sections and outline

Scripts are organized into sections. While a script is open, the Documentation sidebar swaps to the script's section OUTLINE — click a section to jump straight to it. As you scroll, the outline highlights where you are.

At the top you have breadcrumbs and a back button to return to the folder, plus the save-status indicator. An inspector pane offers Details and History tabs for the script's metadata and change log.

Signatures — how signing works

The Signatures panel lists the script's signature slots. To sign:

1. Open your slot and draw your signature on the signature pad.
2. Optionally add a comment, then confirm. You can also REJECT a slot with a comment instead of signing.

Only the expected signer can sign a slot: you can sign slots assigned to you or unassigned ones (requires the scripts.sign permission). Admins holding scripts.sign.override can sign any slot. A required slot that is not signed blocks completion — it cannot be accepted as a warning.

Completing a script — warnings you can accept vs blockers

Once all the steps are done, a Complete script button appears in the bottom bar. While a required signature is still missing, the button reads Sign off to complete instead. Clicking it takes you to the signatures and shows "Sign off all required signatures to complete this script."

When you click Complete script, one of three things happens:

1. Nothing is open: the script completes and you see "Script completed".
2. There are WARNINGS: an amber dialog titled "Complete this script?" lists them. A warning is a required field marked "Left empty", or a value outside its expected range (the row shows the value you entered and the range). Click a row to go to that step. Choose "Go back and fill them" to fix the values, or "Complete anyway" to accept them as they are. Warnings you accept are recorded in the script's History.
3. There are BLOCKERS: a red dialog titled "This script isn't finished" lists them. A blocker is a required step marked "No result recorded", or a required signature marked "Not signed". There is no Complete anyway button here. Close the dialog, resolve each one, and try again.

Completing locks the script. The warnings dialog reminds you: "Completing locks the script. You'll have to reopen it to change anything."

Need to change something after completion? Use Reopen in the bottom bar to put the script back in progress, make the correction, and complete it again.

Editing a script's structure

With the scripts.update permission you can switch a script into structure editor mode to adjust its sections and items — separate from filling in results.

Structure changes are for fixing the procedure itself; day-to-day execution (results, data, notes, evidence) happens in the normal runner and needs only scripts.execute.

Templates: draft, published, archived

Templates live in the Templates scope of the Documentation sidebar, with filter chips for All / Drafts / Published / Archived.

Lifecycle: a new template starts as a DRAFT; publish it (requires the scriptTemplates.publish permission) to make it available for creating scripts; archive it when it should no longer be used. Only PUBLISHED templates appear in the New script picker.

Use New template to create one, and delete from the same panel.

Editing a template

Open a template to edit its definition:

• Sections and checklist items.
• Typed data-field definitions (the measurements scripts created from it will collect, including validation ranges).
• Signature slots (who must sign).

The editor offers grid and list views and a bottom save bar. Remember to PUBLISH the template when it's ready — scripts can only be created from published templates.

Sending a script or template to review

Scripts and templates can go through the same formal review process as documents. Open the script's metadata panel (or select it in Documentation) and choose Send to review, pick a workflow, and create the review (requires the reviews.create permission).

Approvers then decide on it from the Reviews page, and the outcome is stamped on the script like any reviewed document.

Working together: live presence and field locks

Scripts support live collaboration. You can see who else has the script open, and while someone is editing a specific field it is locked for others, so two people can't overwrite each other's entries. Changes from teammates appear in real time.

Who can use scripts (permissions) — admin-only by default

IMPORTANT: by default, ONLY Project Admins hold script permissions. Project Members and Technicians cannot even see scripts unless a custom role grant gives them access — ask a project admin if your team needs wider access.

The keys:

• scripts.read — see scripts.
• scripts.create / scripts.update / scripts.delete — create, edit structure, delete.
• scripts.execute — fill in results, data, notes, and evidence.
• scripts.sign — sign slots assigned to you or unassigned; scripts.sign.override — sign any slot.
• scriptTemplates.read / create / update / publish / delete — manage templates.

The project owner can always do everything.

Scripts troubleshooting

• Can't see any scripts or the New script option: script permissions are Project Admin-only by default — other roles need a custom grant.
• A template doesn't appear when creating a script: it's still a draft — it must be PUBLISHED first.
• Can't complete the script: only two things block completion — a required step with no result, and a required signature that is not signed. The "This script isn't finished" dialog lists them; click a row to go to the step. Empty required fields and out-of-range values are only warnings — you can accept them with Complete anyway.
• Can't sign a slot: only the expected signer can sign; ask that person, or an admin with the sign override.
• Script is read-only: it's completed and locked — use Reopen to edit again.
• A field won't accept my edit: a teammate may be editing it right now (field lock) — wait a moment.
• An old /scripts link: it now redirects into Documentation and opens the script there — that's expected.