[ADF-2764] Updated process services docs with latest features (#3390)

This commit is contained in:
Andy Stark 2018-05-24 17:10:35 +01:00 committed by Eugenio Romano
parent a2581417bd
commit 04e50eeabd
33 changed files with 576 additions and 455 deletions

View File

@ -11,50 +11,43 @@ for more information about installing and using the source code.
| Name | Description | Source link | | Name | Description | Source link |
| ---- | ----------- | ----------- | | ---- | ----------- | ----------- |
| [Apps list component](apps-list.component.md) | Shows all available apps. | [Source](../../lib/process-services/app-list/apps-list.component.ts) |
| [Create process attachment component](create-process-attachment.component.md) | Displays Upload Component (Drag and Click) to upload the attachment to a specified process instance | [Source](../../lib/process-services/attachment/create-process-attachment.component.ts) |
| [Create task attachment component](create-task-attachment.component.md) | Displays Upload Component (Drag and Click) to upload the attachment to a specified task | [Source](../../lib/process-services/attachment/create-task-attachment.component.ts) |
| [Process attachment list component](process-attachment-list.component.md) | Displays attached documents on a specified process instance | [Source](../../lib/process-services/attachment/process-attachment-list.component.ts) |
| [Task attachment list component](task-attachment-list.component.md) | Displays attached documents on a specified task. | [Source](../../lib/process-services/attachment/task-attachment-list.component.ts) |
| [People component](people.component.md) | Displays users involved with a specified task | [Source](../../lib/process-services/people/components/people/people.component.ts) |
| [People list component](people-list.component.md) | Shows a list of users (people). | [Source](../../lib/process-services/people/components/people-list/people-list.component.ts) |
| [People search component](people-search.component.md) | Searches users/people. | [Source](../../lib/process-services/people/components/people-search/people-search.component.ts) |
| [Process comments component](process-comments.component.md) | Displays comments associated with a particular process instance and allows the user to add new comments. | [Source](../../lib/process-services/process-comments/process-comments.component.ts) |
| [Process filters component](process-filters.component.md) | Collection of criteria used to filter process instances, which may be customized by users. | [Source](../../lib/process-services/process-list/components/process-filters.component.ts) |
| [Process instance details component](process-instance-details.component.md) | Displays detailed information on a specified process instance | [Source](../../lib/process-services/process-list/components/process-instance-details.component.ts) |
| [Process instance header component](process-instance-header.component.md) | Sub-component of the process details component, which renders some general information about the selected process. | [Source](../../lib/process-services/process-list/components/process-instance-header.component.ts) |
| [Process instance tasks component](process-instance-tasks.component.md) | Lists both the active and completed tasks associated with a particular process instance | [Source](../../lib/process-services/process-list/components/process-instance-tasks.component.ts) |
| [Process list component](process-list.component.md) | Renders a list containing all the process instances matched by the parameters specified. | [Source](../../lib/process-services/process-list/components/process-list.component.ts) | | [Process list component](process-list.component.md) | Renders a list containing all the process instances matched by the parameters specified. | [Source](../../lib/process-services/process-list/components/process-list.component.ts) |
| [Start process component](start-process.component.md) | Starts a process. | [Source](../../lib/process-services/process-list/components/start-process.component.ts) | | _Apps list component_ | _Not currently documented_ | [Source](../../lib/process-services/app-list/apps-list.component.ts) |
| [Checklist component](checklist.component.md) | Shows the checklist task functionality. | [Source](../../lib/process-services/task-list/components/checklist.component.ts) | | _Create process attachment component_ | _Not currently documented_ | [Source](../../lib/process-services/attachment/create-process-attachment.component.ts) |
| [Start task component](start-task.component.md) | Creates/Starts new task for the specified app | [Source](../../lib/process-services/task-list/components/start-task.component.ts) | | _Create task attachment component_ | _Not currently documented_ | [Source](../../lib/process-services/attachment/create-task-attachment.component.ts) |
| [Task details component](task-details.component.md) | Shows the details of the task ID passed in as input. | [Source](../../lib/process-services/task-list/components/task-details.component.ts) | | _Process attachment list component_ | _Not currently documented_ | [Source](../../lib/process-services/attachment/process-attachment-list.component.ts) |
| [Task filters component](task-filters.component.md) | Shows all available filters. | [Source](../../lib/process-services/task-list/components/task-filters.component.ts) | | _Task attachment list component_ | _Not currently documented_ | [Source](../../lib/process-services/attachment/task-attachment-list.component.ts) |
| [Task header component](task-header.component.md) | Shows all the information related to a task. | [Source](../../lib/process-services/task-list/components/task-header.component.ts) | | _People component_ | _Not currently documented_ | [Source](../../lib/process-services/people/components/people/people.component.ts) |
| [Task list component](task-list.component.md) | Renders a list containing all the tasks matched by the parameters specified. | [Source](../../lib/process-services/task-list/components/task-list.component.ts) | | _People list component_ | _Not currently documented_ | [Source](../../lib/process-services/people/components/people-list/people-list.component.ts) |
| [Task standalone component](task-standalone.component.md) | This component can be used when there is no form attached to a task. | [Source](../../lib/process-services/task-list/components/task-standalone.component.ts) | | _People search component_ | _Not currently documented_ | [Source](../../lib/process-services/people/components/people-search/people-search.component.ts) |
| _Process comments component_ | _Not currently documented_ | [Source](../../lib/process-services/process-comments/process-comments.component.ts) |
| _Process filters component_ | _Not currently documented_ | [Source](../../lib/process-services/process-list/components/process-filters.component.ts) |
| _Process instance details component_ | _Not currently documented_ | [Source](../../lib/process-services/process-list/components/process-instance-details.component.ts) |
| _Process instance header component_ | _Not currently documented_ | [Source](../../lib/process-services/process-list/components/process-instance-header.component.ts) |
| _Process instance tasks component_ | _Not currently documented_ | [Source](../../lib/process-services/process-list/components/process-instance-tasks.component.ts) |
| _Start process component_ | _Not currently documented_ | [Source](../../lib/process-services/process-list/components/start-process.component.ts) |
| _Checklist component_ | _Not currently documented_ | [Source](../../lib/process-services/task-list/components/checklist.component.ts) |
| _Start task component_ | _Not currently documented_ | [Source](../../lib/process-services/task-list/components/start-task.component.ts) |
| _Task details component_ | _Not currently documented_ | [Source](../../lib/process-services/task-list/components/task-details.component.ts) |
| _Task filters component_ | _Not currently documented_ | [Source](../../lib/process-services/task-list/components/task-filters.component.ts) |
| _Task header component_ | _Not currently documented_ | [Source](../../lib/process-services/task-list/components/task-header.component.ts) |
| _Task list component_ | _Not currently documented_ | [Source](../../lib/process-services/task-list/components/task-list.component.ts) |
| _Task standalone component_ | _Not currently documented_ | [Source](../../lib/process-services/task-list/components/task-standalone.component.ts) |
## Directives ## Directives
| Name | Description | Source link | | Name | Description | Source link |
| ---- | ----------- | ----------- | | ---- | ----------- | ----------- |
| [Process audit directive](process-audit.directive.md) | Fetches the Process Audit information the PDF or JSON format. | [Source](../../lib/process-services/process-list/components/process-audit.directive.ts) | | _Process audit directive_ | _Not currently documented_ | [Source](../../lib/process-services/process-list/components/process-audit.directive.ts) |
| [Task audit directive](task-audit.directive.md) | Fetches the Task Audit information in PDF or JSON format. | [Source](../../lib/process-services/task-list/components/task-audit.directive.ts) | | _Task audit directive_ | _Not currently documented_ | [Source](../../lib/process-services/task-list/components/task-audit.directive.ts) |
## Models
| Name | Description | Source link |
| ---- | ----------- | ----------- |
| [Filter model](filter.model.md) | Contains classes related to filters in Process Services. | [Source](../../lib/process-services/task-list/models/filter.model.ts) |
| [Task details model](task-details.model.md) | Information about a task. | [Source](../../lib/process-services/task-list/models/task-details.model.ts) |
## Services ## Services
| Name | Description | Source link | | Name | Description | Source link |
| ---- | ----------- | ----------- | | ---- | ----------- | ----------- |
| [Process filter service](process-filter.service.md) | Manage Process Filters, which are pre-configured Process Instance queries. | [Source](../../lib/process-services/process-list/services/process-filter.service.ts) | | _Process filter service_ | _Not currently documented_ | [Source](../../lib/process-services/process-list/services/process-filter.service.ts) |
| [Process service](process.service.md) | Manages Process Instances, Process Variables, and Process Audit Log. | [Source](../../lib/process-services/process-list/services/process.service.ts) | | _Process service_ | _Not currently documented_ | [Source](../../lib/process-services/process-list/services/process.service.ts) |
| [Task filter service](task-filter.service.md) | Manage Task Filters, which are pre-configured Task Instance queries. | [Source](../../lib/process-services/task-list/services/task-filter.service.ts) | | _Task filter service_ | _Not currently documented_ | [Source](../../lib/process-services/task-list/services/task-filter.service.ts) |
| [Tasklist service](tasklist.service.md) | Manages Task Instances. | [Source](../../lib/process-services/task-list/services/tasklist.service.ts) | | _Tasklist service_ | _Not currently documented_ | [Source](../../lib/process-services/task-list/services/tasklist.service.ts) |
<!--process-services end--> <!--process-services end-->

View File

@ -2,6 +2,7 @@
Added: v2.0.0 Added: v2.0.0
Status: Active Status: Active
--- ---
# Apps List Component # Apps List Component
Shows all available apps. Shows all available apps.
@ -34,15 +35,15 @@ If we intend to show a custom template if there are no apps present
### Properties ### Properties
| Name | Type | Default value | Description | | Name | Type | Default value | Description |
| ---- | ---- | ------------- | ----------- | | -- | -- | -- | -- |
| layoutType | `string` | `AppsListComponent.LAYOUT_GRID` | (**required**) Defines the layout of the apps. There are two possible values, "GRID" and "LIST". |
| filtersAppId | `any[]` | | Provides a way to filter the apps to show. | | filtersAppId | `any[]` | | Provides a way to filter the apps to show. |
| layoutType | `string` | [`AppsListComponent`](../process-services/apps-list.component.md).LAYOUT_GRID | (**required**) Defines the layout of the apps. There are two possible values, "GRID" and "LIST". |
### Events ### Events
| Name | Type | Description | | Name | Type | Description |
| ---- | ---- | ----------- | | -- | -- | -- |
| appClick | `EventEmitter<AppDefinitionRepresentationModel>` | Emitted when an app entry is clicked. | | appClick | [`EventEmitter<AppDefinitionRepresentationModel>`](../../lib/process-services/task-list/models/filter.model.ts) | Emitted when an app entry is clicked. |
| error | `EventEmitter<any>` | Emitted when an error occurs. | | error | `EventEmitter<any>` | Emitted when an error occurs. |
## Details ## Details

View File

@ -2,6 +2,7 @@
Added: v2.0.0 Added: v2.0.0
Status: Active Status: Active
--- ---
# Checklist Component # Checklist Component
Shows the checklist task functionality. Shows the checklist task functionality.
@ -21,15 +22,15 @@ Shows the checklist task functionality.
### Properties ### Properties
| Name | Type | Default value | Description | | Name | Type | Default value | Description |
| ---- | ---- | ------------- | ----------- | | -- | -- | -- | -- |
| taskId | `string` | | (required) The id of the parent task to which subtasks are attached. |
| readOnly | `boolean` | `false` | Toggle readonly state of the form. All form widgets will render as readonly if enabled. |
| assignee | `string` | | (required) The assignee id that the subtasks are assigned to. | | assignee | `string` | | (required) The assignee id that the subtasks are assigned to. |
| readOnly | `boolean` | false | Toggle readonly state of the form. All form widgets will render as readonly if enabled. |
| taskId | `string` | | (required) The id of the parent task to which subtasks are attached. |
### Events ### Events
| Name | Type | Description | | Name | Type | Description |
| ---- | ---- | ----------- | | -- | -- | -- |
| checklistTaskCreated | `EventEmitter<TaskDetailsModel>` | Emitted when a new checklist task is created. | | checklistTaskCreated | [`EventEmitter<TaskDetailsModel>`](../process-services/task-details.model.md) | Emitted when a new checklist task is created. |
| checklistTaskDeleted | `EventEmitter<string>` | Emitted when a checklist task is deleted. | | checklistTaskDeleted | `EventEmitter<string>` | Emitted when a checklist task is deleted. |
| error | `EventEmitter<any>` | Emitted when an error occurs. | | error | `EventEmitter<any>` | Emitted when an error occurs. |

View File

@ -2,6 +2,7 @@
Added: v2.0.0 Added: v2.0.0
Status: Active Status: Active
--- ---
# Create Process Attachment component # Create Process Attachment component
Displays Upload Component (Drag and Click) to upload the attachment to a specified process instance Displays Upload Component (Drag and Click) to upload the attachment to a specified process instance
@ -23,12 +24,12 @@ Displays Upload Component (Drag and Click) to upload the attachment to a specifi
### Properties ### Properties
| Name | Type | Default value | Description | | Name | Type | Default value | Description |
| ---- | ---- | ------------- | ----------- | | -- | -- | -- | -- |
| processInstanceId | `string` | | (required) The ID of the process instance to display. | | processInstanceId | `string` | | (required) The ID of the process instance to display. |
### Events ### Events
| Name | Type | Description | | Name | Type | Description |
| ---- | ---- | ----------- | | -- | -- | -- |
| error | `EventEmitter<any>` | Emitted when an error occurs while creating or uploading an attachment from the user within the component. | | error | `EventEmitter<any>` | Emitted when an error occurs while creating or uploading an attachment from the user within the component. |
| success | `EventEmitter<any>` | Emitted when an attachment is successfully created or uploaded from within the component. | | success | `EventEmitter<any>` | Emitted when an attachment is successfully created or uploaded from within the component. |

View File

@ -2,6 +2,7 @@
Added: v2.0.0 Added: v2.0.0
Status: Active Status: Active
--- ---
# Create Task Attachment Component # Create Task Attachment Component
Displays Upload Component (Drag and Click) to upload the attachment to a specified task Displays Upload Component (Drag and Click) to upload the attachment to a specified task
@ -22,13 +23,13 @@ Displays Upload Component (Drag and Click) to upload the attachment to a specifi
### Properties ### Properties
| Name | Type | Description | | Name | Type | Default value | Description |
| ---- | ---- | ----------- | | -- | -- | -- | -- |
| taskId | string | (**required**): The numeric ID of the task to display | | taskId | `string` | | (required) The numeric ID of the task to display. |
### Events ### Events
| Name | Description | | Name | Type | Description |
| ---- | ----------- | | -- | -- | -- |
| error | Raised when the error occurred while creating/uploading the attachment by the user from within the component | | error | `EventEmitter<any>` | Emitted when an error occurs while creating or uploading an attachment from the user within the component. |
| success | Raised when the attachment created/uploaded successfully from within the component | | success | `EventEmitter<any>` | Emitted when an attachment is created or uploaded successfully from within the component. |

View File

@ -2,6 +2,7 @@
Added: v2.0.0 Added: v2.0.0
Status: Active Status: Active
--- ---
# Filter model # Filter model
Contains classes related to filters in Process Services. Contains classes related to filters in Process Services.

View File

@ -2,6 +2,7 @@
Added: v2.0.0 Added: v2.0.0
Status: Active Status: Active
--- ---
# People list component # People list component
Shows a list of users (people). Shows a list of users (people).
@ -41,7 +42,7 @@ export class SomeComponent implements OnInit {
} }
``` ```
In the component template use the people list component: In the component template use the [people list component](../process-services/people-list.component.md):
<!-- {% raw %} --> <!-- {% raw %} -->
@ -68,7 +69,7 @@ In the component template use the people list component:
<!-- {% endraw %} --> <!-- {% endraw %} -->
Note that the people list component is based on the Note that the [people list component](../process-services/people-list.component.md) is based on the
[Datatable component](../core/datatable.component.md). [Datatable component](../core/datatable.component.md).
## Class members ## Class members
@ -76,13 +77,13 @@ Note that the people list component is based on the
### Properties ### Properties
| Name | Type | Default value | Description | | Name | Type | Default value | Description |
| ---- | ---- | ------------- | ----------- | | -- | -- | -- | -- |
| users | `any[]` | | The array of user data used to populate the people list. | | actions | `boolean` | false | Toggles whether or not actions should be visible, i.e. the 'Three-Dots' menu. |
| actions | `boolean` | `false` | Toggles whether or not actions should be visible, i.e. the 'Three-Dots' menu. | | users | [`UserProcessModel[]`](../core/user-process.model.md) | | The array of user data used to populate the people list. |
### Events ### Events
| Name | Type | Description | | Name | Type | Description |
| ---- | ---- | ----------- | | -- | -- | -- |
| clickRow | `EventEmitter<any>` | Emitted when the user clicks a row in the people list. | | clickAction | [`EventEmitter<UserEventModel>`](../../lib/process-services/task-list/models/user-event.model.ts) | Emitted when the user clicks in the 'Three Dots' drop down menu for a row. |
| clickAction | `EventEmitter<UserEventModel>` | Emitted when the user clicks in the 'Three Dots' drop down menu for a row. | | clickRow | [`EventEmitter<UserProcessModel>`](../core/user-process.model.md) | Emitted when the user clicks a row in the people list. |

