Documentation wizard creates project documentation

Edited by the Engineeringtalk editorial team Dec 20, 2006

zenOn's system integrators have long enjoyed automatic engineering tools that can save weeks of engineering time by streamlining the design process and automatically defining variables.

Independent software innovator Copa-Data has announced a new built-in documentation wizard that creates project documentation easily in a fully automated process, furthermore it comes as standard for zenOn 6.2 customers as part of the new service pack 4.

Even the smallest project requires documentation, whether it is simply a book explaining the symbols in the SCADA project (inputs and outputs, colour coding, etc) or a full, picture by picture, definition of all symbols and variables.

It can take system integrators weeks to document a typical SCADA system.

This represents significant engineering cost and shortcuts can result in a lack of proper documentation which leads to future problems.

zenOn's system integrators have long enjoyed automatic engineering tools, such as project creation wizards that can save weeks of engineering time by streamlining the design process and automatically defining variables.

Now users can enjoy the same power and simplicity using the documentation wizard; with a single click an entire project can be documented in portable and user-friendly HTML.

The documentation wizard is written in VBA and can be fully customised by system integrators to meet their specific industry requirements.

One-click documentation is also invaluable for the customer.

Should they wish to make small changes to their system, the information needed is readily available.

When more detailed maintenance is required, the system integrator's maintenance team can refresh their minds quickly and easily by revisiting the HTML documentation.

A powerful 'detail filter' is also provided that adjusts the detail of the documentation depending on the target reader.

For example, the wizard could be used to create a 'light' operator manual or a verbose SCADA programmer's handbook.

In total, over 1,000 different properties can be configured.

With this in mind, the tool employs a user-friendly step by step wizard with check boxes to configure different versions of the technical and graphical documentation.

The technical configuration screens filter information such as data types, variables, recipes, drivers, and scripts.

Graphical parts of the SCADA project's documentation can be filtered to include the picture type, size, background and other relevant information that could be useful for system integrators and project designers.

The SCADA documentation created by the wizard is easy to use because images and screenshots are automatically inserted into the HTML and all variables and functions are cross-referenced, showing where each variable is used with respect to a function.

A standard project document includes a picture tree of the project, showing where each SCADA picture can be opened.

The documentation is available within the zenOn runtime environment and editor for ease of use.

This also means that the level of detail accessible to the reader is dependent on their SCADA system access rights.