Difference between revisions of "Editable Data Grid"

From Mea Wiki
Jump to navigation Jump to search
Line 13: Line 13:
 
|-
 
|-
 
||query
 
||query
||Query parameter for the QPR Suite Web Service query to get the rows to the data grid.
+
||Query parameter for the QPR Suite Web Service query to get the rows to the editable data grid. More information: http://kb.qpr.com/qpr2017-1/index.html?queryobjects.htm.
 
|-
 
|-
 
||sortby
 
||sortby
||Sorting parameter for the QPR Suite Web Service query to get the rows to the data grid.
+
||Sorting parameter for the QPR Suite Web Service query to get the rows to the editable data grid.
 
|-
 
|-
 
||queryoptions
 
||queryoptions
||Options parameter for the QPR Suite Web Service query to get the rows to the data grid.
+
||Options parameter for the QPR Suite Web Service query to get the rows to the editable data grid.
 
|-
 
|-
 
||columns
 
||columns
||Array of objects where each represent a column in the editable data grid.
+
||Array of objects where each represent a column in the editable data grid. Following properties can be used:
 
{| class="wikitable"
 
{| class="wikitable"
 
!'''Property'''
 
!'''Property'''
Line 28: Line 28:
 
|-
 
|-
 
||attribute
 
||attribute
||QPR Suite Web Service attribute name.
+
||QPR Suite Web Service attribute name. List of available attributes: http://kb.qpr.com/qpr2017-1/index.html?supported_parameters.htm.
 
|-
 
|-
 
||attributeParameters
 
||attributeParameters
||Parameters for the attribute.
+
||Parameters for the attribute. For example, ''value'' attribute supports ''period'' and ''series'' parameters, which are defined as follows: ''period=Q1/2018,series=ACT''.
 
|-
 
|-
 
||headerText
 
||headerText
Line 38: Line 38:
 
||type
 
||type
 
||
 
||
* '''textbox''': shows a textbox for storing string values.
+
* '''checkbox''': shows a checkbox, which is used for storing two possible values. The possible values are defined in '''trueValue''' and '''falseValue''' properties.
* '''numericbox''': shows a textbox for numeric values. It's not possible to input textual data.
+
* '''date''': shows a date selector that can store values using XML date format (e.g. 2018-10-05T16:26:42). Other date type of data than the Metrics date series, use the XML date format.
 
* '''dropdown''': shows a dropdown list where user can select from a list of predefined items. The items are defined in the '''dropdownoptions''' property.
 
* '''dropdown''': shows a dropdown list where user can select from a list of predefined items. The items are defined in the '''dropdownoptions''' property.
 
* '''metricsdate''': shows a date selector that can store dates to Metrics date type of series.
 
* '''metricsdate''': shows a date selector that can store dates to Metrics date type of series.
* '''date''': shows a date selector that can store values using XML date format (e.g. 2018-10-05T16:26:42). Other date type of data than the Metrics date series, use the XML date format.
+
* '''numericbox''': shows a textbox for numeric values. It's not possible to input textual data.
* '''checkbox''': shows a checkbox, which is used for storing two possible values. The possible values are defined in '''trueValue''' and '''falseValue''' properties.
+
* '''textbox''': shows a textbox for storing string values.
 
|-
 
|-
 
||dropdownOptions
 
||dropdownOptions
||Options for the dropdown menu. Only used when '''dropdown''' is checkbox.
+
||Selectable options for the dropdown menu as an array. Only used when '''type''' is dropdown. The array has the following properties:
 
{| class="wikitable"
 
{| class="wikitable"
 
!'''Property'''
 
!'''Property'''
Line 52: Line 52:
 
|-
 
|-
 
||label
 
||label
||Text visible to user
+
||Visible text in the dropdown list.
 
|-
 
|-
 
||value
 
||value
||Text to store to QPR Suite
+
||Attribute value to store to QPR Suite when an item is selected in the dropdown list.
 
|}
 
|}
  
Line 67: Line 67:
 
||validationRules
 
||validationRules
 
||
 
||
It's possible to define validation rules for each column. Following validation rules are available:
+
Validation rules for the column. Provided values must pass the validations so that they can be saved. Following validation rules are available:
 
* '''required''' (boolean): Value is required, i.e. it cannot be empty.
 
* '''required''' (boolean): Value is required, i.e. it cannot be empty.
 
* '''minlength''' (integer): Minimum number of charactes in a textual value.
 
* '''minlength''' (integer): Minimum number of charactes in a textual value.
Line 96: Line 96:
 
[other syncfusion settings]
 
[other syncfusion settings]
 
||
 
||
https://help.syncfusion.com/api/js/ejgrid#members:columns
+
All Syncfusion datagrid settings can be used: https://help.syncfusion.com/api/js/ejgrid#members:columns
 
|-
 
|-
 
|}
 
|}
 
