Export Retrospective to Confluence
Prerequisites
Configure your Confluence Cloud integration if you haven't already.
Configuration
FireHydrant provides default templating, but you can optionally customize the content. The template fields support Template Variables.
- Parent Page: This refers to the main page that the new Confluence page will be created within. Leave empty to save at the top level in your Confluence workspace.
- Title Template: This is the name of the new Confluence page that will be created
- Body Template: This is the body of the page that we will create in Confluence. This field also accepts variables, so you can automatically include details such as when the incident started, the incident summary, severity, roles involved, etc.**
**Note:
The Runbook step supports Markdown and not Confluence Wiki markup syntax.
On the Conditions & scheduling tab, ensure settings are configured per your requirements. The default configuration is "When current Milestone == Retrospective Completed."
Remember that for this step to execute successfully, the step must run after the Retrospective has at least started. Valid conditions include:
- When the current milestone is Retrospective Started
- When the current milestone is Retrospective Completed
- Time since Retrospective Started/Completed
Note:
If using in a Private Incident/private runbook, you must uncheck "Execute Automatically." For security and safety reasons, FireHydrant does not allow these retrospective steps to execute automatically for Private incidents, and you must set the step to execute manually.
Runbook Execution
Upon completion of Retrospective, the export step may take a few minutes to execute in Confluence. Once the export is complete, a link to the exported document will attach to the incident, like so:
Note:
This step will only be able to execute once, even if included in multiple Runbooks. Subsequent executions after the first will fail.
Troubleshooting
Atlassian converting ADF to storage format error
The Atlassian Confluence API occasionally returns the following error when a Confluence runbook export is initiated:
This intermittent error has been reported on the Confluence developer forum. If this happens, retry the step by going to the incident page and then clicking on Runbooks > [Your Runbook], expanding the step, and then clicking "Retry step."
Updated 10 months ago