Output Diagram Templates
Templates are used as the basis of the output diagrams. They contain the formatting and layout elements of the documents and have textual formulae placed on them to mark where information from the project database will be substituted.
Each template that can be used in an output diagram requires a record in the project database. For each of the five types of templates there is a table in the database where the records for the templates exist. Templates can be added and removed from the tables in a similar fashion to components in the project database.
The generation of output diagrams from templates is very similar to the system used by the EDS Protogen module. The same standard EDS formula syntax is used, but in Instrument Manager, the fields used in formulae can also be relational columns or aliases, which make it possible to lookup relational data.
The formulae on a template will be displayed in the list view of Instrument Manager when a template is selected in the tree.
Templates can be viewed and edited using an editor native to their file format. This will be your CAD package for DWG files and Microsoft Excel for XLS, XLSX, XLSM or XLSB files. To view or edit a template, right click on the desired template and select "Edit/View" from the pop up menu. Instrument Manager will run the appropriate application and open the template file.
Instrument datasheet templates are Microsoft Excel XLS, XLSX, XLSM or XLSB format spreadsheet files. The formula fields on the templates generally map the cells in the datasheet to columns in the instrument tag and ratings records. Formulae in the title block map to the columns in the record for the datasheet itself.
In Datasheet templates, relational columns fields on the template are resolved from the tag record of the instrument. As an example, if an #R1:CATDESC# formula were used on any datasheet template then it would be the CATDESC column of the RATINGS record of the first INSTRUMENT on that datasheet that will load into the formula. A #D2:Title# formula would fetch the TITLE column of the datasheet record.
Datasheet templates can be found in the <EDS>\IMP_IM\DSTemplates directory for imperial units or the <EDS>\MET_IM\DSTemplates directory for metric units.
The Generic_Instruments datasheet template is not specific to any particular type of instrument. This template can also be used as a base for creating new datasheet templates for new instrument types.
Datasheet templates are the mapping files for importing data from datasheets.
Loop Diagram Templates
These are AutoCAD DWG files. Diagrams of this type are used as a basis for loop output diagrams. There are two types of loop diagram template that can be used in Instrument Manager.
Loop templates for simple automatically drawn loops
Simple loops have a standard twin conductor connection from the instrument to the DCS. These loop circuits can be derived and drawn automatically by Instrument Manager. A simple loop template will typically contain graphical elements for a border, title block and other items not related to the electrical components. The title block should have formula fields linking text or attribute entities on the diagram to columns from the loop diagram record in the project database. The electrical elements of the diagram (the loop itself) will be inserted by Instrument Manager when the diagram is generated - these are the loop component templates described below.
In simple automatically drawn loop diagrams, relational columns fields on the template are resolved from the tag record of the instrument. As an example, if an #R1:CATDESC# formula were used on an attribute on a template then it would be the CATDESC column of the RATINGS record of the first INSTRUMENT that will load into the attribute. A #D1:Title# formula would fetch the TITLE column of the loop diagram record.
Simple loop diagram templates can be found in the <EDS>\IMP_IM\LPTemplates directory for imperial units or the <EDS>\MET_IM\LPTemplates directory for metric units.
Custom Loop Templates
Custom loop templates are used to generate loop diagrams which have connections that are complicated and that "branch out" from the standard twin conductor connection between an instrument and the DCS.
A custom loop template should contain a template for the graphical elements of the entire loop circuit. This allows a completely customisable loop diagram to be created in any free form layout.
Custom loop templates contain relationships in order to connect to and load data from several components in the database. These relationships are NOT resolved in the same way as with simple automatically drawn loops. Please read the following linked section if you wish to create and use "Custom loops".
Loop Component Templates
These are AutoCAD DWG files. Simple loop diagrams are constructed automatically by Instrument Manager by inserting many small "loop component" template drawings, one for each component, onto the otherwise empty loop diagram template, thus building a connected loop circuit. Each component is represented by a loop component template appropriate to that component.
Custom loops do not use the loop component templates.
In loop component templates, relational column fields on the component template are resolved from the tag record of the component that the template represents. It could be a cable, wire, instrument or other. As an example, if an #"R1:CATDESC# formula were used on an attribute on a component template for a device then it would be the CATDESC column of the RATINGS record of the DEVICE that is being inserted that will be loaded into the attribute.
Loop component templates can be found in the <EDS>\IMP_IM\LPComponentTemplates directory for imperial units or the <EDS>\MET_IM\LPComponentTemplates directory for metric units.
Each component can be configured to use a specific loop component template. If a specific template is not configured it will use the default loop component template for its component type.
Loop Component Template Offsets and Width
Specific loop component templates may require positional information to ensure that they are placed correctly in the output diagram to align with other loop component templates. This information is supplied in five columns of the record for the loop component template. The five columns are provided with both a metric and imperial prefix so that the differently scaled values do not overwrite each other.
The columns are Horiz Offset, Vert Offset, Width, Term Horiz Offset and Term Vert Offset, with the appropriate prefix of Met or Imp. Horiz Offset and Vert Offset specify the offset from the point at which the template will be inserted to the top-left corner of the template. The Width column specifies the horizontal width of the template. The Term Horiz Offset and Term Vert Offset columns specify the insertion point of terminals onto the template. If the template will not have terminals these values are not required.
Hook-up Diagram Templates
These are AutoCAD DWG files. They typically will contain graphical elements describing the shape, position and connection details for instrument mounting hardware. It will also have a border and title block that will appear on a hook-up output diagram. The formula fields on the templates generally map the text or attributes on the hook-up diagram to columns in the instrument tag and ratings records. Formula fields in the title block map to the columns in the record for the hook-up diagram itself.
In hook-up diagrams, relational column fields on the template are resolved from the tag record of the instrument. As an example, if an #R1:CATDESC# formula were used on an attribute or text field on a template then it would be the CATDESC column of the RATINGS record of the INSTRUMENT that will load into the attribute/text. A #D3:Title# formula would fetch the TITLE column of the hook-up diagram record.
Hook-up diagram templates can be found in the <EDS>\IMP_IM\HUTemplates directory for imperial units or the <EDS>\MET_IM\HUTemplates directory for metric units.
Materials from hook-up drawings
The extra materials that are listed in the hook-up drawings (screws, brackets, glands etc), which are used to mount and connect instruments and devices, can be included in the EDS materials reports.
Use an "extra part table" block for each type of item (block name: oeTable.dwg) to create a table of these materials on the hook-up drawing. The contents of extra part blocks is automatically included in the EDS materials reports.
You can insert the extra part table block from the Elecdes "Reference and Indicators" symbol menu. Graphically the extra part table block looks like a single row from a table.
For more information about the materials reports, see How to Add non-Electrical Parts to the Bill of Materials (Ebase).
Terminal Strip and Wiring Diagram Templates
These are AutoCAD DWG files. Templates of this type are used as a basis for terminal strip diagrams for terminal strips or wiring diagrams for devices. They typically will contain graphical elements for a border and title block. The title block should have formula fields that map to the columns in the record for the terminal strip or wiring diagram itself.
In terminal strip and wiring diagrams, relational column fields on the template are resolved from the tag record of the terminal strip or device. As an example, if a #TAGNAME# formula were used on an attribute on a template then it would be the TAGNAME column of the appropriate terminal strip or device that will load into the attribute. A #D4:Title# formula would fetch the TITLE column of the terminal strip or wiring diagram record.
Terminal strip and wiring diagram templates can be found in the <EDS>\IMP_IM\TSTemplates directory for imperial units or the <EDS>\MET_IM\TSTemplates directory for metric units.
Multiple Components on One Diagram
Multiple components can be linked to a single diagram. For example, a tabular datasheet, or three loops shown on one loop diagram.
Numbered Fields - #Tagname_3#
The formula fields on a diagram that contains multiple components will be "Numbered fields". Each field will end in an underscore, followed by a component number, e.g. #R1:CATDESC_1# for the first instrument, #R1:CATDESC_2# for the second instrument.
Note that numbered fields are not required for loop diagram templates. The electrical components shown on simple, automatically drawn loop diagrams use loop component templates, which are specific to each component.
Note that numbered fields are not required for custom loop diagram templates. Custom loop diagrams use a different system where the relational column fields are resolved from the record of the custom loop diagram.
On datasheets, multiple components can be shown using numbered fields on one sheet, or as clones of the tabs or sheets.
For example, if you link five instruments to a single datasheet that does not use numbered fields (i.e. it appears to be a template for a single instrument), then the individual sheets within the datasheet template will be cloned for each of the five instruments.
The two methods of showing multiple components can work together. For example, if your template has a single sheet that can show 25 instruments and you link 40 to the diagram, then the final datasheet will contain two sheets, the first containing 25 instruments and the second containing the remaining 15.
If a template is designed to have sheets cloned to show multiple instruments but also contains sheets that should appear only once, you can define a pattern to identify the names of any sheets that should not be cloned in the datasheet preferences.
The record in the project database for each template can optionally specify the maximum number of components that can be shown on a diagram generated from that template. Right click on the desired template and select "Set Component Limit" from the pop-up menu to specify this value. Alternatively, the "Component Limit" column can be edited in the row and column edit mode of the Instrument Manager window. A component limit of "0" indicates that there is no limit specified for that template.
The order that multiple components appear on a single diagram can be set by manually assigning a number that represents the position for each component assigned to the diagram. Enter increasing numbers into the appropriate *_Order column of each component tag record.
Use DS_Order to arrange components on datasheets.
Use HU_Order to arrange components on hook-up diagrams.
Use LP_Order to arrange instruments on simple, automatically drawn loop diagrams.
Ordering is not necessary for terminal strip and wiring diagrams because the individual components are arranged using the EDS Wiring Diagram Generator.
Ordering by a column is not necessary for custom loop diagrams because each component is assigned to a specific link on the custom loop diagram, as described below.