Report and Dashboard Objects

This page provides detailed information on how to create, manage, and deploy report and dashboard objects.

What are report and dashboard objects?

Report and dashboard objects allows developers to easily deploy reports and dashboards that are created using the accelerated design experience in Process HQ. Once a report or dashboard object is successfully deployed, business users in the target environment can access the report or dashboard in either the Process HQ workspace or from a site, and use the objects as templates to design their own reports and dashboards.

A report object can be referenced in a dashboard only. A dashboard object cannot be referenced in other objects.

Scroll or drag to pan · ⌘+/⌘− to zoom · Esc to close

When to use these objects

Use a report or dashboard object when you need to:

• Deploy a report or dashboard from a source environment to a target environment.
• Include key business metrics and reports as part of a standard application delivery.

Elements of these objects

In Appian Designer, a report or dashboard object redirects you to the report or dashboard in Process HQ. There, the elements of the report or dashboard depend on the design of the individual report or dashboard.

Security

Object security for design objects is configured through role maps.

The role map for a report or dashboard object allows the following permission levels:

• No Access: The object is not visible to the user or group.
• Viewer: The object is visible to the user or group, but the actions they can take on it are limited.
• Editor: The object is visible to the user or group, and they can take all actions except editing the object role map and deleting the object.
• Administrator: The object is visible to the user or group, and they can take all actions including editing the object role map and deleting the object. This permission level becomes Owner access in Process HQ.

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

Action
	Administrator	Editor	Viewer	No Access
See a report or dashboard object in the Objects view.	Yes	Yes	Yes	No
Add a report or dashboard object to an application.	Yes	Yes	Yes	No
View security for a report or dashboard object.	Yes	Yes	No	No
Edit security for a report or dashboard object.	Yes	No	No	No
View dependencies and precedents for a report or dashboard object.	Yes	Yes	Yes	No
Deploy a report or dashboard object.	Yes	Yes	Yes	No
Delete a report or dashboard object.	Yes	No	No	No

Process HQ dependencies

When you create a report or dashboard in Process HQ, the object's role map in Appian Designer reflects the following default user access levels:

• The creator of the report or dashboard is assigned Owner access, which becomes the Administrator permission level in the report or dashboard object.
• The Process HQ Users system group is assigned No Access.

User access and object permission levels stay synchronized as you share the report or dashboard in Process HQ or edit the object security in Appian Designer.

Manage these objects

This section explains how to create, edit, and delete report and dashboard objects, as well as add these objects to applications.

Common object options

There are a few common options available across different design objects. The following options are available in report and dashboard objects.

Option	Available?
Versioning	No
Renaming	Process HQ
Viewing Appian Design Guidance	No
Duplicating	Process HQ
Viewing Performance Details	No
Object overwrite protection	No

Create these objects

Use Process HQ to create a report or dashboard.

Add these objects to an application

To add report and dashboard objects to an application, you must have:

• Editor permissions for the application.
• Viewer permissions for the report and dashboard objects.

To add a report or dashboard object to an application:

1. Go to the Build view of the application.
2. Go to the ALL OBJECTS tab, if it's not already active.
3. In the toolbar, click ADD EXISTING.
4. Select Existing Objects.
5. In the Other box, select one or more reports and dashboards.
6. (Optional) To check the added objects for missing precedents, select Check for missing precedents after adding objects to this application.
7. Click ADD TO APPLICATION.

Edit the object properties

You must have Editor permissions to edit properties for a report or dashboard object.

To edit properties for a report or dashboard object:

1. In the Build view of your application, click the object in the objects grid. The report or dashboard opens in Process HQ in another tab.

2. Click the edit icon next to the report or dashboard name.

   For example:

   

   Scroll or drag to pan · ⌘+/⌘− to zoom · Esc to close

3. In the Edit Report Properties or Edit Dashboard Properties dialog:
   • For Name, enter a name for the report or dashboard.
   • For Description, enter a brief description of the report or dashboard.
4. Click UPDATE. The dialog closes.
5. In the report header, click SAVE.

Delete these objects

You must have Administrator permissions to delete a report or dashboard object.

To delete a report or dashboard object:

1. In the Build view, select the check box next to the object's name.
2. Click DELETE in the toolbar.
3. Review the list of dependent objects. See Object Relationships for more information about the impact of deleting objects that rely on each other.
4. Click DELETE to confirm.

See also

• Manage Reports and Dashboards: Learn how to create, design, and manage reports, then assemble those reports into dashboards and share them with colleagues.
• Deploy to Process HQ

Feedback