Skip to content

User Manual

Jump to bottom
czz22 edited this page Feb 26, 2019 · 11 revisions

The Admin application is where the magic happens - here you can create, view, update, and delete records (experiments, their dependencies (such as email texts, email replies, tasks), participants and admin users).

You can log in via www.emtray.com/admin with your given credentials. The intended audience for the following are super users (users who have full permissions on the platform).

Setting up a User

The first step into creating a user is going to emtray.com/admin, and clicking on users (or simply going to https://www.emtray.com/admin/auth/user/ ). Everything should be straightforward from that point onwards:

             1. Choose a username
             2. Choose a password 
             3. Confirm the password 
             4. Save and continue to a different part of the app, or keep adding more users.

By default, the user created is not an admin. They won't be able to log in to the admin panel. To do that, you must change their user permissions.

Changing User Permissions

Perhaps you've created a user that doesn't have all the permissions you do and they should. Or perhaps the user has access to modify too many things, and that might be dangerous to your experiment. Don't worry, there's a simple way to fix those issues - Once a user is set up, return to Home › Authentication and Authorization › Users and click on the specific user. You will see there's a number of actions you can perform from this panel, namely:

  1. View Action History

You can view the main actions a user has performed by clicking History on the top right

  1. Change User Details

You can change user details such as their username and personal details.

  1. Change User Permissions
  • Active Status - keep active unless you know a user won't be on the platform.
  • Staff Status - if you tick this, the user will be able to log in through the admin panel.
  • Super User Status - the user will be able to do anything on the platform - they will have access to all experiments created and will have permission to modify any content.

You can also set specific permissions - say you want to give someone the ability to be an admin without them being a super user. You can do that by choosing specific permissions

Setting up an experiment

To set up an experiment, the experiment administrator needs to go through a number of steps:

  1. Login and open admin panel.

  2. Set up the experiment:

    2.1. Add demographics questions

    2.2. Add experiment emails.

     2.2.1. Sender, subject, body.
 2.2.2. Type of email (malicious/normal) 
 2.2.3. Select corresponding attachments 
 2.2.4. Select corresponding replies 
 2.2.5. Add email proprieties

    2.3. Add email replies

    2.4. Add tasks

    2.5. Complete experiment details

     2.5.1. Experiment title 
 2.5.2. Experiment description 
 2.5.3. Experiment introduction/participant briefing 
 2.5.4. Experiment afterword/participant debrief 
 2.5.5. Experiment length 
 2.5.6. Select demographics questions 
 2.5.7. Select experiment emails 
 2.5.8. Select attachment files

  3. Get experiment unique link.

1. Getting admin panel access

To get admin panel access contact an experiment administrator.

2. Setting up an experiment

2.1. Adding demographics questions:

There's two actions you can perform in the Demographics panel - add and remove questions.

  • To add demographics questions, go to Exercise > Demographics Infos>Add demographics info

There you will be asked to define the question type:

  • Number denotes a question that will require a numeric answer, such as "How old are you?".

  • String denotes a question that will require a text-based answer, such as "Where are you from?".

Ignore the Require filed at the moment, it's a feature that still needs to be implemented.

2.2. Adding experiment emails.

To add experiment emails, go to Home>Exercise>Exercise emails and click on Add Exercise Email tab. Here, you will need to populate each individual email shown in the experiment with the following data:

  • Subject

  • From address - the email address of the sender.

  • From name - name of the sender.

  • From profile img url - link to the email profile picture of the sender.

  • From role - role of the sender within the company they represent.

  • To address - email address of the recipient.

  • To name - name of the recipient.

  • To profile img url - link to the email profile picture of the recipient.

  • To role - role of the recipient.

  • Phish type - there's a dropdown menu with 3 types of phishing - regular, phishing and e-tray.

               Regular - normal email, not phishing email. 
           Phishing - phishing email.
           E-tray - ignore this option for the time being.

  • Content - this is the body of the email.

  • Attachments - if you wish to upload any attachments, click on the + button, enter the details and the attachment URL.

  • Replies - Select the replies you want to appear in this email, or create a new one by clicking the + button.

  • Belongs to - If the email is part of an email thread, then select the main email in that thread, otherwise select the email itself.

  • Sort order - Select the order number in the thread.

Now all that's left is configuring the time at which the email will be revealed throughout the experiment. To do so, go to Home>Exercise>Exercise Email Proprieties and proceed with the following steps:

            1. Click on the Add Exercise Email Proprieties button on the top right of the panel. 
            2. Select the relevant exercise (experiment) 
            3. Select the email subject 
            4. Add the time at which the email should appear in the experiment. 
               > This will be in seconds
               > For 400, the email will appear in the inbox at second 400.

FAQ

1. How do I send an experiment link to participants?

You need to copy the exercise id (found in Home> Exercise> Exercises) and add it on the emtray link. All experiment links will follow this particular structure: www.emtray.com/welcome/experiment_id .

This way, if the management task ID is c266f00c-e42a-blabla-460310c5aa34, the link to the management demo task is www.emtray.com/welcome/c266f00c-e42a-blabla-460310c5aa34.

2. How do I download experiment data?

In order to download the data, you'd need to go on this link and login with your credentials: https://www.emtray.com/api-auth/login/?next=/api/v1/

There, you need to click on the exercise-reports link, then click on exerciseReportsUrl link that corresponds to your exercise ID, and then click on the downloadCsvUrl link.

The .csv file should download in your browser. This file is unique per participant, so you would have to download all .csv's separately in order to have a full data set.

Clone this wiki locally