Class FSCSCRUM@1.1001:BacklogItem

Backlog item is the abstract base class for stories and defects

Class Hierarchy

Direct Subclasses

Additional Information

Commonly usable

Properties

Type	Property	Name
integer	businessvalue	Business Value
Impediment[]	impediments	Impediments
Term	storyadmincategory	Administrative Category
Term[]	storyaffectedapps	Affected Applications
date	storyallocatedat	Allocated on/at
StoryCategoryType	storycategory	Category
string[]	storychangelog	Change Log
content	storychanges	Changes
CompletedWithType[]	storycompletedwith	Completed With
string[]	storycondsofsatisfaction	Acceptance Criteria
Object	storycontext	Context
float(3, 2)	storycurrmandays	Effort in Current Sprint (MD)
Defect[]	storydefects	Caused Defects
BacklogItem[]	storydependencyfor	Dependency for
BacklogItem[]	storydependentonstories	Dependent on
EffortType[]	storyeffort	Effort
BacklogItem	storyentermasterstory	Merge Into
ExternalIDType[]	storyexternalids	External IDs
BacklogItem	storyfeaturestory	Feature
Term	storyfeatureteam	Feature Team
Term	storyhierarchylevel	Hierarchy Level
integer	storyhoursplanned	Planned (Hours) - not used anymore
string	storyid	ID
Term[]	storyimpactareas	Impact Areas
BacklogItem[]	storyjoinedstories	Merged From
date	storylastversionreleasechange	Last Version or Release Change on/at
User	storylead	Lead
boolean	storylocked	Locked
float(3, 2)	storymandays	Total Effort (MD)
BacklogItem	storymasterstory	Merged With
MergeInfo[]	storymergeinfo	Merge Requests
integer	storyordernumber	Order
float(3, 2)	storypctdone	Done (%)
FibonacciList	storypoints	Size (Story Points)
StoryPriorityType	storypriority	Priority
ScrumProject	storyproject	Scrum Project
Release	storyrelease	Release
RepositoryInfo[]	storyrepoinfo	Repository Information
AdministrationObject	storyrequestedby	Requested by
RequestedForType	storyrequestedfor	Requested for
Defect[]	storyrequirementfor	Provides Requirements for
integer	storysize	Size (Accumulated)
integer	storysizedone	Done (Story Points)
BacklogItem	storysplitfrom	Split from
BacklogItem[]	storysplitstories	Split Into
Sprint	storysprint	Sprint
Term	storystage	Current Stage
AdministrationObject[]	storystakeholders	Stakeholders
ComponentState	storystate	State
date	storystatechangedat	Last State Change on/at
BacklogItem[]	storystories	Subordinate Items
string[]	storysubject	Story
Task[]	storytasks	Tasks
Term	storyterm	Topic
integer	storytimeleft	Estimated Remaining Time
integer	storytimeplanned	Planned Effort
integer	storytimeprocessed	Total Processing Time
integer	storytimeprocessedalloc	Processing Time Since Allocation
integer	storytimeworked	Time Worked
integer	storytimeworkedsprint	Time Worked in Sprint
integer	storytotaltimeleft	Remaining Time (Including Subordinate Items)
integer	storytotaltimeplanned	Planned Effort (Including Subordinate Items)
integer	storytotaltimeworked	Time Worked (Including Subordinate Items)
integer	storytotaltimeworkedsprint	Time Worked in Sprint (Including Subordinate Items)
Version	storyversion	Product Version

Actions

Return Type	Signature
object[]	GetChildren( out retval object[] objlist, optional boolean includebacklinks, optional object[] attrdefs)

Properties

Business Value (FSCSCRUM@1.1001:businessvalue)

Contains an abstract relatively comparable numeric value that can be used to manually document the business value to give team members a relevant sorting criterion in decision finding.

Explanation:
Defines the business value that can be generated by implementing the story.

integer FSCSCRUM@1.1001:businessvalue readonly volatile

Additional Information

Access Types for Changing Property: AccTypeChangeSensitive

Impediments (FSCSCRUM@1.1001:impediments)

unique Impediment[] FSCSCRUM@1.1001:impediments readonly

Additional Information

Access Types for Changing Property: AccTypeChangeSensitive
Access Types for Reading Property: AccTypeReadSensitive
Property for Back Link: impaffecteditems

