Template Type: System template

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.

For a video guide to HTMLQueryResultView see our QueryDesign journey.

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.

 

HTML Content Tab

A HTMLContentTab is used to set up content in tab format. Content tabs are used in the HTMLTemplateDefinition, to create dedicated tabs with different types of content (in the Center tab in the Diagram Workspace – Classic Layout).

Title: This will be shown as the title of the tab. If nothing is specified, the name of the HTMLContentTab object will be shown on the tab.

Empty content text: If there is no content to show inside the tab, then this text will be shown.

Content field: This defines the content of the tab. It is possible to either specify a list of attributes to show or to link to other objects that defines the content.

Content field

There are a few different ways to specify the content of the tab, right click in the box to get the available options:

HTML Content Box

A HTMLContentBox is a contained box that holds some information. It can be placed in a side panel or inside a tab.

Collapsible: Defines if the box should be collapsible (Value: checked / unchecked)

Collapsed: Defines if the initial state of the box is collapsed.

Show counter: Defines if the box should display a counter to show how many links it contains. (Value: checked / unchecked)

Hide if empty: Defines if the box should be hidden if there is not content (Value: checked / unchecked)

Empty content text: If there is no content to show inside the box, then this text will be shown.

Title:  This will be shown on the title bar. If nothing is specified, the name of the HTMLContentBox object will be shown on the title bar.

Format: This defines how the information in the box should be shown. Values are Generic, List, Table.

Use Web Query: This defines how the information in the box should be shown. Values are Generic, List, Table.

Use a HTMLWebQuery to define a list of objects to show. This can e.g. be a list of all ExternalDocuments that are related to the current object in a specific way.

Content field:  This defines the content of the box unless a web query is selected. It is possible to specify a list of attributes to show.

  • Name: The content to be displayed.
  • Prompt: A prompt that helps the user understand what the content is.
  • Style:
  • Format: The format of the content of the content box.
    • Values are: CheckList: displays content from the diagram as a checklist. It is possible to select/deselect individual items, and select/deselect all items.
    • Chart
    • Spreadsheet
    • Fieldset
    • Table: displays content in a table format.
    • List: displays content in list format.
    • Gauge
    • Embed
  • Function:
  • Role: You can add a repository role to configure who can see the information.

A HTMLContentBox in inserted in a HTMLTemplateDefintion, in the left or right sidepanel.

A HTMLContentBox can also be used in the HTMLDashboardItems to collect a group of content, e.g. as part of a TableListView

The example to the right shows a HTMLDashbordItem, with multiple collapible HTMLContentBoxes (QualiWare 10.10).

Governance Conditional Message

A GovernanceConditionalMessage is used in a GovernanceWorkflow when you want to do a GovernanceTransition based on some event condition (GovernanceBoolList/Method).

Short description: Here you give a short description of the GovernanceConditionalMessage. This should be able to give the user an overview of the feature.

Level: Level is used to indicate the context where the conditional message is evaluated and executed:

  • Object: Context is object level, i.e. the conditional message should run for each object.
  • State: Context is the state of the object. A manager might want to be notified about all objects in a specific state.
  • Workflow: Context is the entire GovernanceWorkflow. A manager might want a weekly update about their governance tasks related to the GovernanceWorkflow.
  • Global

Event Condition: A condition for if the action(s) should run or not. The condition should return true or false with true meaning the action(s) will run.

Event Renew: This defines how often the GovernanceConditionalMessage should be repeated. The time is defined in minutes.

If Event Renew is set to 0, the GovernanceConditionalMessage will be run once the condition is met. It will be run when EventTracker is set to run.
Otherwise the Event Renew is the number of minutes from the first time the condition is met and the action(s) are executed to the next time the action(s) should be executed according to the setting for EventTracker specified on the HTMLPublisher.

E.g. EventTracker runs daily at 1am and registers that condition is met = the action will be run. If Event Renew is then set to 1440 minutes, the action will run once a day, when the EventTracker is set to run, until the condition is no longer true.

Configuration Filter: When does the condition apply – all configurations (none), base configuration, private workspace(s) or a named configuration

  • None – The configuration will not be considered when evaluating the condition and executing the action(s).
  • Base – Only the base configuration will be considered for evaluating the condition and executing the action(s).
  • PWS – All private workspaces will be considered for evaluating the condition and executing the action(s).
  • Named – Only the named configuration will be considered for evaluating the condition and executing the action(s).

Rule to define Duration: An object is moved from GovernanceState to GovernanceState using different kinds of transitions, e.g. a GovernanceConditionalMessage. When a transition moves an object in to a GovernanceState the object will get a date set that is the limit for how long the object is allowed to be in the GovernanceState. The limit is calculated based on what the duration is set to in the transition leading in to the GovernanceState.

