xlrelease.UserInputTask
Description unavailable
Type hierarchy: xlrelease.UserInputTask > xlrelease.Task > xlrelease.PlanItem > udm.BaseConfigurationItem
Label: User Input
Properties
| Property | Kind | Description |
|---|---|---|
| title | String | The title of the item. |
| description | String | The description of the item. |
| owner | String | The owner of the item. |
| scheduledStartDate | Date | The date that the item is supposed to start. |
| dueDate | Date | The date that the item is supposed to end. |
| startDate | Date | The actual start date. |
| endDate | Date | The actual end date. |
| plannedDuration | Integer | The time that the item is supposed to take to complete, in seconds. |
| flagStatus | Enum | Flags indicate that an item needs attention. |
| flagComment | String | The reason the item is flagged. |
| overdueNotified | Boolean | Overdue Notified |
| comments | List of xlrelease.Comment (contained) | The comments on the task. |
| container | xlrelease.TaskContainer (parent) | The phase or task this task is contained in. |
| facets | List of xlrelease.Facet (contained) | Facets applied to the task. |
| attachments | List of xlrelease.Attachment | List of file attachments on this task. |
| status | Enum | The state the task is in. |
| team | String | The name of the team this task is assigned to. |
| waitForScheduledStartDate | Boolean | The task is not started until the scheduledStartDate is reached if set to true. |
| delayDuringBlackout | Boolean | The task is to be delayed when a blackout period is active. |
| postponedDueToBlackout | Boolean | The task is postponed by a blackout period |
| originalScheduledStartDate | Date | The original scheduled start date. |
| hasBeenFlagged | Boolean | Has Been Flagged |
| hasBeenDelayed | Boolean | Has Been Delayed |
| precondition | String | A snippet of code that is evaluated when the task is started. |
| failureHandler | String | A snippet of code that is evaluated when the task is failed. |
| taskFailureHandlerEnabled | Boolean | The failed script will be executed. |
| taskRecoverOp | Enum | Task recovery operation performed after task failure. |
| phaseRecoverOp | Enum | Phase recovery operation performed after task recovery. |
| failuresCount | Integer | The number of times this task has failed. |
| executionId | String | Execution Id |
| variableMapping | Map | Map from property name to a variable name that replaces that property |
| tags | List of string | The tags of the task. Tags can be used for grouping and querying. |
| dueSoonNotified | Boolean | Due Soon Notified |
| locked | Boolean | The task is locked |
| checkAttributes | Boolean | Check attributes on task execution |
| watchers | Set of string | List of users watching this task |
| variables | List of xlrelease.Variable | Variables |
title
The title of the item.
- Label: Title
- Kind: String
- Required: true
description
The description of the item.
- Label: Description
- Kind: String
- Required: false
owner
The owner of the item.
- Label: Owner
- Kind: String
- Required: false
scheduledStartDate
The date that the item is supposed to start.
- Label: Scheduled Start Date
- Kind: Date
- Required: false
dueDate
The date that the item is supposed to end.
- Label: Due Date
- Kind: Date
- Required: false
startDate
The actual start date.
- Label: Start Date
- Kind: Date
- Required: false
endDate
The actual end date.
- Label: End Date
- Kind: Date
- Required: false
plannedDuration
The time that the item is supposed to take to complete, in seconds.
- Label: Planned Duration
- Kind: Integer
- Required: false
flagStatus
Flags indicate that an item needs attention.
- Label: Flag Status
- Kind: Enum
- Allowed values: OK, ATTENTION_NEEDED, AT_RISK
- Default value: OK
- Required: true
flagComment
The reason the item is flagged.
- Label: Flag Comment
- Kind: String
- Required: false
overdueNotified
Overdue Notified
- Label: Overdue Notified
- Kind: Boolean
- Default value: false
- Required: false
- Category: internal
comments
The comments on the task.
- Label: Comments
- Kind: List of xlrelease.Comment (contained)
- Required: false
- Reference type: xlrelease.Comment
- As containment: true
container
The phase or task this task is contained in.
- Label: Container
- Kind: xlrelease.TaskContainer (parent)
- Required: true
- Reference type: xlrelease.TaskContainer
- As containment: true
facets
Facets applied to the task.
- Label: Facets
- Kind: List of xlrelease.Facet (contained)
- Required: false
- Reference type: xlrelease.Facet
- As containment: true
attachments
List of file attachments on this task.
- Label: Attachments
- Kind: List of xlrelease.Attachment
- Required: false
- Reference type: xlrelease.Attachment
status
The state the task is in.
- Label: Status
- Kind: Enum
- Allowed values: PLANNED, PENDING, IN_PROGRESS, COMPLETED, COMPLETED_IN_ADVANCE, SKIPPED, SKIPPED_IN_ADVANCE, FAILED, FAILING, ABORTED, PRECONDITION_IN_PROGRESS, WAITING_FOR_INPUT, FAILURE_HANDLER_IN_PROGRESS, FACET_CHECK_IN_PROGRESS
- Required: true
team
The name of the team this task is assigned to.
- Label: Team
- Kind: String
- Required: false
waitForScheduledStartDate
The task is not started until the scheduledStartDate is reached if set to true.
- Label: Wait For Scheduled Start Date
- Kind: Boolean
- Default value: true
- Required: false
delayDuringBlackout
The task is to be delayed when a blackout period is active.
- Label: Delay During Blackout
- Kind: Boolean
- Default value: false
- Required: false
postponedDueToBlackout
The task is postponed by a blackout period
- Label: Postponed Due To Blackout
- Kind: Boolean
- Default value: false
- Required: false
- Category: internal
originalScheduledStartDate
The original scheduled start date.
- Label: Original Scheduled Start Date
- Kind: Date
- Required: false
- Category: internal
hasBeenFlagged
Has Been Flagged
- Label: Has Been Flagged
- Kind: Boolean
- Default value: false
- Required: false
- Category: internal
hasBeenDelayed
Has Been Delayed
- Label: Has Been Delayed
- Kind: Boolean
- Default value: false
- Required: false
- Category: internal
precondition
A snippet of code that is evaluated when the task is started.
- Label: Precondition
- Kind: String
- Required: false
failureHandler
A snippet of code that is evaluated when the task is failed.
- Label: Failure Handler
- Kind: String
- Required: false
taskFailureHandlerEnabled
The failed script will be executed.
- Label: Task Failure Handler Enabled
- Kind: Boolean
- Default value: false
- Required: false
taskRecoverOp
Task recovery operation performed after task failure.
- Label: Task Recover Op
- Kind: Enum
- Allowed values: FAIL_TASK, SKIP_TASK, RUN_SCRIPT
- Required: false
phaseRecoverOp
Phase recovery operation performed after task recovery.
- Label: Phase Recover Op
- Kind: Enum
- Allowed values: NO_PHASE_RECOVER, SKIP_PHASE, RESTART_ORIGINAL, RESTART_LATEST
- Required: false
failuresCount
The number of times this task has failed.
- Label: Failures Count
- Kind: Integer
- Default value: 0
- Required: true
executionId
Execution Id
- Label: Execution Id
- Kind: String
- Required: false
- Category: internal
variableMapping
Map from property name to a variable name that replaces that property
- Label: Variable Mapping
- Kind: Map
- Required: false
tags
The tags of the task. Tags can be used for grouping and querying.
- Label: Tags
- Kind: List of string
- Required: false
dueSoonNotified
Due Soon Notified
- Label: Due Soon Notified
- Kind: Boolean
- Default value: false
- Required: false
- Category: internal
locked
The task is locked
- Label: Locked
- Kind: Boolean
- Default value: false
- Required: false
checkAttributes
Check attributes on task execution
- Label: Check Attributes
- Kind: Boolean
- Default value: false
- Required: false
watchers
List of users watching this task
- Label: Watchers
- Kind: Set of string
- Required: false
variables
Variables
- Label: Variables
- Kind: List of xlrelease.Variable
- Required: true
- Reference type: xlrelease.Variable
Hidden properties
| Property | Kind | Description |
|---|---|---|
| maxCommentSize | Integer | Maximum size of a comment on a task. Default value is 32768. |
| configurationUri | String | URI of the HTML file to render the task |
| automated | Boolean | Indicates whether this is an automated task |
| preconditionEnabled | Boolean | Indicates whether preconditions should be enabled |
| failureHandlerEnabled | Boolean | Indicates whether failure handler should be enabled |
| sendNotificationWhenStarted | Boolean | Indicates whether a notification must be sent when the task starts |
maxCommentSize
Maximum size of a comment on a task. Default value is 32768.
- Key:
xlrelease.UserInputTask.maxCommentSize - Kind: Integer
- Default value: 32768
- Category: internal
- Hidden: true
configurationUri
URI of the HTML file to render the task
- Key:
xlrelease.UserInputTask.configurationUri - Kind: String
- Hidden: true
automated
Indicates whether this is an automated task
- Key:
xlrelease.UserInputTask.automated - Kind: Boolean
- Default value: false
- Hidden: true
preconditionEnabled
Indicates whether preconditions should be enabled
- Key:
xlrelease.UserInputTask.preconditionEnabled - Kind: Boolean
- Default value: true
- Hidden: true
failureHandlerEnabled
Indicates whether failure handler should be enabled
- Key:
xlrelease.UserInputTask.failureHandlerEnabled - Kind: Boolean
- Default value: true
- Hidden: true
sendNotificationWhenStarted
Indicates whether a notification must be sent when the task starts
- Key:
xlrelease.UserInputTask.sendNotificationWhenStarted - Kind: Boolean
- Default value: true
- Hidden: true