​
Overview

Ocular is built for flexibility and extensibility which gives developers to choose how to implement the logic of their Search platform.

Application connectors allow developers to index documents from external SAAS providers into Ocular.

For example if you want to index data from GoogleDocs, Slack or an Internal Datastore then you can just install an Application Connector into Ocular.

Connectors run in the same backend process as the core application thus share the same infrastructure, capacity and maintaince. Connectors also have access to services and database within Ocular via a dependency container.

​
Official Ocular Application Connectors

Ocular has official connectors that cover providers such as Google Drive, Gmail, Asana, Confluence etc. The current application connectors are listed in the next sections.

​
Installing Connectors

To install a connector in your backend, add the connector to the Ocular config file in your backend.

The following config files are currenlty supported

  • core-config-local.js - for running Ocular in Docker.
  • core-config-dev.js - for running Ocular in development mode.

Set the following in the core-config-xxx.js apps section.

core-config-xxx.js
apps: [
   //..
   {
      resolve: `app-name`,
      options: {
        // other configurations,
         ...,
        rate_limiter_opts: {
          requests: xxx, // Number of Requests
          interval: xxx, // Interval in Seconds
        },
      },
    },
]

rate-limiter_opts are used to define the request rate limiting for the respective application connector api’s.

​
Connector Configurations

For official Ocular connectors in the Ocular repository, you can find in the README.md a list of configurations. You can also check the official Ocular documentation below.

Slack BotDevelopment