Variables in Lucy

Lucy variables are useful for personalizing your content for each recipient. You can use them throughout the application to easily apply the correct value without having to know it in advance.

Variables in Lucy use the % character to identify themselves, like so:

Hello %name%, I am sending this message on %date% at %time%.

---

Awareness Email Variables

Variable	Description
%link%	Resolves to the base URL of the scenario (phishing page in an attack template, training content in an awareness template).
%user-password-reset%	Resolves to a password reset link for the recipient's end-user account.
%user-profile-link%	Resolves to a link to the end-user portal.
%user-login-url%	Resolves to a Single Sign-On (SSO) link for the end-user portal.
%name%	Resolves to the recipient's full name.
%firstname%	Resolves to the recipient's first name.
%lastname%	Resolves to the recipient's last name.
%email%	Resolves to the recipient's email address.
%client%	Resolves to the client name associated with the recipient's group.
%gender%	Used for titles (e.g., Mr., Mrs., None).
%subject%	Resolves to the subject line of the attack email.
%sender%	Resolves to the sender name of the attack email.
%sender-email%	Resolves to the email address that sent the attack email.
%started%	Resolves to the date when the related campaign was started.
%stopped%	Resolves to the date when the related campaign was stopped.

time

%time% inserts a timestamp into the template. If a time zone is not specified then the time of the email send is used as the basis of the offset. The offset is measures in minutes.

You can configure the variable like so: %time("format", "offset", "zone")%

Examples

%time("l, H:i", "0", "Europe/Zurich")% = "Monday, 09:20"

This time is offset 0 minutes from Europe/Zurich time.

%time("Y/m/d" H:i:s", "-60")% = "2024/03/12 08:30:47"

The time is offset 60 minutes backwards from the time of the email.

---

Awareness Website Variables

Variable	Description
%name%	Resolves to the recipient's full name.
%email%	Resolves to the recipient's email address.
%client%	Resolves to the client name associated with the recipient's group.
%subject%	Resolves to the subject line of the attack email.
%sender%	Resolves to the sender name of the attack email.
%sender-email%	Resolves to the email address that sent the attack email.
%started%	Resolves to the date when the related campaign was started.
%stopped%	Resolves to the date when the related campaign was stopped.

---

Attack Email Variables

Variable	Description
%link%	Resolves to the base URL of the scenario (phishing page in an attack template, training content in an awareness template).
%qr-code%	A QR code version of the %link% variable.
%link-awareness%	Resolves to the awareness website.
%name%	Resolves to the recipient's full name.
%firstname%	Resolves to the recipient's first name.
%lastname%	Resolves to the recipient's last name.
%email%	Resolves to the recipient's email address.
%division%	Resolves to the recipient's division field.
%location%	Resolves to the recipient's location field.
%staff-type%	Resolves to the recipient's staff type field.
%comment%	Resolves to the recipient's comment field.

---

Attack Website Variables

Variable	Description
%link%	Always resolves to the base URL of the scenario. In an attack template, this is the phishing page; in an awareness template, this is the training content.
%link-awareness%	Resolves to the awareness website.
%name%	Resolves to the recipient's full name.
%firstname%	Resolves to the recipient's first name.
%lastname%	Resolves to the recipient's last name.
%email%	Resolves to the recipient's email address.
%division%	Resolves to the recipeint's division field.
%location%	Resolves to the recipeint's location field.
%staff-type%	Resolves to the recipeint's staff type field.
%comment%	Resolves to the recipeint's comment field.
%gender%	Used for titles (e.g., Mr., Mrs., None).
%subject%	Resolves to the subject line of the attack email.
%sender%	Resolves to the sender name of the attack email.
%sender-email%	Resolves to the email address that sent the attack email.

static

The %static% variable refers to the static file path, which is useful for linking content.

<link rel=styelsheet type="text/css" href="%static%/style.css>
<script src="%static%/script.js"></script>

time("format", "offset", "zone")

%time% inserts a timestamp into the template. If a time zone is not specified then the time of the email send is used as the basis of the offset. The offset is measures in minutes.

%time("l, H:i", "0", "Europe/Zurich")% = "Monday, 09:20"

This time is offset 0 minutes from Europe/Zurich time.

%time("Y/m/d" H:i:s", "-60")% = "2024/03/12 08:30:47"

The time is offset 60 minutes backwards from the time of the email.

---

Login Form Parameters

• The login form should use the POST method.

• Set the form's action attribute to either:

  • The same page (leave action empty).

  • "?login" to point to a login-specific route.

    • In Lucy, this action will automatically lead to the account.html page which is required in order to collect statistics for the campaign.

To validate logins and passwords using regular expressions (configured in the "Login Regexp" and "Password Regexp" fields in scenario settings):

• Set the name attribute of the login field to "login".

• Set the name attribute of the password field to "password".

---

Report Template Variables

Variable	Description
%report.createdate%	The date the report was created.
%report.author%	The author of the report.
%startdate%	Start date and time of the campaign.
%finishdate%	End date and time of the campaign.
%creator%	User who created the campaign.
%file.formats%	File formats used in file-based attack scenarios within the campaign.
%scenarios.number%	Total number of scenarios used in the campaign.
%scenarios.names%	Names of the scenarios used in the campaign.
%scenarios.types%	Types of scenarios used in the campaign.
%client%	Name of the client associated with the campaign.
%opened%	Percentage of recipients who opened the email.
%opened.count%	Number of emails that were opened.
%clicked%	Percentage of recipients who clicked on a link.
%clicked.count%	Number of emails where a link was clicked.
%sent.count%	Total number of emails sent in the campaign.
%reported%	Percentage of recipients who reported the email.
%success%	Percentage of emails where data was submitted by the recipient.
%success.count%	Number of emails where data was submitted.
%domains%	Domains used in the campaign's scenario settings.
%timezone%	Timezone setting of the product server.
%recipients.groups%	Names of recipient groups targeted in the campaign.
%awareness.names%	Name of the awareness template used.
%awareness.sent%	Number of awareness emails sent.
%awareness.opened%	Number of awareness emails opened by recipients.
%awareness.incomplete%	Number of users who did not complete the training.
%awareness.completed%	Number of users who completed the training.
%questions.number%	Number of questions included in the quiz.
%data.number%	Total and relative amount of data collected from users.
%recipient.count%	Number of recipients in the campaign.
%incident.count.campaign%	Number of incident reports related to the campaign.
%incident.count.campaignrelated%	Total number of reports related to all campaigns.
%incident.count.notcampaignrelated%	Total number of reports not related to campaigns.
%incident.count.total%	Total number of incident reports.
%out.of.office%	Percentage of "Out of Office" responses.
%bounced%	Percentage of bounced messages.
%responded%	Percentage of recipients who responded.