Connectors on

Atlassian Bitbucket Connector

Mon, 01 Jan 0001 00:00:00 +0000

The Atlassian Bitbucket connector indexes repositories, projects, pull requests, commits, and comments across your Bitbucket instance.

The connector supports Atlassian Bitbucket Cloud.

Installing the Bitbucket App Descriptor

In order to target your specific Atolio deployment, the Atlassian Bitbucket connector requires a private listing to be installed instead of the Atlassian marketplace version. This can be disabled again after the connect app is installed.

In your Bitbucket instance:

Under Settings -> Workplace settings, navigate to Installed apps under the APPS AND FEATURES section.
After clicking Enable development mode, click the link for Install app from URL.

Specify the URL provided by your Deployment Engineer. It will be similar to the following with your chosen DNS name:

https://relay.search.example.com/connectors/bitbucketcloud/default/install/atlassian-connect.json
Note: if you have multiple Bitbucket instances, please make sure to provide the correct instance name in the URL above (i.e. default in the example).

Once the Atolio Connect app has been installed, the configuration will be stored securely in your Atolio deployment. You can now disable the development mode as needed.

Atlassian Confluence Connector

Mon, 01 Jan 0001 00:00:00 +0000

The Atlassian Confluence connector indexes spaces, pages, and comments across your Confluence instance.

The connector supports Atlassian Confluence Cloud.

Installing the Confluence App Descriptor

In order to target your specific Atolio deployment, the Atlassian Confluence connector requires a private listing to be installed instead of the Atlassian marketplace version, as explained here. This can be disabled again after the connect app is installed.

To start, within your Confluence instance:

Navigate to the application management page by clicking Apps -> Manage your apps.
Click Settings at the bottom, then enable private listings and development mode before clicking Apply.

The Upload app link will now be enabled.

Specify the URL provided by your Deployment Engineer. It will be similar to the following with your chosen DNS name:

https://relay.search.example.com/connectors/confluencecloud/default/install/atlassian-connect.json
Note: if you have multiple Confluence instances, please make sure to provide the correct instance name in the URL above (i.e. default in the example).

Once the Atolio Connect app has been installed, the configuration will be stored securely in your Atolio deployment. You can now disable the development mode and private listings as needed.

Atlassian Connector for Jira & Confluence Data Center

Mon, 01 Jan 0001 00:00:00 +0000

The Atlassian Connector for Jira & Confluence Data Center indexes:

Projects, issues, comments, and attachments across your Jira instance.
Spaces, pages, blog posts, comments, and attachments across your Confluence instance.
Users and groups in Jira & Confluence for the purpose of understanding permissions.

The connectors authenticate to Jira and Confluence as a dedicated service user using a Personal Access Token (PAT). They run as part of your Atolio deployment — no plugin or app needs to be installed in Jira or Confluence.

Atlassian Jira Connector

Mon, 01 Jan 0001 00:00:00 +0000

The Atlassian Jira connector indexes projects, issues, and comments across your Jira instance.

The connector supports Atlassian Jira Cloud.

Installing the Jira App Descriptor

In order to target your specific Atolio deployment, the Atlassian Jira connector requires a private listing to be installed instead of the Atlassian marketplace version, as explained here. This can be disabled again after the connect app is installed.

To start, within your Jira instance:

Navigate to the application management page by clicking Apps -> Manage your apps.
Click Settings at the bottom, then enable private listings and development mode before clicking Apply.

The Upload app link will now be enabled.

Specify the URL provided by your Deployment Engineer. It will be similar to the following with your chosen DNS name:

https://relay.search.example.com/connectors/jiracloud/default/install/atlassian-connect.json
Note: if you have multiple Jira instances, please make sure to provide the correct instance name in the URL above (i.e. default in the example).

Once the Atolio Connect app has been installed, the configuration will be stored securely in your Atolio deployment. You can now disable the development mode and private listings as needed.

GitHub Connector

Mon, 01 Jan 0001 00:00:00 +0000

The GitHub connector enables the indexing of pull requests, commits, comments, and markdown in your GitHub repositories.

Create Access Token

To install the GitHub connector, use a GitHub account with admin access to the organization (requires read access to teams). Using this account, create a personal access token (currently Classic only) according to these instructions. You will need to ensure repo and user scopes are set (as shown below):

Note: for GitHub Enterprise Server installations, you would need to enable the site_admin scope too.

GitLab Connector

