User Tools

Site Tools


variables_you_can_use_in_lucy

This is an old revision of the document!


Landing Page Variables

  • %static% — path to static directory. It may be useful to make references to CSS/JS files from the HTML page. For example: <link rel="stylesheet" type="text/css" href="%static%/style.css"> <script src="%static%/script.js"></script>
  • %link% — base link of the scenario. Use it in navigation for constructing absolute URLs.
  • %name% — recipient name
  • %email% — recipient email address
  • %message% — error message (if any)
  • %link-awareness% — link to the awareness website. You should configure & enable the awareness website in campaign settings for this feature to work.
  • %division%
  • %location%
  • %staff-type%
  • %comment% — recipient related information.
  • %gender("MALE ADDRESSING", "FEMALE ADDRESSING")% — recipient gender
  • %time(FORMAT, OFFSET, ZONE)% — Time based variables. FORMAT - date/time format. OFFSET - date/time offset in minutes, can be negative (example: "-60" - means 60 minutes prior to mail submit time, "20160" - 20160 minutes = 14 days). ZONE - time zone name (example: US/Central). Example: %time("l, H:i", "0", "Europe/Zurich")% — will output "Monday, 09:20" - exact time of email submission in Europe/Zurich zone. Example: %time("Y/m/d H:i:s", "60")% — will output "2016/12/12 10:20:30" - 1 hour ahead of email submit time

Please note, that these variables are not available in CSS and Javascript files.

Login form parameters

The login form should use a POST method and either point to the same page (have an empty action attribute) or have an action set to "?login". If you want to validate logins & passwords using regular expressions ("Login Regexp" and "Password Regexp" fields in scenario settings), please set the name of the login field to "login" and the name of the password field to "password".

Message Template Variables

You may use the following variables in the template:

  • %link% — unique page URL for the recipient.
  • %link-awareness% — link to the awareness website. You should configure & enable the awareness website in campaign settings for this feature to work.
  • %name% — recipient name
  • %email% — recipient email address
  • %division%
  • %location%
  • %staff-type%
  • %comment% — recipient related information.
  • %gender("MALE ADDRESSING", "FEMALE ADDRESSING")% — recipient gender
  • %time(FORMAT, OFFSET, ZONE)% — Time based variables. FORMAT - date/time format. OFFSET - date/time offset in minutes, can be negative (example: "-60" - means 60 minutes prior to mail submit time, "20160" - 20160 minutes = 14 days). ZONE - time zone name (example: US/Central). Example: %time("l, H:i", "0", "Europe/Zurich")% — will output "Monday, 09:20" - exact time of email submission in Europe/Zurich zone. Example: %time("Y/m/d H:i:s", "60")% — will output "2016/12/12 10:20:30" - 1 hour ahead of email submit time

Please note, that these variables are not available in CSS and Javascript files.

Reporting Template Variables

Within your you can use the following variables Lucy comes with a constantly growing list of variables which are placeholders for specific statistics or graphics. Those placeholders can be inserted in the content of any section in the custom report template at any point:

When you create the report within a campaign those variables will be populated with your specific campaign statistics (similar to the graphics you already know from the dashboard). Those variables are:

  • %report.createdate% Create Date Of Report
  • %report.author% Author Of Report
  • %startdate% Start Date & Time Of Campaign
  • %finishdate% Finish Date & Time Of Campaign
  • %creator% User Who Created The Campaign
  • %file.formats% File Based Attacks: Name Of File Formats Used In Campaign Scenarios
  • %scenarios.number% Number Of Scenarios Used In Campaign
  • %scenarios.names% Names Of Scenarios Used In Campaign
  • %scenarios.types% Types Of Scenarios Used In Campaign
  • %client% Client Name
  • %opened% Percentage opened mail
  • %clicked% Percentage clicked on link
  • %domains% Domain(s) Used In Scenarios Settings
  • %timezone% Timezone Setting Of LUCY
  • %recipients.groups% Recipient Group Names In Campaign
  • %awareness.name% Name Of Awareness Template Used
  • %awareness.sent% Number Of Awareness Emails Sent
  • %awareness.incomplete% Number Of Users With Incomplete Training
  • %awareness.completed% Number Of Users Who Completed Training
  • %questions.number% Number Of Questions In Quiz
  • %data.number% Absolute Number & Relative Number Of Collected Data From Users
  • %logo% Logo
  • %table.contents% Table Of Contents
  • %system.info% System Information
  • %file.settings% File Based Attacks: Settings Table
  • %scenarios.settings% Scenarios Settings
  • %message.settings% Message Template Settings
  • %schedulers% Scheduler Settings
  • %awareness.settings% Awareness Website Settings
  • %data% Reports the file attack output & form POST data
  • %additional.fields% List Of Available Recipient Fields
  • %victim.table% Detailed Victim Results
  • %quiz% Quiz Questions
  • %analyse.stats% Analyse Statistics
  • %benchmark.stats% Benchmark Statistics
  • %compare.stats% Campaign Comparison Statistics
  • %charts% All Charts
  • %charts.summary% Summary Chart
  • %charts.totalstats% Total Stats Chart
  • %charts.analyse% Analyse Stats Chart
  • %charts.dailystats% Daily Stats Chart
  • %charts.hourlystats% Hourly Stats Chart
  • %charts.events% Events Chart
  • %charts.os% Operating System Chart
  • %charts.browsers% Browsers Chart
  • %charts.files% Files Chart
  • %charts.plugins% Plugins Chart
  • %charts.countries% Countries Chart
  • %charts.awareness% Awareness Stats Chart
  • %charts.additional% Additional Charts
  • %charts.custom% Custom Fields Charts
  • %awareness.website% Awareness Website Screenshot
  • %awareness.mail% Awareness Mail Template Screenshot
  • %message.screen% All Message Template Screenshots
  • %landing.screen% All Landing Page Screenshots
  • %message.screen#% Message Template Screenshot (# - replace on scenario id)
  • %landing.screen#% Landing Page Screenshot (# - replace on scenario id)

eLearning variables

You can also create your own eLearning templates. You may use the following variables in the templates:

  • %name% — Recipient's name (if applicable)
  • %email% — Recipient's email address (if applicable)
  • %client% — Client's name
  • %started% — Date when the related campaign has been started.
  • %stopped% — Date when the related campaign has been stopped.
variables_you_can_use_in_lucy.1554667574.txt.gz · Last modified: 2019/07/25 12:51 (external edit)