Equipment Module Classes

For (Command Driven) Equipment Module Classes we generate documents from the following:

• Document data from an Excel Workbook,
• A Word Template, and
• Data extracted from FHX

Excel Workbook

The Excel Workbook has different Worksheets that define the document to be generated. The main Worksheet allows rows for:

• CaptionFigure, plus parameter to define the Caption text
  • Results in "Figure { SEQ Figure \* ARABIC}: <Caption as defined by the parameter>"
  • The parameter may contain field codes (e.g., "Schematic drawing of { DocProperty "EM Class" \* MERGEFORMAT }.")
• CaptionTable, plus parameter to define the Caption text
  • Results in "Table { SEQ Table \* ARABIC}: <Caption as defined by the parameter>"
  • The parameter may contain field codes
• Heading, including level, plus parameter to define the Heading text
  • Level 1 results in Style "Heading1", level 2 results in Style "Heading2", etc.
  • The parameter may contain field codes
• Image, plus parameter to define the kind of image, e.g.,
  • "Ext(Replace w. Schematic Drawing)" results in a dummy image with text "Replace w. Schematic Drawing" that can be replaced afterwards with the actual image
  • "SFC(CIP)" results in an automatically generated SFC diagram for the relevant Command - in this case "CIP"
• Paragraph, plus parameter to define the Paragraph text
  • The parameter may contain field codes
• Table, plus parameter to define the type of table, e.g.,
  • "Document Revision History" results in a table with Revision History data from the Revision History Worksheet
  • "Device List" results in a table listing the Module Blocks of the Equipment Module as defined by the FHX file
  • "Operating (or Tuning, or Calculated) Parameters" results in a table listing the Operating (or Tuning, or Report) Parameters of the Equipment Module as defined by the FHX file
  • "Linked (or Embedded) Composites" results in a table listing the Linked (or Embedded) Composites of the Equipment Module as defined by the FHX file
  • "SFC(CIP)" results in a table listing the Steps and Transitions for the relevant Command - in this case "CIP" - as defined by the FHX file
• Title, plus parameter to define the Title text
  • The parameter may contain field codes
• ToC, plus parameter to define the field code for the Table of Contents, e.g.,
  • "{ TOC \O "1-3" }" results in a Table of Contents listing Headings 1 through 3

The Workbook also contains a Worksheet where Custom Document Properties may be defined. These properties may be used in field codes that are referred to from Paragraphs, Captions, Headings, etc.

Word Template

The Word Template is a .docx document with custom Header (with Customer logo, for instance) and Footer. It may have certain Document Properties, which may be updated from data in the Excel Workbook. New Document Properties may be added from Excel. It should have certain Styles defined, e.g., Heading1, Heading2, HeadNoNumber, TableText, TableHeading, Caption, Normal, etc.

FHX File

The FHX file should be generated off one or more (Command Driven) Equipment Module Classes.