Document toolboxDocument toolbox

Subscriptions

This page describes how Projectrak subscriptions work. Since Projectrak 6.6.0, you'll be able to see an "envelope" icon, that upon selection will allow you to subscribe to a PQL query that you have used to filter through your Jira projects. 

Screenshot 2024-01-18 at 18.44.24.png

 

How to schedule a new subscription

As soon as you select the "envelope" icon, a new window will pop-up in order for you to start configuring your subscription.

Screenshot 2024-01-18 at 18.45.08.png

 

  • Subscription name: In the first place, you will be able to choose a name for your subscription in order to be able to recognize it as fast as possible in your email inbox, in the "Subscription Name" section.

  • Include all project fields: By default, you'll receive the information that you have chosen to see in the Project Navigator that is shown in your columns. In the next step, you would be able to decide whether you would like to Include all Project fields in your subscription or not. You can do so by checking the box. 

  • Highlight updated values since the last email notification: Please, also note that you'll be able to choose between receiving the changes that have been made since the last notification, with these updates highlighted in order for you to be able to see them at a glance, or not. 

  • Frequency: And finally, you'll be able to set up the frequency your subscription will be arriving at. You can configure it in 3 different ways: days per week, once a month, and advanced.

    • Days per week: When you select this configuration, you will be able to choose any day of the week, some of them, and even all of them, at one time during the day. For example, if you want your subscription to be delivered every Monday at 9:00 a.m. you'll just need to choose the following settings that you can see in the next screenshot. Also, keep in mind that the chosen configuration will be shown in the summary at the bottom of the screen. 

    • Once a month: This configuration will allow you to receive the subscription on a specific day of the month, every month, and at a specific time. For example, on the 15th of every month, at 9:00 a.m. The following screenshot will show you the actual configuration for this example and remember that the summary will show the configuration you just selected. 

    • Advanced: In this mode, you will be able to enter a cron expression which will be translated and sent at the moment that the cron specifies. The next screenshot shows that by entering a correctly formatted cron the summary will read it and show you the configuration you have just chosen. If you don't know how to configure a Cron expression, don't worry, we got you covered with this piece of documentation written by Atlassian. 

How to manage a new subscription

In order to keep your subscriptions up to date and have all the information about them at hand, we have created the "Projectrak subscriptions" page, which you can access through User profile > Projectrak subscriptions.

 

On this subscription management page, you are going to be able to see all the information regarding your subscriptions as in the subscription namethe query you are subscribed to, the frequency you chose for your subscription to arrive at, the date and time of the last notification you got and the date and time for when your next notification will arrive. Also, as you might want to unsubscribe at one point, we added the "delete subscription" functionality.

Final result in your inbox

Once everything's set up, it's just a matter of time until you receive the first notification of your subscription. Below you can find a screenshot that shows an example of a subscription to a query:

When there's a change in one of the Projects that you have subscribed to in the PQL, the next subscription notification will show the changes that have been made in the project fields, only if you have chosen the "Highlight updated values since the last email notification" option in the configuration screen.