alfresco-ng2-components/docs/start-process.component.md

32 lines
1.2 KiB
Markdown

# Start Process component
Starts a process.
![adf-start-process ](docassets/images/startProcess.png)
## Basic Usage
```html
<adf-start-process
appId="YOUR_APP_ID" >
</adf-start-process>
```
### Properties
| Name | Description |
| --- | --- |
| appId | (required): Limit the list of processes which can be started to those contained in the specified app |
| variables | Variables in input to the process [RestVariable](https://github.com/Alfresco/alfresco-js-api/tree/master/src/alfresco-activiti-rest-api/docs/RestVariable.md)|
### Events
| Name | Description |
| --- | --- |
| start | Raised when the process start |
| cancel | Raised when the process canceled |
| error | Raised when the start process fail |
## Details
Displays Start Process, allowing the user to specify some details like process name and process definition, which are the most basic requirement to start a new process instance. The user have to select the process definition from a dropdown if there are more than one process definition available. If there is just one process definition available for the app, then it is auto-selected. There is a error message shown if no process definition is available.