SysCAD Tags

From SysCAD Documentation
Jump to navigation Jump to search

Navigation: User Guide -> SysCAD Tags

Copy and Paste Tags SysCAD Tags

Model Tags

Some tag naming rules need to be observed when naming unit models (ie Feeder, Tanks, Pipes, Controllers etc). For example, the Tag name for the Feeder below is "Plant_Feed"

ModelTag.png

The following rules apply to Model Tag names:

  • Must be unique within a project.
  • Tags are not case-sensitive.
  • A tag may not contain any "whitespace". So no spaces, tabs or control characters.
  • A tag may not contain aSpecialCharDot.png(dot). TheSpecialCharDot.pngis used to separate the parts of a full tag.
  • Tag may not begin with =
  • A tag may not contain any of the following characters SpecialChar1 137.png
  • Tags cannot only contain numeric (0-9) characters. For example "120053" is not allowed.
  • If the project setting "Allow Tags Beginning with Numeric" is NOT selected then the first character of a tag cannot be a numeric character (0-9).
  • The tag length should not be too long. The maximum length allowed is 50 characters

Note

  1. Build 137 has stricter tag naming rules, in addition to the Build136 tag restrictions, these characters are also not allowed anywhere in the tag SpecialChar137.png
  2. Build 136 tag restrictions:
    • tags cannot begin with SpecialChar3.png
    • tags cannot contain any of these characters SpecialChar1.png.
  3. Tag name may not be able to handle foreign language such as Chinese, please input tag name using English keyboard if possible. This also applies to punctuation marks.
  4. These tag naming rules also apply to User Calculation variable naming and SysCAD project naming. One exception do apply, the dot(.) can be used in these names.

Species Tags

Some tag naming rules need to be observed when defining species in the Species Database, these apply to the Species Definition fields as shown and explained below:

This field describes the species and is often the common or English name for the species, e.g. Water, Lime, Nitric_Acid, etc.This field is normally the chemical formula of the species, e.g. H2O, HNO3, etc.This is the component name and is usually the same as the Short Name.This field defines the elemental make up of the species, and the charge, if required.The user must select the appropriate phase for the species, either Gas, Liquid or Solid.This is the individual phase of the species, e.g. s, l, aq, ml, etc.Species Definition1.png
About this image

Species tags are case sensitive. For the full tag "P_002.Qo.QM.H2O(l) (t/h)" the "H2O(l)" part is case sensitive.

The following rules apply to the Long Name field when defining a species: for example "Water" or "Sodium_sulphate"

  • May not contain any "whitespace". So no spaces, tabs or control characters. Build 135 and earlier allowed spaces.
  • May not contain a SpecialChar1 137.png (See Note)
  • May not only contain numeric (0-9) characters.
  • The maximum length allowed is 50 characters.

The following rules apply to the Short Name and Component fields when defining a species: for example "H2O" or "Na2SO4"

  • May not contain any "whitespace". So no spaces, tabs or control characters.
  • May not contain a SpecialChar5.png (See Note)
  • May not only contain numeric (0-9) characters.
  • If the tag contains one or more of '+' and/or '-', these must be at the end of the tag.
  • The maximum length allowed is 50 characters.

The following rules apply for the Individual Phase label when defining a species: for example "aq", "organic" or "slag"

  • May not contain any "whitespace". So no spaces, tabs or control characters.
  • May not contain aSpecialCharDot.png(dot).
  • May not contain a SpecialChar7.png (See Note)
  • May not only contain numeric (0-9) characters.
  • The maximum length allowed is 20 characters.

NOTE: Species name may not be able to handle foreign language such as Chinese, please input tag name using English keyboard if possible. This also applies to punctuation marks.