Dashboard in Expression Language: Difference between revisions

From QPR ProcessAnalyzer Wiki
Jump to navigation Jump to search
No edit summary
Line 1: Line 1:
In QPR ProcessAnalyzer, '''diagram''' can be used to create user-defined business process and architecture designs. The diagram is a drawing canvas where elements can be added from a tool palette and relation between them defined. Each diagram belongs to the model in QPR ProcessAnalyzer and there can be several diagrams in each model.
In QPR ProcessAnalyzer, '''dashboard''' is a canvas where charts and other visualization components can be added. Each dashboard belongs to project. Dashboards have a mandatory name and optional identifier. The identifier is used when creating links between dashboards.


==Dashboard properties==
==Dashboard properties==
Line 14: Line 14:
|-
|-
||CreatedDate (DateTime)
||CreatedDate (DateTime)
||Returns dashboard created date.
||Returns date when the dashboard was created.
|-
|-
||Description (String)
||Description (String)
||Returns description of the dashboard.
||Returns description text of the dashboard.
|-
|-
||Id (Integer)
||Id (Integer)
Line 29: Line 29:
|-
|-
||LastModifiedDate (DateTime)
||LastModifiedDate (DateTime)
||Returns the dashboard last modified date.
||Returns date when the dashboard was last time modified.
|-
|-
||Name (String)
||Name (String)
Line 35: Line 35:
|-
|-
||Project (Project)
||Project (Project)
||Returns project object that this dashboard belongs to.
||Returns project object where the dashboard belongs to.
|-
|-
||ProjectId (Integer)
||ProjectId (Integer)
||Returns the project id that this dashboard belongs to.
||Returns project id where this dashboard belongs to.
|}
|}


== Diagram functions ==
== Diagram functions ==
Diagram objects in the expression language have the functions described below. To create new diagrams, use function [[QPR_ProcessAnalyzer_Objects_in_Expression_Language#Model|Model.CreateDiagram()]], and to list existing diagram, use property [[QPR_ProcessAnalyzer_Objects_in_Expression_Language#Model|Model.Diagrams]].
Dashboard objects in the expression language have the functions described below. To create new dashboards, use function [[QPR_ProcessAnalyzer_Objects_in_Expression_Language#Model|Model.CreateDashboard()]], and to list existing dashboards, use property [[QPR_ProcessAnalyzer_Objects_in_Expression_Language#Model|Project.Dashboards]].
{| class="wikitable"
{| class="wikitable"
!'''Function'''
!'''Function'''
Line 50: Line 50:
||DeletePermanently
||DeletePermanently
||
||
||Deletes the dashboard permanently.
||Deletes the dashboard permanently. ''EditDashboards'' permission to the project is required.
2. EditDashboards permission to the project is required.
 
3. Throws an exception (LimitedModeException with exceptionCode 11) if called is from api/expression or api/expression/query and full functionality isn't enabled (#70961#).
Example: delete all dashboards in a project:
<pre>
ProjectById(1).Dashboards.DeletePermanently()
</pre>
|-
|-
||Modify
||Modify
||
||
||
||
Modifies/updates the dashboard.
Modifies the dashboard. The parameter is a dictionary containing dashboard properties to be updated. ''EditDashboards'' permission to the project is required. Following properties are supported:
2. Parameters:
* '''Name''' (String): Name of the dashboard.
2.1. Dictionary containing the dashboard properties to be updated. The following properties are supported:
* '''Identifier''' (String): Identifier of the dashboard.
2.1.1. Name (string).
* '''Description''' (String): Description of the dashboard.
2.1.2. Identifier (string).
* '''ProjectId''' (Integer): Project id where the dashboard belongs to, i.e., moves the dashboard to other project.
2.1.3. Description (string).
* '''Content''' (Dictionary): Dashboard content as dictionary.
2.1.4. ProjectId (integer).
 
2.1.5. Content (dictionary).
Example:
3. Returns the updated Dashboard object (#71651#).
<pre>
4. EditDashboards permission to the project is required.
 
5. Throws an exception (LimitedModeException with exceptionCode 11) if called is from api/expression or api/expression/query and full functionality isn't enabled (#70961#).
</pre>
|}
|}


Line 80: Line 83:
* Dashboard id (Integer)
* Dashboard id (Integer)
||
||
Gets the dashboard by the given dashboard id.
Returns dashboard by the given dashboard id. Returns the Dashboard object if such is found. Throws an exception if dashboard doesn't exist or user doesn't have permissions to it. ''GenericRead'' permission to the project that contains the dashboard is required.
2. Parameters:
2.1. Id of the dashboard (integer).
3. Returns the Dashboard object (#71651#) if such is found.
4. Throws an exception if dashboard is not found.
5. GenericRead permission to the project that contains the dashboard is required.
|}
|}

Revision as of 19:58, 27 October 2023

In QPR ProcessAnalyzer, dashboard is a canvas where charts and other visualization components can be added. Each dashboard belongs to project. Dashboards have a mandatory name and optional identifier. The identifier is used when creating links between dashboards.

Dashboard properties

Dashboard objects in the expression language have the following properties:

Property Description
Content (Dictionary) Returns dashboard content (charts and other components contained by the dashboard).
CreatedBy (User) Returns user who created the dashboard.
CreatedDate (DateTime) Returns date when the dashboard was created.
Description (String) Returns description text of the dashboard.
Id (Integer) Returns id of the dashboard.
Identifier (String) Returns identifier of the dashboard.
LastModifiedBy (User) Returns user who last modified this dashboard.
LastModifiedDate (DateTime) Returns date when the dashboard was last time modified.
Name (String) Returns the name of the dashboard.
Project (Project) Returns project object where the dashboard belongs to.
ProjectId (Integer) Returns project id where this dashboard belongs to.

Diagram functions

Dashboard objects in the expression language have the functions described below. To create new dashboards, use function Model.CreateDashboard(), and to list existing dashboards, use property Project.Dashboards.

Function Parameters Description
DeletePermanently Deletes the dashboard permanently. EditDashboards permission to the project is required.

Example: delete all dashboards in a project: 

ProjectById(1).Dashboards.DeletePermanently()
Modify

Modifies the dashboard. The parameter is a dictionary containing dashboard properties to be updated. EditDashboards permission to the project is required. Following properties are supported:

  • Name (String): Name of the dashboard.
  • Identifier (String): Identifier of the dashboard.
  • Description (String): Description of the dashboard.
  • ProjectId (Integer): Project id where the dashboard belongs to, i.e., moves the dashboard to other project.
  • Content (Dictionary): Dashboard content as dictionary.

Example:

Function to get diagram by dashboard id:

Function Parameters Description
DashboardById
  • Dashboard id (Integer)

Returns dashboard by the given dashboard id. Returns the Dashboard object if such is found. Throws an exception if dashboard doesn't exist or user doesn't have permissions to it. GenericRead permission to the project that contains the dashboard is required.

Retrieved from "https://wiki.onqpr.com/pa/index.php?title=Dashboard_in_Expression_Language&oldid=23739"