Tutorial: Creating View in QPR UI

From QPR ProcessAnalyzer Wiki
Jump to: navigation, search

Example: Defining View Properties and Variables

  1. Creating a new QPR UI view starts by defining the Name and View Context. These are defined in the view properties that is opened by clicking the Properties button:
    OpenViewProperties.png
  2. First, give your view a Name and a Description. Then, click Presentation:
    ViewProperties.png
  3. On the Presentation tab, change the Background color. Set also the Outer margin to be "5", this setting will make the panels be closer to each other than with the default setting. After that, click Context:
    ViewPresentationTab.png
  4. The context defines the starting points for later querying data from QPR EnterpriseArchitect/ProcessDesigner, QPR Metrics, and/or QPR ProcessAnalyzer. Define the context by selecting values for the context variables by first selecting a variable from the drop-down menu and then tapping the edit icon on the Value column:
    ViewContext.png
  5. To define context variables, type in the name of the variable to the text field and click the check mark. After that, you can click the value field and type in the value for your context variable. Context variables starting with "sys:" are system context variables which have special purpose in QPR UI - use them only for their intended purpose. The Behavior selection affects the context variable used explained in Context Variable Behaviors. To see what context variable values are used in the view, panel, or presentation object, select the Show effective context check box in the Context tab of the view, panel, or presentation object properties pages.

Using QPR EnterpriseArchitect/ProcessDesigner Data

EAContext.png

  • To use QPR EnterpriseArchitect or QPR ProcessDesigner data, define the sys:eapdModel, sys:eapdElementType and sys:eapdElement context variables to set the default context instance. With the sys:eapdElement context variable, you can use the check boxes on the left side of the list to select the elements to which the view you are designing applies. These elements will then be selectable as the context instance via the Selections button when browsing the view. Selecting the All elements automatically check box will result in all elements of the element type defined by the sys:eapdElementType variable to be automatically available in the view when new elements of that type are added to the model.

Using QPR Metrics Data

MetricsContext.png

  • If you want to show data from element(s) that reside in some particular scorecard(s), define the sys:metricsModel and sys:metricsScorecard context variables. This is the most commonly preferred way of showing Metrics data.
  • If you want to show data from a single Metrics element or measure, define the sys:metricsModel, sys:metricsValueSettings, and sys:metricsElement context variables.

The difference between these two approaches is that views with the sys:metricsScorecard variable defined can show data from multiple measures residing in the selected scorecards, whereas views with the sys:metricsElement variable defined are restricted to the measures selected here, but they enable browsing different measures using the same value settings as the selected measure. With the sys:metricsScorecard and sys:metricsElement variables, you can use the check boxes on the left side of the list to select the scorecards or elements to which the view you are designing applies. These scorecards or elements will then be selectable as the context instance via the Selections button when browsing the view. Selecting the All scorecards/elements automatically check box will result in all scorecards or elements of the model defined by the sys:metricsModel variable to be automatically available in the view when new scorecards or elements of the defined sys:metricsValueSettings type are added to the model.

Select QPR Metrics Period

By default, the QPR UI view shows data from the Current period. As the view you are designing might not have data available for the current period, click the Selections button:

Selections.png

Then, select a period for which you have data:

SelectPeriod.png

Example: Adding Panel and Defining Properties and Context

  1. Add a new Panel to the view by clicking the Add New Panel button in the side toolbar.
    AddNewPanel.png
  2. Click the panel to select it and then click the Properties button on the panel.
    PropertiesPanel.png
  3. In the Panel Properties, you can define the Name, Identifier, and Description on the Properties tab.
    PanelProperties.png

    In addition to normal text, you can use Variable and Expression tags in the panel name to enable the name to change dynamically or construct the name using an expression. For example, you could define the panel name to be Selected scorecard: <#sys:metricsScorecard>.
  4. Switch to the Presentation tab. On the Presentation tab, change the Background color. Set also the Inner margin to be "5", this setting will make the presentation objects be closer to each other than with the default setting. You can also adjust the other presentation settings, see the Panel Properties page for their descriptions.
    PanelPresentation.png

    You can also define panel specific context variable values on the Context tab. Apply the changes and close the panel properties by clicking Close.

Editing Panel Contents

  1. To add contents to a panel, open the Panel Editor by clicking the Edit button.
    EditPanel.png
  2. The left side toolbar contains all the possible presentation objects in QPR UI. Click on a presentation object icon on the left side toolbar to add the presentation object to the panel.
    POsToolbar.png