Administrative Category (FSCSCRUM@1.1001:storyadmincategory)

Term FSCSCRUM@1.1001:storyadmincategory readonly

Additional Information

Object Classes Allowed: Term

Affected Applications (FSCSCRUM@1.1001:storyaffectedapps)

unique Term[] FSCSCRUM@1.1001:storyaffectedapps readonly

Additional Information

Object Classes Allowed: Term

Allocated on/at (FSCSCRUM@1.1001:storyallocatedat)

date FSCSCRUM@1.1001:storyallocatedat local readonly

Category (FSCSCRUM@1.1001:storycategory)

A type of stories.
The category will be considered when calculating the storypctdone. If there are only design or spike stories in the storystories list of a feature, storypctdone will be null even if the design or spike stories are done or released.
If the feature itself is a design or spike feature storypctdone will be calculated as expected.

Explanation:
In this field a category for the story can be selected.

StoryCategoryType FSCSCRUM@1.1001:storycategory

Change Log (FSCSCRUM@1.1001:storychangelog)

A free-text field that can be used to describe the changes the backlog item causes.

string[] FSCSCRUM@1.1001:storychangelog

Changes (FSCSCRUM@1.1001:storychanges)

In this field the text from the repository is stored.

content FSCSCRUM@1.1001:storychanges readonly

Additional Information

Access Types for Changing Property: AccTypeRead

Completed With (FSCSCRUM@1.1001:storycompletedwith)

Defines the product version, release and build the backlog item was completed with.

unique CompletedWithType[] FSCSCRUM@1.1001:storycompletedwith readonly

Additional Information

Access Types for Changing Property: AccTypeRead

Acceptance Criteria (FSCSCRUM@1.1001:storycondsofsatisfaction)

In this field the conditions for completing a story or defect are specified.

string[] FSCSCRUM@1.1001:storycondsofsatisfaction

Context (FSCSCRUM@1.1001:storycontext)

Context of a story or defect. Per default a group or a project can be referenced. FSCSERVICEDESK and FSCTICKETING extend this property so that support requests or service tickets can be used as well.

Explanation:
Defines an organization, organizational unit or support request the backlog item is related to.

Object FSCSCRUM@1.1001:storycontext readonly

Additional Information

Object Classes Allowed: Group, Project, SupportRequest, ServiceTicket

Effort in Current Sprint (MD) (FSCSCRUM@1.1001:storycurrmandays)

In this field the user working on this story or defect can define the effort in man days.

float(3, 2) FSCSCRUM@1.1001:storycurrmandays

Caused Defects (FSCSCRUM@1.1001:storydefects)

unique Defect[] FSCSCRUM@1.1001:storydefects readonly

Additional Information

Property for Back Link: defectcausingstories

Dependency for (FSCSCRUM@1.1001:storydependencyfor)

unique BacklogItem[] FSCSCRUM@1.1001:storydependencyfor readonly

Additional Information

Property for Back Link: storydependentonstories

Dependent on (FSCSCRUM@1.1001:storydependentonstories)

unique BacklogItem[] FSCSCRUM@1.1001:storydependentonstories readonly

Additional Information

Property for Back Link: storydependencyfor

Effort (FSCSCRUM@1.1001:storyeffort)

This list displays the effort of a story or defect for each sprint the story or defect has been added to. When setting a story or defect to “Released” or “Not Released” an entry for this sprint is added to this list and the value of the Effort in Current Sprint (MD) field is taken over.

EffortType[] FSCSCRUM@1.1001:storyeffort readonly

Merge Into (FSCSCRUM@1.1001:storyentermasterstory)

The current object will be removed from its context (project, version, release, sprint, feature) and joined with the story selected in this property.

BacklogItem FSCSCRUM@1.1001:storyentermasterstory not null readonly

Additional Information

Object Classes Allowed: BacklogItem

External IDs (FSCSCRUM@1.1001:storyexternalids)

unique ExternalIDType[] FSCSCRUM@1.1001:storyexternalids

Feature (FSCSCRUM@1.1001:storyfeaturestory)

Defines a story that represents the superordinate feature of the current story. If a Feature Project is defined in the scrum project, only stories from the feature project can be selected.

BacklogItem FSCSCRUM@1.1001:storyfeaturestory readonly

Additional Information

Object Classes Allowed: BacklogItem
Property for Back Link: storystories

Feature Team (FSCSCRUM@1.1001:storyfeatureteam)

If feature teams are defined in the scrum project ("Scrum Project" tab > Feature Teams), a feature team can be assigned to the backlog item.

Term FSCSCRUM@1.1001:storyfeatureteam readonly

Additional Information

Object Classes Allowed: Term

Hierarchy Level (FSCSCRUM@1.1001:storyhierarchylevel)

Term FSCSCRUM@1.1001:storyhierarchylevel readonly

Additional Information

Object Classes Allowed: Term

Planned (Hours) - not used anymore (FSCSCRUM@1.1001:storyhoursplanned)

integer FSCSCRUM@1.1001:storyhoursplanned readonly volatile invisible

ID (FSCSCRUM@1.1001:storyid)

Defines the unique story id either within a scrum project or within a scrum center. The story id is taken from the scrum project ( if project specific numbering is configured) or from the scrum center when the story is assigned to a scrum project. If a story id is already set and the last source for generating the id is the same as for the current operation, the story id will not be changed.

Explanation:
The identifier of the backlog item is a combination of the short form of the scrum center or scrum project and a running number. If the short form is defined in the scrum center, the ID is assigned automatically when the backlog item is added to the inbox. If the short form is defined in the scrum project, the ID is assigned automatically when the backlog item is accepted.

string FSCSCRUM@1.1001:storyid readonly

Impact Areas (FSCSCRUM@1.1001:storyimpactareas)

unique Term[] FSCSCRUM@1.1001:storyimpactareas readonly

Additional Information

Object Classes Allowed: Term

Merged From (FSCSCRUM@1.1001:storyjoinedstories)

unique BacklogItem[] FSCSCRUM@1.1001:storyjoinedstories readonly

Additional Information

Access Types for Changing Property: AccTypeRead
Access Types for Reading Property: AccTypeReadComp
Describes Child Relationship

Last Version or Release Change on/at (FSCSCRUM@1.1001:storylastversionreleasechange)

date FSCSCRUM@1.1001:storylastversionreleasechange local readonly

Lead (FSCSCRUM@1.1001:storylead)

Defines a team member that should take the lead.

User FSCSCRUM@1.1001:storylead readonly

Additional Information

Object Classes Allowed: User

Locked (FSCSCRUM@1.1001:storylocked)

boolean FSCSCRUM@1.1001:storylocked

Total Effort (MD) (FSCSCRUM@1.1001:storymandays)

This field displays the total effort of a story in man days and is calculated from the total amount of all entries in the Effort list.

float(3, 2) FSCSCRUM@1.1001:storymandays readonly volatile

Merged With (FSCSCRUM@1.1001:storymasterstory)

BacklogItem FSCSCRUM@1.1001:storymasterstory readonly

Merge Requests (FSCSCRUM@1.1001:storymergeinfo)

MergeInfo[] FSCSCRUM@1.1001:storymergeinfo readonly

Order (FSCSCRUM@1.1001:storyordernumber)

This field defines the priority of the story or defect relative to other backlog items. This value can be set automatically when fixing the backlog order or manually.

integer FSCSCRUM@1.1001:storyordernumber

Done (%) (FSCSCRUM@1.1001:storypctdone)

The percentage of stories done or released compared to the total size of the stories in storystories. If there are stories that have no storypoints or that are not ratealbe, the storysize is null and therefore storypctdone is null, too.
If a feature is not a design/spike feature storypctdone is null if there are only design/spike stories in storystories. Set storycategory to define design/spike stories or features.
Defects and impediments are not considered except if scdefectstorypoints is configured at the scrum center.

float(3, 2) FSCSCRUM@1.1001:storypctdone readonly volatile

Additional Information

Access Types for Changing Property: AccTypeRead

Size (Story Points) (FSCSCRUM@1.1001:storypoints)

The size of the story in story points.
When changed the other size properties (storysize, storypctdone, storysizedone) will be calculated, too.

Explanation:
Stories have to be estimated when adding them to a sprint. By default story points are not used for defects and impediments but they can be enabled in the scrum center ("General Settings" tab > Allow Story Points for Defects and Impediments).

FibonacciList FSCSCRUM@1.1001:storypoints

Priority (FSCSCRUM@1.1001:storypriority)

One of four different priorities can be selected for a backlog item (from "must have" to "nice to have").

StoryPriorityType FSCSCRUM@1.1001:storypriority

Scrum Project (FSCSCRUM@1.1001:storyproject)

In this field the Scrum Project of the Story or Defect is displayed.

ScrumProject FSCSCRUM@1.1001:storyproject readonly

Release (FSCSCRUM@1.1001:storyrelease)

Defines the release for which the backlog item should be completed. Releases can be defined in product versions.

Release FSCSCRUM@1.1001:storyrelease readonly

Additional Information

Object Classes Allowed: Release
Property for Back Link: relstories

Repository Information (FSCSCRUM@1.1001:storyrepoinfo)

In this field data from the repository is displayed.

RepositoryInfo[] FSCSCRUM@1.1001:storyrepoinfo readonly

Requested by (FSCSCRUM@1.1001:storyrequestedby)

Defines a user who requests the backlog item (by default the creator of the backlog item).

AdministrationObject FSCSCRUM@1.1001:storyrequestedby readonly

Additional Information

Access Types for Changing Property: AccTypeChangeSecRel
Access Types for Reading Property: AccTypeReadSecRel
Object Classes Allowed: User, Group

Requested for (FSCSCRUM@1.1001:storyrequestedfor)

The backlog item can be requested for a concrete product version and release.

unique RequestedForType FSCSCRUM@1.1001:storyrequestedfor readonly

Provides Requirements for (FSCSCRUM@1.1001:storyrequirementfor)

unique Defect[] FSCSCRUM@1.1001:storyrequirementfor readonly

Additional Information

Object Classes Allowed: Defect
Property for Back Link: defectrequirementstories

Size (Accumulated) (FSCSCRUM@1.1001:storysize)

The calculated size of a story.
For stories, the size is retrieved from its storypoints. If as story is not rateable the storysize will be null.
For features, the sum of the storysize of all substories stored in storystories is calculated. If a substory has no storypoints or is not ratealbe the storysize of the feature is null.
Defects and impediments are not considered for the size of a feature except if scdefectstorypoints is configured at the scrum center.

Explanation:
If a backlog item is defined as feature of other backlog items the sum of story points of these backlog items is shown in this field.

integer FSCSCRUM@1.1001:storysize readonly volatile

Additional Information

Access Types for Changing Property: AccTypeRead

Done (Story Points) (FSCSCRUM@1.1001:storysizedone)

The sum of storysize of those stories in storystories that are done or released.
Defects and impediments are not considered except if scdefectstorypoints is configured at the scrum center.

integer FSCSCRUM@1.1001:storysizedone readonly volatile

Additional Information

Access Types for Changing Property: AccTypeRead

Split from (FSCSCRUM@1.1001:storysplitfrom)

BacklogItem FSCSCRUM@1.1001:storysplitfrom readonly

Additional Information

Access Types for Changing Property: AccTypeRead
Property for Back Link: storysplitstories

Split Into (FSCSCRUM@1.1001:storysplitstories)

unique BacklogItem[] FSCSCRUM@1.1001:storysplitstories readonly

Additional Information

Access Types for Changing Property: AccTypeRead
Property for Back Link: storysplitfrom

Sprint (FSCSCRUM@1.1001:storysprint)

Shows the sprint the backlog item is assigned to.

Sprint FSCSCRUM@1.1001:storysprint readonly

Additional Information

Object Classes Allowed: Sprint

Current Stage (FSCSCRUM@1.1001:storystage)

Term FSCSCRUM@1.1001:storystage readonly

Additional Information

Object Classes Allowed: Term

Stakeholders (FSCSCRUM@1.1001:storystakeholders)

unique AdministrationObject[] FSCSCRUM@1.1001:storystakeholders readonly

Additional Information

Access Types for Changing Property: AccTypeChangeSecRel
Access Types for Reading Property: AccTypeReadSecRel
Object Classes Allowed: User, Group

State (FSCSCRUM@1.1001:storystate)

Shows the current state ("Received", "Planning", "In Progress", "To Verify", "Done", "Released", "Not Released") of the backlog item.

ComponentState FSCSCRUM@1.1001:storystate not null readonly

Additional Information

Access Types for Changing Property: AccTypeRead

Last State Change on/at (FSCSCRUM@1.1001:storystatechangedat)

date FSCSCRUM@1.1001:storystatechangedat local readonly

Subordinate Items (FSCSCRUM@1.1001:storystories)

Defines all subordinate backlog items of a story that represents a feature.

unique BacklogItem[] FSCSCRUM@1.1001:storystories readonly

Additional Information

Property for Back Link: storyfeaturestory

Story (FSCSCRUM@1.1001:storysubject)

Contains the description of the backlog item.

string[] FSCSCRUM@1.1001:storysubject

Tasks (FSCSCRUM@1.1001:storytasks)

In this list all associated tasks are displayed.

unique Task[] FSCSCRUM@1.1001:storytasks readonly

Additional Information

Access Types for Changing Property: AccTypeChangeComp
Access Types for Reading Property: AccTypeReadComp
Describes Child Relationship

Topic (FSCSCRUM@1.1001:storyterm)

If backlog item topics are defined in the scrum center or scrum project ("Structuring" tab > Topics for Structuring Backlog Items), a topic can be assigned to the backlog item.

Term FSCSCRUM@1.1001:storyterm readonly

Additional Information

Object Classes Allowed: Term

Estimated Remaining Time (FSCSCRUM@1.1001:storytimeleft)

unsigned integer FSCSCRUM@1.1001:storytimeleft readonly volatile

Planned Effort (FSCSCRUM@1.1001:storytimeplanned)

unsigned integer FSCSCRUM@1.1001:storytimeplanned readonly volatile

Total Processing Time (FSCSCRUM@1.1001:storytimeprocessed)

Provides the time needed to process a backlog item. The persisted value is only used, if a backlog item is set to "Released", "Not Released" or "Rejected". Otherwise the calculated value for the timespan between the creation of the story/defect and the current time is delivered.

unsigned integer FSCSCRUM@1.1001:storytimeprocessed readonly volatile

Processing Time Since Allocation (FSCSCRUM@1.1001:storytimeprocessedalloc)

Provides the time passed since the backlog item was allocated to the current scrum project.

unsigned integer FSCSCRUM@1.1001:storytimeprocessedalloc readonly volatile

Time Worked (FSCSCRUM@1.1001:storytimeworked)

unsigned integer FSCSCRUM@1.1001:storytimeworked readonly volatile

Time Worked in Sprint (FSCSCRUM@1.1001:storytimeworkedsprint)

unsigned integer FSCSCRUM@1.1001:storytimeworkedsprint readonly volatile

Remaining Time (Including Subordinate Items) (FSCSCRUM@1.1001:storytotaltimeleft)

unsigned integer FSCSCRUM@1.1001:storytotaltimeleft readonly volatile

Planned Effort (Including Subordinate Items) (FSCSCRUM@1.1001:storytotaltimeplanned)

unsigned integer FSCSCRUM@1.1001:storytotaltimeplanned readonly volatile

Time Worked (Including Subordinate Items) (FSCSCRUM@1.1001:storytotaltimeworked)

unsigned integer FSCSCRUM@1.1001:storytotaltimeworked readonly volatile

Time Worked in Sprint (Including Subordinate Items) (FSCSCRUM@1.1001:storytotaltimeworkedsprint)

unsigned integer FSCSCRUM@1.1001:storytotaltimeworkedsprint readonly volatile

Product Version (FSCSCRUM@1.1001:storyversion)

Defines the product version for which the backlog item should be completed. Product versions can be defined in the scrum center or scrum project.

Version FSCSCRUM@1.1001:storyversion readonly

Additional Information

Object Classes Allowed: Version
Property for Back Link: verstories

Actions

FSCFOLIO@1.1001:GetChildren

Get the children of an object which are stored in attributes marked with attrischild = TRUE. The action does not read the children in a recursive way. To retrieve the children in a recursive way the action GetChildrenEx can be used.
Note: If the object has an attribute definition with object class AttributeObjectMappingDef the children of registered folders are also included.

object[] FSCFOLIO@1.1001:GetChildren(
  out retval object[] objlist,
  optional boolean includebacklinks,
  optional object[] attrdefs)

Name	Description
objlist	the result
includebacklinks	if set the backlink objects themselves are included instead of the mapped values of attributes of type `AttributeBackLinkDef`
attrdefs	if set only the children from the specified attributes are returned