Report Definition

Report definition is used to generate reports for e.g. a diagram type, and make them available on the web.

There is a set of standard reports included in the standard configuration, click here to see more about the standard reports.

Reports are designed via the template ReportDefinition.

Reports are always generated dynamically based on the content where they are executed. For example, if you click on the report button on a diagram, it will use the objects and their information contained on the diagram. To make this possible it is necessary to define what variables the ReportDefinition should gather and where it should place them in the report.

Designing a report consists of four stages: Designing the queries, arranging the attributes in the main report, designing sub-reports and finally applying advanced formatting.

  1. In the design phase it is necessary to structure the data for the report. This is done via SQL. To remove the need of learning SQL QualiWare has introduced a Query Designer that helps users build SQL scripts and tables automatically based on a graphical diagram.
  2. The queries are then used as input for the ReportDefinition where the individual attributes can be re-arranged graphically.
  3. When designing a Query that needs to read the attributes of objects that are referenced in a multi-link field it is necessary to create sub-queries and sub-reports. Sub-reports gather and organize the attributes for the underlying objects and then are themselves inserted into the main report, just like the other attributes.
  4. When the data has been defined, organized and arranged in the report it is necessary to apply advanced formatting to the report for aesthetic reasons.

See this detailed guide for more.

Once created the report can be added to the relevant template in the Template Definition, to make them available on the web, via the “Print icon” in the Toolbar.

Notification Template

A notification template is used for sending standard emails and notifications on the QualiWare app. – and with GovernanceGetMethods the data can be dynamically taken from the relevant object.

Type: Check if the notification is an email of notification in mobile App

Priority: Priority set on the email

Condition: It is possible to add a condition (or a list of conditions) that needs to evaluate to true before the notification is send.

To: Who is the receiver of the notification – it can be a static written email or use a GovernanceGetMethod

Subject: What is the subject header of the email notification – GovernanceGetMethod can be used again to retrieve data dynamic from the object

Message: Text of the email notification– GovernanceGetMethod can be used again to retrieve data dynamic from the object

Signature: Signature on the email

Insert a Dynamic Value (governance get method) in the text

There is a whole set of Governance Get Methods included in the available standard governance workflows.

Right click to insert a governance get method in the text in an email field.

Once you have selected “Insert Dynamic Value” a list of GovernanceGetMetods come up, and you can select the method.

If you have expanded the text editor (F8), you can right-click and select “Insert Link” to choose the GovernanceGetMethod.

Notification Templates – Mail Setup

Mail Setup: You setup the mail in the QEF Admin Console and insert it into this field.

Email Domain Filter: If you want to filter which emails it is allowed to send to, select the Domains here.

Delivery Options:

  • “Do not wait to send (fast)”: which means that emails (notifications) will be sent immediately. If something goes wrong in sending the email, and you haven’t set up the QCL Engine service “EmailSender” in the HTMLPublisher, then the email will never be sent.
  • “Use ‘HTTP Sender Service’”: will only send emails if the EmailSender QCL service has been added to the HTMLPublisher.

 

Model Presentation

The ModelPresentation is an attempt to make it easier for the end-user to understand the meaning of the model when viewing it on the Web.

The ModelPresentation consists of a series of models or model parts shown in a sequence on the web. The sequence may include pictures, sound, video or text to explain the view of the model.

From the main settings, you can configure the scope of the presentation:

  • Relevant for:
    • Here you map the model that is subject to the presentation
  • Content Selection:
    • Here you select the content of the presentation (All revisions, Revisions across configurations, All language variants, Custom selection, Walkthrough)

Once the ModelPresentation is created and associated with e.g. a diagram in the “Relevant for”, the presentation becomes available on the web, as a tab in the classic view.

The presentation gives the user a standard set of “video control buttons”, so it is possible to jump forward, backward, stop the automatic sequencing of pictures and so on.

This example shows a definition of a ModelPresentation that fades through the all revisions of the BusinessProcessNetwork.

The custom selection is a selection of diffrent models, which can be shown in the model presententer in relation to content selected in the “Relevant for”:

Another example of a ModelPresentation is the illustrated walkthrough of a diagram. Here it is a CustomerJourneyMap that shows the journey of a persona interacting with our enterprise. Each interaction is illustrated by a TouchPoint, and the ModelPresentation includes real life explanation, photos, etc. to illustrate the journey.

As illustrated in the example above with the customer journey, it is possible to show pictures and video associated to the object.

You can specify what attributes should be shown where in the “Attributes” tab.

