Russell Heppell, Jun 4, 2024, Portage Bay blog

Source: https://www.portagebay.com/blog/install-our-free-filemaker-logging-add-on-v2-0/

Three years ago, we proudly launched our initial version of PBS Log, a robust add-on designed for FileMaker solutions. Today, we are pleased to unveil an upgraded version, available for free in the Claris Marketplace.

Read below to see how to incorporate the add-on in your solution. And check out this area of our website to find even more free add-ons and demos that will help expand your development skills.

Goals of v2.0 of the FileMaker Logging Add-On

The core objectives of version 2.0 are to provide you with:

  1. Clear Call to Action when viewing the log listing.
  2. Efficient Filtering for easy retrieval of specific records.
  3. Informative Headers that tell a story—who, what script, and when was the log created.
  4. Modern Design: Sleek and contemporary for a visually appealing experience.
  5. Logical Chaining: Clear chaining of log records for multi-session logs.
  6. Settings Popover: An intuitive settings popover to access various options, such as:
    1. Logging instructions
    2. Record cleanup
    3. Data export
    4. Test record creation 
    5. Time offset

Easily Add Simple Logging Functionality to Any FileMaker Solution

With PBS Log, integrating simple FileMaker logging functionality into your solution is a breeze. This add-on features a visually appealing log in both list and detail views, robust filtering capabilities, comprehensive add-on instructions, and log record export functionality. The Claris documentation for logged information is accessible by clicking on the label from the log detail view.

Example Use Cases

The PBS Log proves valuable in many scenarios, including:

  • Session Logins and Logouts
  • Data Import Processes
  • User Activities: Record creation, deletion and other interactions.
  • Server-side Script Processes
  • FileMaker Go Actions: Particularly useful where the debugger is unavailable.
  • PSOS Scripts: Ideal for server-side script execution.
  • Relating Log Records to Data: Utilize a foreign key field to give your logging better context.

Important Considerations

When incorporating a custom add-on, remember:

  • Installation Impact: the add-on creates new tables, fields, scripts, layouts, and value lists.
  • Uninstallation: Follow the Claris help documentation for proper add-on removal, which deletes all calls to the main logging script and associated data permanently.
  • Custom Scripting: Develop a wrapper script that calls the main logging script by name for centralized control, which is essential when upgrading or removing the add-on.

Sample Wrapper Script

Installing and Implementing the Logging Add-On

Follow these steps for seamless integration:

  1. Quit FileMaker Pro.
  2. Unarchive and then copy the “PBS_Logging_Add_On” folder into the appropriate location:
    1. Mac: HD/Users/YOU/Library/Application Support/FileMaker/Extensions/AddonModules
    2. Windows: Users\YOU\AppData\Local\FileMaker\Extensions\AddonModules
  3. Open your FileMaker Pro file.
  4. Enter Layout Mode on any layout.
  5. Open the Add-Ons tab and click ‘+’ to add a new Add-On.
  1. Click “Choose” to install the Add-On.
    1. Note: The installation process may take a few minutes.
  2. After installation, discover new layouts, scripts, tables, relationships, and even some sample data in your solution.

Implementing the FileMaker Logging Add-On

Implement PBS Log with ease:

  • Knowledge Prerequisite: Basic familiarity with scripts and JSON.
  • Example Script: Refer to “Log_Example” script for guidance or reuse.
  • Logging Script Parameters: Passed in JSON format for flexibility and customization.

Now You Can Easily Track Anything in Your Solution

That’s it! Just copy and paste a few lines of code, adjust the parameters as needed, and  you have gained the ability to effortlessly track various activities and session times in your solution.

We are thrilled about the enhanced UI of our add-on and look forward to seeing how you leverage this log feature. If you have any questions in implementing or customizing the PBS Log to suit your solution’s needs, don’t hesitate to reach out for a free consultation. We’re happy to take this add-on and create custom logging in your FileMaker solution. Happy coding!

File last updated: 5/6/2024