mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-07-24 17:32:15 +00:00
[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
This commit is contained in:
committed by
Eugenio Romano
parent
0b218f0978
commit
574cc9c1a6
@@ -0,0 +1,51 @@
|
||||
---
|
||||
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.
|
||||
|
||||

|
||||
|
||||
## 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.
|
31
docs/process-services-cloud/process-header-cloud.service.md
Normal file
31
docs/process-services-cloud/process-header-cloud.service.md
Normal file
@@ -0,0 +1,31 @@
|
||||
---
|
||||
Title: Process Header Cloud Service
|
||||
Added: v3.0.0
|
||||
Status: Experimental
|
||||
Last reviewed: 2019-03-08
|
||||
---
|
||||
|
||||
# [Process Header Cloud Service](../../lib/process-services-cloud/src/lib/process/process-header/services/process-header-cloud.service.ts "Defined in process-header-cloud.service.ts")
|
||||
|
||||
Manages cloud process instances.
|
||||
|
||||
## Class members
|
||||
|
||||
### Methods
|
||||
|
||||
- **getProcessInstanceById**(appName: `string`, processInstanceId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessInstanceCloud`](../../lib/process-services-cloud/src/lib/process/start-process/models/process-instance-cloud.model.ts)`>`<br/>
|
||||
Gets details of a process instance.
|
||||
- _appName:_ `string` - Name of the app
|
||||
- _processInstanceId:_ `string` - ID of the process instance whose details you want
|
||||
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessInstanceCloud`](../../lib/process-services-cloud/src/lib/process/start-process/models/process-instance-cloud.model.ts)`>` - Process instance details
|
||||
|
||||
## Details
|
||||
|
||||
The methods work in much the same way as the equivalent methods in the
|
||||
[Processlist Cloud Component](./process-list-cloud.component.md)
|
||||
but they use the cloud variants of the classes for return values. See the
|
||||
[Processlist Cloud Service](./process-list-cloud.service.md) page for usage examples.
|
||||
|
||||
## See also
|
||||
|
||||
- [Processlist Cloud Service](./process-list-cloud.service.md)
|
Reference in New Issue
Block a user