Task Engine Webhelp
Document Conventions
Online Information and Support
Data Protection
webMethods Task Engine User's Guide
Introduction to webMethods Task Engine
Deprecation of webMethods Broker
Understanding webMethods Tasks
Task Overview
Task Runtimes and Relationship with Software AG Designer
About Tasks and Task Types
Task Interaction with Users, Groups, and Roles
About User Information in Tasks and Task Engine Logs
Task Assignments, Events, and Rules
Task Assignment
Task Status and Life Cycle
How Permission-Based Access Affects Tasks
About Scheduling Tasks
About Collaboration Tasks
How Collaboration Tasks Differ from Standard Tasks
Using Collaboration Tasks in a Process
Using Collaboration Tasks Manually
About Collaboration Processes
About the Relationship Between Parent Tasks and Collaboration Tasks
About Collaboration Tasks and Task Business Data
Key Points About Collaboration Tasks
About Task Comments and Attachments Sharing
About E-form Integration with Tasks
About Task E-mail Notifications
Replying to a Notification without a My webMethods Connection
Permissions Required to Work with Task Notifications
About Mobile Task Integration
Where to Find Tasks in My webMethods
Monitoring Tasks in My webMethods
About My Inbox
About Task Actions
About Task List Management
About Task Type Inboxes
About Task Charts
Working with Tasks in My webMethods
About Task Inboxes
Viewing and Opening Tasks in the Task Inboxes
Selecting Tasks in Task Inboxes
Sorting Tasks in the Task Inboxes
About Duplicate Task Type Names in the My Inbox Results
Viewing Detailed Information About a Task
About the Data View
About the Details View
About the Audit View
About the Task Comments View
About the New Comments/Edit Comments Panel
About the Collaboration Tab
About the New Collaboration Task Panel
Customizing the Task Inbox Search Options
Searching and Filtering the Task List
Filtering and Searching in My Inbox
Searching in a Task Type Inbox
Customizing the My Inbox and Task Type Inbox Results List
Directing a Task to a User
About Task Assignment
Differences in Task Assignment and Delegation
Working with the Select Principals and Select Users Dialog Boxes
Assigning a Task from a Task Inbox
Viewing Task Assignments
Unassigning a Task
Delegating a Task
Accepting a Task
Releasing a Task
Delegating Tasks
Delegating a Task from Your Inbox
Removing a Delegation
Viewing Task Delegations
Scheduling Task Delegation
Scheduling a Task Delegation
Deleting a Scheduled Task Delegation
Viewing Scheduled Task Delegations
Working with Attachments
Working with Comments and Attachments in the Comments Tab
Adding a Comment to a Task
Updating a Comment in a Task
Deleting a Comment from a Task
Adding an Attachment to a Task
Updating an Attachment in a Task
Deleting an Attachment from a Task
Working with Attachments in an Attachments Panel
Attaching a File to a Task
Viewing an Attached File
Downloading an Attached File
Updating an Attached File
Removing an Attached File
Working with Notifications
Subscribing to a Task Notification for Your Own User Account
Unsubscribing from a Task Notification for Your Own User Account
Subscribing to a Notification Rule for Other Users
Unsubscribing from a Notification Rule for Other Users
Responding to an E-mail Notification
Working with E-form Data in Tasks
Downloading an E-form from a Task
Uploading an E-form to a Task
Exporting the Contents of a Task Inbox or Task List
Other Task Actions
Submitting a Task
Completing a Task
Working with Collaboration Tasks
Creating a Collaboration Task
Viewing a Collaboration Task
Opening a Task on the Collaboration Tab
Modifying the Collaboration Task Display
Modifying a Collaboration Task
Deleting a Collaboration Task
Searching for Collaboration Tasks
Working with Collaboration Processes
Viewing Collaboration Process Details
Searching for Collaboration Processes
Completing a Collaboration Process
Viewing Collaboration Processes in webMethods Monitor
Managing Tasks from the Task List Management Page
Overview
Viewing Tasks on the Task List Management Page
Selecting Tasks in Task List Management
Sorting Tasks in the Task Results List
About Duplicate Task Type Names in the Task List Management Results
Customizing the Task List Management Search Options
Customizing the List of Task Results
Filtering and Searching the Task Management List
Viewing Task Details
Managing Tasks
Suspending a Task
Resuming a Task
Assigning a Task from the Task List Management Page
Unassigning a Task from a User, Group, or Role
Accepting a Task for a User
Setting the Task Status
Deleting a Task
Process Implications When Deleting a Task
Delegating a Task from One User to Another
Removing All Task Delegations
Scheduling a Task Delegation
Modifying Task Properties
Rolling Back a Task
Administering Tasks
Configuring Task Permissions
About Access Permissions
Configuring Task Access Permissions
Limitations When Denying Access to My Inbox
About Functional Permissions
Configuring Global Task Functional Permissions
About Task Type Functional Permissions
Configuring Task Type Functional Permissions
Configuring Task Support for a User
Subscribing Users to Notifications
Configuring Support for Collaboration Tasks
Administering Task Types
Administrative Considerations for Task Publishing
Considerations When Publishing Task Types with Duplicate Names
About Optimized Task Type Publishing
Forcing a Full Publication of a Task Application
Searching for Task Type Instances
Deleting All Task Type Instances
Disabling and Enabling a Task Type
Disabling and Enabling Task Analytics
Disabling and Enabling Comments and Attachments
Disabling and Enabling Task Collaboration
Disabling and Enabling Task Data Sharing
Specifying Allowed Collaboration Tasks
Setting Display Options for the Collaboration Process Diagram
Administering Indexed Task Business Data
About Business Data Field Searches
Considerations When Publishing Task Types with Indexed Data
Reindexing Task Business Data
Considerations when Reindexing Task Business Data
Indexing Considerations in a Clustered Environment
Deleting a Task Type from My webMethods Server
Deleting a Task Application from My webMethods Server
Starting a New Task
Modifying Task Types in My webMethods Server
About Task Type Rules and Events
Viewing Task Type Rules in My webMethods
Administering Task Types with Date/Time Events
Recalculating Date/Time Events for a Single Task Type
Recalculating Date/Time Events for All Task Types
Scheduling Date/Time Event Recalculation for a Task Type
Configuring a Custom Data Source
Working with Global Task Rules
Managing Global Rules
Creating a Global Task Rule
Modifying a Global Task Rule
Copying a Global Task Rule
Removing a Global Task Rule
Changing the Rule Evaluation Order
Disabling Auditing for Task Rules
Specifying Task Audit View Logging Levels
Working with Task Charts
Viewing and Refreshing Charts on the Task Charts Page
Configuring a Task Chart
Working with Task Chart Portlets
Creating a Task Chart Portlet
Renaming a Task Chart Portlet
Placing Task Portlets on Other Pages in My webMethods
Deleting and Hiding Task Type Entries in My webMethods
Deleting a Task Type Inbox Entry
Hiding and Displaying a Task Type Inbox Entry
Deleting a Task Type Page
Hiding and Displaying a Task Type Page
Analyzing Task Engine Runtime Performance
Administering Task EDA Event Emission
About Global Settings for EDA Events
Enabling and Disabling Global EDA Event Emission for Tasks
Enabling and Disabling EDA Event Emission for a Task Type
About EDA Predefined Task Event Types
About Task Event Schemas
EDA Task Event Element Definitions
The EDA Predefined Task Event Type
Key Supporting Schemas
Importing the EDA Predefined Event Type Project in Designer
Exporting Task EDA Event Settings
Exporting and Importing Task Types at Run Time
Exporting and Importing a Task Type
Exporting Settings for a Task Type
Importing Settings for a Task Type
Archiving Tasks
About Task Archiving
Configuring Task Archiving
Modifying the Task Archiving Schedule
Triggering the Task Archiving Rule
Example: Task Archiving Configuration
Searching and Viewing Archived Tasks
Running Task Engine on Integration Server
About Task Engine on Integration Server
About Task Engine Packages on Integration Server
About Services in the WmTaskEngine Package
Installation Requirements and Post-Installation Steps
Using Task Engine on Integration Server with the webMethods Suite
Configuring the Task Engine Environment
About the Task Engine Configuration
Running Task Engine with Docker
Running Task Engine in a Clustered Environment
Configuring Task Engine in My webMethods
Configuring the Task Engine Logging Level
Configuring HPSTRA
Configuring a JDBC Data Source
Creating a Task Time-to-Live Eviction Policy
Working with Business Calendars
Creating a Business Calendar
Specifying a Default Business Calendar
Modifying a Business Calendar
Deleting a Business Calendar
Specifying a Business Calendar for a User Account
Working with Personal User Calendars
Configuring User Calendars — Microsoft Exchange
Configuring User Calendars — Lotus Notes
Installing the notes.jar File
Configuring the IBM Lotus Domino Server
Configuring a Task E-mail Listener
Managing Task E-mail Listeners
About E-mail Listener Security
About E-mail Listener Behavior
Running an E-mail Listener in a Clustered Environment
Configuring Task Analytics
About the Task Metrics Event Map
Working with the Task Metrics Event Map
Configuring a webMethods Broker (Deprecated) or JMS Server Connection and Deploying Event Maps
About Modifying the Task Analytics Schema
Configuring an E-form Environment
Applying Task Engine Optional Settings
Configuring the WmTaskClient Package
Specifying a User Account for the WmTaskClient Package
About WmTaskClient and Session Pooling
Configuring Task Service Retry and Timeout Values
Configuring Task Client in Integration Server or Microservices Runtime Containers
Configuring Task Engine on Integration Server
About Task Engine Logging
Task Engine Logging Configuration files
Modifying the Logging Configuration Files
Configure Logging for Task Engine on Integration Server
Applying Task Engine Optional Settings
About Task Engine Optional Settings
Allow Attachment Download for Task Instances
Allow Empty Business Data Field
Completed Task Re-Delivery Count
Completed Task Re-Delivery Interval
Disable Task Engine Initialization on Integration Server Start-up
Disable/Enable Task Logging in Processes
Limit the Number of Tasks Returned to a Results List
Look Up Principal Retry Behavior
Look Up Principal Retry Timeout
Maximum Thread Count
Preload the Task Cache at Startup
Remote Session Timeout Values
Return of Empty Documents
Return Order of Task Data Fields
Set Conditions for Task Preloading
Suppress Task Deleted Events
Synchronous Cluster Updates
Task Event Processing Wait Time
Task Locking in a Cluster Environment
Task Lock Timeout Values
Task Permission Checking Behavior
Task Search Thread Count
Task Update Behavior
Task Update Thread Count
Adjust for Network Latency in Service Call to Task Engine
Change the Default User for Services in the WmTaskClient Package
Turn on Oracle Database Hints
Using Command Central to Manage Task Engine
Administering Task Engine
About Administering Task Engine on My webMethods Server
Commands that Task Engine Supports
Configuration Types that Task Engine on My webMethods Server Supports
Run-Time Monitoring Statuses for Task Engine
About Administering Task Client
About Administering Task Client
Commands that WmTaskClient Supports
Configuration Types that WmTaskClient Supports
Run-Time Monitoring Statuses for WmTaskClient
Administering Task Engine on Integration Server
About Administering Task Engine on Integration Server
Commands that Task Engine on Integration Server Supports
Configuration Types that Task Engine on Integration Server Supports
Run-Time Monitoring Statuses for Task Engine on Integration Server
Adding a Cluster Configuration Endpoint for Task Engine on Integration Server
Configuring System Properties for Task Engine on Integration Server
Configuring Task Engine Variables
Considerations when Configuring Task Engine Variables in Command Central
Task Expression Reference
About Task Expressions
Understanding Task Expressions
About Condition Expressions
About Filter Rule Expressions
About Results Expressions
About Expression Operators
About Date/Time Values in Rule Expressions
About Global Rule Expressions
Expressions for Default Global Rules
Infinite Loop Rule
Delete a Task Rule
Example Global Rule - Expire Task
webMethods Task Engine API and Service Reference
Introduction to the Task Engine APIs
Using the Task Engine Built-in Services
Task Engine Built-In Services Location
Summary of Available Services
pub.task.taskclient:addTagsToTask
pub.task.taskclient:addTaskAttachment
pub.task.taskclient:addTaskComment
pub.task.taskclient:countTasksIndexed
pub.task.taskclient:countTasksIndexedHPSTRA
pub.task.taskclient:deleteTagsFromTask
pub.task.taskclient:deleteTask
pub.task.taskclient:deleteTaskAttachment
pub.task.taskclient:deleteTaskComment
pub.task.taskclient:formFlowTaskNotify
pub.task.taskclient:getTask
pub.task.taskclient:getTaskAttachments
pub.task.taskclient:getTaskAudit
pub.task.taskclient:getTaskComments
pub.task.taskclient:getTaskExpertList
pub.task.taskclient:listTagsByTask
pub.task.taskclient:queueTask
pub.task.taskclient:rollbackTask
pub.task.taskclient:searchTasks
pub.task.taskclient:searchTasksHPSTRA
pub.task.taskclient:searchTasksFields
pub.task.taskclient:searchTasksFieldsHPSTRA
pub.task.taskclient:searchTasksIndexed
pub.task.taskclient:searchTasksIndexedHPSTRA
pub.task.taskclient:updateTask
pub.task.taskclient:updateTaskAttachment
pub.task.taskclient:updateTaskComment
pub.task.taskclient:updateTaskTags
pub.task.taskclient:voteTask
Summary of Data Structures
pub.task:Guidance
pub.task:Task
pub.task:TaskAttachment
pub.task:TaskAudit
pub.task:TaskCallbackService
pub.task:TaskComment
pub.task:TaskCompletionInfo
pub.task:TaskFields
pub.task:TaskInfo
pub.task:TaskQueueInfo
pub.task:TaskSearchQuery
pub.task:TaskSearchQueryTerm
pub.task.TaskSearchQueryV2
Using the Task Engine RESTful Web Services in Integration Server
Overview
Summary of REST Resources and Requests
DELETE a Task Instance
GET Task Instance Information
POST a New Task Instance
PUT Information in a Task Instance
POST a Vote to a Task Instance
GET Tasks with a Simple Search Request
GET HPSTRA-enabled Tasks with a Simple Search Request
POST a Complex Task Search Request
POST a Complex Search Request for HPSTRA-enabled Tasks
GET Task Audit Information
DELETE Audit Entries to Rollback Task
GET or POST a Form Flow Notification
DELETE Task Comment
GET Task Comments
PUT Updates into a Task Comment
POST Task Comment
DELETE Tags From Task
GET Tags By Task
GET Task Expert List
POST Tags To Task
PUT Task Tags
DELETE Task Attachment
GET Task Attachments
PUT Task Attachment
POST Task Attachment
Using the Task Engine RESTful Web Services in My webMethods Server
Overview
Summary of REST Resources and Requests Through My webMethods Server
DELETE a Task Instance
GET Task Instance Information
POST a New Task Instance
PUT Information in a Task Instance
POST a Vote to a Task Instance
GET Tasks with a Simple Search Request
POST a Complex Task Search Request
GET Task Audit Information
DELETE Audit Entries to Rollback Task
GET or POST a Form Flow Notification
DELETE Task Comment
GET Task Comments
PUT Updates into a Task Comment
POST Task Comment
DELETE Task Attachment
GET Task Attachments
PUT Task Attachment
POST Task Attachment
Using the Task Engine Web Service API
Overview
Task Service URLs
Extracting the WSDL for the Task Web Service
Using the Task Web Service Operations
Summary of Available Operations
addTagsToTask
addTaskAttachment
addTaskComment
countTasksIndexed
deleteTagsFromTask
deleteTask
deleteTaskAttachment
deleteTaskComment
formFlowTaskNotify
getTask
getTaskAttachments
getTaskAudit
getTaskComments
getTaskExpertList
listTagsByTask
queueTask
rollbackTask
searchTaskFields
searchTasks
searchTasksIndexed
updateTask
updateTaskAttachment
updateTaskComment
updateTaskTags
voteTask
Summary of Data Structures
TaskAttachment
TaskAudit
TaskComment
TaskData
TaskInfo
Task
TaskSearchQuery
TaskSearchQueryTerm
TaskSearchQueryV2
Copyright
Task Engine Webhelp
Copyright