Work Order system switches info

Overview

Work Order system switches are tenant-level configuration settings that turn optional Work Order behavior on or off — for example, whether 3C notes appear on a job, whether a work order number can be typed in or is only ever system-generated, or whether the asset/work order status feature is active. An administrator sets these switches, typically from the System Switches admin screen under the Work Orders category (link pending — no Administration-domain article on setting system switches exists yet in this repo). Use this reference to look up what a specific switch controls; it does not describe how to open or use the System Switches screen itself.


Reference content

Job and line behavior

Switch

What it controls

Notes

isThreeCNotesEnabled

Shows the Complaint / Cause / Correction (3C) notes fields on a job, and flags new lines as 3C by default.

See Job fields for the 3C fields themselves.

workOrderLinePromptNotes

Shows a notes-prompt step when adding a job line, and affects whether saved 3C notes are auto-populated.

Distinct from isThreeCNotesEnabled, which controls whether 3C fields exist at all.

isJobsPoolEnabled

Enables a "pool" toggle on the mechanic's job-search view, switching between jobs assigned to that mechanic and all available jobs.

Observed in the Shop / My Work area rather than the Work Order screen itself.

isNegativePartsQuantityAllowed

Allows a parts posting or transaction to result in a negative quantity (for example, when crediting inventory) instead of blocking it.

Affects several parts-posting screens and the Equipment mega-modal.

useCauseCodes

Shows and, in some flows, requires a Cause Code field when adding a job or line.

useReasonCodes

Shows a Reason Code field on job/line details and the Work Order header.

usePriorityCodes

Shows a Priority Code field on job/line details and the Work Order summary.

isCompletionCodesEnabled

Shows a completion-code selection step when closing a job, instead of closing it automatically.

Affects both bulk-close and single-line close flows.

usePartWarrantyReturnVerification

Adds a part-return verification step when closing a job line that used a warrantied part.

Work order numbering and creation

Switch

What it controls

Notes

isWorkOrderNumberAlphaEnabled

Allows a Work Order number to contain letters; when off, numbers are validated/padded as numeric only.

isWorkOrderNumberGenerated

Determines whether the Work Order number is generated automatically by the system rather than entered manually.

promptVendorOnWorkOrder

Shows a vendor prompt when creating a Work Order.

autoCreatePurchaseOrderOnOutsideWorkOrder

Automatically creates a purchase order when an outside (sublet) Work Order is created.

promptPurchaseOrderOnWorkOrder

Shows a purchase-order creation prompt when creating a Work Order.

workOrderCustomerPromptType

Controls whether the Customer field on Work Order creation is hidden, optional, or required.

Values: IGNORE (hidden), PROMPT (optional), REQUIRED.

useShopCodes

Controls how shop codes are entered when creating a Work Order or template: freely selected, validated against a list, or not used at all.

Values: USE, VALIDATE, NOT_USED.

Status, dates, and templates

Switch

What it controls

Notes

useWorkOrderStatus

Turns on the asset/work order status feature — the status column, status field, and related controls across Work Order grids, job panels, and history.

The one switch in this table with a confirmed customer-facing label: "Use Work Order Status," on the Company Info > Custom Web Configuration admin panel. Also gated by an internal rollout flag of the same name — both must be on for the feature to appear.

useDefaultDateTimeForWorkOrderPost

Chooses the default posting date offered when posting to a Work Order that has never been closed: today, or the highest prior transaction date.

Values: T (today), P (prior/highest transaction date).

usePostingDateTimeForWorkOrderClose

Same choice as above, but for a Work Order that has previously been closed.

Values: T, P.

workOrderMasterNotesReplace

Controls whether applying a template's notes to a Work Order replaces existing notes, always replaces, or never replaces (preserves/prepends).

Values: PROMPT, ALWAYS, NEVER. A code comment (ticket HIVE-1049) indicates PROMPT and ALWAYS are currently short-circuited to behave as NEVER — confirm current behavior before publishing.

canCloseWorkOrderFromPaperless

Allows a job to be closed from the Paperless Shop flow.

vmrsDigitsUsed

Sets the digit length/format used when creating VMRS codes.

See Job fields for the Job VMRS field.

Paperless, parts, and quick repair

Switch

What it controls

Notes

isPaperlessEnabled

Paired with sharePaperlessShopJobs to compute whether a new job line defaults to shared-to-paperless.

sharePaperlessShopJobs

Paired with isPaperlessEnabled above.

useCentralizedParts

Enables centralized-parts behavior in parts master, search, and create screens.

Also requires an internal rollout flag of the same name to be on.

useCommonParts

Enables a "common parts" quick-pick option in Parts posting when no search term is entered and an asset is selected.

trackLaborOnQuickRepair

Automatically clocks a mechanic in for labor tracking when creating a Quick Repair.

isMechanicWageHidden

Hides the mechanic's hourly wage/rate on Labor posting panels.

Present in both the legacy and redesigned Labor posting panels.

Declared but not currently observed in the client

These fields exist in the Work Order configuration object but no code path in fmis-web reads or acts on them. They may be enforced server-side only, reserved for functionality not yet released, or unused. Do not treat the list below as a description of behavior — confirm with engineering before documenting what, if anything, each one does.

Switch

isMechanicVehicleInspectionDuplicateLineCheckEnabled

isWorkOrderNumberOverrideEnabled

isEditingWorkOrderLinePartKitEnabled

isZeroEstimatedHoursPermitted

isWorkOrderLineJobAccountCodeFreeFormEnabled

useFacilityOverheadPercentage

isChangingMechanicPostingWagePermitted

isAutomaticDowntimeEnabled

maximumWorkOrderLines

isDowntimeEnabled

isPartCatalogEnabled

isSystemCalcWageByHourlyRateEnabled

systemFlatHourlyRate

reasonableMileageRange


Module and posting-type switches (separate mechanism)

The switches above all belong to one tenant configuration object. A second, distinct mechanism — tenant "additional configuration" module codes, tied to plan/license tier rather than the System Switches screen — separately turns on entire Work Order features or posting types. Their exact customer-facing names are not confirmed from the fmis-web frontend; the codes below are the internal identifiers found in the client.

Code

What it controls

Notes

RTAWOR

Enables the base Work Orders module — Work Order routes and navigation are gated on it.

Without it, Work Order screens are not accessible at all.

RTAWOS

Enables the Work Order Status Setup admin screen.

Related to, but distinct from, the useWorkOrderStatus switch above, which turns the status feature on for end users.

RTATIR

Enables Tire Posting (the Tires tab in Add Posting).

Also requires an internal rollout flag (usePostTire) to be on; plan inclusion alone may not be sufficient to show the tab for every tenant. See Posting types.

RTAWAR

Enables Warranty Posting (the Warranty tab in Add Posting, and the automatic warranty-claim prompt during a Parts posting).

Also paired with related internal rollout flags. See Posting types.


Related tasks

See also