Simple Variables

You are here:
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 }. The system honors two ways of applying the variable to a value.
  1. Append Variable: Select this option to insert the variable at the end of the value. The list of variables available in the dropdown is not always exhaustive.
  2. Use Variable: Select this option to replace the value with the variable. The list of variables available in the dropdown is not always exhaustive.
Please see Telemetric Variables for details on how to use those more complex functions.
Variable Format Description Example Applications
As of Date {AsOfDate} Used in report filters to prompt the user for a single date and filters for all dates greater than or equal to this date. NOTE:  A report with this variable set to “first day of this year” will automatically roll over to the next year on January 1. Telemetry.ActiveDate >= {AsOfDate} Report
Asset {Asset:} 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:} {Asset:Engine_01} Or {Asset: d445e351-e93b-4e35-89f6-8a9b23cc8495} Form Type Report Workflow
Asset (Report dropdown filter) {AssetID} 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. Asset.Asset ID = {AssetID} Report
Asset Address {AssetAddress:,
,
}
Inserts 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. {AssetAddress:{FormAnswer:Facility},Physical,Street1} Or {AssetAddress: 3d367a48-8b09-46c7-bd08-95d2763802a2,Mailing,State.Code} Form Type
Asset Attribute (Form) {AssetAttribute:,} 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 example to the right). {AssetAttribute: Engine_CE01, FuelType} Or (AssetAttribute:{FormAnswer:EngineName}, FuelType} Form Type
Asset Attribute (Reports and Workflow) {AssetAttribute:} 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:} variable in the Calculated Field. Use of the Alias field is highly recommended for identifying the attribute in each column. For Asset Attributes that span multiple record types, please specify the record type within the variable (as in the last example). {AssetAttribute:Condition} Or {AssetAttribute: a9fe3517-da98-46ff-b990-6f0e5687458e} Or {AssetAttribute:StartDate, Engine} Report Workflow
Asset Contact(s) {AssetContacts:,} 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. {AssetContacts:{FormAnswer:Facility},Manager} Form Type
Associated Contact(s) {AssociatedContacts} All of the contacts associated with the asset(s) that are identified in the report or that triggered the workflow (no inputs to the variable are necessary). {AssociatedContacts} Report Workflow
Associated Contact(s) with Role {AssociatedContacts:} All of 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:} 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. {AssociatedContacts:EngineMechanic} Or {AssociatedContacts:a8bebe1e-68cf-4451-bfc6-7ec05db3157c} Report Workflow
Blank/Null {Blank} 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. {Blank} Form Type Report Task TypeWorkflow
Calendar Year {CalendarYear} 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. {CalendarYear} Document Template Report
Calendar Year End Date {CalendarYearEndDate} The last day in 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. Telemetry.ActiveDate <= {CalendarYearEndDate} Document Template Report
Calendar Year Start Date {CalendarYearStartDate} The first day in 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. Telemetry.ActiveDate >= {CalendarYearStartDate} Document Template Report
Contact {Contact:} Or {Contact:, } 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 {Contact:BillupsJames27210} Or {Contact:3d367a48-8b09-46c7-bd08-95d2763802a2} Or {Contact:SmithBob4589,LFM} Form Type Report Workflow
Contact (Report dropdown filter) {ContactID} 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. Contact.Contact ID = {ContactID} Report
Contact Address {ContactAddress:,
,
}
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.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. {ContactAddress:{FormAnswer:Assetas_EmployeeName},Assetas_Home,Street1} Or {ContactAddress: 3d367a48-8b09-46c7-bd08-95d2763802a2,Mailing,State.Code} Form Type
Contact Attribute (Form) {ContactAttribute:,} 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 to the right). {ContactAttribute: BillupsJames27210, Title} Or {ContactAttribute:{FormAnswer:EmployeeName}, Title} Or {ContactAttribute:{CurrentUser}, Role} Form Type
Contact Attribute (Reports and Workflow) {ContactAttribute:} 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:} variable in the Calculated Field. Use of the Alias field is highly recommended for identifying the attribute in each column. For Contact Attributes that span multiple record types, please specify the record type within the variable (as in the last example). {ContactAttribute:Birthday} Or {ContactAttribute: b51d832d-b358-4250-9abd-e2122d2d422b} Or {ContactAttribute:StartDate, Staff} Report Workflow
Contact Email {ContactEmail:,} 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 (Personal or Work) or external identifier. {ContactEmail:{FormAnswer:Name},Work} Or {ContactEmail:BinghamBrandy53128,Personal} Form Type
Contact Phone {ContactPhone:,} 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.). {ContactPhone:BinghamBrandy53128,Mobile} Or {ContactPhone:{FormAnswer:ContactName},Home} Form Type
County {CountyID} 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. Address.County ID = {CountyID} Report
Country {CountryID} 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. Address.Country ID = {CountryID} Report
Create Date {CreateDate} The date the form was created (no inputs necessary). Available only in the Form Name field. {CreateDate} Form Type
Current Location {CurrentLocation} Inserts the latitude/longitude coordinates of the user’s location (no inputs necessary). Available only in Form questions when using the Coordinates Data Type. NOTE:  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. {CurrentLocation} Form Type
Current User {CurrentUser} Or {CurrentUser: } 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 {CurrentUser} Or {CurrentUser:FL} Document Template Form Type Report Task Type
Document Attribute {DocumentAttribute:} 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. {DocumentAttribute:Description} Or {DocumentAttribute: bfeb244f-322b-4abe-bf16-9396e6bcd73c} Report
End Date {EndDate} 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. 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. Telemetry.ActiveDate <= {EndDate} Document Template Report
Evaluate {Evaluate:} Allows for mathematical functions to be performed on numbers and dates. Please refer to section 8.3 of the Appendix for examples of how to use this function. {Evaluate:{FormAnswer:Count} + 5} Or {EVALUATE: ToDateTime(“{FormAnswer:Date}”).AddDays(10)} Form Type Workflow
First Day of the Month {MonthStart} Inserts the first day of the current month. No inputs to the variable are necessary. Only available when Telemetry Aggregate is selected as the Trigger Type in Workflow. {MonthStart} Workflow
First Day of the Year {YearStart} Inserts the first day of the current year. No inputs to the variable are necessary. Only available when Telemetry Aggregate is selected as the Trigger Type in Workflow. {YearStart} Workflow
Form Answer {FormAnswer:} Or {FormAnswer:, } 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 {FormAnswer:Inspector_Name} Or {FormAnswer:3b06c469-56de-4047-aec1-583d1a77ad95} Or {FormAnswer:ReportedBy, FL} Form Type Report Workflow
Form Type {FormType} The current form type of the form being edited (no inputs necessary). Available only in the Form Name field. {FormType} Form Type
Last Day of the Month {MonthEnd} Inserts the last day of the current month. No inputs to the variable are necessary. Only available when Telemetry Aggregate is selected as the Trigger Type in Workflow. {MonthEnd} Workflow
Last Day of the Year {YearEnd} Inserts the last day of the current year. No inputs to the variable are necessary. Only available when Telemetry Aggregate is selected as the Trigger Type in Workflow. {YearEnd} Workflow
Manager Of {ManagerOf:} Or {ManagerOf:, } 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 example to the right). 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 {ManagerOf:BillupsJames27210} Or {ManagerOf: 3d367a48-8b09-46c7-bd08-95d2763802a2} Or {ManagerOf:{FormAnswer:EmployeeName}} Or {ManagerOf:{TriggeringContact},FL} Or {ManagerOf:{FormAnswer:EmployeeName},L} Form Type Workflow
New Form Link {NewFormLink:
,
}
Creates a clickable link to another existing form type and allows for custom link text. {NewFormLink:Storm_CA, Stormwater Corrective Action Report Form} Or {NewFormLink: 81499d29-a719-4c6e-a722-f564b8673a2b, Incident Follow Up Form} Form Type Task Type
Now {Now} The current date & time (no inputs necessary). {Now} Document Template Form Type Task Type Workflow
Report {ReportID} 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. Report.Report ID = {ReportID} Report
Selection List {SL:} 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. Asset.Asset ID = {SL:ActiveEngines} Or Asset.Asset ID = {SL: a01cbd61-dd5b-4770-889c-53d4d84bbc83} Report
Start Date {StartDate} 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. Telemetry.ActiveDate >= {StartDate} Document Template Report
State {StateID} 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. Address.State ID = {StateID} Report
Task {TaskID} 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. Task.Task ID = {TaskID} Report
Task Attribute {TaskAttribute:} The value for a specific task attribute. Enter the Task Attribute Type’s external identifier or 36-character GUID. {TaskAttribute:Mileage} Or {TaskAttribute:c6ee6695-a46c-4f31-bfb4-c2517079b232} Task Type Report
Telemetry Type {TelemetryTypeID} 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. Telemetry Type.Telemetry Type ID = {TelemetryTypeID} Report
Timestamp ID {TimestampID} Or {TimestampID:YYMMDD.HHMMSS} 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. {TimestampID} OR {TimestampID:YYMMDD.HHMMSS} Form Type
Today {Today} The current date in your timezone (no inputs necessary). {Today} Document Template Form Type Report Task Type Workflow
Today + – Days {Today +- No. of Days} A date before or after today, based on the number of days specified. {Today + 7} Or {Today – 2} Document Template Form Type Report Workflow
Triggering Active Date {TriggeringActiveDate} 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. {TriggeringActiveDate} Workflow
Triggering Asset {TriggeringAsset} The name of the asset(s) that caused the workflow triggers to evaluate to ‘True’. No inputs to the variable are necessary. {TriggeringAsset} Workflow
Triggering Asset Link {TriggeringAssetLink} 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. {TriggeringAssetLink} Workflow
Triggering Contact {TriggeringContact} Or {TriggeringContact: } 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 {TriggeringContact} Or {TriggeringContact:FL} Workflow
Triggering Form {TriggeringForm} The 36-character GUID of the form(s) that caused the workflow triggers to evaluate to ‘True’. No inputs to the variable are necessary. {TriggeringForm} Workflow
Triggering Form Link {TriggeringFormLink} A link with the name of the form(s) that caused the workflow triggers to evaluate to ‘True’. No inputs to the variable are necessary. {TriggeringFormLink} Workflow
Triggering Group Active Date {TriggeringGroupActiveDate} 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. {TriggeringGroupActiveDate} Workflow
Triggering Group Inactive Date {TriggeringGroupInactiveDate} 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. {TriggeringGroupInactiveDate} Workflow
Triggering Inactive Date {TriggeringInactiveDate} 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. {TriggeringInactiveDate} Workflow
Triggering Max Active Date {TriggeringMaxActiveDate} 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. {TriggeringMaxActiveDate} Workflow
Triggering Max Inactive Date {TriggeringMaxInactiveDate} 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. {TriggeringMaxInactiveDate} Workflow
Triggering Min Active Date {TriggeringMinActiveDate} 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. {TriggeringMinActiveDate} Workflow
Triggering Min Inactive Date {TriggeringMinInactiveDate} 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. {TriggeringMinInactiveDate} Workflow
Triggering Telemetry Average {TriggeringAvgNumericValue} 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. {TriggeringAvgNumericValue} Workflow
Triggering Telemetry Sum {TriggeringSumNumericValue} 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. {TriggeringSumNumericValue} Workflow
Triggering Telemetry Value {TriggeringNumericValue} For use with the Telemetry Comparison trigger. Inserts the value of the telemetry that triggered the workflow. No inputs to the variable are necessary. {TriggeringNumericValue} Workflow
Unit of Measure {UnitOfMeasureID} 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. Unit of Measure.Unit of Measure ID = {UnitOfMeasureID} Report
Table of Contents