Task Progress
Definition and Usage
The Task Progress reusable component is a widget that displays progress information for a task. It is designed specifically for displaying the progress of a change request task. It includes a progress bar, a count of the total members that have completed the task, and a summary of member votes. At the bottom it includes a configurable link.
The following is a sample image showing the Task Progress reusable component:
There are no predefined configurations available for the Task Progress reusable component.
Binding Properties
There is one property for the Task Progress component that is available for binding:
• Input— JSON that is the input ID for which data needs to be fetched from the backend system. This information is provided in a CCO (Common Communication Object) format. The following is a sample:
{
"version":"1.0.0",
"data":[
{
"adapter":{
"thingName":"PTC.WCAdapter",
"instanceName":"windchill"
},
"itemListsData":[
{
"objectType":"PTC.Workflow.WorkItem",
"items":[
{
"id":{
"value":"OR:wt.workflow.work.WorkItem:365218"
}
}
]
}
]
}
]
}
Configuration Fields
The following table shows the JSON fields used to configure this component.
Property Name | Description | Type | Default Value | Required or Optional |
progressBarMessage | See subproperties: | N/A | N/A | Optional |
value | String that is shown below the progress bar. This is a message that indicates progress, as measured by activity. Place holders exposed in the progress bar message are [[VALUE]], [[MAX_VALUE]] and [[MIN_VALUE]]. These placeholders are replaced by the actual value, maximum value and minimum value returned by model Thing. | String | N/A | Required |
version | Configuration version. | String | 1.0.0 | Optional |
detailsLinkLabel | See subproperty: | N/A | N/A | Optional |
value | The label for the link that appears in the component. If this field is left blank, no label appears. | String | N/A | Required |
version | Configuration version. | String | 1.0.0 | Optional |
detailsPageHref | See subproperty: | N/A | N/A | Optional |
value | URL to which user is navigated when you click detailsLinkLabel. If this field is left blank, the value for detailsLinkLabel is rendered as a plain label instead of hyperlink. | String | N/A | Required |
version | Configuration version. | String | 1.0.0 | Optional |
title | See subproperty: | N/A | N/A | Optional |
value | String that appears as the title in component. | String | "" | Required |
version | Configuration version. | String | 1.0.0 | Optional |
modelThing | See subproperty: | N/A | N/A | Required |
value | The name of the Model Thing that gets the data. | String | PTC.TaskProgress ModelThing | Required |
version | Configuration version. | String | 1.0.0 | Optional |
Sample Configuration
{
"progressBarMessage": {
"version": "1.0.0",
"value": "[[PTC.TaskProgressComponent.ProgressBar.Message]]"
},
"detailsPageHref": {
"version": "1.0.0",
"value": ""
},
"detailsLinkLabel": {
"version": "1.0.0",
"value": "[[PTC.TaskProgressComponent.ViewFullDetailsLabel]]"
},
"title": {
"version": "1.0.0",
"value": "[[PTC.TaskProgressComponent.Title]]"
},
"modelThing": {
"entityName": "PTC.TaskProgressModelThing",
"version": "1.0.0"
}
}