You specify the layout of the presenter on the “Layout” tab.

Interest Group

InterestGroup is a template that can be used to collect a set of organizational objects into a group.

In the standard Metamodel you can include the following templates types into an interest group:

  • Person
  • OrganizationUnit
  • InterestGroup
  • Postion
  • Role

An InterestGroup can be used to in relation to other objects in the repository, in relations to GovernanceWorkFlows or AcknowledgeLists.

 

HTML Tile

The HTMLTile template is used on one or more HTMLDesktop(s) on the collaboration platform.

It is possible to configure the appearance and nature of the tile via the HTMLTile-template.

Among many things you can specify the title, color, size, description text, as well as link it to other content in the repository, e.g. a diagram or a HTMLQueryResultView.

Example of a tile on the web:

HTML Template Definition

The HTML template definition defines how and what information is displayed on the web for each template-type.

In QualiWare 10.8 a new Dashboard layout has been introduced. You can create one or multiple dashboard(s) for a diagram template-type. The dashboard(s) are associated on the Dashboard Tab:

The Dashboard are configured using the templates:

The “Left”, “Center” and “Right” tabs specifies the content on the classic diagram workspace, shown on the example below.

The left window (1) of a diagram workspace is configured on the Left tab, using HTMLContentBox and other HTML-templates:

The Center tabs (2) of a diagram workspace in configured on the Center tab, using HTMLContentTab and other HTML-templates :

The right window (3) of a diagram workspace is configured on the Right tab, using HTMLContentBox and other HTML-templates :

On the Analytics tab, you can configure which “Social Behavior Warehouse” tabs should be available on the model.

The Behavior tab, specifies the behavior of a template, e.g. how should a link to an object of the template behave when clicked.

Target: This is how the link will open when clicked.

  • Self: This will open the object page in the same browser window.
  • New Window: This will open the object page in a new browser window or tab depending on the browser setup.
  • IFrame: This will open the object in an iFrame pop-up window using the Popup Settings configuration.
  • FancyBox: This will open the object in a Fancybox pop-up window using the Popup Settings configuration.

Title: This specifies what should be shown as the title of the object being shown.

  • Page header: The header of the page or popup window of the object. This can be static or dynamic text. Dynamic text is indicated by curly braces and will be evaluated client side in JavaScript.

Popup settings:

  • Width: The width of the popup window.
  • Height: The height of the popup window.
  • Popup content: A list of HTMLContentTables or HTMLContentTabs contains information about what is shown in the popup window. If nothing is specified here, the HTMLPublisher will use the information specified in the Center tab of the template definition.

JumpOnLink: JumpOnLink functionality can be used to forward the user if certain criteria are met. This is typically used when e.g. a BusinessProcess can be broken down in to subprocesses. It allows the user to jump directly to one of the subprocesses without having to open the properties of the BusinessProcess first.

  • Attribute(s): This is an attribute that is part of the object that this template definition is for. When the user clicks on the object, this attribute will be used to calculate where the user is taken to on click.
    • If the attribute contains exactly one link then the user will be taken to the target of that link when clicking the object.
    • If the attribute contains more than one link, then jumping is disabled.
    • If more than one jump attribute is defined, then the whole set of resulting links are evaluated. If only one link is available in the set, then jumping happens. If more than one link is available in the set, then jumping is disabled.
    • E.g. BusinessProcess can be set up to jump on BreaksDownTo. When the user clicks a BusinessProcess the user will be redirected to the link in the BreaksDownTo attribute (if only one link is available).
  • And attribute(s) is empty:
    • If the specified attribute is not empty the JumpOnLink functionality will be ignored. The attribute specified here should be different than the attribute for JumpOnLink.
    • E.g. BusinessProcess can be set up to jump on BreaksDownTo when ShortDescription is empty. If ShortDescription has content then the BusinessProcess will follow the behavior specified in Target settings.

Tooltip settings: The tooltip is used to display information about the object when a user hovers the object link.

Example of a BusinessProcessNetwork tooltip appearing when a BusinessProcessNetwork is hovered on the web.

  • Enable: Enable or disable the tooltip feature.
  • Title (attribute): The attribute that should displayed at the top of the tooltip.
  • Width: The width of the tooltip window.
  • Tooltip content: A list of attributes to be displayed in the tooltip window.

 

 

 

 

 

 

 

