Drop us a line...

Send Message

Customizing Process Reports

open all - close all

The following steps outline how to create reports using the Mickabooh Control & tracking system. To create a new report template, click the New Template button to open the Report Templates Manager.

When the "Report Templates Manager" is open, it shows an empty report with two data block panes separated horizontally. Each pane can hold one of the data blocks from the Available Data Blocks toolbox. From the File menu, you can use the Page Settings menu to change the report to either Portrait or Landscape (new reports are created using Portrait.) You can also adjust the report margins from the Page Settings menu as well.

Block Panes

Any pane can hold any data block, but each pane can contain no more than one block. Any pane can also be separated into two panes. Right clicking in an empty pane will open the Pane Manager Menu, allowing you to create additional panes.

Any pane can be split even if it already contains a data block. If the pane does contain a data block, the block and its configuration will be retained.

Pane Separators

The panes separators are added automatically and can be moved to adjust the sizes and location of each pane. To move a separator, hover the mouse over it until the direction arrow appears , then using the left mouse button, click and drag the separator to its new location.

Right clicking the pane separator will open the Pane Separator menu allowing you to further configure the separator.

Printing the Separator

By default each separator created will print when the report template is used. Clicking the Print Separator item will toggle the print status of the separator allowing you to effectively turn off the separator when it prints.

Separator Width

Each separator's width can also be adjusted. Clicking the Separator Width item will open a sub menu that allows you to set the width.

Separator Color

Clicking the Separator Color item will open a color selection window so you can change the color of any separator.

Inserting a pane

A separator essentially splits a parent pane into two child panes. Inserting a pane from the Pane Separator menu will insert a pane either above, below, left or right of the parent pane.

Removing the separator

To remove a separator, click the Remove Separator item. If there are no data blocks on either side of the separator, the separator will simply be removed yielding an empty pane where two panes once resided. If there is a data block on only one side of the separator, the separator will be removed, and the resulting pane will contain the data block. If however there are data blocks on both sides of the separator, the Remove Blocks window will be displayed allowing you to choose which content to retain.

Changing the separator orientation

Clicking the Orientation item will open a sub menu allowing you to set the orientation of the separator to either horizontal or vertical.

Note about changing the separator orientation:

If a horizontal separator is changed to vertical, the data block above the separator will end up on the left side of the separator and the block below it will end up on the right side. For a vertical separator, the block on the left side will end up above the separator, and the block on the right, will end up below it.

Data Block Types

All of the information collected by the Mickabooh Controller is categorized into one of the available data blocks shown in the Available Data Block toolbox. By creating panes as outlined above, you can then drag and drop a specific data block into a pane to build the report. A pane can hold only one data block, but the same data block can be added to multiple blocks.

Each block will allow you to include different information in the process and each block is also configurable. After adding a block to a pane, the block's configuration window will open, allowing you to further customize your reports. Many of the data blocks have common configuration fields including text alignment, font, and color. Those data blocks configurable beyond that will be discussed separately.

Chart Block

The chart block will include the real time voltage, current and temperature chart created by the process.

Drawing the voltage, current or temperature

A chart data block can be configured to display the process variables (voltage, current and temperature) independently by placing a check next to the variable. Each variable can also be drawn using any color you choose. To change the color of one of the variables, click the colored square to the right of the variable.

Note about drawing the voltage, current and temperature:

If the voltage, current and temperature are all drawn on the same chart, the voltage and current will be scaled using the rectifier's maximum outputs. For example, for a 24V/1000A rectifier, the top of the chart would represent 24V/1000A. If one or more of the process variables are excluded, the voltage and/or current will be drawn using its own axis that shows the scaled values.

Drawing the axes

You can choose to include either the X and/or Y axis by checking the Draw X axis or Draw Y axis options.

Changing fonts

The chart block fonts are fully customizable as well. By clicking the All Fonts button, you can change the font for all of the text in the block. This action will change the font for any visible axes as well as for the legend. You can also change any element's font independently by clicking the "X axis font", "Y axis font" or "Legend font" buttons.

The remainder of the blocks will be discussed, but the screen shots have been left out. Essentially they all have the same customization with different content. To see what each block editor looks like, please use the Download link at the top of the page to view the PDF version of this page.

Controller Details Block

The Controller Details Block includes information about the controller itself. Like the company header block, you can independently choose which items to include, and you can set the text alignment, font and color.

Date Time Block

Using a Date Time block will include the date and/or time the report was created. You can customize the date and time formats independently, display the date and time on one line or two, and you can set the text alignment, font and color.

Image Block

When an image block is included on a report, a file selection window will open allowing you to include an image file. Multiple image types are supported including png, bmp, jpg and gif. When the image is selected and the report template is saved, the template is saved with the image embedded, so there is no dependency on the original image.

Note about Image Blocks:

