Contribute in GitHub:
Edit online
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)
| Type | Description | Examples |
|---|---|---|
| Simple Value | Numeric, 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 Object | Link to a single entity. It may include: entities that can be seen as cards | Entities that can be seen as cards:Owner (User)Project System objects:Entity StateBusiness Value / Prioritysystem objects |
| 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 Role Efforts Comments Attachments Relations *CustomValues |
/api/v1/FeatureHistories /api/v2/FeatureHistories /api/history/v2/Feature
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 Name | Field Type | |
|---|---|---|
| ID | Number | Numeric ID# of an entity. |
| Name | Text | Name (title) of an entity. |
| Description | Text | Description of an entity. Contains HTML or markdown markup. |
| Tags | Text | List of assigned tags, comma-separated. For advanced processing, use TagObjects collection instead of Tags field. |
Estimation, Progress Tracking, Time Tracking:
| Field Name | Field Type | |
|---|---|---|
| Effort | Number | Sum of total effort of an entity |
| TimeSpent | Number | Sum of total time spent for an entity |
| TimeRemain | Number | Sum of most recent forecasts taken from time records submitted to an entity |
| Progress | Number | Progress of an entity. Fractional number in [0..1] range. |
Dates, Kanban Flow Metrics:
| Field Name | Field Type | |
|---|---|---|
| CreateDate | Date | Date an entity was created. |
| [Assignable] StartDate | Date | Date an entity was moved from initial or planned to a next workflow state. |
| [Assignable] EndDate | Date | Date an entity was moved to a final workflow state. |
| PlannedStartDate PlannedEndDate | Date | Manually set date when work on an entity should be started / completed. Due dates, deadlines. |
| [Release, Iteration, TeamIteration] StartDate EndDate | Date | Manually set date range for work scope |
| ForecastEndDate | Date | End date predicted on current progress.Can be used in Calculated Custom Fields Cannot be used in Custom Formula Metrics |
| LeadTime CycleTime | Number | Lead Time, Cycle Time metrics. Can be used in Calculated Custom Fields Cannot be used in Custom Formula Metrics |
User:
| Field Name | Field Type | |
|---|---|---|
| FirstName LastName FullName Email | Text | Personal details of a user |
Time:
| Field Name | Field Type | |
|---|---|---|
| Spent | Number | Amount of spent hours |
| Remain | Number | Manually set forecast of remaining hours |
| Date | Date | Date for which the time spent record is submitted |
Examples: Single object
Entity State:
| Custom Formula | Field Type | |
|---|---|---|
| EntityState.Name | Text | Name of current state of an entity in project workflow |
| EntityState.IsFinal EntityState.IsInitial EntityState.IsPlanned | Boolean | Check if current workflow state of an entity is final (last) / initial (first) / has "Planned" attribute |
| EntityState.Role.Name | Text | Name of the role responsible for the current state of an entity |
| ResponsibleTeam.EntityState.Name | Text | Name of current state of an entity in team workflow |
Entity Type:
| Custom Formula | Field Type | |
|---|---|---|
| EntityType.Name | Text | Name of entity type of an entity |
Business Values:
| Custom Formula | Field Type | |
|---|---|---|
| Priority.Name | Text | Name of Business Value of an entity |
| Priority.Importance | Number | Numeric priority level of Business Value of an entity |
| [Bug] Severity.Name | Text | Name of Severity of a Bug |
| [Bug] Severity.Importance | Number | Numeric priority level of Severity of a Bug |
| [Request] RequestType.Name SourceType.ToString | Text | Type and Source of a Request |
Owner:
| Custom Formula | Field Type | |
|---|---|---|
| Owner.FirstName Owner.LastName Owner.FullName Owner.Email | Text | Personal details of a user set as an Owner for an entity |