App settings:

  • App content: This specified what should be shown in the app. It links to a HTMLContentTable.
    • If nothing is specified for the template then the app will look for the settings for DefaultDiagram/DefaultObject template definitions and use those.
    • If nothing is specified on the template definition for the template or for DefaultDiagram/DefaultObject the all attributes are shown.

OnClick

  • Execute javascript: This can be used to execute a JavaScript function when the object is clicked.

On the Smart Capture tab, you can link Model Generator Settings to the template definition. The settings are used for the table to model feature in the web-modeler (introduced in QualiWare 10.8).

Table-to-model

  • Inherit default settings: Tick the box to inherit the settings from the Smart Capture Settings on the HTMLPublisher
  • Model generator settings: Insert specific HTMLModelGeneratorSettings to the template definition

Once you have made changes to the template, you should click “Apply” and “Publish” to implement the changes on the Web.

The HTMLTemplateDefinitions are included in the HTMLPublisher.

HTML Query Result View (QRV)

HTMLQueryResultView is a way to query for a list of objects to be displayed.

A HTMLQueryResultView (also known as QRV) is a table that is used to present the result of a query in the web solution. It is often accessed from the leftmenu, or in a HTMLContentTab.

An example of a QRV is the list of BusinessProcessNetworks available in the standard left menu.

 

The QRVs are configured in the QLM windows client, using the HTML QueryResultView Template.

The template contains three ways of defining the view of the data: Explorer, Select, and MultiLink.

The Explorer is the essential part of the QRV, and it is descibed in detail below. The Select and MultiLink settings are used by Client Side WebForms.

Explorer Settings

Explorer Settings are used to configure how data is displayed in a table on web. The Explorer QRV is a table meant for being displayed using the full size of the page. So the table will be the main content. It can also be used as an embedded content table for displaying content related to the main content, e.g. show an overview of Risks related to a BusinessProcessNetwork.

Buttons

Buttons can be used to add options for handling the content of the table. There is a set of standard buttons available to quickly add functionality for the most common actions. The standard buttons can be added be right clicking in the button window, cf. figure above.  It is also possible to create custom functionality.

Standard buttons

  • Create: Enables the user to create a new object of the template associated to the QRV in the filter settings
  • Edit: displays an Edit button to the right of each object in the QRV
  • Delete: displays a Delete button to the right of each object in the QRV
  • Rename: displays a Rename button to the right of each object in the QRV
  • 3D Visualize: add a visulisation button to the QRV.

Available settings for buttons:

  • Buttons
    • Client Side Grid: Create, Edit, Delete, Rename, Visualization 2D, Visualization 3D, Cluster, Custom.
    • Server Side QRV: Create, Edit, Delete, Rename, Export, Custom (For Client Side Grid: Export functionality is handled by grid settings)
  • Text: The text displayed on the button.
  • Tooltip: Tooltip with more information to the user.
  • Display Mode: Where to display the button.
    • Empty value: Button is displayed same as Toolbar.
    • Toolbar value: Button is displayed in the toolbar of the QRV.
    • Inline: Button is displayed in a column in the right side of the QRV. One button is displayed per row (object) of the table.
  • Command: Command associated with the button
  • Command Arg:  Argument associated with the command
  • Role: You can configure the button to be available for one or more roles in the repository
  • Condition: You can specify a condition for when the button shoudl be available
  • Image: You can configure an icon for the button.
  • Export Type: Defines if it should be possible to export the content of the table.
    • Possible values: Csv, Excel, Custom

Columns

Right click the window to add a column. Press F2 to get available option (see figure above).

  • Custom input…: choose this option to insert text ‘manually’
  • Audit attribute…: choose this to select an audit attribute from the attribute list

  • Template attribute…: select a template from the list to choose a template specific attribute for the Query

Once you have selected a template you will get the full list of attributes available. It is possible to expand the window to see and sort by attributes of the different sub dialogs of the object, see example below with the BusinessProcessNetwork

Once you have selected the attribute it will appear in the column list.

