Free cookie consent management tool by TermsFeed

Build Reports in Process HQ

On This Page

This page applies primarily to business users. It describes how to create and manage reports created in Process HQ.

About reports

Reports empower business users to independently explore and analyze business data. You can build reports from datasets and processes. You can customize reports with different visualizations, easy-to-configure filters, and useful interactive elements, then share them with colleagues and add them to dashboards.

When to use Process HQ reports

Reports in Process HQ are the best way to meet your organization's reporting needs. However, you should build reports in Appian Designer instead if you need to:

Developers can also create Process HQ reports in Appian Designer, then deploy them to environments to kickstart your reporting experience.

Prerequisites for building reports

Before you begin creating a report, make sure that:

Create a report

You can create reports using the datasets and processes available to you. System administrators can create a report from any dataset or process in the data catalog.

To create a report:

  1. Go to Process HQ and decide how you want to start building the report:

  2. Design, filter, and sort the report data.

  3. (Optional) Add interactive elements to the report.

  4. Click SAVE.

    By default, you are assigned Owner permissions to any report you create, and all other users are assigned No Access.

  5. (Optional) Share the report with your colleagues.
  6. (Optional) Add the report to a dashboard.
  7. (Optional) Partner with AI Copilot to discover new insights about reports created from datasets.

Create a report with AI Copilot

Appian AI Copilot can automatically generate a report for you based on your available datasets. You can chat with AI Copilot to adjust the report as much as you want. Then, create the report to make your own edits manually, save, and share the report.

Note:  AI Copilot can only generate reports from datasets. To create a report from a process, start from a process on the Data Catalog page.

To create a report with AI Copilot:

  1. In the AI Copilot chat on the Home page, ask AI Copilot for the report you'd like to see.

    For example, "Show me a report of orders by customer for the last month."

    Tip:  Click the Expand button to make the AI Copilot window larger, so your report preview is easier to see.

  2. Continue chatting with AI Copilot to refine your report. You can ask AI Copilot to add or remove fields, change the chart type, apply filters, and more.

  3. When you're ready to edit the report yourself, click CREATE REPORT.

    Scroll or drag to pan · ⌘+/⌘− to zoom · Esc to closeimages/dfi-ai-copilot.gif

  4. Edit the report data manually.

Create a report with the guided experience

If you're exploring less familiar data, you can take advantage of a guided experience to create a report from a dataset.

Note:  The guided experience can only create reports from datasets. To create a report from a process, start from a process on the Data Catalog page.

To create a report with a guided experience:

  1. Go to the Home page and click CREATE REPORT.

  2. Go to the Guided Experience tab.

  3. Pick and format report data using autocomplete suggestions. As you select different options, you'll see a real-time preview of the report.

  4. When you're ready, click CREATE REPORT.

    Scroll or drag to pan · ⌘+/⌘− to zoom · Esc to closeimages/dfi-guided-experience.gif

  5. Edit the report data.

Create a report from a dataset

If you're already familiar with the data you want to use for your report, you can start by selecting a specific dataset.

To create a report from a dataset:

  1. Go to the Data Catalog page.

  2. From the Datasets tab, decide which dataset you want to start with. You can use the toolbar to:
    • Search by dataset name or description.
    • Filter by Source Type (Database, Salesforce, or Web service).
    • Filter by Source Name.
  3. Click the dataset. The dataset details appear.

    Scroll or drag to pan · ⌘+/⌘− to zoom · Esc to closescreenshot of the dataset's Overview tab showing the dataset's description, source, and a list of fields

  4. Review the fields and data in the dataset to confirm it meets your needs.
  5. Click CREATE REPORT.
  6. Edit the report data.

Tip:  You can also select a dataset from the Home page by clicking CREATE REPORT, but you cannot preview the datasets information.

Selecting a dataset for your report

When you create a report, the dataset you select determines what data can be included in your report.

Before selecting a dataset, you should:

Example

You have a Customers dataset and an Orders dataset, where the Customers dataset has a one-to-many relationship with Orders (each customer can have many orders).

To decide which dataset to use in this scenario, think of the question you want the report to answer:

  • Select the Customers dataset (the "one" side) if you want to know which customers have spent the most money on orders.
  • Select the Orders dataset (the "many side") if you want to see how many orders have been placed in the last month.