Add Data Grid to View

  1. Add a Data Grid Presentation Object to the panel by clicking the Data Grid Presentation Object button on the side toolbar.
  2. This is a good point to save the Panel. Click the Save button on the toolbar on top.
    SavePanel.png
  3. The Presentation Object Properties are used to define what data is used in the Data Grid and how the data is shown. Click the Properties button on the Data Grid Presentation Object to open the data grid properties.
    OpenDataGridProperties.png
  4. First, give a Name and optionally a Description for the data grid. Then click the Query tab.
    DataGridProperties.png

Defining Queries

The query defines the element(s) from which attributes having values are taken. Click Add query to start defining a query, and then select either EnterpriseArchitect / ProcessDesigner, Metrics element, Metrics scorecard, or ProcessAnalyzer to be the initial data source.
AddQuery.png

When querying EnterpriseArchitect / ProcessDesigner data, the first element that appears to the query is the sys:eapdElementType value that is defined in the Session or View/Panel/Presentation object Properties. Click on the Element and Connector types in the Side Pane until you have reached the desired Element Type from which you want to show data.
EAPDQuery.png

When querying Metrics data, with Metrics scorecard, you can select the element residing in the scorecard defined by the sys:metricsScorecard context variable to be the element from which you want the query to take data. With Metrics element, the first element that appears to the query is the element you selected as the sys:metricsElement context variable value. Note that when the value of the context variables are changed, the initial element in the query will change too.

Metrics reference elements are shown with the format "Element name (Scorecard name)". When using a reference element, the data will always be taken from the selected reference element, regardless of what the currently selected scorecard is.

MetricsQuery.png

When querying Metrics data, you can define the Period range, which defines how many periods are shown before and after the currently selected period in the view.
MetricsQueryDefinePeriodRange.png

More information about writing QPR ProcessAnalyzer queries and QPR Web Service queries.

WSquery.png

After reaching the wanted element (EA/PD), defining the period range (Metrics), or defining the analysis parameters (ProcessAnalyzer), click Finalize and give a name for the query result. The attributes from the result set will be selectable on the Mappings tab. If you want to add another query, click the Add query button.
FinalizeQuery.png

Mapping Query Results to the Data Grid

  1. Click the Mapping tab. On the Mapping tab, you select which attributes' values are shown in the table.

    First, expand a Result Set by clicking it under Select attributes.
    MappingExpandResult.png
  2. Click on the Attribute Names on the Result Set list to add the attributes to the table. The whole rectangular area shown on the sheet is called a Mapping. The dotted line shown on the mapping on the sheet indicates where the next attribute will be placed in the table.

    On the Mapping tab, the table will show only placeholders for the attribute values. Real values can be seen on the Presentation tab.
    MappingSelectAttributes.png
  3. A single mapping can have attribute values from only one result set defined on the Query tab. To add another mapping to the table, click a cell that doesn't have a mapping definition in it. To edit an existing mapping, click on a cell on that mapping.
    MappingAddAnother.png
  4. To Move, set the Size and Direction, Hide or Show the Table Headers, or to Delete the mapping, click the Mapping Toolbar buttons shown on top of the mapping.
    MappingToolbar.png
  5. Click the Cogwheel button to open the Cell Properties, and define some Text and the Link URL for the cell.
    MappingCellProperties.png
    The Text in the Cell Properties will overwrite any value coming from a mapping, so that the value won't be shown in the table.

    When the Link URL is defined, the cell will contain a hyperlink to the defined URL, and the link will be shown if you have defined the Text for the cell or if the table contains a value for that cell.

    To link to a QPR UI view, define the view with the "sys:dashboardIdentifier" variable in the URL like this: "http://your.host.here/ui/#/dashboard?sys:dashboardIdentifier=<View identifier of the target view>". Similarly, you can use the sys:dashboard variable, if you haven't defined the View identifier for the target view. You can also define values for the target view's context variables by appending "&variablename=<variablevalue>" to the URL, and utilize context variables as the value in the URL by adding them using the format "{#contextvariablename}". For example:
    http://your.host.here/ui/#/dashboard?sys:dashboardIdentifier=MyFineDashboard&country=Finland&scorecard={#YourScorecardIdentifierVariable}.
    Note: Each variable value you define in the URL like described above must have the value defined, otherwise the link won't work.

    If the QPR Suite Single Sign-on is in use, and you want to link to QPR Portal or QPR ProcessAnalyzer Web Client using the QPR Suite Single Sign-on, append a "&XSESSION={#sys:sessionId}" parameter to the end of the link URL, for example:
    http://your.host.here/QPR2017-1/Portal/QPR.Isapi.dll?your-mea-parameters&XSESSION={#sys:sessionId}

    Cells for which you have defined Cell Properties are marked with a triangle on the top right corner of the cell.

