Business Console 10.11 | webMethods Business Console Documentation | Working with Business Console | Administering Business Console | Customizing Business Console Using Gadgets | Task Related Gadgets
 
Task Related Gadgets
Task Charts
Displays charts for tasks such as bar charts and pie charts.
Gadget Setting
Description
Maximum Legend Limit
Maximum number of legends allowed in a chart.
Saved Search
The task filter for chart results. The public and private saved searches that you defined in My webMethods are available for selection.
Default is All My Tasks (Standard Task Inbox).
Chart Type
The type of chart.
The following chart types are available for selection:
*Bar chart
*Pie chart
*Donut chart
*Bubble chart
*Tree chart
Default is Bar chart.
Task Parameter
The task data on which the task charting is based.
Group By Task Type
Whether the chart data is grouped by task type.
The Group By Task Type option is not available for Pie chart and Donut chart. It is mandatory for Bubble chart and Tree chart.
Produced Event
Description
UPDATE_CHART_DEFAULT_SAVED_SEARCH
Triggered when running saved search queries.
LAUNCH_TASK_CHART_SETTINGS
Displays the Chart Settings dialog box.
Task Inbox
Displays the task instances in an inbox.
Gadget Setting
Description
Inbox
The task inbox. Select My Inbox to view the tasks assigned to you, or select one of the task types.
Select Saved Search
A saved search query for retrieving task instances.
Filter
Select a task filter. This option appears only when you select My Inbox in the Inbox field.
Custom Task Name
A custom title for the Task Name column.
Use Custom Task Name
Displays the custom title when selected.
Action Menu Orientation
Select a position to display the task actions menu in the gadget. You can either select the Left position or the Right position.
Subscribed Event
Description
ACCEPT_TASK_SUCCESSFUL
Refreshes the task inbox when a task is accepted.
Task Audit
Displays the audit information for a task.
Gadget Setting
Description
Instance ID
The Instance ID of the task.
Subscribed Event
Description
TASK_DETAILS_DASHBOARD_LOADED
Following is the input parameter in the payload (payLoad.<parameter>):
*Parameter
*Description
instanceId
Task Instance ID
Triggered when the audit information for a task instance is retrieved on the task details page.
Task Business Data
Displays the business data for a task instance.
Gadget Setting
Description
Instance ID
The Instance ID of the task.
Task type name
Name of the task type.
Task application name
Name of the application which contains the task.
Finish URL (Optional)
URL to return after completing the task. This is an optional field.
Show Gadgets for Business Data
Replaces the existing CAF/OpenUI portlet with a gadget. A gadget URL must be defined while creating a task type in Software AG Designer to replace the existing CAF/OpenUI portlet.
Subscribed Event
Description
TASK_DETAILS_DASHBOARD_LOADED
Following is the input parameter in the payload (payLoad.<parameter>):
*Parameter
*Description
instanceId
Task Instance ID
Triggered when the business data for a task instance is retrieved and displayed on the task details page.
Task Comments
Displays the comments for a task instance.
Gadget Setting
Description
Instance ID
The Instance ID of the task.
Subscribed Event
Description
TASK_DETAILS_DASHBOARD_LOADED
Following is the input parameter in the payload (payLoad.<parameter>):
*Parameter
*Description
instanceId
Task Instance ID
Triggered when comments for a task instance is retrieved and displayed on the task details page.
Task Experts
Displays a list of task experts based on task tags. Endorsement ratings are used for determining task experts.
Gadget Setting
Description
Tags
Task tags for which the task experts must be retrieved.
Collapsable
Makes the Task Experts panel collapsable.
Subscribed Event
Description
TASK_DETAILS_DASHBOARD_LOADED
Following is the input parameter in the payload (payLoad.<parameter>):
*Parameter
*Description
instanceId
Task Instance ID
Displays data for a task instance.
TASK_ENDORSE_SUCCESSFUL
Following is the input parameter in the payload (payLoad.<parameter>):
*Parameter
*Description
taskId
Task ID
Refreshes the gadget after a user endorses a task expert.
LOAD_EXPERTSPANEL
Following is the input parameter:
*Parameter
*Description
taskTypeName
Task type name
Refreshes the Task Experts panel after an update.
Task Header
Displays the header for a task. The header contains the parent task ID, priority, status, duration, and actions.
Gadget Setting
Description
Instance ID
The Instance ID of the task.
Produced Event
Description
TASK_DETAILS_UPDATED
Triggered after updating the task priority.
LOAD_TASK_HEADER_DETAILS
Displays the header for a task instance.
TASK_ASSIGN_TO_USER
Following is the output parameter in the payload (payLoad.<parameter>):
*Parameter
*Description
taskId
Task ID
Triggered when you perform the Assign To task action.
ACCEPT_TASK_SUCCESSFUL
Following is the output parameter in the payload (payLoad.<parameter>):
*Parameter
*Description
taskId
Task ID
Triggered when you perform the Accept task action.
ACCEPT_FOR_TASK_SUCCESSFUL
Following is the output parameter in the payload (payLoad.<parameter>):
*Parameter
*Description
taskId
Task ID
Triggered when you perform the Accept For task action.
BASIC_DELEGATE_SUCCESSFUL
Following is the output parameter in the payload (payLoad.<parameter>):
*Parameter
*Description
taskId
Task ID
targetUserID
Delegated user IDs in a list
responseJSON
Success message from the server
Triggered when you perform the Delegate task action.
TASK_REMOVE_DELEGATION_SUCCESSFUL
Following is the output parameter in the payload (payLoad.<parameter>):
*Parameter
*Description
taskId
Task ID
Triggered when you perform the Remove Delegations task action.
Subscribed Event
Description
LOAD_TASK_HEADER_DETAILS
Displays the header for a task instance.
TASK_DETAILS_DASHBOARD_LOADED
Following is the input parameter in the payload (payLoad.<parameter>):
*Parameter
*Description
instanceId
Task Instance ID
Displays data for a task instance.
Task Summary
Displays the summary of a task instance.
Gadget Setting
Description
Instance ID
The Instance ID of the task.
Summary Tab Label
The title to use for the Summary tab.
Business Data Tab Label
The title to use for the Business Data tab.
Show Gadgets for Business Data
Replaces the existing CAF/OpenUI portlet with a gadget. A gadget URL must be defined while creating a task type in Software AG Designer for the gadget to replace the existing CAF/OpenUI portlet.
Produced Event
Description
TASK_ENDORSE_SUCCESSFUL
Following is the output parameter in the payload (payLoad.<parameter>):
*Parameter
*Description
taskId
Task ID
Triggered when a user endorses a task expert.
Subscribed Event
Description
TASK_DETAILS_DASHBOARD_LOADED
Following are the input parameters in the payload (payLoad.<parameter>):
*Parameter
*Description
instanceId
Task Instance ID
Displays the data for the task instance.
GET_TASK_CHILDREN_STATUS
Following is the input parameter in the payload (payLoad.<parameter>):
*Parameter
*Description
parentTaskIds
Parent task ID
Displays the status of the child tasks.
UPDATE_TASK_DETAILS_TODO
Updates the to-do list of the task instance.
Following events are related to task actions:
TASK_ASSIGN_TO_USER
Following is the input parameter in the payload (payLoad.<parameter>):
*Parameter
*Description
taskId
Task ID
Triggered when the task instance is assigned to a user.
ACCEPT_TASK_SUCCESSFUL
Following is the input parameter in the payload (payLoad.<parameter>):
*Parameter
*Description
taskId
Task ID
Triggered when the current user accepts the task instance.
ACCEPT_FOR_TASK_SUCCESSFUL
Following is the input parameter in the payload (payLoad.<parameter>):
*Parameter
*Description
taskId
Task ID
Triggered when the current user accepts the task instance on behalf of one or more users or roles.
BASIC_DELEGATE_SUCCESSFUL
Following is the input parameter in the payload (payLoad.<parameter>):
*Parameter
*Description
taskId
Task ID
Triggered when the current user delegates a task instance to another user.
TASK_REMOVE_DELEGATION_SUCCESSFUL
Following is the input parameter in the payload (payLoad.<parameter>):
*Parameter
*Description
taskId
Task ID
Triggered when the current user removes task delegations.
Task Calendar
Displays a calendar to identify the days when you have scheduled tasks and to search for tasks based on their date property. See My Calendar.
Gadget Setting
Description
Task Type
The type of the task instance to search.
Saved Search
A saved search query for searching task instances.
Filter Fields
A date property for searching task instances.
Show Only My Tasks
View task instances that are assigned to the current user.
Produced Event
Description
REGISTER_SCHEDULED_CALENDER_EVENTS
Updates the calendar.
Task Child Details
Displays the child tasks of a parent task.
Gadget Setting
Description
Parent Task ID
The ID of the parent task for which you want to view the child tasks.
Subscribed Event
Description
LOAD_CHILD_TASKS
Following is the input parameter in the payload (payLoad.<parameter>):
*Parameter
*Description
taskId
Task ID of the parent task
Loads the child tasks of a parent task.
TASK_TYPE_PERMISSION_LOADED
Following is the input parameter in the payload (payLoad.<parameter>):
*Parameter
*Description
taskTypeId
Task ID of the parent task
Loads the current user permissions for the parent task type.
TASK_ASSIGN_TO_USER
Following is the input parameter in the payload (payLoad.<parameter>):
*Parameter
*Description
taskId
Task ID of the parent task
Triggered when you perform the Assign To task action, and it updates the tasks in the gadget.
ACCEPT_TASK_SUCCESSFUL
Following is the input parameter in the payload (payLoad.<parameter>):
*Parameter
*Description
taskId
Task ID
Triggered when the current user accepts the task instance, and it updates the tasks in the gadget.
ACCEPT_FOR_TASK_SUCCESSFUL
Following is the input parameter in the payload (payLoad.<parameter>):
*Parameter
*Description
taskId
Task ID
Triggered when the current user accepts the task instance on behalf of one or more users or roles, and it updates the tasks in the gadget.