CAT uses email to communicate with people. The use of template files allows the content of each mail sent by CAT to be customised to include your company name etc. The templates relating to queries allow CAT to receive a request by email and to mail back the query response.
The following templates are used at various points within the recruitment process.
| acknowledgement | an optional acknowledgement sent upon receipt of a new CV |
| block | a return message sent back when a mail is received from a blocked address |
| receipt error | if a CV submitted to CAT cannot be understood, then an receipt error message is returned |
| general error | template used to inform an email user of a general error in processing |
| interview | template used to invite a person to perform an interview |
| reminder | template used to remind a person to perform an interview |
| query | template used return the results of a general query |
| status query | template used return the results of a status query about a single application |
| agent status query | template used return the results of a status query about all applications from a given recruitment agency |
| put on hold | message sent when an application is put 'on hold' |
| take off hold | message sent when an application is taken off hold |
| reject | message sent when an application is rejected |
| reference request | message sent to request a reference |
| reference acknowledgement | message sent to acknowledge a reference received |
| applicant details | message sent containing all details stored about an applicant |
The contents of these mail messages are built from a template
which is filled using data supplied by the CAT system. For example,
when acknowledging the receipt of an application, the file acknowledge.htm
contains the template and this is filled out with the name of the applicant etc.
This allows you to customise the mail messages sent out from the CAT system.
These template files live in the cat directory under the CAT
installation directory. By default, this is
c:\Program Files\Carapace\cat
A template can contain fragments of Carapace script to build the
HTML. These script fragments are embedded between the <carapace> and
</carapace> tags. For example, if a template included the following
script fragment
<carapace>(catDate 21)</carapace>
When a template is evaluated, there are two Carapace variables defined:
env - a HashTable which contains data
relevant to the template usage. All the keys of the table are strings.
scratch - a HashTable used to allow
different script fragments on the same page to share results.
If evaluation of the template sets the subject part of the template, then
this is used as the subject of the returned mail message. For instance, if the template
includes the following:
<carapace>(env.set "subject" "Query Results")</carapace>
Query Results.
File: acknowledge.htm
If this file does not exist, then no acknowledgement for a CV is sent.
If this file exists, it is used to build an acknowledgement sent upon receipt of a CV into the system. The sample provided by Carapace simply thanks the person for the application and says if they hear nothing back within 21 days then their application has not been successful. This file can be customised to include the company name, change/remove the 21 day threshold etc.
The env table contains the following keys:
| key | value type | description |
|---|---|---|
candidate |
String |
name of the candidate |
applicantId |
String |
unique identify for this particular application |
bestFitJob |
String |
job type for which this candidate has applied |
agent |
String |
email address used of this mail agent -- the acknowledgement is sent by this user |
For example, the following script fragment will be replaced by the candidate's name:
<carapace>(env.get "candidate")</carapace>
File: block.htm
This file is used to build a message sent upon receipt of a CV from a blocked mail address or domain.
The env table contains the following keys:
| key | value type | description |
|---|---|---|
blockedOn |
String |
date the block was set up |
blockReason |
String |
reason the block is in place |
blockedBy |
String |
person who applied the block |
For example, the following script fragment will be replaced by the reason for the block:
<carapace>(env.get "blockReason")</carapace>
File: rcverror.htm
This template is used when reporting a failure to process the supplied application. The original application mail message is included as an attachment when this error is sent.
The env table contains the following keys:
| key | value type | description |
|---|---|---|
agent |
String |
email address used of this mail agent -- the error message is sent by this user |
sender |
String |
email address of the person submitting the CV |
For example, the following script fragment will be replaced by the mail address used for sending back this error message:
<carapace>(env.get "agent")</carapace>
File: error.htm
This template is used when reporting a failure to process a mail message -- for example, if the interview attempts to re-arrange an interview and fails to include a replacement interviewer.
The env table contains the following keys:
| key | value type | description |
|---|---|---|
activity |
String |
short description of the activity being undertaken |
error |
Error |
the error raised |
sender |
String |
email address of the sender of the original message |
agent |
String |
email address used of this mail agent -- the error message is sent by this user |
For example, the following script fragment will be replaced by the mail address used for sending back this error message:
<carapace>(env.get "agent")</carapace>
File: interview.htm
This template is used when inviting a person to interview. The applicant's CV is included as an attachment when this message is sent.
The env table contains the following keys:
| key | value type | description |
|---|---|---|
interviewId |
String |
unique identifier for this interview as known by CAT |
candidate |
String |
name of the candidate to be interviewed |
jobType |
String |
type of job for which the candidate is to be interviewed |
interviewType |
String |
type of interview to be performed |
interviewers |
List |
list of email addresses of the people interviewing |
interviewDateTime |
String |
date and time of the interview |
room |
String |
name of the interview room |
comments |
String |
(optional) any comments entered by the interview arranger |
sender |
String |
email address of the person sending this invitation |
agent |
String |
email address used for sending this invitation |
For example, the following script fragment will be replaced by the candidate's name:
<carapace>(env.get "candidate")</carapace>
File: reminder.htm
This template is used when reminding a person about an interview. The applicant's CV is included as an attachment when this message is sent.
The env table contains the following keys:
| key | value type | description |
|---|---|---|
interviewId |
String |
unique identifier for this interview as known by CAT |
candidate |
String |
name of the candidate to be interviewed |
jobType |
String |
type of job for which the candidate is to be interviewed |
interviewType |
String |
type of interview to be performed |
interviewers |
List |
list of email addresses of the people interviewing |
interviewDateTime |
String |
date and time of the interview |
room |
String |
name of the interview room |
comments |
String |
(optional) any comments entered by the interview arranger |
sender |
String |
email address of the person sending this invitation |
agent |
String |
email address used for sending this invitation |
For example, the following script fragment will be replaced by the candidate's name:
<carapace>(env.get "candidate")</carapace>
File: query.htm
This template is used to return results from a general query.
The env table contains the following keys:
| key | value type | description |
|---|---|---|
db |
Db |
connection to the database |
sender |
String |
email address of the person submitting this query |
agent |
String |
email address used for sending the results |
subject |
String |
the subject line from the submitted email address -- this can be analysed to determine the type of query to perform |
agency |
String |
name of the recruitment agency, or the empty string, corresponding to the sender of this email message |
primary |
String |
if agency is not empty, this defines whether the
sender is the primary contact for the agency or not. Legal
values are "yes" and "no".
|
File: queryStatus.htm
This template is used to return the status information about a given application.
The env table contains the following keys:
| key | value type | description |
|---|---|---|
candidate |
String |
name of the candidate |
status |
String |
status of this application |
applicantId |
String |
unique identify for this particular application |
bestFitJob |
String |
job type for which this candidate has applied |
jobs |
List |
list of jobs for which this candidate is being considered |
agent |
String |
email address used of this mail agent -- the status information is sent by this user |
File: agentQueryStatus.htm
This template is used to return the status information about all applications submitted from a given recruitment agency.
The env table contains the following keys:
| key | value type | description |
|---|---|---|
db |
Db |
connection to the database |
sender |
String |
email address of the person submitting this query |
agent |
String |
email address used for sending the results |
subject |
String |
the subject line from the submitted email address -- this can be analysed to determine the type of query to perform |
agency |
String |
name of the recruitment agency, or the empty string, corresponding to the sender of this email message |
primary |
String |
if agency is not empty, this defines whether the
sender is the primary contact for the agency or not. Legal
values are "yes" and "no".
|
Files: hold.htm, agencyHold.htm
These templates are used to build the message sent when an application is placed 'on hold'. Different templates are used since the wording differs if the message is directed to the applicant directly or to an agency about the applicant. The values available to be expanded within the templates are the same in either case:
The env table contains the following keys:
| key | value type | description |
|---|---|---|
candidate |
String |
name of the candidate |
applicantId |
String |
unique identify for this particular application |
jobType |
String |
job type for which this candidate has applied |
comments |
String |
reason the candidate was placed on hold |
Files: offHold.htm, agencyOffHold.htm
These templates are used to build the message sent when an application is taken 'off hold'. Different templates are used since the wording differs if the message is directed to the applicant directly or to an agency about the applicant. The values available to be expanded within the templates are the same in either case:
The env table contains the following keys:
| key | value type | description |
|---|---|---|
candidate |
String |
name of the candidate |
applicantId |
String |
unique identify for this particular application |
jobType |
String |
job type for which this candidate has applied |
comments |
String |
reason the candidate was placed on hold |
Files: reject.htm,
These templates are used to build the message sent when an application is rejected. Different templates are used since the wording differs if the message is directed to the applicant directly or to an agency about the applicant. The values available to be expanded within the templates are the same in either case:
The env table contains the following keys:
| key | value type | description |
|---|---|---|
candidate |
String |
name of the candidate |
applicantId |
String |
unique identify for this particular application |
jobType |
String |
job type for which this candidate has applied |
comments |
String |
reason the candidate was placed on hold |
File: referenceRequest.htm
This template is used to build the message to request a reference for an applicant.
The env table contains the following keys:
| key | value type | description |
|---|---|---|
candidate |
String |
name of the candidate |
referee |
String |
name of the person being asked for a reference |
applicantId |
String |
unique identify for this particular application |
jobType |
String |
job type for which this candidate has applied |
comments |
String |
reason the candidate was placed on hold |
File: referenceAck.htm
This template is used to build the message thanking a referee for a reference.
The env table contains the following keys:
| key | value type | description |
|---|---|---|
candidate |
String |
name of the candidate |
referee |
String |
name of the person being asked for a reference |
applicantId |
String |
unique identify for this particular application |
jobType |
String |
job type for which this candidate has applied |
comments |
String |
reason the candidate was placed on hold |
File: applicantDetails.htm
This template is used to build the message returning all details held about an applicant to the applicant.
The env table contains the following keys:
| key | value type | description |
|---|---|---|
applicantId |
String |
unique identify for this particular application |
cv |
Object |
object describing the application |
details |
List |
attribute-value list describing the application |
notes |
List |
list of actions done to the application -- each action
is itself a list of 5 items:
|
interviews |
List |
list of interview details -- each detail
is itself a list of 5 items:
|
| Contents | Index | Current topic: Carapace Application Tracker | Related topics: Carapace Hub |