Updating and Validating FSM Configuration

Update the Field Service Management (FSM) configuration when you need to change a supported property. Create an inactive copy of the current configuration, then edit and validate the copy. Activate the revised configuration and retain the previous version as an inactive record.

In this topic:

Preparing a Revised Configuration

To update the configuration:

  1. Go to Field Service > Administration > Configuration. The Field Service Configuration page opens the active configuration record.

  2. Record the name of the active configuration so that you can identify it when activating the replacement.

  3. In Name, enter a unique name for the revised configuration. Begin with the current product version, followed by the date in YYYYMMDD format and your initials. You can add a short description.

  4. Check the Inactive box to keep the replacement inactive during editing.

  5. On the Save list, click Save As.

  6. Click List. On the Field Service Configuration List page, check the Show Inactives box.

  7. Find the copied record and click Edit.

  8. Change the JSON in the Editor. If you use an external editor, paste the revised JSON back into the Editor.

  9. Complete the checks under Validating the Draft before activation.

  10. On the Save As list, click Save.

  11. On the configuration list, clear the Inactive box for the replacement record and check the Inactive box for the previous active record.

  12. Click Submit. Reopen the configuration page to confirm the intended record is active.

The previous configuration remains available as an inactive record.

Automatic Configuration Updates

FSM can apply automatic changes to the active custom configuration through scheduled configuration maintenance. A targeted account update applies only when the current property matches the expected value and differs from the proposed value.

When an automatic change replaces the active configuration, FSM creates a record whose name begins with Auto Configure and inactivates the previous record. The previous configuration remains available for reference. Before preparing a manual revision, confirm which record is currently active.

Not every SuiteApp update changes custom configuration. For the associated scheduled script, deployment, and monitoring details, see FSM Script Reference.

Validating the Draft

FSM checks whether the Editor content can be parsed as JSON. When Preview is enabled, the form shows whether the JSON is valid or invalid. Saving rejects invalid JSON in either Preview mode.

Repeated property names within one object pass the syntax check, but only the last value remains. With Preview enabled, the Editor can remove an earlier duplicate when you finish changing the field. Saving removes earlier duplicates in either mode.

The syntax check does not comprehensively validate property paths, values, record references, searches, expressions, or the account setup needed for the intended behavior.

Important:

Valid JSON and Configuration Preview do not establish that a property is supported or that downstream processing succeeds.

For performance measurement and data capture, see FSM Performance and Data Collection.

Using Configuration Preview

Preview shows a merged configuration when you edit a configuration record, including unsaved changes in its Editor. An inactive record containing only config.preview may still show settings from the active custom configuration. Preview does not confirm that Editor changes are saved or active.

The preview property in the root config object controls whether the form displays Preview. Its default is false. To enable it, add "preview": true to the root config object, then save and activate that configuration:

            {
  "config": {
    "preview": true
  }
} 

          
Important:

When enabling Preview in an existing custom configuration, add this fragment without replacing its other properties. Adding config.preview only to an inactive record does not enable Preview on the form.

Using Configuration Preview

  1. To view the standard product configuration, save the preceding JSON example as its own configuration record.

  2. Inactivate all other configuration records, then activate this Preview-only record.

  3. Open the active Preview-only record in edit mode.

    Its Preview shows the standard product configuration.

  4. When you finish viewing Preview, inactivate the Preview-only record and reactivate the proper custom configuration.

Reminder: In an active production account, use this method only when you are confident that FSM Mobile users will not be affected when the other configuration is inactive.

Standard default JSON (false disables Preview):

            {
  "config": {
    "preview": false
  }
} 

          

Related Topics

General Notices