Confluence Repositories
- Debesh Roy Chowdhury
In this section, the Syndeia Web Dashboard capabilities for Confluence repositories are presented.
Pre-Requisites
Check supported versions of Confluence here: Syndeia 3.5 - Integration Compatibility.
Tutorials
See the Confluence integration tutorial for Syndeia Web Dashboard - Part 21 - Confluence on Web Dashboard.
Add a Confluence Repository
(1) Click the Repositories icon in the LHS menu pane.
(2) Select Confluence in the list of Repository types on the LHS and click on the + icon to add a new Confluence repository, as shown below.
(3) Fill out the details for your Confluence server (repository), as shown below, and click the Create button.
URL - Base URL of your Confluence repository
Name - Name of the Confluence server. Provide a unique name to distinguish this Confluence repository from others you may add.
Description - Description of the Confluence repository
Authentication type - OAuth (default)
Username - Username to sign in to your Confluence repository. Enter the same username that you use on the Confluence web client.
Password - Password to sign in to your Confluence repository.
If you are using Confluence Server (installed on premise or virtual private cloud), enter the same password that you use on the Confluence web client.
If you are using Confluence Cloud (hosted by Atlassian), enter your API token to sign in. To create an API token, refer here - https://support.atlassian.com/atlassian-account/docs/manage-api-tokens-for-your-atlassian-account/.
Browse a Confluence Repository
(1) Expand the Confluence repository after it has been added.
(2) If your repository details are correct, Syndeia Cloud will try to sign in to the Confluence repository and display all Spaces (projects) that are accessible to you. For example, the following spaces are shown in the Confluence repository view below - Sandbox, Sydneia 3.0, Syndeia 3.1, Syndeia 3.2, Syndeia 3.3, and Syndeia 3.4.
(3) Expand a Space to view the page hierarchy in that Space. For example, in the Confluence repository view above, the Syndeia 3.4 Home page is shown directly under the Syndeia 3.4 Space, and it includes the following child pages - Syndeia 3.4 - New Features, Syndeia 3.4 Home, Syndeia Architecture, Syndeia Cloud Web-Dashboard, and Syndeia Cloud.
Search a Confluence Repository
Users can search Spaces and Pages in a Confluence repository. Click on the Search icon on the RHS to see the Search tab.
(1) Search Spaces
Select the Space option, as shown below.
Specify any text string contained in the title of the Spaces you are searching for.
Click the Search button. Results are shown on the RHS.
(2) Search Pages
Select the Page option, as shown below.
Select the Simple option to search for Pages by title, or the Advanced option to search for Pages using the Confluence Query Language (CQL)
Simple search
In the Title Contains field, specify any text string contained in the title of the pages you are searching for.
Click the Search button. Results will be shown on the RHS, as shown below.
Advanced search
Specify a CQL query to search for Pages. For example, the CQL query shown below will search for pages in the SYN34 space that were modified after 25-May-2021 and created by the current user (signed-in user).
type=page and space='SYN34' and lastModified > "2021/05/25" and creator=currentUser()For a complete reference on Confluence Query Language, refer here - https://developer.atlassian.com/server/confluence/advanced-searching-using-cql/
Click the Search button. Results will be shown on the RHS, as shown below.
Digital Thread Explorer
(1) See an overview of the Digital Thread Explorer - Digital Thread Explorer (DTE)
(2) See the tutorial for Confluence integration on Syndeia Web Dashboard - Part 21 - Confluence on Web Dashboard.
The Digital Thread Explorer will display the Page hierarchy in a Confluence repository using the Contains relationship (intra-model).
Creating Relations
(1) See an overview of the Creating Relations - Creating Relations on the Web Dashboard
(2) See the tutorial for Confluence integration on Syndeia Web Dashboard - Part 21 - Confluence on Web Dashboard.