View File

@ -2,6 +2,7 @@
Added: v2.0.0 Added: v2.0.0
Status: Active Status: Active
--- ---
# People Search component # People Search component
Searches users/people. Searches users/people.
@ -17,16 +18,16 @@ Searches users/people.
### Properties ### Properties
| Name | Type | Default value | Description | | Name | Type | Default value | Description |
| ---- | ---- | ------------- | ----------- | | -- | -- | -- | -- |
| results | `Observable<any[]>` | | The parameters to show people list. | | results | [`Observable<UserProcessModel[]>`](../core/user-process.model.md) | | Parameters for displaying the list. |
### Events ### Events
| Name | Type | Description | | Name | Type | Description |
| ---- | ---- | ----------- | | -- | -- | -- |
| closeSearch | `EventEmitter<Object>` | Emitted when the "close" button is clicked. |
| searchPeople | `EventEmitter<any>` | Emitted when a search is performed with a new keyword. | | searchPeople | `EventEmitter<any>` | Emitted when a search is performed with a new keyword. |
| success | `EventEmitter<any>` | Emitted when a user is selected and the action button is clicked. | | success | [`EventEmitter<UserProcessModel>`](../core/user-process.model.md) | Emitted when a user is selected and the action button is clicked. |
| closeSearch | `EventEmitter<{}>` | Emitted when the "close" button is clicked. |
## Details ## Details

View File

