Skip to content
English
  • There are no suggestions because the search field is empty.

Configuring Forms

 What is Form Configuration?

Form configuration is where admins build the structured data-collection templates operators use across the app — pigging send/receive records, Health & Safety incidents, Field Tickets on Jobs, inspection checklists, and more. All form types share the same underlying engine, but each type has specific rules about which admin tabs and runtime features are available.

Key point: Forms are built once in Admin → Form Config and then appear for operators in the appropriate area of the app. Changes after operators have started using a form are recorded in form history — keep edits minimal once a form is in active use.

The Twelve Form Types

The app string for each type is exact (from Form.php). Older docs or UI labels sometimes use aliases — both names are listed where they differ.

Form Type (app string) Also known as Where it appears Purpose Org setting that adds it to Form Config
Pigging — Pig send / receive Linked to a pig schedule type; captures send and receive data pigging_widget
Inspection — Inspection schedules Structured pass/fail checklist for recurring condition checks inspections
Health & Safety HSE HSE Dashboard, Forms Report Safety incidents, near misses, hazard observations hse_forms
Custom — HSE Dashboard (when Form Process on), Forms Report General operational data collection custom_forms
Machine Schedule Equipment Schedule (legacy UI/report wording) Equipment maintenance / schedules Linked to a machine schedule type; optionally required before completing the schedule schedules_widget
Causal Analysis Causal HSE Dashboard (attached to HSE/Custom) Root cause analysis on a parent form Always listed; list visibility needs custom_forms or hse_forms
MOC — MOC Dashboard Management of Change moc_forms
RIK — MOC Dashboard Risk / RIK process paired with MOC moc_forms
Job Project (legacy code name) Jobs module Form attached to a Job project_page
Field Ticket — Jobs module only (no top-nav item) Billable field work on a Job project_page
Reading Sheet Normals Equipment Normals (stale in a few admin strings) Equipment reading sheets Niche: force a task when a reading sheet answer is "No". Typically not recommended Always available; one form per org
Task Work Order (if task_rename is set) Task modal / Tasks report Optional form filled when working a task Always available
Where to Configure Forms

Navigate to Admin → Form Config. All form types are created and managed here. Inspection schedules can be assigned to multiple assets in bulk from this page.

Building a Form

Step 1 — Create the Form

  1. Select the form type — only types enabled for your org appear in the dropdown (see table above)
  2. Enter a name — what operators see when selecting the form
  3. Assign a department (optional) — that department's supervisors become default email recipients for workflows. See Departments below
  4. Save — the form is ready for questions

MOC, RIK, and Reading Sheet Normals seed default questions on create. Pigging allows one form per pig sub-type. Reading Sheet Normals allows one form per org.

Step 2 — Add Questions

Open the form and go to the Questions tab.

Question Text

The prompt shown to the operator. Limited to 255 characters.

Answer Type

Determines the input the operator sees. Values below match the Answer Type dropdown in Form Config (formCtrl.js).

Standard inputs

Answer Type (app string) Use When
number Numeric entry only
checkbox Single checkbox — typically yes/no or acknowledge
text Free-text entry
select Longer list, only one answer
radio Short list, only one answer — best for pass/fail
checkboxes Multiple answers possible from a list
date Date only
dateTime Date and time
time Time only
LLD LSD / legal land description format (00-00-000-00X0)
contact First name, last name, email, phone — each unused/optional/required
money Same as number but prefixed with $
item_in_list Pick from a list; with Assign selected users to the form log checked and list = users, creates user assignments (one such question per form)
other_expenses Freeform description / rate / quantity rows. Available on all form types in admin; Field Ticket totals and invoicing use these rows
replacement Used when an item is being physically replaced (common on inspections; not available during bulk completion)
department Dropdown of existing departments
asset Attach a single piece of equipment or tank (one per form)

Layout / notice breaks (not answered by the operator — the question text is shown as a visual break)

Answer Type Use When
section_break Neutral section heading inside the question list
warning_break Warning-styled notice block
info_break Info-styled notice block

These are separate from the form Sections tab (multi-stage Sending/Receiving-style sections). Breaks only change how the form looks while filling it.

Risk matrices (operator picks a cell on a probability × consequence grid)

Answer Type Grid
4x4_risk_matrix 4 × 4
5x4_risk_matrix 5 × 4
5x5_risk_matrix 5 × 5

Type-specific additions (not always in the base dropdown)

Answer Type / option When it appears
inspection_freq Inspection forms only — one per form. Lets the operator change inspection frequency (not available during bulk completion)
Category budget (config on money/number) Job forms — ties a money/number answer to a project budget category; not a separate Answer Type row in the dropdown

