mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-07-24 17:32:15 +00:00
Documentation build (#6762)
* move doc dependency in doctools * add ignore link * rebuild doc * version index * put it back some deps
This commit is contained in:
@@ -13,18 +13,18 @@ Starts a process.
|
||||
|
||||
## Contents
|
||||
|
||||
* [Basic Usage](#basic-usage)
|
||||
* [Class members](#class-members)
|
||||
* [Properties](#properties)
|
||||
* [Events](#events)
|
||||
* [Details](#details)
|
||||
* [Starting a process with a default name and pre-selected process definition name](#starting-a-process-with-a-default-name-and-pre-selected-process-definition-name)
|
||||
* [Starting a process not included in an app](#starting-a-process-not-included-in-an-app)
|
||||
* [Custom data example](#custom-data-example)
|
||||
* [Attaching a File to the start form of the process](#attaching-a-file-to-the-start-form-of-the-process)
|
||||
* [Starting a process with a selected application](#starting-a-process-with-a-selected-application)
|
||||
* [Error handling](#error-handling)
|
||||
* [See also](#see-also)
|
||||
- [Basic Usage](#basic-usage)
|
||||
- [Class members](#class-members)
|
||||
- [Properties](#properties)
|
||||
- [Events](#events)
|
||||
- [Details](#details)
|
||||
- [Starting a process with a default name and pre-selected process definition name](#starting-a-process-with-a-default-name-and-pre-selected-process-definition-name)
|
||||
- [Starting a process not included in an app](#starting-a-process-not-included-in-an-app)
|
||||
- [Custom data example](#custom-data-example)
|
||||
- [Attaching a File to the start form of the process](#attaching-a-file-to-the-start-form-of-the-process)
|
||||
- [Starting a process with a selected application](#starting-a-process-with-a-selected-application)
|
||||
- [Error handling](#error-handling)
|
||||
- [See also](#see-also)
|
||||
|
||||
## Basic Usage
|
||||
|
||||
@@ -39,26 +39,26 @@ Starts a process.
|
||||
### Properties
|
||||
|
||||
| Name | Type | Default value | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| ---- | ---- | ------------- | ----------- |
|
||||
| appId | `number` | | (optional) 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`](../../../lib/cli/node_modules/@alfresco/js-api/src/api/content-rest-api/model/definition.ts) name of the process to start. |
|
||||
| processDefinitionName | `string` | | (optional) [Definition](../../../lib/cli/node_modules/@alfresco/js-api/src/api/content-rest-api/model/definition.ts) name of the process to start. |
|
||||
| processFilterSelector | `boolean` | true | (optional) Parameter to enable selection of process when filtering. |
|
||||
| showSelectApplicationDropdown | `boolean` | false | (optional) Hide or show application selection dropdown. |
|
||||
| showSelectProcessDropdown | `boolean` | true | Hide or show the process selection dropdown. |
|
||||
| title | `string` | | (optional) Define the header of the component. |
|
||||
| values | [`FormValues`](../../../lib/core/form/components/widgets/core/form-values.ts) | | Parameter to pass form field values in the start form if one is associated. |
|
||||
| variables | [`ProcessInstanceVariable`](../../../lib/process-services/src/lib/process-list/models/process-instance-variable.model.ts)`[]` | | Variables in the input to the process [RestVariable](https://github.com/Alfresco/alfresco-js-api/tree/master/src/alfresco-activiti-rest-api/docs/RestVariable.md). |
|
||||
| variables | [`ProcessInstanceVariable`](../../../lib/process-services/src/lib/process-list/models/process-instance-variable.model.ts)`[]` | | Variables in the input to the process [`RestVariable`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/activiti-rest-api/docs/RestVariable.md). |
|
||||
|
||||
### Events
|
||||
|
||||
| Name | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| ---- | ---- | ----------- |
|
||||
| applicationSelection | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`AppDefinitionRepresentationModel`](../../../lib/process-services/src/lib/task-list/models/filter.model.ts)`>` | Emitted when application selection changes. |
|
||||
| cancel | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<void>` | Emitted when the process is canceled. |
|
||||
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when an error occurs. |
|
||||
| processDefinitionSelection | `EventEmitter<ProcessDefinitionRepresentation>` | Emitted when process definition selection changes. |
|
||||
| start | `EventEmitter<ProcessInstance>` | Emitted when the process starts. |
|
||||
| processDefinitionSelection | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ProcessDefinitionRepresentation`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/activiti-rest-api/docs/ProcessDefinitionRepresentation.md)`>` | Emitted when process definition selection changes. |
|
||||
| start | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ProcessInstance`](../../../lib/process-services/src/lib/process-list/models/process-instance.model.ts)`>` | Emitted when the process starts. |
|
||||
|
||||
## Details
|
||||
|
||||
@@ -115,8 +115,8 @@ const formValues: FormValues = {
|
||||
You can see a repository in the Alfresco Repositories list once it is created in APS.
|
||||
If the repository is set up with an ID value of anything other than 1 then you will need
|
||||
to declare it in `app.config.json`. For example, if the repository's ID is 1002 and its
|
||||
name is *alfresco* then you would set the `alfrescoRepositoryName` property in`app.config.json`
|
||||
to *alfresco-1002* as follows:
|
||||
name is _alfresco_ then you would set the `alfrescoRepositoryName` property in`app.config.json`
|
||||
to _alfresco-1002_ as follows:
|
||||
|
||||
```json
|
||||
{
|
||||
@@ -218,4 +218,4 @@ When an error occurs, the component will emit an error event that can be used to
|
||||
|
||||
## See also
|
||||
|
||||
* [Select Apps Dialog component](select-apps-dialog.component.md)
|
||||
- [Select Apps Dialog component](select-apps-dialog.component.md)
|
||||
|
Reference in New Issue
Block a user