Post-upgrade Steps for Zephyr SaaS/Cloud

Starting October 11, 2024 (Zephyr Enterprise 8.2), the Zephyr Enterprise documentation moved from its current location on Atlassian to a dedicated, standalone Zephyr Enterprise documentation page. Please see: https://support.smartbear.com/zephyr-enterprise/docs/en/zephyr-enterprise/zephyr-installation---upgrade-guides/upgrade-zephyr-enterprise/post-upgrade-steps-for-zephyr-saas-cloud.html

Post-upgrade recommendations

Step 1: After upgrading, we recommend users clear the browser cache when accessing the Zephyr application if they experience issues regarding cached pages.

Step 2: Log in as an Administrator and trigger the Full Reindexing manually.

Step 3: Update ZBot. You can download the ZBot installation file from Zephyr by clicking the username in the top-right corner and selecting the ‘Download ZBot’ option from the dropdown.

Step 4: Update the Jira configuration after the upgrade

  • Once the upgrade is successful, the Administrator will get the popup below when login into Zephyr. (If Jira is integrated before the upgrade)

99c4cc01-6d2f-42f5-9b6e-5213e8e9b2cd.png
  • Once the user navigates to the Jira Integration page → the Jira connections will be highlighted in RED, as shown in the screenshot below:

216e606d-5c6f-48e7-aad4-43eaf04fe612.png
  • Once all services are up and running → For Automatic webhook management →, click on the Update Webhook button from the Jira Integration page.

  • In Jira, the webhook URL will be updated as per the new webhook URL:

The new webhook URL would be something like:
Example:- https://webhook.yourzephyr.com/v1/jira/webhooks/callback

Step 5: For manual webhook management, copy the URL from the popup as shown in the screenshot below and go to Jira to create a webhook with the new URL. The below popup will appear when integrating a Zephyr project with a Jira project or In Jira Integration → click on the Edit icon under the Action column and save the Jira Integration again.

Step 6: Enable the Jira sync for the closed Release if needed

By default, the Jira sync is disabled for all Releases that have ended (closed). If a Jira
sync needs to be re-enabled, perform the following steps:

  1. Click on the image-20240320-115615.png button next to the Release on the left-hand side.

  2. Click on "Enable Sync".

Zephyr Recommends disabling the Jira sync If the Release is done to avoid unnecessary webhook calls coming to Zephyr.

 

Step 7: Run the Manual Jira Update to get the latest change

  • Users can manually sync the Jira Sync Requirement using the Manual Jira Update. This can be useful when a Jira sync has been re-enabled or a webhook callback that has not been updated to the latest changes.

  • On doing Manual Jira Update on Jira Sync Folder

    • It will bring the requirement that satisfies the JQL or Filter

    • It will remove the requirement if any requirement does not satisfy the JQL or Filter

    • It will Update the requirement if any changes are made to the Requirement.

  1. Click on the image-20240320-120135.png button next to the Jira sync folder on the left-hand side.

  2. Click on "Manual Jira Update".

 

You will get the pop-up to sync.

On Click on sync, it will bring the Job Progress.