Troubleshooting and Diagnostics

This section provides guidance on troubleshooting common issues and performing diagnostics for the metadata structure within the MFSQL Connector. It covers key concepts, tools, and techniques for identifying and resolving problems related to metadata synchronization, automation, and overall connector performance.

The structure tables are inter-related and it is important to understand these relationships when diagnosing issues. The following sections outline common problems, their potential causes, and recommended solutions.

Refer to Metadata Structure Tables for more details on the structure tables

Common Issues and Solutions

  1. Metadata Structure Not Updating: If changes made in M-Files are not reflected in the SQL database, ensure that the procedure spMFDropAndUpdateMetadata has been run after the changes. Verify that the metadata structure version in the vault matches the version stored in the MFSettings table.

  2. Valuelist Items Missing or Incorrect: If valuelist items are not appearing as expected, check the MFValuelistItems table for the correct entries. Use the procedure spMFSynchronizeSpecificMetadata with the appropriate parameters to refresh valuelist items.

  3. Class Table Issues: If class tables are not being created or updated correctly, verify the MFClassProperty table for the correct property definitions. Ensure that required properties are marked as such and that data types are correctly defined.

  4. Automation Failures: If automated processes are failing, check the logs for error messages. Ensure that the procedures are being called with the correct parameters and that any dependencies are met.

  5. Performance Issues: If the connector is experiencing performance issues, consider optimizing the synchronization procedures by limiting the scope of updates using spMFSynchronizeSpecificMetadata. Review indexing on key tables to improve query performance.

  6. Data Inconsistencies: If there are inconsistencies between the M-Files vault and the SQL database, consider running a full synchronization using spMFSynchronizeMetadata to ensure all data is aligned.

  7. Error Messages: If specific error messages are encountered, refer to the procedure documentation for guidance on resolving the issues. Common errors may relate to permissions, data types, or missing references.

  8. Backup and Restore Issues: If issues arise after restoring a backup, ensure that the metadata structure is consistent with the current state of the M-Files vault. It may be necessary to run spMFDropAndUpdateMetadata to realign the structure tables.

  9. Custom Properties Not Appearing: If custom properties are not appearing in the metadata card, verify that they are correctly defined in the MFClassProperty table and that any additional properties are set using SpmfSetAdditionalProperty.

  10. Workflow Issues: If workflows or workflow states are not functioning as expected, check the MFWorkflow and MFWorkflowState tables for correct definitions. Use spMFCreateWorkflowStateLookupView to create lookup views for specific workflows.

  11. Logging and Monitoring: Implement logging for key procedures to monitor their execution and identify any issues. Regularly review logs to proactively address potential problems before they impact operations.

  12. Consult Documentation: Always refer to the official documentation for the most up-to-date information on procedures, parameters, and best practices. The documentation provides valuable insights into the correct usage of the connector and its features.