inteligr8/alfresco-ng2-components
1
0
Fork 0
mirror of https://github.com/Alfresco/alfresco-ng2-components.git synced 2025-10-08 14:51:32 +00:00
Code Issues Packages Projects Releases Wiki Activity

[ADF-2764] Updated process services docs with latest features (#3390)

Browse Source
This commit is contained in:
Andy Stark
2018-05-24 17:10:35 +01:00
committed by Eugenio Romano
parent a2581417bd
commit 04e50eeabd
33 changed files with 576 additions and 455 deletions
Download Patch File Download Diff File Expand all files Collapse all files

29
docs/process-services/start-process.component.md
View File

@@ -10,6 +10,24 @@ Starts a process.
![adf-start-process ](../docassets/images/startProcess.png)
## Contents
- [Basic Usage](#basic-usage)
- [Class members](#class-members)
- [Properties](#properties)
- [Events](#events)
- [Details](#details)
- [Starting a process with a default name and pre-selected process definition name](#starting-a-process-with-a-default-name-and-pre-selected-process-definition-name)
- [Starting a process not included in an app](#starting-a-process-not-included-in-an-app)
- [Custom data example](#custom-data-example)
- [Attaching a File to the start form of the process](#attaching-a-file-to-the-start-form-of-the-process)
- [See also](#see-also)
## Basic Usage
```html
@@ -27,17 +45,17 @@ Starts a process.
| appId | `number` | (optional): Limit the list of processes which 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 |
| variables | `ProcessInstanceVariable[]` | Variables in input to the process [RestVariable](https://github.com/Alfresco/alfresco-js-api/tree/master/src/alfresco-activiti-rest-api/docs/RestVariable.md) |
| values | `FormValues` | Parameter to pass form field values in the start form if is associated |
| variables | [`ProcessInstanceVariable[]`](../../lib/process-services/process-list/models/process-instance-variable.model.ts) | Variables in input to the process [RestVariable](https://github.com/Alfresco/alfresco-js-api/tree/master/src/alfresco-activiti-rest-api/docs/RestVariable.md) |
| values | [`FormValues`](../../lib/core/form/components/widgets/core/form-values.ts) | Parameter to pass form field values in the start form if is associated |
| showSelectProcessDropdown | `boolean` | hide or show the process selection drodown, true by default |
### Events
| Name | Type | Description |
| ---- | ---- | ----------- |
| start | `EventEmitter<ProcessInstance>` | Emitted when the process starts |
| cancel | `EventEmitter<ProcessInstance>` | Emitted when the process is canceled |
| error | `EventEmitter<ProcessInstance>` | Emitted when the start process operation fails |
| start | [`EventEmitter<ProcessInstance>`](../../lib/process-services/process-list/models/process-instance.model.ts) | Emitted when the process starts |
| cancel | [`EventEmitter<ProcessInstance>`](../../lib/process-services/process-list/models/process-instance.model.ts) | Emitted when the process is canceled |
| error | [`EventEmitter<ProcessInstance>`](../../lib/process-services/process-list/models/process-instance.model.ts) | Emitted when the start process operation fails |
## Details
@@ -143,7 +161,6 @@ const values: FormValues = {
});
```
Note that in the object above, the key `file` is the name of the attach file field in the start form of the process. The value of the `file` property must be a
[MinimalNodeEntryEntity](../content-services/document-library.model.md):