Substitution Variables

Variable Name	Description	Example/Notes
!acc_name!	Name of the employee who accepted. Repeating variable (used inside LOOP command).	Used for Callout Complete, and Callout Done/Closed alerts.
!acc_loc!	Location of the employee who accepted. Repeating variable (used inside LOOP command).	Used for Callout Complete, and Callout Done/Closed alerts.
!acc_class!	Classification of the employee who accepted. Repeating variable (used inside LOOP command).	Used for Callout Complete, and Callout Done/Closed alerts.
!acc_co_id!	Sub-callout ID of the employee who accepted.	Used for Callout Complete, and Callout Done/Closed alerts.
$acc_sched_com$	Schedule record comment. Used for Schedule Release Alerts and to display ETA.	Used for Callout Complete, Callout Done/Closed, Employee Release, and Schedule Record Modify alerts.
$acc_sched_start$	Working record start time for employees who have accepted the callout.	Used for the Callout Complete Alerts.
$acc_sched_end$	Working record end time for employees who have accepted the callout. If the employee has not been released an the schedule exception is set to auto-extend the end time will display as "**".	Used for the Callout Done/Closed Alerts.
$adj_new$	New adjusted VLG hours	Used for Vacation Management alert types only.
$adj_old$	Old adjusted VLG hours.	Used for Vacation Management alert types only.
$alert_reason$	Reason the alert was sent.	Can be used with all alert types but cannot be used with standard e-mails for callouts or notifications.
$arrivtime$	Sends the callout's Arrival Time (Crew Assembled in Yard Time) with alerts. Note: If an arrival time is not selected for the callout at the time of the alert, a dash ("-") will be sent in the arrival time field.	Used for Callout Complete, Callout Done/Closed alerts and callout and notification e-mail templates.
$c$	Company Abbreviation. Standard variable, e.g. MCLEOD.	Can be used with callout and notification e-mail templates, along with all alert types.
$calc_used$	Calculated VLG hours used.	Used for Vacation Management alert types only.
$callout_id$	Callout ID number. Standard variable, e.g. 20380.	Used for Callout Complete, Callout Done/Closed alerts, and callout and notification e-mail templates.
$change_date$	Date and Time a Schedule Record was Modified	Used for the Schedule Change E-mail Alerts.
$cm$	The callout Custom Message. Standard variable. Text as entered on the Custom Message Detail page or the Callout Create/Edit page.	Can only be used for callout and notification e-mail templates. This variable cannot be used with any alert type.
!co_id!	Sub-callout ID. Repeating variable (used inside LOOP command).	Used for Callout Complete and Callout Done/Closed alerts.
$cr$	The currently selected Callout Reason for the alerted callout. Standard variable, e.g. Broken Pole.	Used for Callout Complete, Callout Done/Closed alerts, and callout and notification e-mail templates.
$ct$	The alerted callout's type.Standard variable. The callout type, as selected from the Type dropdown on the Callout Create/Edit page, e.g. Normal.	Used for Callout Complete, Callout Done/Closed alerts, and callout and notification e-mail templates.
$custom_cond$	The callout Condensed Custom Message Text. Sends text as entered on the Custom Message Detail page or the Callout Create/Edit page in the Condensed Txt field.	Can only be used for callout and notification e-mail templates. This variable cannot be used with any alert type.
$d$	The description of the alerted callout. Standard variable. Description as entered in the callout description on the Callout Create/Edit page.	Used for Callout Complete and Callout Done/Closed alerts and callout, notification and SIREN Mass Calling e-mail templates.
$emp_class$	The employee's primary classification.	Used for Vacation Management alerts, Schedule Change, and Schedule Release alert types.
$emp_loc$	The employee's home location in ARCOS.	Used for Vacation Management alerts, Schedule Change, and Schedule Release alert types.
$emp_name$	The affected employee's name.	Used for Vacation Management alerts, Schedule Change, and Schedule Release alert types.
$entitled_new$	New number of hours entitled.	Used for Vacation Management alert types only.
$entitled_old$	Original number of hours entitled.	Used for Vacation Management alert types only.
$env$	The environment the callout was created in. This will be either "QA" or "PROD".	Can be used with callout and notification e-mail templates, along with all alert types.
$excep_count$	The number of Vacation Management exceptions that are scheduled for the VLG on the alerted day.	Used for Vacation Management alert types only.
$excep_date$	VLG exception date.	Used for Vacation Management alert types only.
$first_request$	Displays the first vacation or personal request created for the VLG.	Used for Vacation Management Request alert only.
$forcecall$	Sinafies if "Forced" was enabled on the callout or not at the time of the callout.	Used for Callout Complete, Callout Done/Closed alerts, and callout and notification e-mail templates.
$link_expires$	Displays the date and time the link will expire in the following format: MM/DD/YYYY HH:MM TZ	Used for the management of login password resets and new account activation.
$link_text$	Adds text to the e-mail informing the recipient what the link is for.	Used for the management of login password resets and new account activation.
$link_url$	Includes the unique URL for the employee’s account activation and password reset.	Used for the management of login password resets and new account activation.
$location$	The callout location.	Used for Callout Complete, Callout Done/Closed alerts and callout and notification e-mail templates.
$mce_call_id$	The call ID associated with the message.	Can only be used in SIREN Mass Calling templates.
$mce_email_txt$	The SIREN Mass Call text version of the message.	Can only be used in SIREN Mass Calling templates.
$mce_event_id$	The SIREN Mass Call event ID.	Can only be used in SIREN Mass Calling templates.
!msgInfo!	Allows more information about the Failed OB Message to be sent in the alert.	This is only used for the System Wide e-mail alert type.
$num_requests$	Shows the number of pending vacation or personal requests.	Used for Vacation Management Request alert only.
$owner$	The callout owner.	Used for Callout Complete, Callout Done/Closed alerts and callout and notification e-mail templates.
$ppl_called$	Used to send the number of people called for a callout.	Used for Callout Complete, Callout Done/Closed alerts and callout and notification e-mail templates.
$prev_info$	The original Start and End time of the alerted exception.	Used for the Schedule Change E-mail Alerts only.
$safetime$	Sends the callout's Made Safe Time (Crew Leaving the Yard Time) with alerts. Note: If a made safe time is not selected for the callout at the time of the alert, a dash ("-") will be sent in the made safe time field.	Used for Callout Complete, Callout Done/Closed alerts and callout and notification e-mail templates.
$sched_com$	The schedule record comment.	Used for the Schedule Change E-mail Alerts only.
$sched_dur$	The duration of the schedule exception.	Used for the Schedule Change E-mail Alerts only.
$sched_end$	The new End time of the exception.	Used for the Schedule Change E-mail Alerts only.
$sched_start$	the new Start time of the exception.	Used for the Schedule Change E-mail Alerts only.
$sched_type$	The exception type.	Used for the Schedule Change E-mail Alerts only.
$scm$	The text used for the sub-custom message. Only works in alerts if your company uses sub-custom messages.	Can only be used for callout and notification e-mail templates. This variable cannot be used with any alert type.
$source$	How the employee was released from their schedule exception. (example: VRU Inbound, Data Loader, or Web)	Used for Schedule Release Alerts only.
!sub_class!	The sub-callout classification. Repeating variable (used inside LOOP command).	Used for Callout Complete and Callout Done/Closed alerts.
!sub_filled!	The number of filled positions for the sub-callout. Repeating variable (used inside LOOP command).	Used for Callout Complete and Callout Done/Closed alerts.
!sub_loc!	The location of the list used for the sub-callout. Repeating variable (used inside LOOP command).	Used for Callout Complete and Callout Done/Closed alerts.
!sub_quan!	The number of employees requested from the sub-callout.	Used for Callout Complete and Callout Done/Closed alerts.
!sub_status!	The sub-callout's alerted status.	Used for Callout Complete and Callout Done/Closed alerts.
sup_name	Sends the supervisor name, from the Callout Create page.	Can be used with Callout and notification e-mail templates, along with alert types.
sup_phone	Sends the supervisor phone number, from the Callout Create page.	Can be used with Callout and notification e-mail templates, along with alert types.
$ticket$	The ticket number entered on the Callout Create page.	Used for callout e-mail templates, Callout Complete, and Callout Done/Closed alerts.
$total_new$	Exceeds total entitled.	Used for the Schedule Change E-mail Alerts only.
$trouble_loc$	The callout's selected Trouble Location.	Used for callout and notification e-mail templates and the Callout Complete and Callout Done/Closed alerts.
$user_name$	The name of the user who made the change.	Used for Vacation Management alert types only.
$used_new$	The new total number of hours used.	Used for Vacation Management alert types only.
$used_old$	The previous total number of hours used.	Used for Vacation Management alert types only.
$vlg_limit$	The day the exception puts the VLG over it's limit.	Used for Vacation Management alert types only.
$vlg_name$	The name of the alerted VLG.	Used for Vacation Management alert types only.
$vm_type$	The type of Vacation Management Exception.	Used for Vacation Management alert types only.
$vmp_start$	The start date of the Vacation Management Period.	Used for Vacation Management alert types only.
$vru_id$	The employee's VRU ID.	Used for Vacation Management alerts, Schedule Change, and Schedule Release alert types.
$work_start$	The selected Work Start Time for the callout on the Callout Edit page. Standard variable. Shown in time zone for the callout in question.	Used for Callout e-mail templates, Callout Complete and Callout Done/Closed alerts.
$work_end$	The selected Work End Time for the callout on the Callout Edit page. Standard variable. Shown in time zone for the callout in question.	Used for Callout e-mail templates, Callout Complete and Callout Done/Closed alerts

Note: These variables can be used in the form $var$ in order to insert the value, in the conditional form ?var? to only include the line IF the variable has a value, or !var! in conjunction with the LOOP command if the variable should be repeated.

For condition text (only if a value is returned) ?cm?Custom Message: $cm$

• If custom message text is available, the email will contain

• Custom Message: This is a test of the ARCOS email system.

• If custom text is not available, the email will NOT contain the "Custom Message" section of the email.

Note: Since the dollar sign ($), the question mark (?), and the exclamation point (!) are all reserved characters, in order to insert any of those symbols in the actual text, you must type the symbol twice. For example, to insert the text "Are you available for this callout?" you need to enter it as "Are you available for this callout??" so that the text editor recognizes the use of the question mark as part of the text and not part of a variable.

---

*Note: Not all companies have all of the items described in the Online Help.

*Please note, the ARCOS online documentation is a living document that is always under review. If you see information that is inconsistent with the behavior in the application, or you do not see a page covering an ARCOS feature you would like to know more about, please contact the ARCOS Support Center.