Documenting developer solutions (FileMaker Pro Advanced)
You should provide documentation for your database solution, whether it is a database that must be opened in FileMaker Pro, FileMaker Pro Advanced, or a standalone runtime database solution. There are several ways that you can provide documentation for your solution, including a printed manual, an online Help system, and an About
layout that is available from any layout in the solution.
Create custom About and Help layouts that document what your database solution is, how to use it, and where users can go for more information. Then use the custom menus feature to attach
scripts to menu commands that open the About and Help layouts.
Note The FileMaker Pro and FileMaker Pro Advanced Help system is not available in runtime applications. However, status bar Help (Windows) and Help tags (macOS) are available.
Creating an About layout
For runtime database solutions, the FileMaker Pro Advanced license specifies that you must create an About layout that provides information for your users on how to contact you for technical support.
To create an About layout:
2. For Layout Name, type About <your solution>.
3. Select Blank Layout.
4. Click Finish.
5. Include in the layout your logo, other graphics, and your company information.
6. Include text that notifies users if the solution files are protected with passwords or if full access privileges have been removed.
8. Create a button that lets your users return to the main layout of the primary file.
9. Choose Scripts menu > Script Workspace and create a script that goes to the About layout.
10. Include the word About in the script’s name.
To display the About layout when the runtime application is started:
1. Open the primary file for the database solution.
2. Choose File menu > File Options.
3. In the Open tab of the File Options dialog box, select Switch to layout and choose the About layout from the list.
Creating a custom Help layout
Create a Help layout that provides instructions for how to use your solution and add data to it. Then create a script in the primary file of your solution to display the Help system. Use the custom menus feature to make the script available as a command in the Help menu.
If you want to create a webpage to document your solution, you can put a web viewer in your Help layout that opens the webpage.
Including printed documentation
You’ll need to provide instructions to your users on how to install your database solution. Here’s a list of things you should document:
•minimum equipment and software requirements
•how to install your bundled solution
•how to install custom files
•how to use software you might have included for:
•installing your bundled solution
•decompressing your solution files
•how to use your Help system
•how to reach you for technical support
Important In the event that your runtime database solution files become damaged, make sure users have access to your technical support email address or telephone number in your printed documentation or in a text file. If a database file is damaged, they may not be able to access the About layout in your solution to find out how to contact you.
You might also want to include the following recommendations:
•Tell your users not to rename any solution files (except the runtime application), or they may be unable to run your solution.
Related topics