Diagnose the QY CAD data management configuration


The QY CAD Data Management Diagnostic Application helps you validate your data management configuration. The application verifies that properties were registered correctly, the search location is specified, and more, as shown below.

If you have a single-user deployment, simply run the diagnostic application on your local system.

If you have a multiple-user deployment, run the diagnostic application on your local system as well as on the server.

Note:

The Windows Search service must be enabled on each machine you want indexed by Fast Search. By default, the Windows Search service is disabled on Windows Server 2016 and 2019. Windows Search cannot be enabled in Windows Server 2019 if Remote Desktop Session Host (RDSH) is enabled. For more information, see Microsoft documentation at https://docs.microsoft.com/en-US/troubleshoot/windows-server/shell-experience/windows-search-is-disabled-by-default.

Distributed File System (DFS) Namespaces are not supported by Windows Search. Windows Search supports DFS Replication, but has not been tested with QY CAD data management. Any problems specific to this configuration will not be addressed.

  1. From the default installation location \Program folder, run BuiltinDiagApp.exe.

    Note:

    You must be a user with administrator privileges.

    The system displays the QY CAD Data Management Diagnostic Application, with all Validate options already selected for you.

  2. Select or clear the selection of options as needed:

    • Validate Search Service—Verifies that the Windows Search service (WSS) is running. We recommend that Log On As is set to Local System. We do not recommend to have the Startup Type set to Automatic (Delayed Start), because that can delay the indexing process.

      For details on WSS, see Microsoft TechNet.

    • Validate Service Account—Verifies that the Windows Search service is running on the local system account.

    • Validate Property Handler Registration—Verifies that property handlers are registered correctly.

    • Export Property Handler Registry—Allows you to export the current QY CAD property handler registries to the local disk. This data is generated at the diagnostic application location.

    • Validate Schema Path—Verifies the property schema registration for default QY CAD properties and registered custom properties.

    • Validate Indexed Properties—Verifies that QY CAD properties are indexed properly.

    • Validate Fast Search Scope—Verifies that the vault definition is valid. To learn more, see Define a QY CAD vault.

    • Validate Indexing Attributes—Verifies the Windows folder option that drives indexing contents and attributes. To access the option, right-click a file, choose Properties, click Advanced, and then in the Advanced Properties dialog box, select or clear the option Allow this file to have contents indexed in addition to file properties. Selecting this option increases the time it takes to validate your configuration.

    • Validate Data DeDuplication—Verifies if Windows Data Deduplication is configured on the server and enabled for any drive. If it is enabled for any drive, an error message and the Repair button will be displayed.

      This validation option is only enabled when running the diagnostic tool on a version of Windows Server OS. Windows Search does not support data deduplication.

  3. Click Validate.

    The application starts the validation process and if it identifies any issues, it displays the Repair button. The application displays error messages in red text and information messages in blue text.

  4. Click Repair.

  5. If the application reports that not all files in the vault are indexed, this error may be caused by differences in permissions in the folder structure, where the SYSTEM account, which runs the Windows Search service, does not have adequate permissions to index files and properties. You can resolve this error as follows:

    • If you knowingly broke inheritance in NTFS permissions to certain subfolders, add the SYSTEM account with full control to these subfolders, and allow changes to be propagated to all subfolders.

    • If you are not aware of inheritance in NTFS permissions being broken, assign permissions for the entire vault location, as follows:

      1. Right-click the top folder of the vault location, and then choose Properties.

      2. Choose the Security tab.

      3. Verify that the SYSTEM account has full control, and if it does not, assign it full control.

      4. Click Advanced, and then select the option Replace all child permission entries with inheritable permission entries from this object.

        For details on setting permissions, see Microsoft TechNet.

  6. To enable or disable auditing on all QY CAD property handler registries, click Enable Auditing or Disable Auditing, respectively.

    If you encounter any issues with the QY CAD registry, we recommend that you enable auditing to add an event watcher to the QY CAD registries. Auditing identifies the user account or application that modified the registry.

    Note:

    Because enabling auditing generates Windows logs very fast, we recommend that you do so only when required.

  7. To test the indexing, in the Test Indexing box, modify the default SQL query for your specifications, and then click Execute.

    The file path must be in the format <absolute file path>\<File name with extension>.

  8. To view the logs of all user actions, check your Temp directory for files with the name format, DiagnosticToolLogs_yymmdd_HHMMss.log.