Appendix E – Email Templates
The table shows the available parameters and their definitions from the Email Templates page.
Description |
Parameter Name |
Notes |
Alert data id |
ALERT_DATA_ID |
The alert ID associated with the record. |
Alert description |
ALERT_DESCRIPTION |
The description of the alert (i.e. Late In). |
Alert formula |
ALERT_FORMULA |
The script formula that created the alert. |
Alert Generated date/time |
ALERT_GENERATED_DATETIME |
The date and time the alert was generated. |
Alert ID |
ALERT_ID |
The alert ID associated with the record. |
Alert minutes |
ALERT_MINUTES |
The minutes of the alert (i.e. 5 minutes late). |
Alert Offending date/time |
ALERT_OFFENDING_DATETIME |
The date and date of the punch or other hours record that met the condition of the alert. |
Alert severity code |
ALERT_SEVERITY_CODE |
The alert severity code (H=High, M=Medium, I=Immediate, E=Email, L=Low). |
Alert type description |
ALERT_TYPE_DESC |
The description of the alert (i.e. Late In). |
Alert type name |
ALERT_TYPE_NAME |
The name of the alert (i.e. Late In). |
Employee badge |
EMP_BADGE |
The employee’s badge number. |
Employee first name |
EMP_FIRST |
The employee’s first name. |
Employee job title |
EMP_JOB_TITLE |
The employee’s job title. |
Employee last name |
EMP_LAST |
The employee’s late name. |
Employee middle initial |
EMP_MIDDLE |
The employee’s middle initial. |
Employee name |
EMP_NAME |
The employee’s first, middle initial and last names. |
Employee number |
EMP_NUMBER |
The employee number assigned to the employee. |
Offending employee org level 1 |
EMP_ORG_LEVEL_1 |
The employee’s home organization level 1 assignment. |
Offending employee org level 2 |
EMP_ORG_LEVEL_2 |
The employee’s home organization level 2 assignment. |
Offending employee org level 3 |
EMP_ORG_LEVEL_3 |
The employee’s home organization level 3 assignment. |
Offending employee org level 4 |
EMP_ORG_LEVEL_4 |
The employee’s home organization level 4 assignment. |
Offending employee org level 5 |
EMP_ORG_LEVEL_5 |
The employee’s home organization level 5 assignment. |
Offending employee org level 6 |
EMP_ORG_LEVEL_6 |
The employee’s home organization level 6 assignment. |
Offending employee org level 7 |
EMP_ORG_LEVEL_7 |
The employee’s home organization level 7 assignment. |
Offending employee org level 8 |
EMP_ORG_LEVEL_8 |
The employee’s home organization level 8 assignment. |
Offending employee org level 9 |
EMP_ORG_LEVEL_9 |
The employee’s home organization level 9 assignment. |
Offending employee pay group description |
EMP_PAY_GROUP_DESC |
The name of the employee’s pay group assignment. |
Offending employee pay group name |
EMP_PAY_GROUP_NAME |
The description of the employee’s pay group assignment. |
Employee time zone |
EMP_TIME_ZONE |
The employee’s time zone description. |
Employee time zone name |
EMP_TIME_ZONE_NAME |
The employee’s time zone name. |
Employee title |
EMP_TITLE |
The employee’s title (i.e. Ms., Mr., Mrs., Dr.). |
Recipient first name |
RECIPIENT_FIRST |
The email recipient’s first name. |
Recipient last name |
RECIPIENT_LAST |
The email recipient’s last name. |
Recipient middle initial |
RECIPIENT_MIDDLE |
The email recipient’s middle initial. |
Recipient name |
RECIPIENT_NAME |
The employee’s recipient’s first, middle initial and last names. |
Request punch actual timedate |
REQPUNCH_ACTUAL_TIMEDATE |
The actual timedate of the punch request |
Request punch pay type |
REQPUNCH_PAY_TYPE |
The pay type associated with the punch request. |
Request punch pay type name |
REQPUNCH_PAY_TYPE_NAME |
The pay type associated with the punch request. |
Request punch category |
REQPUNCH_PUNCH_CATEGORY |
The punch category associated with the request. |
Request schedule all day flag |
REQSCHED_ALL_DAY_FLAG |
Whether the time off or schedule request was selected for all day. |
Request schedule deviation code |
REQSCHED_DEVIATION_CODE |
The schedule deviation code for the schedule request (C=Unpaid Time Off, X=Cancel Shift, A=Additional Time). |
Request schedule deviation code description |
REQSCHED_DEVIATION_CODE_DESCRIPTION |
The schedule deviation code for the schedule request (C=Unpaid Time Off, X=Cancel Shift, A=Additional Time). |
Request schedule duration |
REQSCHED_DURATION |
The duration of the Schedule request. |
Start date for the schedule change |
REQSCHED_EFFECTIVE_DATE |
The request start date for a time off or schedule request. |
Start time for the schedule |
REQSCHED_START_TIME |
The request start time for a time off or schedule request. |
Stop date for the schedule change |
REQSCHED_STOP_DATE |
The request stop date for a time off or schedule request. |
Stop time for schedule |
REQSCHED_STOP_TIME |
The request stop time for a time off or schedule request. |
Is the request cancelled? |
REQUEST_CANCELLED_FLAG |
If the request was cancelled. |
What request is being cancelled? |
REQUEST_CANCELLED_ID |
The cancelled request ID. |
Request comment |
REQUEST_COMMENT |
The employee comment of the request. |
Request summary of time |
REQUEST_DURATION |
The total hours of the request. |
Global status of the request |
REQUEST_STATUS |
The request status (Approved, Denied, Unanswered, Cancelled, No Action Required). |
Request sub subtoken |
REQUEST_SUB_SUBTOKEN |
|
Date/time that the request was made |
REQUEST_TIMEDATE |
The time/date the request was submitted |
Request type |
REQUEST_TYPE |
The type of request (Punch, Schedule, Time off, General) |
User that made the request |
REQUEST_USER |
The user that submitted the request |
Workflow used to calculate recipients |
REQUEST_WORKFLOW |
The request workflow used to determine recipient |
Request time off detail all day flag |
SUB_REQUEST_ALL_DAY_FLAG |
Whether the request was for all day off for the detail lines within a time off deviation. |
Request time off last sub record date |
SUB_REQUEST_DATE |
The date of the detail line within a time off deviation. |
Request time off detail deviation code |
SUB_REQUEST_DEVIATION_CODE |
The schedule deviation code for a detail line within a time off deviation. |
Request time off detail deviation code description |
SUB_REQUEST_DEVIATION_DESCRIPTION |
The schedule deviation description for a detail line within a time off deviation. |
Request detail time off time
|
SUB_REQDATE_DURATION |
Number of hours for each day requested |
Request detail time off pay type |
SUB_REQDATE_PAY_TYPE |
The pay type of the time off request. |
Request detail time off pay type description |
SUB_REQDATE_PAY_TYPE_DESCRIPTION |
The pay type description of the time off request. |
Request detail time off start time |
SUB_REQDATE_START_TIME |
Start time for each day requested. |
Request punch depth for an override |
SUB_REQPUNCHOL_DEPTH |
The org level depth for the punch request. |
Request punch override org level ID |
SUB_REQPUNCHOL_ORGLEVEL_ID |
The org level id of the punch request. |
Request response advisory flag |
SUB_REQRESP_ADVISORY_FLAG |
|
Response comment |
SUB_REQRESP_COMMENT |
The comment entered by the recipient. |
Date/time that the request response was made |
SUB_REQRESP_RESPONSE_TIMEDATE |
The date/time the response was submitted. |
Request response status |
SUB_REQRESP_STATUS |
The status that the recipient responded with. |
Who is making this response to the request |
SUB_REQRESP_USER |
The user that is responding to the request. |
Token alert ID |
SUB_REQTOK_ALERT_ID |
|
Token option response label |
SUB_REQTOK_SUBTOKEN_LABEL |
|
Token option string |
SUB_REQTOK_SUBTOKEN_STRING |
|
Token option response URL |
SUB_REQTOK_SUBTOKEN_URL |
|
Token string for the alert and user |
SUB_REQTOK_TOKEN_STRING |
|
Token user ID |
SUB_REQTOK_USER_ID |
|
Sub Template Indicator |
TEMPLATE |
The ID of the email template. |
Link to TimeStar login page |
TIMESTAR_LOGIN_LINK |
The URL to the login page of TimeStar™. NOTE – additional setup is necessary for this item. |