Mon, 01 Jan 0001 00:00:00 +0000

The GitLab connector enables indexing of merge requests, commits, and comments across your GitLab projects. Atolio supports GitLab Server (minimum version v16.5-ee) and GitLab Cloud.

Create Access Token

As an admin, perform the following steps:

Login as admin user
Go to https://gitlab.company.com/-/user_settings/personal_access_tokens
Click “Add New Token”
Give it a name and expiration date, set scope as read_api
Copy generated token

Setup Webhooks

If live indexing of GitLab content is desired, you will want to setup Webhooks. If you have GitLab Premium you can set up webhooks for groups. If you don’t have GitLab Premium, you need to set up a webhook for each project separately.

Keycloak Connector

Mon, 01 Jan 0001 00:00:00 +0000

The Keycloak connector reads the users in a realm so that Atolio can resolve each signed-in identity to an Atolio user. Every user is ingested under their Keycloak user ID, which is the same identifier Keycloak puts in the sub claim of an OIDC token. That match is what lets Atolio connect a login back to the right user.

Note: As part of Atolio Configuration, this connector should be selected as Identity Provider if it is used to resolve app-user mappings. Point it at the same realm your users authenticate against in Keycloak authentication.

Linear Connector

Mon, 01 Jan 0001 00:00:00 +0000

The Linear connector indexes teams, projects, issues, and comments across your Linear workspace.

Note: Atolio currently uses an API key for this connector, but will support a published Integration in a future release.

Create the Linear API key & Webhooks

As an administrator:

Navigate to Workspace Settings by selecting your tenant and choosing Preferences.
Under My Account, click on API.

To create an API key, complete the following steps: 3. Under Personal API keys, provide a Label in the text box, e.g. Atolio. 4. Click on Create new API key. 5. Copy the value of the key to securely share with your Deployment Engineer.

Notion Connector

Mon, 01 Jan 0001 00:00:00 +0000

The Notion connector indexes databases, pages, and comments across your Notion workspace.

Create the Notion integration

As an administrator, you can either follow the steps below or navigate directly to My Integrations:

Click on Settings & members.
Under Workspace, click on Connections.
Click the link for Develop or manage integrations.

Create a new Internal integration by following the steps below:

Choose the associated workspace and give it an appropriate name, e.g. Atolio.
(Optional) Use the Atolio logo here, if needed.
Under Secrets, copy the Internal Integration Secret to share with your Deployment Engineer.
Under Capabilities:

Only “Read content” and “Read comments” are necessary. The other permissions can be removed.
Ensure that “Read user information including email addresses” is enabled.
Click Save changes.

Once the integration has been created, provide the secret copied above to your Deployment Engineer for configuration in your Atolio deployment.

Okta Connector

Mon, 01 Jan 0001 00:00:00 +0000

The Okta connector provides identity mappings for each user based on the apps that they use.

Note: As part of Atolio Configuration, this connector should be selected as Identity Provider if it is used to resolve app-user mappings.

Service Account and Required Permissions

Okta API tokens inherit the permissions of the user that creates them, so we recommend creating a dedicated service account rather than using a personal admin account. The connector only performs read operations against Okta (users, groups, applications, application users, and the System Log).

Salesforce Connector

Mon, 01 Jan 0001 00:00:00 +0000

The Salesforce connector enables the indexing of Salesforce objects, such as Accounts and Opportunities, using the Salesforce REST API by creating an External Client App in your Salesforce instance.

Note: Salesforce’s External Client Apps (ECA) are the successor to the legacy Connected Apps and follow a least-privilege model with explicit permission grants.

Setup External Client App

Note: The setup assumes that you are using the lightning experience of Salesforce.

As a best practice, we recommend creating a new user account or identifying an existing user account to be used for integrations. This user will be granted access to the External Client App in a later step.

ServiceNow Connector

Mon, 01 Jan 0001 00:00:00 +0000

The ServiceNow connector will index:

IT Service Management (ITSM) tasks - such as incidents, service requests, problems - including work notes and comments.
Knowledge bases (KBs) and KB articles.

The ServiceNow connector supports all releases from ServiceNow San Diego to the latest.

Note: If you need support for additional modules (e.g. Security Operations) with fields that aren’t indexed in the base tasks, contact your Atolio support team.

Install ServiceNow Update Set

The Atolio ServiceNow plug-in is available as an update set (XML file). The update set will be provided by your Deployment Engineer (from the Atolio GitHub repository) or your Atolio support team. From ServiceNow documentation, follow the steps below to Commit an update set.

