Claris FileMaker Cloud 2.19.0 Help
About FileMaker Cloud
What is FileMaker Cloud?
Claris™ FileMaker Cloud® is a service that provides access in the cloud to custom apps (databases) that use Claris FileMaker Pro™, Claris FileMaker Go®, and Claris FileMaker WebDirect™. FileMaker Cloud uses the Claris ID integrated sign-on system to authenticate users and is offered directly from Claris International Inc.
- Claris Customer Console is a web-based application for managing Claris ID accounts, groups, hosts, settings, and subscriptions.
- FileMaker Cloud Admin Console is a web-based application for monitoring and managing your FileMaker Cloud instance.
- The Claris FileMaker® Data API is an application programming interface (API) that allows web services to access data in hosted databases. Because this API conforms to Representational State Transfer (REST) architecture, the FileMaker Data API is a REST API.
- OData (Open Data Protocol) is a REST-based protocol for querying and updating data, allowing REST API client applications to access data in databases hosted by FileMaker Cloud.
- The Claris FileMaker Admin API is a REST-based API that allows web services to perform administrative tasks on FileMaker Cloud products and Claris FileMaker Server™.
FileMaker Cloud hardware and software requirements are listed here: FileMaker Cloud Technical Specifications.
Monitoring and managing instances
To use FileMaker Cloud Admin Console, you must be a FileMaker Cloud team manager. See Claris Customer Console Help.
After you've created and set up your FileMaker Cloud instance, you use your Claris ID to sign in to Claris Customer Console. Then, on the Hosts page, click Go to FileMaker Cloud Admin Console.
You can also sign in to FileMaker Cloud Admin Console directly, using the URL for your instance.
Use Admin Console to:
- view information about the host, connected clients, and data usage
- view and upgrade the FileMaker Cloud version
- work with databases, backups, and clients
- download databases
- configure FileMaker Cloud settings
- download log files
- configure FileMaker Data API, OData, and ODBC settings
- discontinue your subscription
Use Claris Customer Console to:
- add and manage Claris ID users and groups
- manage settings for your team and its Claris ID accounts
- set up external identity provider (IdP) authentication
- view information about your FileMaker Cloud subscription, and manage and upgrade your subscription
- download FileMaker software and license certificates
- update your Claris ID profile
- External IdP users cannot upgrade the subscription.
- The language used for displaying FileMaker Cloud Admin Console and Claris Customer Console is specified in your Claris ID profile. To change the language, in Claris Customer Console, click your Claris ID user name, then choose Profile. In the Claris ID Account area, click Edit. Choose a language, then click Save. The language used for external IdP users is based on the browser settings.
Navigating FileMaker Cloud
Viewing the system summary
When you sign in to Admin Console, you see the Dashboard page, which provides a summary view of your system. Admin Console also contains a set of tabbed pages for you to navigate as you administer FileMaker Cloud: Databases, Backups, Configuration, Connectors, and Subscription.
The Dashboard shows information about:
- host name, FileMaker Cloud version, and server ID
in-use connections to FileMaker Cloud
These can be FileMaker Pro, FileMaker Go, or FileMaker WebDirect connections.
- open and total hosted databases
the annual limit for data that can be sent from hosted databases to clients using the FileMaker Data API and OData
The limit is set by your purchase agreement.
- FileMaker Data API usage
- OData usage
total FileMaker Data Storage, the amount of data used, and the amount of data remaining
FileMaker Data Storage is a service that provides cloud-hosted storage for databases, externally stored container field data, and backup files.
CPU and memory usage, and network throughput
This data updates every 20 seconds.
The upper right of the Dashboard page shows the time in Coordinated Universal Time (UTC).
Next to the UTC time, the Notifications drop-down list shows important events for you to respond to, such as warnings on system usage, or notifications about upgrading to a new version of FileMaker Cloud.
Upgrading FileMaker Cloud
When a new software version or patch is available, you see an Upgrade link or a notification in Admin Console. Team managers also receive an email. Always keep your software up-to-date.
- FileMaker Cloud 2.19 is compatible only with Claris FileMaker 19 Platform clients.
- The Upgrade link is available only after your preferred host name has been approved and applied.
Encrypting and uploading database files
FileMaker Cloud requires all database files to be encrypted. Use one of these options to upload files:
- Upload an unencrypted FileMaker Pro database file. FileMaker Cloud encrypts the database and creates an encryption password when you upload the file. See About encryption passwords.
- Before you upload a database, in FileMaker Pro, encrypt the database file with a password. When you choose the file to upload, enter the encryption password.
- You must be a team manager to upload a database file. The file must have Claris ID account access for groups or individual users. You can select groups and users with a Claris ID account or an external identity provider (IdP) account. To set up external IdP accounts, see Claris Customer Console Help.
- FileMaker Cloud can host up to 125 custom apps.
- Only database files with password protection can be opened in FileMaker Cloud.
About encryption passwords
When you upload an unencrypted file, FileMaker Cloud encrypts the file and creates an encryption password.
To show the encryption password for a database:
- In Admin Console, click the Databases tab.
Click the down arrow to the right of the database name, then click Show Encryption Password.
Note:This option is available only if you saved the encryption password, or the file was encrypted by FileMaker Cloud.
- Enter your Claris ID user name and password.
Important:Keep the encryption password in a secure place. You need this password to open the database. Before you download or delete a database, make sure you have the encryption password.
Setting up authentication
For files hosted by FileMaker Cloud, users are authenticated by their Claris ID account or by an external IdP account. To set up external IdP authentication, invite users to a team, or add users to groups, see Claris Customer Console Help.
Before you upload a file, use FileMaker Pro to create Claris ID or external IdP account access for groups or individual users. See FileMaker Pro Help.
Uploading, encrypting, and opening database files
- Open FileMaker Pro, and use your Claris ID or your external IdP user name and password to sign in.
- Click Allow if you are asked to allow using the page to open FileMaker Pro.
- In FileMaker Pro, choose File menu > Sharing > Upload to Host.
In the Upload to Host window, click Show next to the team name, then click the FileMaker Cloud host name.
You can also enter the host name in the search box.
- Browse to the file or files, then click Open.
- If the file is already encrypted, enter the encryption password.
- Click Upload.
After the upload completion message appears, click Done.
If you didn't choose the option to open the file automatically, continue to the next steps.
- In Admin Console, click Databases.
- Click the right arrow next to the database and choose Open.
- If prompted, enter the encryption password to open the file.
To open the file in FileMaker Pro, on the Home page of Claris Customer Console, click the filename, then click Open in FileMaker Pro. You can also open the file directly in FileMaker Pro.
Working with databases and clients
In Admin Console, click the Databases tab to view, sort, and search uploaded databases. Click the down arrow to the right of the databases list to open, pause, resume, close, download, remove, rename, and show the encryption password for databases.
Use the right pane to manage client users connected to the databases:
- Select the checkbox next to Claris ID to select all users. You can also select specific users and sort by Claris ID user name, client, or sign-in (session duration).
- Click Disconnect to disconnect selected users. Enter an optional message to send to users and specify a delay time. (The default is two minutes.)
- Click Send Message to send messages to selected users (for example, if you plan to pause the database they are connected to).
- Before you download or delete a database, make sure you have the encryption password for the database. See About encryption passwords.
- After you select the databases to download, you receive separate notifications when each database is ready to be downloaded. In each notification, click Download.
- After you delete a database, it might take up to 20 minutes for the Dashboard to update the used and remaining space for FileMaker Data Storage.
Working with backups
In Admin Console, click the Backups tab.
Databases that have changes are automatically backed up every 20 minutes. Backups are stored for 30 days before automatic deletion begins. You can preserve backups, remove backups from the preserved list, edit the backup label, and restore a backup.
Viewing and managing backups
In the left pane of the Backups page:
- Click Auto-Backup to see a list of backups, to preserve backups, and to edit backup labels.
- Click Preserved to see the list of preserved backups, edit backup labels, and remove a backup from the preserved list.
Backups appear in timestamp order (in UTC time).
You can use the date box to filter backups by a specific date.
Creating backup labels
You can create a backup label to identify a specific backup.
- Select one or more backups.
- Click Edit Label.
- Enter the new name.
To filter the backups list by the label, enter a label in the Filter by Label box. To reset the current filter, click Clear search results.
- If you have more than one backup selected, they all receive the same label.
Working with preserved backups
You can preserve backups. Preserved backups cannot be automatically deleted by FileMaker Cloud.
You can remove preserved backups that are no longer needed. After you remove a backup from the preserved list, it is automatically deleted 30 days after the backup was created.
Preserve a backup:
- On the Auto-Backup tab, select the backup.
- Click Preserve Backup.
A check mark appears next to the backup in the Preserved column.
Remove a backup from the preserved list:
- On the Preserved tab, select the backup.
- Click Undo Preserve.
- In the right pane of the Backups page, select a backup, then click Restore Backup.
- Select the databases to restore, then click Restore.
- If prompted, enter the database encryption password.
After each database is restored, you receive a notification. The restored backup is added to the list of databases in the Databases tab. Restored files are saved as new files with the filename <filename>_Restored_<backup_timestamp>.
- To download a restored backup, click the Databases tab. Click the down arrow to the right of the database name, then click Download. After each file is ready to be downloaded, you receive a notification. Click Download in each notification.
- To rename a restored database, click the Databases tab. Click the down arrow to the right of the database name, then click Rename.
- To use the original filename for the restored database, rename the original file, then rename the restored file using the original filename.
- If you delete a database, the next scheduled backup will not include the database. To restore the deleted database, you must use the last available backup for the database.
- If you update a database after a scheduled backup and then delete the database before the next scheduled backup, your changes will not be saved.
Configuring FileMaker Cloud
In Admin Console, click the Configuration tab.
Setting the local time zone
- In Admin Console, click Configuration > General Settings.
- Click Change for Local Time Zone, then choose a different time zone.
- Click Save.
- Changing the local time zone changes the auto-maintenance schedule.
Setting session timeouts
In Admin Console, click Configuration > FileMaker Clients. Click Change for FileMaker Pro and FileMaker Go, or for FileMaker WebDirect, then choose a new session timeout. Changing the FileMaker WebDirect session timeout restarts FileMaker WebDirect and disconnects users. You can send a message from the Databases tab to warn users.
- Restarting FileMaker WebDirect takes several minutes. Do not make other FileMaker WebDirect changes until the restart completes.
- The session timeout for the FileMaker Admin API and FileMaker Data API is 15 minutes and cannot be changed.
Downloading log file entries
FileMaker Cloud tracks activity, client access, and other information, and stores this information in log files.
- In Admin Console, click Configuration > Logging.
- Click Select the log to download.
- Click the log name.
|event.log||Events that occur when the FileMaker Cloud database server is running. Examples include when the Database Server starts or stops, or when database files are opened or closed.|
|gateway.log||FileMaker Cloud Admin Console activities.|
|journal.log||Notifications and user actions. Examples include notifications about memory or data volume usage, and actions such as initiating an instance upgrade.|
|wpe.log||Web Publishing Engine events—such as Web Publishing Engine errors and FileMaker WebDirect errors—or FileMaker script-related errors.|
|fmshelper.log||The utility process that runs, starts, and stops all other processes.|
|awsmanager.log||Activities related to upgrading your FileMaker Cloud subscription or FileMaker Data Storage.|
|fmdapi.log||All FileMaker Data API errors that have occurred, and information about FileMaker Data API calls that access hosted databases.|
|stats.log||FileMaker Server performance and number of clients signed in.|
|fmodata.log||All OData errors that have occurred, and information about OData calls that access hosted databases.|
- User credentials and database entries are not logged.
Viewing the auto-maintenance schedule
In Admin Console, click Configuration > Auto-Maintenance.
Your FileMaker Cloud instance is automatically restarted once a day for auto-maintenance. You can't disable auto-maintenance. The Auto-Maintenance page displays the scheduled time for auto-maintenance in UTC time. Auto-maintenance starts within an hour after the scheduled time. To change the auto-maintenance schedule, you need to change the local time zone. See Setting the local time zone.
In general, auto-maintenance will not occur if clients are connected, but clients may be disconnected during auto-maintenance for critical updates. Make sure to save your changes before the scheduled auto-maintenance.
Important:The scheduled time for auto-maintenance is in UTC time. Make sure to calculate the difference between the UTC and your time zone.
Changing FileMaker Data API settings
Note:Change FileMaker Data API settings only when the databases are not being used. Clients can lose unsaved work when the FileMaker Data API Engine restarts.
The FileMaker Data API allows you to share your data with applications via a set of REST-compliant API statements.
To host a database for access via the FileMaker Data API:
- Prepare your database for FileMaker Data API access using FileMaker Pro. See FileMaker Data API Guide.
- In Admin Console, click Connectors > FileMaker Data API, then set FileMaker Data API to Enabled.
- Upload the database file to FileMaker Cloud. See Uploading, encrypting, and opening database files.
- Use a REST-compliant web service to send HTTPS requests in the form of URLs that specify the FileMaker Data API statements.
Hosting databases for access via OData
Note:Disable OData only when the databases are not being used by OData clients.
OData allows access to a database file from an OData-capable provider via a set of REST-compliant API statements.
To host a database for access via OData:
- Prepare your database for OData access using FileMaker Pro. See FileMaker Cloud OData Guide.
- In Admin Console, click Connectors > OData, then set OData to Enabled.
- Upload the database file to FileMaker Cloud. See Uploading, encrypting, and opening database files.
- Use a REST-compliant web service to send HTTPS requests in the form of URLs that specify the OData statements.
Setting up ODBC data sources
In Admin Console, click Connectors > External ODBC Data to set up ODBC data sources for access by FileMaker Cloud clients. When you add an ODBC data source and choose the driver type, the default port number for that driver is selected. However, you can select any port number from 1 to 65535, except for the reserved ports used by FileMaker Cloud. For a list of the ports used by FileMaker Cloud, see FileMaker Cloud Getting Started Guide.
Note:To test the ODBC data source connection, you must know the user name and password for the database.
Managing your subscription
To manage your FileMaker Cloud subscription and to download the license certificate and client software, use the Subscription tab in Claris Customer Console. See Claris Customer Console Help. To cancel your subscription, use FileMaker Cloud Admin Console.
Discontinuing your subscription
Before canceling your subscription, carefully review this information.
- In Admin Console, click Subscription > Subscription Center.
- Click Send Instructions to receive an email with instructions.
- Follow the steps in the email to download client software, logs, and databases.
Important:After your FileMaker Cloud license expires, you have 45 days to retrieve your data. After 45 days, your data will be deleted. To retrieve your databases and log files, see Claris Customer Console Help.
FileMaker Cloud considerations
- FileMaker Cloud Admin Console always shows time in UTC. If you want to use the local time zone, you must include the calculation (the difference between UTC and your time zone) in FileMaker Pro scripts.
- FileMaker Cloud does not support automatic login to a FileMaker Pro file using a specific account and password. If you upload a file and then change the file options in FileMaker Pro to specify an account and password, the file will not subsequently open in FileMaker Cloud.
- FileMaker Cloud does not support custom FileMaker WebDirect homepages hosted on the FileMaker WebDirect web server. Custom FileMaker WebDirect homepages can be hosted on an external website, but the list of databases cannot be displayed dynamically.
- FileMaker Cloud does not support uploading a FileMaker Pro runtime solution.
- FileMaker Cloud installs the following Linux fonts: Liberation, Baekmuk Batang (Korean), IPA Gothic (Japanese), and WenQuanYi Zen Hei (wqy-zenhei) (Chinese).
- FileMaker Cloud version upgrade and FileMaker Data Storage upgrade processes will take a few minutes. No clients can connect to FileMaker Cloud during this downtime. You should notify users to save their work and disconnect all users before initiating these processes.
- Before you initiate an instance upgrade, you should inform any users who might be signed in and ask them to save their changes and to wait for the process to complete.
- Your FileMaker Cloud instance is restarted once a day for auto-maintenance. You should inform users about the auto-maintenance schedule and advise them to save their changes and wait for the process to complete.
- By default, FileMaker Pro uses secure storage to encrypt container data that is stored externally. FileMaker Cloud uses FileMaker Data Storage for container data that's configured to be stored externally. For files hosted by FileMaker Cloud, you can't transfer data with secure storage to embedded container data. For information about secure storage, see FileMaker Pro Help.
- In FileMaker Cloud, the FileMaker Script Engine (FMSE) can only access the Data/Documents and temp folders. The FMSE is blocked from accessing a localhost port.
fmsadmincommand line interface (CLI) commands are not supported in FileMaker Cloud. If you use the Perform Script on Server script step with an
fmsadmincommand in your script, you might see FileMaker error code 812, "Exceeded host's capacity."
- You cannot establish an ODBC connection if the source name contains extended ASCII characters.
- When you configure an ODBC source with the Microsoft SQL Server driver and a non-default port, you must append the port number to the server IP address (for example: