Manage Roles
To access a case solution, a user must be a member of a role that is associated with that solution. Adds users and groups to a role.
Appearance
| Hide Manage Roles Button: | Hide the Manage Roles button. | Boolean |
| Color style: | The color style of the view. | |
| Shape style: | The shape of the view, rounded, flat or square (default). | |
| Size: | The size-based styling for this view (default, large, small, extra-small) | |
| Outline only: | Show the outline and hide the solid fill of the button in the selected color style. Add the solid fill at hover over. | Boolean |
| Icon: | The icon name, for example, calendar, clock-o, camera, cloud-upload, bell, info, file-text, etc. For a comprehensive list, see http://fontawesome.io/icons. Note that the "fa-" prefix is optional. | String |
| Width: | The width in px, %, or em. For example, 50px, 20%, 0.4em. If no unit is specified, px is assumed. | String |
| Icon location: | The location of the icon relative to the button text. | |
| Ghost style: | Show the button in the selected color style with no outline and no solid fill. Add a light grey background at hover over. | Boolean |
General options
| Target Object Store Name: | The name of the repository that the view connects to. | String |
| Solution Prefix: | The prefix of the case solution. | String |
| Maximum results: | Maximum number of search results to display. | Integer |
| Search attribute: | Select the attributes for the user groups search. {Display name | Short Name} |
UserGroupSearchAttribute |
| Initial Page Size: | The default number of items that can be configured to display items of type List. Default: 10. | Integer |
| Events | ||||
| On load: |
| |||
Extends:
Methods:
Inherited
addClass(name, [replaced])
Add or replace the CSS classes for this view.
| Name | Type | Default | Description |
| name | {string} | The CSS class names to add to the view. For multiple classes, use space to separate the class names. | |
| replaced | {string} | The CSS class names to be replaced by the first argument. For multiple classes, use space to separate the class names. |
Example
| Button.addClass("green"); |
addCurrentUser()
Adds the current logged-in user as a member.
closeManageRolesModal()
Closes the Manage roles dialog.
Inherited
getData()
Returns:
{Object}
Retrieve the bound data associated with the view. It applies only to views with bound data.
Example
| var dec1 = MyDecimal.getData(); |
Inherited
hide(collapseFlag)
Hide the view.
| Name | Type | Default | Description |
| collapseFlag | {boolean} | Set to true to collapse the view (equivalent to a view setting of "NONE") |
Example
| MyView.hide(); |
Inherited
isBound()
Returns:
{boolean}
Indicate the bound status of the view.
Inherited
isEnabled()
Returns:
{boolean}
Check whether the view is enabled.
Example
| var enabled = MyView.isEnabled(); |
Inherited
isLabelVisible()
Returns:
{boolean}
Check whether the view label is visible.
Example
| var labelVisible = MyView.isLabelVisible(); |
Inherited
isValid()
Returns:
{boolean}
Return the valid status as last set by the setValid() method.
Example
| var valid = MyView.isValid(); |
Inherited
isVisible()
Returns:
{boolean}
Check whether the view is visible.
Example
| var visible = MyView.isVisible(); |
openManageRolesModal()
Opens the Manage roles dialog.
Inherited
propagateUpValueChange(event)
Returns:
{boolean}
Propagate the value change of the view up through the parent views.
| Name | Type | Default | Description |
| event | {Event} | Value change event (usually an onchange event) |
Example
| MyView.propagateUp(event); |
Inherited
recalculate()
Applicable only to formula-enabled views!
Triggers the re-evaluation of the formula
for the view, if a formula was specified. If the view is not formula-enabled,
Triggers the re-evaluation of the formula
for the view, if a formula was specified. If the view is not formula-enabled,
recalculate() does nothing.Example
| Text1.recalculate();
//If the formula for Text1 is: new Date().toString(), Text1 is updated to the current date/time |
Inherited
setEnabled(enabled, required)
Enable or disable the view.
| Name | Type | Default | Description |
| enabled | {boolean} | Enabled/read-only flag (true to enable view, false to disable/make read-only) | |
| required | {boolean} | Enable or disable the required field flag for the view. |
Example
| MyView.setEnabled(false); //Make MyView read-only |
Inherited
setLabelVisible(visible)
Show or hide the view label.
| Name | Type | Default | Description |
| visible | {boolean} | Label visibility flag (true to show view label, false to hide) |
Example
| MyView.setLabelVisible(false); |
Inherited
setValid(valid, errorText)
Flag the view as valid or invalid.
| Name | Type | Default | Description |
| valid | {boolean} | Valid/invalid flag (true to set view valid, false to make it invalid - which typically shows the view with "invalid" styling and indicator) | |
| errorText | {string} | Validation error text to show on the invalid-styled view |
Example
| MyView.setValid(false, "Fix your data entry"); //Make MyView invalid |
Inherited
setViewData(data, createPseudoBinding)
Set or update the bound data associated with the view. It applies only to views with bound data.
Note: It should only be used with simple type bindings, or complex type bindings with simple type properties.
It should not be used with bindings that have properties that are lists or compext types. For complex types, set the bindings by using
the
Note: It should only be used with simple type bindings, or complex type bindings with simple type properties.
It should not be used with bindings that have properties that are lists or compext types. For complex types, set the bindings by using
the
binding.set pattern, as described in the Binding data and configuration options documentation section.| Name | Type | Default | Description |
| data | {Object} | The value of the bound data. The parameter type must match the type of the bound data. | |
| createPseudoBinding | {boolean} | If the value is set to true, the parameter creates a pseudo binding if there is no current binding. |
Example
| MyView.setViewData("TEST"); //Updates bound data to the string 'TEST' |
Inherited
setVisible(visible, collapse)
Show or hide the view.
| Name | Type | Default | Description |
| visible | {boolean} | Visibility flag (true to show the view, false to hide it) | |
| collapse | {boolean} | Set it to true to collapse the view space when the option visible is set to false. |
Examples
| MyView.setVisible(false, false); //Equivalent to MyView.hide() |
| MyView.setVisible(false, true); // Sets visibility to "None" |
Inherited
show()
Show this view.
Example
| MyView.show(); |
Inherited
triggerFormulaUpdates([phase])
Broadcast the expression trigger for the specified view.
| Name | Type | Default | Description |
| phase | {int} | bpmext.ui.PHASE_NORMAL | The phase we are currently in |
Example
| MyView.triggerFormulaUpdates(); |