Difference between revisions of "CanIt User Essentials"

From Roaring Penguin
Jump to: navigation, search
(E-Mail Footers)
(Web User Interface)
 
(6 intermediate revisions by 2 users not shown)
Line 8: Line 8:
 
=Inbox Interface=
 
=Inbox Interface=
  
Depending on how your administrator has things configured you may see CanIt at work inside your inbox in a number of different ways. The behaviour of any links pressed within CanIt e-mail content is dependent upon your e-mail reader, but generally it will open up a browser page that you can either quickly dismiss, or dismiss after having entered your credentials.
+
Depending on how your administrator has things configured you may see CanIt at work inside your inbox in a number of different ways.  
 +
 
 +
==URL Proxying==
 +
 
 +
You may find that when you click certain links within emails that it will instead direct you to the CanIt WebUI. This is CanIt's URL Proxy feature at work. This is meant to give you a second chance to review what it is that you actually clicked on before proceeding by showing you the actual URL, which many have nothing to do with where the link said it was going, and the geographical location of the web server.  
  
 
==E-Mail Footers==
 
==E-Mail Footers==
  
Most of our users are set up with to have CanIt training links appended to the end of all of their messages. This has been added to allow you to easily optimize your filtering experience from your email client directly. The footer section provides links for you to vote on the quality of the message that you just read. You are given the choice to mark any email as Spam, Phishing/Fraud, or Non-Spam. Votes from all emails are accumulated to better identify the contents of future emails. Your administrator may also set the footers up to have an option to blacklist or whitelist the sender, but you should be careful with this as mentioned here:
+
Most CanIt users are set up with to have training links appended to the end of all of their inbound messages. These are added to allow you to easily train the system to work more effectively by alerting us to spam or phishing messages that may slip through. Given the generally low false-negative rate, many administrators will often disable these links.
  
