Home
Home
Support
Impressum
22.3 Release ►

    Main Navigation

    • Preparation
      • Connectors
      • Create an InSpire VM on Hyper-V
      • Initial Startup for G7 appliances
      • Setup InSpire G7 primary and Standby Appliances
    • Datasources
      • Configuration - Atlassian Confluence Connector
      • Configuration - Best Bets Connector
      • Configuration - Box Connector
      • Configuration - COYO Connector
      • Configuration - Data Integration Connector
      • Configuration - Documentum Connector
      • Configuration - Dropbox Connector
      • Configuration - Egnyte Connector
      • Configuration - GitHub Connector
      • Configuration - Google Drive Connector
      • Configuration - GSA Adapter Service
      • Configuration - HL7 Connector
      • Configuration - IBM Connections Connector
      • Configuration - IBM Lotus Connector
      • Configuration - Jira Connector
      • Configuration - JiveSoftware Jive Connector
      • Configuration - JVM Launcher Service
      • Configuration - LDAP Connector
      • Configuration - Microsoft Azure Principal Resolution Service
      • Configuration - Microsoft Dynamics CRM Connector
      • Configuration - Microsoft Exchange Connector
      • Configuration - Microsoft File Connector (Legacy)
      • Configuration - Microsoft File Connector
      • Configuration - Microsoft Graph Connector
      • Configuration - Microsoft Project Connector
      • Configuration - Microsoft SharePoint Connector
      • Configuration - Microsoft SharePoint Online Azure Principal Resolution Service
      • Configuration - Microsoft Stream Connector
      • Configuration - Microsoft Teams Connector
      • Configuration - Salesforce Connector
      • Configuration - SAP KMC Connector
      • Configuration - SemanticWeb Connector
      • Configuration - ServiceNow Connector
      • Configuration - SharePoint Online Connector
      • Configuration - Sitecore Connector
      • Configuration - Web Connector
      • Configuration - Yammer Connector
      • Configuration - Zoho Connector
      • Data Integration Guide with SQL Database by Example
      • Indexing user-specific properties (Documentum)
      • Installation & Configuration - Atlassian Confluence Sitemap Generator Add-On
      • Installation & Configuration - Caching Principal Resolution Service
      • Installation & Configuration - Jive Sitemap Generator
      • Installation & Configuration - Mindbreeze InSpire Insight Apps in Microsoft SharePoint On-Prem
      • Mindbreeze InSpire Insight Apps in Microsoft SharePoint Online
      • Mindbreeze Web Parts for Microsoft SharePoint
      • User Defined Properties (SharePoint 2013 Connector)
      • Whitepaper - Mindbreeze InSpire Insight Apps in Salesforce
    • Configuration
      • CAS_Authentication
      • Cognito JWT Authentication
      • Configuration - Alternative Search Suggestions and Automatic Search Expansion
      • Configuration - Back-End Credentials
      • Configuration - Chinese Tokenization Plugin (Jieba)
      • Configuration - CJK Tokenizer Plugin
      • Configuration - Collected Results
      • Configuration - CSV Metadata Mapping Item Transformation Service
      • Configuration - Entity Recognition
      • Configuration - Exporting Results
      • Configuration - External Query Service
      • Configuration - Filter Plugins
      • Configuration - GSA Late Binding Authentication
      • Configuration - Identity Conversion Service - Replacement Conversion
      • Configuration - InceptionImageFilter
      • Configuration - Index-Servlets
      • Configuration - Item Property Generator
      • Configuration - Japanese Language Tokenizer
      • Configuration - Kerberos Authentication
      • Configuration - Management Center Menu
      • Configuration - Metadata Enrichment
      • Configuration - Metadata Reference Builder Plugin
      • Configuration - Mindbreeze Proxy Environment (Remote Connector)
      • Configuration - Notifications
      • Configuration - Personalized Relevance
      • Configuration - Plugin Installation
      • Configuration - Principal Validation Plugin
      • Configuration - Profile
      • Configuration - QueryExpr Label Transformer Service
      • Configuration - Reporting Query Logs
      • Configuration - Reporting Query Performance Tests
      • Configuration - Request Header Session Authentication
      • Configuration - Shared Configuration (Windows)
      • Configuration - Vocabularies for Synonyms and Suggest
      • Configuration of Thumbnail Images
      • Cookie-Authentication
      • Documentation - Mindbreeze InSpire
      • I18n Item Transformation
      • Installation & Configuration - Outlook Add-In
      • Installation - GSA Base Configuration Package
      • Language detection - LanguageDetector Plugin
      • Mindbreeze Personalization
      • Mindbreeze Property Expression Language
      • Mindbreeze Query Expression Transformation
      • Non-Inverted Metadata Item Transformer
      • SAML-based Authentication
      • Trusted Peer Authentication for Mindbreeze InSpire
      • Using the InSpire Snapshot for Development in a CI_CD Scenario
      • Whitepaper - MMC_ Services
      • Whitepaper - SSO with Microsoft AAD or AD FS
      • Whitepaper - Text Classification Insight Services
    • Operations
      • app.telemetry Statistics Regarding Search Queries
      • Configuration - app.telemetry dashboards for usage analysis
      • Configuration Usage Analysis
      • Deletion of Hard Disks
      • Handbook - Backup & Restore
      • Handbook - Command Line Tools
      • Handbook - Distributed Operation (G7)
      • Handbook - Filemanager
      • Handbook - Indexing and Search Logs
      • Handbook - Updates and Downgrades
      • Index Operating Concepts
      • Inspire Diagnostics and Resource Monitoring
      • InSpire Support Documentation
      • Mindbreeze InSpire SFX Update
      • Provision of app.telemetry Information on G7 Appliances via SNMPv3
      • Restoring to As-Delivered Condition
    • User Manual
      • Browser Extension
      • Cheat Sheet
      • iOS App
      • Keyboard Operation
    • SDK
      • api.v2.alertstrigger Interface Description
      • api.v2.export Interface Description
      • api.v2.personalization Interface Description
      • api.v2.search Interface Description
      • api.v2.suggest Interface Description
      • api.v3.admin.SnapshotService Interface Description
      • Debugging (Eclipse)
      • Developing an API V2 search request response transformer
      • Developing Item Transformation and Post Filter Plugins with the Mindbreeze SDK
      • Development of Insight Apps
      • Embedding the Insight App Designer
      • Java API Interface Description
    • Release Notes
      • Release Notes 20.1 Release - Mindbreeze InSpire
      • Release Notes 20.2 Release - Mindbreeze InSpire
      • Release Notes 20.3 Release - Mindbreeze InSpire
      • Release Notes 20.4 Release - Mindbreeze InSpire
      • Release Notes 20.5 Release - Mindbreeze InSpire
      • Release Notes 21.1 Release - Mindbreeze InSpire
      • Release Notes 21.2 Release - Mindbreeze InSpire
      • Release Notes 21.3 Release - Mindbreeze InSpire
      • Release Notes 22.1 Release - Mindbreeze InSpire
      • Release Notes 22.2 Release - Mindbreeze InSpire
      • Release Notes 22.3 Release - Mindbreeze InSpire
    • Security
      • Known Vulnerablities
    • Product Information
      • Product Information - Mindbreeze InSpire - Standby
      • Product Information - Mindbreeze InSpire
    Home

    Path

    Sure, you can handle it. But should you?
    Let our experts manage the tech maintenance while you focus on your business.
    See Consulting Packages

    Atlassian Confluence Sitemap Generator Add-On

    Copyright ©

    Mindbreeze GmbH, A-4020 Linz, 2022.

    All rights reserved. All hardware and software names used are registered trade names and/or registered trademarks of the respective manufacturers.

    These documents are highly confidential. No rights to our software or our professional services, or results of our professional services, or other protected rights can be based on the handing over and presentation of these documents.

    Distribution, publication or duplication is not permitted.

    The term “user” is used in a gender-neutral sense throughout the document.

    IntroductionPermanent link for this heading

    The Mindbreeze Sitemap Generator add-on generates a sitemap of the Atlassian Confluence pages. The pages contained are restricted by rights of the user generating the sitemap. Additionally you can exclude pages using regular expressions.

    PreparationPermanent link for this heading

    The Remote API-Interface of Atlassian Confluence has to be enabled in order for the Mindbreeze Sitemap Generator add-on to work. Activate at: “Further Configuration > Remote API (XML-RPX & SOAP)”


    InstallationPermanent link for this heading

    Install the add-on using “Manage add-ons” and “Upload add-on”:

    Please refer to the Product Information for the latest supported version.

    Choose the file „confluence-5.6-mindbreeze-plugin-<version number>.jar“ in the Plugin folder of the Web Connector and submit using the “Upload” button:

    The add-on installation is finished:

    ConfigurationPermanent link for this heading

    Use the “Configure” button to change the settings of the Mindbreeze Sitemap Generator add-on:

    Sitemap Generating User

    Atlassian Confluence user, used to generate the sitemap. Default: admin

    Sitemap Downloader Group

    Only members of the given Atlassian Confluence group are allowed to download the sitemap. Default: confluence-users

    ACL Encryption Password

    A password used for encrypting the ACL elements. If this parameter is left empty, the ACL elements will not be encrypted.

    Confluence Base URL

    the base URL that should be used for generating the links in the sitemap.

    Sitemap Cache Directory

    A directory where the generated sitemap.xml is stored on the Atlassian Confluence Server.

    Disable Parent Reference Metadata for Pages

    If enabled, no reference metadata to the parent document is generated for Confluence pages. This reduces the number of database queries.

    Add Performance Metrics to Sitemap

    If enabled, the times required for sitemap generation tasks are entered as comments in the sitemap.

    ACL Exempt Group Name (ex. confluence-administrators)

    Group that has read-access to all Confluence Content regardless of the explicit rights.

    Custom Content Property Key Pattern

    With this option, custom content properties can be included in the sitemap. A regular expression is defined that matches the name of the custom content properties (without the prefix custprop_ ). Matching properties are included in the sitemap. Note: Custom Content Property values of type JSON Object, are flattened into one or more metadata. Furthermore, custom content properties are only supported for pages and not for attachments. Default value: not set. Example values: .* (includes all custom content properties) or myProp.* (includes all custom content properties that begin with myProp, e.g. myPropLikes). Note: This feature is only supported for Confluence Version 5.6+.

    Delta Sitemap Containing Last Modified Sites Minutes

    The delta sitemap contains all documents that have been changed in the last minutes. How many minutes this actually is can be configured with this option. If this option is not set, the delta sitemap will not contain any <url> elements.

    Generate REST URLs

    Instead of the normal Confluence Sitemap URLs, REST API URLs are generated which are set as document key in the Confluence crawler. This has the advantage, for example, that no temporary duplicates are created during a delta crawl run if the title of pages has been changed.

    If you enable this option, please also make sure that the option "Use Rest API for Page Content" is active in the Atlassian Confluence Crawler.

    Attention: If you have already indexed Confluence and want to enable or disable this option afterwards, you need an empty index before changing this option. This would otherwise lead to document duplicates, since the mes:key scheme changes in the process.

    REST URL Base Path

    If the REST API endpoint is not located directly on <your-confluence-url>/rest/api, the "REST URL Base Path" can be specified. For example, if it is located at <your-confluence-url>/mybasepath/rest/api, the "REST URL Base Path" value must be /mybasepath.

    Include Labels

    If active, label metadata ("labels") for sites, spaces and attachments are included in the sitemap.

    Generating & Retrieving the SitemapPermanent link for this heading

    Generating the sitemapPermanent link for this heading

    After a successful installation of the Atlassian Confludence Sitemap Generator Add-on, the sitemap can be generated with a scheduled job. To set up the sitemap generator job navigate to the Confluence Admin interface to the section “Scheduled Jobs”

    The sitemap generator job can be started automatically according to a given schedule. This schedule can be specified using standard cron expressions by clicking on the “Edit” action of the “scheduledjob.desc.mindbreezeGenerateSitemapJob”.

    The sitemap generator job can also be started manually by clicking on the “Run” action.

    Retrieving the sitemapPermanent link for this heading

    After the sitemap generator job has completed the sitemap is available using the following URL: <confluence_url>/plugins/servlet/sitemapservlet?jobbased=true.

    The Delta Sitemap is available at
    <Atlassian Confluence URL>/plugins/servlet/sitemapservlet?jobbased=true&delta=true

    Logfiles and TroubleshootingPermanent link for this heading

    You can configure the log-level for the Atlassian Confluence Sitemap Generator Add-On at “Administration -> Logging and Profiling”.

    Create a new Entry for the Class/Packet name: “com.mindbreeze.enterprisesearch.connectors” and select the log-level.

    The logfiles are available at the folloging path: <Confluence Home>/logs/atlassian-confluence.log

    Download PDF

    • Installation & Configuration - Atlassian Confluence Sitemap Generator Add-On

    Content

    • Introduction
    • Preparation
    • Installation
    • Configuration
    • Generating & Retrieving the Sitemap
    • Logfiles and Troubleshooting

    Download PDF

    • Installation & Configuration - Atlassian Confluence Sitemap Generator Add-On