Formatting Values

To format the values in a column or row:

  1. Click a Column/Row Function button and select Format column/row.
  2. Select the Show numeric values as percentages check box to convert the decimal numbers into percentages.
  3. To limit the number of decimals, select the Number of decimals check box and define the number of decimals you wish to use.
  4. Select the Format cell background based on column values check box to make the cells have gradient background colors computed from the position of the value of each cell relative to the maximum and minimum values in the column or row.

To hide a column or row, select Hide column/row from the Column/Row Function buttons menu. A hidden column or row can be shown by selecting Show column/row from the Column/Row Function button menu.


Add a Gauge

  1. Click the Gauge button on the side toolbar.
    AddGauge.png
  2. Click the Properties button on the gauge presentation object to open the gauge properties.
    OpenGaugeProperties.png
  3. First, give a Name and optionally a Description for the gauge. Then click the Mapping tab.
    GaugeProperties.png
  4. Graphical presentation objects take their data from existing tables. Select a data grid from the Select Data Source list.
    GaugeSelectDataSource.png
  5. Value settings define the ranges and range limits for the graphical presentation objects. To use existing value settings, select the desired value settings from the list on the bottom left corner. To define new value settings, click New and give a name for the value settings. Next, add the desired amount of Range limits and then add Range(s) and define their properties.
    GaugeValueSettings.png
  6. Next, use the Column and Row Function buttons to define which row or column contains the Values, which row or column contains the Labels for the periods, which one(s) are used for the Series Labels, which one(s) are used for Range Limit(s), and which row or column to take All the values from.
    GaugeMapColumns.png
    These same kind of mapping steps are used in other graphical presentation objects too, but for example column charts can show multiple values, whereas a gauge is limited to showing only one value.
  7. The Preview shown on the Mapping tab acts as a reference when defining the ranges. To see a bigger preview click the Presentation tab.
    GaugeMapped.png
  8. On the Presentation tab, expand the Scale section, and define the scale for the gauge by entering the Minimum and Maximum values to use on the gauge.
    GaugePresentation.png
    For other graphical presentation objects, expand the Presentation settings Values section to define the Ordering, Color, and Type of the series, and the Axis section to define the scale.
  9. Collapse the Scale section and expand the JSON settings section.
  10. After you are done, click Close to apply the changes and to close the presentation object properties. Then click Save to save the changes to the panel.


Usage Example

  1. Click the External Content presentation object icon.
  2. Click the Properties button on the presentation object to open its properties.
    OpenExternalContentProperties.png
  3. Define the Name, Description, and the External content URL. In the Name and URL fields, you can use context variables by typing in the context variable name in the format "{#contextvariablename}".
  4. After defining these properties, click Close. The web page should now be visible:
    ExternalContent.png


Add a Pushbutton

  1. Click the Pushbutton presentation object icon.
    AddPushbutton.png
  2. Click the Properties button on the presentation object to open its properties.
    OpenPushbuttonProperties.png
  3. Define the Name for the pushbutton. The name will be used as the label on the button. Optionally, give a Description for the pushbutton.
  4. Switch to the Query tab, and define the QPR ProcessAnalyzer query parameters.
    PushbuttonQuery.png
  5. Optionally, you can also define context variables for the Pushbutton on the Context tab.
  6. Click Close to close the pushbutton properties, and then Save the changes.


Add a Pivot Grid

  1. Add a Pivot Grid Presentation Object to the panel by clicking the Pivot Grid presentation object button on the side toolbar.
  2. Click the Properties button on the Pivot Grid Presentation Object to open the pivot grid properties.
    OpenPivotGridProperties.png
  3. After defining the Name and possibly a Description for the Pivot Grid, switch to the Mapping tab. On the Mapping tab, select a table or a data grid to be the data source for the Pivot Grid.
    PivotGridSelectDataSource.png
  4. Use the buttons shown on top of the data table/data grid columns to map the columns to Rows, Values, and/or Columns.
    PivotGridMapColumns.png
    You can switch to the Presentation tab to see how your Pivot Grid looks like when doing the mapping.
    PivotGridPresentation.png
    After you are satisfied, click Close to close the Pivot Grid Properties and again Close to close the panel. Then Save the panel.


