Install the app
Oktul Work Item Macro for Confluence is an Atlassian Forge application for two products at once. It is installed in Confluence, where the macro lives, and connected to Jira on the same site, where the work items are. One installation covers both, and nothing runs outside Atlassian.
Cloud only. There is no Data Center or Server version.
Caution
The Marketplace listing is not live yet. These steps describe the installation flow submitted for Atlassian’s review. The labels will be checked against the listing before launch.
Requirements
- Confluence Cloud and Jira Cloud on the same site
- Site administrator or Atlassian app administrator permission
A cross-product Forge app cannot connect two sites. If Confluence and Jira are on different sites, the macro cannot read the work items.
Install it
- Open the Marketplace listing
One application gives both editions. Which one you have follows the subscription.
- Select Try it free, at the top right
Evaluation runs through Atlassian rather than through Oktul.
- Choose your site, then Install app
The app is installed in Confluence, its required product. Only a site or Atlassian app administrator can install. Anyone else sees Request app instead, which asks an administrator to approve. Forge applications take up to a minute to become available.
- Connect it to Jira
Atlassian offers the Jira connection during installation. Accept it there, or connect Jira later from the app’s entry in Atlassian administration. Without Jira the macro can be inserted, but it cannot load any work items.
Confirm it worked
Open a Confluence page and edit it. Type /oktul and choose
Oktul Work Item Macro for Confluence. The macro is inserted with a
Configure this macro message, and the pencil icon on it opens
Configure work item list.
The configuration loads the list of Jira fields. If that list appears, the app is installed in both products and can read Jira as you. See add the macro to a page.
If it did not work
| What you see | What it means |
|---|---|
| The macro is not in the insert menu | The app is not installed in Confluence on this site, or the installation has not finished. Check Apps, then Manage apps, in Confluence. |
| Could not load Jira fields when you open the configuration | The app is not connected to Jira, or Jira cannot be reached. Connect Jira to the app in Atlassian administration, then open the configuration again. Save stays disabled while the field list is missing, so a stored configuration is never overwritten. |
| App not installed in Jira or Cannot reach Jira on the page | The same cause, seen by a reader. The table comes back when Jira is connected, with no change to the page. |
| App license is not active on the page | The subscription has lapsed. See below. |
Licensing, and what happens when it lapses
Paid and licensed per installation through the Atlassian Marketplace, with a Standard and an Advanced edition. Advanced adds inline editing; everything else is in both.
With no active subscription, the macro loads nothing. It shows App license is not active and asks the reader to have a site administrator check the subscription in Atlassian administration, under Billing, or under Manage apps in Confluence. Exports carry the line “Work item list not included in this export: the app license is inactive.” in place of the table.
What a lapsed licence leaves alone
The configuration of every macro stays in its page. When the subscription is active again, every table comes back as it was, with nothing to set up.
A move from Advanced to Standard keeps the editing settings. They are stored with the macro and ignored until the edition is Advanced again.
Removing the app
Uninstalling the app from Confluence also removes it from Jira, because Confluence is its required product. The macros and their configuration stay in the pages, since Confluence stores them there, and the app keeps no other data. See privacy and data handling.
Related
A problem or a question? Write to support@oktul.com or open a request in the Help Center. Both reach the same service desk, so either way the request gets a reference and an SLA measuring the response.