FileMaker Server Soft Close

Bare Metals Servers require UPS Battery Backup . . .

'Power loss is a when, not an if.' ~ my good-self, to every client hosting on FileMaker Server.

Bare metal servers require UPS battery backup . . .

A FileMaker Server soft close gracefully closes every hosted database, warning connected users first, before your UPS shuts the operating system down. It's the difference between a clean shutdown and a consistency check on restart.

This is part two in my Prevention and Maintenance series. Here's the link if you've not reviewed the first blog post: FileMaker Prevention and Maintenance.

This solution and code are from a recent two-part project: a FileMaker Server Host protected by UPS, VM synced to a Synology NAS. At the time of the project, I was unable to find any examples of closing FileMaker files via the Admin API, hence I'm sharing the code here, for the Community.

Example: This client's APC Smart-UPS 1500VA was chosen for one feature: it runs scripts 'before' shutting down the OS. The soft close is that script. The NAS is a Synology RackStation RS1619xs+, configured with 32GB RAM and 24TB of Storage.

Close FileMaker Databases Locally with fmsadmin

When FMS is running on the same OS as the APC Management Software, the FMS CLI function can be called directly.

fmsadmin close -m "Server maintenance in 2 minutes. Please save your work." -t 20 -u <username> -p <password> -y

Obviously, the reverse is required, to re-open the files, unless your process is the restart the FMS, with the correct configuration to open the correct files.

The FileMaker Server Command Line Reference can be found on the Claris website.

Close Databases Remotely via the Admin API

In more complicated setups, the FMS may not be running on the same OS as the APC UPS configuration. In this case, we'll apply a custom PowerShell script to call the FMS Admin API.

PowerShell.exe -ExecutionPolicy Bypass -File "C:\<YourDrive>\CloseDatabases.ps1"

This is the power script code - the file has been zipped to allow sharing via this webpage.

CloseDatabases.zip

Download ZIP • 2KB

Again, the reverse to open files when back on power is required.

These scripts are released under CC BY 4.0. Use it, fork it, adapt it. Attribute it.

Soft Close FAQ

Does fmsadmin close warn connected users first?

Yes. The -m flag sends a message to every connected client, and -t sets the grace period in seconds before the close proceeds.

Do I need FileMaker Pro to run these scripts?

No. The local call uses the fmsadmin CLI bundled with FileMaker Server. The remote call is plain PowerShell against the Admin API.

How do the files re-open when power returns?

The reverse call: fmsadmin open locally, or set the database status back to OPENED via the Admin API. Unless your restart process opens the correct files automatically.

Will a hard power cut corrupt hosted files?

It can. Files that are not closed properly are flagged for a consistency check on the next open, and a write interrupted mid-flight can do real damage. The soft close exists so you never find out.

Soft Close Takeaway

This is merely a 'short' example to demonstrate what can be achieved . . .

Power loss is still a when, not an if. The difference is whether your files were closed gracefully when it arrived.