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

Andy Stark 16cb15468c [ADF-2334] Added metadata to doc files (#2980 )

2018-02-22 10:28:13 +00:00

3.9 KiB

Raw Blame History

Added, Status

Added	Status
v2.0.0	Active

Start Process component

Starts a process.

Basic Usage

<adf-start-process 
   [appId]="YOUR_APP_ID">
</adf-start-process>

Properties

Name	Type	Description
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
values	`FormValues`	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 a process with a default name and pre-selected process definition name

 <adf-start-process 
      [appId]="YOUR_APP_ID"
      [name]="PROCESS_NAME"
      [processDefinitionName]="PROCESS_DEFINITION_NAME">
 </adf-start-process>

If your app has more than one process definition, with the property processDefinitionName you can select as dropdown default value your PROCESS_DEFINITION_NAME. The name will be the PROCESS_NAME.

Start a process not included in an app

 <adf-start-process 
      [processDefinitionName]="PROCESS_DEFINITION_NAME">
 </adf-start-process>

With the property processDefinitionName you can select as dropdown default value your PROCESS_DEFINITION_NAME.

Custom data example

Here is an example of how to pass in form field values to initialize the start form that has been defined for the process:

const formValues: FormValues  = {
    'test_1': 'value_1',
    'test_2': 'value_2',
    'test_3': 'value_1',
    'test_4': 'dropdown_id',
    'test_5': 'dropdown_label',
    'dropdown': {'id': 'dropdown_id', 'name': 'dropdown_label'}
};

<adf-start-process 
    [values]="formValues"
    [appId]="YOUR_APP_ID" >
</adf-start-process>

Attaching a File to the start form of the process

After the repository is created in APS, you can it in the Alfresco Repositories list. If the ID is set to 1 then all default values are fine. However, if it is set to something else, for example, 1002 and the name is alfresco, you must set the property alfrescoRepositoryName in your app.config.json file to alfresco-1002:

        {
            name: 'Alfresco ADF Application'
        },
        ecmHost: 'http://{hostname}{:port}/ecm',
        bpmHost: 'http://{hostname}{:port}/bpm',
        logLevel: 'silent',
        alfrescoRepositoryName : 'alfresco-1002'

You then need to pass the node as the input values object with the other properties:

let node: MinimalNodeEntryEntity = this.nodesApiService.getNode(NODE_ID);

const formValues: FormValues  = {
    'file' : node
    'field_one': 'example text'
};

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:

<adf-start-process 
    [values]="formValues"
    [appId]="YOUR_APP_ID" >
</adf-start-process>

The result will be the start form prefilled with the file data:

3.9 KiB Raw Blame History