When an image is printed in a block, it will be resized to fit the pane it is in. The aspect ratio however will remain the same so there will not be any distortion or "stretching" of the image.

Process Events Block

A Process Events block contains the Protrak events that were detected for the work load. You can customize the formats of the date and time the event occured as well as the text alignment, font and color.

Process Times Block

The Process Times block includes the tank immersion times as well as the process variables (temperature, conductivity, etc) for the tank while the work load was in the tank. Using the configuration options, you can select any or all process details you need for you documentation. You can also customize the text alignment, font and color.

Program Details Block

The program details block includes the details about the rectifier program that was used for the process. You can customize which parts of the program to include as well as the text alignment, font and color.

Note about the instruction count:

If a program has more instructions than the number selected for the maximum to print, the instruction list will be appended with the phrase "Plus X more..." where "X" is the number of instructions in the program that were omitted.

Program Details Block

The program details block includes the details about the rectifier program that was used for the process. You can customize which parts of the program to include as well as the text alignment, font and color.

Note about instructions:

If there were additional instructions added to the program for Add Plating, the additional instructions will be appended with "- EXTRA" to indicate they were a result of add plating. For more information about Add Plating, please see the Add Plating Technical Brief for details.

Rectifier Results Block

The Rectifier Results block will include information that pertains to the rectifier outputs during the process. These outputs include when the rectifier started and stopped, the number of amp-hours (or amp-minutes), and the maximum voltage and currents experienced during the run. Also included is a log of when and how long the process was paused, and when and by how much the load size changed. As with many other blocks, you can choose which of these items to include and you can also customize the text alignment, font and color.

Report Number Block

Using the Report Number block you can include the report number and total number of reports created for the process. The total number of reports will be the number of data field sets entered by the operator when process information was being entered. The report number is shown as which number the particular report is out of the total number of reports (i.e. 1 of 3, 2 of 3, etc). For more information about Data Fields, please see the Data Fields section of the Documents Library.

Text Block

Using a Text Block will allow you to include text on a report. By including text on a report, you will enter whatever text you need, and that text will appear on each report. The text is not changeable from report to report and should be considered static. After entering the text, you can customize its alignment, font and color.

User Data Block

A User Data block is much like a text block except, it will include all of the data field values entered by the operator when the process information was being entered. The only customizable fields for a "Use Data block" are the text alignment, font and color. For more information about Data Fields, please see the Data Fields section of the Documents Library.

Work Order Block

The Work Order block will display the value of the Work Order Data Field. For this value to be populated when the report is created, one of the data fields must be marked as the work order field. With the Work Order block, you have the ability to set the work order title and the work order text alignment, font and color independently.

Editing a template

To edit a report template click the Edit Template button to open the template. When you are editing a report template you can add and remove panes as outlined above, or you can edit an existing data block by double clicking it or by right clicking it and choosing Configure Block. To remove an existing block, right click it and select Remove Block.

Identifying Panes and Parents

To make editing a template easier, panes/parent relationships are color highlighted. To view a parent pane relationship, click one of the pane separators on a populated report template. After doing so, the associated panes (the left/right panes or the top/bottom panes) will have different color boarders drawn around them as shown.

As mentioned above, a data block gets added to a pane, and 1 pane can be split into 2 panes that are inside of a parent pane. Without care, and attention, it can become confusing trying to figure out what panes are parented to what panes. This color coding feature helps avoid the confusion, when you click on a pane separator, all of the panes associated with that separator will be drawn with a colored boarder as shown below.

After clicking the pane separator in the image to the right, the top pane (or left panel for vertical separator) will have a light blue boarder whereas the bottom (or right) pane's boarder will be light red. In another situation, selecting a separator with multiple attached panes, will have similar results.

By clicking the center separator in the image to the left, we can see it has panes on either side, both of which have been split further. One thing to recognize is that the right pane has been split into a top and bottom pane, and its top pane has been split further into a top and bottom pane. Understanding how the pane/parent relationships are constructed will help you understand how to modify the template.

Removing a template

To remove the current template, click on the "Remove Template" button .

Set a default template

After creating a template, it must be selected as the default template. By selecting a template as the default, it will be used to create the process documentation when a process is closed. There can only be one default template. If no template is marked as the default, the Print Report options in the Report Settings will BOTH be disabled.

Testing a template

After you have created a template, you can test it with default information by clicking the PRD, Print or Print Preview buttons.

Note about designing report templates:

After you have created a template and tested it, you may need to edit the template after using your data. You may have data blocks that do not fit in the panes you have created. If this occurs, simply open the template and either make adjustments to the size of the panes, or to the font size for the offending data block.

The ability to create customer reports was included in the Mickabooh Controller because everyone has different requirements and different data. The first version of our control system included a static report that could not be changed. Our customers needed something more however, and each needed something different. We listened and now offer report customization to a degree that is not found anywhere else in the industry.