mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-07-24 17:32:15 +00:00
[ADF-3543] Start Process Component for APS 2 (#4105)
* [ADF-3543] Start Process Component for APS 2 * [ADF-3543] Fix e2e tests * [ADF-3543] Process filter data automation id with process key * [ADF-3543] Fix Process Services e2e tests * [ADF-3543] Fix Search e2e tests * [ADF-3543] Fix Search e2e tests
This commit is contained in:
committed by
Maurizio Vitale
parent
dd25467a98
commit
2acd1b4e26
49
docs/process-services-cloud/start-process-cloud.component.md
Executable file
49
docs/process-services-cloud/start-process-cloud.component.md
Executable file
@@ -0,0 +1,49 @@
|
||||
# Start Process Cloud Component
|
||||
|
||||
Starts a process.
|
||||
|
||||

|
||||
|
||||
## Basic Usage
|
||||
|
||||
```html
|
||||
<adf-cloud-start-process
|
||||
[appName]="YOUR_APP_NAME">
|
||||
</adf-cloud-start-process>
|
||||
```
|
||||
|
||||
## Class members
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Default value | Description |
|
||||
| ---- | ---- | ------------- | ----------- |
|
||||
| appName | `string` | | Limit the list of processes that can be started to those contained in the specified app. |
|
||||
| name | `string` | "" | (optional) Name to assign to the current process. |
|
||||
| processDefinitionName | `string` | | (optional) Definition name of the process to start. |
|
||||
| showSelectProcessDropdown | `boolean` | true | (optional) Hide or show the process selection dropdown. |
|
||||
| variables | `Map<string, any>[]` | | (optional) Variables in the input to the process. |
|
||||
|
||||
### Events
|
||||
|
||||
| Name | Type | Description |
|
||||
| ---- | ---- | ----------- |
|
||||
| cancel | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ProcessInstanceCloud`](../../lib/process-services-cloud/src/lib/process-cloud/models/process-instance-cloud.model.ts)`>` | Emitted when the process is canceled. |
|
||||
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ProcessInstanceCloud`](../../lib/process-services-cloud/src/lib/process-cloud/models/process-instance-cloud.model.ts)`>` | Emitted when an error occurs. |
|
||||
| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ProcessInstanceCloud`](../../lib/process-services-cloud/src/lib/process-cloud/models/process-instance-cloud.model.ts)`>` | Emitted when the process starts. |
|
||||
|
||||
## Details
|
||||
|
||||
### Starting a process with a default name and a pre-selected process definition name
|
||||
|
||||
```html
|
||||
<adf-cloud-start-process
|
||||
[appId]="YOUR_APP_ID"
|
||||
[name]="PROCESS_NAME"
|
||||
[processDefinitionName]="PROCESS_DEFINITION_NAME">
|
||||
</adf-cloud-start-process>
|
||||
```
|
||||
|
||||
You can use the `processDefinitionName` property to select which process will be selected by default on the dropdown (when there is more than one process to choose from). Use the `name` property to set the name shown on the dropdown item.
|
||||
|
||||
If the app contains only one process definition, this process definition will be selected by default
|
Reference in New Issue
Block a user