It is possible to configure which columns are in the table along with basic settings for the content, when it is displayed on the web.

  • Column header: The text of the header for the column, to be displayed when presented on the collaboration web.
  • Column attribute: The attribute of the column. This one is combined with the column filter in Explorer Filter to define the content for the column.
  • Width: Width of the column. It can be defined using pixels or percentages.
    • Using pixels can produce a horizontal scrollbar if total width of all columns exceed the content width.
    • Percentages will be the percentage of the total width of the table. If all column widths are defined in percentages, the total width of the table will not exceed 100%.
  • Format: If cells of the column can contain more than one link (MultiLink or multiple SingleLinks), then the format can be defined as List to diplay the links in list format.
    • Possible values: Default, List
  • Vertical align: Vertical alignment of the content of each cell in the column.
    • Possible values: Top, Middle, Bottom.
  • Plain text: If the content of each cell in the column should be displayed as plain text. This can be used in cases where the content is links. When content is plain text it is not clickable.
  • Filtering: specifies if the column is filterable
  • Filters:
    • Between; NotBetween; Contains; DoesNotContain; EqualTo; NotEqualTo; StartsWith; EndsWith; IsEmpty; NotIsEmpty; GreaterThan; GreaterThanOrEqualTo; LessThan; LessThanOrEqualTo
  • Filter type:
    • Default; Date; Number
  • Sort/Filter by:
    • Value; Auto; LinkedObjectName
  • Data format: Define the format for the content of the cells in the column.
    • For simple formats, define the format directly in this field.
    • For advanced formatting, define which value mapping should be used. Read more about value mapping in the Explorer Grid Settings.
  • Script: You can insert a script
  • Link value / Ref. attr: 

Explorer Parameters

Parameter settings

  • Use script: Select to use script
  • Filter command:
    • Client Side options: Choose ClientSide.GridControl to display data in a client side table. This is the recommended setting. When choosing ClientSide.GridControl, the Explorer Filter options will be enabled.
    • Server Side options: There are a list of predefined commands available for fetching and displaying data in a server side table.
  • Fill command: Commands for the different actions. (Disabled for Client Side Grid)
  • Filter settings: Here you specify Template filter and Query parameters (Disabled for Client Side Grid.)
  • Initial sorting order: Defines the initial sort order of the data in the table. Available options are calculated from the columns set in Explorer Settings.
  • Allow paging: Allows dividing the result in multiple pages
  • Paging size: The number of items on each page of the table.
  • Show icon column: The first column of the QRV will show an icon for the object of the row. (Disabled for Client Side Grid.)
  • On doubleclick: Defines which action will be executed on double clicking a row. Options are calculated based on buttons defined for the QRV. (Disabled for Client Side Grid.)

Explorer Filter

Configure the filters for content of the table.

Row filter: Defines what each row of the table should represent.

  • Most simple filter is a template, i.e. show one Activity per row.
  • Advanced filter could be show one BusinessProcess where the current user is responsible for the BusinessProcess per row. The filter is used as a WHERE clause in a QSQL statement.

Column filter: The column filter specifies content of a table column. Each column specified on the Explorer Settings tab should be present in the column filter.

To add a column filter right click the window and select from the list of attributes defined in the Explorer Settings above. It will insert the basic settings for the columns (it will loop already defined columns and insert one filter per column).

 

  • Query Column: This should match a column attribute from the Explorer Settings tab. This is what created the link to the column settings.
  • Column Rule: The content of the column. This can be a simple connection like an attribute on the object, e.g. Name. Or it can be a more advanced connection like an attribute on an object linking to the row object, e.g. CurrInst-<Concerns->HasResponsible.
  • Column Filter: This will filter the content specified in Column Rule. If Column Rule uses an advanced connection, it can be useful to filter on the template of the resulting content, e.g. only show ChangeRequests. Example: CurrInst-<Concerns=’ChangeRequest’ Having a Column Rule of CurrInst-<Concerns can result in a list of both ChangeRequests and Risks (and other templates) and that might not be what is wanted.
  • Column Format: The format of the content. This will have impact on how the content is displayed.
  • Column Sorting: If the content of a cell contains multiple links, then the sorting can be set to define in which order the links will be shown.

Example of a QRV from the standard, showing all BusinessProcessNetworks in the repository:

Explorer Grid Settings

Grid parameters

Configure settings for how the table is displayed and if further options should be available to the user.

Right click the window to add standard parameters.

Standard Grid parameters (standard settings).

  • AllowCopy: If it should be possible to copy content of the table.
  • AllowRefresh: If a button should be shown to allow the user to refresh content of the table.
  • ColumnMenu: If a column menu for sorting and show/hide column should be available to the user.
  • Expandable: If each row should be expandable to display more information about the row object.
  • ExpandContent: The content that will be shown when expanding the row. Simple markup can be used to format the information.
  • ExpandContentEmptyText: If content is not available when expanding the row, this text will be displayed.
  • ExportToExcel: If button for exporting the content of the table to Excel should be available.
  • ExportToPdf: If button for exporting the content of the table to PDF should be available.
  • Filterable: If it should be possible to filter each column of the table. Each column will have an input in the column header for defining a filter.
  • FilterToggle: If it should be possible to show/hide the filter inputs for the columns.
  • Groupable: If it should be possible to group columns by dragging and dropping a column to the top area of the table.
  • Resizable: If the width of the columns should be resizeable.
  • Reorderable: If it should be possible to reorder the columns by dragging and dropping a column. The order of the columns will be reset when reloading the table.
  • Selectable: If rows should be selectable.
  • Sortable: If the columns should be sortable by clicking the column header.
  • TableValued:

