Usage

To use Teamworkx Configuration Exporter for Jira follow these steps as system administrator:

  1. Select Apps form the "Adminstration" menu.
  2. Select Export Configuration from the "Configuration Export" section in the left side bar.

    The "Configuration Export" page appears.
  3. Note the 

    Detected and enabled Config IO Helpers

    In the picture above both the

    • catworkx Agile config exporter for Jira
    • catworkx JSM config exporter for Jira

    are ENABLED and will generate additional export files during the Configuration Export. This will not apply to the Backup

    For details regarding this framework and the integration, please see catworkx Configuration Import Export Helper for Jira.

  4. You now have the following options:
    1. Export only the configuration
      1. Enter or keep the suggested filename in the input field directly above
      2. Click on START CONFIGURATION EXPORT
      3. Once the export is done a success message, see below, will be shown on top
    2. Backup the system (not available in 8.0.x.x)
      1. Enter or keep the suggested filename in the input field directly above
      2. Click on START FULL BACKUP
      3. Once the export is done a success message, see below, will be shown on top
    3. Backup the system but anonymize the issue data during the process(not available in 8.0.x.x)
      1. Enter or keep the suggested filename in the input field directly above
      2. Check the box "Anonymize"
      3. Click on START FULL BACKUP
      4. Once the export is done a success message, see below, will be shown on top
    4. Export both, the configuration and the backup
      1. Enter or keep the suggested filename in the first input field (configuration export)
      2. Enter or keep the suggested filename in the second input field (backup)
      3. (info) You may also check the box "Anonymize" if you want the backup to be anonymized
      4. Click on START CONFIGURATION EXPORT AND START FULL BACKUP AFTERWARDS
      5. Once the export is done a success message, see below, will be shown on top. This will be done for both files individually.
    5. Switch to the standard backup page
      1. Click on GO TO BACKUP PAGE
      2. A new tab or window opens
      3. The auto generated filename suggestion will be filled in that form automatically.
    6. Filter the export folder
      1. Enter a timestamp in Jira format (yyyy-MMM-dd) into the input field "filter"
        • Please note the month abbreviation is language dependent. Your Jira system might spell the month differently from normal English spelling
      2. Changing the value in the input field will automatically be applied
    7. Download files from the export folder
      1. All ZIP Archive files, regardless what App generated them will be listed below.
      2. You can refresh the view by clicking the double circle arrow symbol on the top left of the table.
      3. Displayed are the filename, the full path in the popup, the modification date, the file size and an icon
        • If the icon shows a double circle arrow the file is still being written
        • If the icon shows an arrow point downward from the cloud the file may be downloaded by clicking here
  5. If the export was successful, you will get a success message.

    The file is stored in the <JIRA-HomeDirectory>/export/ directory under the filename you provided in the input fields.

Sometimes the export or backup takes longer than the normal timeout to generate.

You will be shown an error message relating to the timeout.

(info) Simply refresh the page or the table below.

(lightbulb) A notification message will tell you a backup or export is still running and the table will reflect the status as well. Albeit triggering a backup from the standard backup page will show the file here as well but not it's status.