LogoLogo
Enterprise GuideCommunity Edition GuideDeveloper Guide
  • Using The Polarity Enterprise Guide
  • Getting Started
    • How Polarity Works
    • Setting Up Polarity Enterprise Edition
      • Special Considerations for Setting Up Polarity on macOS
    • Frequently Asked Questions
  • WEB SEARCH
    • Polarity Web Search
    • Polarity Chrome Extension V1
  • Using Polarity Enterprise
    • Opening the Polarity Client
    • Recognition Modes
    • Overlay Window
    • Entities and Annotations
    • Channels
    • Integrations
    • Channel and Integration Permissions
    • Explore Page
    • Using Shortcut Keys
    • Report Issues
  • Polarity Settings
    • The Polarity Client Advanced Settings
  • Personal Account Administration
    • My Profile
  • Polarity Administrator Settings
    • Tasks
    • Team Management
    • Server Configuration
Powered by GitBook
On this page
  • Configuring Shortcut Keys
  • Recognition Settings
  • Filter entities within words
  • Name Transformations
  • Simultaneously run Stream and Highlight
  • Locate Entities
  • Language
  • Annotate Entities within Polarity Focus
  • Polarity Focus clipboard actions
  • Logging Settings
  • Logging Level
  • Sanitize data in log files
  • Pretty Print logs
  • Ignore Manager
  • Ignore Manager - Entities Tab
  • Ignore Manager - Windows Tab
  • Ignore Manager - Annotations Tab

Was this helpful?

  1. Polarity Settings

The Polarity Client Advanced Settings

PreviousReport IssuesNextMy Profile

Last updated 2 years ago

Was this helpful?

The Polarity Advanced Settings window now contains the client advanced settings. This window contains four tabs which will be discussed in this section.

The The PolarityX Advanced Settings - Client options are only available via the Polarity Client and cannot be accessed from the Web interface. Changes made here do not affect other users.

Configuring Shortcut Keys

  1. From the Polarity Overlay settings menu bar, click on Advanced Settings window.

  2. Click on the Shortcut Keys tab.

Here users can customize the three shortcut key bindings for applying annotations, running an on-demand search of their clipboard contents and toggling highlight mode on/off.

To customize your shortcut keys, click on Editthen select the input and type in the desired shortcut key combination.

All shortcut keys must start with a modifier key (Shift, control, command etc) and each binding can contain up to three keys.

If you decide to change the default key bindings, note that not starting with "CTRL+C" will prevent text from being copied to the clipboard.

For example, if you change the Annotation shortcut from Ctrl+c+c to Alt+c+c when the Annotation window opens up the entity will not be the text that you selected but will be whatever was last saved to your clipboard.

To reset key bindings to their factory default settings click on Revert to Default for the appropriate function.

Recognition Settings

  1. From the Polarity Configuration Window's menu bar, click on Window

  2. In the dropdown list that appears, click on AdvancedSettings.

  3. Click on the Recognitions tab .

Filter entities within words

When enabled, Polarity will attempt to not recognize entities that you specify within strings.

For example, if the word "two" is the entity, it will not be recognized or highlighted in the string "onetwothree" when this setting is enabled.

Name Transformations

When enabled, Polarity will recognize first and last name pairs as the same entity regardless of the order. For example, the entity "Joe Miller" will be recognized by Polarity even if it appears on your screen as "Miller, Joe".

Simultaneously run Stream and Highlight

When enabled, users will be able to have both the Stream and Highlight modes running at the same time.

Use of this setting results in additional load being placed on the CPU.

Locate Entities

Polarity makes use of an algorithm that helps to detect the location of entities displayed on your screen faster when Highlight mode is turned on.

Whether this feature is on or off Polarity will always locate entities. However, when the feature is disabled less load will be placed on the CPU but you might experience recognition lag when using Highlight mode.

Language

English - Only English characters are recognized.

Russian - Both English and Cyrillic (Russian) characters are recognized.

Annotate Entities within Polarity Focus

Polarity Focus clipboard actions

  1. Copy Selected Image - Copies a snippet of the captured area to your clipboard as an image.

  2. Copy Selected Text - Copies all recognized text of the captured area to your clipboard.

  3. Copy none - No image or text is copied to your clipboard.

  4. Copy Selected Image & Text - Copies all recognized text and a snippet of the captured area to your clipboard as an image.

Logging Settings

Here users can adjust various event logging settings. To get to this page:

  1. From the Polarity Configuration Window's menu bar, click on Window

  2. In the dropdown list that appears, click on Advanced Settings.

  3. Click on the Logging tab.

Logging Level

