Installation

At the moment, you can obtain the catWorkX Confluence REST API Extension add-on as JAR file only directly from catWorkX.

Content of this section:

Install Add-On

To install the catWorkX Confluence REST API Extension add-on, do the following on the Confluence server:

  1. Log into the Confluence server as administrator.
  2. From the Administration menu, select Add-ons.
  3. By default, you should see the "Manage Add-ons" dialog in the right frame. If not, search for Manage add-ons in the left frame and select it.
  4. Click Upload add-on.
  5. Select the add-on JAR file and click Upload.
  6. A message should appear that the installation was successful. Click Close to close the message window.
    The catWorkX Confluence REST API Extension should be listed at "User-installed add-ons" in the right frame.

Uninstall Add-On

To uninstall the catWorkX Confluence REST API Extension add-on, do the following on the Confluence server:

  1. Log into the Confluence server as administrator.
  2. From the Administration menu, select Add-ons.
  3. By default, you should see the "Manage Add-ons" dialog in the right frame. If not, search for Manage add-ons in the left frame and select it.
  4. By default the user-installed add-ons are listed in the right frame. The catWorkX Confluence REST API Extension should be listed.
  5. From the add-on list, select catWorkX Confluence REST API Extension.
  6. To uninstall the catWorkX Confluence REST API Extension add-on, select Uninstall.
  7. To confirm, click Uninstall add-on in the confirmation dialog.
  8. The add-on is removed and a confirmation should appear on the "User-installed add-ons" list.
  9. If you click the Reload button in your Web browser, the catWorkX Confluence REST API Extension add-on should be removed from the list of "User-installed add-ons".

Disable/Enable Add-On

Disable Add-On

To disable catWorkX Confluence REST API Extension, do the following on the Confluence server:

  1. Log into the Confluence server as administrator.
  2. From the Administration menu, select Add-ons.
    By default the user-installed add-ons are listed in the right frame. The catWorkX Confluence REST API Extension add-on should be listed.
  3. From the add-on list, select catWorkX Confluence REST API Extension.
  4. To disable the catWorkX JIRA Field Value Macro add-on, click Disable.
  5. To indicate that the add-on is disabled, the font of the catWorkX Confluence REST API Extension entry in add-on list changed from black to gray.
    An "Enable" button should appear.

Enable Add-On

To enable a disabled catWorkX Confluence REST API Extension add-on, do the following on the Confluence server:

  1. Log into the Confluence server as administrator.
  2. From the Administration menu, select Add-ons.
    By default the user-installed add-ons are listed in the right frame. The catWorkX Confluence REST API Extension add-on should be listed.
  3. From the add-on list, select catWorkX Confluence REST API Extension.
  4. To enable the catWorkX Confluence REST API Extension add-on, click Enable.
  5. To indicate that the add-on is enabled, the font of the catWorkX Confluence REST API Extension entry in add-on list changed from gray to black.
    An "Disable" button should appear.