Panel | ||
---|---|---|
| ||
|
the
In the "Connector" tab, specify the connection information to crawl the Confluence
Confluence url: URL to access the Confluence
site. The server URL where Confluence is installed, it should include the protocol (http or https), the server name or server IP and also the port number if needed (ex: http://myConfluenceSite:8090/).Domain Username Password
server in the form of: http://{servername}{:port}. In some Confluence installations you must add "/confluence" to the end of the server name – e.g http://wiki.local.search/confluence . The connector uses REST API to communicate with Confluence. To verify REST append /rest/api/space at the end of the URL. Test it in a browser.
Domain: Domain used to login to Confluence. If the domain is not required by the environment it is ignored.
Username: Username with admin privileges to access all Confluence content, this will be the user used to crawl the Confluence instance. i.e part of the confluence-admin group
Use login.action.form: Use login.action POST action to authenticate instead of using BASIC Authorization headers
Include attachments: Select to include attachments in the crawl
Include comments: Select to include comments in the crawl
Anonymous access allowed: Select to indicate anonymous access is allowed in the Confluence instance. If anonymous (or public) access is allowed on your Confluence instance, you can check the "Anonymous access allowed" checkbox. To see if anonymous access is allowed, please see access in your Confluence instance. This has its meaning when Aspire creates ACL's. Basically if Confluence space has anonymous access allowed Aspire will assign ACL "public" to it instead of other defined space permissions. But it does not work that way that all objects get automatically ACL “public” when anonymous access is allowed. Pages that have explicit restrictions should retain their ACL’s. Only pages that have inherited security from the space with anonymous access allowed would get ACL’s “public”.
Index containers: Select if containers (space, page, blog) are to be indexed. Clear to index attachments only.
Scan recursively: Select if subfolders are to be scanned
Scan excluded items: Select so that the scanner will scan sub items of container items excluded by a pattern (because it matches an exclude pattern or because it doesn't match an include pattern).
Use space key for spaces inclusion/exclusion list: If turned on all Space Inclusion/Exclusion lists should specify Space Keys. Otherwise Space Names should be used
Now that the content source is set up, the crawl can be initiated.
The status will show RUNNING while the crawl is going, and CRAWLED when it is finished.
If there are errors, you will get a clickable "Error" flag that will take you to a detailed error message page.
If you only want to process content updates from the Confluence (documents which are added, modified, or removed), then click on the "Incremental" button instead of the "Full" button. The Confluence connector will automatically identify only changes which have occurred since the last crawl.
If this is the first time that the connector has crawled, the action of the "Incremental" button depends on the exact method of change discovery. It may perform the same action as a "Full" crawl crawling everything, or it may not crawl anything. Thereafter, the Incremental button will only crawl updates.
Info |
---|
Statistics are reset for every crawl. |
Group expansion configuration is done on the "Advanced Connector Properties" of the Connector tab.
Aspire Confluence connector can receive incremental changes from Confluence plugin and Updates Listener in the form of JSON requests. If configured like that the normal Incremental crawl is no longer needed.
Here are examples of JSON requests for various types of updates:
Code Block | ||
---|---|---|
| ||
{ "contentSource": "Aspire_Confluence_Source", "documents": [ { "url": "http://10.89.26.110:8090/rest/api/space/NELA", "action": "update", "metadata": { "connectorSpecific": { "field": [ { "@name": "spaceKey", "$": "NELA" } ] } } } ] } |
Code Block | ||
---|---|---|
| ||
{ "contentSource": "Aspire_Confluence_Source", "documents": [ { "url": "http://10.89.26.110:8090/rest/api/content/8159239", "action": "update", "metadata": { "connectorSpecific": { "field": [ { "@name": "confluenceId", "$": "8159239" } ] } } } ] } |
Code Block | ||
---|---|---|
| ||
{ "contentSource": "Aspire_Confluence_Source", "documents": [ { "url": "http://10.89.26.110:8090/download/attachments/8159239/test.txt?version=1&modificationDate=1538982092437&api=v2", "action": "update", "metadata": { "connectorSpecific": { "field": [ { "@name": "confluenceId", <------ attachment Id "$": "10848196" }, { "@name": "parentType", <------- page or blogpost. The type of the item with "@name": "parentType",the attachment "$": "page" }, { "@name": "parentContainerId",": "parentContainerId", <------- Item id of page or blogpost with the attachment "$": "8159239" } ] } } } ] } |
Code Block | ||
---|---|---|
| ||
{ "contentSource": "Aspire_Confluence_Source", "documents": [ { "url": "http://10.89.26.110:8090/rest/api/content/3145758", "action": "update", "metadata": { "connectorSpecific": { "field": [ { "@name": "confluenceId", "$": "3145758" }} ] } } } ] } |
Code Block | ||
---|---|---|
| ||
{ "contentSource": "Aspire_Confluence_Source", "documents": [ ]{ } }"url": "http://10.89.26.110:8090/rest/api/content/38244815", } ] } | ||
Code Block | ||
| ||
{ "contentSource"action": "Aspire_Confluence_Sourcedelete", "documentsmetadata": [{ { "urldisplayUrl": "http://10.89.26.110:8090/restdisplay/apiNAT/content/3145752Pepotodelete", "action": "delete"} } ] } |