Create a report from a process

If you want to create a report from a process, start by selecting a specific process in the data catalog.

To create a report from a process:

  1. Go to the Data Catalog page.

  2. From the Processes tab, decide which process you want to start with. You can use the toolbar to search by process name or description.

  3. Click the process. The process details appear.

    Scroll or drag to pan · ⌘+/⌘− to zoom · Esc to closeimages/data-catalog-process-view.png

  4. Review the process details to confirm it meets your needs. To view more information about a process, explore the process from the Process Insights page.
  5. Click CREATE REPORT.
  6. Edit the report data.

Design, filter, and sort report data

After you've created a report, you can start customizing the report's data and appearance.

For example, you can quickly build a stacked bar chart with multiple data points, and add a color scheme.

Scroll or drag to pan · ⌘+/⌘− to zoom · Esc to closeimages/report-builder-26_2.gif

Tip:  If you created your report using AI Copilot or the guided experience, you won't need to design your report from scratch, but we recommend that you review and refine the suggestions you selected at this point.

First, you select the fields you want to include in your report.

  1. In the FIELDS section, use the dropdown to select fields. If you're building a report from a dataset, you can select fields from the dataset and related datasets. If you're building a report from a process, you can select fields from the process case data.
  2. Click the X icon next to a field to remove it.
  3. To edit a field's display name:
    1. Click the pencil icon next to the field name.
    2. In the Edit Display Name dialog, enter a new display name for the field in the Display Name field.
    3. Click OK.

After selecting fields for your report, you can customize the report grid:

  • Drag and drop columns in the grid to rearrange them.
  • Click the menu to sort, move, or remove columns, aggregate the column's data, or change the format for the values in the column.

To apply a filter to your report data:

  1. In the DATASET FILTERS or PROCESS FILTERS section, click ADD DATASET FILTERS or ADD PROCESS FILTERS.
  2. In the dialog, click Add Dataset Filter or Add Process Filter.
  3. Use the Field, Operator, and Value fields to build your filter criteria.
  4. When you've added all of the criteria you want, click ADD.

To change the design of your report:

  1. In the DESIGN section, click one of the following options:

    Design Availability
    Grid Any report
    Pie Any report
    Donut Any report
    Bar, Stacked Bar, or 100% Bar Any report
    Column, Stacked Column, or 100% Column Any report
    Area, Stacked Area, or 100% Area Any report
    Line Any report
    Scatter Reports created from datasets
    KPI Reports created from datasets
    Heatmap Reports created from datasets
  2. Click the Show Grid toggle to show or hide the report grid.

If your selected design includes a chart, you can add and adjust the following options to customize the chart's appearance:

  • Reference lines
  • Chart legend
  • Data labels
  • Tooltips
  • Chart color

Next, add interactive elements to your report.

Add interactive elements

Every chart in a custom report is interactive. For example, you can click on any section of a chart in your report to quickly filter the report data.

Scroll or drag to pan · ⌘+/⌘− to zoom · Esc to closeimages/interactive-report-chart.gif

You can also add the following design elements to let report viewers interact with the data and take action from the context of the report.

Scroll or drag to pan · ⌘+/⌘− to zoom · Esc to closeimages/report_designElements_26_3.png

#

Design Element

Description

1

Report Filters

Display interactive filters on a report so report viewers can filter the data to best fit their needs.

User filters configured on the dataset's underlying record type are not available in reports in Process HQ.

2

Actions

(Dataset reports only) Display record actions from the base record type in a grid header.

3

Link to Row Details

(Dataset reports only) Displays a link to the record’s summary view in a grid. This option will only provide links to records in the base record type; it cannot provide links to related records.

The summary view page is determined by the default start page configured in the Admin Console.

4

Show Export or Download Button

Depending on the selected design:

  • Displays an export to Excel button on a grid design. The data will download as a .xlsx file.
  • Displays an image download button on a chart design. The image will download as a PNG file.

5

Drilldown Reports

(Dataset reports only) Select a Drilldown Report that's based on the same dataset. When users click a section of the chart, they'll see the selected drilldown report with the data filtered by the section of the chart they clicked.