|-
 
|-
 +
|-
 +
||
 +
[other syncfusion settings]
 +
||
 +
All Syncfusion datagrid settings can be used: https://help.syncfusion.com/api/js/ejgrid#members:columns
 
|}
 
|}
  

Revision as of 19:17, 17 February 2018

Editable Data Grid is a table, that shows data from QPR Suite Web Service, and the data can also be edited. QPR Suite Web Service properties define which kind of data can be edited. Mainly QPR Metrics, QPR Portal action forms and QPR Suite user management data can be edited, but not QPR ProcessDesigner or QPR EnterpriceArchitect.

Data shown in the data grid is fetched using QPR Suite Web Service query, where each row is linked to one object and each column is linked to an attribute in the Web Service.

Note that, the editable data grid does not use datasets to fetch data.

Property Description
selectedRowVariable Local context variable where currently selected row's object id of stored. Note that the selected row doesn't change, when the context variable is changed from somewhere else.
query Query parameter for the QPR Suite Web Service query to get the rows to the editable data grid. More information: http://kb.qpr.com/qpr2017-1/index.html?queryobjects.htm.
sortby Sorting parameter for the QPR Suite Web Service query to get the rows to the editable data grid.
queryoptions Options parameter for the QPR Suite Web Service query to get the rows to the editable data grid.
columns Array of objects where each represent a column in the editable data grid. Following properties can be used:
Property Description
attribute QPR Suite Web Service attribute name. List of available attributes: http://kb.qpr.com/qpr2017-1/index.html?supported_parameters.htm.
attributeParameters Parameters for the attribute. For example, value attribute supports period and series parameters, which are defined as follows: period=Q1/2018,series=ACT.
headerText Column header text that is visible to users. Syncfusion Grid setting.
type
  • checkbox: shows a checkbox, which is used for storing two possible values. The possible values are defined in trueValue and falseValue properties.
  • date: shows a date selector that can store values using XML date format (e.g. 2018-10-05T16:26:42). Other date type of data than the Metrics date series, use the XML date format.
  • dropdown: shows a dropdown list where user can select from a list of predefined items. The items are defined in the dropdownoptions property.
  • metricsdate: shows a date selector that can store dates to Metrics date type of series.
  • numericbox: shows a textbox for numeric values. It's not possible to input textual data.
  • textbox: shows a textbox for storing string values.
dropdownOptions Selectable options for the dropdown menu as an array. Only used when type is dropdown. The array has the following properties:
Property Description
label Visible text in the dropdown list.
value Attribute value to store to QPR Suite when an item is selected in the dropdown list.
trueValue Attribute value corresponding to checkbox checked state of a checkbox. Used only used when type is checkbox.
falseValue Attribute value corresponding to checkbox unchecked state. Used only used when type is checkbox.
validationRules

Validation rules for the column. Provided values must pass the validations so that they can be saved. Following validation rules are available:

  • required (boolean): Value is required, i.e. it cannot be empty.
  • minlength (integer): Minimum number of charactes in a textual value.
  • maxlength (integer): Maximum number of charactes in a textual value.
  • range (two integers): Requires the value to be in given value range.
  • min (integer): Minimum for numeric value.
  • max (integer): Maximum for numeric value.
  • email (boolean): The value must be a valid email address.
  • url (boolean): The value must be a valid email URL.
  • digits (boolean): The value must contain digits only.

Examples:

validationRules: { required: true, minlength: 3 }
validationRules: { range: [0, 100] }
allowEditing Syncfusion Grid setting.
format Syncfusion Grid setting.

[other syncfusion settings]

All Syncfusion datagrid settings can be used: https://help.syncfusion.com/api/js/ejgrid#members:columns

[other syncfusion settings]

All Syncfusion datagrid settings can be used: https://help.syncfusion.com/api/js/ejgrid#members:columns

{
  "editSettings": {
    "allowAdding": true,
    "allowDeleting": true,
    "allowEditing": true,
    "allowEditing": "normal"
  },
  "toolbarSettings": {
    "showToolbar": true,
    "toolbarItems": ["add", "edit", "delete", "update", "cancel"]
  }                             
}
{
  "columns": [
    { allowEditing: false },
  ]                             
}

Batch editing is not supported by the editable data grid (editSettings: { allowEditing: "batch" })