Display analysis results as an image

You can display an analysis dynamically created by the PPM server as a graphic in your HTML page. The data is queried by specifying a favorite. As an option, you can also specify filters to further restrict the data volume.

Query pattern

http://host:port/contextname/urlquery/image/query.do?parameterliste

Example

http://localhost:8080/API_demo41_en/urlquery/image/query.do?favoritename=<favorite name>

Favorite types

You can use all favorites based on any diagram type, EPC view, communication analysis, or Relation Explorer analysis.

If you enabled the query interface the pop-up menu entry URL for query interface is available in PPM for certain favorites based on a supported favorite type. You can use the pop-up menu entry to copy the relevant URL to the clipboard. The URL created is already correctly coded and contains the language specified when logging into the PPM front-end in the language argument. Filter settings specified in addition to the favorite will not be considered (see chapter URL query).

The query returns the binary data stream of the analysis graphic in the format PNG (Portable Network Graphics) or JPG.

In addition to the default parameters favoritename, favoritefolder, language, filterfavorite, and a filter list (see chapter URL query and Query parameters) you can specify further parameters for the query:

Parameter

Description

imageheigth
(optional)

Height of the graphic to be created
Maximum value 2000 pixels

imagewidth
(optional)

Width of the graphic to be created
Maximum value 2500 pixels

imageformat
(optional)

Format of the graphic to be created
Valid values: PNG (default value), JPG.

Graphic size

Width and height of the graphic to be created must always be specified together. If one information is missing or invalid, the other will be ignored. In this case, the default values are applied. A value is identified as invalid if the specified value is less than or equal to zero, or if it is larger than the maximum value.

Default sizes

For graphics based on a chart, a default size of 640 pixels (width) by 480 pixels (height) applies.

For graphics based on EPC and organizational analyses, the default size and thus the aspect ratio of the created graphic is determined by the number of objects the graphic contains.

Error behavior

If an error occurs during the creation of the graphic, a graphic including the reason for the error in text form is created. Possible causes of errors are: