xlrelease.Release
A release or template.
Type hierarchy: xlrelease.Release > xlrelease.PlanItem > udm.BaseConfigurationItem
Label: Xlrelease: Release
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 |
rootReleaseId | String | Root Release Id |
maxConcurrentReleases | Integer | The maximum number of concurrent releases that can be started by Create Release tasks |
releaseTriggers | List of xlrelease.ReleaseTrigger (contained) | The triggers that may start a release from a template. (Templates only) |
teams | List of xlrelease.Team (contained) | The teams configured on the release. |
memberViewers | List of string | Member Viewers |
roleViewers | List of string | Role Viewers |
attachments | List of xlrelease.Attachment (contained) | File attachments of the release. |
phases | List of xlrelease.Phase (contained) | The list of phases in the release. |
queryableStartDate | Date | Queryable Start Date |
queryableEndDate | Date | Queryable End Date |
realFlagStatus | Enum | The calculated flag status, derived from the flags from the release and its tasks. |
status | Enum | The state the release is in. |
tags | List of string | The tags of the release. Tags can be used for grouping and querying. |
variables | List of xlrelease.Variable (contained) | List of variable CIs representing variables in this release or template |
calendarLinkToken | String | Calendar Link Token |
calendarPublished | Boolean | Calendar Published |
tutorial | Boolean | Tutorial |
abortOnFailure | Boolean | Releases automatically abort when a task fails if this property is set to true. |
allowConcurrentReleasesFromTrigger | Boolean | If set to false, a trigger can’t create a release if the previous one it created is still running. |
originTemplateId | String | The ID of the template that created this release. |
runningTriggeredReleasesCount | Integer | Running Triggered Releases Count |
createdFromTrigger | Boolean | True if release was created by a trigger. |
scriptUsername | String | The credentials of this user are used to run automated scripts in this release. |
scriptUserPassword | Password | The password of the user that lends his credentials to run the scripts. |
extensions | List of xlrelease.ReleaseExtension (contained) | Extensions of this release, e.g. ‘Release contents dashboard’ |
startedFromTaskId | String | The Create Release task from which this release was created, if any |
autoStart | Boolean | If true, the release will automatically start at scheduledStartDate. |
automatedResumeCount | Integer | Automated Resume Count |
abortComment | String | The comment to associate with the action |
riskProfile | xlrelease.RiskProfile | Risk profile used in risk calculations |
riskScore | String | Risk score |
totalRiskScore | String | Total risk score |
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
rootReleaseId
Root Release Id
- Label: Root Release Id
- Kind: String
- Required: false
- Category: internal
maxConcurrentReleases
The maximum number of concurrent releases that can be started by Create Release tasks
- Label: Max Concurrent Releases
- Kind: Integer
- Default value: 100
- Required: true
- Category: internal
releaseTriggers
The triggers that may start a release from a template. (Templates only)
- Label: Release Triggers
- Kind: List of xlrelease.ReleaseTrigger (contained)
- Required: false
- Reference type: xlrelease.ReleaseTrigger
- As containment: true
teams
The teams configured on the release.
- Label: Teams
- Kind: List of xlrelease.Team (contained)
- Required: false
- Reference type: xlrelease.Team
- As containment: true
- Transient: true
memberViewers
Member Viewers
- Label: Member Viewers
- Kind: List of string
- Required: false
- Category: internal
- Transient: true
roleViewers
Role Viewers
- Label: Role Viewers
- Kind: List of string
- Required: false
- Category: internal
- Transient: true
attachments
File attachments of the release.
- Label: Attachments
- Kind: List of xlrelease.Attachment (contained)
- Required: false
- Reference type: xlrelease.Attachment
- As containment: true
phases
The list of phases in the release.
- Label: Phases
- Kind: List of xlrelease.Phase (contained)
- Required: false
- Reference type: xlrelease.Phase
- As containment: true
queryableStartDate
Queryable Start Date
- Label: Queryable Start Date
- Kind: Date
- Required: false
- Category: internal
queryableEndDate
Queryable End Date
- Label: Queryable End Date
- Kind: Date
- Required: false
- Category: internal
realFlagStatus
The calculated flag status, derived from the flags from the release and its tasks.
- Label: Real Flag Status
- Kind: Enum
- Allowed values: OK, ATTENTION_NEEDED, AT_RISK
- Default value: OK
- Required: true
status
The state the release is in.
- Label: Status
- Kind: Enum
- Allowed values: TEMPLATE, PLANNED, IN_PROGRESS, PAUSED, FAILING, FAILED, COMPLETED, ABORTED
- Required: true
tags
The tags of the release. Tags can be used for grouping and querying.
- Label: Tags
- Kind: List of string
- Required: false
variables
List of variable CIs representing variables in this release or template
- Label: Variables
- Kind: List of xlrelease.Variable (contained)
- Required: false
- Reference type: xlrelease.Variable
- As containment: true
calendarLinkToken
Calendar Link Token
- Label: Calendar Link Token
- Kind: String
- Required: false
- Category: internal
calendarPublished
Calendar Published
- Label: Calendar Published
- Kind: Boolean
- Default value: false
- Required: false
- Category: internal
tutorial
Tutorial
- Label: Tutorial
- Kind: Boolean
- Default value: false
- Required: false
- Category: internal
abortOnFailure
Releases automatically abort when a task fails if this property is set to true.
- Label: Abort On Failure
- Kind: Boolean
- Default value: false
- Required: false
allowConcurrentReleasesFromTrigger
If set to false, a trigger can’t create a release if the previous one it created is still running.
- Label: Allow Concurrent Releases From Trigger
- Kind: Boolean
- Default value: true
- Required: false
originTemplateId
The ID of the template that created this release.
- Label: Origin Template Id
- Kind: String
- Required: false
runningTriggeredReleasesCount
Running Triggered Releases Count
- Label: Running Triggered Releases Count
- Kind: Integer
- Default value: 0
- Required: true
- Category: internal
createdFromTrigger
True if release was created by a trigger.
- Label: Created From Trigger
- Kind: Boolean
- Default value: false
- Required: false
scriptUsername
The credentials of this user are used to run automated scripts in this release.
- Label: Script Username
- Kind: String
- Required: false
scriptUserPassword
The password of the user that lends his credentials to run the scripts.
- Label: Script User Password
- Kind: Password
- Password: true
- Required: false
extensions
Extensions of this release, e.g. ‘Release contents dashboard’
- Label: Extensions
- Kind: List of xlrelease.ReleaseExtension (contained)
- Required: false
- Reference type: xlrelease.ReleaseExtension
- As containment: true
startedFromTaskId
The Create Release task from which this release was created, if any
- Label: Started From Task Id
- Kind: String
- Required: false
autoStart
If true, the release will automatically start at scheduledStartDate.
- Label: Auto Start
- Kind: Boolean
- Default value: false
- Required: false
automatedResumeCount
Automated Resume Count
- Label: Automated Resume Count
- Kind: Integer
- Default value: 0
- Required: true
- Category: internal
abortComment
The comment to associate with the action
- Label: Abort Comment
- Kind: String
- Required: false
riskProfile
Risk profile used in risk calculations
- Label: Risk Profile
- Kind: xlrelease.RiskProfile
- Required: false
- Reference type: xlrelease.RiskProfile
riskScore
Risk score
- Label: Risk Score
- Kind: String
- Default value: 000
- Required: false
totalRiskScore
Total risk score
- Label: Total Risk Score
- Kind: String
- Default value: 0000
- Required: false
Hidden properties
Property | Kind | Description |
---|---|---|
maxAutomatedResumes | Integer | The maximum number of automatic release resumes performed during phase restarts. |
maxAutomatedResumes
The maximum number of automatic release resumes performed during phase restarts.
- Key:
xlrelease.Release.maxAutomatedResumes
- Kind: Integer
- Default value: 50
- Category: internal
- Hidden: true