Variables are available throughout the system to develop dynamic lists of data sets, use specific dates and times as input values, and call on data from modules throughout the system to be used in other modules. Variables are denoted by a set of curly brackets: {Variable}.

Where variables are allowed, view the entire list of variables by entering “{“ into the text field. From there, continue typing the variable name and inputs, or select a variable from the dropdown list. Not every variable displayed in the dropdown list will be applicable to the text field being edited.

Please note that variables that use a minus sign (-) should not be copied out of Word or from the online Knowledge Base. Em dashes, en dashes, and minus signs all look nearly identical but perform different functions.

Alternate Name

• • Format: {Asset.AlternateName: Asset ID or External ID}
  • Description: The alternate name of a specific asset. Insert the asset’s external identifier or 36-character GUID.
  • Examples:
    • {Asset.AlternateName:Engine_01}
    • {Asset.AlternateName: d445e351-e93b-4e35-89f6-8a9b23cc8495}
  • Applications: Form Type, Task Type

As of Date

• • Format: {AsOfDate}
  • Description: Prompts the user for a single date and filters for all dates greater than or equal to this date.
    • A report with this variable set to the “first day of this year” will automatically roll over to the next year on January 1.
  • Example: Asset.InServiceDate >= {AsOfDate}
  • Applications: Report

As of Date Time

• • Format: {AsOfDateTime}
  • Description: Prompts the user for a single date and time and filters for all datetimes greater than or equal to this datetime.
    • This variable is in UTC and should only be used in filters against datetime fields like Telemetry.ActiveDate, and not date fields like Asset.InServiceDate.
  • Example: Telemetry.ActiveDate >= {AsOfDateTime}
  • Applications: Report

Asset

• • Format: {Asset:Asset ID or External ID} 
  • Description: A specific asset. Insert the asset’s external identifier or 36-character GUID.
    • When multiple assets are permitted (such as when a workflow generates a task for multiple assets), separate each variable with a colon (;). For example: {Asset:Asset ID1};{Asset:Asset ID2}
  • Examples:
    • {Asset:Engine_01}
    • {Asset: d445e351-e93b-4e35-89f6-8a9b23cc8495}
  • Applications: Form Type, Report, Workflow

Asset (Report dropdown filter)

• • Format: {AssetID}
  • Description: An asset in the system. No inputs to the variable are necessary.
    • To configure a report filter to select a value from a list of assets, you will need to set the Value field to an ID rather than a name. For example: Asset.Asset ID = {AssetID} will allow you to filter by a single asset chosen from the list of all assets.
  • Example: Asset.Asset ID = {AssetID}
  • Applications: Report

Asset Address

• • Format: {AssetAddress:Asset ID or External ID,Address Type,Address Property}
  • Description: A portion of an asset’s address.
    • If more than one address of the same type is marked as “Use”, the first match will be returned.
    • Input the Asset’s external identifier or 36-character GUID, the Address Type (name or external identifier), and the Address Property.
    • Please specify one of the following Address Properties: Street1, Street2, City, State.Name, State.Code, PostalCode, Country.Name, Country.Code, County.Name, County.Code.
    • If the Address Property is blank, or any unsupported property is entered, the variable will return the full address on a single line.
  • Examples:
    • {AssetAddress:{FormAnswer:Facility},Physical,Street1}
    • {AssetAddress: 3d367a48-8b09-46c7-bd08-95d2763802a2,Mailing,State.Code}
  • Applications: Form Type

Asset Attribute (Form)

• • Format: {AssetAttribute:Asset ID or External ID,Attribute Type ID or External ID}
  • Description: A value from an asset attribute. Insert the Asset’s and Attribute Type’s external identifiers or 36-character GUIDs. The Attribute Type must be defined at the asset’s Asset Type. Answers to form questions may be nested inside of this variable (please see the examples below).
  • Examples:
    • {AssetAttribute: Engine_CE01, FuelType}
    • (AssetAttribute:{FormAnswer:EngineName}, FuelType}
  • Applications: Form Type

Asset Attribute (Reports, Task Types, and Workflows)

• • Format: {AssetAttribute:Attribute Type ID or External ID,Asset Type}
  • Description: A value from an asset attribute. Insert the Attribute Type’s external identifier or 36-character GUID.
    • This variable will only work in table reports where Asset is selected as the Datasource. To use this in a table report, for each column that will have an asset attribute, you must select Advanced Features.Calculated Field as the Column field and choose the {AssetAttribute:Attribute Type ID or External ID} variable in the Calculated Field. Use of the Alias field is highly recommended for identifying the attribute in each column. Please see Calculated Fields for more information.
    • For Asset Attributes that span multiple record types, please specify the record type within the variable (as in the last example).
  • Examples:
    • {AssetAttribute:Condition}
    • {AssetAttribute: a9fe3517-da98-46ff-b990-6f0e5687458e}
    • {AssetAttribute:StartDate, Engine}
  • Applications: Report, Task Type, Workflow

Asset Attribute of Secondary/Child – Max

• • Format: {MaxSecondaryAssetAttribute:<Association Type ID or External ID>,<Asset Attribute Type ID or External ID>}
  • Description: The maximum attribute value of all the secondary/child records associated to the triggering asset. Insert the asset association type ID and the asset attribute type ID.
  • Example: {MaxSecondaryAssetAttribute:containment,CrossSectionalAreaFt2}
  • Applications: Workflow

Asset Attribute of Secondary/Child – Sum

• • Format: {SumSecondaryAssetAttribute:<Association Type ID or External ID>,<Asset Attribute Type ID or External ID>}
  • Description: The sum of the attribute values of all the secondary/child records associated to the triggering asset. Insert the asset association type ID and the asset attribute type ID.
  • Example:{SumSecondaryAssetAttribute:containment,Assetas_TankCapacity}
  • Applications: Workflow

Asset Contact(s)

• • Format: {AssetContacts:Asset ID or External ID,Contact Role ID or External ID}
  • Description: The contacts associated with the asset identified and with the contact role identified. Insert the asset external identifier or 36-character GUID and the contact role external identifier or 36-character GUID.
    • If more than one contact is returned, if written to a dropdown form answer, the first contact (alphabetically) will be chosen. If written to a text field, all contacts will be returned, separated by commas.
  • Example: {AssetContacts:{FormAnswer:Facility},Manager}
  • Applications: Form Type

Asset External ID

• • Format: {Asset.ExternalID:<Asset ID>}
  • Description: Inserts the external id of the asset. If the asset is not found, or an external id does not exist, nothing is inserted. Use the asset external identifier or 36-character GUID.
    Note: If using this variable to create a ghost’s external id, prepend “Gst_{Today}_” or something to that effect.
  • Example: {Asset.ExternalID:{FormAnswer:AssetSelection}}
  • Applications: Form Type, Workflow

Asset In-Service Date

• • Format: {Asset.InServiceDate:<Asset ID or External ID>}
  • Description: Inserts the In-Service Date of the asset. If the asset is not found, or a date does not exist, nothing is inserted. Use the asset external identifier or 36-character GUID.
  • Example: {Asset.InServiceDate:{TriggeringAssetID}}
  • Applications: Report, Work, Workflow

Asset Location

• • Format: {AssetLocation:<Asset ID or External ID>,<Location Type ID, Name, or External ID>}
  • Description: Inserts the most recent coordinates of the asset. If the asset is not found, or coordinates do not exist, nothing is inserted or overwritten. Use the asset external identifier or 36-character GUID.
  • Example: {AssetLocation:{FormAnswer:ParentFacility},Center}
  • Applications: Form

Asset Location In-Service Date

• • Format: {Asset.LocationInServiceDate:<Asset ID or External ID>}
  • Description: Inserts the Location In-Service date from the asset. If the Location In-Service Date is blank, this blank will overwrite the field being written to. Use the asset external identifier or 36-character GUID.
  • Example:
    • {Asset.LocationInServiceDate:{FormAnswer:EquipmentSelection}}
    • {Asset.LocationInServiceDate:{TriggeringAsset}}
  • Applications: Form, Workflow

Asset Location Retired Date

• • Format: {Asset.LocationRetiredDate:<Asset ID or External ID>}
  • Description: Inserts the Location Retired date from the asset. If the Location Retired Date is blank, this blank will overwrite the field being written to. Use the asset external identifier or 36-character GUID. 
  • Example:
    • {Asset.LocationRetiredDate:{FormAnswer:EquipmentSelection}}
    • {Asset.LocationRetiredDate:{TriggeringAsset}}
  • Applications: Form, Workflow

Asset Photo

• • Format: {Asset.Photo:<Asset ID or External ID>}
  • Description: Inserts a photo of the asset in the email body that’s triggered by a workflow. If the asset is not found, or a representative photo does not exist, nothing is inserted in the email. Insert the asset external identifier or 36-character GUID. This variable currently works in email notifications only, not SMS notifications.
  • Example: {Asset.Photo:{TriggeringAssetID}}
  • Applications: Workflow

Asset Property

• • Format: {AssetProperty:<Property Type ID or External ID>}
  • Description: Inserts the value of a specific property of the asset that is valid as of today. Input the Property Type ID or Property Type External ID.
  • Example: {AssetProperty:CO_tonpermonth}
  • Applications: Reports, Document Template, Form Type

Asset Property (Specify Date)

• • Format: {AssetProperty:<Property Type ID or External ID>,<AsOfDate>}
  • Description: Inserts the value of a specific property of the asset that is valid as of the given date. Input the Property Type ID or Property Type External ID and the date in YYYY-MM-DD format.
  • Example: {AssetProperty:CO_tonpermonth,2025-01-01}
  • Applications: Reports, Document Template, Form Type

Asset Property (Specify Asset and Date)

• • Format: {AssetProperty:<Asset ID>,<Property Type ID or External ID>,<AsOfDate>}
  • Description: Inserts the value of a specific property of the selected asset that is valid as of the given date. Input the Asset GUID, the Property Type ID or Property Type External ID, and the date in YYYY-MM-DD format.
  • Example: {AssetProperty:{FormAnswer:engine},CO_tonpermonth,2025-01-01}
  • Applications: Reports, Document Template, Form Type

Asset Retired Date

• • Format: {Asset.RetiredDate:<Asset ID or External ID>}
  • Description: Inserts the Retired Date of the asset. If the asset is not found, or a date does not exist, nothing is inserted. Use the asset external identifier or 36-character GUID.
  • Example: {Asset.RetiredDate:{TriggeringAssetID}}
  • Applications: Report, Work, Workflow

Asset Status

• • Format: {Asset.Status:<Asset ID or External ID>, <True/False>}
  • Description: Inserts the asset’s status. Use the “True” parameter to override the default context-based display value/GUID decision and force the display value to be inserted.
  • Example: {Asset.Status:{TriggeringAsset},True}
  • Applications: Form Type, Report, Work, Workflow

Asset Type

• • Format: {AssetType:}
  • Description: The type of asset. Insert the asset type external identifier, 36-character GUID, or asset type name.
  • Example: {AssetType:Assetas_Engine}
  • Applications: Form Type, Task Type, Workflow

Associated Contact(s)

• • Format: {AssociatedContacts}
  • Description: Contacts associated with the record(s). There are no inputs to the variable.
    • In Form Type Rules, it returns the contacts associated with the form.
    • In Reports, it returns the contacts associated with the asset(s) that are identified in the report.
    • In Task Type Rules, it returns the contacts associated with the task.
    • In Workflows, it returns the contacts associated with the asset(s) that triggered the workflow.
  • Example: {AssociatedContacts}
  • Applications: Form Type, Report, Task Type, Workflow

Associated Contact(s) with Role

• • Format: {AssociatedContacts:Contact Role ID or External ID,format}
  • Description: The contacts with a specific role associated with the asset(s) that are identified in the report or that triggered the workflow. Insert the Contact Role’s external identifier or 36-character GUID.
    • This variable will only work in table reports where Asset is selected as the Datasource. To use this in a table report, for each column that will list contacts with a specific role, you must select Advanced Features.Calculated Field as the Column field and choose the {AssociatedContacts:Contact Role ID or External ID} variable in the Calculated Field. Use of the Alias field is highly recommended for identifying the role in each column. Multiple contacts with the same role will be listed and separated with a semicolon. Please see Calculated Fields for more information.
    • This variable accepts the following inputs to format the display name:
      • F – First
      • M – Middle
      • L – Last
      • FL – First Last
      • FML – First Middle Last
      • LF – Last, First
      • LFM – Last, First Middle
  • Examples:
    • {AssociatedContacts:EngineMechanic}
    • {AssociatedContacts:a8bebe1e-68cf-4451-bfc6-7ec05db3157c}
    • {AssociatedContacts:Operator, FL}
  • Applications: Report, Workflow

Associated Contact(s) with Asset and Role

• • Format: {AssociatedContacts:<Asset ID or External ID>} or {AssociatedContacts:<Asset ID or External ID>, <Format>} or {AssociatedContacts:<Asset ID or External ID>, <Contact Role ID or External ID>} or {AssociatedContacts:<Asset ID or External ID>, <Contact Role ID or External ID>, <Format>}
  • Description: The contacts with an optional specific role associated with the specified asset. Insert the Asset’s external identifier, 36-character GUID, or the {AssociatedAssets} variable and the optional Contact Role’s external identifier or 36-character GUID.
    • You may insert multiple Asset IDs as long as they are separated by semicolons, with no spaces on either side of the semicolon. 
    • This variable accepts the following inputs to format the display name:
      • F – First
      • M – Middle
      • L – Last
      • FL – First Last
      • FML – First Middle Last
      • LF – Last, First
      • LFM – Last, First Middle
  • Examples:
    • {AssociatedContacts:{AssociatedAssets},ProductionCoordinator}
    • {AssociatedContacts:{PrimaryAssets:{TriggeringAsset},Assetas_PhysicalLocation},Operator}
    • {AssociatedContacts:ROUTE 10;ROUTE 11;ROUTE 25,Foreman}
  • Applications: Form Type, Workflow

Associated Contact(s) to Other Contacts or in a Group

• • Format:
    • {AssociatedContacts:Primary Contact ID or External ID,format}
    • {AssociatedContacts:Group ID or External ID,format}
  • Description: The contacts associated to the Primary Contact or within a Group. Insert the Primary Contact’s or Group’s external identifier or 36-character GUID.
    • Contacts are associated by directional associations such that the Primary Contact is the first name in the association and the Secondary Contact is the second name in the same association.  For the following example, “Group A contains John Doe”, Group A is the Primary Contact, while John Doe is the Secondary Contact.
    • Multiple contacts will be returned separated with a semicolon.
    • This variable accepts the following inputs to format the display name:
      • F – First
      • M – Middle
      • L – Last
      • FL – First Last
      • FML – First Middle Last
      • LF – Last, First
      • LFM – Last, First Middle
    • Please note that managed contacts are not the same as associated contacts.
  • Examples:
    • {AssociatedContacts:{FormAnswer:Name},FL}
    • {AssociatedContacts:GroupXYZ,FML}
  • Applications: Form Type, Report, Task Type, Workflow

Blank/Null

• • Format: {Blank}
  • Description: Overwrites a form answer or an asset attribute with a null value. Must be used in conjunction with the ‘Overwrite Values’ toggle. The form answer or asset attribute must be specified in the trigger portion of the rule, but not inputs to the variable are necessary.
  • Example: {Blank}
  • Applications: Form Type, Report, Task Type, Workflow

Calculation Date

• • Format: {CalculationDate}
  • Description: Inserts the exact date of the calculation as yyyy-MM-dd.
  • Example: {CalculationDate}
  • Applications: Calculation

Calculation Year

• • Format: {CalculationYear}
  • Description: Inserts the year of the calculation as yyyy.
  • Example: {CalculationYear}
  • Applications: Calculation

Calculation Month

• • Format: {CalculationMonth}
  • Description: Inserts the number of the month of the calculation as m. For example, July would be 7.
  • Example: {CalculationMonth}
  • Applications: Calculation

Calculation Day

• • Format: {CalculationDay}
  • Description: Inserts the number of the day of the calculation as d. For example, the 15^th day of the month would return 15.
  • Example: {CalculationDay}
  • Applications: Calculation

Calendar Year

• • Format: {CalendarYear} or {CalendarYear +/- n}
  • Description: A four-digit calendar year. No inputs to the variable are necessary. When configured in a report or document template filter, this variable will prompt the user to select a calendar year prior to running the report or document template. When used in a workflow it will insert the current year. Insert a number for the number of years in place of “n”.
  • Example: {CalendarYear} or {CalendarYear – 2}
  • Applications: Document Template, Report, Workflow

Calendar Year End Date

• • Format: {CalendarYearEndDate}
  • Description: The last day of the calendar year, entered 12/31/XXXX. No inputs to the variable are necessary. The {CalendarYearStartDate} and {CalendarYearEndDate} variables may be applied together, but the combination is not required. When configured in a report or document template filter, this variable will prompt the user to select a calendar year prior to running the report or document template.
  • Example: Asset.InServiceDate <= {CalendarYearEndDate}
  • Applications: Document Template, Report

Calendar Year End Date Time

• • Format: {CalendarYearEndDateTime}
  • Description: The last day and time of the calendar year, entered 12/31/XXXX 11:59:59PM. No inputs to the variable are necessary. The {CalendarYearStartDateTime} and {CalendarYearEndDateTime} variables may be applied together, but the combination is not required. When configured in a report or document template filter, this variable will prompt the user to select a calendar year prior to running the report or document template.
    • This variable is in UTC and should only be used in filters against datetime fields like Telemetry.ActiveDate, and not date fields like Asset.InServiceDate.
  • Example: Telemetry.ActiveDate <= {CalendarYearEndDateTime}
  • Applications: Document Template, Report

Calendar Year Start Date

• • Format: {CalendarYearStartDate}
  • Description: The first day of the calendar year, entered 01/01/XXXX. No inputs to the variable are necessary. The {CalendarYearStartDate} and {CalendarYearEndDate} variables may be applied together, but the combination is not required. When configured in a report or document template filter, this variable will prompt the user to select a calendar year prior to running the report or document template.
  • Example: Asset.InServiceDate >= {CalendarYearStartDate}
  • Applications: Document Template, Report

Calendar Year Start Date Time

• • Format: {CalendarYearStartDateTime}
  • Description: The first day and time of the calendar year, entered 01/01/XXXX 12:00:00AM. No inputs to the variable are necessary. The {CalendarYearStartDateTime} and {CalendarYearEndDateTime} variables may be applied together, but the combination is not required. When configured in a report or document template filter, this variable will prompt the user to select a calendar year prior to running the report or document template.
    • This variable is in UTC and should only be used in filters against datetime fields like Telemetry.ActiveDate, and not date fields like Asset.InServiceDate.
  • Example: Telemetry.ActiveDate >= {CalendarYearStartDateTime}
  • Applications: Document Template, Report

Contact

• • Format: {Contact:Contact ID or External ID} or {Contact:Contact ID or External ID,format}
  • Description: A specific contact. Insert the contact’s external identifier or 36-character GUID. This variable accepts the following inputs to format the display name:
    • F – First
    • M – Middle
    • L – Last
    • FL – First Last
    • FML – First Middle Last
    • LF – Last, First
    • LFM – Last, First Middle
  • Examples:
    • {Contact:BillupsJames27210}
    • {Contact: 3d367a48-8b09-46c7-bd08-95d2763802a2}
    • {Contact:SmithBob4589,LFM}
    • {Contact:{FormAnswer:Name},FL}
  • Applications:  Form Type, Report, Task Type, Workflow

Contact (Report dropdown filter)

• • Format: {ContactID}
  • Description: A contact in the system. No inputs to the variable are necessary.
    • To configure a report filter to select a value from a list of contacts, you will need to set the Value field to an ID rather than a name. For example: Contact.Contact ID = {ContactID} will allow you to filter by a single contact chosen from the list of all contacts.
  • Example: Contact.Contact ID = {ContactID}
  • Applications: Report

Contact Address

• • Format: {ContactAddress:Contact ID or External ID,Address Type,Address Property}
  • Description: Inserts a portion of a contact’s address. If more than one address of the same type is marked as “Use”, the first match will be returned.
    • Input the Contact’s external identifier or 36-character GUID, the Address Type (name or external identifier), and the Address Property. Please specify one of the following Address Properties: Street1, Street2, City, State, StateCode, PostalCode, Country, CountryCode, County.
    • If the Address Property is blank, or any unsupported property is entered, the variable will return the full address on a single line.
  • Examples:
    • {ContactAddress:{FormAnswer:Assetas_EmployeeName},Assetas_Home,Street1}
    • {ContactAddress: 3d367a48-8b09-46c7-bd08-95d2763802a2,Mailing,StateCode}
  • Applications: Form Type

Contact Attribute (Form)

• • Format: {ContactAttribute:Contact ID or External ID,Attribute Type ID or External ID}
  • Description: A value from a contact attribute. Insert the Contact’s and Attribute Type’s external identifiers or 36-character GUIDs. The Attribute Type must be defined at the contact’s Contact Type. Answers to form questions may be nested inside of this variable (please see the example).
  • Examples:
    • {ContactAttribute: BillupsJames27210, Title}
    • {ContactAttribute:{FormAnswer:EmployeeName}, Title}
  • Applications: Form Type

Contact Attribute (Reports and Workflow)

• • Format: {ContactAttribute:Attribute Type ID or External ID,Type}
  • Description: A value from a contact attribute. Insert the Attribute Type’s external identifier or 36-character GUID.
    • This variable will only work in table reports where Contact is selected as the Datasource. To use this in a table report, for each column that will have a contact attribute, you must select Advanced Features.Calculated Field as the Column field and choose the {ContactAttribute:Attribute Type ID or External ID} variable in the Calculated Field. Use of the Alias field is highly recommended for identifying the attribute in each column. Please see Calculated Fields for more information.
    • For Contact Attributes that span multiple record types, please specify the record type within the variable (as in the last example).
  • Examples:
    • {ContactAttribute:Birthday}
    • {ContactAttribute: b51d832d-b358-4250-9abd-e2122d2d422b}
    • {ContactAttribute:StartDate, Staff}
  • Applications: Report, Workflow

Contact Email

• • Format: {ContactEmail:Contact ID or External ID,Email Type}
  • Description: Inserts a contact’s email address. If more than one email address of the same type is marked as “Use”, the first match will be returned. Input the Contact’s external identifier or 36-character GUID, along with the Email Type’s name or external identifier (Personal or Work).
  • Examples:
    • {ContactEmail:{FormAnswer:Name},Work}
    • {ContactEmail:BinghamBrandy53128,Personal}
  • Applications: Form Type

Contact Phone

• • Format: {ContactPhone:Contact ID or External ID,Phone Number Type}
  • Description: Inserts a contact’s phone number. If more than one phone number of the same type is marked as “Use”, the first match will be returned. Input the Contact’s external identifier or 36-character GUID, along with the Phone Number Type’s name or external identifier (Home, Mobile, Work, etc.).
  • Example:
    • {ContactPhone:BinghamBrandy53128,Mobile}
    • {ContactPhone:{FormAnswer:ContactName},Home}
  • Applications: Form Type

Contact Security Role

• • Format: {ContactSecurityRole:<Contact ID or EID>}
  • Description: Inserts a contact’s Security Role. Input the Contact’s external identifier or 36-character GUID, or use the {CurrentUser} variable.
  • Example: {ContactSecurityRole:{CurrentUser}}
  • Applications: Form Type

Count of Secondary/Child Assets

• • Format: {CountSecondaryAssets:<Association Type ID or External ID>}
  • Description: The count of secondary/child assets associated to the triggering asset. Insert the asset association type ID.
  • Example: {CountSecondaryAssets:containment}
  • Applications: Workflow

County

• • Format: {CountyID}
  • Description: A county within the 50 United States and US territories. No inputs to the variable are necessary.
    • To configure a report filter to select a value from a list of counties, you will need to set the Value field to an ID rather than a name. For example: Address.County ID = {CountyID} will allow you to filter by a single county chosen from the list of US counties.
  • Example: Address.County ID = {CountyID}
  • Applications: Report

Country

• • Format: {CountryID}
  • Description: A country. No inputs to the variable are necessary.
    • To configure a report filter to select a value from a list of countries, you will need to set the Value field to an ID rather than a name. For example: Address.Country ID = {CountryID} will allow you to filter by a single country chosen from the list of all countries.
  • Example: Address.Country ID = {CountryID}
  • Applications: Report

Create Date

• • Format: {CreateDate} or {CreateDate +/- n}
  • Description: The date the form was created. Available only in the Form Name field. Insert a number for the number of days in place of “n”.
  • Example: {CreateDate} or {CreateDate – 2}
  • Applications: Form Type

Create Date Time

• • Format: {CreateDateTime} or {CreateDateTime +/- n}
  • Description: The date and time the form was created. Available only in the Form Name field. Insert a number for the number of days in place of “n”.
  • Example: {CreateDateTime} or {CreateDateTime – 2}
  • Applications: Form Type

Currency Conversion

• • Format: {CurrencyConversion: From=<currency code, GUID, or EID>; To=<currency code, GUID, or EID>; AsOfDate=<date>}
  • Description: The exchange rate to USD on a specific date. The “To” currency must be set to USD. Insert the currency to convert from to USD and the date of the foreign exchange rate close date.
  • Example: {CurrencyConversion: From=MXN; To=USD; AsOfDate={Today}}
  • Applications: Reports, Workflows

Current Location

• • Format: {CurrentLocation}
  • Description: Inserts the latitude/longitude coordinates of the user’s location (no inputs necessary). Available only in Form questions when using the Coordinates Data Type.
    • The “current location” is set by the browser.  While questions with this default value can be hidden, they will not work correctly when set to read-only.
  • Example: {CurrentLocation}
  • Applications: Form Type

Current User

• • Format: {CurrentUser} or {CurrentUser:format}
  • Description: The current user of the form or task. This variable accepts the following inputs to format the display name:
    • F – First
    • M – Middle
    • L – Last
    • FL – First Last
    • FML – First Middle Last
    • LF – Last, First
    • LFM – Last, First Middle
  • Examples:
    • {CurrentUser}
    • {CurrentUser:FL}
  • Applications: Document Template, Form Type, Report, Task Type

Data Value

• • Format: {DataValue:<Column Name or Index>}
  • Description: For use in Scheduled Jobs. Returns the value of the given column or index in the data. Helpful for performing mathematical functions upon import. 
  • Example: {DataValue:serial}
  • Applications: Scheduled Job

Date Time

• • Format: {DateTime:<any date or datetime>,<any time or integer representing an hour of the day>}
  • Description: Inserts a date/time value in standard format.
    • The first parameter can be any standard date or date/time value, but if a time is included, it is stripped.
    • The second variable is a time or integer representing an hour of the day.
  • Example: {DateTime:2023-12-30, 14:22} or for APIs: {DateTime:{JsonValue:gmt_datetime},{JsonValue:hour_of_day}}
  • Applications: Scheduled Jobs, Document Template, Form Type, Report, Task Type

Document Attribute (Report, Workflow)

• • Format: {DocumentAttribute:Attribute Type ID or External ID}
  • Description: A value from a document attribute. Insert the Attribute Type’s external identifier or 36-character GUID.
    • This variable will only work in table reports where Document is selected as the Datasource. To use this in a table report, for each column that will have a document attribute, you must select Advanced Features.Calculated Field as the Column field and choose the {DocumentAttribute:} variable in the Calculated Field. Use of the Alias field is highly recommended for identifying the attribute in each column. Please see Calculated Fields for more information.
  • Examples:
    • {DocumentAttribute:Description}
    • {DocumentAttribute: bfeb244f-322b-4abe-bf16-9396e6bcd73c}
  • Applications: Report, Workflow

Document Attribute (Form)

• • Format: {DocumentAttribute:Attribute Type ID or External ID}
  • Description: A value from a document attribute. Insert the Document and Attribute Type’s external identifiers or 36-character GUIDs. The Attribute Type must be defined at the document’s Document Type. Answers to form questions may be nested inside of this variable (please see the example below).
  • Examples:
    • {DocumentAttribute:DocExID, Description}
    • {DocumentAttribute: {FormAnswer:Document}, bfeb244f-322b-4abe-bf16-9396e6bcd73c}
  • Applications: Form Type

End Date

• • Format: {EndDate}
  • Description: The end date in a date range. No inputs to the variable are necessary. The {StartDate} and {EndDate} variables must be applied together; you cannot reference only one of these two variables.
    • When timestamps matter, Assetas recommends using {EndDateTime} variable.
    • If you need to reference a single date, use the {AsOfDate} variable.
    • When configured in a report or document template filter, the combination of {StartDate} and {EndDate} will prompt the user to select a date range prior to running the report.
  • Example:
    • Date >= {StartDate} AND Date <= {EndDate}
  • Applications: Document Template, Report

End Date Time

• • Format: {EndDateTime}
  • Description: The end datetime in a date range. No inputs to the variable are necessary. The {StartDateTime} and {EndDateTime} variables must be applied together; you cannot reference only one of these two variables.
    • When timestamps do not matter, Assetas recommends using {EndDate} variable.
    • This variable is in UTC and should only be used in filters against datetime fields like Telemetry.ActiveDate, and not date fields like Asset.InServiceDate.
    • If you need to reference a single datetime, use the {AsOfDateTime} variable.
    • When configured in a report or document template filter, the combination of {StartDateTime} and {EndDateTime} will prompt the user to select a datetime range prior to running the report.
  • Example:
    • Telemetry.ActiveDate >= {StartDateTime} AND Telemetry.ActiveDate <= {EndDateTime}
  • Applications: Document Template, Report

Evaluate

• • Format: {Evaluate:expression}
  • Description: Allows for mathematical functions to be performed on numbers and dates. Please see Evaluate for more information.

    When used in a workflow trigger comparison, where the {Evaluate} function is generating a date, the entire function needs to be surrounded in single quotes: ‘{Evaluate:ToDateTime(…)}’

  • Examples:
    • {Evaluate:{FormAnswer:Count} + 5}
    • {Evaluate: ToDateTime(“{FormAnswer:Date}”).AddDays(10)}
  • Applications: Form Type, Workflow

First Date of the Month

• • Format: {MonthStartDate} or {MonthStartDate +/- n}
  • Description: Inserts the first day of the current month. Insert a number for the number of months in place of “n”. Only available when Telemetry Aggregate is selected as the Trigger Type in Workflow.
  • Example: {MonthStartDate} or {MonthStartDate – 1}
  • Applications: Workflow, Reports

First Datetime of the Month

• • Format: {MonthStartDateTime} or {MonthStartDateTime +/- n}
  • Description: Inserts the first day of the current month at midnight. Insert a number for the number of months in place of “n”. Only available when Telemetry Aggregate is selected as the Trigger Type in Workflow.
    • This variable is in UTC and should only be used in filters against datetime fields like Telemetry.ActiveDate, and not date fields like Asset.InServiceDate.
  • Example: {MonthStartDateTime} or {MonthStartDateTime – 1}
  • Applications: Workflow, Reports

First Date of the Semi-Annual Period

• • Format: {SemiAnnualStartDate} or {SemiAnnualStartDate +/- n}
  • Description: Inserts the first day of the current semi-annual period (January 1 or July 1). Insert a number for the number of semi-annual periods in place of “n”. Only available when Telemetry Aggregate is selected as the Trigger Type in Workflow.
  • Example: {SemiAnnualStartDate} or {SemiAnnualStartDate – 1}
  • Applications: Workflow, Reports, Forms

First Datetime of the Semi-Annual Period

• • Format: {SemiAnnualStartDateTime} or {SemiAnnualStartDateTime +/- n}
  • Description: Inserts the first day of the current semi-annual period (January 1 or July 1) at midnight. Insert a number for the number of semi-annual periods in place of “n”. Only available when Telemetry Aggregate is selected as the Trigger Type in Workflow.
    • This variable is in UTC and should only be used in filters against datetime fields like Telemetry.ActiveDate, and not date fields like Asset.InServiceDate.
  • Example: {SemiAnnualStartDateTime} or {SemiAnnualStartDateTime – 1}
  • Applications: Workflow, Reports, Forms

First Date of the Quarter

• • Format: {QuarterStartDate} or {QuarterStartDate +/- n}
  • Description: Inserts the first day of the current calendar quarter. Insert a number for the number of quarters in place of “n”. Only available when Telemetry Aggregate is selected as the Trigger Type in Workflow.
  • Example: {QuarterStartDate} or {QuarterStartDate – 1}
  • Applications: Workflow, Reports

First Datetime of the Quarter

• • Format: {QuarterStartDateTime} or {QuarterStartDateTime +/- n}
  • Description: Inserts the first day of the current quarter at midnight. Insert a number for the number of quarters in place of “n”. Only available when Telemetry Aggregate is selected as the Trigger Type in Workflow.
    • This variable is in UTC and should only be used in filters against datetime fields like Telemetry.ActiveDate, and not date fields like Asset.InServiceDate.
  • Example: {QuarterStartDateTime} or {QuarterStartDateTime – 1}
  • Applications: Workflow, Reports

First Day of the Year

• • Format: {YearStart} or {YearStart +/- n}
  • Description: Inserts the first day of the current year. Insert a number for the number of years in place of “n”. Only available when Telemetry Aggregate is selected as the Trigger Type in Workflow.
  • Example: {YearStart} or {YearStart – 1}
  • Applications: Workflow, Reports
  • Note: Deprecated in favor of {YearStartDate}

First Date of the Year

• • Format: {YearStartDate} or {YearStartDate +/- n}
  • Description: Inserts the first day of the current year. Insert a number for the number of years in place of “n”. Only available when Telemetry Aggregate is selected as the Trigger Type in Workflow.
  • Example: {YearStartDate} or {YearStartDate – 1}
  • Applications: Workflow, Reports

First Datetime of the Year

• • Format: {YearStartDateTime} or {YearStartDateTime +/- n}
  • Description: Inserts the first day of the current year at midnight. Insert a number for the number of years in place of “n”. Only available when Telemetry Aggregate is selected as the Trigger Type in Workflow.
    • This variable is in UTC and should only be used in filters against datetime fields like Telemetry.ActiveDate, and not date fields like Asset.InServiceDate.
  • Example: {YearStartDateTime} or {YearStartDateTime – 1}
  • Applications: Workflow, Reports

Form Answer

• • Format: {FormAnswer:Question ID or External ID} or {FormAnswer:Question ID or External ID,format}
  • Description: Answer from a form question. Insert the form question’s external identifier or 36-character GUID. If the form answer contains a contact name, the variable accepts the following inputs to format the display name:
    • F – First
    • M – Middle
    • L – Last
    • FL – First Last
    • FML – First Middle Last
    • LF – Last, First
    • LFM – Last, First Middle
  • Examples:
    • {FormAnswer:Inspector_Name}
    • {FormAnswer:3b06c469-56de-4047-aec1-583d1a77ad95}
    • {FormAnswer:ReportedBy, FL}
  • Applications: Form Type, Report, Workflow

Form Answer Display

• Format: {FormAnswerDisplay:Question ID or External ID}
• Description: Answer from a form question, displayed as text rather than an ID. Insert the form question’s external identifier or 36-character GUID.
  • This is useful when comparing the answer from a previous question’s dropdown list to something else, particularly if the list contains assets or contacts. The form question containing this variable is typically hidden and populated with a Set Answer form rule action.
• Examples:
  • {FormAnswerDisplay:EngineList}
• Applications: Form Type

Form Type

• • Format: {FormType}
  • Description: The current form type of the form being edited (no inputs necessary). Available only in the Form Name field.
  • Example: {FormType}
  • Applications: Form Type

Form Name

• • Format: {FormName: AssetID=<GUID>; FormType=<name, GUID, or EID>; MinDate=<date>; MaxDate=<date>; Top=<n (default 100)>; ExcludeDrafts=<True/False (default)>}
  • Description:  Inserts a comma-separated list of form names that match the given criteria.
    • All variables are optional and may be used in any combination.
    • Use Top=1 to get the most recent. The default and max is 100 forms.
    • ExcludeDrafts defaults to false, if not included.
    • Can optionally add links to each form.
    • When using this in an asset report, set AssetID=Asset.AssetID.
  • Examples: In a report with an asset data source, return the most recent form of a specific type associated with the asset: {FormName: AssetID=Asset.AssetID; FormType=Example Form Type Name; Top=1}
  • Applications: Document Template, Report

Get Hash

• • Format: {GetHash: <item>}
  • Description: Hashing transforms a string of characters of any size to a shorter, fixed length value that acts as a primary key for the original value. Equal items generate the same hash. Insert any string to output up to 6 characters. Multiple variables in sequence create a longer hash.
  • Example: {GetHash:{TriggeringContact}} would generate a hash of 6 characters.
    {GetHash:{TriggeringAsset}}{GetHash:{Today}} would generate a hash of 12 characters.
  • Applications: Workflow

JSON Value

• • Format: {JsonValue:<token>} or {JsonValue:<token>,<Array Index>} or {JsonValue:<token>,<child_token>}
  • Description: For use in API Integration Scheduled Jobs. Returns the value of the given token in the API JSON. Insert the token name and the array index if the data is in an array format. A positive array index reads from left to right, and a negative array index reads from right to left.  Helpful for performing mathematical functions upon import. Insert the token name and the child token name if the parent token itself contains a JSON object. Base64 encoding will be autodetected and decoded.
  • Example: {JsonValue:serial} or {JsonValue:sensor,2} or {JsonValue:data,date}
  • Applications: Scheduled Job

Last Date of the Month

• • Format: {MonthEndDate} or {MonthEndDate +/- n}
  • Description: Inserts the last day of the current month. Insert a number for the number of months in place of “n”. Only available when Telemetry Aggregate is selected as the Trigger Type in Workflow.
  • Example: {MonthEndDate} or {MonthEndDate – 1}
  • Applications: Workflow, Reports

Last Datetime of the Month

• • Format: {MonthEndDateTime} or {MonthEndDateTime +/- n}
  • Description: Inserts the last day of the current month at 11:59:59PM. Insert a number for the number of months in place of “n”. Only available when Telemetry Aggregate is selected as the Trigger Type in Workflow.
    • This variable is in UTC and should only be used in filters against datetime fields like Telemetry.ActiveDate, and not date fields like Asset.InServiceDate.
  • Example: {MonthEndDateTime} or {MonthEndDateTime – 1}
  • Applications: Workflow, Reports

Last Date of the Semi-Annual Period

• • Format: {SemiAnnualEndDate} or {SemiAnnualEndDate +/- n}
  • Description: Inserts the last day of the current semi-annual period (June 60 or December 31). Insert a number for the number of semi-annual periods in place of “n”. Only available when Telemetry Aggregate is selected as the Trigger Type in Workflow.
  • Example: {SemiAnnualEndDate} or {SemiAnnualEndDate – 1}
  • Applications: Workflow, Reports, Forms

Last Datetime of the Semi-Annual Period

• • Format: {SemiAnnualEndDateTime} or {SemiAnnualEndDateTime +/- n}
  • Description: Inserts the last day of the current semi-annual period (June 30 or December 31) at 11:59:59PM. Insert a number for the number of semi-annual periods in place of “n”. Only available when Telemetry Aggregate is selected as the Trigger Type in Workflow.
    • This variable is in UTC and should only be used in filters against datetime fields like Telemetry.ActiveDate, and not date fields like Asset.InServiceDate.
  • Example: {SemiAnnualEndDateTime} or {SemiAnnualEndDateTime – 1}
  • Applications: Workflow, Reports, Forms

Last Date of the Quarter

• • Format: {QuarterEndDate} or {QuarterEndDate +/- n}
  • Description: Inserts the last day of the current calendar quarter. Insert a number for the number of quarters in place of “n”. Only available when Telemetry Aggregate is selected as the Trigger Type in Workflow.
  • Example: {QuarterEndDate} or {QuarterEndDate – 1}
  • Applications: Workflow, Reports

Last Datetime of the Quarter

• • Format: {QuarterEndDateTime} or {QuarterEndDateTime +/- n}
  • Description: Inserts the last day of the current quarter at 23:59:59. Insert a number for the number of quarters in place of “n”. Only available when Telemetry Aggregate is selected as the Trigger Type in Workflow.
    • This variable is in UTC and should only be used in filters against datetime fields like Telemetry.ActiveDate, and not date fields like Asset.InServiceDate.
  • Example: {QuarterEndDateTime} or {QuarterEndDateTime – 1}
  • Applications: Workflow, Reports

Last Day of the Year

• • Format: {YearEnd} Or {YearEnd +/- n}
  • Description: Inserts the last day of the current year. Insert a number for the number of years in place of “n”. Only available when Telemetry Aggregate is selected as the Trigger Type in Workflow.
  • Example: {YearEnd} Or {YearEnd – 1}
  • Applications: Workflow, Reports
  • Note: Deprecated in favor of {YearEndDate}

Last Date of the Year

• • Format: {YearEndDate} Or {YearEndDate +/- n}
  • Description: Inserts the last day of the current year. Insert a number for the number of years in place of “n”. Only available when Telemetry Aggregate is selected as the Trigger Type in Workflow.
  • Example: {YearEndDate} Or {YearEndDate – 1}
  • Applications: Workflow, Reports

Last Datetime of the Year

• • Format: {YearEndDateTime} or {YearEndDateTime +/- n}
  • Description: Inserts the last day of the current year at 11:59:59PM. Insert a number for the number of years in place of “n”. Only available when Telemetry Aggregate is selected as the Trigger Type in Workflow.
    • This variable is in UTC and should only be used in filters against datetime fields like Telemetry.ActiveDate, and not date fields like Asset.InServiceDate.
  • Example: {YearEndDateTime} or {YearEndDateTime – 1}
  • Applications: Workflow, Reports

Last Success Date

• • Format: {LastSuccessDate} or {LastSuccessDate +/- n}
  • Description: Pulls back the start date of the last time the Scheduled Job ran and was successful. Useful for processing deltas in a data set instead of processing the full data set each time a Scheduled Job runs, assuming the data set contains a “last modified date” or something similar. Enter the number of days for n. Fractions are accepted in place of “n”; for example, 0.5 translates to 12 hours.
  • Example: {LastSuccessDate} or {LastSuccessDate – 0.5}
  • Applications: Scheduled Jobs

Last Success Date Time

• • Format: {LastSuccessDateTime} or {LastSuccessDateTime +/- n}
  • Description: Pulls back the start date and time of the last time the Scheduled Job ran and was successful. Useful for processing deltas in a data set instead of processing the full data set each time a Scheduled Job runs, assuming the data set contains a “last modified date” or something similar. Enter the number of days for n. Fractions are accepted in place of “n”; for example, 0.5 translates to 12 hours.
  • Example: {LastSuccessDateTime} or {LastSuccessDateTime – 0.5}
  • Applications: Scheduled Jobs

Manager Of

• • Format:
    • {ManagerOf:Contact ID or External ID}
    • {ManagerOf:Contact ID or External ID,format}
  • Description: The manager of the given contact. The contact must be associated to the manager as a managed contact.
    • Insert the contact’s external identifier or 36-character GUID. Answers to form questions may be nested inside of this variable (please see the examples below).
    • This variable accepts the following inputs to format the display name:
      • F – First
      • M – Middle
      • L – Last
      • FL – First Last
      • FML – First Middle Last
      • LF – Last, First
      • LFM – Last, First Middle
  • Examples:
    • {ManagerOf:BillupsJames27210}
    • {ManagerOf: 3d367a48-8b09-46c7-bd08-95d2763802a2}
    • {ManagerOf:{FormAnswer:EmployeeName}}
    • {ManagerOf:{TriggeringContact},FL}
    • {ManagerOf:{TaskContact:{Triggering Task}},FL}
  • Applications: Form Type, Task Type, Workflow

New Form Link

• • Format: {NewFormLink:<Form Type ID or External ID>,<Link text>, <QuestionID1>=<Value1>,<QuestionID2>=<Value2>, …}
  • Description: Creates a clickable link to another existing form type and allows for custom link text and optional pre-filled default form answers.
  • Examples:
    • {NewFormLink:Storm_CA, Stormwater Corrective Action Report Form}
    • {NewFormLink: 81499d29-a719-4c6e-a722-f564b8673a2b, Incident Follow Up Form}
    • {NewFormLink:EngineForm,Please Complete Engine Form,Attribute1={AssetAttribute:Assetas_EngineDriver},Attribute2={AssetAttribute:Assetas_EngineFuel}}
  • Applications: Form Type, Task Type, Workflow

Now

• • Format: {Now} or {Now +/- n}
  • Description: The current date & time. Insert a number for the number of days in place of “n”. “n” may also be a decimal to denote hours. For example, 6 hours (6/24 = 0.25) would be {Now +- 0.25}.
  • Example: {Now} or {Now + 1}
  • Applications: Document Template, Form Type, Task Type, Workflow
  • This is the preferred default for datetime fields.

Property Unit

• • Format: {PropertyUnits:<Property Type ID or External ID>}
  • Description: The unit for a given property type.
  • Example: {PropertyUnits:PropertyExID}
  • Applications: Form Type, Workflow

Random

• • Format: {Random:min, max}
  • Description: Creates a random integer between the specified minimum and maximum values (inclusive).
  • Example: {Random:0, 100}
  • Applications: Form Type

Report

• • Format: {ReportID}
  • Description: A report within the database. No inputs to the variable are necessary.
    • Available only when creating a report with the Report Log as the datasource. Using Report.Report ID = {ReportID} as a filter allows for the selection of a report from a list of all available reports.
  • Example: Report.Report ID = {ReportID}
  • Applications: Report

Selection List

• • Format: {SL:ReportID or External ID}
  • Description: An item from a preconfigured Selection List report. Enter the Selection List report’s external identifier or 36-character GUID.
    • To configure a report filter to select a value from an existing Selection List report, you will need to set the Value field to an ID rather than a name. For example: Asset.Asset ID = {SL:ActiveEngines} will allow you to filter by a single item out of the list within the Selection List report.
  • Examples:
    • Asset.Asset ID = {SL:ActiveEngines}
    • Asset.Asset ID = {SL:a01cbd61-dd5b-4770-889c-53d4d84bbc83}
  • Applications: Report

Short Link

• • Format: {ShortURL:<full URL>}
  • Description: This variable converts a full URL into a shortened, 28-character URL Lookup link. This variable is useful for inserting short links in SMS messages. 
  • Examples:
    • {ShortURL: https://app.assetas.com/Asset/Details/a6e818f3-3af0-483b-8411-99ccae77972c}
    • {ShortURL:{NewFormLink:VehicleIncident, New Vehicle Incident Form}}
    • {ShortURL:{TriggeringFormLink}}
  • Applications: Form Type, Task Type, Workflow

Space

• • Format: {Space}
  • Description: Represents a space (not a null). No inputs to the variable are necessary.
  • Examples:
    • {Space}
  • Applications: Report

Start Date

• • Format: {StartDate}
  • Description: The start date in a date range. No inputs to the variable are necessary. The {StartDate} and {EndDate} variables must be applied together; you cannot reference only one of these two variables. If you need to reference a single date, use the {AsOfDate} variable. When configured in a report or document template filter, the combination of {StartDate} and {EndDate} will prompt the user to select a date range prior to running the report.
    • When timestamps matter, Assetas recommends using the {StartDateTime} variable.
  • Example: Asset.InServiceDate >= {StartDate} AND Asset.InServiceDate <= {EndDate}
  • Applications: Document Template, Report

Start Date Time

• • Format: {StartDateTime}
  • Description: The start datetime in a date range. No inputs to the variable are necessary. The {StartDateTime} and {EndDateTime} variables must be applied together; you cannot reference only one of these two variables. If you need to reference a single datetime, use the {AsOfDateTime} variable. When configured in a report or document template filter, the combination of {StartDateTime} and {EndDateTime} will prompt the user to select a datetime range prior to running the report.
    • When timestamps do not matter, Assetas recommends using the {StartDate} variable.
    • This variable is in UTC and should only be used in filters against datetime fields like Telemetry.ActiveDate, and not date fields like Asset.InServiceDate.
  • Example: Telemetry.ActiveDate >= {StartDateTime} AND Telemetry.ActiveDate <= {EndDateTime}
  • Applications: Document Template, Report

State

• • Format: {StateID}
  • Description: A state within the United States or a Canadian province. No inputs to the variable are necessary. To configure a report filter to select a value from a list of states/provinces, you will need to set the Value field to an ID rather than a name. For example: Address.State ID = {StateID} will allow you to filter by a single state/province chosen from the list of all states/provinces.
  • Example: Address.State ID = {StateID}
  • Applications: Report

Task

• • Format: {TaskID}
  • Description: A task. No inputs to the variable are necessary. Only available when Task is selected as the Datasource in a report.
    To configure a report filter to select a value from a list of tasks, you will need to set the Value field to an ID rather than a name. For example: Task.Task ID = {TaskID} will allow you to filter by a task chosen from the list of all available tasks.
  • Example: Task.Task ID = {TaskID}
  • Applications: Report

Task Attribute

• • Format: {TaskAttribute:Attribute Type ID or External ID}
  • Description: The value for a specific task attribute. Enter the Task Attribute Type’s external identifier or 36-character GUID.
  • Examples:
    • {TaskAttribute:Mileage}
    • {TaskAttribute:c6ee6695-a46c-4f31-bfb4-c2517079b232}
  • Applications: Task Type, Report

Task Contact

• • Format:
    • {TaskContact:Task ID or External ID}
    • {TaskContact:Task ID or External ID,format}
  • Description: The contact(s) assigned to the task. Enter the Task’s 36-character GUID. This variable accepts the following inputs to format the display name:
    • F – First
    • M – Middle
    • L – Last
    • FL – First Last
    • FML – First Middle Last
    • LF – Last, First
    • LFM – Last, First Middle
  • Examples:
    • {TaskContact:{TriggeringTask}}
    • {TaskContact: 875487c3-2dc9-4014-f57f-08d8ced07ad1}
    • {TaskContact:{TriggeringTask},FL}
  • Applications: Workflow

Task Details

• • Format: {TaskDetails}
  • Description: The details of the task (includes the link, summary, type, priority, status, due date, and assignees). No inputs to the variable are necessary.
  • Examples:
    • {TaskDetails}
  • Applications: Task Type, Workflow

Task Link

• • Format: {TaskLink}
  • Description: The URL link to the task. No inputs to the variable are necessary.
  • Examples:
    • {TaskLink}
  • Applications: Task Type

Telemetry Average

• • Format: {TelemetryAverage: StartDate=date;EndDate=date;TelemetryType=name, GUID, or EID;UnitOfMeasure=name, GUID, or EID;Rounding=n;AssetID=GUID or AssetAssociationType=ExternalID}
  • Description: Given a telemetry type, unit of measure, and date range, this variable will return the average of all telemetric values matching the criteria where the active date falls within the date range. Telemetric variables pull from the final numeric value field, which includes the numeric value override if present.
    • Within the telemetric variable, please note that the AssetID= argument is optional. If not specified, all telemetry matching the criteria will be included in the variable, regardless of Asset assignment.
    • Telemetric variables may also perform mathematical functions on child records and roll those values up to the parent record by using the AssetAssociationType=<ExternalID> argument, which is optional. This is particularly useful in workflows. In the Workflow Triggers, set an Asset Detail Item Comparison trigger equal to the parent record’s asset type. It is critically important that, when using the AssetAssociationType argument, you set a filter in the Workflow Triggers to only include assets with child records. Otherwise, telemetry values will be set to 0 for all matching assets that don’t have child records.
    • In Reports and Document Templates, you may set AssetID=Asset.AssetID to apply the telemetry variable to each asset returned, individually. Use filters to define the assets to include and apply selection list filters when necessary.
    • In workflows, the triggering asset will automatically be inserted into the telemetric variable, so the specification of the AssetID is not necessary.
    • When using the telemetric variables to evaluate a set of null data, the system will return a null. In workflows, please utilize workflow triggers to avoid evaluating cases where only null data exists.
  • Examples: In a report where engines and their attributes are listed, return the average of daily runtime hours by engine over the last week, rounded to the nearest hour: {TelemetryAverage: StartDate={Today – 7}; EndDate={Today}; TelemetryType=Runtime; UnitOfMeasure=hr/day; Rounding=0; AssetID=Asset.AssetID}

    A workflow to calculate an 8-hour rolling average of temperatures: {TelemetryAverage: StartDate={Now – 0.333}; EndDate={Now}; TelemetryType=Temperature; UnitOfMeasure=°F; Rounding=1; AssetID=Asset.AssetID}

  • Applications: Document Template, Report, Workflow

Telemetry Delta

• • Format: {TelemetryDelta: LatestDate=<date>; TelemetryType=<name, GUID, or EID>; UnitOfMeasure=<name, GUID, or EID>; Rounding=<n>; AssetID=<GUID> or AssetAssociationType=<ExternalID>}
  • Description: Given a telemetry type, unit of measure, and date range, this variable will return the difference between the two most recent telemetry data points that have a date time stamp equal to or earlier than the ‘Latest Date’ argument. If the delta between the two telemetry data points is negative, or if there aren’t two telemetry data points to evaluate, the variable will return a null value. Telemetric variables pull from the final numeric value field, which includes the numeric value override if present.
    • Within the telemetric variable, please note that the AssetID= argument is optional. If not specified, all telemetry matching the criteria will be included in the variable, regardless of Asset assignment.
    • Telemetric variables may also perform mathematical functions on child records and roll those values up to the parent record by using the AssetAssociationType=<ExternalID> argument, which is optional. This is particularly useful in workflows. In the Workflow Triggers, set an Asset Detail Item Comparison trigger equal to the parent record’s asset type. It is critically important that, when using the AssetAssociationType argument, you set a filter in the Workflow Triggers to only include assets with child records. Otherwise, telemetry values will be set to 0 for all matching assets that don’t have child records.
    • In Reports and Document Templates, you may set AssetID=Asset.AssetID to apply the telemetry variable to each asset returned, individually. Use filters to define the assets to include and apply selection list filters when necessary.
    • In workflows, the triggering asset will automatically be inserted into the telemetric variable, so the specification of the AssetID is not necessary.
    • When using the telemetric variables to evaluate a set of null data, the system will return a null. In workflows, please utilize workflow triggers to avoid evaluating cases where only null data exists.
  • Telemetric variables pull from the final numeric value field, which includes the numeric value override if present.
  • Telemetric variables pull from the final numeric value field, which includes the numeric value override if present.
  • Telemetric variables pull from the final numeric value field, which includes the numeric value override if present.
  • Telemetric variables pull from the final numeric value field, which includes the numeric value override if present.
  • Example: Telemetry is provided as a cumulative value and daily values need to be derived from the cumulative values via a workflow: {TelemetryDelta: LatestDate={TriggeringActiveDate}; TelemetryType=Cumulative_Production; UnitOfMeasure=l; Rounding=5; AssetID={TriggeringAssetID}}
  • Applications: Document Template, Report, Workflow

Telemetry Last

• • Format: {TelemetryLast: EndDate=<date>; TelemetryType=<name, GUID, or EID>; UnitOfMeasure=<name, GUID, or EID>; Rounding=<n>; AssetID=<GUID> or AssetAssociationType=<ExternalID>}
  • Description: Given a telemetry type, unit of measure, and date range, this variable will return the most recently telemetry data point that has a date time stamp earlier than the ‘End Date’ argument. If no values are returned, the variable will return a null value. Telemetric variables pull from the final numeric value field, which includes the numeric value override if present.
    • Within the telemetric variable, please note that the AssetID= argument is optional. If not specified, all telemetry matching the criteria will be included in the variable, regardless of Asset assignment.
    • Telemetric variables may also perform mathematical functions on child records and roll those values up to the parent record by using the AssetAssociationType=<ExternalID> argument, which is optional. This is particularly useful in workflows. In the Workflow Triggers, set an Asset Detail Item Comparison trigger equal to the parent record’s asset type. It is critically important that, when using the AssetAssociationType argument, you set a filter in the Workflow Triggers to only include assets with child records. Otherwise, telemetry values will be set to 0 for all matching assets that don’t have child records.
    • In Reports and Document Templates, you may set AssetID=Asset.AssetID to apply the telemetry variable to each asset returned, individually. Use filters to define the assets to include and apply selection list filters when necessary.
    • In workflows, the triggering asset will automatically be inserted into the telemetric variable, so the specification of the AssetID is not necessary.
    • When using the telemetric variables to evaluate a set of null data, the system will return a null. In workflows, please utilize workflow triggers to avoid evaluating cases where only null data exists.
  • Example: The last valid datapoint needs to display at the asset record via a workflow: {TelemetryLast: EndDate={Today}; TelemetryType=Cumulative_Production; UnitOfMeasure=l; Rounding=5; AssetID={TriggeringAssetID}}
  • Applications: Document Template, Report, Workflow

Telemetry Maximum

• • Format: {TelemetryMaximum:StartDate=date;EndDate=date;TelemetryType=name, GUID, or EID;UnitOfMeasure=name, GUID, or EID;Rounding=n;AssetID=GUID or AssetAssociationType=ExternalID}
  • Description: Given a telemetry type, unit of measure, and date range, this variable will return the maximum of all telemetric values matching the criteria where the active date falls within the date range. Telemetric variables pull from the final numeric value field, which includes the numeric value override if present.
    • Within the telemetric variable, please note that the AssetID= argument is optional. If not specified, all telemetry matching the criteria will be included in the variable, regardless of Asset assignment.
    • Telemetric variables may also perform mathematical functions on child records and roll those values up to the parent record by using the AssetAssociationType=<ExternalID> argument, which is optional. This is particularly useful in workflows. In the Workflow Triggers, set an Asset Detail Item Comparison trigger equal to the parent record’s asset type. It is critically important that, when using the AssetAssociationType argument, you set a filter in the Workflow Triggers to only include assets with child records. Otherwise, telemetry values will be set to 0 for all matching assets that don’t have child records.
    • In Reports and Document Templates, you may set AssetID=Asset.AssetID to apply the telemetry variable to each asset returned, individually. Use filters to define the assets to include and apply selection list filters when necessary.
    • In workflows, the triggering asset will automatically be inserted into the telemetric variable, so the specification of the AssetID is not necessary.
    • When using the telemetric variables to evaluate a set of null data, the system will return a null. In workflows, please utilize workflow triggers to avoid evaluating cases where only null data exists.
  • Example: Maximum precipitation over the last five days, rounded to the nearest tenth of an inch:  {TelemetryMaximum: StartDate={Today – 5}; EndDate={Today}; TelemetryType=Precipitation; UnitOfMeasure=in; Rounding=1; AssetID=Asset.AssetID}
  • Applications: Document Template, Report, Workflow

Telemetry Minimum

• • Format: {TelemetryMinimum:StartDate=date;EndDate=date;TelemetryType=name, GUID, or EID;UnitOfMeasure=name, GUID, or EID;Rounding=n;AssetID=GUID or AssetAssociationType=ExternalID}
  • Description: Given a telemetry type, unit of measure, and date range, this variable will return the minimum of all telemetric values matching the criteria where the active date falls within the date range. Telemetric variables pull from the final numeric value field, which includes the numeric value override if present.
    • Within the telemetric variable, please note that the AssetID= argument is optional. If not specified, all telemetry matching the criteria will be included in the variable, regardless of Asset assignment.
    • Telemetric variables may also perform mathematical functions on child records and roll those values up to the parent record by using the AssetAssociationType=<ExternalID> argument, which is optional. This is particularly useful in workflows. In the Workflow Triggers, set an Asset Detail Item Comparison trigger equal to the parent record’s asset type. It is critically important that, when using the AssetAssociationType argument, you set a filter in the Workflow Triggers to only include assets with child records. Otherwise, telemetry values will be set to 0 for all matching assets that don’t have child records.
    • In Reports and Document Templates, you may set AssetID=Asset.AssetID to apply the telemetry variable to each asset returned, individually. Use filters to define the assets to include and apply selection list filters when necessary.
    • In workflows, the triggering asset will automatically be inserted into the telemetric variable, so the specification of the AssetID is not necessary.
    • When using the telemetric variables to evaluate a set of null data, the system will return a null. In workflows, please utilize workflow triggers to avoid evaluating cases where only null data exists.
  • Example: In a report where wells and their attributes are listed, return the minimum barrels of oil produced per month over the last year by well, rounded to the nearest barrel: {TelemetryMinimum: StartDate={Today – 365}; EndDate={Today}; TelemetryType=Produced Oil; UnitOfMeasure=bbl/month; Rounding=0; AssetID=Asset.AssetID}
  • Applications: Document Template, Report, Workflow

Telemetry Summation

• • Format: {TelemetrySum:StartDate=date;EndDate=date;TelemetryType=name, GUID, or EID;UnitOfMeasure=name, GUID, or EID;Rounding=n;AssetID=GUID or AssetAssociationType=ExternalID}
  • Description: Given a telemetry type, unit of measure, and date range, this variable will return the summation of all telemetric values matching the criteria where the active date falls within the date range. Telemetric variables pull from the final numeric value field, which includes the numeric value override if present.
    • Within the telemetric variable, please note that the AssetID= argument is optional. If not specified, all telemetry matching the criteria will be included in the variable, regardless of Asset assignment.
    • Telemetric variables may also perform mathematical functions on child records and roll those values up to the parent record by using the AssetAssociationType=<ExternalID> argument, which is optional. This is particularly useful in workflows. In the Workflow Triggers, set an Asset Detail Item Comparison trigger equal to the parent record’s asset type. It is critically important that, when using the AssetAssociationType argument, you set a filter in the Workflow Triggers to only include assets with child records. Otherwise, telemetry values will be set to 0 for all matching assets that don’t have child records.
    • In Reports and Document Templates, you may set AssetID=Asset.AssetID to apply the telemetry variable to each asset returned, individually. Use filters to define the assets to include and apply selection list filters when necessary.
    • In workflows, the triggering asset will automatically be inserted into the telemetric variable, so the specification of the AssetID is not necessary.
    • When using the telemetric variables to evaluate a set of null data, the system will return a null. In workflows, please utilize workflow triggers to avoid evaluating cases where only null data exists.
  • Example A: In a workflow with a triggering engine, the sum of the operating hours since the last oil change date by engine: {TelemetrySum: StartDate={AssetAttribute:LastOilChangeDate}; EndDate={Today}; TelemetryType=Runtime; UnitOfMeasure=hr/day; Rounding=0, AssetID=Asset.AssetID}
  • Example B: In a workflow with a triggering asset type of facility, sum the gas production from three months ago at the underlying wells to the facility level: {TelemetrySum: StartDate={MonthStart – 3}; EndDate={MonthEnd – 3}; TelemetryType=ProducedGas; UnitOfMeasure=mscf/month; Rounding=3; AssetAssociationType=Assetas_PhysicalLocation}
  • Applications: Document Template, Report, Workflow

Telemetry Type

• • Format: {TelemetryTypeID}
  • Description: A telemetry type. No inputs to the variable are necessary. Only available when Telemetry is selected as the Datasource in a report. To configure a report filter to select a value from a list of telemetry types, you will need to set the Value field to an ID rather than a name. For example: Telemetry Type.Telemetry Type ID = {TelemetryTypeID} will allow you to filter by a telemetry type chosen from the list of all available telemetry types.
  • Example: Telemetry Type.Telemetry Type ID = {TelemetryTypeID}
  • Applications: Report

Timestamp ID

• • Format: {TimestampID} or {TimestampID:YYMMDD.HHMMSS}
  • Description: Creates a unique 12-character identifier that combines the current date and time in the following formats:
    • {TimestampID} returns YYMMDDHHMMSS
    • {TimestampID:YYMMDD.HHMMSS} returns YYMMDD.HHMMSS
    • Useful in creating unique identifiers or case numbers in forms that are easily sortable. Assetas recommends using the ‘Read Only’ form question toggle in conjunction with this variable to prevent manipulation of the unique identifier.
  • Examples:
    • {TimestampID}
    • {TimestampID:YYMMDD.HHMMSS}
  • Applications: Form Type

Today

• • Format: {Today} Or {Today +/- n}
  • Description: The current date in your timezone. Insert a number for the number of days in place of “n”.
  • Example: {Today}
  • Applications: Document Template, Form Type, Report, Task Type, Workflow
  • This is the preferred default for date fields.
    • Applying the “today” variable to a datetime field will result in the current time in UTC.

Triggering Active Date

• • Format: {TriggeringActiveDate}
  • Description: For use with the Telemetry Comparison trigger. Inserts the active date of the telemetry that triggered the workflow. No inputs to the variable are necessary.
  • Example: {TriggeringActiveDate}
  • Applications: Workflow

Triggering Asset

• • Format: {TriggeringAsset}
  • Description: The name of the asset(s) that caused the workflow triggers to evaluate to ‘True’. No inputs to the variable are necessary.
  • Example: {TriggeringAsset}
  • Applications: Workflow

Triggering Asset External ID

• • Format: {TriggeringAssetExternalID}
  • Description: The external identifier of the asset(s) that caused the workflow triggers to evaluate to ‘True’. No inputs to the variable are necessary.
  • Example: {TriggeringAssetExternalID}
  • Applications: Workflow

Triggering Asset ID

• • Format: {TriggeringAssetID}
  • Description: The GUID of the asset(s) that caused the workflow triggers to evaluate to ‘True’. No inputs to the variable are necessary. If passing this variable into an email or SMS notification, we recommend toggling the Summary Email/SMS option to ‘off’.
  • Example: {TriggeringAssetID}
  • Applications: Workflow

Triggering Asset Link

• • Format: {TriggeringAssetLink}
  • Description: A link with the name of the asset(s) that caused the workflow triggers to evaluate to ‘True’. No inputs to the variable are necessary.
  • Example: {TriggeringAssetLink}
  • Applications: Workflow

Triggering Comments

• • Format: {TriggeringMaxComments}
  • Description: Returns the maximum comment value from the triggering telemetry. No inputs to the variable are necessary.
  • Example: {TriggeringMaxComments}
  • Applications: Workflow

Triggering Contact

• • Format: {TriggeringContact} or {TriggeringContact:}
  • Description: The name of the contact(s) that caused the workflow triggers to evaluate to ‘True’. This variable accepts the following inputs to format the display name:
    • F – First
    • M – Middle
    • L – Last
    • FL – First Last
    • FML – First Middle Last
    • LF – Last, First
    • LFM – Last, First Middle
  • Examples:
    •  {TriggeringContact}
    • {TriggeringContact:FL}
  • Applications: Workflow

Triggering Evaluation

• • Format: {TriggeringEvaluation}
  • Description: The 36-character GUID of the evaluation(s) that caused the workflow triggers to evaluate to ‘True’. No inputs to the variable are necessary.
  • Example:{TriggeringEvaluation}
  • Applications: Workflow

Triggering Evaluation Date

• • Format: {TriggeringEvaluationDate}
  • Description: The create date(s) of the evaluation(s) that caused the workflow triggers to evaluate to ‘True’. Results are returned in order from oldest to newest. No inputs to the variable are necessary.
  • Example:{TriggeringEvaluationDate}
  • Applications: Workflow

Triggering Evaluation Closed Date

• • Format: {TriggeringEvaluationClosedDate}
  • Description: The closed date(s) of the evaluation(s) that caused the workflow triggers to evaluate to ‘True’. Results are returned in order from oldest to newest. No inputs to the variable are necessary.
  • Example:{TriggeringEvaluationClosedDate}
  • Applications: Workflow

Triggering Form

• • Format: {TriggeringForm}
  • Description: The 36-character GUID of the form(s) that caused the workflow triggers to evaluate to ‘True’. No inputs to the variable are necessary.
  • Example: {TriggeringForm}
  • Applications: Workflow

Triggering Form Link

• • Format: {TriggeringFormLink}
  • Description: A link with the name of the form(s) that caused the workflow triggers to evaluate to ‘True’, or the form from where the notification originated. No inputs to the variable are necessary.
  • Example: {TriggeringFormLink}
  • Applications: Form Type, Workflow

Triggering Group Active Date

• • Format: {TriggeringGroupActiveDate}
  • Description: For use with the Telemetry Aggregate trigger. The triggering group’s active date, from the Telemetry Aggregate trigger, based on the Date Grouping selection. For example, if the Date Grouping is Monthly, the active date will be set to the first day of the month. No inputs to the variable are necessary.
  • Example: {TriggeringGroupActiveDate}
  • Applications: Workflow

Triggering Group Inactive Date

• • Format: {TriggeringGroupInactiveDate}
  • Description: For use with the Telemetry Aggregate trigger. The triggering group’s inactive date, from the Telemetry Aggregate trigger, based on the Date Grouping selection. For example, if the Date Grouping is Monthly, the inactive date will be set to the last day of the month. No inputs to the variable are necessary.
  • Example: {TriggeringGroupInactiveDate}
  • Applications: Workflow

Triggering Inactive Date

• • Format: {TriggeringInactiveDate}
  • Description: For use with the Telemetry Comparison trigger. Inserts the inactive date of the telemetry that triggered the workflow. No inputs to the variable are necessary.
  • Example: {TriggeringInactiveDate}
  • Applications: Workflow

Triggering Max Active Date

• • Format: {TriggeringMaxActiveDate}
  • Description: For use with the Telemetry Comparison trigger. Inserts the maximum active date of the telemetry that triggered the workflow. No inputs to the variable are necessary.
  • Example: {TriggeringMaxActiveDate}
  • Applications: Workflow

Triggering Max Inactive Date

• • Format: {TriggeringMaxInactiveDate}
  • Description: For use with the Telemetry Comparison trigger. Inserts the maximum inactive date of the telemetry that triggered the workflow. No inputs to the variable are necessary.
  • Example: {TriggeringMaxInactiveDate}
  • Applications: Workflow

Triggering Min Active Date

• • Format: {TriggeringMinActiveDate}
  • Description: For use with the Telemetry Comparison trigger. Inserts the minimum active date of the telemetry that triggered the workflow. No inputs to the variable are necessary.
  • Example: {TriggeringMinActiveDate}
  • Applications: Workflow

Triggering Min Inactive Date

• • Format: {TriggeringMinInactiveDate}
  • Description: For use with the Telemetry Comparison trigger. Inserts the minimum inactive date of the telemetry that triggered the workflow. No inputs to the variable are necessary.
  • Example: {TriggeringMinInactiveDate}
  • Applications: Workflow

Triggering Task

• • Format: {TriggeringTask}
  • Description: The 36-character GUID of the task(s) that caused the workflow triggers to evaluate to ‘True’. No inputs to the variable are necessary.
  • Example: {TriggeringTask}
  • Applications: Workflow

Triggering Telemetry Average

• • Format: {TriggeringAvgNumericValue}
  • Description: For use with the Telemetry Aggregate trigger. Inserts the average of the telemetry values, based on the Date Grouping in the Telemetry Aggregate trigger, over the specified date range. No inputs to the variable are necessary.
  • Example: {TriggeringAvgNumericValue}
  • Applications: Workflow

Triggering Telemetry Sum

• • Format: {TriggeringSumNumericValue}
  • Description: For use with the Telemetry Aggregate trigger. Inserts the sum of the telemetry values, based on the Date Grouping in the Telemetry Aggregate trigger, over the specified date range. No inputs to the variable are necessary.
  • Example: {TriggeringSumNumericValue}
  • Applications: Workflow

Triggering Telemetry Value

• • Format: {TriggeringNumericValue}
  • Description: For use with the Telemetry Comparison trigger. Inserts the value of the telemetry that triggered the workflow. No inputs to the variable are necessary.
  • Example: {TriggeringNumericValue}
  • Applications: Workflow

Unit of Measure

• • Format: {UnitOfMeasureID}
  • Description: A unit of measure. No inputs to the variable are necessary. Only available when Telemetry is selected as the Datasource in a report. To configure a report filter to select a value from a list of units of measure, you will need to set the Value field to an ID rather than a name. For example: Unit of Measure.Unit of Measure ID = {UnitOfMeasureID} will allow you to filter by a unit of measure chosen from the list of all available units of measure.
  • Examples:
    • Unit of Measure.Unit of Measure ID = {UnitOfMeasureID}
  • Applications: ReportDate