Entity Fields

In the calculation formulas for custom formula metrics and calculated custom fields you can use fields (properties) of an entity.

An object in Targetprocess has fields (properties) that may refer to:

  • Simple value
  • Single object
  • Multiple objects (collection)
TypeDescriptionExamples for User Story
Simple ValueNumeric, text, date, boolean fields. It may include:
predefined fields
custom fields*

*Extended support for custom fields as simple values has been added in v3.12.9. In older versions support is limited.
Predefined fields:
ID
Name
CreateDate
Effort
TimeSpent

Custom fields:
FieldName
Single ObjectLink to a single entity. It may include:
entities that can be seen as cards
system objects
Entities that can be seen as cards:
Owner (User)
Project

System objects:
Entity State
Business Value / Priority
Multiple Objects (collection)List of multiple entities. It may include:
entities that can be seen as cards
system objects
Entities that can be seen as cards:
Tasks
Bugs
Times

System objects:
Assignments
RoleEfforts
Comments
Attachments
Relations
* CustomValues

In references to a single object you get objects and nested properties using dots.

EntityState.Name
EntityState.Role.Name
Priority.Importance
Owner.FullName
Project.ID

Work with parent and linked entities is described in the dedicated article: Parent and Linked Entities

Work with collections of multiple objects is more advanced topic. We'll describe it in separate article.

Examples: Simple Values

General:

Field NameField Type
IDNumberNumeric ID# of an entity.
NameTextName (title) of an entity.
DescriptionTextDescription of an entity. Contains HTML or markdown markup.
TagsTextList of assigned tags, comma-separated. For advanced processing, use TagObjects collection instead of Tags field.

Estimation, Progress Tracking, Time Tracking:

Field NameField Type
EffortNumberSum of total effort of an entity
TimeSpentNumberSum of total time spent for an entity
TimeRemainNumberSum of most recent forecasts taken from time records submitted to an entity
ProgressNumberProgress of an entity. Fractional number in [0..1] range.

Dates, Kanban Flow Metrics:

Field NameField Type
CreateDateDateDate an entity was created.
[Assignable]
StartDate
DateDate an entity was moved from initial or planned to a next workflow state.
[Assignable]
EndDate
DateDate an entity was moved to a final workflow state.
PlannedStartDate
PlannedEndDate
DateManually set date when work on an entity should be started / completed. Due dates, deadlines.
[Release, Iteration, TeamIteration]
StartDate
EndDate
DateManually set date range for work scope
ForecastEndDateDateEnd date predicted on current progress.

Can be used in Calculated Custom Fields
Cannot be used in Custom Formula Metrics
LeadTime
CycleTime
NumberLead Time, Cycle Time metrics.

Can be used in Calculated Custom Fields
Cannot be used in Custom Formula Metrics

User:

Field NameField Type
FirstName
LastName
FullName
Email
TextPersonal details of a user

Time:

Field NameField Type
SpentNumberAmount of spent hours
RemainNumberManually set forecast of remaining hours
DateDateDate for which the time spent record is submitted

Examples: Single object

Entity State:

Custom FormulaField Type
EntityState.NameTextName of current state of an entity in project workflow
EntityState.IsFinal
EntityState.IsInitial
EntityState.IsPlanned
BooleanCheck if current workflow state of an entity is final (last) / initial (first) / has "Planned" attribute
EntityState.Role.NameTextName of the role responsible for the current state of an entity
ResponsibleTeam.EntityState.NameTextName of current state of an entity in team workflow

Entity Type:

Custom FormulaField Type
EntityType.NameTextName of entity type of an entity

Business Values:

Custom FormulaField Type
Priority.NameTextName of Business Value of an entity
Priority.ImportanceNumberNumeric priority level of Business Value of an entity
[Bug]
Severity.Name
TextName of Severity of a Bug
[Bug]
Severity.Importance
NumberNumeric priority level of Severity of a Bug
[Request]
RequestType.Name
SourceType.ToString
TextType and Source of a Request

Owner:

Custom FormulaField Type
Owner.FirstName
Owner.LastName
Owner.FullName
Owner.Email
TextPersonal details of a user set as an Owner for an entity

Detailed Fields List per Entity Type