Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update confluence-onpremises-connector.md #328

Closed
wants to merge 1 commit into from
Closed

Update confluence-onpremises-connector.md #328

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 25 additions & 13 deletions MicrosoftSearch/confluence-onpremises-connector.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,19 @@ To connect to your Confluence site, use your site URL.

Select the connector agent from the drop-down list. The agent will securely send Confluence On-premises content into Microsoft Graph index.

### Step 3.4: Select authentication type
### Step 3.4: Install Confluence On-Prem Plugin

- Download the app from [Microsoft Graph Connectors Confluence On-prem Plugin | Atlassian Marketplace](https://marketplace.atlassian.com/apps/1234846?tab=overview&hosting=datacenter).
- Log in to your confluence system
- Click on settings icon -> Click on manage apps
![undefined (2)](https://github.com/user-attachments/assets/16a6a8f0-844e-49bd-9939-694d8741eaea)
- Click on upload app
- Choose the downloaded file and proceed
- Make a call to the URL: http://{BASE_URL}/rest/api/msplugin/1.0/healthcheck/version and check if it gives you the version. If yes, you are all set for crawling.
![undefined](https://github.com/user-attachments/assets/e1216fef-7c35-4e87-a1ad-4aef7062fd1a)
![undefined (1)](https://github.com/user-attachments/assets/58ba9e9e-e2c9-47e9-967d-401cd79a7c5d)

### Step 3.5: Select authentication type

You can choose either Basic Authentication or OAuth 1.0a (recommended) to authenticate to your Confluence site.

Expand All @@ -76,7 +88,7 @@ Enter a service account's username (usually email ID) and password to authentica

Generate a public/private key pair and create an application link in Confluence On-premises site so that the connector agent can access the instance. To learn more, see [step 1 in Atlassian developer documentation](https://developer.atlassian.com/server/jira/platform/oauth/#step-1--configure-jira) on how to configure OAuth 1.0a.

#### Step 3.4.1 Generate an RSA public/private key pair
#### Step 3.5.1 Generate an RSA public/private key pair

Run the following openssl commands in your on-premises machine terminal.

Expand All @@ -87,7 +99,7 @@ Create an X509 certificate |`openssl req -newkey rsa:1024 -x509 -key confluence_
Extract the private key (PKCS8 format) to the `confluence_privatekey.pcks8` file | `openssl pkcs8 -topk8 -nocrypt -in confluence_privatekey.pem -out confluence_privatekey.pcks8`
Extract the public key from the certificate to the `confluence_publickey.pem` file | `openssl x509 -pubkey -noout -in confluence_publickey.cer > confluence_publickey.pem`

#### Step 3.4.2 Create an application link
#### Step 3.5.2 Create an application link

1. In Confluence, navigate to **Administration** (cog icon) > **General configuration** > **Application Links** in the side pane.

Expand All @@ -109,11 +121,11 @@ Extract the public key from the certificate to the `confluence_publickey.pem` fi

:::image type="content" alt-text="Link Applications post creation" source="media/confluence-connector/confluence-onpremises-applications-link-2.png" lightbox="media/confluence-connector/confluence-onpremises-applications-link-2.png":::

#### Step 3.4.3 Enter consumer key and private key to sign in
#### Step 3.5.3 Enter consumer key and private key to sign in

In the connection creation configuration assistant in Microsoft 365 admin center, enter the **Consumer key** created during *Step 3.4.2* and **Private key** from `confluence_privatekey.pcks8` file in *Step 3.4.1*. Enable pop-up in the browser for Microsoft 365 admin center and select **Sign in**.

#### Step 3.4.4 Enter verification code to Finish Sign in
#### Step 3.5.4 Enter verification code to Finish Sign in

In the Confluence sign in screen, enter service account credentials. After successful sign-in, you'll get a verification code like the following screen.

Expand All @@ -135,14 +147,15 @@ The following steps provide guidance on how to register the app [Configure an in

## Step 4: Select properties

In this step, you can add or remove available properties from your Confluence data source. Microsoft 365 has already selected few properties by default.
In this step, you can add or remove properties from your confluence data source. M365 has already selected few properties by default.

With a Confluence Query Language (CQL) string, you can specify conditions for syncing pages. It's like a **Where** clause in a **SQL Select** statement. For example, you can choose to index only the pages that are modified in the last two years. To learn about creating your own query string, see [Advanced Searching using CQL](https://developer.atlassian.com/server/confluence/advanced-searching-using-cql/). By default, all pages will be indexed by the connector.
**Specify the spaces you want to index:** By default, the connector will index all spaces. However, you can choose to include or exclude specific spaces using the space filter option. Enter the list of space keys you wish to include or exclude, and you will see a preview of the results.
Space key: Each Confluence space has a **space key**, which is a short, unique identifier that forms part of the URL for that space. To get the space key please contact confluence admin

>[!TIP]
>You may use the CQL filter to index **content modified after a certain time** using, *lastModified >= "2018/12/31"*
>[!NOTE]
> * CQL is not supported for Confluence on-premises.
> * Conflunce On-prem indexes only current pages and not archived pages

Use the preview results button to verify the sample values of the selected properties and CQL string.

## Step 5: Manage search permissions

Expand All @@ -157,8 +170,7 @@ To identify which option is suitable for your organization:
1. Choose the **Microsoft Entra ID** option if the email ID of Confluence users is **same** as the UserPrincipalName (UPN) of users in Microsoft Entra ID.
2. Choose the **Non-AAD** option if the email ID of Confluence users is **different** from the UserPrincipalName (UPN) of users in Microsoft Entra ID.

>[!NOTE]
>
>[!NOTE]
> * If you choose Microsoft Entra ID as the type of identity source, the connector maps the Email IDs of users obtained from Confluence directly to UPN property from Microsoft Entra ID.
> * If you chose "Non-AAD" for the identity type see [Map your non-Azure AD Identities](map-non-aad.md) for instructions on mapping the identities. You can use this option to provide the mapping regular expression from Email ID to UPN.
> * Updates to users or groups governing access permissions are synced in full crawls only. Incremental crawls do not currently support processing of updates to permissions.
Expand Down Expand Up @@ -196,4 +208,4 @@ The confluence On-premises connector has the following known limitations in its
After publishing your connection, you can review the status under the **Data Sources** tab in the [admin center](https://admin.microsoft.com). To learn how to make updates and deletions, see [Manage your connector](manage-connector.md).
You can find troubleshooting steps for commonly seen issues [here](troubleshoot-confluence-onpremises-connector.md).

If you have any other issues or want to provide feedback, write to us [aka.ms/TalkToGraphConnectors](https://aka.ms/TalkToGraphConnectors).
If you have any other issues or want to provide feedback, write to us [aka.ms/TalkToGraphConnectors](https://aka.ms/TalkToGraphConnectors).