Differences

This shows you the differences between two versions of the page.

--- create_campaign_reports [2019/02/26 13:28] – lucy
+++ create_campaign_reports [2019/08/13 08:59] – [What variables can be used for the report?] lucy
@@ Line 37: / Line 37: @@
 ===== What variables can be used for the report? =====
-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 at any point. You find the variables within the variable list in LUCY:
+Lucy comes with a constantly growing list of variables which are placeholders for specific statistics or graphics. You find the variables within the variable list in LUCY:
 {{ variable_list_rr.png?600 }}
+Those placeholders can be inserted in the content of any report chapter:
 {{ report_variables.png?600 }}
@@ Line 45: / Line 47: @@
 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.createdate% Create Date Of Report
+  - %report.author%	Author Of Report
-  * %report.author% Author Of Report
+  - %startdate%	Start Date & Time Of Campaign
-  * %startdate% Start Date & Time Of Campaign
+  - %finishdate%	Finish Date & Time Of Campaign
-  * %finishdate% Finish Date & Time Of Campaign
+  - %creator%	User Who Created The Campaign
-  * %creator% User Who Created The Campaign
+  - %file.formats%	File Based Attacks: Name Of File Formats Used In Campaign Scenarios
-  * %file.formats% File Based Attacks: Name Of File Formats Used In Campaign Scenarios
+  - %scenarios.number%	Number Of Scenarios Used In Campaign
-  * %scenarios.number% Number Of Scenarios Used In Campaign
+  - %scenarios.names%	Names Of Scenarios Used In Campaign
-  * %scenarios.names% Names Of Scenarios Used In Campaign
+  - %scenarios.types%	Types Of Scenarios Used In Campaign
-  * %scenarios.types% Types Of Scenarios Used In Campaign
+  - %client%	Client Name
-  * %client% Client Name
+  - %opened%	Percentage Of Opened Mail
-  * %opened% Percentage opened mail
+  - %opened.count%	Number Of Emails Opened
-  * %clicked% Percentage clicked on link
+  - %clicked%	Percentage Clicked On Link
-  * %domains% Domain(s) Used In Scenarios Settings
+  - %clicked.count%	Number Of Emails Clicked
-  * %timezone% Timezone Setting Of LUCY
+  - %sent.count%	Number Of Emails Sent
-  * %recipients.groups% Recipient Group Names In Campaign
+  - %reported%	Percentage Of Users Reported
-  * %awareness.name% Name Of Awareness Template Used
+  - %success%	Percentage Of Emails Submitted Data
-  * %awareness.sent% Number Of Awareness Emails Sent
+  - %success.count%	Number of Emails Submitted Data
-  * %awareness.incomplete% Number Of Users With Incomplete Training
+  - %domains%	Domain(s) Used In Scenario Settings
-  * %awareness.completed% Number Of Users Who Completed Training
+  - %timezone%	Timezone Setting Of LUCY
-  * %questions.number% Number Of Questions In Quiz
+  - %recipients.groups%	Recipient Group Names In Campaign
-  * %data.number% Absolute Number & Relative Number Of Collected Data From Users
+  - %awareness.names%	Name Of Awareness Template Used
-  * %logo% Logo
+  - %awareness.sent%	Number Of Awareness Emails Sent
-  * %table.contents% Table Of Contents
+  - %awareness.opened%	Number Of Awareness Emails Opened
-  * %system.info% System Information
+  - %awareness.incomplete%	Number Of Users With Incomplete Training
-  * %file.settings% File Based Attacks: Settings Table
+  - %awareness.completed%	Number Of Users Who Completed Training
-  * %scenarios.settings% Scenarios Settings
+  - %questions.number%	Number Of Questions In Quiz
-  * %message.settings% Message Template Settings
+  - %data.number%	Absolute Number & Relative Number Of Collected Data From Users
-  * %schedulers% Scheduler Settings
+  - %out.of.office%	Percentage 'Out Of Office' Responses
-  * %awareness.settings% Awareness Website Settings
+  - %bounced%	Percentage Bounced Messages
-  * %data% Reports the file attack output & form POST data
+  - %responded%	Percentage Responded Recipients
-  * %additional.fields% List Of Available Recipient Fields
+  - %recipient.count%	Number of recipients
-  * %victim.table% Detailed Victim Results
+  - %incident.count.campaign%	Number of incident reports in campaign
-  * %quiz% Quiz Questions
+  - %incident.count.campaignrelated%	Number of all campaign-related reports in total
-  * %analyse.stats% Analyse Statistics
+  - %incident.count.notcampaignrelated%	Number of all reports not related to campaigns
-  * %benchmark.stats% Benchmark Statistics
+  - %incident.count.total%	Number of incident reports total
-  * %compare.stats% Campaign Comparison Statistics
+  - %logo%	Logo
-  * %charts% All Charts
+  - %table.contents%	Table Of Contents
-  * %charts.summary% Summary Chart
+  - %system.info%	System Information
-  * %charts.totalstats% Total Stats Chart
+  - %file.settings%	File Based Attacks: Settings Table
-  * %charts.analyse% Analyse Stats Chart
+  - %scenarios.settings%	Scenarios Settings
-  * %charts.dailystats% Daily Stats Chart
+  - %scenarios.filebased.settings%	Filebased Scenarios Settings
-  * %charts.hourlystats% Hourly Stats Chart
+  - %message.settings%	Message Template Settings
-  * %charts.events% Events Chart
+  - %schedulers%	Scheduler Settings
-  * %charts.os% Operating System Chart
+  - %awareness.settings%	Awareness Website Settings
-  * %charts.browsers% Browsers Chart
+  - %data%	Reports the file attack output & forms POST data
-  * %charts.files% Files Chart
+  - %additional.fields%	List Of Available Recipient Fields
-  * %charts.plugins% Plugins Chart
+  - %victim.table%	Detailed Victim Results
-  * %charts.countries% Countries Chart
+  - %victim.table.opened%	The list of victims who opened the email
-  * %charts.awareness% Awareness Stats Chart
+  - %victim.emails%	Table of recipient email addresses
-  * %charts.additional% Additional Charts
+  - %victim.table.osbrowsers%	Browser and OS stats table
-  * %charts.custom% Custom Fields Charts
+  - %victim.table.trainingstats%	Table With Columns: "Email", "Trained", "Trained At", "Answers Count", "Correct Answers", "% Of Correct Answers"
-  * %charts.responses% Track Responses Chart
+  - %victim.table.successclickrate%	Table Columns: "Email", "Succeeded", "Succeeded At", "Success Rate", "Click Rate"
-  * %awareness.website% Awareness Website Screenshot
+  - %victim.table.mailstats%	Table Columns: "Email", "Email Opened", "Mail Submitted At", "Clicked", "Clicked At"
-  * %awareness.mail% Awareness Mail Template Screenshot
+  - %quiz%	Quiz Questions
-  * %message.screen% All Message Template Screenshots
+  - %analyse.stats%	Analyse Statistics
-  * %landing.screen% All Landing Page Screenshots
+  - %benchmark.stats%	Benchmark Statistics
-  * %message.screen#% Message Template Screenshot (# - replace on scenario id)
+  - %compare.stats%	Campaign Comparison Statistics
-  * %landing.screen#% Landing Page Screenshot (# - replace on scenario id)
+  - %trends.stats%	Trends Stats
+  - %timeline%	Campaign Timeline
+  - %scenarios.table.successaction%	Scenarios Success Action Table
+  - %charts%	All Charts
+  - %charts.summary%	Summary Chart
+  - %charts.totalstats%	Total Stats Chart
+  - %charts.analyse%	Analyse Stats Chart
+  - %charts.awarenesstime%	Awareness Time Chart
+  - %charts.scenariotime%	Scenario Time Chart
+  - %charts.scenariostats%	Scenario Stats Chart
+  - %charts.dailystats%	Daily Stats Chart
+  - %charts.hourlystats%	Hourly Stats Chart
+  - %charts.responses%	Responses Detection 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.clickstats%	Click in First 8 Hours Chart
+  - %charts.awarenessclicks%	Awareness Website Clicks Chart
+  - %charts.additional%	Additional Charts
+  - %charts.custom%	Custom Fields Charts
+  - %charts.stafftype%	Staff Types Chart
+  - %charts.location%	Locations Chart
+  - %charts.division%	Divisions Chart
+  - %charts.comment%	Comments Chart
+  - %charts.reports%	Percentage reported/not-reported Chart
+  - %charts.reportdynamics%	Reports Dynamics Over Time
+  - %charts.quizquestions%	Awareness Quiz Questions Chart
+  - %charts.quizscores%	Awareness Quiz Scores Chart
+  - %charts.quiztimes%	Awareness Quiz Times Chart
+  - %domains.table%	Domain list (table with columns: "Domain", "Associated scenario")
+  - %users.table%	Campaign responsible users (table with columns: "User", "User type")
+  - %recipient.group.table%	Recipient groups (table with columns: "Group", "Number of users in this group")
+  - %recipient.group.extendedtable%	Recipient group to scenario association (table with columns: "Name", "Scenario", "Mapping", "Recipients")
+  - %recipient.group.customfields.table%	Recipient settings (table with columns: “Group Name“, “Fields”, “Values”)
+  - %campaign.scenarios.table%	Table of scenarios for the campaign (table with columns: "Scenario Name", "Scenario Type")
+  - %awareness.website%	All Awareness Website Screenshots
+  - %awareness.website.table%	All Awareness Website Screenshots Table
+  - %awareness.mail%	All Awareness Email Template Screenshots
+  - %message.screen%	All Message Template Screenshots
+  - %landing.screen%	All Landing Page Screenshots
+  - %landing.screen.table%	All Landing Page Screenshots Table
+  - %message.screen#%	Message Template Screenshot (# - replace to scenario sequence number)
+  - %landing.screen#%	Landing Page Screenshot (# - replace to scenario sequence number)
+  - %summary%	Summary report across all campaigns for the current client
+  - %summary.[type]%	Summary report across all campaigns by scenario type ([type] - scenario type, example: %summary.file%). List of available scenario types:%summary.file% - File-Based
+  - %summary.mixed% - Mixed
+  - %summary.malware_test% - Technical Malware Test
+  - %summary.hyperlink% - Hyperlink
+  - %summary.data% - Web Based
+  - %summary.awareness% - Awareness Only
+  - %summary.usb_attack% - Portable Media Attack
+  - %summary.mail_web_test% - Mail & Web Test
+  - %summary.[period]%	Summary report across all campaigns by time ([period] - time period in years or months, example: %summary.2016-2017% or %summary.11.17-12.17%)
+  - %worst.employees.[limit]%	Worst employees ([limit] - number of entries to show, example: %worst.employees.10%)
+  - %worst.division.[limit]%	Worst divisions ([limit] - number of entries to show, example: %worst.division.10%)
+  - %worst.location.[limit]%	Worst locations ([limit] - number of entries to show, example: %worst.location.10%)
+  - %worst.staff_type.[limit]%	Worst staff types ([limit] - number of entries to show, example: %worst.staff_type.10%)
+  - %worst.comment.[limit]%	Worst comments ([limit] - number of entries to show, example: %worst.comment.10%)
 You can see the result of using each of the above variables [[examplesofvariables|here]].