Action events
Some of the IBM® Business Automation Workflow actions publish outgoing events. As with widgets, you can wire these events to the incoming events of widgets.
The action events are listed with the outgoing events that are published by the widget for which the action is configured. For example, the event for the Add Case action is configured by default for the Toolbar widget on the Cases page. Therefore, the Open new case page event for the Add Case action shows up in the list of outgoing events for the Toolbar widget on this page.
Add Case action
- Action ID
- icm.action.solution.OpenAddCasePage
- Event
- Open add case page
- ID
- icm.AddCase
- Description
- Opens the Add Case page so that the user can create a case of the selected case type.
- Type
- Broadcast
- Payload
- caseType
- A string that contains the case type that the user selected to create the case.
- 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.
Add Comment to Case action
- Action ID
- icm.action.comment.AddCaseComment
- Event
- Add case comment
- ID
- icm.CommentAdded
- Description
- The new case comment was saved to the case.
- Type
- Wired
- Payload
- Case
- An icm.model.Case object that represents the case to which the comment is being added.
- CaseComment
- An icm.model.CaseComment object that represents the comment that is being added.
- commentType
- A string that is set to the value
Case
to indicate that the comment applies to a case.
Add Comment to Document action
- Action ID
- icm.action.comment.AddDocumentComment
- Event
- Document comment added
- ID
- icm.CommentAdded
- Description
- The new document comment was saved to the case.
- Type
- Wired
- Payload
- Case
- An icm.model.Case object that represents the case that contains the document for which the comment is being added.
- CaseComment
- An icm.model.CaseComment object that represents the comment that is being added.
- commentType
- A string that is set to the value
Document
to indicate that the comment applies to a document. - docId
- A string that contains the identifier of the document for which the comment is being added.
- documentTitle
- A string that contains the title of the document for which the comment is being added.
Add Comment to Task action
- Action ID
- icm.action.comment.AddTaskComment
- Event
- Activity comment added
- ID
- icm.CommentAdded
- Description
- The new activity comment was saved to the case.
- Type
- Wired
- Payload
-
- Case
- An icm.model.Case object that represents the case that contains the activity to which the comment is being added.
- CaseComment
- An icm.model.CaseComment object that represents the comment that is being added.
- commentType
- A string that is set to the value
Task
to indicate that the comment is being added for an activity. - Task
- An icm.model.Task object that represents the activity for which the comment is being added.
Add Comment to Work Item action
- Action ID
- icm.action.comment.AddWorkItemComment
- Event
- Work item comment added
- ID
- icm.CommentAdded
- Description
- The new work item comment was saved to the case.
- Type
- Wired
- Payload
- Case
- An icm.model.Case object that represents the case that contains the work item to which the comment is being added.
- CaseComment
- An icm.model.CaseComment object that represents the comment that is being added.
- commentType
- A string that is set to the value
WorkItem
to indicate that the comment is being added for a work item. - WorkItem
- An icm.model.WorkItem object that represents the work item for which the comment is being added.
Add Task action
- Action ID
- icm.action.case.OpenAddPredefinedTaskPage
- Event
- Open Add Activity page
- ID
- icm.AddTask
- Type
- Broadcast
- Description
- Opens the Add Activity page so the user can add a new discretionary activity to the case.
- Payload
- taskEditable
- An icm.model.TaskEditable object that represents the activity that is to be created.
- coordination
- An icm.util.Coordination object that is used internally by the widgets in the same page.
Add To-Do Task action
- Action ID
- icm.action.case.OpenAddToDoTask
- Event
- To-Do Task Added
- ID
- icm.ToDoTaskAdded
- Type
- Broadcast
- Description
- A discretionary to-do task is added.
- Payload
- ToDoTaskEditable
- An icm.model.TaskEditable object that represents the added to-do task.
Cancel Adding Task action
- Action ID
- icm.action.task.CancelAddTaskPage
- Event
- Close page
- ID
- icm.ClosePage
- Type
- Broadcast
- Description
- Closes the current Add Activity page.
- Payload
null
Close action
- Action ID
- icm.action.task.CloseToDoTaskView
- Event
- To-Do View Closed
- ID
- icm.ToDoTaskViewClosed
- Type
- Wiring
- Description
- The current to-do task view is hidden.
- Payload
- caseEditable
- An icm.model.CaseEditable object that represents the case that is to be handled.
- ToDoTaskEditable
- An icm.model.TaskEditable object that represents the added to-do task.
Close Case Page action
- Action ID
- icm.action.case.CloseCasePage
- Event
- Close case page
- ID
- icm.ClosePage
- Description
- Closes the current Add Case, Case Details, or Split Case page without saving any changes.
- Type
- Broadcast
- Payload
null
Close Work Details Page action
- Action ID
- icm.action.workitem.CloseWorkItemPage
- Event
- Close page
- ID
- icm.ClosePage
- Description
- Closes the current Work Details page.
- Type
- Broadcast
- Payload
null
Complete action
- Action ID
- icm.action.task.CompleteToDoTask
- Event
- To-Do Task Completed
- ID
- icm.ToDoTaskCompleted
- Type
- Wiring
- Description
- The current to-do task is completed.
- Payload
- caseEditable
- A CaseEditable object that represents the case that is to be handled.
- ToDoTaskEditable
- An icm.model.TaskEditable object that represents the completed to-do task.
Disable action
- Action ID
- icm.action.task.StopToDoTask
- Event
- To-Do Task Disabled
- ID
- icm.ToDoTaskDisabled
- Type
- Wiring
- Description
- The current to-do task is disabled.
- Payload
- caseEditable
- An icm.model.CaseEditable object that represents the case that is to be handled.
- ToDoTaskEditable
- An icm.model.TaskEditable object that represents the disabled to-do task.
Dispatch Work Item
- Action ID
- icm.action.workitem.DispatchWorkItemAndClosePage
- Event
- Work item dispatched
- ID
- icm.WorkItemDispatched
- Type
- Wired
- Description
- Dispatches the completed work item.
- Payload
- workItemEditable
- An icm.model.WorkItemEditable object that represents the work item that is being edited.
- Event
- Close page
- ID
- icm.ClosePage
- Description
- Closes the current Work Details page.
- Type
- Broadcast
- Payload
null
Enable action
- Action ID
- icm.action.task.EnableToDoTask
- Event
- To-Do Task Enabled
- ID
- icm.ToDoTaskEnabled
- Type
- Wired
- Description
- The current to-do task is enabled.
- Payload
- caseEditable
- An icm.model.CaseEditable object that represents the case that is to be handled.
- ToDoTaskEditable
- An icm.model.TaskEditable object that represents the enabled to-do task.
Move Item to Personal In-basket action
- Action ID
- icm.action.workitem.MoveToInbox
- Event
- Close Case Page
- ID
- icm.ClosePage
- Description
- Closes the case page.
- Type
- Broadcast
- Payload
null
Open action
- Action ID
- icm.action.folder.Open
- Event
- Folder open
- ID
- icm.OpenFolder
- Description
- Opens the selected folder and displays its content.
- Type
- Wired
- Payload
- folder
- An ecm.model.ContentItem that represents the folder that was opened.
Open Case action
- Action ID
- icm.action.case.OpenCasePage
- Event
- Open case
- ID
- icm.OpenCase
- Description
- Opens the selected case in the Case Details page.
- Type
- Broadcast
- Payload
- caseEditable
- An icm.model.CaseEditable object that represents the case that the user selected.
- coordination
- An icm.util.Coordination object that is used internally by the widgets in the same page.
Open Item action
- Action ID
- icm.action.workitem.OpenWorkItemPage
- Event
- Open work item
- ID
- icm.OpenWorkItem
- Description
- Opens the selected work item in the Work Details page.
- Type
- Broadcast
- Payload
- workItemEditable
- An icm.model.WorkItemEditable object that represents the work item to be opened.
- coordination
- An icm.util.Coordination object that is used internally by the widgets in the same page.
- UIState
- A Dojo Stateful object that is used internally by the widgets in the same
page. This object can contain the following properties:
- GetNext
- This property determines whether the next work item is to be opened automatically.
- workitemReadonly
- This property determines whether the work item is to be opened in view mode.
- GetNextCfg
- This property determines the configuration of the Open Next Work Item action.
Reassign Item action
- Action ID
- icm.action.workitem.Reassign
- Event
- Close case page
- ID
- icm.ClosePage
- Description
- Closes the Work Details page.
- Type
- Broadcast
- Payload
null
Refresh To-Do List action
- Action ID
- icm.action.case.RefreshToDoTaskList
- Event
- Refresh To-Do List
- ID
- icm.RefreshToDoTaskList
- Description
- Refreshes the list of to-do tasks in the To-do List widget.
- Type
- Broadcast
- Payload (optional)
- caseEditable
- An icm.model.CaseEditable object that represents the case that is to be displayed.
- coordination
- An icm.base.Coordination object that is used internally by the widgets in the same page.
Restart action
- Action ID
- icm.action.task.RestartToDoTask
- Event
- To-Do Task Restarted
- ID
- icm.ToDoTaskRestarted
- Type
- Wiring
- Description
- The current to-do task is restarted.
- Payload
- caseEditable
- An icm.model.CaseEditable object that represents the case that is to be handled.
- ToDoTaskEditable
- An icm.model.TaskEditable object that represents the restarted to-do task.
Save action
- Action ID
- icm.action.task.SaveToDoTask
- Event
- To-Do Task Saved
- ID
- icm.ToDoTaskSaved
- Type
- Wiring
- Description
- The current to-do task is saved.
- Payload
- caseEditable
- An icm.model.CaseEditable object that represents the case that is to be handled.
- ToDoTaskEditable
- An icm.model.TaskEditable object that represents the saved to-do task.
Save Case
- Action ID
- icm.action.case.SaveCaseOnPage
- Event
- Case saved
- ID
- icm.CaseSaved
- Description
- Saves the case that is being edited or added without closing the page.
- Type
- Wired
- Payload
- caseEditable
- An icm.model.CaseEditable object that represents the case that is to be saved.
Save Case and Close Page action
- Action ID
- icm.action.case.AddCaseAndClosePage
- Event
- Case created
- ID
- icm.CaseCreated
- Description
- Adds the new case to the solution.
- Type
- Broadcast
- Payload
- caseEditable
- An icm.model.CaseEditable object that represents the case that is to be created.
- Event
- Close page
- ID
- icm.ClosePage
- Description
- Closes the current Add Case page or Split Case page.
- Type
- Broadcast
- Payload
null
Save Work Item action
- Action ID
- icm.action.workitem.SaveWorkItemOnPage
- Event
- Work item saved
- ID
- icm.WorkItemSaved
- Description
- Saves the work item that the user is editing.
- Type
- Wired
- Payload
- workItemEditable
- An icm.model.WorkItemEditable object that represents the work item that is to be saved.
Split Case action
- Action ID
- icm.action.case.OpenSplitCasePage
- Event
- Open split case page
- ID
- icm.SplitCase
- Description
- Opens the Split Case page so that the user can reuse properties from an existing case to create a case.
- Type
- Broadcast
- Payload
- caseType
- A string that contains the case type that the user selected to create the case.
- caseEditable
- An icm.model.CaseEditable object that represents the case that is to be split.
- coordination
- An icm.util.Coordination object that is used internally by the widgets in the same page.
Start action
- Action ID
- icm.action.task.StartToDoTask
- Event
- To-Do Task Started
- ID
- icm.ToDoTaskStarted
- Description
- The current to-do task is started.
- Type
- Wired
- Payload
- caseEditable
- An icm.model.CaseEditable object that represents the case that is to be split.
- ToDoTaskEditable
- An icm.util.Coordination object that is used internally by the widgets in the same page.
Start Task and Close Page action
- Action ID
- icm.action.task.AddTaskAndClosePage
- Event
- Activity created
- ID
- icm.TaskCreated
- Description
- Starts the new activity.
- Type
- Wired
- Payload
-
- taskEditable
- An icm.model.TaskEditable object that represents the activity to be started.
- Event
- Close page
- ID
- icm.ClosePage
- Description
- Closes the current Add Activity page.
- Type
- Broadcast
- Payload
null