''Scanning: [[How_Does_CanIt_Work%3F#Scanning]]''
+
For users of Hosted CanIt these links, as well as those in the next section do not require authentication to submit. A web browser page will likely be opened when you click them but this is not a behaviour that we can can control; it is a behaviour of your mail reader. You can quickly dismiss it. If you are using an on-premise version of the software, the default is to require authentication to submit a vote. If it asks you to log in, you will need to do so first, and dismiss the page after you get the acknowledgement of your action.
  
 
==CanIt Notifications==
 
==CanIt Notifications==
 +
 +
[https://www.roaringpenguin.com/wiki/images/inbox.png Sample Notification]
  
 
Besides noticing this change to your regular emails, you may also be set up to receive special notification emails at regular intervals giving you updates about your quarantine. Users who are set up to receive these rarely need to visit the WebUI. If you don't get these e-mails, it is possible that someone else is in charge of managing your quarantine or you are expected to do so from the the WebUI. If you receive these notifications, you will have the ability to see all of your pending messages at a glance and will be able to accept or reject them from within your email client.
 
Besides noticing this change to your regular emails, you may also be set up to receive special notification emails at regular intervals giving you updates about your quarantine. Users who are set up to receive these rarely need to visit the WebUI. If you don't get these e-mails, it is possible that someone else is in charge of managing your quarantine or you are expected to do so from the the WebUI. If you receive these notifications, you will have the ability to see all of your pending messages at a glance and will be able to accept or reject them from within your email client.
Line 22: Line 28:
 
==Tag-Only Mode==
 
==Tag-Only Mode==
  
It is not common, but some administrators choose to configure their spam filter to Tag-Only Mode. If you administrator has decided to do this, you will receive almost all messages that are addressed to you and any that trip the filter will simply have a 'Tag' added to their subject. An example of this would be:
+
It is not common, but some administrators choose to configure their spam filter to Tag-Only Mode. If you administrator has decided to do this, you will receive almost all messages that are addressed to you except those that fail an absolute rule or are above the discard threshold. Any messages that would normally be quarantines or rejected will instead simply have a 'Tag' added to their subject. An example of this would be:
  
 
Old Subject: Buy stuff now
 
Old Subject: Buy stuff now
  
New Subject: [SPAM *****] Buy stuff now
+
New Subject: [*****SPAM*****] Buy stuff now
 
 
The exception to this is that messages which score higher than the rejection threshold will still be automatically rejected and you will still not see them.
 
  
 
This also adds information to the headers (such as X-Spam-Flag: YES), so that your email client can be configured to deal with the messages directly. This will often be used to stream all tagged mail into the Junk folder or otherwise.
 
This also adds information to the headers (such as X-Spam-Flag: YES), so that your email client can be configured to deal with the messages directly. This will often be used to stream all tagged mail into the Junk folder or otherwise.
Line 34: Line 38:
 
=Web User Interface=
 
=Web User Interface=
  
The CanIt WebUI is an interface designed to house all that you need to view and manage your spam. It is not designed to be used as a mail reader and should not be treated as if it were. Instead it provides you easy access to only your pending messages and spam, with tools to allow for advanced analysis of these messages. As has been mentioned, you may or may not have access to some of the features mentioned below.
+
The CanIt WebUI is an interface designed to house all that you need to view and manage your spam. It is not designed to be used as a mail reader although this functionality is available through the Archived Mail tab allowing for business continuity in the event of your mail server becoming unavailable. Aside from archived content, the CanIt WebUI is intended to provide you easy access to only your pending messages and spam, with tools to allow for advanced analysis of these messages. As has been mentioned, you may or may not have access to some of the features mentioned below.
  
Before going into too much detail, it is best to point out that there is a link to online documentation in the top right corner of each page of the WebUI that will lead to the relevant section of the full User's Guide.
+
Before going into too much detail, it is best to point out that there is a link to online documentation in the top-right corner of each page of the WebUI that will lead to the relevant section of the full User's Guide.
  
 
==Logging In==
 
==Logging In==
  
The URL that you need to use to log in to can vary depending on the product that your organization uses and how they have it configured. You administrator can point you in the right direction if you don't know where this is, otherwise it is generally linked in some way in notification emails. If you don't have access to either, it is quite possible that your administrator doesn't want you managing your own spam.
+
The URL that you need to use to log in to can vary depending on the product that your organization uses and how they have it configured. Your administrator can point you in the right direction if you don't know where this is, otherwise there is generally a link to it at the bottom of the notification emails. If you don't have access to either, it is quite possible that your administrator doesn't want you managing your own spam.
  
When you do find your way to our WebUI you will be presented with a Login screen. The credentials used to log in can also vary depending on how your system is configured. It will most likely use either your full email address, or the email address chopped off before @ (user@example.com -> user), depending on the configuration. It should also use the password that you use to log in to your work computer and should update automatically when it does. That being said, it is possible that your administrator will have your setup configured otherwise. Please contact your administrator if you are having trouble logging in. They will know how your system is set up and can reset your password if necessary. Again, it is possible that he/she doesn't want you to have access to the WebUI.
+
When you do find your way to our WebUI you will be presented with a Login screen. The credentials used to log in can also vary depending on how your system is configured. It will most likely use either your full email address, your Windows network username @ your domain, or simply the username portion of either (CanIt-Pro only). It will likely also use the same password that you use either for your Windows network password, or the password that you use to log on to your email. That being said, it is possible that your administrator will have your setup configured otherwise. Please contact your administrator if you are having trouble logging in. They will know how your system is set up and can reset your password if necessary. Again, it is possible that he/she doesn't want you to have access to the WebUI.
  
 
==Layout==
 
==Layout==
  
After you log in you will find that you land on the home page of the WebUI. This experience is usually fairly standard for all of our users, but we do offer customization features to our customers, so your experience may vary.
+
After you log in you will find that you land on the home page of the WebUI. This experience is usually fairly standard for all of our users, but we do offer customized features and themes, so your experience may vary.
  
The WebUI is fairly simple in its layout but it has a large menu structure for accessing the many tool options available to you. These options can vary depending on what your administrator has allowed you to have control over, but this guide will just hit on the major functions that you should know about.
+
The WebUI generally consist of a fairly straight-forward main menu at the top with a secondary menu on the left-hand side or as a drop-down menu from the main menu (or both). That said, there can be a lot of options within these menus. If you are trying to figure out how to do something and don't know where to look, there is a Search Manuals box at the bottom which will provide results within the User's Guide to try to point you to the right place. This guide will not enumerate these options, but will mention some of them in context.
 
 
The basic layout consists of the user and stream information in the very top-right corner along the company banner, the major interface categories in a horizontal line just below that, the options available within the current category down the left and the main page contents to the right of that. This should be a fairly familiar layout but each has a few intricacies that you should know about.
 
  
 
===User/Stream Area===
 
===User/Stream Area===
  
The user/stream area gives you the ability to switch streams if there are others available to you by clicking on the 'Change Stream' button. It will also allow you to see where the rules for your stream are inherited from by clicking on the details button beside your current stream.
+
Along the header bar there should be a section that mentions who you are logged in as and what scope you are currently working in. This will be your User-ID and then "your organization:your stream". You may have been given access to additional streams from your account, in which case you will see a Change Stream button beside this that you can use to switch. It will also allow you to see where the rules for your stream are inherited from by clicking on the Details button beside your current stream.
  
 
For the most part, the only thing you will need this area for is to log out.
 
For the most part, the only thing you will need this area for is to log out.
  
===Category Selection===
+
===Main Menu===
  
 
The categories available to you can vary widely depending on the permissions that your administrator has given you. The ones that you need to be most concerned with as an end-user are:
 
The categories available to you can vary widely depending on the permissions that your administrator has given you. The ones that you need to be most concerned with as an end-user are:
  
<ul>
+
* Home - A simplified overview of your Pending Quarantine activity
<li>Home - A simplified overview of your Quarantine activity</li>
+
* Quarantine - Allows you to sort and search through Pending mail as well as mail that has already been judged as Spam or Non-Spam
<li>Quarantine - Allows you to sort and search through the Quarantine</li>
+
* Rules - May be available to set up new filtering Rules. Rule options are limited by default.
<li>Rules - May be available to set up new filtering Rules</li>
+
* Preferences - Aesthetic preferences for the WebUI as well as your spam score thresholds, notification settings, etc.
<li>Preferences - Mainly aesthetic preferences for the WebUI, as well as your spam score thresholds</li>
 
</ul>
 
  
===Page Selection===
+
:''Continue to: [[Common CanIt User Tasks]]''
  
You will start in Home, which doesn't have a page selection list of options on the left as the rest do. The available pages for a given category will vary as well depending on what your administrator has allowed, but in general their function should be fairly apparent from their names.
+
<div style="float:right; clear:both; margin-right:0.5em">[[Support Wiki | [Home]]]</div>
 
+
[[category:All]][[category:Quick Start Guide]]
In the next sections of the guide, when a page is specified it will be given in this format: Category Name->Page Name->Section Heading(if applicable)
 
 
 
On every page there is always a link in the top right corner, under the category bar, for the online documentation. These will lead you to the relevant section of the CanIt User's Guide which has much more detain on the what can be done on that page than is provided here. If you are unsure of anything, check here first and ask your administrator if things are still unclear.
 
 
 
On many pages, be sure to keep an eye out for a 'Submit Changes' button at the bottom of the page. On pages that have this button, you changes will not be applied if it is not pressed.
 
 
 
:''Continue to: [[Common CanIt User Tasks]]''
 

Latest revision as of 11:40, 18 April 2017

Main article: Quick Start Guide

Most end-users will interact with CanIt either through their email or with our Web User Interface (WebUI). Here are the basics of how you can expect to navigate CanIt.

Please Note

The options within this guide may or not apply to you, depending on your version of CanIt and how it has been set up by the e-mail administrator. If you can't find something as described but think that you need it, consult your administrator; there may be a reason that you don't have it

Inbox Interface

Depending on how your administrator has things configured you may see CanIt at work inside your inbox in a number of different ways.

URL Proxying

You may find that when you click certain links within emails that it will instead direct you to the CanIt WebUI. This is CanIt's URL Proxy feature at work. This is meant to give you a second chance to review what it is that you actually clicked on before proceeding by showing you the actual URL, which many have nothing to do with where the link said it was going, and the geographical location of the web server.

E-Mail Footers

Most CanIt users are set up with to have training links appended to the end of all of their inbound messages. These are added to allow you to easily train the system to work more effectively by alerting us to spam or phishing messages that may slip through. Given the generally low false-negative rate, many administrators will often disable these links.

For users of Hosted CanIt these links, as well as those in the next section do not require authentication to submit. A web browser page will likely be opened when you click them but this is not a behaviour that we can can control; it is a behaviour of your mail reader. You can quickly dismiss it. If you are using an on-premise version of the software, the default is to require authentication to submit a vote. If it asks you to log in, you will need to do so first, and dismiss the page after you get the acknowledgement of your action.

CanIt Notifications

Sample Notification

Besides noticing this change to your regular emails, you may also be set up to receive special notification emails at regular intervals giving you updates about your quarantine. Users who are set up to receive these rarely need to visit the WebUI. If you don't get these e-mails, it is possible that someone else is in charge of managing your quarantine or you are expected to do so from the the WebUI. If you receive these notifications, you will have the ability to see all of your pending messages at a glance and will be able to accept or reject them from within your email client.

Tag-Only Mode

It is not common, but some administrators choose to configure their spam filter to Tag-Only Mode. If you administrator has decided to do this, you will receive almost all messages that are addressed to you except those that fail an absolute rule or are above the discard threshold. Any messages that would normally be quarantines or rejected will instead simply have a 'Tag' added to their subject. An example of this would be:

Old Subject: Buy stuff now

New Subject: [*****SPAM*****] Buy stuff now

This also adds information to the headers (such as X-Spam-Flag: YES), so that your email client can be configured to deal with the messages directly. This will often be used to stream all tagged mail into the Junk folder or otherwise.

Web User Interface

The CanIt WebUI is an interface designed to house all that you need to view and manage your spam. It is not designed to be used as a mail reader although this functionality is available through the Archived Mail tab allowing for business continuity in the event of your mail server becoming unavailable. Aside from archived content, the CanIt WebUI is intended to provide you easy access to only your pending messages and spam, with tools to allow for advanced analysis of these messages. As has been mentioned, you may or may not have access to some of the features mentioned below.

Before going into too much detail, it is best to point out that there is a link to online documentation in the top-right corner of each page of the WebUI that will lead to the relevant section of the full User's Guide.

Logging In

The URL that you need to use to log in to can vary depending on the product that your organization uses and how they have it configured. Your administrator can point you in the right direction if you don't know where this is, otherwise there is generally a link to it at the bottom of the notification emails. If you don't have access to either, it is quite possible that your administrator doesn't want you managing your own spam.

When you do find your way to our WebUI you will be presented with a Login screen. The credentials used to log in can also vary depending on how your system is configured. It will most likely use either your full email address, your Windows network username @ your domain, or simply the username portion of either (CanIt-Pro only). It will likely also use the same password that you use either for your Windows network password, or the password that you use to log on to your email. That being said, it is possible that your administrator will have your setup configured otherwise. Please contact your administrator if you are having trouble logging in. They will know how your system is set up and can reset your password if necessary. Again, it is possible that he/she doesn't want you to have access to the WebUI.

Layout

After you log in you will find that you land on the home page of the WebUI. This experience is usually fairly standard for all of our users, but we do offer customized features and themes, so your experience may vary.

The WebUI generally consist of a fairly straight-forward main menu at the top with a secondary menu on the left-hand side or as a drop-down menu from the main menu (or both). That said, there can be a lot of options within these menus. If you are trying to figure out how to do something and don't know where to look, there is a Search Manuals box at the bottom which will provide results within the User's Guide to try to point you to the right place. This guide will not enumerate these options, but will mention some of them in context.

User/Stream Area

Along the header bar there should be a section that mentions who you are logged in as and what scope you are currently working in. This will be your User-ID and then "your organization:your stream". You may have been given access to additional streams from your account, in which case you will see a Change Stream button beside this that you can use to switch. It will also allow you to see where the rules for your stream are inherited from by clicking on the Details button beside your current stream.

For the most part, the only thing you will need this area for is to log out.

Main Menu

The categories available to you can vary widely depending on the permissions that your administrator has given you. The ones that you need to be most concerned with as an end-user are:

  • Home - A simplified overview of your Pending Quarantine activity
  • Quarantine - Allows you to sort and search through Pending mail as well as mail that has already been judged as Spam or Non-Spam
  • Rules - May be available to set up new filtering Rules. Rule options are limited by default.
  • Preferences - Aesthetic preferences for the WebUI as well as your spam score thresholds, notification settings, etc.
Continue to: Common CanIt User Tasks