Add a Pick List

  1. Add a Pick list Presentation Object to the panel by clicking the Pick list Presentation Object button on the side toolbar.
    AddPickList.png
  2. Click the Properties button on the Pick list Presentation Object to open the Pick list properties.
    OpenPickListProperties.png
  3. Define a Name and optionally a Description for the Pick list. The name will be shown on the Pick list button when nothing has been selected from the Pick list yet.
    PickListProperties.png
  4. Switch to the Query tab. On the Query tab, you can define a QPR ProcessAnalyzer query to be executed when a selection is made on the Pick list. The query will be executed after the context variable value defined on the Context Mapping tab is set by the Pick list. Defining the QPR ProcessAnalyzer query is optional. If you don't define the query, only the context variable value will be set.
    PickListQuery.png
  5. Switch to the Context Mapping tab. On the Context Mapping tab, define the Context variable for which you want to set a value, and then select the table or data grid from which the context variable will take the possible values. The values will be taken from the leftmost column of the table or data grid, and the first row of the table or data grid is considered a header, so data on the first row won't be regarded as a possible value.
    PickListContextMapping.png
  6. After you are satisfied, click Close to close the Pick list Properties, and then click Save to save the changes to the panel.


Adding PAPO to View

  1. Add a new PAPO to a panel by clicking the QPR ProcessAnalyzer Presentation Object button on the side toolbar.
  2. By default, PAPO shows the Flowchart Analysis based on the default filter for the user. To change this, the FilterId context variable needs to be defined. We'll define the FilterId in the View context, so that it will be available when the view is opened. First, click Close to close the panel.
  3. The View context is accessible in the View properties. Click the Properties button and then switch to the Context tab.
  4. Type in "FilterId" to the Variable name text box and then click the check mark.
  5. Tap the Value section on the FilterId row and input the desired FilterId value there, and then tap the check mark. The Behavior can be left as "Default", so that if the FilterId value is changed in the session context, the flowchart will update accordingly.
    You can also define some additional context variable values that are used by the QPR ProcessAnalyzer Presentation Object. After you are done, tap Close to apply the changes.
  6. Click the Save button on the toolbar on top to save the view. Saving a view will also save any unsaved changes to the panels in the view.
    PAPOTutorial.png


Add SVG Presentation Object

  1. Add an SVG Presentation Object to the panel by clicking the SVG Presentation Object button on the side toolbar.
  2. Click the Properties button on the SVG Presentation Object to open the SVG properties.
    OpenSVGProperties.png
  3. First, give a Name and optionally a Description for the SVG presentation object.
    SVGNameDescription.png
  4. Switch to the Presentation tab. On the Presentation tab, define the SVG code. You can use an external SVG editor first to create the image and save it to a file. Then, open the file in a text editor and copy and paste the svg code from the file to the "Define SVG code" field. Optionally, you can also define the SVG actions.
    SVGCode.png
  5. Click Close to see what the svg image looks like. If you need to make adjustments, you can return to the SVG tab and edit the SVG code there.
    SVGReady.png


Add a Repeater and repeated content to a panel

  1. Add a Repeater Presentation Object to the panel by clicking the Repeater Presentation Object button on the side toolbar:
    AddRepeater.png
  2. Click the Properties button on the Repeater:
    OpenRepeaterProperties.png
  3. After defining the Name, click the Datasets tab:
    RepeaterDefineDataset.png
  4. Type in an identifier for the dataset and click the check mark:
    RepeaterNewDataset.png
  5. Define the query for the dataset, and then click the Data Source tab:
    RepeaterProperties2.png
  6. Select the dataset you created earlier from the data source list and click Close:
    RepeaterDataSource.png
  7. To add the contents to be repeated, click the Edit button on the repeater:
    RepeaterEdit.png
  8. Add an HTML Presentation Object to the Repeater:
    RepeaterAddHTML.png
  9. Click the Properties button on the HTML Presentation Object to open the HTML Presentation Object Properties:
    RepeaterHTMLProperties.png
  10. After defining the Name for the HTML Presentation Object, click the Presentation tab:
    RepeaterHTMLProperties2.png
  11. Define the HTML code. In the HTML code, use the names of the data source columns as a context variable references in the format "{#ContextVariableReference}". For example, here the HTML Presentation Object will get values from the name and createddate columns in the Repeater data source:
    RepeaterHTMLCode.png
  12. Click Close a couple of times so that you are in the View Editor. The Repeater has now created an HTML Presentation Object for every row cell value in the Repeater data source, and the values from each row are now shown in place of the context variable references:
    RepeaterDone.png