Overlay Window

Accessing the Polarity Overlay‌

The Polarity Overlay can be accessed through the system tray, or by clicking on the Polarity Community Edition icon on your desktop.

The System Tray or Menu Bar

Windows

The system tray is usually located at the bottom of your screen (near the clock).

1. Right click on the Polarity icon and

2. Select the Polarity Overlay menu item.

macOS

The macOS menu bar is usually located at the bottom of your screen.

1. Click on the Polarity icon

2. Select the Polarity Overlay menu item.

Linux

The menu bar appears at the top of the screen.

1. Click on the Polarity icon

2. Select the Polarity Overlay menu item

Polarity Overlay Layout‌

The Polarity Overlay contains a search bar that allows you to quickly search for entities against integrations you are subscribed to in Polarity. It is organized in a card format with the entities (what was recognized on your screen) in bold at the top of the card and contextual information on that entity below in a tag format. The contextual information displayed in an entity's card will be the same as the color that has been set for that particular integration.

You will only receive notifications integrations that you are currently subscribed to.‌

Each card within the Polarity Overlay is composed of two different sections. The first section is the Summary view, which consists of the entity and important summary information from each integration.‌

The second portion of the card is the Details view, which contains additional information from integrations that have returned data for a particular entity. You can open the details view by clicking on the card.‌

Details view‌

To see more information about an entity click anywhere in the Summary portion of the entity card.‌

Search Entities in Polarity‌

The Polarity Overlay contains a search bar that allows you to quickly search for entities across Polarity.

To run a search:

1. Click inside the search bar,

2. Enter the exact name of the entity that you wish to look up then hit enter on your keyboard or click the green search icon to the right of the text input field.‌

Using Quick Links

‌From within each entity card in the Polarity Overlay you can access Quick Links. Quick Links are dynamic URLs for linking to 3rd party websites, They can be applied to a specific entity type (e.g. a link could be displayed only for IPv4 addresses, or hashes).‌

Click on the more actions icon within the entity card and select the Quick Link you want to navigate to. Quick links will be opened in your default external browser.

Minimizing and Closing the Polarity Overlay‌

While minimized, the Polarity Overlay will continue to receive data but will not automatically bring itself to the front of your screen.

If you run an on-demand lookup the overlay window automatically reappears whether it was closed or minimized.‌

Configure Overlay‌

Within the Configure settings users can further customize Polarity by editing integration settings, Overlay Window preferences, and other settings.

Clicking on the Configure settings button will take you to the Subscriptions page. From here you can:

1. Configure integration settings and subscription status.

2. Access More Settings which allows you to navigate between Subscriptions, Preferences and viewing current configurations for Shortcut Keys.

3. Discover more integrations

4. Refer a friend to get them in on the free Polarity Community Edition action!

Subscriptions Page

Discover more integrations

Clicking on this link takes you to Polarity's external Integrations web page that displays all of the currently available integrations that Polarity has to offer.

Manage Integration Settings

In addition to managing Integration settings from the Web interface, users can also make these changes from the Overlay window by clicking on the green gear shaped icon to the right of the desired integration.

Manage Integration Colors

To do this:‌

1. Open the Polarity Overlay,

2. Click on Configure ,this pulls up the list of integrations with the colors that have been set.

3. Navigate to the integration you wish to change the color of and click on the button that is labeled with that integrations abbreviation.

4. Select color of choice.

Manage Integration Subscriptions

To do this:

1. Open the Polarity Overlay, click on Configure Overlay

2. Select Integrations.

3. Once there, click the ON/OFF toggle of the desired integration(s).

Manage Individual Integration Settings

To do this:

1. Open the Polarity Overlay, click on Configure.

2. Select Integrations.

3. Once there, click the green settings wheel of the desired integration(s).

See Managing Integration Settings for more info.

Preferences

The Polarity Overlay has various settings that can be configured by clicking on the gear shaped icon to the top right of the Polarity Overlay.‌

Export‌

Allows users to export all current overlay information into a CSV file.‌

Pin Polarity Overlay‌

If enabled, the Polarity Overlay will be present on your screen at all times. If disabled, the Overlay window will pop up whenever an entity is recognized then go away after a set period of time.

See Open Overlay Duration for more info on configuring how long the Overlay window remains open for.

Toggle this setting on and off using the ON/OFF button under the Pin Overlay Window setting.‌

Always on Top‌

The Polarity Overlay can sit on top of all the other windows on your screen ensuring that you are always aware of important context being delivered to you by Polarity. Toggle this setting on and off using the ON/OFF button under the Always on Top setting.‌

Overlay Opacity‌

In the Overlay Opacity setting card, drag the slider to your preferred opacity level. When dragging the bar in the setting you will see the opacity change in real-time. By default, the opacity is set to full.‌

Suppression Duration‌

Suppression is the amount of time that will pass before Polarity will notify you of an entity it has recently seen. Increasing this value will help reduce the total number of notifications. Decreasing this number will help ensure that notifications are most relevant to what is on your screen.‌

For example, if the suppression value is set for 30 seconds and you see the IP Address "127.0.0.1" on your screen and receive a notification, you will not receive another notification for this IP address until at least 30 seconds later.‌

To set the suppression time, bring up the Polarity Overlay and select Settings. From there navigate to Suppression Duration and input the amount of time suppression should be set at in seconds.‌

Overlay Open Duration‌

If the Polarity Overlay is not pinned, you can adjust how long it stays visible before hiding itself. Navigate to the Overlay Open Duration setting and input the amount of time (in seconds) that the window should stay open. This setting has no effect if the Polarity Overlay is "Pinned".‌

Pulse New Entity Data‌

Pulse the background color of entity cards when they contain new data. The minimum duration value is 1 second.

Shortcut Keys

Clicking this menu item only allows users to view currently configured Shortcut Key Settings.

Go here for info on configuring shortcut keys.

Advanced Settings

To access Advanced Settings :

1. Navigate to More Settings in the Overlay Window.

2. Click on either Preferences or Shortcut Keys in the dropdown menu that appears.

3. Click on the Advanced Settings button located at the bottom left of the page.

From this window, users can perform the following actions:

1. Configure, search for and subscribe to Integrations.

2. Access the current user's profile.