Slack Connector

Mon, 01 Jan 0001 00:00:00 +0000

The Slack connector indexes messages across public channels, private channels, and threads. It will only index messages where the Atolio bot has been invited.

Choose a Change Notification Mechanism

For Atolio to get notified of changes happening on Slack in real-time, there are 2 options: “HTTP mode”, and “socket mode”. A detailed comparison of these options is available here.

If having a webhook is not ideal for your organization, you can opt in for socket mode.

SolarWinds Service Desk Connector

Mon, 01 Jan 0001 00:00:00 +0000

SolarWinds Service Desk (SWSD) connector enables the indexing of Incidents, Service Catalog, Problems, Solutions, Releases and Changes on your SWSD instance.

Prerequisites

The following configuration should be set on your SWSD instance, by an admin user, before configuring the SWSD connector.

Create a new admin user:
- Go to Setup -> Users & Groups -> Users.
- Create a new user with a descriptive name, such as “Atolio Admin User”. Make sure the user is given “Admin” role.
- Activate the newly created user through the link sent via email.
- Altough you can use an existing admin user, creating a new user solely for the purpose of Atolio integration is a best practice.
Generate JWT:
- Login as “Atolio Admin User”.
- Go to Setup -> Users & Groups -> Users. From the user table, click on “Atolio Admin User” to open the details page.
- From the “Actions” menu, select “Generate JSON Web Token” item to generate an API token. Provide the token value to your Deployment Engineer.

Provide Configuration

Provide the following configuration to your Deployment Engineer:

Staffbase Connector

Mon, 01 Jan 0001 00:00:00 +0000

The Staffbase connector enables indexing of various resources from your Staffbase platform, including Users, Campaigns, Posts, and Comments. This integration allows you to search and access Staffbase content directly through Atolio.

Set Up Administrator API Key and Retrieve Base URL

To set up the Staffbase connector, you’ll need to create an API key with administrator privileges. Follow these steps:

Log in to your Staffbase account as an administrator.
Navigate to the Admin Panel:

Web Connector

Mon, 01 Jan 0001 00:00:00 +0000

The Web connector enables the indexing of HTML web pages.

Enable Access

The Web connector indexes unauthenticated web page content which can be accessed from your Atolio deployment.

First, determine where your website is hosted. The Web connector can crawl HTML content by either:

Navigating URLs from a configured baseURL.
Browsing an Amazon S3 bucket from a configured url.

In order to ensure that the content is accessible in your Atolio deployment, ensure that your Deployment Engineer is aware of the necessary network or AWS permissions as part of the infrastructure deployment.

Zendesk Connector

Mon, 01 Jan 0001 00:00:00 +0000

Zendesk connector enables the indexing of tickets, and help center articles.

Prerequisites

The following configuration should be set on your Zendesk instance, by the account owner or an admin user, before configuring the Zendesk connector.

Go to Zendesk admin panel
- https://{your-zendesk-subdomain}.zendesk.com/admin/apps-integrations/apis/zendesk-api/settings
Enable “API access”
- If you don’t see such an option, it means it’s already enabled.
Enable “Token access”
Create a new API token
- If you already have an API token other integrations, it’s still advised to create a new one for the Zendesk connector, and provide a descriptive name such as atolio-connector-token. Note the token value since you cannot retrieve it after its creation. The token will be used to configure the connector.
Create a new admin user
- If you already have an admin user for other integrations, it’s still advised to create a new admin user for the Zendesk connector, and provide a descriptive username such as atolio-connector-admin-user@<your-org-domain>. The username will be used to configure the connector.

After the configuration, your API settings page should look like the following:

Zulip Connector

Mon, 01 Jan 0001 00:00:00 +0000

The Zulip connector indexes content from your Zulip organization using Zulip API credentials.

Atolio recommends using a dedicated Zulip bot for this connector rather than a personal user account.

Create Zulip credentials

Create credentials for either:

a generic bot (recommended), or
a dedicated service user.

You can retrieve Zulip API credentials using Zulip’s API key documentation: https://zulip.com/api/api-keys.

When creating the account used by Atolio:

Use a dedicated bot or service account such as atolio-bot or atolio-export-bot.
Record the account email address.
Record the account API key.
Record your Zulip organization URL (for example, https://example.zulipchat.com).

Visibility and access

The Zulip connector can only index content visible to the configured bot or user: