alfresco-ng2-components/docs/process-services-cloud/process-header-cloud.component.md
Deepak Paul 574cc9c1a6 [ADF-4123] Process Cloud Instance Details Header component (#4418)
* [ADF-4123] Added service to get process instance details

* [ADF-4123] Added process header component

* [ADF-4123] Added more properties to model

* [ADF-4123] Exported process sidebar

* [ADF-4123] Added new process instance details demo component

* [ADF-4123] Added tests for module

* [ADF-4123] Added tests for process-header

* [ADF-4123] Added documentation
2019-03-13 11:33:40 +00:00

52 lines
1.5 KiB
Markdown

---
Title: Process Header Cloud Component
Added: v3.0.0
Status: Experimental
Last reviewed: 2019-03-08
---
# [Process Header Cloud Component](../../lib/process-services-cloud/src/lib/process/process-header/components/process-header-cloud.component.ts "Defined in process-header-cloud.component.ts")
Shows all the information related to a process instance.
![adf-cloud-process-header](../docassets/images/adf-cloud-process-header.png)
## Basic Usage
```html
<adf-cloud-process-header
[appName]="appName"
[processInstanceId]="processInstanceId">
</adf-cloud-process-header>
```
## Class members
### Properties
| Name | Type | Default value | Description |
| ---- | ---- | ------------- | ----------- |
| appName | `string` | | (Required) The name of the application. |
| processInstanceId | `string` | | (Required) The id of the process instance. |
## Details
The component populates an internal array of
[CardViewModel](../core/card-view.component.md) with the information that we want to display.
By default all properties are displayed:
**_id_**, **_name_**, **_description_**, **_status_**, **_initiator_**, **_startDate_**, **_lastModified_**, **_parentId_**, **_businessKey_**.
However, you can also choose which properties to show using a configuration in `app.config.json`:
```json
"adf-cloud-process-header": {
"presets": {
"properties" : [ "name", "status", "initiator", "parentId"]
}
}
```
With this configuration, only the four listed properties will be shown.