Business Console 10.7 | webMethods Business Console Documentation | Working with Business Console | Administering Business Console | Customizing Business Console Using Gadgets | Common Gadgets
 
Common Gadgets
Global Activity Stream
Displays information related to activities such as adding attachments or comments received from users.
Produced Event
Description
TASK_TYPE_PERMISSION_LOADED_FOR_TASK_ACTION
Following are the output parameters in the payload (payLoad.<parameter>):
*Parameter
*Description
taskTypeId
Task type ID
taskId
Task ID
status
Task status
name
Task name
source
Gadget name
isDelegated
Task is delegated if the value is true. Otherwise, it is false.
Retrieves user permissions for task instances after clicking the icon.
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
COLLABORATION_TASK_CREATED
Updates the activity information after creating an instant task or a collaboration task.
Attachments
Displays attachments for an instance type based on the gadget setting. Additionally, you can download, upload, and delete attachments.
Gadget Setting
Description
Type
Type of instance. You can select one of the following instance types:
*Activity
*Process
*Task
*Case
Instance ID
The Instance ID of a process, task, or case.
Case Type
The case type associated with a case instance. This option appears only for case instances.
Subscribed Event
Description
PROCESS_DETAILS_DASHBOARD_LOADED
Following is the input parameter in the payload (payLoad.<parameter>):
*Parameter
*Description
instanceId
Process Instance ID
Retrieves the process for which attachments must be displayed.
TASK_DETAILS_DASHBOARD_LOADED
Following are the input parameters in the payload (payLoad.<parameter>):
*Parameter
*Description
instanceId
Task ID
type
Set the value to tlm to display attachments associated with tasks.
Retrieves the task for which attachments must be displayed.
CASE_DETAILS_DASHBOARD_LOADED
Retrieves the case for which attachments must be displayed.
ACTIVITY_DETAILS_DASHBOARD_LOADED
Retrieves the activities for which attachments must be displayed.
Instance List Management
Displays a process list, task list, or case list based on the gadget setting.
Gadget Setting
Description
Type
Type of instance. Select one of the following instance types:
*Process
*Task
*Case
Name
Name of the process type, task type, or case type.
Gadget label
The title of the gadget.
Show instance details
Displays process instances, task instances, or case instances.
Following gadget settings are applicable only to tasks:
Custom task name
The custom title to use for the Task Name column.
Select a saved search
Select a saved search criteria for retrieving tasks.
Show only my tasks
Displays tasks that are associated with the current user.
Show completed tasks
Displays tasks that are complete.
Produced Event
Description
UPDATE_INBOX_TASK_LIST
Following are the output parameters in the payload (payLoad.<parameter>):
*Parameter
*Description
pageNumber
The updated page number in the task inbox
pageSize
The updated page size in the task inbox
Updates the task instances in the task inbox.
AA_OBJECT_RECORD_CHANGE
Following are the output parameters in the payload (payLoad.<parameter>):
*Parameter
*Description
AAObjectID
Case type ID
AAObjectRecordID
Case Instance ID
Triggered when a case instance is selected.
SAVED_SEARCH_DELETE_CHART_REFRESH
Following is the output parameter in the payload (payLoad.<parameter>):
*Parameter
*Description
savedSearchID
Saved search name
Triggered when a saved search query is deleted.
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
COLLABORATION_TASK_CREATED
Following is the input parameter in the payload (payLoad.<parameter>):
*Parameter
*Description
taskId
Task ID of the parent task
Updates the list after creating an instant task or a collaboration task.
People Picker
Displays users listed in the active directory that is configured on My webMethods Server.
Gadget Setting
Description
Maximum users to display per page
The maximum number of users to display on a page.
Work Stream
Displays a list of process types, task types, and case types. This gadget enables you to customize the following pages: Process Details, Task Details, and Case Details.
Subscribed Event
Description
GLOBAL_PERMISSION_LOADED
Updates the user interface based on user permissions.
REFRESH_PLM_GADGET_ON_CLOSE
Following is the input parameter in the payload (payLoad.<parameter>):
*Parameter
*Description
pKey
Parameter to identify the process type. For example, the payLoad.pKey for the Hire (HR) process has the following format:
HR/Hire
Updates the process list.
MashZone NextGen
Displays the MashZone NextGen data on Business Console as a gadget. For more information, see MashZone NextGen Gadgets.
Gadget Setting
Description
Dashboard URL
The URL of the MashZone NextGen instance.
UI Settings
Specify the following:
*Parameter
*Description
Height in px
Height of the gadget frame.
Gadget Title
A unique title for the gadget.
Show Border
Select to display a border for the MashZone NextGen gadget.
Custom settings for the gadget on Business Console.
Data Mappings
Provide the following mapping details:
*Parameter
*Description
Mapping ID
A unique string representing the common entity in two different data sets.
Widget ID
The Widget ID details of the MashZone NextGen data set that is obtained from the MashZone NextGen Dashboard instance.
Widget Parameter
The parameter that needs to mapped between the two communicating MashZone NextGen gadgets.
Default Value
Assign a default parameter value through which the communication is visible on Business Console.
The settings to map the data set with another MashZone NextGen gadget having a different Dashboard URL.