@ -2,6 +2,7 @@
Added: v2.0.0 Added: v2.0.0
Status: Active Status: Active
--- ---
# People Component # People Component
Displays users involved with a specified task Displays users involved with a specified task
@ -12,6 +13,8 @@ Displays users involved with a specified task
- [Basic Usage](#basic-usage) - [Basic Usage](#basic-usage)
- [Class members](#class-members)
- [Properties](#properties) - [Properties](#properties)
- [Details](#details) - [Details](#details)
@ -37,21 +40,21 @@ Displays users involved with a specified task
### Properties ### Properties
| Name | Type | Default value | Description | | Name | Type | Default value | Description |
| ---- | ---- | ------------- | ----------- | | -- | -- | -- | -- |
| people | `any[]` | `[]` | The array of User objects to display. | | people | [`UserProcessModel[]`](../core/user-process.model.md) | \[] | The array of User objects to display. |
| taskId | `string` | `''` | The numeric ID of the task. | | readOnly | `boolean` | false | Should the data be read-only? |
| readOnly | `boolean` | `false` | Should the data be read-only? | | taskId | `string` | "" | The numeric ID of the task. |
## Details ## Details
### How to customize the people component behavior ### How to customize the people component behavior
The people component provide two methods to customize the behavior: The [people component](../process-services/people.component.md) provide two methods to customize the behavior:
- involveUserAndCloseSearch: The selected user is going to be added and the search section closed - involveUserAndCloseSearch: The selected user is going to be added and the search section closed
- involveUserWithoutCloseSearch: The selected user is going to be added without close the search section - involveUserWithoutCloseSearch: The selected user is going to be added without close the search section
In this way will be easy customize the people component to involve the user with the single or double click event: In this way will be easy customize the [people component](../process-services/people.component.md) to involve the user with the single or double click event:
### Involve People single click and close search ### Involve People single click and close search

View File

@ -19,7 +19,7 @@ Displays attached documents on a specified process instance
</adf-process-attachment-list> </adf-process-attachment-list>
``` ```
Make sure to override the UploadService with the ProcessUploadService Make sure to override the [UploadService](../core/upload.service.md) with the [ProcessUploadService](../../lib/process-services/task-list/services/process-upload.service.ts)
```ts ```ts
import { UploadService } from '@alfresco/adf-core'; import { UploadService } from '@alfresco/adf-core';
@ -41,17 +41,17 @@ export class MyCustomProcessAttachmentComponent {
### Properties ### Properties
| Name | Type | Default value | Description | | Name | Type | Default value | Description |
| ---- | ---- | ------------- | ----------- | | -- | -- | -- | -- |
| disabled | `boolean` | false | Disable/Enable read-only mode for attachment list. |
| processInstanceId | `string` | | (**required**) The ID of the process instance to display. | | processInstanceId | `string` | | (**required**) The ID of the process instance to display. |
| disabled | `boolean` | `false` | Disable/Enable read-only mode for attachment list. |
### Events ### Events
| Name | Type | Description | | Name | Type | Description |
| ---- | ---- | ----------- | | -- | -- | -- |
| attachmentClick | `EventEmitter<{}>` | Emitted when the attachment is double-clicked or the view option is selected from the context menu by the user from within the component. Returns a Blob representing the object that was clicked. | | attachmentClick | `EventEmitter<Object>` | Emitted when the attachment is double-clicked or the view option is selected from the context menu by the user from within the component. Returns a Blob representing the object that was clicked. |
| success | `EventEmitter<{}>` | Emitted when the attachment list has fetched all the attachments. Returns a list of attachments. |
| error | `EventEmitter<any>` | Emitted when the attachment list is not able to fetch the attachments (eg, following a network error). | | error | `EventEmitter<any>` | Emitted when the attachment list is not able to fetch the attachments (eg, following a network error). |
| success | `EventEmitter<Object>` | Emitted when the attachment list has fetched all the attachments. Returns a list of attachments. |
## Details ## Details

View File

@ -2,6 +2,7 @@
Added: v2.0.0 Added: v2.0.0
Status: Active Status: Active
--- ---
# Process Instance Comments component # Process Instance Comments component
Displays comments associated with a particular process instance and allows the user to add new comments. Displays comments associated with a particular process instance and allows the user to add new comments.
@ -19,12 +20,12 @@ Displays comments associated with a particular process instance and allows the u
### Properties ### Properties
| Name | Type | Default value | Description | | Name | Type | Default value | Description |
| ---- | ---- | ------------- | ----------- | | -- | -- | -- | -- |
| processInstanceId | `string` | | (**required**) The numeric ID of the process instance to display comments for. | | processInstanceId | `string` | | (**required**) The numeric ID of the process instance to display comments for. |
| readOnly | `boolean` | `true` | Should the comments be read-only? | | readOnly | `boolean` | true | Should the comments be read-only? |
### Events ### Events
| Name | Type | Description | | Name | Type | Description |
| ---- | ---- | ----------- | | -- | -- | -- |
| error | `EventEmitter<any>` | Emitted when an error occurs. | | error | `EventEmitter<any>` | Emitted when an error occurs. |

View File

@ -12,34 +12,41 @@ Manage Process Filters, which are pre-configured Process Instance queries.
### Methods ### Methods
- `getProcessFilters(appId: number): Observable<FilterProcessRepresentationModel[]>` - **addProcessFilter**(filter: [`FilterProcessRepresentationModel`](../../lib/process-services/process-list/models/filter-process.model.ts) = `null`): [`Observable<FilterProcessRepresentationModel>`](../../lib/process-services/process-list/models/filter-process.model.ts)<br/>
Gets all filters defined for a Process App.
- `appId` - ID of the target app
- `getProcessFilterById(filterId: number, appId?: number): Observable<FilterProcessRepresentationModel>`
Retrieves the process filter by ID.
- `filterId` - ID of the filter
- `appId` - (Optional) ID of the target app
- `getProcessFilterByName(filterName: string, appId?: number): Observable<FilterProcessRepresentationModel>`
Retrieves the process filter by name.
- `filterName` - Name of the filter
- `appId` - (Optional) ID of the target app
- `createDefaultFilters(appId: number): Observable<FilterProcessRepresentationModel[]>`
Creates and returns the default filters for an app.
- `appId` - ID of the target app
- `getRunningFilterInstance(appId: number): FilterProcessRepresentationModel`
Creates and returns a filter that matches "running" process instances.
- `appId` - ID of the target app
- `addProcessFilter(filter: FilterProcessRepresentationModel): Observable<FilterProcessRepresentationModel>`
Adds a filter. Adds a filter.
- `filter` - The filter to add - _filter:_ [`FilterProcessRepresentationModel`](../../lib/process-services/process-list/models/filter-process.model.ts) - The filter to add
- `callApiProcessFilters(appId?: number): any` - **Returns** [`Observable<FilterProcessRepresentationModel>`](../../lib/process-services/process-list/models/filter-process.model.ts) - The filter just added
- **callApiProcessFilters**(appId?: `number` = `null`): `Promise<any>`<br/>
Calls `getUserProcessInstanceFilters` from the Alfresco JS API. Calls `getUserProcessInstanceFilters` from the Alfresco JS API.
- `appId` - (Optional) ID of the target app - _appId:_ `number` - (Optional) ID of the target app
- **Returns** `Promise<any>` - List of filter details
- **createDefaultFilters**(appId: `number` = `null`): [`Observable<FilterProcessRepresentationModel[]>`](../../lib/process-services/process-list/models/filter-process.model.ts)<br/>
Creates and returns the default filters for an app.
- _appId:_ `number` - ID of the target app
- **Returns** [`Observable<FilterProcessRepresentationModel[]>`](../../lib/process-services/process-list/models/filter-process.model.ts) - Default filters just created
- **getProcessFilterById**(filterId: `number` = `null`, appId?: `number` = `null`): [`Observable<FilterProcessRepresentationModel>`](../../lib/process-services/process-list/models/filter-process.model.ts)<br/>
Retrieves the process filter by ID.
- _filterId:_ `number` - ID of the filter
- _appId:_ `number` - (Optional) ID of the target app
- **Returns** [`Observable<FilterProcessRepresentationModel>`](../../lib/process-services/process-list/models/filter-process.model.ts) - Details of the filter
- **getProcessFilterByName**(filterName: `string` = `null`, appId?: `number` = `null`): [`Observable<FilterProcessRepresentationModel>`](../../lib/process-services/process-list/models/filter-process.model.ts)<br/>
Retrieves the process filter by name.
- _filterName:_ `string` - Name of the filter
- _appId:_ `number` - (Optional) ID of the target app
- **Returns** [`Observable<FilterProcessRepresentationModel>`](../../lib/process-services/process-list/models/filter-process.model.ts) - Details of the filter
- **getProcessFilters**(appId: `number` = `null`): [`Observable<FilterProcessRepresentationModel[]>`](../../lib/process-services/process-list/models/filter-process.model.ts)<br/>
Gets all filters defined for a Process App.
- _appId:_ `number` - ID of the target app
- **Returns** [`Observable<FilterProcessRepresentationModel[]>`](../../lib/process-services/process-list/models/filter-process.model.ts) - Array of filter details
- **getRunningFilterInstance**(appId: `number` = `null`): [`FilterProcessRepresentationModel`](../../lib/process-services/process-list/models/filter-process.model.ts)<br/>
Creates and returns a filter that matches "running" process instances.
- _appId:_ `number` - ID of the target app
- **Returns** [`FilterProcessRepresentationModel`](../../lib/process-services/process-list/models/filter-process.model.ts) - Filter just created
## Details ## Details
The methods of this service generally return an instance of The methods of this service generally return an instance of
`FilterProcessRepresentationModel` or an array of instances. For example, you [`FilterProcessRepresentationModel`](../../lib/process-services/process-list/models/filter-process.model.ts) or an array of instances. For example, you
could use `getProcessFilters` as follows: could use `getProcessFilters` as follows:
```ts ```ts
@ -52,7 +59,7 @@ this.processFilterService.getProcessFilters(processAppId)
}); });
``` ```
The response is an array of `FilterProcessRepresentationModel` objects: The response is an array of [`FilterProcessRepresentationModel`](../../lib/process-services/process-list/models/filter-process.model.ts) objects:
filters: filters:
0: {id: 15, appId: 2, name: "Running", recent: true, icon: "glyphicon-random", …} 0: {id: 15, appId: 2, name: "Running", recent: true, icon: "glyphicon-random", …}
@ -65,7 +72,6 @@ The response is an array of `FilterProcessRepresentationModel` objects:
You can use the returned filters to get matching process instances for the process app with ID 2, You can use the returned filters to get matching process instances for the process app with ID 2,
such as 'Running', 'Completed', 'All', etc. such as 'Running', 'Completed', 'All', etc.
## See also ## See also
- [Process Filters component](process-filters.component.md) - [Process Filters component](process-filters.component.md)

View File

@ -2,10 +2,28 @@
Added: v2.0.0 Added: v2.0.0
Status: Active Status: Active
--- ---
# Process Filters Component # Process Filters Component
Collection of criteria used to filter process instances, which may be customized by users. Collection of criteria used to filter process instances, which may be customized by users.
## Contents
- [Basic Usage](#basic-usage)
- [Class members](#class-members)
- [Properties](#properties)
- [Events](#events)
- [Details](#details)
- [How filter the activiti process filters](#how-filter-the-activiti-process-filters)
- [FilterParamsModel](#filterparamsmodel)
- [How to create an accordion menu with the processes filter](#how-to-create-an-accordion-menu-with-the-processes-filter)
- [See also](#see-also)
## Basic Usage ## Basic Usage
```html ```html
@ -19,19 +37,19 @@ Collection of criteria used to filter process instances, which may be customized
### Properties ### Properties
| Name | Type | Default value | Description | | Name | Type | Default value | Description |
| ---- | ---- | ------------- | ----------- | | -- | -- | -- | -- |
| filterParam | `FilterProcessRepresentationModel` | | The parameters to filter the task filter. If there is no match then the default one (ie, the first filter in the list) is selected. |
| appId | `number` | | Display filters available to the current user for the application with the specified ID. | | appId | `number` | | Display filters available to the current user for the application with the specified ID. |
| appName | `string` | | Display filters available to the current user for the application with the specified name. | | appName | `string` | | Display filters available to the current user for the application with the specified name. |
| showIcon | `boolean` | `true` | Toggle to show or hide the filter's icon. | | filterParam | [`FilterProcessRepresentationModel`](../../lib/process-services/process-list/models/filter-process.model.ts) | | The parameters to filter the task filter. If there is no match then the default one (ie, the first filter in the list) is selected. |
| showIcon | `boolean` | true | Toggle to show or hide the filter's icon. |
### Events ### Events
| Name | Type | Description | | Name | Type | Description |
| ---- | ---- | ----------- | | -- | -- | -- |
| error | `EventEmitter<any>` | Emitted when an error occurs. |
| filterClick | `EventEmitter<ProcessInstanceFilterRepresentation>` | Emitted when the user selects a filter from the list. | | filterClick | `EventEmitter<ProcessInstanceFilterRepresentation>` | Emitted when the user selects a filter from the list. |
| success | `EventEmitter<ProcessInstanceFilterRepresentation[]>` | Emitted when the list of filters has been successfully loaded from the server. | | success | `EventEmitter<ProcessInstanceFilterRepresentation[]>` | Emitted when the list of filters has been successfully loaded from the server. |
| error | `EventEmitter<any>` | Emitted when an error occurs. |
## Details ## Details
@ -51,7 +69,7 @@ If both `appId` and `appName` are specified then `appName` will take precedence
</adf-process-instance-filters> </adf-process-instance-filters>
``` ```
You can use inside the filterParam one of the properties defined by [FilterParamsModel](#filterparamsmodel) (see below). You can use inside the filterParam one of the properties defined by [`FilterParamsModel`](../../lib/process-services/task-list/models/filter.model.ts) (see below).
### FilterParamsModel ### FilterParamsModel

View File

@ -2,6 +2,7 @@
Added: v2.0.0 Added: v2.0.0
Status: Active Status: Active
--- ---
# Process Details component # Process Details component
Displays detailed information on a specified process instance Displays detailed information on a specified process instance
@ -19,16 +20,16 @@ Displays detailed information on a specified process instance
### Properties ### Properties
| Name | Type | Default value | Description | | Name | Type | Default value | Description |
| ---- | ---- | ------------- | ----------- | | -- | -- | -- | -- |
| processInstanceId | `string` | | (required) The numeric ID of the process instance to display. | | processInstanceId | `string` | | (required) The numeric ID of the process instance to display. |
| showTitle | `boolean` | `true` | Toggles whether to show or hide the title. | | showRefreshButton | `boolean` | true | Toggles whether to show or hide the refresh button. |
| showRefreshButton | `boolean` | `true` | Toggles whether to show or hide the refresh button. | | showTitle | `boolean` | true | Toggles whether to show or hide the title. |
### Events ### Events
| Name | Type | Description | | Name | Type | Description |
| ---- | ---- | ----------- | | -- | -- | -- |
| processCancelled | `EventEmitter<any>` | Emitted when the current process is cancelled by the user from within the component. |
| error | `EventEmitter<any>` | Emitted when an error occurs. | | error | `EventEmitter<any>` | Emitted when an error occurs. |
| taskClick | `EventEmitter<TaskDetailsEvent>` | Emitted when a task is clicked. | | processCancelled | `EventEmitter<any>` | Emitted when the current process is cancelled by the user from within the component. |
| showProcessDiagram | `EventEmitter<any>` | Emitted when the "show diagram" button is clicked. | | showProcessDiagram | `EventEmitter<any>` | Emitted when the "show diagram" button is clicked. |
| taskClick | [`EventEmitter<TaskDetailsEvent>`](../../lib/process-services/task-list/models/task-details.event.ts) | Emitted when a task is clicked. |

View File

@ -2,6 +2,7 @@
Added: v2.0.0 Added: v2.0.0
Status: Active Status: Active
--- ---
# Process Instance Details Header component # Process Instance Details Header component
Sub-component of the process details component, which renders some general information about the selected process. Sub-component of the process details component, which renders some general information about the selected process.
@ -21,23 +22,23 @@ Sub-component of the process details component, which renders some general infor
### Properties ### Properties
| Name | Type | Default value | Description | | Name | Type | Default value | Description |
| ---- | ---- | ------------- | ----------- | | -- | -- | -- | -- |
| processInstance | `ProcessInstance` | | (**required**) Full details of the process instance to display information about. | | processInstance | [`ProcessInstance`](../../lib/process-services/process-list/models/process-instance.model.ts) | | (**required**) Full details of the process instance to display information about. |
## Customise the properties showed ## Customise the properties showed
By default all the properties are showed : By default all the properties are showed :
***status***, ***ended***, ***category***, ***businessKey***, ***assignee***, ***created***,***id***, ***description***. **_status_**, **_ended_**, **_category_**, **_businessKey_**, **_assignee_**, **_created_**,**_id_**, **_description_**.
It is possible to customise the showed properties via "app.config.json". It is possible to customise the showed properties via "app.config.json".
This is how the configuration looks like: This is how the configuration looks like:
```json ```json
"adf-process-instance-header": { "adf-process-instance-header": {
"presets": { "presets": {
"properties" : [ "status", "ended", "created", "id"] "properties" : [ "status", "ended", "created", "id"]
} }
} }
``` ```
In this way only the listed properties will be showed. In this way only the listed properties will be showed.

View File

@ -2,6 +2,7 @@
Added: v2.0.0 Added: v2.0.0
Status: Active Status: Active
--- ---
# Process Instance Tasks component # Process Instance Tasks component
Lists both the active and completed tasks associated with a particular process instance Lists both the active and completed tasks associated with a particular process instance
@ -20,13 +21,13 @@ Lists both the active and completed tasks associated with a particular process i
### Properties ### Properties
| Name | Type | Default value | Description | | Name | Type | Default value | Description |
| ---- | ---- | ------------- | ----------- | | -- | -- | -- | -- |
| processInstanceDetails | `ProcessInstance` | | (**required**) The ID of the process instance to display tasks for. | | processInstanceDetails | [`ProcessInstance`](../../lib/process-services/process-list/models/process-instance.model.ts) | | (**required**) The ID of the process instance to display tasks for. |
| showRefreshButton | `boolean` | `true` | Toggles whether to show a refresh button next to the list of tasks to allow it to be updated from the server. | | showRefreshButton | `boolean` | true | Toggles whether to show a refresh button next to the list of tasks to allow it to be updated from the server. |
### Events ### Events
| Name | Type | Description | | Name | Type | Description |
| ---- | ---- | ----------- | | -- | -- | -- |
| error | `EventEmitter<any>` | Emitted when an error occurs. | | error | `EventEmitter<any>` | Emitted when an error occurs. |
| taskClick | `EventEmitter<TaskDetailsEvent>` | Emitted when a task is clicked. | | taskClick | [`EventEmitter<TaskDetailsEvent>`](../../lib/process-services/task-list/models/task-details.event.ts) | Emitted when a task is clicked. |

View File

@ -1,7 +1,7 @@
--- ---
Added: v2.0.0 Added: v2.0.0
Status: Active Status: Active
Last reviewed: 2018-04-16 Last reviewed: 2018-05-24
--- ---
# Process Instance List # Process Instance List
@ -23,28 +23,28 @@ Renders a list containing all the process instances matched by the parameters sp
### Properties ### Properties
| Name | Type | Default | Description | | Name | Type | Default value | Description |
| ---- | ---- | ------- | ----------- | | -- | -- | -- | -- |
| appId | number | | The id of the app. | | appId | `number` | | The id of the app. |
| processDefinitionKey | string | | The processDefinitionKey of the process. | | data | [`DataTableAdapter`](../../lib/core/datatable/data/datatable-adapter.ts) | | Data source to define the datatable. |
| presetColumn | string | | Name of a custom schema to fetch from `app.config.json`. | | multiselect | `boolean` | false | Toggles multiple row selection, which renders checkboxes at the beginning of each row |
| state | string | | Define state of the processes. Possible values are `running`, `completed` and `all` | | name | `string` | | The name of the list. |
| sort | string | | Define sort of the processes. Possible values are `created-desc`, `created-asc`, `ended-desc`, `ended-asc` | | page | `number` | 0 | The page number of the processes to fetch. |
| name | string | | The name of the list. | | presetColumn | `string` | | Name of a custom schema to fetch from `app.config.json`. |
| page | number | 0 | The page of the processes to fetch. | | processDefinitionKey | `string` | | The processDefinitionKey of the process. |
| size | number | 25 | The number of processes to fetch. | | selectFirstRow | `boolean` | true | Toggles default selection of the first row |
| data | DataTableAdapter | | Data source to define the datatable. | | selectionMode | `string` | "single" | Row selection mode. Can be none, `single` or `multiple`. For `multiple` mode, you can use Cmd (macOS) or Ctrl (Win) modifier key to toggle selection for multiple rows. |
| multiselect | boolean | false | Toggles multiple row selection, renders checkboxes at the beginning of each row. | | size | `number` | [`PaginationComponent`](../core/pagination.component.md).DEFAULT_PAGINATION.maxItems | The number of processes to fetch in each page. |
| selectionMode | string | 'single' | Row selection mode. Can be none, `single` or `multiple`. For `multiple` mode you can use Cmd (macOS) or Ctrl (Win) modifier key to toggle selection for multiple rows. | | sort | `string` | | Defines the sort ordering of the list. Possible values are `created-desc`, `created-asc`, `ended-desc`, `ended-asc`. |
| selectFirstRow | boolean | true | Toggles default selection of the first row. | | state | `string` | | Defines the state of the processes. Possible values are `running`, `completed` and `all` |
### Events ### Events
| Name | Type | Description | | Name | Type | Description |
| ---- | ---- | ----------- | | -- | -- | -- |
| rowClick | `EventEmitter<string>` | Emitted when a row in the process list is clicked | | error | `EventEmitter<any>` | Emitted when an error occurs while loading the list of process instances from the server. |
| success | `EventEmitter<ProcessListModel>` | Emitted when the list of process instances has been loaded successfully from the server | | rowClick | `EventEmitter<string>` | Emitted when a row in the process list is clicked. |
| error | `EventEmitter<any>` | Emitted when an error is encountered loading the list of process instances from the server | | success | [`EventEmitter<ProcessListModel>`](../../lib/process-services/process-list/models/process-list.model.ts) | Emitted when the list of process instances has been loaded successfully from the server. |
## Details ## Details

View File

@ -12,50 +12,58 @@ Manages Process Instances, Process Variables, and Process Audit Log.
### Methods ### Methods
- `getProcessInstances(requestNode: ProcessFilterParamRepresentationModel, processDefinitionKey?: string): Observable<ProcessListModel>` - **cancelProcess**(processInstanceId: `string` = `null`): `Observable<void>`<br/>
Get process instances for a filter and optionally a process definition.
- `requestNode` - Filter for instances
- `processDefinitionKey` - (Optional) Limits returned instances to a process definition
- `fetchProcessAuditPdfById(processId: string): Observable<Blob>`
Fetches the Process Audit information as a pdf
- `processId` - ID of the target process
- `fetchProcessAuditJsonById(processId: string): Observable<any>`
Fetches the Process Audit information in a json format.
- `processId` - ID of the target process
- `getProcess(processInstanceId: string): Observable<ProcessInstance>`
Gets Process Instance metadata.
- `processInstanceId` - ID of the target process
- `getProcessTasks(processInstanceId: string, state?: string): Observable<TaskDetailsModel[]>`
Gets task instances for a process instance.
- `processInstanceId` - ID of the process instance
- `state` - (Optional) Task state filter (can be "active" or "completed")
- `getProcessDefinitions(appId?: number): Observable<ProcessDefinitionRepresentation[]>`
Gets process definitions associated with an app.
- `appId` - (Optional) ID of a target app
- `getProcessDefinitionVersions(appId?: number): Observable<ProcessDefinitionRepresentation[]>`
Gets the versions of process definitions associated with an app.
- `appId` - (Optional) ID of a target app
- `startProcess(processDefinitionId: string, name: string, outcome?: string, startFormValues?: FormValues, variables?: ProcessInstanceVariable[]): Observable<ProcessInstance>`
Starts a process based on a process definition, name, form values or variables.
- `processDefinitionId` - Process definition ID
- `name` - Process name
- `outcome` - (Optional) Process outcome
- `startFormValues` - (Optional) Values for the start form
- `variables` - (Optional) Array of process instance variables
- `cancelProcess(processInstanceId: string): Observable<void>`
Cancels a process instance. Cancels a process instance.
- `processInstanceId` - ID of process to cancel - _processInstanceId:_ `string` - ID of process to cancel
- `getProcessInstanceVariables(processInstanceId: string): Observable<ProcessInstanceVariable[]>` - **Returns** `Observable<void>` - Null response notifying when the operation is complete
Gets the variables for a process instance. - **createOrUpdateProcessInstanceVariables**(processInstanceId: `string` = `null`, variables: [`ProcessInstanceVariable[]`](../../lib/process-services/process-list/models/process-instance-variable.model.ts) = `null`): [`Observable<ProcessInstanceVariable[]>`](../../lib/process-services/process-list/models/process-instance-variable.model.ts)<br/>
- `processInstanceId` - ID of the target process
- `createOrUpdateProcessInstanceVariables(processInstanceId: string, variables: ProcessInstanceVariable[]): Observable<ProcessInstanceVariable[]>`
Creates or updates variables for a process instance. Creates or updates variables for a process instance.
- `processInstanceId` - ID of the target process - _processInstanceId:_ `string` - ID of the target process
- `variables` - Variables to update - _variables:_ [`ProcessInstanceVariable[]`](../../lib/process-services/process-list/models/process-instance-variable.model.ts) - Variables to update
- `deleteProcessInstanceVariable(processInstanceId: string, variableName: string): Observable<void>` - **Returns** [`Observable<ProcessInstanceVariable[]>`](../../lib/process-services/process-list/models/process-instance-variable.model.ts) - Array of instance variable info
- **deleteProcessInstanceVariable**(processInstanceId: `string` = `null`, variableName: `string` = `null`): `Observable<void>`<br/>
Deletes a variable for a process instance. Deletes a variable for a process instance.
- `processInstanceId` - ID of the target process - _processInstanceId:_ `string` - ID of the target process
- `variableName` - Name of the variable to delete - _variableName:_ `string` - Name of the variable to delete
- **Returns** `Observable<void>` - Null response notifying when the operation is complete
- **fetchProcessAuditJsonById**(processId: `string` = `null`): `Observable<any>`<br/>
Fetches the Process Audit information in a JSON format.
- _processId:_ `string` - ID of the target process
- **Returns** `Observable<any>` - JSON data
- **fetchProcessAuditPdfById**(processId: `string` = `null`): `Observable<Blob>`<br/>
Fetches the Process Audit information as a PDF.
- _processId:_ `string` - ID of the target process
- **Returns** `Observable<Blob>` - Binary PDF data
- **getProcess**(processInstanceId: `string` = `null`): [`Observable<ProcessInstance>`](../../lib/process-services/process-list/models/process-instance.model.ts)<br/>
Gets Process Instance metadata.
- _processInstanceId:_ `string` - ID of the target process
- **Returns** [`Observable<ProcessInstance>`](../../lib/process-services/process-list/models/process-instance.model.ts) - Metadata for the instance
- **getProcessDefinitions**(appId?: `number` = `null`): [`Observable<ProcessDefinitionRepresentation[]>`](../../lib/process-services/process-list/models/process-definition.model.ts)<br/>
Gets process definitions associated with an app.
- _appId:_ `number` - (Optional) ID of a target app
- **Returns** [`Observable<ProcessDefinitionRepresentation[]>`](../../lib/process-services/process-list/models/process-definition.model.ts) - Array of process definitions
- **getProcessInstanceVariables**(processInstanceId: `string` = `null`): [`Observable<ProcessInstanceVariable[]>`](../../lib/process-services/process-list/models/process-instance-variable.model.ts)<br/>
Gets the variables for a process instance.
- _processInstanceId:_ `string` - ID of the target process
- **Returns** [`Observable<ProcessInstanceVariable[]>`](../../lib/process-services/process-list/models/process-instance-variable.model.ts) - Array of instance variable info
- **getProcessInstances**(requestNode: [`ProcessFilterParamRepresentationModel`](../../lib/process-services/process-list/models/filter-process.model.ts) = `null`, processDefinitionKey?: `string` = `null`): [`Observable<ProcessListModel>`](../../lib/process-services/process-list/models/process-list.model.ts)<br/>
Gets process instances for a filter and optionally a process definition.
- _requestNode:_ [`ProcessFilterParamRepresentationModel`](../../lib/process-services/process-list/models/filter-process.model.ts) - Filter for instances
- _processDefinitionKey:_ `string` - (Optional) Limits returned instances to a process definition
- **Returns** [`Observable<ProcessListModel>`](../../lib/process-services/process-list/models/process-list.model.ts) - List of process instances
- **getProcessTasks**(processInstanceId: `string` = `null`, state?: `string` = `null`): [`Observable<TaskDetailsModel[]>`](../process-services/task-details.model.md)<br/>
Gets task instances for a process instance.
- _processInstanceId:_ `string` - ID of the process instance
- _state:_ `string` - (Optional) Task state filter (can be "active" or "completed")
- **Returns** [`Observable<TaskDetailsModel[]>`](../process-services/task-details.model.md) - Array of task instance details
- **startProcess**(processDefinitionId: `string` = `null`, name: `string` = `null`, outcome?: `string` = `null`, startFormValues?: [`FormValues`](../../lib/core/form/components/widgets/core/form-values.ts) = `null`, variables?: [`ProcessInstanceVariable[]`](../../lib/process-services/process-list/models/process-instance-variable.model.ts) = `null`): [`Observable<ProcessInstance>`](../../lib/process-services/process-list/models/process-instance.model.ts)<br/>
Starts a process based on a process definition, name, form values or variables.
- _processDefinitionId:_ `string` - Process definition ID
- _name:_ `string` - Process name
- _outcome:_ `string` - (Optional) Process outcome
- _startFormValues:_ [`FormValues`](../../lib/core/form/components/widgets/core/form-values.ts) - (Optional) Values for the start form
- _variables:_ [`ProcessInstanceVariable[]`](../../lib/process-services/process-list/models/process-instance-variable.model.ts) - (Optional) Array of process instance variables
- **Returns** [`Observable<ProcessInstance>`](../../lib/process-services/process-list/models/process-instance.model.ts) - Details of the process instance just started
## Details ## Details
@ -99,7 +107,7 @@ this.processService.startProcess(processDefinitionId, name, outcome, startFormVa
}); });
``` ```
A `ProcessInstance` object is returned for a successfully started process. This implements the A [`ProcessInstance`](../../lib/process-services/process-list/models/process-instance.model.ts) object is returned for a successfully started process. This implements the
[ProcessInstanceRepresentation interface](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-activiti-rest-api/docs/ProcessInstanceRepresentation.md). [ProcessInstanceRepresentation interface](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-activiti-rest-api/docs/ProcessInstanceRepresentation.md).
You can start the process with process variables instead of form field values using You can start the process with process variables instead of form field values using

View File

@ -2,6 +2,7 @@
Added: v2.0.0 Added: v2.0.0
Status: Active Status: Active
--- ---
# Select app Component # Select app Component
Show all available apps and return the selected app. Show all available apps and return the selected app.

View File

@ -10,6 +10,24 @@ Starts a process.
![adf-start-process ](../docassets/images/startProcess.png) ![adf-start-process ](../docassets/images/startProcess.png)
## 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)
- [See also](#see-also)
## Basic Usage ## Basic Usage
```html ```html
@ -27,17 +45,17 @@ Starts a process.
| appId | `number` | (optional): Limit the list of processes which can be started to those contained in the specified app | | 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 | | name | `string` | (optional) name to assign to the current process |
| processDefinitionName | `string` | (optional) definition name of the process to start | | processDefinitionName | `string` | (optional) definition name of the process to start |
| variables | `ProcessInstanceVariable[]` | Variables in 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/process-list/models/process-instance-variable.model.ts) | Variables in input to the process [RestVariable](https://github.com/Alfresco/alfresco-js-api/tree/master/src/alfresco-activiti-rest-api/docs/RestVariable.md) |
| values | `FormValues` | Parameter to pass form field values in the start form if is associated | | values | [`FormValues`](../../lib/core/form/components/widgets/core/form-values.ts) | 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 | | showSelectProcessDropdown | `boolean` | hide or show the process selection drodown, true by default |
### Events ### Events
| Name | Type | Description | | Name | Type | Description |
| ---- | ---- | ----------- | | ---- | ---- | ----------- |
| start | `EventEmitter<ProcessInstance>` | Emitted when the process starts | | start | [`EventEmitter<ProcessInstance>`](../../lib/process-services/process-list/models/process-instance.model.ts) | Emitted when the process starts |
| cancel | `EventEmitter<ProcessInstance>` | Emitted when the process is canceled | | cancel | [`EventEmitter<ProcessInstance>`](../../lib/process-services/process-list/models/process-instance.model.ts) | Emitted when the process is canceled |
| error | `EventEmitter<ProcessInstance>` | Emitted when the start process operation fails | | error | [`EventEmitter<ProcessInstance>`](../../lib/process-services/process-list/models/process-instance.model.ts) | Emitted when the start process operation fails |
## Details ## Details
@ -143,7 +161,6 @@ const values: FormValues = {
}); });
``` ```
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 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](../content-services/document-library.model.md): [MinimalNodeEntryEntity](../content-services/document-library.model.md):

View File

@ -2,6 +2,7 @@
Added: v2.0.0 Added: v2.0.0
Status: Active Status: Active
--- ---
# Start Task Component # Start Task Component
Creates/Starts new task for the specified app Creates/Starts new task for the specified app
@ -21,13 +22,13 @@ Creates/Starts new task for the specified app
### Properties ### Properties
| Name | Type | Default value | Description | | Name | Type | Default value | Description |
| ---- | ---- | ------------- | ----------- | | -- | -- | -- | -- |
| appId | `number` | | (required) The id of the app. | | appId | `number` | | (required) The id of the app. |
### Events ### Events
| Name | Type | Description | | Name | Type | Description |
| ---- | ---- | ----------- | | -- | -- | -- |
| success | `EventEmitter<any>` | Emitted when the task is successfully created. |
| cancel | `EventEmitter<void>` | Emitted when the cancel button is clicked by the user. | | cancel | `EventEmitter<void>` | Emitted when the cancel button is clicked by the user. |
| error | `EventEmitter<any>` | Emitted when an error occurs. | | error | `EventEmitter<any>` | Emitted when an error occurs. |
| success | `EventEmitter<any>` | Emitted when the task is successfully created. |

View File

@ -3,6 +3,7 @@ Added: v2.0.0
Status: Active Status: Active
Last reviewed: 2018-03-13 Last reviewed: 2018-03-13
--- ---
# Task Attachment List Component # Task Attachment List Component
Displays attached documents on a specified task. Displays attached documents on a specified task.
@ -23,17 +24,17 @@ Displays attached documents on a specified task.
### Properties ### Properties
| Name | Type | Default value | Description | | Name | Type | Default value | Description |
| ---- | ---- | ------------- | ----------- | | -- | -- | -- | -- |
| disabled | `boolean` | false | Disable/Enable read only mode for attachement list. |
| taskId | `string` | | (**required**) The ID of the task to display. | | taskId | `string` | | (**required**) The ID of the task to display. |
| disabled | `boolean` | `false` | Disable/Enable read only mode for attachement list. |
### Events ### Events
| Name | Type | Description | | Name | Type | Description |
| ---- | ---- | ----------- | | -- | -- | -- |
| attachmentClick | `EventEmitter<{}>` | Emitted when the attachment is double-clicked or a view option is selected from the context menu by the user from within the component. Returns a Blob representing the clicked object. | | attachmentClick | `EventEmitter<Object>` | Emitted when the attachment is double-clicked or a view option is selected from the context menu by the user from within the component. Returns a Blob representing the clicked object. |
| success | `EventEmitter<{}>` | Emitted when the attachment list has fetched all the attachments. Returns a list of attachments. |
| error | `EventEmitter<any>` | Emitted when an error occurs while fetching the attachments. | | error | `EventEmitter<any>` | Emitted when an error occurs while fetching the attachments. |
| success | `EventEmitter<Object>` | Emitted when the attachment list has fetched all the attachments. Returns a list of attachments. |
## Details ## Details
@ -74,7 +75,7 @@ import { UploadService } from '@alfresco/adf-core';
import { TaskUploadService } from '@alfresco/adf-process-services'; import { TaskUploadService } from '@alfresco/adf-process-services';
``` ```
Make sure you override the `UploadService` with the `TaskUploadService` Make sure you override the [`UploadService`](../core/upload.service.md) with the [`TaskUploadService`](../../lib/process-services/task-list/services/task-upload.service.ts)
```ts ```ts
@Component({ @Component({

View File

@ -21,43 +21,43 @@ Shows the details of the task ID passed in as input.
### Properties ### Properties
| Name | Type | Default value | Description | | Name | Type | Default value | Description |
| ---- | ---- | ------------- | ----------- | | -- | -- | -- | -- |
| debugMode | `boolean` | `false` | Toggles debug mode. | | debugMode | `boolean` | false | Toggles debug mode. |
| fieldValidators | [`FormFieldValidator[]`](../../lib/core/form/components/widgets/core/form-field-validator.ts) | \[] | Field validators for use with the form. |
| readOnlyForm | `boolean` | false | Toggles read-only state of the form. All form widgets render as read-only if enabled. |
| showChecklist | `boolean` | true | Toggles `Checklist` feature for the Header component. |
| showComments | `boolean` | true | Toggles `Comments` feature for the Header component. |
| showFormCompleteButton | `boolean` | true | Toggles rendering of the `Complete` outcome button. |
| showFormRefreshButton | `boolean` | true | Toggles rendering of the `Refresh` button. |
| showFormSaveButton | `boolean` | true | Toggles rendering of the `Save` outcome button. |
| showFormTitle | `boolean` | true | Toggles rendering of the form title. |
| showHeader | `boolean` | true | Toggles task details Header component. |
| showHeaderContent | `boolean` | true | Toggles collapsed/expanded state of the Header component. |
| showInvolvePeople | `boolean` | true | Toggles `Involve People` feature for the Header component. |
| showNextTask | `boolean` | true | Automatically renders the next task when the current one is completed. |
| taskId | `string` | | (**required**) The id of the task whose details we are asking for. | | taskId | `string` | | (**required**) The id of the task whose details we are asking for. |
| showNextTask | `boolean` | `true` | Automatically renders the next task when the current one is completed. |
| showHeader | `boolean` | `true` | Toggles task details Header component. |
| showHeaderContent | `boolean` | `true` | Toggles collapsed/expanded state of the Header component. |
| showInvolvePeople | `boolean` | `true` | Toggles `Involve People` feature for the Header component. |
| showComments | `boolean` | `true` | Toggles `Comments` feature for the Header component. |
| showChecklist | `boolean` | `true` | Toggles `Checklist` feature for the Header component. |
| showFormTitle | `boolean` | `true` | Toggles rendering of the form title. |
| showFormCompleteButton | `boolean` | `true` | Toggles rendering of the `Complete` outcome button. |
| showFormSaveButton | `boolean` | `true` | Toggles rendering of the `Save` outcome button. |
| readOnlyForm | `boolean` | `false` | Toggles read-only state of the form. All form widgets render as read-only if enabled. |
| showFormRefreshButton | `boolean` | `true` | Toggles rendering of the `Refresh` button. |
| fieldValidators | `any[]` | `[]` | Field validators for use with the form. |
### Events ### Events
| Name | Type | Description | | Name | Type | Description |
| ---- | ---- | ----------- | | -- | -- | -- |
| formSaved | `EventEmitter<any>` | Emitted when the form is submitted with the `Save` or custom outcomes. |
| formCompleted | `EventEmitter<any>` | Emitted when the form is submitted with the `Complete` outcome. |
| formContentClicked | `EventEmitter<any>` | Emitted when the form field content is clicked. |
| formLoaded | `EventEmitter<any>` | Emitted when the form is loaded or reloaded. |
| taskCreated | `EventEmitter<TaskDetailsModel>` | Emitted when a checklist task is created. |
| taskDeleted | `EventEmitter<string>` | Emitted when a checklist task is deleted. |
| error | `EventEmitter<any>` | Emitted when an error occurs. |
| executeOutcome | `EventEmitter<any>` | Emitted when any outcome is executed. Default behaviour can be prevented via `event.preventDefault()`. |
| assignTask | `EventEmitter<void>` | Emitted when a task is assigned. | | assignTask | `EventEmitter<void>` | Emitted when a task is assigned. |
| claimedTask | `EventEmitter<string>` | Emitted when a task is claimed. | | claimedTask | `EventEmitter<string>` | Emitted when a task is claimed. |
| error | `EventEmitter<any>` | Emitted when an error occurs. |
| executeOutcome | [`EventEmitter<FormOutcomeEvent>`](../../lib/core/form/components/widgets/core/form-outcome-event.model.ts) | Emitted when any outcome is executed. Default behaviour can be prevented via `event.preventDefault()`. |
| formCompleted | [`EventEmitter<FormModel>`](../../lib/core/form/components/widgets/core/form.model.ts) | Emitted when the form is submitted with the `Complete` outcome. |
| formContentClicked | [`EventEmitter<ContentLinkModel>`](../../lib/core/form/components/widgets/core/content-link.model.ts) | Emitted when the form field content is clicked. |
| formLoaded | [`EventEmitter<FormModel>`](../../lib/core/form/components/widgets/core/form.model.ts) | Emitted when the form is loaded or reloaded. |
| formSaved | [`EventEmitter<FormModel>`](../../lib/core/form/components/widgets/core/form.model.ts) | Emitted when the form is submitted with the `Save` or custom outcomes. |
| taskCreated | [`EventEmitter<TaskDetailsModel>`](../process-services/task-details.model.md) | Emitted when a checklist task is created. |
| taskDeleted | `EventEmitter<string>` | Emitted when a checklist task is deleted. |
| unClaimedTask | `EventEmitter<string>` | Emitted when a task is unclaimed. | | unClaimedTask | `EventEmitter<string>` | Emitted when a task is unclaimed. |
## Details ## Details
### Custom 'empty Task Details' template ### Custom 'empty Task Details' template
By default the Task Details component shows a simple "No Tasks" message when there are By default the [Task Details component](../process-services/task-details.component.md) shows a simple "No Tasks" message when there are
no details. You can change this by adding the a custom HTML template as in the following no details. You can change this by adding the a custom HTML template as in the following
example: example:

View File

@ -2,6 +2,7 @@
Added: v2.0.0 Added: v2.0.0
Status: Active Status: Active
--- ---
# Task Details model # Task Details model
Information about a task. Information about a task.

View File

@ -11,42 +11,52 @@ Manage Task Filters, which are pre-configured Task Instance queries.
### Methods ### Methods
- `createDefaultFilters(appId: number): Observable<FilterRepresentationModel[]>` - **addFilter**(filter: [`FilterRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts) = `null`): [`Observable<FilterRepresentationModel>`](../../lib/process-services/task-list/models/filter.model.ts)<br/>
Creates and returns the default filters for a process app.
- `appId` - ID of the target app
- `getTaskListFilters(appId?: number): Observable<FilterRepresentationModel[]>`
Gets all task filters for a process app.
- `appId` - (Optional) Optional ID for a specific app
- `getTaskFilterById(filterId: number, appId?: number): Observable<FilterRepresentationModel>`
Gets a task filter by ID.
- `filterId` - ID of the filter
- `appId` - (Optional) ID of the app for the filter
- `getTaskFilterByName(taskName: string, appId?: number): Observable<FilterRepresentationModel>`
Gets a task filter by name.
- `taskName` - Name of the filter
- `appId` - (Optional) ID of the app for the filter
- `addFilter(filter: FilterRepresentationModel): Observable<FilterRepresentationModel>`
Adds a new task filter Adds a new task filter
- `filter` - The new filter to add - _filter:_ [`FilterRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts) - The new filter to add
- `callApiTaskFilters(appId?: number): any` - **Returns** [`Observable<FilterRepresentationModel>`](../../lib/process-services/task-list/models/filter.model.ts) - Details of task filter just added
- **callApiTaskFilters**(appId?: `number` = `null`): `Promise<any>`<br/>
Calls `getUserTaskFilters` from the Alfresco JS API. Calls `getUserTaskFilters` from the Alfresco JS API.
- `appId` - (Optional) ID of the target app - _appId:_ `number` - (Optional) ID of the target app
- `getInvolvedTasksFilterInstance(appId: number): FilterRepresentationModel` - **Returns** `Promise<any>` - List of task filters
Creates and returns a filter for "Involved" task instances. - **createDefaultFilters**(appId: `number` = `null`): [`Observable<FilterRepresentationModel[]>`](../../lib/process-services/task-list/models/filter.model.ts)<br/>
- `appId` - ID of the target app Creates and returns the default filters for a process app.
- `getMyTasksFilterInstance(appId: number): FilterRepresentationModel` - _appId:_ `number` - ID of the target app
Creates and returns a filter for "My Tasks" task instances. - **Returns** [`Observable<FilterRepresentationModel[]>`](../../lib/process-services/task-list/models/filter.model.ts) - Array of default filters just created
- `appId` - ID of the target app - **getCompletedTasksFilterInstance**(appId: `number` = `null`): [`FilterRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts)<br/>
- `getQueuedTasksFilterInstance(appId: number): FilterRepresentationModel`
Creates and returns a filter for "Queued Tasks" task instances.
- `appId` - ID of the target app
- `getCompletedTasksFilterInstance(appId: number): FilterRepresentationModel`
Creates and returns a filter for "Completed" task instances. Creates and returns a filter for "Completed" task instances.
- `appId` - ID of the target app - _appId:_ `number` - ID of the target app
- **Returns** [`FilterRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts) - The newly created filter
- **getInvolvedTasksFilterInstance**(appId: `number` = `null`): [`FilterRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts)<br/>
Creates and returns a filter for "Involved" task instances.
- _appId:_ `number` - ID of the target app
- **Returns** [`FilterRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts) - The newly created filter
- **getMyTasksFilterInstance**(appId: `number` = `null`): [`FilterRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts)<br/>
Creates and returns a filter for "My Tasks" task instances.
- _appId:_ `number` - ID of the target app
- **Returns** [`FilterRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts) - The newly created filter
- **getQueuedTasksFilterInstance**(appId: `number` = `null`): [`FilterRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts)<br/>
Creates and returns a filter for "Queued Tasks" task instances.
- _appId:_ `number` - ID of the target app
- **Returns** [`FilterRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts) - The newly created filter
- **getTaskFilterById**(filterId: `number` = `null`, appId?: `number` = `null`): [`Observable<FilterRepresentationModel>`](../../lib/process-services/task-list/models/filter.model.ts)<br/>
Gets a task filter by ID.
- _filterId:_ `number` - ID of the filter
- _appId:_ `number` - (Optional) ID of the app for the filter
- **Returns** [`Observable<FilterRepresentationModel>`](../../lib/process-services/task-list/models/filter.model.ts) - Details of task filter
- **getTaskFilterByName**(taskName: `string` = `null`, appId?: `number` = `null`): [`Observable<FilterRepresentationModel>`](../../lib/process-services/task-list/models/filter.model.ts)<br/>
Gets a task filter by name.
- _taskName:_ `string` - Name of the filter
- _appId:_ `number` - (Optional) ID of the app for the filter
- **Returns** [`Observable<FilterRepresentationModel>`](../../lib/process-services/task-list/models/filter.model.ts) - Details of task filter
- **getTaskListFilters**(appId?: `number` = `null`): [`Observable<FilterRepresentationModel[]>`](../../lib/process-services/task-list/models/filter.model.ts)<br/>
Gets all task filters for a process app.
- _appId:_ `number` - (Optional) Optional ID for a specific app
- **Returns** [`Observable<FilterRepresentationModel[]>`](../../lib/process-services/task-list/models/filter.model.ts) - Array of task filter details
## Details ## Details
The methods of this service generally return an instance of `FilterRepresentationModel` or The methods of this service generally return an instance of [`FilterRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts) or
an array of instances. For example, you could use `getTaskListFilters` as follows: an array of instances. For example, you could use `getTaskListFilters` as follows:
```ts ```ts
@ -58,7 +68,7 @@ this.taskFilterService.getTaskListFilters(processAppId).subscribe( (filters: Fil
}); });
``` ```
The response is an array of `FilterRepresentationModel` objects: The response is an array of [`FilterRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts) objects:
filters: filters:
0: {id: 10, appId: 2, name: "Involved Tasks", recent: true, icon: "glyphicon-align-left", …} 0: {id: 10, appId: 2, name: "Involved Tasks", recent: true, icon: "glyphicon-align-left", …}

View File

@ -2,10 +2,28 @@
Added: v2.0.0 Added: v2.0.0
Status: Active Status: Active
--- ---
# Task Filters component # Task Filters component
Shows all available filters. Shows all available filters.
## Contents
- [Basic Usage](#basic-usage)
- [Class members](#class-members)
- [Properties](#properties)
- [Events](#events)
- [Details](#details)
- [How filter the activiti task filters](#how-filter-the-activiti-task-filters)
- [FilterParamsModel](#filterparamsmodel)
- [How to create an accordion menu with the task filter](#how-to-create-an-accordion-menu-with-the-task-filter)
- [See also](#see-also)
## Basic Usage ## Basic Usage
```html ```html
@ -17,19 +35,19 @@ Shows all available filters.
### Properties ### Properties
| Name | Type | Default value | Description | | Name | Type | Default value | Description |
| ---- | ---- | ------------- | ----------- | | -- | -- | -- | -- |
| filterParam | `FilterParamsModel` | | Parameters to use for the task filter. If there is no match then the default filter (the first one the list) is selected. |
| appId | `number` | | Display filters available to the current user for the application with the specified ID. | | appId | `number` | | Display filters available to the current user for the application with the specified ID. |
| appName | `string` | | Display filters available to the current user for the application with the specified name. | | appName | `string` | | Display filters available to the current user for the application with the specified name. |
| hasIcon | `boolean` | `true` | Toggles display of the filter's icon. | | filterParam | [`FilterParamsModel`](../../lib/process-services/task-list/models/filter.model.ts) | | Parameters to use for the task filter. If there is no match then the default filter (the first one the list) is selected. |
| hasIcon | `boolean` | true | Toggles display of the filter's icon. |
### Events ### Events
| Name | Type | Description | | Name | Type | Description |
| ---- | ---- | ----------- | | -- | -- | -- |
| filterClick | `EventEmitter<FilterRepresentationModel>` | Emitted when a filter in the list is clicked. |
| success | `EventEmitter<any>` | Emitted when the list is loaded. |
| error | `EventEmitter<any>` | Emitted when an error occurs during loading. | | error | `EventEmitter<any>` | Emitted when an error occurs during loading. |
| filterClick | [`EventEmitter<FilterRepresentationModel>`](../../lib/process-services/task-list/models/filter.model.ts) | Emitted when a filter in the list is clicked. |
| success | `EventEmitter<any>` | Emitted when the list is loaded. |
## Details ## Details
@ -41,7 +59,7 @@ Shows all available filters.
</adf-task-filters> </adf-task-filters>
``` ```
You can use inside the filterParam one of the properties from [FilterParamsModel](#filterparamsmodel) (see below). You can use inside the filterParam one of the properties from [`FilterParamsModel`](../../lib/process-services/task-list/models/filter.model.ts) (see below).
### FilterParamsModel ### FilterParamsModel

View File

@ -23,14 +23,14 @@ Shows all the information related to a task.
### Properties ### Properties
| Name | Type | Default value | Description | | Name | Type | Default value | Description |
| ---- | ---- | ------------- | ----------- | | -- | -- | -- | -- |
| formName | `string` | `null` | The name of the form. | | formName | `string` | null | The name of the form. |
| taskDetails | `TaskDetailsModel` | | (required) Details related to the task. | | taskDetails | [`TaskDetailsModel`](../process-services/task-details.model.md) | | (required) Details related to the task. |
### Events ### Events
| Name | Type | Description | | Name | Type | Description |
| ---- | ---- | ----------- | | -- | -- | -- |
| claim | `EventEmitter<any>` | Emitted when the task is claimed. | | claim | `EventEmitter<any>` | Emitted when the task is claimed. |
| unclaim | `EventEmitter<any>` | Emitted when the task is unclaimed (ie, requeued). | | unclaim | `EventEmitter<any>` | Emitted when the task is unclaimed (ie, requeued). |
@ -41,19 +41,18 @@ The component populates an internal array of
By default all properties are displayed: By default all properties are displayed:
***assignee***, ***status***, ***priority***, ***dueDate***, ***category***, ***parentName***, ***created***, ***id***, ***description***, ***formName***. **_assignee_**, **_status_**, **_priority_**, **_dueDate_**, **_category_**, **_parentName_**, **_created_**, **_id_**, **_description_**, **_formName_**.
However, you can also choose which properties to show using a configuration in `app.config.json`: However, you can also choose which properties to show using a configuration in `app.config.json`:
```json ```json
"adf-task-header": { "adf-task-header": {
"presets": { "presets": {
"properties" : [ "assignee", "status", "priority", "parentName"] "properties" : [ "assignee", "status", "priority", "parentName"]
} }
}, },
``` ```
With this configuration, only the four listed properties will be shown. With this configuration, only the four listed properties will be shown.
## See also ## See also

View File

@ -8,6 +8,24 @@ Last reviewed: 2018-04-16
Renders a list containing all the tasks matched by the parameters specified. Renders a list containing all the tasks matched by the parameters specified.
## Contents
- [Basic Usage](#basic-usage)
- [Class members](#class-members)
- [Properties](#properties)
- [Events](#events)
- [Details](#details)
- [Setting the column schema](#setting-the-column-schema)
- [Pagination strategy](#pagination-strategy)
- [DataTableAdapter example](#datatableadapter-example)
- [DataColumn Features](#datacolumn-features)
- [See also](#see-also)
## Basic Usage ## Basic Usage
```html ```html
@ -23,30 +41,30 @@ Renders a list containing all the tasks matched by the parameters specified.
### Properties ### Properties
| Name | Type | Default value | Description | | Name | Type | Default value | Description |
| ---- | ---- | ------------- | ----------- | | -- | -- | -- | -- |
| appId | `number` | | The id of the app. | | appId | `number` | | The id of the app. |
| processInstanceId | `string` | | The Instance Id of the process. |
| processDefinitionKey | `string` | | The Definition Key of the process. **Deprecated:** in 2.4.0 |
| state | `string` | | Current state of the process. Possible values are: `completed`, `active`. |
| assignment | `string` | | The assignment of the process. Possible values are: "assignee" (the current user is the assignee), candidate (the current user is a task candidate", "group_x" (the task is assigned to a group where the current user is a member, no value(the current user is involved). | | assignment | `string` | | The assignment of the process. Possible values are: "assignee" (the current user is the assignee), candidate (the current user is a task candidate", "group_x" (the task is assigned to a group where the current user is a member, no value(the current user is involved). |
| sort | `string` | | Define the sort order of the processes. Possible values are : `created-desc`, `created-asc`, `due-desc`, `due-asc` | | data | [`DataTableAdapter`](../../lib/core/datatable/data/datatable-adapter.ts) | | Data source object that represents the number and the type of the columns that you want to show. |
| name | `string` | | Name of the tasklist. |
| landingTaskId | `string` | | Define which task id should be selected after reloading. If the task id doesn't exist or nothing is passed then the first task will be selected. | | landingTaskId | `string` | | Define which task id should be selected after reloading. If the task id doesn't exist or nothing is passed then the first task will be selected. |
| data | `any` | | Data source object that represents the number and the type of the columns that you want to show. | | multiselect | `boolean` | false | Toggles multiple row selection, renders checkboxes at the beginning of each row |
| selectionMode | `string` | `'single'` | Row selection mode. Can be none, `single` or `multiple`. For `multiple` mode, you can use Cmd (macOS) or Ctrl (Win) modifier key to toggle selection for multiple rows. | | name | `string` | | Name of the tasklist. |
| page | `number` | 0 | The page number of the tasks to fetch. |
| presetColumn | `string` | | Custom preset column schema in JSON format. | | presetColumn | `string` | | Custom preset column schema in JSON format. |
| multiselect | `boolean` | `false` | Toggles multiple row selection, renders checkboxes at the beginning of each row | | processDefinitionKey | `string` | | **Deprecated:** 2.4.0 |
| page | `number` | `0` | The page number of the tasks to fetch. | | processInstanceId | `string` | | The Instance Id of the process. |
| size | `number` | See description | The number of tasks to fetch. Default value: 25. | | selectionMode | `string` | "single" | Row selection mode. Can be none, `single` or `multiple`. For `multiple` mode, you can use Cmd (macOS) or Ctrl (Win) modifier key to toggle selection for multiple rows. |
| size | `number` | [`PaginationComponent`](../core/pagination.component.md).DEFAULT_PAGINATION.maxItems | The number of tasks to fetch. Default value: 25. |
| sort | `string` | | Define the sort order of the processes. Possible values are : `created-desc`, `created-asc`, `due-desc`, `due-asc` |
| state | `string` | | Current state of the process. Possible values are: `completed`, `active`. |
### Events ### Events
| Name | Type | Description | | Name | Type | Description |
| ---- | ---- | ----------- | | -- | -- | -- |
| error | `EventEmitter<any>` | Emitted when an error occurs. |
| rowClick | `EventEmitter<string>` | Emitted when a task in the list is clicked | | rowClick | `EventEmitter<string>` | Emitted when a task in the list is clicked |
| rowsSelected | `EventEmitter<any[]>` | Emitted when rows are selected/unselected | | rowsSelected | `EventEmitter<any[]>` | Emitted when rows are selected/unselected |
| success | `EventEmitter<any>` | Emitted when the task list is loaded | | success | `EventEmitter<any>` | Emitted when the task list is loaded |
| error | `EventEmitter<any>` | Emitted when an error occurs. |
## Details ## Details
@ -192,8 +210,8 @@ The Tasklist also supports pagination as shown in the example below:
### DataTableAdapter example ### DataTableAdapter example
See the [DataTableAdapter](../core/datatable-adapter.interface.md) page for full details of the interface and its standard See the [`DataTableAdapter`](../../lib/core/datatable/data/datatable-adapter.ts) page for full details of the interface and its standard
implementation, ObjectDataTableAdapter. Below is an example of how you can set up the adapter for a implementation, [ObjectDataTableAdapter](../../lib/core/datatable/data/object-datatable-adapter.ts). Below is an example of how you can set up the adapter for a
typical tasklist. typical tasklist.
```json ```json
@ -207,10 +225,10 @@ typical tasklist.
### DataColumn Features ### DataColumn Features
You can customize the styling of a column and also add features like tooltips and automatic translation of column titles. See the [DataColumn](../core/data-column.component.md) page for more information about these features. You can customize the styling of a column and also add features like tooltips and automatic translation of column titles. See the [`DataColumn`](../../lib/core/datatable/data/data-column.model.ts) page for more information about these features.
## See also ## See also
- [Data column component](../core/data-column.component.md) - [Data column component](../core/data-column.component.md)
- [DataTableAdapter](../core/datatable-adapter.interface.md) - [`DataTableAdapter`](../../lib/core/datatable/data/datatable-adapter.ts)
- [Pagination component](../core/pagination.component.md) - [Pagination component](../core/pagination.component.md)

View File

@ -2,17 +2,11 @@
Added: v2.0.0 Added: v2.0.0
Status: Active Status: Active
--- ---
# Task Standalone component # Task Standalone component
This component can be used when there is no form attached to a task. This component can be used when there is no form attached to a task.
## Contents
- [Basic Usage](#basic-usage)
- [Properties](#properties)
- [Events](#events)
## Basic Usage ## Basic Usage
```html ```html
@ -26,16 +20,15 @@ This component can be used when there is no form attached to a task.
### Properties ### Properties
| Name | Type | Default value | Description | | Name | Type | Default value | Description |
| ---- | ---- | ------------- | ----------- | | -- | -- | -- | -- |
| taskName | `string` | | Name of the task | | hasCompletePermission | `boolean` | true | Toggles rendering of the `Complete` button. |
| isCompleted | `boolean` | `false` | If true then Task completed message is shown and `Complete` and `Cancel` buttons are hidden | | hideCancelButton | `boolean` | true | Toggles rendering of the `Cancel` button. |
| hasCompletePermission | `boolean` | `true` | Toggle rendering of the `Complete` button. | | isCompleted | `boolean` | false | If true then Task completed message is shown and `Complete` and `Cancel` buttons are hidden. |
| hideCancelButton | `boolean` | `true` | Toggle rendering of the `Cancel` button. | | taskName | `string` | | Name of the task. |
### Events ### Events
| Name | Type | Description | | Name | Type | Description |
| ---- | ---- | ----------- | | -- | -- | -- |
| cancel | `EventEmitter<void>` | Emitted when the `Cancel` button is clicked. | | cancel | `EventEmitter<void>` | Emitted when the "Cancel" button is clicked. |
| complete | `EventEmitter<void>` | Emitted when the form associated with the task is completed. | | complete | `EventEmitter<void>` | Emitted when the form associated with the task is completed. |

View File

@ -12,86 +12,107 @@ Manages Task Instances.
### Methods ### Methods
- `getFilterForTaskById(taskId: string, filterList: FilterRepresentationModel[]): Observable<FilterRepresentationModel>` - **addTask**(task: [`TaskDetailsModel`](../process-services/task-details.model.md) = `null`): [`Observable<TaskDetailsModel>`](../process-services/task-details.model.md)<br/>
Gets all the filters in the list that belong to a task.
- `taskId` - ID of the target task
- `filterList` - List of filters to search through
- `isTaskRelatedToFilter(taskId: string, filter: FilterRepresentationModel): Observable<FilterRepresentationModel>`
Checks if a taskId is filtered with the given filter.
- `taskId` - ID of the target task
- `filter` - The filter you want to check
- `getTasks(requestNode: TaskQueryRequestRepresentationModel): Observable<TaskListModel>`
Gets all the tasks matching the supplied query.
- `requestNode` - Query to search for tasks
- `findTasksByState(requestNode: TaskQueryRequestRepresentationModel, state?: string): Observable<TaskListModel>`
Gets tasks matching a query and state value.
- `requestNode` - Query to search for tasks
- `state` - (Optional) Task state. Can be "open" or "completed".
- `findAllTaskByState(requestNode: TaskQueryRequestRepresentationModel, state?: string): Observable<TaskListModel>`
Gets all tasks matching a query and state value.
- `requestNode` - Query to search for tasks.
- `state` - (Optional) Task state. Can be "open" or "completed".
- `findAllTasksWithoutState(requestNode: TaskQueryRequestRepresentationModel): Observable<TaskListModel>`
Get all tasks matching the supplied query but ignoring the task state.
- `requestNode` - Query to search for tasks
- `getTaskDetails(taskId: string): Observable<TaskDetailsModel>`
Gets details for a task.
- `taskId` - ID of the target task.
- `getTaskChecklist(id: string): Observable<TaskDetailsModel[]>`
Gets the checklist for a task.
- `id` - ID of the target task
- `getFormList(): Observable<Form[]>`
Gets all available reusable forms.
- `attachFormToATask(taskId: string, formId: number): Observable<any>`
Attaches a form to a task.
- `taskId` - ID of the target task
- `formId` - ID of the form to add
- `addTask(task: TaskDetailsModel): Observable<TaskDetailsModel>`
Adds a subtask (ie, a checklist task) to a parent task. Adds a subtask (ie, a checklist task) to a parent task.
- `task` - The task to add - _task:_ [`TaskDetailsModel`](../process-services/task-details.model.md) - The task to add
- `deleteTask(taskId: string): Observable<TaskDetailsModel>` - **Returns** [`Observable<TaskDetailsModel>`](../process-services/task-details.model.md) - The subtask that was added
Deletes a subtask (ie, a checklist task) from a parent task. - **assignTask**(taskId: `string` = `null`, requestNode: `any` = `null`): [`Observable<TaskDetailsModel>`](../process-services/task-details.model.md)<br/>
- `taskId` - The task to delete
- `completeTask(taskId: string): any`
Gives completed status to a task.
- `taskId` - ID of the target task
- `getTotalTasks(requestNode: TaskQueryRequestRepresentationModel): Observable<any>`
Gets the total number of the tasks found by a query.
- `requestNode` - Query to search for tasks
- `createNewTask(task: TaskDetailsModel): Observable<TaskDetailsModel>`
Creates a new standalone task.
- `task` - Details of the new task
- `assignTask(taskId: string, requestNode: any): Observable<TaskDetailsModel>`
Assigns a task to a user or group. Assigns a task to a user or group.
- `taskId` - The task to assign - _taskId:_ `string` - The task to assign
- `requestNode` - User or group to assign the task to - _requestNode:_ `any` - User or group to assign the task to
- `assignTaskByUserId(taskId: string, userId: number): Observable<TaskDetailsModel>` - **Returns** [`Observable<TaskDetailsModel>`](../process-services/task-details.model.md) - Details of the assigned task
- **assignTaskByUserId**(taskId: `string` = `null`, userId: `number` = `null`): [`Observable<TaskDetailsModel>`](../process-services/task-details.model.md)<br/>
Assigns a task to a user. Assigns a task to a user.
- `taskId` - ID of the task to assign - _taskId:_ `string` - ID of the task to assign
- `userId` - ID of the user to assign the task to - _userId:_ `number` - ID of the user to assign the task to
- `claimTask(taskId: string): Observable<TaskDetailsModel>` - **Returns** [`Observable<TaskDetailsModel>`](../process-services/task-details.model.md) - Details of the assigned task
- **attachFormToATask**(taskId: `string` = `null`, formId: `number` = `null`): `Observable<any>`<br/>
Attaches a form to a task.
- _taskId:_ `string` - ID of the target task
- _formId:_ `number` - ID of the form to add
- **Returns** `Observable<any>` - Null response notifying when the operation is complete
- **claimTask**(taskId: `string` = `null`): [`Observable<TaskDetailsModel>`](../process-services/task-details.model.md)<br/>
Claims a task for the current user. Claims a task for the current user.
- `taskId` - ID of the task to claim - _taskId:_ `string` - ID of the task to claim
- `unclaimTask(taskId: string): Observable<TaskDetailsModel>` - **Returns** [`Observable<TaskDetailsModel>`](../process-services/task-details.model.md) - Details of the claimed task
Unclaims a task for the current user. - **completeTask**(taskId: `string` = `null`): `Observable<any>`<br/>
- `taskId` - ID of the task to unclaim Gives completed status to a task.
- `updateTask(taskId: any, updated): Observable<TaskDetailsModel>` - _taskId:_ `string` - ID of the target task
Updates the details (name, description, due date) for a task. - **Returns** `Observable<any>` - Null response notifying when the operation is complete
- `taskId` - ID of the task to update - **createNewTask**(task: [`TaskDetailsModel`](../process-services/task-details.model.md) = `null`): [`Observable<TaskDetailsModel>`](../process-services/task-details.model.md)<br/>
- `updated` - Data to update the task (as a \`TaskUpdateRepresentation\` instance). Creates a new standalone task.
- `fetchTaskAuditPdfById(taskId: string): Observable<Blob>` - _task:_ [`TaskDetailsModel`](../process-services/task-details.model.md) - Details of the new task
Fetches the Task Audit information in PDF format. - **Returns** [`Observable<TaskDetailsModel>`](../process-services/task-details.model.md) - Details of the newly created task
- `taskId` - ID of the target task - **deleteTask**(taskId: `string` = `null`): [`Observable<TaskDetailsModel>`](../process-services/task-details.model.md)<br/>
- `fetchTaskAuditJsonById(taskId: string): Observable<any>` Deletes a subtask (ie, a checklist task) from a parent task.
- _taskId:_ `string` - The task to delete
- **Returns** [`Observable<TaskDetailsModel>`](../process-services/task-details.model.md) - Null response notifying when the operation is complete
- **fetchTaskAuditJsonById**(taskId: `string` = `null`): `Observable<any>`<br/>
Fetch the Task Audit information in JSON format Fetch the Task Audit information in JSON format
- `taskId` - ID of the target task - _taskId:_ `string` - ID of the target task
- **Returns** `Observable<any>` - JSON data
- **fetchTaskAuditPdfById**(taskId: `string` = `null`): `Observable<Blob>`<br/>
Fetches the Task Audit information in PDF format.
- _taskId:_ `string` - ID of the target task
- **Returns** `Observable<Blob>` - Binary PDF data
- **findAllTaskByState**(requestNode: [`TaskQueryRequestRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts) = `null`, state?: `string` = `null`): [`Observable<TaskListModel>`](../../lib/process-services/task-list/models/task-list.model.ts)<br/>
Gets all tasks matching a query and state value.
- _requestNode:_ [`TaskQueryRequestRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts) - Query to search for tasks.
- _state:_ `string` - (Optional) Task state. Can be "open" or "completed".
- **Returns** [`Observable<TaskListModel>`](../../lib/process-services/task-list/models/task-list.model.ts) - List of tasks
- **findAllTasksWithoutState**(requestNode: [`TaskQueryRequestRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts) = `null`): [`Observable<TaskListModel>`](../../lib/process-services/task-list/models/task-list.model.ts)<br/>
Gets all tasks matching the supplied query but ignoring the task state.
- _requestNode:_ [`TaskQueryRequestRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts) - Query to search for tasks
- **Returns** [`Observable<TaskListModel>`](../../lib/process-services/task-list/models/task-list.model.ts) - List of tasks
- **findTasksByState**(requestNode: [`TaskQueryRequestRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts) = `null`, state?: `string` = `null`): [`Observable<TaskListModel>`](../../lib/process-services/task-list/models/task-list.model.ts)<br/>
Gets tasks matching a query and state value.
- _requestNode:_ [`TaskQueryRequestRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts) - Query to search for tasks
- _state:_ `string` - (Optional) Task state. Can be "open" or "completed".
- **Returns** [`Observable<TaskListModel>`](../../lib/process-services/task-list/models/task-list.model.ts) - List of tasks
- **getFilterForTaskById**(taskId: `string` = `null`, filterList: [`FilterRepresentationModel[]`](../../lib/process-services/task-list/models/filter.model.ts) = `null`): [`Observable<FilterRepresentationModel>`](../../lib/process-services/task-list/models/filter.model.ts)<br/>
Gets all the filters in the list that belong to a task.
- _taskId:_ `string` - ID of the target task
- _filterList:_ [`FilterRepresentationModel[]`](../../lib/process-services/task-list/models/filter.model.ts) - List of filters to search through
- **Returns** [`Observable<FilterRepresentationModel>`](../../lib/process-services/task-list/models/filter.model.ts) - Filters belonging to the task
- **getFormList**(): [`Observable<Form[]>`](../../lib/process-services/task-list/models/form.model.ts)<br/>
Gets all available reusable forms.
- **Returns** [`Observable<Form[]>`](../../lib/process-services/task-list/models/form.model.ts) - Array of form details
- **getTaskChecklist**(id: `string` = `null`): [`Observable<TaskDetailsModel[]>`](../process-services/task-details.model.md)<br/>
Gets the checklist for a task.
- _id:_ `string` - ID of the target task
- **Returns** [`Observable<TaskDetailsModel[]>`](../process-services/task-details.model.md) - Array of checklist task details
- **getTaskDetails**(taskId: `string` = `null`): [`Observable<TaskDetailsModel>`](../process-services/task-details.model.md)<br/>
Gets details for a task.
- _taskId:_ `string` - ID of the target task.
- **Returns** [`Observable<TaskDetailsModel>`](../process-services/task-details.model.md) - Task details
- **getTasks**(requestNode: [`TaskQueryRequestRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts) = `null`): [`Observable<TaskListModel>`](../../lib/process-services/task-list/models/task-list.model.ts)<br/>
Gets all the tasks matching the supplied query.
- _requestNode:_ [`TaskQueryRequestRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts) - Query to search for tasks
- **Returns** [`Observable<TaskListModel>`](../../lib/process-services/task-list/models/task-list.model.ts) - List of tasks
- **getTotalTasks**(requestNode: [`TaskQueryRequestRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts) = `null`): `Observable<any>`<br/>
Gets the total number of the tasks found by a query.
- _requestNode:_ [`TaskQueryRequestRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts) - Query to search for tasks
- **Returns** `Observable<any>` - Number of tasks
- **isTaskRelatedToFilter**(taskId: `string` = `null`, filter: [`FilterRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts) = `null`): [`Observable<FilterRepresentationModel>`](../../lib/process-services/task-list/models/filter.model.ts)<br/>
Checks if a taskId is filtered with the given filter.
- _taskId:_ `string` - ID of the target task
- _filter:_ [`FilterRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts) - The filter you want to check
- **Returns** [`Observable<FilterRepresentationModel>`](../../lib/process-services/task-list/models/filter.model.ts) - The filter if it is related or null otherwise
- **unclaimTask**(taskId: `string` = `null`): [`Observable<TaskDetailsModel>`](../process-services/task-details.model.md)<br/>
Unclaims a task for the current user.
- _taskId:_ `string` - ID of the task to unclaim
- **Returns** [`Observable<TaskDetailsModel>`](../process-services/task-details.model.md) - Null response notifying when the operation is complete
- **updateTask**(taskId: `any` = `null`, updated: `any` = `null`): [`Observable<TaskDetailsModel>`](../process-services/task-details.model.md)<br/>
Updates the details (name, description, due date) for a task.
- _taskId:_ `any` - ID of the task to update
- _updated:_ `any` - Data to update the task (as a `TaskUpdateRepresentation` instance).
- **Returns** [`Observable<TaskDetailsModel>`](../process-services/task-details.model.md) - Updated task details
## Details ## Details
### Task details ### Task details
Several of the methods return one or more `TaskDetailsModel` instances corresponding Several of the methods return one or more [`TaskDetailsModel`](../process-services/task-details.model.md) instances corresponding
to tasks or subtasks matched by a query of some kind. For example, `getTaskDetails` to tasks or subtasks matched by a query of some kind. For example, `getTaskDetails`
could be used as shown below: could be used as shown below:
@ -104,9 +125,8 @@ this.tasklistService.getTaskDetails(taskInstanceId).subscribe( (taskInstance: Ta
}); });
``` ```
The resulting `TaskDetailsModel` object contains information like the following: The resulting [`TaskDetailsModel`](../process-services/task-details.model.md) object contains information like the following:
```
adhocTaskCanBeReassigned: false adhocTaskCanBeReassigned: false
assignee: UserProcessModel {pictureId: null, id: 1, email: "admin@app.activiti.com", firstName: null, lastName: "Administrator"} assignee: UserProcessModel {pictureId: null, id: 1, email: "admin@app.activiti.com", firstName: null, lastName: "Administrator"}
category: null category: null
@ -138,11 +158,10 @@ The resulting `TaskDetailsModel` object contains information like the following:
processInstanceName: null processInstanceName: null
processInstanceStartUserId: "1" processInstanceStartUserId: "1"
taskDefinitionKey: "clarifyInvoice" taskDefinitionKey: "clarifyInvoice"
```
### Queries ### Queries
Some of the methods run a search query contained in a `TaskQueryRequestRepresentationModel` and Some of the methods run a search query contained in a [`TaskQueryRequestRepresentationModel`](../../lib/process-services/task-list/models/filter.model.ts) and
return the matched tasks. Below is an example of how you might run a query using `getTasks`: return the matched tasks. Below is an example of how you might run a query using `getTasks`:
```ts ```ts
@ -181,8 +200,8 @@ The `assignment` property filters tasks based on how they are assigned (or not a
Use `assignee` if you are interested in tasks that are assigned to a user. If you want to see Use `assignee` if you are interested in tasks that are assigned to a user. If you want to see
pooled tasks (i.e. tasks that needs to be claimed by a user), then use `candidate`. pooled tasks (i.e. tasks that needs to be claimed by a user), then use `candidate`.
A successful query returns a `TaskListModel` with the `data` property set to an array of A successful query returns a [`TaskListModel`](../../lib/process-services/task-list/models/task-list.model.ts) with the `data` property set to an array of
`TaskDetailsModel`: [`TaskDetailsModel`](../process-services/task-details.model.md):
data: data:
0: {id: "75010", name: "Approve Invoice - Invoice-10202.pdf", description: null, category: null, assignee: {…}, …} 0: {id: "75010", name: "Approve Invoice - Invoice-10202.pdf", description: null, category: null, assignee: {…}, …}

View File

@ -84,11 +84,11 @@ export class ProcessInstanceListComponent implements OnChanges, AfterContentInit
@Input() @Input()
name: string; name: string;
/* The page number of the processes to fetch. */ /** The page number of the processes to fetch. */
@Input() @Input()
page: number = 0; page: number = 0;
/* The page number processes to fetch. */ /** The number of processes to fetch in each page. */
@Input() @Input()
size: number = PaginationComponent.DEFAULT_PAGINATION.maxItems; size: number = PaginationComponent.DEFAULT_PAGINATION.maxItems;
@ -100,18 +100,18 @@ export class ProcessInstanceListComponent implements OnChanges, AfterContentInit
@Input() @Input()
data: DataTableAdapter; data: DataTableAdapter;
/* Toggles multiple row selection, renders checkboxes at the beginning of each row */ /** Toggles multiple row selection, which renders checkboxes at the beginning of each row */
@Input() @Input()
multiselect: boolean = false; multiselect: boolean = false;
/* Row selection mode. Can be none, `single` or `multiple`. For `multiple` mode, /** Row selection mode. Can be none, `single` or `multiple`. For `multiple` mode,
* you can use Cmd (macOS) or Ctrl (Win) modifier key to toggle selection for * you can use Cmd (macOS) or Ctrl (Win) modifier key to toggle selection for
* multiple rows. * multiple rows.
*/ */
@Input() @Input()
selectionMode: string = 'single'; // none|single|multiple selectionMode: string = 'single'; // none|single|multiple
/* Toggles default selection of the first row */ /** Toggles default selection of the first row */
@Input() @Input()
selectFirstRow: boolean = true; selectFirstRow: boolean = true;

View File

@ -16,7 +16,9 @@ var nameExceptions = {
"datatable.component": "DataTableComponent", "datatable.component": "DataTableComponent",
"tasklist.service": "TaskListService", "tasklist.service": "TaskListService",
"text-mask.component": "InputMaskDirective", "text-mask.component": "InputMaskDirective",
"card-item-types.service": "CardItemTypeService" "card-item-types.service": "CardItemTypeService",
"create-task-attachment.component": "AttachmentComponent",
"process-list.component": "ProcessInstanceListComponent"
}; };
var undocMethodNames = { var undocMethodNames = {
"ngOnChanges": 1 "ngOnChanges": 1

View File

@ -38,7 +38,9 @@ let nameExceptions = {
"datatable.component": "DataTableComponent", "datatable.component": "DataTableComponent",
"tasklist.service": "TaskListService", "tasklist.service": "TaskListService",
"text-mask.component": "InputMaskDirective", "text-mask.component": "InputMaskDirective",
"card-item-types.service": "CardItemTypeService" "card-item-types.service": "CardItemTypeService",
"create-task-attachment.component": "AttachmentComponent",
"process-list.component": "ProcessInstanceListComponent"
} }