Application Development Framework ADF Documentation Process Services Cloud APIComponentsStart Process Cloud Component

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`	MAX_NAME_LENGTH	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.
showTitle	`boolean`	true	Show/hide title.
values	`TaskVariableCloud[]`		Parameter to pass form field values in the start form if one is associated.
variables	`any`		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.
formContentClicked	`EventEmitter<ContentLinkModel>`	Emitted when form content is clicked.
processDefinitionSelection	`EventEmitter<ProcessDefinitionCloud>`	Emitted when process definition selection changes.
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 
      [appName]="YOUR_APP_NAME"
      [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

Starting a process with variables

 <adf-cloud-start-process 
      [appName]="YOUR_APP_NAME"
      [variables]="{ 'my-key1' : 'myvalue', 'my-key2' : 'myvalue2'}">
 </adf-cloud-start-process>

Starting a process with values passed to the form

 <adf-cloud-start-process 
      [appName]="YOUR_APP_NAME"
      [values]="[{'name': 'firstName', 'value': 'MyName'}, {'name': 'lastName', 'value': 'MyLastName'}]">
 </adf-cloud-start-process>

Edit on github