addTaskDefinition
- Description
- This transaction creates a task definition that is used to create a task instance. Task definitions define the nature of a task and the metadata key used for executing and launching the task.
- Web Services
- Operation name: addTaskDefinition
- Example
- Create a definition for a task to enrich the marketing attributes
of a campaign.
Create a definition for a task to approve a new product for introduction to the general public.
Create a definition for a task to handle the merging of two duplicate records into one.
- Usage information
- A task definition is a prerequisite for creating a task. Task
definitions define the parameters within which a task operates. For
example, a task definition specifies which user roles are allowed
to access the task. As a result, the task using this task definition
cannot be assigned to anybody who does not belong to those specific
task owner roles.
This is a coarse-grained transaction. When a task owner role is assigned to a task definition, a task role association instance is created. If multiple roles are specified in a task definition, multiple association records are created. Each association record links the task definition to a single task owner role. When a task is created using a task definition, a task owner role must also be provided. The system then searches and retrieves the appropriate association record that represents the given task definition and task owner role and applies it to the task instance.
- Preconditions
- User roles must exist.
A task category must exist.
Metadata information type must exist.
TaskLaunchActionType must exist, if provided.
- Mandatory input
- TaskName
- TaskCatType or TaskCatValue
- TaskOwnerRole
- MetadataInfoType
- Inquiry levels
- Not applicable
- Filter values
- Not applicable
- Transaction behavior
- A task definition can be associated with multiple task owner roles.
TaskLaunchActionType is optional in a task definition. If a task is created with a task definition that does not have a launch action defined, the task cannot be opened.
If a TaskLaunchActionType is provided, valid task launch action data that is applicable to the given launch action type is required.
Task definitions of the same name must belong to the same task category.
The combination of a task name, a task category, and the metadata info type is unique in each task definition.
If the StartDate is not provided, the current system date and time is used by default.
The EndDate must be equal or later than the StartDate.
- Request message
- <DWLTxType> addTaskDefinition
<DWLTxObject> TaskDefinitionBObj
<DWLObject> TaskDefinitionBObj with TaskRoleAssocBObj
- Response objects
- TaskDefinitionBObj with a list of TaskRoleAssocBObj
- Special note
- Not applicable