The Properties widget provides the following incoming events
to handle the data that is received from other widgets.
Update fields event
| Description |
Update the fields with the values that are contained
in the event payload. |
| Event ID |
icm.UpdateFields |
| Payload |
- changes
- A JSON object that contains the unique identifier, collection identifier, and value for the
property to be modified. The structure is:
changes:[
{
id: prop1,
collectionId: collectionId1,
value: value1
},
{
id: prop2,
collectionId: collectionId2,
value: value2
}
]
The collectionId parameter identifies the type of
properties that are being updated. Use the following values for this parameter:
- F_CaseFolder
- Use this value for case properties.
- F_CaseTask
- Use this value for task properties.
- F_WorkflowField
- Use this value for work group or workflow data fields.
The data type of each value must correspond to the data type of the property, or must
be null. For properties that support multiple values, the value is an array of the corresponding
data type. If the value is incompatible, the value is coerced if possible or a default value is
applied. A warning is also logged.
|
Update properties event
| Description |
Update the properties with the values that are contained in the event
payload. |
| Event ID |
icm.UpdateProperties |
| Payload |
- changes
- A JSON object that contains the pvr.widget.Property object, value, error, and
row for the property to be updated. The structure is:
changes:[
{
property: prop1,
value: value1,
[error]: error1,
[row]: row1
},
{
property: prop2,
value: value2,
[error]: error2,
[row]: row2
}
]
The data type of each value must correspond to the data type of the property,
or must be null. For properties that support multiple values, the value is an array of the
corresponding data type. If the value is incompatible, the value is coerced if possible or a default
value is applied. A warning is also logged.
|
Clear content event
| Description |
Clear the content in the Case List widget. |
| Event ID |
icm.ClearContent |
| Payload |
null |
Send case information event
| Description |
Display the properties view for the specified
case. Replace the existing view if one exists. |
| Event ID |
icm.SendCaseInfo |
| Payload |
- caseEditable
- An icm.model.CaseEditable object that represents
the case that is to be displayed and updated.
- coordination
- An icm.util.Coordination object that is used
internally by the widgets in the same page.
|
Send new case information event
| Description |
Display the properties for the new case that
the user is creating. |
| Event ID |
icm.SendNewCaseInfo |
| Payload |
- caseEditable
- An icm.model.CaseEditable object that represents
the case that is to be created.
- coordination
- An icm.util.Coordination object that is used
internally by the widgets in the same page.
|
Send new task information event
| Description |
Display the properties for the new task that
the user is creating. |
| Event ID |
icm.SendNewTaskInfo |
| Payload |
- taskEditable
- An icm.model.TaskEditable object that represents
the task that is to be created. The editable properties are contained
in the icm.model.LaunchStep object that is associated
with the icm.model.TaskEditable object. You can
obtain the editable properties by calling the
taskEditable.getLaunchStep() method.
- coordination
- An icm.util.Coordination object that is used
internally by the widgets in the same page.
|
Send work item event
| Description |
Display the properties for the work item that
is contained in the event payload. |
| Event ID |
icm.SendWorkItem |
| Payload |
- workItemEditable
- An icm.model.WorkItemEditable object that represents
the work item that is to be displayed and updated.
- coordination
- An icm.util.Coordination object that is used
internally by the widgets in the same page.
|