mirror of https://github.com/Alfresco/alfresco-ng2-components.git synced 2025-05-12 17:04:57 +00:00

Andy Stark e5c7ffb314 [ADF-4249] Updates for doc review (#4470 )

* [ADF-4249] Updated review checker tool to work with new doc subfolders

* [ADF-4249] Updates for doc review

2019-03-20 18:12:22 +00:00

2.4 KiB

Raw Blame History

Title, Added, Status, Last reviewed

Title	Added	Status	Last reviewed
Start Process Cloud Component	v3.0.0	Experimental	2019-03-20

Start Process Cloud Component

Starts a 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`		(required) Name of the app.
maxNameLength	`number`		Maximum length of the process name.
name	`string`	""	Name of the process.
processDefinitionName	`string`		Name of the process definition.
showSelectProcessDropdown	`boolean`	true	Show/hide the process dropdown list.
variables	`Map<string, object>[]`		Variables to attach to the payload.

Events

Name	Type	Description
cancel	`EventEmitter<ProcessInstanceCloud>`	Emitted when the starting process is cancelled
error	`EventEmitter<ProcessInstanceCloud>`	Emitted when an error occurs.
success	`EventEmitter<ProcessInstanceCloud>`	Emitted when the process is successfully started.

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

2.4 KiB Raw Blame History