Running the Consistency Checker

Scenario: The Consistency Checker is an engineering, diagnostic tool that is used to check and attempt to fix the software for errors that may exist between the graphics stored in the project folder and System Browser. The tool uses a specific task files (.DLL) that you load and unload, to determine the tasks (or checks) that the Consistency Checker performs on your system.

Select the topic related to your task:

Configure the Consistency Checker

You are in the Graphics Editor and want to load a task file (.DLL) into the Consistency Checker tool.

From the File menu, select Consistency Checker.

The Consistency Checker tool displays.

From the Settings tab, enable the following check boxes, as needed:

Watch in File System – Click this checkbox to enable the Consistency Checker to 1) recognize when a task file has been added to the directory, and 2) automatically add load the task file.
Save Exceptions (Save to log) - Click this check box to always write exceptions into the export log file.

Load a Custom Task File

You are in the Graphics Editor and want to load a customized task file (.DLL) into the Consistency Checker tool and it is not loading when you click Refresh . You can manually add a .DLL file to the tool, by doing the following:

From the File menu, select Consistency Checker.

The Consistency Checker tool displays.

Right-click anywhere in the Tasks Tab > Tasks section, and select Load.

The Open dialog box displays.

Select GMSProjects > GMSMain Project > Bin directory, and select the required task file (.DLL). For example: [YourFileName].dll

The task file is loaded into the Consistency Checker.

If the Task list is empty or has not updated with the new tasks, click Refresh and the task list is updated to display all loaded tasks.

Run a Task in the Consistency Checker

You have loaded one or more tasks and you want to run the tasks to check and synchronize your graphic files in your project folder against the graphic files listed in System Browser.

You have a backup of your current graphic libraries.

You should only run one task at a time.

Information

NOTE:
When you run the Update Symbol Dependencies task, you must use the Fix or Auto Fix options, rather than to fix them manually

From the Tasks tab, in the Tasks section, select the Enabled check box for each task you want to execute.

If a task has additional properties and you want to adjust or view those properties, in the Tasks pane click the task whose properties you want to view, and then click to display the Properties of Task pane. The properties associated with the highlighted task display.

In the Properties of Task pane, make the necessary changes to the properties, if any.

To make changes to a Key or Value – Select the property you want to modify. The Key and Value data displays in the two fields below. For more information on what your options are with each property, hover over the to see a tooltip with the property description.

To apply changes to the Key and Value fields, click.

To restore the properties to the default settings, click

(Optional) If you want the Consistency Checker to automatically fix any discrepancies or issues found, select the Auto Fix check box.

Click Check to run the Consistency Checker and execute the enabled tasks.

The Consistency Checker starts to execute each task. The progress of each task is noted by the icon in the State and the Progress field. If needed, click Pause, Stop or Start.

(Optional) To save the Consistency Checker log file, navigate to the Log tab, and click Save to File.

The Save As dialog box displays.

Navigate to the appropriate file location and click Save.

The file is saved as a CCLog_[Year]-[Month}-[Date].txt file.

To fix the errors generated by running the tasks, you can do one of the following:

Click Fix at the top of the Consistency Checker – this will fix all the errors.

Right-click an individual error, and select Fix from the menu that displays on right-click.

Unload a Task File

You are in the Consistency Checker tool in the Graphics Editor and want to unload a task file (.DLL) so that those task no longer run or display.

On the Task tab, right-click anywhere in the Task section, and then select Unload.

The task file (.dll) is no longer loaded and the Consistency Checker is cleared of all tasks.

Example 1: Importing Graphic Files Using the Consistency Checker Tool

You can import graphic files (.ccg or .cct) from one project into another, or import from a custom folder to your current GMSProject\[YourCurrentProjectName]\Graphics folder using a system task from the Consistency Checker. Alternatively, you can drag-and-drop your custom graphics to the Graphics Editor and save each graphic to the current project folder.

NOTE: When you run a Consistency Checker task, you must only run one task at a time.

Copy and then paste all your graphic files from the old project over to the current project where you would like to use the graphics: GMSProjects\[YourProject]\Graphics folder.

In the Graphics Editor, navigate to the File menu, and click Consistency Checker.

Select the Check *.ccg and *.cct files against System Browser nodes check box, and then click Check.

The Consistency Checker goes through the project's Graphics folder and compares what .ccg's and .cct files are in the folder compared to the System Browser Graphics tree.

When the Consistency Checker is finished checking, Completed with Findings displays next to the task and in the Findings pane, a list of the graphics found in the Graphics folder but not the System Browser Graphics tree display.

In the Findings pane, right-click the Solution column heading, and then select Fix All.

The Consistency Checker runs to save the Graphic to the System Browser Graphics tree.

Completed Success displays next to the task and next to each graphic in the Findings section.

Your graphics have now been imported into the project's Graphics folder and display in the System Browser Graphics tree.