/
Set up a "Calendar" control
Our documentation has moved!

Our documentation now lives on the Atlassian Support site at https://support.atlassian.com/analytics/resources/.

Set up a "Calendar" control

Owned by Cat Africa
Last updated: Apr 05, 2022
2 min read

“Calendar” controls let you filter your charts on a single date or a date range. Setting up a “Calendar” control requires two main steps:

  1. Create the “Calendar” control for your dashboard

  2. Connect the “Calendar” control to a chart

Create a “Calendar” control

To add a “Calendar” control to your dashboard:

  1. Open the dashboard where you want to add the “Calendar” control.

  2. Select Add control > Calendar from the dashboard sidebar. A pop-up will appear for you to select the control’s settings.

  3. Optionally, change the Name of the control.

  4. For Data type, select whether you want to filter your charts on a single date or date range.

  5. Edit the Default start and end dates using fixed dates, or use a combination of relative date variables and date and time functions for dynamic filtering.

  6. Optionally, select a Background color for your control.

  7. Select Add.

  8. Place the newly created “Calendar” control anywhere on your dashboard.

Connect a “Calendar” control to a chart

After you’ve created your “Calendar” control, you’ll need to connect it to a chart in order to start using it to filter. You can do this by using its corresponding dashboard variable in a Visual SQL query.

In a visual mode query

To connect a “Calendar” control to a chart using a visual mode query:

  1. Open the chart editor by creating a new chart or editing an existing chart on the dashboard.

  2. In the “Filters” section of your visual mode query:

    1. Add the date column you want the control to filter.

    2. Select the filter operator. Most people use between and including.

    3. Reference your control using its variable:

      • If the “Data type” of your control is “Date”, use {CALENDAR_NAME}

      • If the “Data type” of your control is “Date range”, use {CALENDAR_NAME.START} and {CALENDAR_NAME.END} for the start and end dates, respectively.

      • Replace CALENDAR_NAME with your control's name.

  3. Select Run query. The result table will update with the new filter applied to the data.

  4. Select Save to dashboard to save the chart.

Filter condition using 'Calendar' control named CALENDAR

In a SQL mode query

You can connect a “Calendar” control in your SQL query by referencing the control using its variable:

  • If the “Data type” of your “Calendar” control is “Date”, use {CALENDAR_NAME}.

  • If the “Data type” of your control is “Date range”, use {CALENDAR_NAME.START} and {CALENDAR_NAME.END} for the start and end dates, respectively.

Replace CALENDAR_NAME with your control's name.

Here’s an example of how someone might get the total number of Jira issues created between the selected dates of a “Calendar” control:

SELECT COUNT(DISTINCT "Jira Issue"."issue_id") AS "Count of distinct Issue Id" FROM "jira _issue" AS "Jira Issue" WHERE "Jira Issue"."created_at" BETWEEN {CALENDAR_NAME.START} AND {CALENDAR_NAME.END};

Related content