Reference strings
- Last UpdatedSep 24, 2024
- 2 minute read
Reference strings refer to an object or to data within an object’s attributes. A reference string consists of an object's reference string plus an attribute's reference string.
object Reference + Attribute Reference
A reference string is the object name plus the attribute name: ObjectName.AttributeName.
In a multi-galaxy environment, a reference string to a remote galaxy is the galaxy name plus the object name plus the attribute name:
GalaxyName:ObjectName.AttributeName.
Use references and reference strings in a multi-galaxy environment as you would in a single-galaxy environment, with the exception of the galaxy name prefix, <GalaxyName>, followed by a colon as in the preceding example. For more information about using references and reference strings in a multi-galaxy environment, see Access multiple galaxies.
In TIC101.PV, TIC101 is the object reference and PV is the attribute reference. The AttributeName can be omitted in a reference string, PV being assumed in such cases.
Note: Some objects have a PV attribute, while others do not.
Reference strings are concatenated substrings, separated by periods. A substring cannot contain a period. Mathematical operator characters are not allowed. At least one character in each substring must be non-numeric. The total length of the reference string cannot be more than 380 characters, including periods between the substrings.
Avoid assigning objects and attributes names such that the same reference string can refer to two different things. For example, you have two objects named A1 and B2, and inside A1 you create an attribute named B2 with a data type of Float. A1.B2 refers to the attribute Float named B2. If you then assign object B2 so that A1 is a container of object B2, the reference A1.B2 could refer either to the object B2 or the attribute B2 Float.
Important: The Galaxy resolves reference strings. If the GR is not available, resolution is done on a peer-to-peer level. After initial resolution, an object is provided an alias that handles references to its location across your network. If an object is relocated or renamed, the reference string resolution is repeated and a new alias provided.