The date limit can be used to handle SLAs on objects. E.g. an email can be send out to the responsible of the object when the SLA is approaching or is already passed.

  • Number of days:
    • Set a specific number of days for the duration. This will be used for all objects handled by this transition.
  • Use the following Attribute
    • Use an attribute on the object to set a specific number of days for the duration. Use this to have different durations for different objects.
    • The attribute on the object will have to contain a number that can be translated into an integer.
  • Use a date attribute
    • Use a date attribute on the object to set a specific date for when the object should no longer be in the next GovernanceState. Use this to have different dates defined for different objects.
    • The date attribute will have to be in a date format.

The number of days defined in this field decides the number of days you have to finish the next state. If you have an SLA it will influence the days to finish like this:

  1. If your days from “Beginning In State” is 5 (this is set on the GovernanceWorkFlow’s attribute “Initial State Duration”), and if your SLA is a positive number 2. Then you will have 7 (5+2) days to finish the transition to next state, and the governance task will be green the first 5 days, then yellow for the next 2 days and then red until handled.
  2. If your days from “Beginning In State” is 5 and if your SLA is a negative number -2. Then you will have 5 days to finish the transition to next state, and the governance task will be green for 3 days, yellow for 2 days and then red until handled.

Action: The action(s) to be executed, if all conditions are met.

Asynchronously: If checked, the action(s) will run asynchronously.

Governance Transition

GovernanceTransition is used in a GovernanceWorkflow from one GovernanceState to another. The transition can change the State but also do a number of Actions before and after the transition.

Short description: Here you give a short description of the GovernanceTransition. This should be able to give the reader an overview of the Transition.

Condition: The condition will return either true or false. It uses GovernanceBoolMethod and GovernanceBoolList.

If true, then it is possible to do the transition. If false, then it is not possible to do the transition.

In some situations when the transition is not possible, the transistion will not be shown to the user.

