RFCs are a way for Atlassian to share what we’re working on with our valued developer community.
It’s a document for building shared understanding of a topic. It expresses a technical solution, but can also communicate how it should be built or even document standards. The most important aspect of an RFC is that a written specification facilitates feedback and drives consensus. It is not a tool for approving or committing to ideas, but more so a collaborative practice to shape an idea and to find serious flaws early.
Please respect our community guidelines: keep it welcoming and safe by commenting on the idea not the people (especially the author); keep it tidy by keeping on topic; empower the community by keeping comments constructive. Thanks!
We are planning to launch Confluence Databases to our customers. Currently a closed set of Early Access Program (EAP) customers are testing Databases and are receiving incremental updates. In one of the upcoming releases, we’ll be integrating Databases as a new content type within Confluence that will exist within the current navigation and creation structures, including the content tree. This update would impact API responses for some of our existing APIs, and we’re mindful of the potential effects on your apps. We deeply value our partnership with you and would like to invite you to validate these changes in a staging environment to assess any impact on your apps. Your collaboration and feedback are essential to us as we work together to deliver a seamless experience to our mutual customers.
- Publish : 30 August 2023
- Discuss : ~20 September 2023
- Resolve : ~6 October 2023
We were very excited to announce Databases coming to Confluence in a community post earlier this year. Databases are structured collections of information organized in tables, where advanced functionality makes it easy for you to change data and content as often as your work does.
Databases will exist as a native content type within Confluence, with functionality and behaviors similar to what pages have today. These include but are not limited to existing in the tree, being able to be created from the create button, and permissions.
In this post, we will provide important details about this upcoming change and what you need to know as an ecosystem developer.
In one of the upcoming releases, Databases will be added to Confluence’s current navigation structure. If you are familiar with the changes associated with the introduction of Whiteboards to Confluence, you’ll notice these changes are very similar ( previous post on Whiteboards RFC-10: Confluence Whiteboards ).
Here are the most relevant upcoming changes:
Databases in the Content Tree (currently known as Page Tree)
- The “Page” Tree will be renamed to “Content” Tree [Note: This change also came when Whiteboards were released to Beta]
- Databases will co-exist in the content tree with other content types such as Pages and Whiteboards, and they will be able to be parent nodes as well as child nodes
Content Actions (in the content tree) available for Databases
- Content actions including Rename, Get Link, Copy, Move Archive, and Delete will be available for Databases similarly to Pages
Databases can be created similarly to pages’ creation mechanism
Databases can be created both through the top navigation ‘Create’ button
Databases can be created through the “+” button next to Content in the sidebar.
- The Database permissions model would be similar to the pages model i.e.
- “Anyone can view and edit”
- “Anyone can view, some can edit”
- “Only specific people can view or edit”
- Databases will also inherit permissions from the parent in the content tree, if applicable.
These changes will affect a cohort of EAP customers who are currently testing Databases, and will eventually affect all users who opt-in to Beta at launch.
- EAP Release Timeline:
- The above changes will be released to some of our EAP customers beginning in late October or early November.
- Databases Beta Release:
- Once the Database Beta becomes available for all customers (exact timeline TBD but tentatively December onwards), Confluence site administrators will have the option to opt-in and enable Databases for their users.
- Along with Databases, the changes to the tree and create navigation will also change for those who opt-in to beta
- It’s important to note that customers who choose not to opt-in for the Database Beta will not see the above changes until Databases are officially released in General Availability (GA) later next year. [Note: The changes to the tree, will update prior GA of Databases when Whiteboards releases to GA early next year.]
With the upcoming changes, some of our APIs would be updated to include Database-related information in the response. Examples of such APIs are:
a. Endpoints that return children/descendants and ancestors for a Content that support the following expand parameters will be affected. E.g.
ancestors- will now return Databases in the response.
childTypes.all- this will not be impacted immediately but will include Databases in the future (when we GA)
b. Endpoints under Content - children and descendants will not be impacted immediately but we will include Databases in the response when we GA.
c. Content body expand will be empty for Databases
Apps that directly use content tree (fka page tree) in their functionality are at high risk. We would highly urge those app developers to proactively test when the changes are available through DCP in your test tenants.
As we prepare to go live with the upcoming changes for some of our Early Access Program (EAP) customers, we would like to seek your collaboration in validating and mitigating any potential impact that these changes may have on your applications.
- To facilitate this process, we will provide you with all required changes in your Developer Canary Program. This will allow you to thoroughly test your applications and report back any impact or issues that you may encounter.
- The timing for providing access is currently being finalized. We anticipate that it will be available in October. This post will be updated with additional details once we have the staging environment ready for testing.
If your application is impacted by the changes, we are looking forward to working together with you to resolve any issues before releasing the Database Beta to our shared customers.