There are six different logging levels to choose from:

  1. Trace Only - Logs detailed Trace events only

  2. Trace - Most verbose option. Logs high level Debug, Info, Warning and Error events in addition to Trace events.

  3. Debug - Logs high level Debug, Info, Warning and Error events

    only.

  4. Info - Logs Info, Warning and Error events only. (This is the default setting).

  5. Warning - Logs Warning and Error Events only

  6. Error - Logs Error Events only

Sanitize data in log files

Enable this option to redact username and email addresses info from logs.

Pretty Print logs

Enable this option to have log events split into separate lines and have the text details indented. If disabled, logs will be printed in a single, continuous block of text.

Ignore Manager

The Ignore Manager allows users to search for Entities, Windows and Annotations for Polarity to ignore or unignore. Searching can be done by typing in the desired string of text or by selecting items from the appropriate list.

You can navigate to the Ignore Manager through the Polarity Menu or the Task bar/Menu Bar depending on which OS you are running.

  • System Tray - You can navigate to the Ignore Manager by going to the system tray and right clicking on the Polarity icon, then selecting Advanced Settings

  • Polarity Menu - You can also navigate to the Window Manager by opening the main Polarity application and finding the File Menu bar at the top of the application. Click on the Window drop down and then select Advanced Settings.

  • Task Bar - You can navigate to the Ignore Manager by going to the Linux task bar in the top right and clicking on the Polarity icon, then selecting Advanced Settings

  • Polarity Menu - You can also navigate to the Window Manager by opening Polarity, then at the top of the Linux menu bar you will see the Polarity Menu. Click on where it says Window and then select Advanced Settings.

  • MacOS menu Bar - You can navigate to the Ignore Manager by going to the macOS menu bar in the top right and clicking on the Polarity icon, then selecting Advanced Settings

  • Polarity Menu - You can also navigate to the Window Manager by opening Polarity, then at the top of the application file menu you will see the Polarity Menu. Click on where it says Window and then select Advanced Settings.

Ignore Manager - Entities Tab

  1. From the Polarity Configuration Window's menu bar, click on Window

  2. In the dropdown list that appears, click on Ignore Manager

  3. You should now be on the Entities tab of the Ignore Manager

  4. Use the text filter to search or select the desired item(s) from the list

To unignore an entity:

  1. Navigate to the Entitiestab in the Ignore Manager

  2. Use the text filter to search the list of ignored items for the desired entity.

  3. Click on Unignore button of the entity you wish to remove.

Alternatively, you can select one or multiple items to unignore by clicking in the check boxes to the left of the item name and then clicking the Remove Selected button that appears.

Ignore Manager - Windows Tab

In this tab you can see all active windows that Polarity has recognized.

There are three ways in which windows can be ignored.

1) Ignore windows from a list of active system applications.

  1. From the Polarity Configuration Window's menu bar, click on Window

  2. In the dropdown list that appears, click on Advanced Settings

  3. You should now be on the Entities tab of the Ignore Manager, click on the Windows tab to the right of it.

  4. Use the text filter to search or select the desired item(s) from the "System active applications" list

2) Ignore windows from any application based on the window title.

  1. From the Polarity Configuration Window's menu bar, click on Window

  2. In the dropdown list that appears, click on Advanced Settings.

  3. You should now be on the Entities tab of the Ignore Manager, click on the Windows tab to the right of it.

  4. Click on the Add new ignore by title rule and enter the desired criteria

For example, if you ignore the window title "Chrome", Polarity will ignore the window "Google Chrome" as well.

3) Ignore windows from any application based on the application's name.

  1. From the Polarity Configuration Window's menu bar, click on Window

  2. In the dropdown list that appears, click on Advanced Settings

  3. You should now be on the Entities tab of the Ignore Manager, click on the Windows tab to the right of it.

  4. Click on the Add new ignore by application name rule and enter the desired criteria

For example, if you ignore the application name "Slack.exe", Polarity will ignore windows for all "Slack.exe" instances.

Ignore Manager - Annotations Tab

  1. From the Polarity Configuration Window's menu bar, click on Window

  2. In the dropdown list that appears, click on Ignore Manager

  3. Click on the Annotations tab of the Ignore Manager

  4. Use the text filter to add new annotations to ignore.

To unignore an annotation:

  1. Navigate to the Annotations tab in the Ignore Manager

  2. Use the text filter to search the list of ignored items for the desired annotation.

  3. Click on Unignore button of the annotation you wish to remove.

Alternatively, you can select one or multiple items to unignore by clicking in the check boxes to the left of the item name and then clicking the Remove Selected button that appears.

When enabled, running an on-demand search using will automatically open the annotation window and populate the "Entities" field with any entities that were recognized.

The following options apply to running an on-demand search using :

Both Entities and Annotations can also be ignored from the . Entities can also be ignored from the .

Overlay Window
Focus Mode
Focus Mode
Explorer page