Message Type: The following types is available:

  • Progress (bold green)
  • Alternative (green
  • Rewind (red)
  • Conclusive (dotted and orange)

There can only be one Progress message type (illustrated by the dark green arrow), all other transitions must be Alternative paths (illustrated by the green arrow). The red arrow is a rewind transition. The orange dotted arrow is the conclusive transition to the end state.

Rule to define Duration: An object is moved from GovernanceState to GovernanceState using different kinds of transitions, e.g. a GovernanceConditionalMessage. When a transition moves an object in to a GovernanceState the object will get a date set that is the limit for how long the object is allowed to be in the GovernanceState. The limit is calculated based on what the duration is set to in the transition leading in to the GovernanceState.

The date limit can be used to handle SLAs on objects. E.g. an email can be send out to the responsible of the object when the SLA is approaching or is already passed.

  • Number of days:
    • Set a specific number of days for the duration. This will be used for all objects handled by this transition.
  • Use the following Attribute
    • Use an attribute on the object to set a specific number of days for the duration. Use this to have different durations for different objects.
    • The attribute on the object will have to contain a number that can be translated into an integer.
  • Use a date attribute
    • Use a date attribute on the object to set a specific date for when the object should no longer be in the next GovernanceState. Use this to have different dates defined for different objects.
    • The date attribute will have to be in a date format.

The number of days defined in this field decides the number of days you have to finish the next state. If you have an SLA it will influence the days to finish like this:

  1. If your days from “Beginning In State” is 5 (this is set on the GovernanceWorkFlow’s attribute “Initial State Duration”), and if your SLA is a positive number 2. Then you will have 7 (5+2) days to finish the transition to next state, and the governance task will be green the first 5 days, then yellow for the next 2 days and then red until handled.
  2. If your days from “Beginning In State” is 5 and if your SLA is a negative number -2. Then you will have 5 days to finish the transition to next state, and the governance task will be green for 3 days, yellow for 2 days and then red until handled.

Actions: When doing the transition, you can define actions to be carried out either before the transition or after. When transitioning an object, sometimes it is needed that actions are done before and/or after the transition happens. E.g. an attribute needs to be filled before an object is moved from one GovernanceState to another. If this attribute needs to be filled for all objects, it is possible to set a pre action that handles this automatically.
Both pre and post attributes can handle GovernanceActionList and GovernanceActionMethod, see more on GovernanceActions.

Governance Transition – Authority

Configuration filter: You can filter on which configuration it is possible to do the transition. Base Configuration, PWS or a named configuration (this shows a list of your configurations).

Configuration execution: This makes it possible to have the transition be carried out in another configuration than the one where the transition is triggered. This can for example be used when you want the development of a process to be done in a private workspace and only have approved processes visible for the whole organization.

Authority Required: Not all users should be able to interact with all GovernanceTransitions and GovernanceStateFeatures. The options for Authority Required helps configure which level of authority the user should have in order to execute a transition or feature.

  • Everyone (Everyone authorizes everyone to do the transition.)
  • Any Role (Any Role means any GovernanceRole related or included in the GovernanceWorkFlow.)
  • Current Role (The default authority is the Current Role. This is the governance role that the state the transition is coming from is inside.)
  • Only Master Role (Only Master Role is the role you set on the GovernanceWorkflow, and you can also specify other specific roles together with the master role in the list next to the authority levels.)

Extended authentication: If extended authentication (‘digital signature’/login) is required, then it can be enabled:

  • None (No extended authentication)
  • Password Authentication (A login box with password is shown)
  • Full Authentication (A login box with full authentication is shown)
  • Allow Changed User (If the “Allow change user” is also enabled, then a login box with both user name and password is shown)

Authentication text: Is for writing a descriptive text associated with the login window.

Governance Transition – Detail

Visual Name: This will be shown as the name of the button. If this is not defined, then the name of the GovernanceTransition object will be shown instead.

Please consider how the text is formulated to help the user to know what will happen when the button is clicked.

Icon on web: An icon to show on the button. An icon can be a helpful indicator to a sighted user about what will happen on clicking the button.

Comment: An option for the user to add a comment related to the transition. This comment will be stored with other governance information about the object (it will not be a comment object). The comment can be shown in e.g. the Governance History information of the object.

  • Skip: User will not be able to add a comment.
  • Optional: User will be presented with option to leave a comment but is able to complete the transition without writing anything in the comment field.
  • Mandatory: User will be forced to leave a comment in order to complete the transition. There are no checks on the actual content of what the user writes in the comment field.

Web feature: These options will define what happens when the user clicks the transition button in the web interface.

Web Dialog: Use this option for when a webform is needed during a transition. The webform will only be able to handle the current object.

  • Customization: Use this to define which HTMLDialogLayout will be used for the webform to be opened. If left empty, the default HTMLDialogLayout or metamodel defined webform will be used.
  • Select Dialog: If checkmark is checked, it is possible to link a specific HTMLDialogLayout to be used for the webform, without using customization.
  • It is recommended to use customization for defining HTMLDialogLayout.

Web Service: This is used when you want the transition to run.

Custom script: When this is enabled, you will be able to write custom JavaScript code to be run when doing the transition. (N.B. This should be used with caution.)

Governance State Feature

The GovernanceStateFeature placed on the GovernanceState contains all related buttons on the web for that particular GovernanceState in a GovernanceWorkflow.

Short description: Here you give a short description of the GovernanceStateFeature. This should be able to give the reader an overview of the Feature.

Condition: Should some condition (GovernanceBoolMethod/List) be true before the feature can be used/is visible.

Scope: Where does the feature apply – Only Web or QLM or both?

QLM feature: If you want a feature to be available from QLM and web (or just QLM) you need a corresponding QCL code.

Governance State Feature – Authority

Configuration filter: You can filter on which configuration it is possible to do the transition. Base Configuration, PWS or a named configuration (this shows a list of your configurations).

Configuration execution: This makes it possible to have the transition be carried out in another configuration than the one where the transition is triggered. This can for example be used when you want the development of a process to be done in a private workspace and only have approved processes visible for the whole organization.

Authority Required: Not all users should be able to interact with all GovernanceTransitions and GovernanceStateFeatures. The options for Authority Required helps configure which level of authority the user should have in order to execute a transition or feature.

  • Everyone (Everyone authorizes everyone to do the transition.)
  • Any Role (Any Role means any GovernanceRole related or included in the GovernanceWorkFlow.)
  • Current Role (The default authority is the Current Role. This is the governance role that the state the transition is coming from is inside.)
  • Only Master Role (Only Master Role is the role you set on the GovernanceWorkflow, and you can also specify other specific roles together with the master role in the list next to the authority levels.)

Extended authentication: If extended authentication (‘digital signature’/login) is required, then it can be enabled:

  • None (No extended authentication)
  • Password Authentication (A login box with password is shown)
  • Full Authentication (A login box with full authentication is shown)
  • Allow Changed User (If the “Allow change user” is also enabled, then a login box with both user name and password is shown)

Authentication text: Is for writing a descriptive text associated with the login window.

Governance State Feature – Detail

Visual Name: This will be shown as the name of the button. If this is not defined, then the name of the GovernanceTransition object will be shown instead.

Please consider how the text is formulated to help the user to know what will happen when the button is clicked.

Icon on web: An icon to show on the button. An icon can be a helpful indicator to a sighted user about what will happen on clicking the button.

Web feature: These options will define what happens when the user clicks the transition button in the web interface.

Web Dialog: Use this option for when a webform is needed during a transition. The webform will only be able to handle the current object.

  • New Object: When checked, a new object will be created. When not checked, the current object will be opened for editing.
  • Create In memory object:
    • Template: Used in combination with the New Object checkmark. Specifies the Template to use for the new object.
    • Link: Used in combination with the New Object checkmark. Specifies how the new object will be link to the current object.
  • Customization: Use this to define which HTMLDialogLayout will be used for the webform to be opened. If left empty, the default HTMLDialogLayout or metamodel defined webform will be used.
  • Select Dialog: If checkmark is checked, it is possible to link a specific HTMLDialogLayout to be used for the webform, without using customization. It is recommended to use customization for defining HTMLDialogLayout.

Web Service: This is used when you want the transition to run.

Custom script: When this is enabled, you will be able to write custom JavaScript code to be run when doing the transition. (N.B. This should be used with caution.)