It is possible to adjust the values by pressing F2 and write e.g. true or false to enable/disable the different parameters.

I.e. the parameters determines what is enabled in relation to the QRV list on the web-view, including the content in the toolbar in the upper right corner.

(The Visualize button in the toolbar is added through the standard buttons under the Explorer Settings.)

Value mapping

In some cases it wil be necessary to map content of a cell before it is shown in the cell. This is useful when content of a checkmark or radio button should be displayed. Content of checkmarks and radio buttons are saved as empty, 0 and 1 in the database which is not useful information to a user. Value mapping can be used to display empty and 0 values as No, False, or similar and 1 as Yes, True, and simliar.

Value mapping is defined as a JSON object and can contain mapping information for multiple columns of the table.

Example of a value mapping used to color risk likelihood according to their value:

Once the value mapping have been defined they can be related to the coloumns in Explorer Settings view:

Grid styles

If specific styling is needed based on on values in the table but values are not needed to be formatted, then grid styles can be used to define styles for the grid. Grid styles use standard CSS.

External data source

It is possible to define an external data source (GenericQuery) for defining more advanced way of getting data to be displayed in the table. When using an external data source, most settings in the QRV object will be set when using the Build button. The Build button examines the settings of the linked GenericQuery and defines settings for the QRV object.

If the GenericQuery is updated, then the QRV object should be rebuilded by using the Build button. The rebuilding will update columns defined by the GenericQuery but will attempt to keep any settings that have been changed in the QRV object. E.g. grouping columns, width of column and similar.

When using an external data source, some settings will be disabled in the QRV object. These settings will be controlled by the GenericQuery.

Read more about Query Design and GenericQuery here.

HTML Publisher

The HTMLPublisher Template contains all settings regarding the configuration of the Web. It collects all the settings for the collaboration platform on the web.

The HTML publisher setting can be accessed in QLM via the HTML icon on the Standard toolbar in QLM.

or by using the shortcut CTRL+H.

The HTMLPublisher collects all settings for the web.

From the HTMLPublisher tab, it is possible to specify:

  • Menu settings
  • Styling, including Logo in the top left corner
  • Available Configuration(s) on the web
  • Languages
  • Additional settings and IIS settings

  • The Template Definitions tab includes the Template Definitions with HTML-settings for the selected templates, and thereby the “look and feel” for how the selected templates is presented on the web

  • Available Navigation Buttons on in the Top right menu

The Model Generator Settings for the table to model feature in the web-modeler (introduced in QualiWare 10.8) is setup through Smart Capture Settings tab:

HTML Mega Menu Item

The HTML Mega Menu Items are used to compose a HTMLMegaMenu.

The Mega Menu is composed of 3 levels. Each level is a HTMLMegaMenuItem.

 

HTMLMegaMenuItems on the top level can be associated with an Image.

It is possible to define role access on each of the HTMLMegaMenuItems.

Right click the role window to add a role:

The available roles are specified in the Repository Administrator.

As can be seen in the selection box above, it is possible to select between two instances for each available role in the repository. The first “:” means that menu item will be visible/accessible in the menu if the user has access to the role. The second “=”  means that the menu item is visible/accessible when the user has selected the role.

Menu Items on the lowest can be associated to all kind of items such as HTMLQueries, Spreadsheets, Diagrams, etc.

It is also possisble to link a HTMLMegaMenuItem to an URL:

HTML Embedded Content

The HTMLEmbeddedContent template is used to embed content on a web page. This content could be e.g. a BusinessChart or a QRV. Inserting a BusinessChart allows for showing statistics related to the current object.


Concerns: The object that contains information about what should be shown.

Url: The URL can be to a file that can use the attributes specified to display content in a special way. E.g. there is a .aspx file that specifies how a BusinessChart is shown.

External: If the content comes from an external source, this should be checked.

Attributes: The attributes to be used by the URL. This can e.g. be the repository ID, configuration ID or object ID.