Causal Analysis also has base cause and causal comment question options. Machine Schedule forms with MSAPR sub-types can set NOx / internal identifiers on questions.

Category budget questions — how spend reaches a Job

Ticking Category budget on a money or number question links that answer to one of your organization's Job Categories, so the amount entered counts as spend against that category's budget.

Three things about this are easy to get wrong:

  • It only produces cost on a Job form. The checkbox is offered on any money or number question regardless of form type, including Field Tickets. On anything other than a Job form the answer is saved and contributes nothing to Job cost. Field Ticket cost has to be captured through the ticket's own line items or an Other Expenses question instead.
  • The link is made by name, and it breaks silently. Budget-versus-actual reporting matches the question wording to the Job Category name as text. Rename either side and the spend is still recorded but stops lining up against its budget — with no warning and no error. If you rename a Job Category, search your Job forms for questions using the old wording and change them together.
  • Job form logs have no stored total. Unlike a Field Ticket, a completed Job form does not compute or store a ticket-style total, even when its category-budget answers hold real money. The amounts live on the individual answers only. Anything needing a per-form or per-Job figure has to sum those answers itself, which is why Job Form spend is absent from the Job Dashboard's Total Cost column.

Answer Type Options (Lists)

For radio, select, checkbox, and checkboxes — enter values manually or link to a Drop Down List from Admin → Drop Down Lists. For item_in_list assignments, the list must be the virtual users list (not a custom Drop Down List of names).

Additional Question Settings

  • Required — must be answered before submit. For a single checkbox, it must be checked. For multiple checkboxes, at least one must be checked
  • Pass Values — on radio and select: which answer(s) count as passing. Used by inspections for pass/fail and auto-generated tasks. A question with no pass value fails if answered
  • Pass Required — operator must select a passing value before the form can be completed
  • Parent Question — nest this question so it appears only when the parent has a specific answer. Only radio, select, or checkbox can be parents
  • Previous Value Visible / Copy Previous Allowed — Inspection and Machine Schedule only (not on asset questions). Shows or copies the last completed answer

Step 3 — Add Sections (Optional)

Sections divide a form into sequential stages (hand-offs between users or multi-stage processes).

To add sections:

  1. Go to the Sections tab
  2. Add and name sections; drag to order
  3. Assign questions to a section when editing each question

Runtime:

  • Only questions on the active section (plus unassigned questions) are editable at each stage
  • Each section can only be completed once per sync
  • Workflows do not fire until all sections are completed

Section availability:

Form Type Sections
Pigging Fixed only — Sending and Receiving (Sections tab hidden; set per question). Cannot rename or reorder
Inspection, Task, Field Ticket, MOC, RIK No admin Sections tab
Health & Safety, Custom, Causal Analysis, Machine Schedule, Job, Reading Sheet Normals Yes
MOC / RIK Use built-in reviewer stages instead of admin sections

Step 4 — Add Calculations (Optional)

Calculations auto-fill a question from other answers.

  1. Go to the Calculations tab, or Add Calculation from the questions editor
  2. Enter a description and save
  3. Add sub-calculations (arithmetic ops; chain up to 4 using Result 1, Result 2…)
  4. Choose which result populates the target question

Types: Basic (field ± field or constant), Time-based (elapsed since last inspection / machine schedule), Chained.

Not available on: MOC, RIK.

Step 5 — Add Workflows (Optional)

Workflows vs. Form Process — two separate systems

  • Workflows — rules you build that send email and/or create corrective-action tasks, optionally with validations and approval.
  • Form Process / HSE Dashboard review — built-in routing that surfaces submitted forms for supervisor review in the HSE Dashboard and can notify supervisors from department / location settings. Driven by Form Process toggles and department setup, not by workflow rules.

Both can be active on the same form. A form with no workflows can still appear on the HSE Dashboard; a form with workflows can also use Form Process.

To add a workflow:

  1. Open the Workflows tab
  2. Choose Send Email, Create Corrective Action (Task), or both
  3. Select which questions to include in the email or task body
  4. Configure validations (AND logic — all must pass), approval required (needs Form Process / Investigation enabled or approval is bypassed), and responsibility role groups

Workflows tab: available on all types except MOC and RIK (those use the MOC reviewer flow instead).

Pigging note: Workflows are available on Pigging forms (the Workflows tab is shown). Older documentation incorrectly said they were not.

Step 6 — Form Process (Optional)

The Form Process tab controls investigation / HSE-dashboard-style review for types that support it.

Tab shown for: Custom, Health & Safety, Causal Analysis, Job, Reading Sheet Normals, Task (and similar non-excluded types).

