Substitution Tokens

Tokens are text strings used in the configuration that represent a value. Tokens are used by publisher output types. When a token is found in a configuration property, the token string is
replaced with a value. For example, the token $$Meter.Name$$ is replaced with the name of the actual meter.

TokenValue
$$Timestamp$$The date and time of the record in "VT_DATE" format
$$Date$$Ten-digit text representation of the record timestamp's date ("yyyy-mm-dd")
$$Day$$Two-digit text representation of the record timestamp's day ("01" to "31")
$$Month$$Two-digit text representation of the record timestamp's month ("01" to "12")
$$Year$$Four-digit text representation of the record timestamp's year ("2010")
$$Time$$Eight-digit text representation of the records time ("00:00:00")
$$Hour$$Two-digit text representation of the record timestamp's hour ("00" to "23")
$$Minute$$Two-digit text representation of the record timestamp's minute ("00" to "59")
$$Second$$Two-digit text representation of the record timestamp's seconds ("00" to "59")
$$TZOffset$$The offset (in minutes) from GMT of the device's time zone
$$EndDate$$The end date of the history record, in string format ("YYYY-MM-DD")
$$EndTime$$The end time of the history record, in string format ("HH:MM:SS")
$$Meter.ObjectID$$ACM's unique numerical identifier of the meter
$$Meter.ObjectName$$The name of the meter object in the ACM configuration
$$Meter.Name$$The name of the meter as resolved by the Meter ID field. The meter configuration object includes a setting that controls how a meter name is determined
$$Meter.RunNumber$$The one-based meter run number of the record.
$$Meter.Content$$A ‘Gas’ or a ‘Liquid’ string identifier of the meter content type.
$$Source.ObjectID$$ACM's unique numerical identifier of the device from which the record was retrieved.
$$Source.Name$$The name of the device from which the record was retrieved.
$$Record.Period$$The period time of the archive record (for periodic archive types).
$$Record.AdHoc$$A flag indicating whether the record was collected due to a command request rather than a schedule. This token is used by Totalflow and SCANCOM device types.
$$AlarmEventId$$ACM's numerical identifier of the alarm or event type.
$$Archive.ObjectID$$ACM's unique numerical identifier of the archive object.
$$Archive.TypeName$$The value of the 'Type Name' property in the archive object.
$$Current.DateTime$$Current date time of server computer.
$$Device.Type$$The type (Protocol) of the device
$$FieldName$$The record field for name point-per-row
$$Archive.SubTypeName$$The value of the 'SubType Name' property in the archive object.
$$Record.Timestamp$$The date and time of the record in "VT_DATE" format.
$$Record.CollectTimestamp$$The date and time the record was collected from the device, in "VT_DATE" format.
$$Record.EndTimestamp$$The end timestamp of the record collected from the device, in "VT_DATE" format.

Time tokens in file names and Paths

The time tokens as part of the path or file name the token represent the date and time since contract hour after adjusting to leading time stamp.  For instance:

  • If the hour is 7 and the contact hour is 7 then the $$Hour$$ token will be 0
  • If the hour is 8 and the contact hour is 7 then the $$Hour$$ token will be 1
  • If the hour is 9 and the contact hour is 7 then the $$Hour$$ token will be 2

For assistance, please submit a ticket via our Support Portal, email autosol.support@autosoln.com or call 281.286.6017 to speak to a support team member.