LogoLogo
Enterprise GuideCommunity Edition GuideDeveloper Guide
  • Using The Polarity Developer Guide
  • Quick Start
    • What's New
    • Installing Integrations
    • Quick Start Guide
    • Learning Resources
  • Building an Integration
    • Directory Layout
    • package.json
    • Configuration File
    • Integration Main Module
      • startup
      • doLookup
        • Entity Objects
        • Result Objects
        • Error Objects
      • onDetails
      • onMessage
      • validateOptions
    • Customizing the Overlay Window
      • Templates
        • Conditionals
        • Displaying a List of Items
        • Display Object Properties
        • Built-in Helpers
        • Displaying Icons
      • Component File
        • Aliased Properties
        • Computed Properties
        • Event Hooks
      • CSS Styles
    • Vendor Javascript
      • Inserting Javascript into DOM
    • README Guide
    • Debugging Integrations
      • Web Inspector
      • Using Integration Logs
      • Testing Main Module
  • Recipes
    • Enabling User Actions
    • Throttling Lookups
    • Using Custom Entity Types
    • Custom Summary Tags
    • Creating a Tabbed Interface
    • Accessing Username of Requestor
Powered by GitBook
On this page
  • About this Guide‌
  • Other Available Guides‌
  • The Polarity Integration Framework

Using The Polarity Developer Guide

NextWhat's New

Last updated 3 years ago

About this Guide‌

This guide teaches you about how the Polarity integration framework works and gives you the tools to build your own custom integrations.

Other Available Guides‌

If this guide is not what you're looking for, we also have two other guides that may be helpful:‌

  1. ​ - Focuses on everything you need to know to install, configure, use, and customize Polarity Enterprise.

  2. - Focuses on everything you need to know to install, configure, use and customize Polarity Community Edition.

For a list of changes, deprecations, and new features please see the the page.

The Polarity Integration Framework

The Polarity Integration Framework gives you the tools to build your own custom integrations. Integrations can connect to existing data to increase your data awareness as well as interact with existing tools to streamline your workflows.

There are three steps to building an integration:

  1. Define the type of data you wish to recognize in a user's active application window.

  2. Choose what to do with the recognized data. Typically you will enrich or transform the recognized data to create relevant contextual intelligence.

  3. Decide how you want to display the contextual intelligence.

If this is your first time writing a Polarity integration we suggest starting with the which will walk you through creating your first integration.

The Polarity Enterprise Guide
​The Polarity Community Edition Guide
What's New
Quick Start Guide