Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.encoreos.io/llms.txt

Use this file to discover all available pages before exploring further.

This screen provides admin-level configuration for the Facilities Management module and is available at /fm/settings.

​
Overview

The FM Settings page is wrapped in a RequirePermission for fm.admin, in addition to the parent FMViewGuard. It loads and saves FM module settings via useFMModuleSettings. A settings header displays the module icon, title (“Facilities Management Settings”), and description (“Configure module-level settings for your organization”), with a link to published documentation via PUBLISHED_DOC_PATHS.moduleSettings.facilities. A Module Configuration card contains FMSettingsForm, which is initialized from transformSettingsForForm(settings). The form covers “work orders, inventory, maintenance scheduling, and asset management settings” (per the card description). A guided tour (fmSettingsTour) can be started via query parameter ?tour=fm-settings-tour or the Help button.

​
Who it’s for

Requires permission fm.admin (inner RequirePermission), plus the outer FMViewGuard requiring fm.dashboard.view.

​
Before you start

  • Hold the fm.admin permission.
  • Understand the impact of the settings being changed before saving.

​
Steps

1

Open FM Settings

Navigate to /fm/settings via the FM admin menu.
2

Review current settings

The Module Configuration card displays current values from useFMModuleSettings.
3

Modify settings

Edit fields in FMSettingsForm as needed.
4

Save

Submit the form to call upsert(values) and persist the settings.
5

Start the guided tour

Add ?tour=fm-settings-tour to the URL or click the Help button to walk through the settings page.

​
Key concepts

  • Module settings — organization-scoped configuration values for the FM core, stored and retrieved via useFMModuleSettings.
  • transformSettingsForForm — utility that maps raw settings data to form-compatible initial values.

Facilities & Inventory

Facilities & Inventory core overview.

Governance & parity

Documentation coverage and governance.
This page documents shipped product behavior. It is not medical, legal, or billing advice. Verify against your organization’s policies and applicable regulations before using it for clinical, compliance, or billing decisions. Protected health information (PHI) shown in the product is governed by your tenant’s access controls and is never exposed in this documentation.
  • src/routes/fm.tsx
  • src/cores/fm/pages/FMSettingsPage.tsx