Tab hidden for: Inspection, Pigging, Machine Schedule, Field Ticket, MOC, RIK.

Important: Only Custom, Health & Safety, and Causal Analysis feed the HSE Dashboard query. Job / Task / Reading Sheet Normals may show Form Process settings, but they do not join that dashboard the same way — treat Form Process on those types as limited / not the HSE review path.

Step 7 — Import (Optional)

The Import tab downloads templates and uploads completed (or, for inspections, incomplete) form logs.

Form Type Import tab
Machine Schedule Hidden in admin UI
Reading Sheet Normals Tab may appear (UI still checks the stale name "Equipment Normals") but this type is not accepted by the import handler — do not rely on Import
Causal Analysis, Task Tab may appear; not in the import handler accepted list
Most other types (including Field Ticket, Job, Pigging, Custom, Health & Safety, Inspection, MOC, RIK) Supported via Import

Inspection forms also support incomplete inspection import.

Departments

Departments connect forms to working groups and workflow notification routing.

  • Assign a department when creating or editing the form
  • That department's supervisors become default workflow email recipients
  • Location limiting: when enabled on the department, only supervisors assigned to the plant where the form was submitted are notified. Requires Form Supervisors on the plant. Custom locations may fall back to all department supervisors
Form Type Quick Reference
Pigging Inspection Health & Safety Custom Machine Schedule Causal Analysis MOC RIK Job Field Ticket Reading Sheet Normals Task
Sections Fixed Send/Recv No Yes Yes Yes Yes Reviewer stages Reviewer stages Yes* No Yes No
Workflows Yes Yes Yes Yes Yes Yes No No Yes Yes Yes Yes
Calculations Yes Yes Yes Yes Yes Yes No No Yes Yes Yes Yes
Departments Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes
Form Process tab No No Yes Yes No Yes No No Yes† No Yes† Yes†
Feeds HSE Dashboard No No Yes Yes‡ No Yes No No No No No No
Pass values Optional Core Optional Optional Optional Optional Optional Optional Optional Optional Optional Optional
Import (practical) Yes Yes Yes Yes No (UI) No Yes Yes Yes Yes No No
Previous / copy answer No Yes No No Yes No No No No No No No

* Job has a Sections tab in admin (not excluded like Field Ticket).
† Tab present; does not feed the HSE Dashboard query.
‡ Custom appears on the HSE Dashboard when Form Process is enabled.

Type-specific notes
  • Field Ticket — billable field work on a Job with line items, assignments, and an invoicing lifecycle. Misc Items catalog table at fill time applies to Job and Field Ticket when misc_items_widget is on.
  • MOC / RIK — dedicated reviewer UI and dashboard; admin workflows/calculations/sections/Form Process tabs are hidden.
  • Reading Sheet Normals — niche; typically not recommended. Prefer normal reading-sheet questions unless you intentionally want a single Yes/No "is this normal?" gate that generates a task on No.
  • Task forms — optional input on tasks; Task Cost / Man Hours can also be tracked on the task itself without Jobs (v02-121-01).
  • Machine Schedule — prefer the name Machine Schedule in new writing; mention "Equipment Schedule" once if supporting older screenshots or reports.
Common Issues

"The form isn't showing up for operators offline"

  • The form must be fully configured and saved
  • Operators must sync after the form is published

"I don't see my form type in the create dropdown"

  • Check the org setting for that type (table at the top). Field Ticket and Job need project_page; MOC/RIK need moc_forms; etc.

"Workflows are firing when they shouldn't"

  • A workflow with no validations fires on every completion
  • If approval is required but Form Process / Investigation is off, approval is bypassed

"Calculations are producing unexpected values"

  • Check sub-calculation order and Result 1 / 2 / 3 references
  • Previous-value calculations need a recent sync — they use the last record on the device

"A question isn't visible on the form"

  • Check parent-question visibility rules

"Assign selected users to the form log" doesn't put the ticket on Assigned to Me"

  • List must be users, checkbox must be on, only one assignment question per form, and prefer a top-level (always visible) question.
Tips & Recommendations
  • Keep forms stable after launch — structure changes are logged in history
  • Set pass values on all Radio and Select questions on inspection forms — unanswered pass values auto-fail and can create unwanted tasks
  • Use parent questions to reduce clutter in the field
  • Use validations on workflows — unconditional workflows create email/task noise
  • Test before deployment — complete the form yourself (sections, calculations, workflows)
  • For Field Ticket assignments, use Item in List → users → Assign selected users to the form log

Remember: Forms are the foundation of structured data collection in EZ Ops. A well-configured form gives operators a clear path to accurate documentation — and ensures the right people are notified and the right corrective actions are created automatically.