Dashboard in Expression Language: Difference between revisions

From QPR ProcessAnalyzer Wiki
Jump to navigation Jump to search
Line 48: Line 48:
! '''Description'''
! '''Description'''
|-
|-
||DeletePermanently
||
||
||Deletes the dashboard permanently.
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#).
|-
||Modify
||
||
||
||
Modifies/updates the dashboard.
2. Parameters:
2.1. Dictionary containing the dashboard properties to be updated. The following properties are supported:
2.1.1. Name (string).
2.1.2. Identifier (string).
2.1.3. Description (string).
2.1.4. ProjectId (integer).
2.1.5. Content (dictionary).
3. Returns the updated Dashboard object (#71651#).
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#).
|}
|}


Line 61: Line 78:
||DashboardById
||DashboardById
||
||
* Diagram id (Integer)
* Dashboard id (Integer)
||
||
Returns diagram object corresponding to the provided diagram id.
Gets the dashboard by the given dashboard id.
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 18:02, 27 October 2023

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.

Dashboard properties

Dashboard objects in the expression language have the following properties:

Property Description
Content Returns the dashboard content (dictionary).
CreatedBy Returns the user (#30964#) who created this dashboard (object).
CreatedDate Returns the dashboard created date (datetime).
Description Returns the description of the dashboard (string).
Id Returns the id of the dashboard (integer).
Identifier Returns the identifier of the dashboard (string).
LastModifiedBy Returns the user (#30964#) who last modified this dashboard (object).
LastModifiedDate Returns the dashboard last modified date (datetime).
Name Returns the name of the dashboard (string).
Project Returns the project (#27622#) that this dashboard belongs to (object).
ProjectId Returns the project id that this dashboard belongs to (integer).

Diagram functions

Diagram objects in the expression language have the functions described below. To create new diagrams, use function Model.CreateDiagram(), and to list existing diagram, use property Model.Diagrams.

Function Parameters Description
DeletePermanently Deletes the dashboard permanently.

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#).

Modify

Modifies/updates the dashboard. 2. Parameters: 2.1. Dictionary containing the dashboard properties to be updated. The following properties are supported: 2.1.1. Name (string). 2.1.2. Identifier (string). 2.1.3. Description (string). 2.1.4. ProjectId (integer). 2.1.5. Content (dictionary). 3. Returns the updated Dashboard object (#71651#). 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#).

Function to get diagram by dashboard id:

Function Parameters Description
DashboardById
  • Dashboard id (Integer)

Gets the dashboard by the given dashboard id. 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.