alfresco-ng2-components/docs/process-services-cloud/start-process-cloud.component.md
davidcanonieto 2acd1b4e26 [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
2019-01-04 12:22:03 +00:00

2.2 KiB
Executable File

Start Process Cloud Component

Starts a process.

adf-start-process

Basic Usage

<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<ProcessInstanceCloud> Emitted when the process is canceled.
error EventEmitter<ProcessInstanceCloud> Emitted when an error occurs.
success EventEmitter<ProcessInstanceCloud> Emitted when the process starts.

Details

Starting a process with a default name and a pre-selected process definition name

 <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