Short codes are used when creating emails and PDFs, to include variables so that your emails are contextualised for the course, venue etc that the customer is attending.
See Variable short codes for use in Emails and PDFs
The following shows the different short codes, their name, a sample of the output and a description. If you spot any inconstancies or you notice there is more than what is listed here please let us know!
Record of Results
[DocumentTopicSummary:RecordOfResults]
This is to display the record of results of all those Units and Modules that have been given the outcome ‘Competency achieved/pass’ (value=20) for the field “AVETMISS 7.0 Outcome Identifier - National”
Example value (Emails and PDFs are designed in HTML):
<table width=100%><tr>
<td width=10%>SITHFAB201</td><td width=80%>Provide responsible service of alcohol</td><td width=10%>Feb 2019</td><tr><tr>
<td width=10%>SITHGAM001</td><td width=80%>Provide responsible gambling services</td><td width=10%>Feb 2019</td>
</tr><table>
Which looks like this in PDFs:
SITHFAB201 Provide responsible service of alcohol Feb 2019
SITHGAM001 Provide responsible gambling services Feb 2019
The short code for this used to be [DocumentTopics:RecordOfResults]
Attainment
[DocumentTopicSummary:Attainment]
Example value (Emails and PDFs are designed in HTML):
<table width=100%><tr>
<td width=10%>SITHFAB201</td><td width=90%>Provide responsible service of alcohol</td></tr><tr>
<td width=10%>SITHGAM001</td><td width=90%>Provide responsible gambling services</td>
</tr><table>
Which looks like this in PDFs:
SITHFAB201 Provide responsible service of alcohol
SITHGAM001 Provide responsible gambling services
The short code for this used to be [DocumentTopics:Attainment]
Attainment (Name Only)
[DocumentTopicSummary:AttainmentNameOnly]
Example value (Emails and PDFs are designed in HTML):
<table width=100%><tr>
<td>Provide responsible service of alcohol</td></tr><tr>
<td>Provide responsible gambling services</td>
</tr><table>
Which looks like this in PDFs:
Provide responsible service of alcohol
Provide responsible gambling services
The short code for this used to be [DocumentTopics:AttainmentNameOnly]
Attainment Plain Text
[DocumentTopicSummary:AttainmentDiv]
Example value (Emails and PDFs are designed in HTML):
<div>
Provide responsible service of alcohol<br>
Provide responsible gambling services
</div>
Which looks like this in PDFs:
Provide responsible service of alcohol
Provide responsible gambling services
The short code for this used to be [DocumentTopics:AttainmentDiv]
Example value:
Dates and times for first and last topic (unit/module)
The following includes the start time and date for the first topic, so this can be used in emails for all courses (you need to have a course topic with a time specified for this to output a value). While the the Activity start date and Activity end date are likely to correspond to the course date start date and end date in most cases there are occasions where an assignment is completed after the actual course so a student could have an end date that is beyond that specified in the course date.
This is particularly useful when using continuous enrolment (eg e-learning or start-when-you-join) courses and you need to specify a start and/or end date on a per student basis.
Activity Start Date
[DocumentTopicSummary:activityStartDate]
First course module date (without time)
Example value:
1 February 2019
Activity Start Time
[DocumentTopicSummary:activityStartTime]
First course module start time (without date) - currently this is not used as course modules do not have times.
Example value:
12:00 AM
Activity End Date
[DocumentTopicSummary:activityEndDate]
Last course module date (without time)
Example value:
1 February 2019
Activity End Time
[DocumentTopicSummary:activityEndTime]
Last course module end time (without date) - currently this is not used as course modules do not have times.
Example value:
12:00 AM