Next, save and share the report with your colleagues.

Report security

When you create a report, the following access levels are assigned by default:

  • Owner access is assigned to the user who creates the report.
  • No Access is assigned to the Process HQ Users system group.

For reports created from a process, users must have at least Viewer permissions for the underlying business process.

When you share a report with another user, the user's access level for the report controls which actions the user can take.

The following table describes the actions users can take based on access level:

Action

Owner

Editor

Viewer

No Access

See a report on the Home page Yes Yes Yes No
View a report Yes Yes Yes No
Edit a report Yes Yes No No
View report properties Yes Yes Yes No
Edit report properties Yes Yes No No
Duplicate a report Yes Yes Yes No
See which users a report is shared with Yes Yes No No
Edit which users a report is shared with Yes Yes No No
Favorite a report Yes Yes Yes No
Delete a report Yes No No No

Edit report properties

Report creators must have Editor access to a report to edit its properties. System administrators can edit any report's properties in Process HQ.

To edit the properties of a report:

  1. Do one of the following to find the report you want to edit:
    • On the Process HQ home page, click the three-dot menu next to the report.
    • While editing a report, click the three-dot menu in the report page toolbar.
  2. Click Edit Properties.
  3. In the Edit Properties dialog:
    • For Name, enter a name for the report.
    • For Description, enter a brief description of the report.
  4. Click SAVE.

Share a report

Report creators must have Editor access to a report to share it. System administrators can share any report.

Keep in mind that sharing a report gives the user access to that report, but data won't display in the report unless the user also has access to the underlying datasets or process.

To share a report:

  1. Click SHARE in the header of the report. The Share Report dialog displays.

    Scroll or drag to pan · ⌘+/⌘− to zoom · Esc to closeimages/phq-share-report.png

    Tip:  You can also share a report from the LIBRARY section of the Home page. Click the three-dot menu for the report, then click Share.

  2. Add new users or groups:

    1. In the Add User or Group field, search for a user or group to add.

    Tip:  To share with all users, select the Process HQ Users group.

    1. Use the dropdown list to assign the user access level.
    2. Click ADD. The Users or Groups with Access section updates.
  3. Edit an existing access assignment:
    1. In the Users or Groups with Access section, find the user or group you want to edit.
    2. Use the dropdown list to assign a new access level. Click X next to the user or group to remove them.
  4. Click SAVE.

After creating and sharing your report, you might want to add the report to a dashboard.

Favorite a report

Report creators or system administrators can favorite any report for quick access. The reports you add as favorites display in the FAVORITES tab of the LIBRARY section of the Home page.

To favorite a report:

  1. Go to the LIBRARY section of the Home page. The All tab is active by default.
  2. In the library list, click the Add to Favorites icon for the report you want to favorite.

    For example:

    Scroll or drag to pan · ⌘+/⌘− to zoom · Esc to closeLIBRARY list with the favorite star highlighted for three entries

Tip:  You can also click the Add to Favorites icon for any report in the RECENTLY OPENED section of the Home page, or next to the name of any open report.

Duplicate a report

Report creators must have Editor access to a report to duplicate it. System administrators can duplicate any report.

To duplicate a report:

  1. Do one of the following to find the report you want to duplicate:
    • On the Process HQ home page, click the three-dot menu next to the report.
    • While editing a report, click the three-dot menu in the report page toolbar.
  2. Click Duplicate.
  3. In the Duplicate dialog:
    • For Name, enter a name for the report.
    • For Description, enter a brief description of the report.
    • For Application, select the application related to the report. The report object will appear in the application you select.
    • To share the report with the same users who can access the original report, keep the checkbox selected. Otherwise, deselect the checkbox.
  4. Click CREATE.

When you duplicate a report, the new report will only be available to you. You must share the new report to allow other users to view it.

Add a report to an app

You can add a report to an application as a deployable object. For more information, see Deploy Report and Dashboard Objects.

Delete a report

Report creators must have Owner access to delete a report. System administrators can delete any report.

To delete a report:

  1. Go to the LIBRARY section of the Home page.
  2. Next to the report, click the three-dot menu .
  3. Select Delete.
  4. In the Delete dialog, click DELETE.

Feedback