Template:Common Data on Info Tab Page

From SysCAD Documentation
Jump to navigation Jump to search
Tag(Long/Short) Input / Calc Calculated Variables / Options

Documentation

EquipDescription / EqpDesc Input Description of the equipment. If not blank, this text will be displayed in the 'GenDesc' field on the first tab page of the unit.
EquipMemo / EqpMemo Input A description of the unit as a memo text field. This field is handled by SysCAD like a normal tag, therefore it can reported and set via Excel.
Link1/2 Hyperlinks Hyperlink to a web page or file. There are two fields available for Hyperlinks. If a valid link is entered, the globe icon lights up and becomes clickable.
Web pages should begin with http:// or https://, and files should begin with file://host/ (or simply file:/// for local files).
EquipIdString / EqpIdStr Input Equipment identifier that can be used for reporting.
EquipLocation / EqpLocation Input Equipment location identifier that can be used for reporting.
ReportMe Tick Box Useful flag to reference to include/exclude models or pipes in Excel TagSelect reports.
ReportKey Input Custom report key number - this may be used to select user defined keys for reporting.
GeneralDescription / GenDesc Display This is an automatically generated description for the unit. If the user has entered text in the 'EqpDesc' field above, this will be displayed here. If this field is blank, then:
  • For pipes, SysCAD will use the text in the 'ConnectDesc' field - this displays the Source and Destination tags of the pipe;
  • For Feeders/Cross Page Connectors, SysCAD will display the state of the unit, i.e. if it is a Feeder or a Sink, etc.;
  • For other units SysCAD will display the unit class ID.

System Info

UnitType Output The unique Type of the model. This will be identical to the title of the first tab page. Useful for selecting types of units/pipes in Excel TagSelect reports.
UnitGroup Output A group that this UnitType belongs to - Unit, Control, Stream, OtherLink or Electrical. Useful for selecting groups of models in Excel TagSelect reports.
DllName Output Each SysCAD unit-model is stored and distributed in a "dynamic-link-library" (dll). The name of the dll where the unit-model is stored will be displayed here for user information.
SubTypeList Output List of all SubType sub models found in this model. There may be one or many of each SubType. These are primarily used in TagSelect for reporting and queries.
AddOnsReqdList Output Some SysCAD unit-models require specific add-ons to load the model. For example, the Flash Tank 2 unit-model requires the HeatBalance Addon to load. If user does not have the "HeatBalance" add-on license option, then the project will fail to load.
AddOnsUsedList Output Some SysCAD unit-models require specific add-ons to run the model. For example, the General Separator unit-model using Solids PSD Solids separation method requires the PSD Addon to run. If user does not have the "PSD" add-on license option, then the project will not solve using the PSD option.
Retrieved from "https://help.syscad.net/index.php?title=Template:Common_Data_on_Info_Tab_Page&oldid=75140"