View Project Issues

This task reports on all issues in a selected Jira project.

You can run this task interactively, from a schedule, or via an API call to PPA.

It requires access credentials for a Jira instance.

Playbook Files

# The task was built to work with these plugin versions.
plugins:
  jira: ~1
  ppa: ~5
  hashicorp_vault: ~5


steps:

  - name: Check if Interactive/Scheduled/API Triggered
    actions:

      - ppa.task.started_by_user:
        save: interactive


  - name: Establish Project if Headless
    when: not interactive
    actions:
      # If the task was started by a schedule or API call, look for the project name in the task payload.

      - ppa.task.get_payload_values:
          keys:
            - name: project_name
        save: payload

      - set:
          name: project_name
          value: "{{ payload.project_name }}"

      - ppa.ui.output_markdown:
          doc: >
            ### Project Overview Report


            This task was started by {{ "a __schedule__" if globals.task.trigger == "job" else "an __API__ call" }}.


            Using project __{{ project_name }}__ specified in the payload.


  - name: Introduction
    when: interactive
    actions:
      # If the task was triggered interactively, present the markdown intro & ask for an project ID.

      - ppa.ui.output_markdown:
          doc: >
            ### Project Overview Report


            This task finds all Issues associated with a Jira Project & displays them in a table.


            You will need to:


            - Provide a Project name

            - Choose whether to email the report

            - Supply an email address (if applicable)


      - ppa.ui.input_accept:
          text: Start


  - name: Get Jira Secrets
    actions:
      - hashicorp_vault.key_value.read_secret_keys:
          secret: jira
          keys:
            - name: host
            - name: user_name
            - name: api_key
              sensitive: true
          create_missing: true
        save: jira_secrets


  - name: Choose project
    when: interactive
    actions:

      - jira.projects.get_all:
        load:
          access_details: jira_secrets
        save: projects

      - eval:
          expression: >
            [project["key"] for project in projects]
        save: project_keys

      - ppa.ui.input_choice:
          text: Select a project
          element_id: select_project
        load:
          options: project_keys
        save: project_name


  - name: Find Issues for Project
    actions:

      - ppa.ui.output_progress:
          text: Finding Issues...
          percent: null
          element_id: finding_issues

      - jira.issues.get_all:
        load:
          project_name: project_name
          access_details: jira_secrets
        save: issues

      - count:
        load:
          item: issues
        save: issue_count

      - ppa.ui.output_progress:
          text: Found {{ issue_count }} Issues for Project
          percent: 100
          element_id: finding_issues


  - name: Exit if No Issues Found
    when: issue_count == 0
    actions:
      - ppa.ui.output_info:
          text: No Issues were found!

      - exit:
          exit_code: 0


  - name: Generate Report
    actions:
      # Create a 2d-array of each Issue so an HTML table can be generated from it.
      - eval:
          expression: >
            [
                [
                  issue["id"],
                  issue["issuetype"],
                  issue["priority"],
                  issue["status"],
                  issue["summary"],
                  issue["reporter"],
                  issue["assignee"]
                ]
                for issue in issues
            ]
        save: issue_rows

      - ppa_tools.generate.html_table:
          header:
            - ID
            - Issuetype
            - Priority
            - Status
            - Summary
            - Reporter
            - Assignee
        load:
          rows: issue_rows
        save: issues_table

      # Format the data into the report template configured at the bottom of the Playbook.
      - format_template:
          key_values:
            icon: "{{ globals.icons.ppa.full }}"
            project_name: "{{ project_name }}"
            issues_table: "{{ issues_table }}"
        load:
          template: report_template
        save: formatted_report

      - ppa.ui.output_table:
          text: Project Issues ({{ project_name }})
          header:
            - ID
            - Issuetype
            - Priority
            - Status
            - Summary
            - Reporter
            - Assignee
        load:
          rows: issue_rows

      - ppa.ui.input_confirm:
          text: Send email report?
          confirm: Yes
          cancel: No
        save: send_email_report
        when: interactive

      # Always send the report email if the task was started from a schedule or API call.
      - set:
          name: send_email_report
          value: true
        when: not interactive


  - name: Send Email Report
    when: send_email_report
    actions:

      - ppa.ui.input_email:
          text: Please supply an email address for reporting
        save: recipient
        when: interactive

      - set:
          name: recipient
        load:
          value: payload.email_address
        when: not interactive

      - ppa.events.send_email:
          subject: PPA - Project Issues Report
          reason: Sending Project Issues Report email
          recipients:
            - "{{ recipient }}"
        load:
          html: formatted_report
        rescue:
          - ppa.ui.output_error:
              text: Failed to send email report. SMTP is not configured in PPA.
            when: rescue.type == "EventNotConfigured"
          - exit:
              exit_code: 2
            when: rescue.type == "EventNotConfigured"
          - ppa.ui.output_error:
              text: Failed to send email report. Please view the logs for more information.
          - exit:
              exit_code: 3


# The email template is set below as a global variable.
set:
  report_template: >
    <html>
      <head>
          <p style="text-align:center;">
              {icon}
          </p>
          <br/>
      </head>
      <body>
          <p style="text-align: center; font-weight: bold; font-size: 20;">
            Project Issues Report
          </p>
          <p style="text-align:center; font-size: 19;">
            <strong>Project:</strong> {project_name}
          </p>
          <div style="margin: auto;">
            {issues_table}
          </div>
          <footer>
            <br/>
            <br/>
            <p style="text-align:center;font-weight:lighter;font-size:10;">
              Email generated and delivered by Osirium PPA.
            </p>
          </footer>
      </body>
    </html>

Running this Playbook

Click download playbook
Import the downloaded file via the Playbooks page on PPA
Build the playbook from the Edit & Build tab
Run the playbook from the Preview & Deploy tab

* Requires PPA v2.9.x or newer

Integrations

PPA User Interface & Events
Hashicorp Vault Key-Value engine
Atlassian Jira Projects & Issues

Required PPA Configuration

If you run start this task from a schedule or API call, the project overview report will be sent via email.

When started interactively the user will have the choice to email the report.

To email this report you must have SMTP configured in PPA.

Required Vault Details

Jira

Host
Username
API key

Vault Configuration Wizard

The first time you run a task built from this playbook, PPA will check the required Vault details exist.

If they don't exist, PPA will ask you to supply the details at the start of the task.

Below you can see a user providing details the first time they run an Active Directory task.

vault-config-wizard

Once the details are added to Vault, the task won't ask for them again.

If you don't know the required details, ask an administrator to run the task or configure Vault manually.

API/Schedule Payload

To run this task from a schedule or API call, you'll need to supply the project name in the task payload.

The payload should be in this format:

{"project_name": "project_name" }

What the Task Does

Interactive

When run interactively this task will:

Present a list of all Jira projects for the users to select
Find all project issues and display them in a table
Ask the user whether they would like to send a report summary email

Schedule/API

When started from a schedule or API call, this task will:

Find all project issues for the project name provided in the payload
Find all project issues and display them in a table
Send a report summary email to the default recipient in the PPA SMTP configuration

See our other playbooks

Get PPA for free!

Start automating your estate with a free 30 day trial today. No signup required!

Get PPA Express

Documentation

Installation Guide
See how easy it is to get started with our installation guide
Playbooks
View our task writing reference guide
Plugins
See how to integrate with different systems using our plugins reference guide.