[ADF-4152] Restructured remaining doc folders and fixed links (#4441)

* [ADF-4152] Moved proc services cloud docs to subfolders

* [ADF-4152] Fixed links in PS cloud docs

* [ADF-4152] Added subfolders and checked links for extensions and insights docs

* [ADF-4152] Moved proc services cloud docs to subfolders

* [ADF-4152] Fixed links in PS cloud docs

* [ADF-4152] Added subfolders and checked links for extensions and insights docs

* [ADF-4152] Fixed links in Proc cloud, Insights and Extensions docs

* [ADF-4152] Updated links in user guide

* [ADF-4152] Fixed broken links in tutorials

* [ADF-4152] Fixed remaining links in core docs

* [ADF-4152] Fixed remaining links in proc services docs

* [ADF-4152] Fixed remaining links in content services docs

* [ADF-4152] Fixed links in breaking changes docs

* [ADF-4152] Updated main README index page

* [ADF-4152] Fixed glitches with preview ext component docs
This commit is contained in:
Andy Stark 2019-03-14 22:01:55 +00:00 committed by Eugenio Romano
parent 8edf92f325
commit 31479cfaa4
80 changed files with 737 additions and 900 deletions

View File

@ -388,7 +388,7 @@ for more information about installing and using the source code.
[(Back to Contents)](#contents) [(Back to Contents)](#contents)
# Process Services Cloud API ## Process Services Cloud API
Contains components related to Process Services Cloud. Contains components related to Process Services Cloud.
See the library's See the library's
@ -397,42 +397,44 @@ for more information about installing and using the source code.
<!--process-services-cloud start--> <!--process-services-cloud start-->
## Components ### Components
| Name | Description | Source link | | Name | Description | Source link |
| ---- | ----------- | ----------- | | ---- | ----------- | ----------- |
| [App list cloud component](process-services-cloud/app-list-cloud.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Shows all deployed cloud application instances. | [Source](../lib/process-services-cloud/src/lib/app/components/app-list-cloud.component.ts) | | [App List Cloud Component](process-services-cloud/components/app-list-cloud.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Shows all deployed cloud application instances. | [Source](../lib/process-services-cloud/src/lib/app/components/app-list-cloud.component.ts) |
| [Group cloud component](process-services-cloud/group-cloud.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Searches Groups. | [Source](../lib/process-services-cloud/src/lib/group/components/group-cloud.component.ts) | | [Edit Process Filter Cloud component](process-services-cloud/components/edit-process-filter-cloud.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Shows Process Filter Details. | [Source](../lib/process-services-cloud/src/lib/process/process-filters/components/edit-process-filter-cloud.component.ts) |
| [Edit process filter cloud component](process-services-cloud/edit-process-filter-cloud.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Shows Process Filter Details. | [Source](../lib/process-services-cloud/src/lib/process/process-filters/components/edit-process-filter-cloud.component.ts) | | [Edit Task Filter Cloud component](process-services-cloud/components/edit-task-filter-cloud.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Edits Task Filter Details. | [Source](../lib/process-services-cloud/src/lib/task/task-filters/components/edit-task-filter-cloud.component.ts) |
| [Process filters cloud component](process-services-cloud/process-filters-cloud.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Lists all available process filters and allows to select a filter. | [Source](../lib/process-services-cloud/src/lib/process/process-filters/components/process-filters-cloud.component.ts) | | [Group Cloud component](process-services-cloud/components/group-cloud.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Searches Groups. | [Source](../lib/process-services-cloud/src/lib/group/components/group-cloud.component.ts) |
| [Process list cloud component](process-services-cloud/process-list-cloud.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Renders a list containing all the process instances matched by the parameters specified. | [Source](../lib/process-services-cloud/src/lib/process/process-list/components/process-list-cloud.component.ts) | | [People Cloud Component](process-services-cloud/components/people-cloud.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Allows one or more users to be selected (with auto-suggestion) based on the input parameters. | [Source](../lib/process-services-cloud/src/lib/task/start-task/components/people-cloud/people-cloud.component.ts) |
| [Start process cloud component](process-services-cloud/start-process-cloud.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Starts a process. | [Source](../lib/process-services-cloud/src/lib/process/start-process/components/start-process-cloud.component.ts) | | [Process Filters Cloud Component](process-services-cloud/components/process-filters-cloud.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Lists all available process filters and allows to select a filter. | [Source](../lib/process-services-cloud/src/lib/process/process-filters/components/process-filters-cloud.component.ts) |
| [People cloud component](process-services-cloud/people-cloud.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Allows one or more users to be selected (with auto-suggestion) based on the input parameters. | [Source](../lib/process-services-cloud/src/lib/task/start-task/components/people-cloud/people-cloud.component.ts) | | [Process Header Cloud Component](process-services-cloud/components/process-header-cloud.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Shows all the information related to a process instance. | [Source](../lib/process-services-cloud/src/lib/process/process-header/components/process-header-cloud.component.ts) |
| [Start task cloud component](process-services-cloud/start-task-cloud.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Creates/starts a new task for the specified app. | [Source](../lib/process-services-cloud/src/lib/task/start-task/components/start-task-cloud.component.ts) | | [Process Instance List Cloud component](process-services-cloud/components/process-list-cloud.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Renders a list containing all the process instances matched by the parameters specified. | [Source](../lib/process-services-cloud/src/lib/process/process-list/components/process-list-cloud.component.ts) |
| [Edit task filter cloud component](process-services-cloud/edit-task-filter-cloud.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Edits Task Filter Details. | [Source](../lib/process-services-cloud/src/lib/task/task-filters/components/edit-task-filter-cloud.component.ts) | | [Start Process Cloud Component](process-services-cloud/components/start-process-cloud.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Starts a process. | [Source](../lib/process-services-cloud/src/lib/process/start-process/components/start-process-cloud.component.ts) |
| [Task filters cloud component](process-services-cloud/task-filters-cloud.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Shows all available filters. | [Source](../lib/process-services-cloud/src/lib/task/task-filters/components/task-filters-cloud.component.ts) | | [Start Task Cloud Component](process-services-cloud/components/start-task-cloud.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Creates/starts a new task for the specified app. | [Source](../lib/process-services-cloud/src/lib/task/start-task/components/start-task-cloud.component.ts) |
| [Task header cloud component](process-services-cloud/task-header-cloud.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Shows all the information related to a task. | [Source](../lib/process-services-cloud/src/lib/task/task-header/components/task-header-cloud.component.ts) | | [Task Filters Cloud component](process-services-cloud/components/task-filters-cloud.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Shows all available filters. | [Source](../lib/process-services-cloud/src/lib/task/task-filters/components/task-filters-cloud.component.ts) |
| [Task list cloud component](process-services-cloud/task-list-cloud.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Renders a list containing all the tasks matched by the parameters specified. | [Source](../lib/process-services-cloud/src/lib/task/task-list/components/task-list-cloud.component.ts) | | [Task Header Cloud Component](process-services-cloud/components/task-header-cloud.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Shows all the information related to a task. | [Source](../lib/process-services-cloud/src/lib/task/task-header/components/task-header-cloud.component.ts) |
| [Task List Cloud component](process-services-cloud/components/task-list-cloud.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Renders a list containing all the tasks matched by the parameters specified. | [Source](../lib/process-services-cloud/src/lib/task/task-list/components/task-list-cloud.component.ts) |
## Pipes ### Pipes
| Name | Description | Source link | | Name | Description | Source link |
| ---- | ----------- | ----------- | | ---- | ----------- | ----------- |
| [Group initial pipe](process-services-cloud/group-initial.pipe.md) | Extracts the initial character from a group name. | [Source](../lib/process-services-cloud/src/lib/group/pipe/group-initial.pipe.ts) | | [Group initial pipe](process-services-cloud/pipes/group-initial.pipe.md) | Extracts the initial character from a group name. | [Source](../lib/process-services-cloud/src/lib/group/pipe/group-initial.pipe.ts) |
## Services ### Services
| Name | Description | Source link | | Name | Description | Source link |
| ---- | ----------- | ----------- | | ---- | ----------- | ----------- |
| [Apps process cloud service](process-services-cloud/apps-process-cloud.service.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Gets details of deployed apps for the current user. | [Source](../lib/process-services-cloud/src/lib/app/services/apps-process-cloud.service.ts) | | [Apps Process Cloud Service](process-services-cloud/services/apps-process-cloud.service.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Gets details of deployed apps for the current user. | [Source](../lib/process-services-cloud/src/lib/app/services/apps-process-cloud.service.ts) |
| [Group cloud service](process-services-cloud/group-cloud.service.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Searches and gets information for groups. | [Source](../lib/process-services-cloud/src/lib/group/services/group-cloud.service.ts) | | [Group Cloud Service](process-services-cloud/services/group-cloud.service.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Searches and gets information for groups. | [Source](../lib/process-services-cloud/src/lib/group/services/group-cloud.service.ts) |
| [Process filter cloud service](process-services-cloud/process-filter-cloud.service.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Manage Process Filters, which are pre-configured Process Instance queries. | [Source](../lib/process-services-cloud/src/lib/process/process-filters/services/process-filter-cloud.service.ts) | | [Process Filter Cloud Service](process-services-cloud/services/process-filter-cloud.service.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Manage Process Filters, which are pre-configured Process Instance queries. | [Source](../lib/process-services-cloud/src/lib/process/process-filters/services/process-filter-cloud.service.ts) |
| [Process list cloud service](process-services-cloud/process-list-cloud.service.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Searches processes. | [Source](../lib/process-services-cloud/src/lib/process/process-list/services/process-list-cloud.service.ts) | | [Process Header Cloud Service](process-services-cloud/services/process-header-cloud.service.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Manages cloud process instances. | [Source](../lib/process-services-cloud/src/lib/process/process-header/services/process-header-cloud.service.ts) |
| [Start process cloud service](process-services-cloud/start-process-cloud.service.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Gets process definitions and starts processes. | [Source](../lib/process-services-cloud/src/lib/process/start-process/services/start-process-cloud.service.ts) | | [Process List Cloud Service](process-services-cloud/services/process-list-cloud.service.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Searches processes. | [Source](../lib/process-services-cloud/src/lib/process/process-list/services/process-list-cloud.service.ts) |
| [Start task cloud service](process-services-cloud/start-task-cloud.service.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Starts standalone tasks. | [Source](../lib/process-services-cloud/src/lib/task/start-task/services/start-task-cloud.service.ts) | | [Start Process Cloud Service](process-services-cloud/services/start-process-cloud.service.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Gets process definitions and starts processes. | [Source](../lib/process-services-cloud/src/lib/process/start-process/services/start-process-cloud.service.ts) |
| [Task filter cloud service](process-services-cloud/task-filter-cloud.service.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Manages task filters. | [Source](../lib/process-services-cloud/src/lib/task/task-filters/services/task-filter-cloud.service.ts) | | [Start Task Cloud Service](process-services-cloud/services/start-task-cloud.service.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Starts standalone tasks. | [Source](../lib/process-services-cloud/src/lib/task/start-task/services/start-task-cloud.service.ts) |
| [Task header cloud service](process-services-cloud/task-header-cloud.service.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Manages cloud tasks. | [Source](../lib/process-services-cloud/src/lib/task/task-header/services/task-header-cloud.service.ts) | | [Task Filter Cloud Service](process-services-cloud/services/task-filter-cloud.service.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Manages task filters. | [Source](../lib/process-services-cloud/src/lib/task/task-filters/services/task-filter-cloud.service.ts) |
| [Task list cloud service](process-services-cloud/task-list-cloud.service.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Searches tasks. | [Source](../lib/process-services-cloud/src/lib/task/task-list/services/task-list-cloud.service.ts) | | [Task Header Cloud Service](process-services-cloud/services/task-header-cloud.service.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Manages cloud tasks. | [Source](../lib/process-services-cloud/src/lib/task/task-header/services/task-header-cloud.service.ts) |
| [Task List Cloud Service](process-services-cloud/services/task-list-cloud.service.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Searches tasks. | [Source](../lib/process-services-cloud/src/lib/task/task-list/services/task-list-cloud.service.ts) |
<!--process-services-cloud end--> <!--process-services-cloud end-->
@ -447,17 +449,18 @@ for more information about installing and using the source code.
<!--extensions start--> <!--extensions start-->
## Components ### Components
| Name | Description | Source link | | Name | Description | Source link |
| ---- | ----------- | ----------- | | ---- | ----------- | ----------- |
| [Dynamic component](extensions/dynamic.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Displays dynamically-loaded extension components. | [Source](../lib/extensions/src/lib/components/dynamic-component/dynamic.component.ts) | | [Dynamic Component](extensions/components/dynamic.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Displays dynamically-loaded extension components. | [Source](../lib/extensions/src/lib/components/dynamic-component/dynamic.component.ts) |
| [Preview Extension Component](extensions/components/preview-extension.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Displays dynamically-loaded extension components. | [Source](../lib/extensions/src/lib/components/viewer/preview-extension.component.ts) |
## Services ### Services
| Name | Description | Source link | | Name | Description | Source link |
| ---- | ----------- | ----------- | | ---- | ----------- | ----------- |
| [Extension service](extensions/extension.service.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Manages and runs basic extension functionality. | [Source](../lib/extensions/src/lib/services/extension.service.ts) | | [Extension Service](extensions/services/extension.service.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Manages and runs basic extension functionality. | [Source](../lib/extensions/src/lib/services/extension.service.ts) |
<!--extensions end--> <!--extensions end-->
@ -472,15 +475,15 @@ for more information about installing and using the source code.
<!--insights start--> <!--insights start-->
## Components ### Components
| Name | Description | Source link | | Name | Description | Source link |
| ---- | ----------- | ----------- | | ---- | ----------- | ----------- |
| [Widget component](insights/widget.component.md) | Base class for standard and custom widget classes. | [Source](../lib/insights/analytics-process/components/widgets/widget.component.ts) | | [Analytics Generator Component](insights/components/analytics-generator.component.md) | Generates and shows charts | [Source](../lib/insights/analytics-process/components/analytics-generator.component.ts) |
| [Analytics generator component](insights/analytics-generator.component.md) | Generates and shows charts | [Source](../lib/insights/analytics-process/components/analytics-generator.component.ts) | | [APS Analytics List Component](insights/components/analytics-report-list.component.md) | Shows a list of all available reports | [Source](../lib/insights/analytics-process/components/analytics-report-list.component.ts) |
| [Analytics report list component](insights/analytics-report-list.component.md) | Shows a list of all available reports | [Source](../lib/insights/analytics-process/components/analytics-report-list.component.ts) | | [APS Analytics Component](insights/components/analytics.component.md) | Shows the charts related to the reportId passed as input | [Source](../lib/insights/analytics-process/components/analytics.component.ts) |
| [Analytics component](insights/analytics.component.md) | Shows the charts related to the reportId passed as input | [Source](../lib/insights/analytics-process/components/analytics.component.ts) | | [Diagram Component](insights/components/diagram.component.md) | Displays process diagrams. | [Source](../lib/insights/diagram/components/diagram.component.ts) |
| [Diagram component](insights/diagram.component.md) | Displays process diagrams. | [Source](../lib/insights/diagram/components/diagram.component.ts) | | [Widget component](insights/components/widget.component.md) | Base class for standard and custom widget classes. | [Source](../lib/insights/analytics-process/components/widgets/widget.component.ts) |
<!--insights end--> <!--insights end-->

View File

@ -6,7 +6,6 @@ Title: Breaking changes, 2.6.0 -> 3.0.0
This document lists all the deprecated ADF v2.x components that were removed for v3.0.0: This document lists all the deprecated ADF v2.x components that were removed for v3.0.0:
- [PR ADF-3354](https://github.com/Alfresco/alfresco-ng2-components/pull/3980): - [PR ADF-3354](https://github.com/Alfresco/alfresco-ng2-components/pull/3980):
The `adf-accordion` component has been removed. The `adf-accordion` component has been removed.
@ -26,20 +25,20 @@ This document lists all the deprecated ADF v2.x components that were removed for
classes without the **adf-** prefix, you will now need to update them. For example, `.card-view` classes without the **adf-** prefix, you will now need to update them. For example, `.card-view`
is now `.adf-card-view`. is now `.adf-card-view`.
- [PR ADF-1443](https://github.com/Alfresco/alfresco-ng2-components/pull/4028): `DownloadZipDialogComponent` - [PR ADF-1443](https://github.com/Alfresco/alfresco-ng2-components/pull/4028): [`DownloadZipDialogComponent`](../../lib/core/dialogs/download-zip.dialog.ts)
and `NodeDownloadDirective` have been moved from the Content Services module to the Core module. and [`NodeDownloadDirective`](../core/directives/node-download.directive.md) have been moved from the Content Services module to the Core module.
This modification has enabled us to remove some code duplication between the two modules. This modification has enabled us to remove some code duplication between the two modules.
- [PR ADF-1873](https://github.com/Alfresco/alfresco-ng2-components/pull/4145): - [PR ADF-1873](https://github.com/Alfresco/alfresco-ng2-components/pull/4145):
- `adf-search-control`: The `QueryBody`, and - `adf-search-control`: The `QueryBody`, and
`customQueryBody` inputs of the `SearchControlComponent` have been removed in favor of the `customQueryBody` inputs of the [`SearchControlComponent`](../content-services/components/search-control.component.md) have been removed in favor of the
[custom search configuration interface](../core/search-configuration.interface.md). [custom search configuration interface](../core/interfaces/search-configuration.interface.md).
The inputs were deprecated in v2.1.0. The inputs were deprecated in v2.1.0.
- `<adf-viewer>`: The `fileNodeId` input that supplies the Node Id of the file to - `<adf-viewer>`: The `fileNodeId` input that supplies the [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/Node.md) Id of the file to
load has been renamed as `nodeId`. load has been renamed as `nodeId`.
- `<adf-viewer>`: The `allowShare` input has been removed. Inject the - `<adf-viewer>`: The `allowShare` input has been removed. Inject the
[Share Directive](../content-services/content-node-share.directive.md) in a [Share Directive](../content-services/directives/content-node-share.directive.md) in a
[custom toolbar](../core/viewer.component.md#custom-toolbar) to recreate the behavior of the [custom toolbar](../core/components/viewer.component.md#custom-toolbar) to recreate the behavior of the
Share button. Share button.
- `<adf-viewer>`: The `allowSidebar` input has now been split into `allowLeftSidebar` and `allowRightSidebar`. - `<adf-viewer>`: The `allowSidebar` input has now been split into `allowLeftSidebar` and `allowRightSidebar`.
- `<adf-viewer>`: The `showSidebar` input has now been split into `showLeftSidebar` and `showRightSidebar`. - `<adf-viewer>`: The `showSidebar` input has now been split into `showLeftSidebar` and `showRightSidebar`.
@ -49,13 +48,13 @@ This document lists all the deprecated ADF v2.x components that were removed for
(you can now have two sidebars on the left and right at the same time). (you can now have two sidebars on the left and right at the same time).
- `analytics-report-list` is now `adf-analytics-report-list`. - `analytics-report-list` is now `adf-analytics-report-list`.
- `analytics-report-parameters` is now `adf-analytics-report-parameters`. - `analytics-report-parameters` is now `adf-analytics-report-parameters`.
- `CommentProcessModel` was moved into the Core library with the name `CommentModel` in v2.3.0. Now you - `CommentProcessModel` was moved into the Core library with the name [`CommentModel`](../../lib/core/models/comment.model.ts) in v2.3.0. Now you
can only import it from `CoreModule`. can only import it from [`CoreModule`](../../lib/core/core.module.ts).
- `CommentsModule`, `CommentListComponent`, and `CommentsComponent` are no longer exported from - [`CommentsModule`](../../lib/core/comments/comments.module.ts), [`CommentListComponent`](../core/components/comment-list.component.md), and [`CommentsComponent`](../core/components/comments.component.md) are no longer exported from
`ProcessModule` but now from `CoreModule`. The old usage was deprecated in v2.3.0. [`ProcessModule`](../../lib/process-services/process.module.ts) but now from [`CoreModule`](../../lib/core/core.module.ts). The old usage was deprecated in v2.3.0.
- `<adf-upload-drag-area>`: The `parentId` input has been renamed as `rootFolderId`. The old - `<adf-upload-drag-area>`: The `parentId` input has been renamed as `rootFolderId`. The old
name was deprecated in v2.4.0. name was deprecated in v2.4.0.
- The `createFolder` event of the `UploadBase` class (emitted when a folder was - The `createFolder` event of the [`UploadBase`](../../lib/content-services/upload/components/base-upload/upload-base.ts) class (emitted when a folder was
created) was deprecated in v2.4.0 and is no longer used by the framework created) was deprecated in v2.4.0 and is no longer used by the framework
Use the `success` event instead. Use the `success` event instead.
- `<adf-filters>` is now `<adf-task-filters>`. The old usage was deprecated in v2.4.0. - `<adf-filters>` is now `<adf-task-filters>`. The old usage was deprecated in v2.4.0.
@ -69,8 +68,8 @@ This document lists all the deprecated ADF v2.x components that were removed for
- The `file-draggable` event (emitted when one or more files are dragged and dropped - The `file-draggable` event (emitted when one or more files are dragged and dropped
onto the draggable element) was deprecated in v2.4.0 and has now been removed. onto the draggable element) was deprecated in v2.4.0 and has now been removed.
Use `filesDropped` instead to get the same effect. Use `filesDropped` instead to get the same effect.
- The `DocumentListService.hasPermission` method was redundant and has now been removed. - The [`DocumentListService`](../content-services/services/document-list.service.md)`.hasPermission` method was redundant and has now been removed.
Use `ContentService.hasAllowableOperations` instead. Use [`ContentService`](../core/services/content.service.md)`.hasAllowableOperations` instead.
- The `diagram-sequence-flow` tag has now been renamed as `adf-diagram-sequence-flow`. - The `diagram-sequence-flow` tag has now been renamed as `adf-diagram-sequence-flow`.
The old name was deprecated in v2.3.0. The old name was deprecated in v2.3.0.
- The `diagram-alfresco-publish-task` tag has now been renamed as - The `diagram-alfresco-publish-task` tag has now been renamed as
@ -83,14 +82,15 @@ This document lists all the deprecated ADF v2.x components that were removed for
the same value in pagination using the `pageSize` property. the same value in pagination using the `pageSize` property.
- `<adf-document-list>`: The `enableInfiniteScrolling` input has been removed since - `<adf-document-list>`: The `enableInfiniteScrolling` input has been removed since
it is not used anymore. To choose the pagination strategy, add either the it is not used anymore. To choose the pagination strategy, add either the
[Infinite Pagination Component](../core/infinite-pagination.component.md) or the normal [Pagination Component](../core/pagination.component.md) and assign [Infinite Pagination Component](../core/components/infinite-pagination.component.md) or the normal [Pagination Component](../core/components/pagination.component.md) and assign
your document list as the `target`. your document list as the `target`.
- `<adf-document-list>`: The `folderNode` input has been removed. Use - `<adf-document-list>`: The `folderNode` input has been removed. Use
the `currentFolderId` and `node` inputs instead. the `currentFolderId` and `node` inputs instead.
- `SettingsService` has been removed. This was deprecated in v1.7.0. - `SettingsService` has been removed. This was deprecated in v1.7.0.
- `FormService`: the `addFieldsToAForm` method has been removed. - [`FormService`](../core/services/form.service.md): the `addFieldsToAForm` method has been removed.
- `<file-uploading-dialog>` has been renamed to `<adf-file-uploading-dialog>`. - `<file-uploading-dialog>` has been renamed to `<adf-file-uploading-dialog>`.
- [PR JS-API](https://github.com/Alfresco/alfresco-ng2-components/pull/4097): - [PR JS-API](https://github.com/Alfresco/alfresco-ng2-components/pull/4097):
- The name package of the JS-API has been modified to use the namespace and all - The name package of the JS-API has been modified to use the namespace and all
**alfresco-js-api** imports need to be modified to **@alfresco/js-api**. **alfresco-js-api** imports need to be modified to **@alfresco/js-api**.
See the official See the official
@ -103,6 +103,7 @@ This document lists all the deprecated ADF v2.x components that were removed for
when the JS-API is constructed. when the JS-API is constructed.
v2.6.1 and before: v2.6.1 and before:
```ts ```ts
callApi( callApi(
path: string, path: string,
@ -122,6 +123,7 @@ This document lists all the deprecated ADF v2.x components that were removed for
``` ```
After v3.0.0: After v3.0.0:
```ts ```ts
callApi( callApi(
path: string, path: string,
@ -139,10 +141,9 @@ This document lists all the deprecated ADF v2.x components that were removed for
): Promise<any>; ): Promise<any>;
``` ```
- [PR ADF-4062](https://github.com/Alfresco/alfresco-ng2-components/pull/4294) - [PR ADF-4062](https://github.com/Alfresco/alfresco-ng2-components/pull/4294)
- `adf-node-permission` has been renamed `adf-check-allowable-operation`. - `adf-node-permission` has been renamed `adf-check-allowable-operation`.
- `ContentService.hasPermission` was actually checking the `allowableOperation` value - [`ContentService`](../core/services/content.service.md)`.hasPermission` was actually checking the `allowableOperation` value
and has been renamed as `ContentService.hasAllowableOperations`. and has been renamed as [`ContentService`](../core/services/content.service.md)`.hasAllowableOperations`.
- `ContentService.hasPermissions` is a new method which actually *does* check - [`ContentService`](../core/services/content.service.md)`.hasPermissions` is a new method which actually _does_ check
the permissions. the permissions.

View File

@ -38,8 +38,8 @@ Opens a [Content Node Selector](content-node-selector.component.md) in its own
| isSelectionValid | `ValidationFunction` | defaultValidation | Function used to decide if the selected node has permission to be selected. Default value is a function that always returns true. | | isSelectionValid | `ValidationFunction` | defaultValidation | Function used to decide if the selected node has permission to be selected. Default value is a function that always returns true. |
| pageSize | `number` | | Number of items shown per page in the list. | | pageSize | `number` | | Number of items shown per page in the list. |
| where | `string` | | Custom _where_ filter function. See the [Document List component](../../content-services/components/document-list.component.md) for more information. | | where | `string` | | Custom _where_ filter function. See the [Document List component](../../content-services/components/document-list.component.md) for more information. |
| excludeSiteContent | `string[]` | | Custom list of site content componentIds. Used to filter out the corresponding items from the displayed nodes | | excludeSiteContent | | | Custom list of site content componentIds. Used to filter out the corresponding items from the displayed nodes |
| rowFilter | `RowFilter` | | Custom row filter function. See the [Row Filter Model](../models/row-filter.model.md) page for more information. | | rowFilter | | | Custom row filter function. See the [Row Filter Model](../models/row-filter.model.md) page for more information. |
### Events ### Events

View File

@ -80,8 +80,8 @@ Displays the documents from a repository.
| sortingMode | `string` | "client" | Defines sorting mode. Can be either `client` (items in the list are sorted client-side) or `server` (the ordering supplied by the server is used without further client-side sorting). Note that the `server` option _does not_ request the server to sort the data before delivering it. | | sortingMode | `string` | "client" | Defines sorting mode. Can be either `client` (items in the list are sorted client-side) or `server` (the ordering supplied by the server is used without further client-side sorting). Note that the `server` option _does not_ request the server to sort the data before delivering it. |
| thumbnails | `boolean` | false | Show document thumbnails rather than icons | | thumbnails | `boolean` | false | Show document thumbnails rather than icons |
| where | `string` | | Filters the [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/Node.md) list using the _where_ condition of the REST API (for example, isFolder=true). See the REST API documentation for more information. | | where | `string` | | Filters the [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/Node.md) list using the _where_ condition of the REST API (for example, isFolder=true). See the REST API documentation for more information. |
| currentFolderId | `string` | | The ID of the folder node to display or a reserved string alias for special sources | | currentFolderId | | | The ID of the folder node to display or a reserved string alias for special sources |
| rowFilter | `RowFilter` | | Custom function to choose whether to show or hide rows. See the [Row Filter Model](../models/row-filter.model.md) page for more information. | | rowFilter | | | Custom function to choose whether to show or hide rows. See the [Row Filter Model](../models/row-filter.model.md) page for more information. |
### Events ### Events

View File

@ -180,7 +180,7 @@ In the Example below we will prepend `Hi!` to each file and folder name in the l
<!-- {% endraw %} --> <!-- {% endraw %} -->
In the Example below we will integrate the [adf-tag-node-list](../../content-services/tag-node-list.component.md) component In the Example below we will integrate the [adf-tag-node-list](../../content-services/components/tag-node-list.component.md) component
within the document list. within the document list.
<!-- {% raw %} --> <!-- {% raw %} -->
@ -300,6 +300,6 @@ Now you can declare columns and assign the `desktop-only` class where needed:
## See also ## See also
- [Document list component](../../content-services/document-list.component.md) - [Document list component](../../content-services/components/document-list.component.md)
- [Datatable component](datatable.component.md) - [Datatable component](datatable.component.md)
- [Task list component](../../process-services/components/task-list.component.md) - [Task list component](../../process-services/components/task-list.component.md)

View File

@ -644,5 +644,5 @@ Final result
- [Data column component](data-column.component.md) - [Data column component](data-column.component.md)
- [Pagination component](pagination.component.md) - [Pagination component](pagination.component.md)
- [`DataTableAdapter`](../../../lib/core/datatable/data/datatable-adapter.ts) - [Data Table Adapter interface](../interfaces/datatable-adapter.interface.md)
- [Document list component](../../content-services/document-list.component.md) - [Document list component](../../content-services/components/document-list.component.md)

View File

@ -40,7 +40,7 @@ Adds "infinite" pagination to the component it is used with.
| ---- | ---- | ------------- | ----------- | | ---- | ---- | ------------- | ----------- |
| isLoading | `boolean` | false | Is a new page loading? | | isLoading | `boolean` | false | Is a new page loading? |
| pageSize | `number` | | Number of items that are added with each "load more" event. | | pageSize | `number` | | Number of items that are added with each "load more" event. |
| target | [`PaginatedComponent`](../../../lib/core/pagination/paginated-component.interface.ts) | | Component that provides custom pagination support. | | target | | | Component that provides custom pagination support. |
### Events ### Events
@ -65,5 +65,5 @@ See the [Pagination component](pagination.component.md) for more information abo
## See also ## See also
- [Document list component](../../content-services/document-list.component.md) - [Document list component](../../content-services/components/document-list.component.md)
- [Pagination component](pagination.component.md) - [Pagination component](pagination.component.md)

View File

@ -63,7 +63,7 @@ toolbar:
``` ```
For example, the image below shows a toolbar with a For example, the image below shows a toolbar with a
[Breadcrumb component](../../content-services/breadcrumb.component.md) title, and then some buttons [Breadcrumb component](../../content-services/components/breadcrumb.component.md) title, and then some buttons
pushed to the right by a spacer: pushed to the right by a spacer:
![](../../docassets/images/adf-toolbar-02.png) ![](../../docassets/images/adf-toolbar-02.png)

View File

@ -130,7 +130,7 @@ See the [Custom layout](#custom-layout) section for full details of all availabl
### Integrating with the Document List component ### Integrating with the Document List component
Below is the most simple integration of the Viewer and Below is the most simple integration of the Viewer and
[Document List](../../content-services/document-list.component.md) components within your custom component: [Document List](../../content-services/components/document-list.component.md) components within your custom component:
```html ```html
<adf-document-list <adf-document-list
@ -484,4 +484,4 @@ content.
## See also ## See also
- [Document List component](../../content-services/document-list.component.md) - [Document List component](../../content-services/components/document-list.component.md)

View File

@ -57,7 +57,7 @@ The decorated element will be disabled if:
### HTML element example ### HTML element example
A typical use case is to bind a [Document List](../../content-services/document-list.component.md) A typical use case is to bind a [Document List](../../content-services/components/document-list.component.md)
selection property to a toolbar button. In the following example, the "Delete" button should selection property to a toolbar button. In the following example, the "Delete" button should
be disabled if no selection is present or if user does not have permission to delete at least one node in the selection: be disabled if no selection is present or if user does not have permission to delete at least one node in the selection:
@ -81,7 +81,7 @@ one or more documents that they have permission to delete.
### Angular component example ### Angular component example
You can add the directive to any Angular component that implements the [`NodeAllowableOperationSubject`](../../../lib/core/directives/check-allowable-operation.directive.ts) You can add the directive to any Angular component that implements the [`NodeAllowableOperationSubject`](../../../lib/core/directives/check-allowable-operation.directive.ts)
interface (the [Upload Drag Area component](../../content-services/upload-drag-area.component.md), interface (the [Upload Drag Area component](../../content-services/components/upload-drag-area.component.md),
for example). You can also use it in much the same way as you would with an HTML element: for example). You can also use it in much the same way as you would with an HTML element:
```html ```html

View File

@ -55,4 +55,4 @@ export class MyComponent implements OnInit {
## Details ## Details
See the [Demo Shell](../../../demo-shell/README.md) See the [Demo Shell](../../../demo-shell/README.md)
or [Document List component](../../content-services/document-list.component.md) implementation for more details and use cases. or [Document List component](../../content-services/components/document-list.component.md) implementation for more details and use cases.

View File

@ -90,5 +90,5 @@ described below.
## See also ## See also
- [Search component](../../content-services/search.component.md) - [Search component](../../content-services/components/search.component.md)
- [Search configuration service](../services/search-configuration.service.md) - [Search configuration service](../services/search-configuration.service.md)

View File

@ -7,7 +7,7 @@ Last reviewed: 2018-11-20
# [Form Rendering service](../../../lib/core/form/services/form-rendering.service.ts "Defined in form-rendering.service.ts") # [Form Rendering service](../../../lib/core/form/services/form-rendering.service.ts "Defined in form-rendering.service.ts")
Maps a form field type string onto the corresponding form [widget component](../../insights/widget.component.md) type. Maps a form field type string onto the corresponding form [widget component](../../insights/components/widget.component.md) type.
## Class members ## Class members

View File

@ -69,7 +69,7 @@ repeated use. More information about renditions is available in the
In the [Renditions service](renditions.service.md) methods, the `nodeId` is a string identifying the content In the [Renditions service](renditions.service.md) methods, the `nodeId` is a string identifying the content
node that the rendition applies to. This can be obtained from node that the rendition applies to. This can be obtained from
[Document List component](../../content-services/document-list.component.md) events and various other places [Document List component](../../content-services/components/document-list.component.md) events and various other places
in the ADF API. The `encoding` identifies the conversion performed by the rendition. in the ADF API. The `encoding` identifies the conversion performed by the rendition.
See the See the

View File

@ -35,5 +35,5 @@ example code.
## See also ## See also
- [Search component](../../content-services/search.component.md) - [Search component](../../content-services/components/search.component.md)
- [Search configuration interface](../interfaces/search-configuration.interface.md) - [Search configuration interface](../interfaces/search-configuration.interface.md)

View File

@ -1,28 +0,0 @@
---
Title: Extensions API
Github only: true
---
# Extensions API
Contains components related to the Extensions functionality.
See the library's
[README file](../../lib/extensions/README.md)
for more information about installing and using the source code.
<!--extensions start-->
## Components
| Name | Description | Source link |
| ---- | ----------- | ----------- |
| [Dynamic component](dynamic.component.md) ![Experimental](../docassets/images/ExperimentalIcon.png) | Displays dynamically-loaded extension components. | [Source](../../lib/extensions/src/lib/components/dynamic-component/dynamic.component.ts) |
| [Preview Extension component](preview-extension.component.md) ![Experimental](../docassets/images/ExperimentalIcon.png) | Preview extension component. | [Source](../../lib/extensions/src/lib/components/viewer/preview-extension.component.ts) |
## Services
| Name | Description | Source link |
| ---- | ----------- | ----------- |
| [Extension service](extension.service.md) ![Experimental](../docassets/images/ExperimentalIcon.png) | Manages and runs basic extension functionality. | [Source](../../lib/extensions/src/lib/services/extension.service.ts) |
<!--extensions end-->

View File

@ -5,7 +5,7 @@ Status: Experimental
Last reviewed: 2018-12-17 Last reviewed: 2018-12-17
--- ---
# [Dynamic Component](../../lib/extensions/src/lib/components/dynamic-component/dynamic.component.ts "Defined in dynamic.component.ts") # [Dynamic Component](../../../lib/extensions/src/lib/components/dynamic-component/dynamic.component.ts "Defined in dynamic.component.ts")
Displays dynamically-loaded extension components. Displays dynamically-loaded extension components.
@ -24,7 +24,7 @@ Use the Dynamic component to create extensible apps
(ie, apps that provide a generalized UI structure where the specific content (ie, apps that provide a generalized UI structure where the specific content
can be "plugged in" by other developers). The `id` property refers to a can be "plugged in" by other developers). The `id` property refers to a
component that has previously been registered using the `setComponents` method component that has previously been registered using the `setComponents` method
of the [Extension service](../../lib/extensions/src/lib/services/extension.service.ts): of the [Extension service](../services/extension.service.md):
```ts ```ts
// Registering the extension components. // Registering the extension components.
@ -48,11 +48,10 @@ Use this to provide the extension developer with a standard layout that
contains placeholders defined by instances of the Dynamic component. The contains placeholders defined by instances of the Dynamic component. The
developer can then register any desired components to correspond to the developer can then register any desired components to correspond to the
defined component IDs. For example, the extensible app might be shipped defined component IDs. For example, the extensible app might be shipped
with the standard [Document List component](../content-services/document-list.component.md) registered against `plugInName.components.docList`. with the standard [Document List component](../../content-services/components/document-list.component.md) registered against `plugInName.components.docList`.
The extension developer can replace this with a custom class The extension developer can replace this with a custom class
simply by registering that class with `setComponents` before use. simply by registering that class with `setComponents` before use.
## See also ## See also
- [Extension service](../../lib/extensions/src/lib/services/extension.service.ts) - [Extension service](../services/extension.service.md)
- [Dynamic tab component](../../lib/extensions/src/lib/components/dynamic-tab/dynamic-tab.component.ts)

View File

@ -1,31 +1,32 @@
--- ---
Title: Dynamic Component Title: Preview Extension Component
Added: v3.1.0 Added: v3.1.0
Status: Experimental Status: Experimental
Last reviewed: 2018-04-12 Last reviewed: 2018-04-12
--- ---
# [Preview Extension component](../../lib/extensions/src/lib/components/viewer/preview-extension.component.ts "Defined in preview-extension.component.ts") # [Preview Extension component](../../../lib/extensions/src/lib/components/viewer/preview-extension.component.ts "Defined in preview-extension.component.ts")
Displays dynamically-loaded extension components. Displays dynamically-loaded extension components.
If you want give a look on a real working viewer extension project you can look at [aca monaco extensio](https://github.com/eromano/aca-monaco-extension)
See the [ACA monaco extension](https://github.com/eromano/aca-monaco-extension) for
an example of a real working viewer extension project.
## Class members ## Class members
### Properties ### Properties
The viewer component when it recognize a new extension always pass the following two parameter as input:
| Name | Type | Default value | Description | | Name | Type | Default value | Description |
| ---- | ---- | ------------- | ----------- | | ---- | ---- | ------------- | ----------- |
| extension | `string` | | |
| id | `string` | | |
| node | [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/Node.md) | | of the content to display |
| url | `string` | | URL Of the content in the repository | | url | `string` | | URL Of the content in the repository |
| node | `Node` | | Node of the content to display |
## Details ## Details
If you want create your custom extension viewer you need to create the following files in a separate project: If you want create your custom extension viewer you need to create the following files in a separate project:
The Module needs to know which is the Id of your extension: The Module needs to know which is the Id of your extension:
```ts ```ts
@ -36,11 +37,9 @@ export class YourExtensionViewerModule {
}); });
} }
} }
``` ```
Your [viewer component](../../core/components/viewer.component.md) extension business logic:
Your viewer component extension business logic:
```ts ```ts
import { Node } from '@alfresco/js-api'; import { Node } from '@alfresco/js-api';
@ -65,19 +64,15 @@ export class YourExtensionViewerComponent implements ViewerExtensionInterface {
....YOUR CUSTOM LOGIC ....YOUR CUSTOM LOGIC
} }
``` ```
Your viewer component template: Your [viewer component](../../core/components/viewer.component.md) template:
```HTML ```HTML
<div> This is your custom extension viewer template</div> <div> This is your custom extension viewer template</div>
``` ```
Your viewer component extension.json: Your [viewer component](../../core/components/viewer.component.md) extension.json:
```JSON ```JSON
{ {
@ -96,11 +91,8 @@ Your viewer component extension.json:
} }
} }
} }
``` ```
## See also ## See also
- [Extension service](../../lib/extensions/src/lib/services/extension.service.ts) - [Extension service](../services/extension.service.md)

View File

@ -5,7 +5,7 @@ Status: Experimental
Last reviewed: 2018-12-17 Last reviewed: 2018-12-17
--- ---
# [Extension Service](../../lib/extensions/src/lib/services/extension.service.ts "Defined in extension.service.ts") # [Extension Service](../../../lib/extensions/src/lib/services/extension.service.ts "Defined in extension.service.ts")
Manages and runs basic extension functionality. Manages and runs basic extension functionality.
@ -13,38 +13,43 @@ Manages and runs basic extension functionality.
### Methods ### Methods
- **evaluateRule**(ruleId: `string`, context: [`RuleContext`](../../lib/extensions/src/lib/config/rule.extensions.ts)): `boolean`<br/> - **evaluateRule**(ruleId: `string`, context: [`RuleContext`](../../../lib/extensions/src/lib/config/rule.extensions.ts)): `boolean`<br/>
Evaluates a rule. Evaluates a rule.
- _ruleId:_ `string` - ID of the rule to evaluate - _ruleId:_ `string` - ID of the rule to evaluate
- _context:_ [`RuleContext`](../../lib/extensions/src/lib/config/rule.extensions.ts) - Parameter object for the evaluator with details of app state - _context:_ [`RuleContext`](../../../lib/extensions/src/lib/config/rule.extensions.ts) - Parameter object for the evaluator with details of app state
- **Returns** `boolean` - True if the rule passed, false otherwise - **Returns** `boolean` - True if the rule passed, false otherwise
- **getActionById**(id: `string`): [`ActionRef`](../../lib/extensions/src/lib/config/action.extensions.ts)<br/> - **getActionById**(id: `string`): [`ActionRef`](../../../lib/extensions/src/lib/config/action.extensions.ts)<br/>
Retrieves an action using its ID value. Retrieves an action using its ID value.
- _id:_ `string` - The ID value to look for - _id:_ `string` - The ID value to look for
- **Returns** [`ActionRef`](../../lib/extensions/src/lib/config/action.extensions.ts) - Action or null if not found - **Returns** [`ActionRef`](../../../lib/extensions/src/lib/config/action.extensions.ts) - Action or null if not found
- **getAuthGuards**(ids: `string[]`): `Array<Type<__type>>`<br/> - **getAuthGuards**(ids: `string[]`): `Array<Type<__type>>`<br/>
Retrieves one or more auth guards using an array of ID values. Retrieves one or more auth guards using an array of ID values.
- _ids:_ `string[]` - Array of ID value to look for - _ids:_ `string[]` - Array of ID value to look for
- **Returns** `Array<Type<__type>>` - Array of auth guards or empty array if none were found - **Returns** `Array<Type<__type>>` - Array of auth guards or empty array if none were found
- **getComponentById**(id: `string`): `Type<>`<br/> - **getComponentById**(id: `string`): `Type<>`<br/>
Retrieves a registered [extension component](../../lib/extensions/src/lib/services/component-register.service.ts) using its ID value. Retrieves a registered [extension component](../../../lib/extensions/src/lib/services/component-register.service.ts) using its ID value.
- _id:_ `string` - The ID value to look for - _id:_ `string` - The ID value to look for
- **Returns** `Type<>` - The component or null if not found - **Returns** `Type<>` - The component or null if not found
- **getEvaluator**(key: `string`): `RuleEvaluator`<br/> - **getEvaluator**(key: `string`): `RuleEvaluator`<br/>
Retrieves a RuleEvaluator function using its key name. Retrieves a RuleEvaluator function using its key name.
- _key:_ `string` - Key name to look for - _key:_ `string` - Key name to look for
- **Returns** `RuleEvaluator` - RuleEvaluator or null if not found - **Returns** `RuleEvaluator` - RuleEvaluator or null if not found
- **getRouteById**(id: `string`): [`RouteRef`](../../lib/extensions/src/lib/config/routing.extensions.ts)<br/> - **getFeature**(key: `string`): `any[]`<br/>
- _key:_ `string` -
- **Returns** `any[]` -
- **getRouteById**(id: `string`): [`RouteRef`](../../../lib/extensions/src/lib/config/routing.extensions.ts)<br/>
Retrieves a route using its ID value. Retrieves a route using its ID value.
- _id:_ `string` - The ID value to look for - _id:_ `string` - The ID value to look for
- **Returns** [`RouteRef`](../../lib/extensions/src/lib/config/routing.extensions.ts) - The route or null if not found - **Returns** [`RouteRef`](../../../lib/extensions/src/lib/config/routing.extensions.ts) - The route or null if not found
- **getRuleById**(id: `string`): [`RuleRef`](../../lib/extensions/src/lib/config/rule.extensions.ts)<br/> - **getRuleById**(id: `string`): [`RuleRef`](../../../lib/extensions/src/lib/config/rule.extensions.ts)<br/>
Retrieves a rule using its ID value. Retrieves a rule using its ID value.
- _id:_ `string` - The ID value to look for - _id:_ `string` - The ID value to look for
- **Returns** [`RuleRef`](../../lib/extensions/src/lib/config/rule.extensions.ts) - The rule or null if not found - **Returns** [`RuleRef`](../../../lib/extensions/src/lib/config/rule.extensions.ts) - The rule or null if not found
- **load**(): [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises)`<`[`ExtensionConfig`](../../lib/extensions/src/lib/config/extension.config.ts)`>`<br/> - **load**(): [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises)`<`[`ExtensionConfig`](../../../lib/extensions/src/lib/config/extension.config.ts)`>`<br/>
Loads and registers an extension config file and plugins (specified by path properties). Loads and registers an extension config file and plugins (specified by path properties).
- **Returns** [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises)`<`[`ExtensionConfig`](../../lib/extensions/src/lib/config/extension.config.ts)`>` - The loaded config data - **Returns** [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises)`<`[`ExtensionConfig`](../../../lib/extensions/src/lib/config/extension.config.ts)`>` - The loaded config data
- **runExpression**(value: `string`, context?: `any`): `any`<br/> - **runExpression**(value: `string`, context?: `any`): `any`<br/>
Runs a lightweight expression stored in a string. Runs a lightweight expression stored in a string.
- _value:_ `string` - String containing the expression or literal value - _value:_ `string` - String containing the expression or literal value
@ -59,11 +64,11 @@ Manages and runs basic extension functionality.
- **setEvaluators**(values: `Function`)<br/> - **setEvaluators**(values: `Function`)<br/>
Adds one or more new rule evaluators to the existing set. Adds one or more new rule evaluators to the existing set.
- _values:_ `Function` - The new evaluators to add - _values:_ `Function` - The new evaluators to add
- **setup**(config: [`ExtensionConfig`](../../lib/extensions/src/lib/config/extension.config.ts))<br/> - **setup**(config: [`ExtensionConfig`](../../../lib/extensions/src/lib/config/extension.config.ts))<br/>
Registers extensions from a config object. Registers extensions from a config object.
- _config:_ [`ExtensionConfig`](../../lib/extensions/src/lib/config/extension.config.ts) - Object with config data - _config:_ [`ExtensionConfig`](../../../lib/extensions/src/lib/config/extension.config.ts) - Object with config data
## Details ## Details
Use the methods of this service to add extensibility features to your app. You can find further Use the methods of this service to add extensibility features to your app. You can find further
details in the [App extensions](../user-guide/app-extensions.md) page. details in the [App extensions](../../user-guide/app-extensions.md) page.

View File

@ -1,25 +0,0 @@
---
Title: Insights API
Github only: true
---
# Insights API
Contains components for Process Services analytics and diagrams.
See the library's
[README file](../../lib/insights/README.md)
for more information about installing and using the source code.
<!--insights start-->
## Components
| Name | Description | Source link |
| ---- | ----------- | ----------- |
| [Widget component](widget.component.md) | Base class for standard and custom widget classes. | [Source](../../lib/insights/analytics-process/components/widgets/widget.component.ts) |
| [Analytics generator component](analytics-generator.component.md) | Generates and shows charts | [Source](../../lib/insights/analytics-process/components/analytics-generator.component.ts) |
| [Analytics report list component](analytics-report-list.component.md) | Shows a list of all available reports | [Source](../../lib/insights/analytics-process/components/analytics-report-list.component.ts) |
| [Analytics component](analytics.component.md) | Shows the charts related to the reportId passed as input | [Source](../../lib/insights/analytics-process/components/analytics.component.ts) |
| [Diagram component](diagram.component.md) | Displays process diagrams. | [Source](../../lib/insights/diagram/components/diagram.component.ts) |
<!--insights end-->

View File

@ -4,7 +4,7 @@ Added: v2.0.0
Status: Active Status: Active
--- ---
# [Analytics Generator Component](../../lib/insights/analytics-process/components/analytics-generator.component.ts "Defined in analytics-generator.component.ts") # [Analytics Generator Component](../../../lib/insights/analytics-process/components/analytics-generator.component.ts "Defined in analytics-generator.component.ts")
Generates and shows charts Generates and shows charts
@ -24,7 +24,7 @@ Generates and shows charts
| Name | Type | Default value | Description | | Name | Type | Default value | Description |
| ---- | ---- | ------------- | ----------- | | ---- | ---- | ------------- | ----------- |
| reportId | `number` | | | | reportId | `number` | | |
| reportParamQuery | [`ReportQuery`](../../lib/insights/diagram/models/report/reportQuery.model.ts) | undefined | | | reportParamQuery | [`ReportQuery`](../../../lib/insights/diagram/models/report/reportQuery.model.ts) | undefined | |
### Events ### Events

View File

@ -4,7 +4,7 @@ Added: v2.0.0
Status: Active Status: Active
--- ---
# [APS Analytics List Component](../../lib/insights/analytics-process/components/analytics-report-list.component.ts "Defined in analytics-report-list.component.ts") # [APS Analytics List Component](../../../lib/insights/analytics-process/components/analytics-report-list.component.ts "Defined in analytics-report-list.component.ts")
Shows a list of all available reports Shows a list of all available reports
@ -31,5 +31,5 @@ Shows a list of all available reports
| Name | Type | Description | | Name | Type | Description |
| ---- | ---- | ----------- | | ---- | ---- | ----------- |
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<Object>` | | | error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<Object>` | |
| reportClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ReportParametersModel`](../../lib/insights/diagram/models/report/reportParameters.model.ts)`>` | | | reportClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ReportParametersModel`](../../../lib/insights/diagram/models/report/reportParameters.model.ts)`>` | |
| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<Object>` | | | success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<Object>` | |

View File

@ -4,11 +4,11 @@ Added: v2.0.0
Status: Active Status: Active
--- ---
# [APS Analytics Component](../../lib/insights/analytics-process/components/analytics.component.ts "Defined in analytics.component.ts") # [APS Analytics Component](../../../lib/insights/analytics-process/components/analytics.component.ts "Defined in analytics.component.ts")
Shows the charts related to the reportId passed as input Shows the charts related to the reportId passed as input
![Analytics-without-parameters](../docassets/images/analytics-without-parameters.png) ![Analytics-without-parameters](../../docassets/images/analytics-without-parameters.png)
## Basic Usage ## Basic Usage

View File

@ -4,7 +4,7 @@ Added: v2.0.0
Status: Active Status: Active
--- ---
# [Diagram Component](../../lib/insights/diagram/components/diagram.component.ts "Defined in diagram.component.ts") # [Diagram Component](../../../lib/insights/diagram/components/diagram.component.ts "Defined in diagram.component.ts")
Displays process diagrams. Displays process diagrams.

View File

@ -5,7 +5,7 @@ Status: Active
Last reviewed: 2018-03-29 Last reviewed: 2018-03-29
--- ---
# [Widget component](../../lib/insights/analytics-process/components/widgets/widget.component.ts "Defined in widget.component.ts") # [Widget component](../../../lib/insights/analytics-process/components/widgets/widget.component.ts "Defined in widget.component.ts")
Base class for standard and custom widget classes. Base class for standard and custom widget classes.
@ -40,10 +40,10 @@ export class CustomEditorComponent extends WidgetComponent {}
## Details ## Details
The [Widget component](../insights/widget.component.md) is the base class for all standard and custom form widgets. See the The [Widget component](widget.component.md) is the base class for all standard and custom form widgets. See the
[Form Extensibility and Customisation](../user-guide/extensibility.md) page for full details about [Form Extensibility and Customisation](../../user-guide/extensibility.md) page for full details about
implementing custom widgets. implementing custom widgets.
## See also ## See also
- [Extensibility](../user-guide/extensibility.md) - [Extensibility](../../user-guide/extensibility.md)

View File

@ -1,52 +0,0 @@
---
Title: Process Services Cloud API
Github only: true
---
# Process Services Cloud API
Contains components related to Process Services Cloud.
See the library's
[README file](../../lib/process-services-cloud/README.md)
for more information about installing and using the source code.
<!--process-services-cloud start-->
## Components
| Name | Description | Source link |
| ---- | ----------- | ----------- |
| [App list cloud component](app-list-cloud.component.md) ![Experimental](../docassets/images/ExperimentalIcon.png) | Shows all deployed cloud application instances. | [Source](../../lib/process-services-cloud/src/lib/app/components/app-list-cloud.component.ts) |
| [Group cloud component](group-cloud.component.md) ![Experimental](../docassets/images/ExperimentalIcon.png) | Searches Groups. | [Source](../../lib/process-services-cloud/src/lib/group/components/group-cloud.component.ts) |
| [Edit process filter cloud component](edit-process-filter-cloud.component.md) ![Experimental](../docassets/images/ExperimentalIcon.png) | Shows Process Filter Details. | [Source](../../lib/process-services-cloud/src/lib/process/process-filters/components/edit-process-filter-cloud.component.ts) |
| [Process filters cloud component](process-filters-cloud.component.md) ![Experimental](../docassets/images/ExperimentalIcon.png) | Lists all available process filters and allows to select a filter. | [Source](../../lib/process-services-cloud/src/lib/process/process-filters/components/process-filters-cloud.component.ts) |
| [Process list cloud component](process-list-cloud.component.md) ![Experimental](../docassets/images/ExperimentalIcon.png) | Renders a list containing all the process instances matched by the parameters specified. | [Source](../../lib/process-services-cloud/src/lib/process/process-list/components/process-list-cloud.component.ts) |
| [Start process cloud component](start-process-cloud.component.md) ![Experimental](../docassets/images/ExperimentalIcon.png) | Starts a process. | [Source](../../lib/process-services-cloud/src/lib/process/start-process/components/start-process-cloud.component.ts) |
| [People cloud component](people-cloud.component.md) ![Experimental](../docassets/images/ExperimentalIcon.png) | Allows one or more users to be selected (with auto-suggestion) based on the input parameters. | [Source](../../lib/process-services-cloud/src/lib/task/start-task/components/people-cloud/people-cloud.component.ts) |
| [Start task cloud component](start-task-cloud.component.md) ![Experimental](../docassets/images/ExperimentalIcon.png) | Creates/starts a new task for the specified app. | [Source](../../lib/process-services-cloud/src/lib/task/start-task/components/start-task-cloud.component.ts) |
| [Edit task filter cloud component](edit-task-filter-cloud.component.md) ![Experimental](../docassets/images/ExperimentalIcon.png) | Edits Task Filter Details. | [Source](../../lib/process-services-cloud/src/lib/task/task-filters/components/edit-task-filter-cloud.component.ts) |
| [Task filters cloud component](task-filters-cloud.component.md) ![Experimental](../docassets/images/ExperimentalIcon.png) | Shows all available filters. | [Source](../../lib/process-services-cloud/src/lib/task/task-filters/components/task-filters-cloud.component.ts) |
| [Task header cloud component](task-header-cloud.component.md) ![Experimental](../docassets/images/ExperimentalIcon.png) | Shows all the information related to a task. | [Source](../../lib/process-services-cloud/src/lib/task/task-header/components/task-header-cloud.component.ts) |
| [Task list cloud component](task-list-cloud.component.md) ![Experimental](../docassets/images/ExperimentalIcon.png) | Renders a list containing all the tasks matched by the parameters specified. | [Source](../../lib/process-services-cloud/src/lib/task/task-list/components/task-list-cloud.component.ts) |
## Pipes
| Name | Description | Source link |
| ---- | ----------- | ----------- |
| [Group initial pipe](group-initial.pipe.md) | Extracts the initial character from a group name. | [Source](../../lib/process-services-cloud/src/lib/group/pipe/group-initial.pipe.ts) |
## Services
| Name | Description | Source link |
| ---- | ----------- | ----------- |
| [Apps process cloud service](apps-process-cloud.service.md) ![Experimental](../docassets/images/ExperimentalIcon.png) | Gets details of deployed apps for the current user. | [Source](../../lib/process-services-cloud/src/lib/app/services/apps-process-cloud.service.ts) |
| [Group cloud service](group-cloud.service.md) ![Experimental](../docassets/images/ExperimentalIcon.png) | Searches and gets information for groups. | [Source](../../lib/process-services-cloud/src/lib/group/services/group-cloud.service.ts) |
| [Process filter cloud service](process-filter-cloud.service.md) ![Experimental](../docassets/images/ExperimentalIcon.png) | Manage Process Filters, which are pre-configured Process Instance queries. | [Source](../../lib/process-services-cloud/src/lib/process/process-filters/services/process-filter-cloud.service.ts) |
| [Process list cloud service](process-list-cloud.service.md) ![Experimental](../docassets/images/ExperimentalIcon.png) | Searches processes. | [Source](../../lib/process-services-cloud/src/lib/process/process-list/services/process-list-cloud.service.ts) |
| [Start process cloud service](start-process-cloud.service.md) ![Experimental](../docassets/images/ExperimentalIcon.png) | Gets process definitions and starts processes. | [Source](../../lib/process-services-cloud/src/lib/process/start-process/services/start-process-cloud.service.ts) |
| [Start task cloud service](start-task-cloud.service.md) ![Experimental](../docassets/images/ExperimentalIcon.png) | Starts standalone tasks. | [Source](../../lib/process-services-cloud/src/lib/task/start-task/services/start-task-cloud.service.ts) |
| [Task filter cloud service](task-filter-cloud.service.md) ![Experimental](../docassets/images/ExperimentalIcon.png) | Manages task filters. | [Source](../../lib/process-services-cloud/src/lib/task/task-filters/services/task-filter-cloud.service.ts) |
| [Task header cloud service](task-header-cloud.service.md) ![Experimental](../docassets/images/ExperimentalIcon.png) | Manages cloud tasks. | [Source](../../lib/process-services-cloud/src/lib/task/task-header/services/task-header-cloud.service.ts) |
| [Task list cloud service](task-list-cloud.service.md) ![Experimental](../docassets/images/ExperimentalIcon.png) | Searches tasks. | [Source](../../lib/process-services-cloud/src/lib/task/task-list/services/task-list-cloud.service.ts) |
<!--process-services-cloud end-->

View File

@ -5,7 +5,7 @@ Status: Experimental
Last reviewed: 2019-01-08 Last reviewed: 2019-01-08
--- ---
# [App List Cloud Component](../../lib/process-services-cloud/src/lib/app/components/app-list-cloud.component.ts "Defined in app-list-cloud.component.ts") # [App List Cloud Component](../../../lib/process-services-cloud/src/lib/app/components/app-list-cloud.component.ts "Defined in app-list-cloud.component.ts")
Shows all deployed cloud application instances. Shows all deployed cloud application instances.
@ -17,7 +17,7 @@ Shows all deployed cloud application instances.
</adf-cloud-app-list> </adf-cloud-app-list>
``` ```
### [Transclusions](../user-guide/transclusion.md) ### [Transclusions](../../user-guide/transclusion.md)
You can show custom content when there are no apps available by supplying an You can show custom content when there are no apps available by supplying an
`<adf-custom-empty-content>` section: `<adf-custom-empty-content>` section:
@ -43,4 +43,4 @@ You can show custom content when there are no apps available by supplying an
| Name | Type | Description | | Name | Type | Description |
| ---- | ---- | ----------- | | ---- | ---- | ----------- |
| appClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ApplicationInstanceModel`](../../lib/process-services-cloud/src/lib/app/models/application-instance.model.ts)`>` | Emitted when an app entry is clicked. | | appClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ApplicationInstanceModel`](../../../lib/process-services-cloud/src/lib/app/models/application-instance.model.ts)`>` | Emitted when an app entry is clicked. |

View File

@ -0,0 +1,124 @@
---
Title: Edit Process Filter Cloud component
Added: v3.0.0
Status: Experimental
Last reviewed: 2019-01-30
---
# [Edit Process Filter Cloud component](../../../lib/process-services-cloud/src/lib/process/process-filters/components/edit-process-filter-cloud.component.ts "Defined in edit-process-filter-cloud.component.ts")
Shows Process Filter Details.
![edit-process-filter-cloud](../../docassets/images/edit-process-filter-cloud.component.png)
## Contents
- [Basic Usage](#basic-usage)
- [Class members](#class-members)
- [Properties](#properties)
- [Events](#events)
- [Details](#details)
- [Editing APS2 process filters](#editing-aps2-process-filters)
- [Filter properties](#filter-properties)
- [See also](#see-also)
## Basic Usage
```html
<adf-cloud-edit-process-filter
[id]="processFilterId"
[appName]="appName"
[filterProperties]="filterProperties"s
(filterChange)="onFilterChange($event)"
(action)="onAction($event)">
</adf-cloud-edit-process-filter>
```
## Class members
### Properties
| Name | Type | Default value | Description |
| ---- | ---- | ------------- | ----------- |
| actions | `string[]` | | List of sort actions. |
| appName | `string` | | The name of the application. |
| filterProperties | `string[]` | | List of process filter properties to display |
| id | `string` | | Id of the process instance filter. |
| showFilterActions | `boolean` | true | Toggles editing of process filter actions. |
| showTitle | `boolean` | true | Toggles editing of the process filter title. |
| sortProperties | `string[]` | | List of sort properties to display. |
### Events
| Name | Type | Description |
| ---- | ---- | ----------- |
| action | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ProcessFilterAction`](../../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts)`>` | Emitted when a filter action occurs i.e Save, SaveAs, Delete. |
| filterChange | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ProcessFilterCloudModel`](../../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts)`>` | Emitted when a process instance filter property changes. |
## Details
### Editing APS2 process filters
Use the `appName` and `id` properties to choose which process filter to edit:
```html
<adf-cloud-edit-process-filter
[id]="processFilterId"
[appName]="appName">
</adf-cloud-edit-process-filter>
```
### Filter properties
You can supply various _filter properties_ to edit that will determine
which processes are found by a filter. The full set of properties is
given below:
| Name | Description |
| ---- | ----------- |
| **_appName_** | Name of the app |
| **_processInstanceId_** | Process instance ID |
| **_processName_** | Process name. |
| **_initiator_** | ID of the user who initiated the process |
| **_state_** | Execution state of the process. |
| **_processDefinitionId_** | Process definition ID |
| **_processDefinitionKey_** | Process definition key |
| **_lastModifiedFrom_** | Finds processes modified _after_ this date |
| **_lastModifiedTo_** | Finds processes modified _before_ this date |
| **_sort_** | Field on which the filter results will be sorted (doesn't participate in the filtering itself). Can be "id", "name", "status" or "startDate". |
| **_order_** | Sort ordering of the filter results (this doesn't participate in the filtering itself) |
By default, the **_state_**, **_sort_** and **_order_** properties are
displayed in the editor. However, you can also choose which properties
to show using the `filterProperties` array.
For example, the code below initializes the editor with the **_appName_**,
**_processInstanceId_**, **_startDate_** and **_lastModified_** properties:
```ts
import { UserProcessModel } from '@alfresco/adf-core';
export class SomeComponent implements OnInit {
filterProperties: string[] = [
"appName",
"processInstanceId",
"startDate",
"lastModified"];
onFilterChange(filter: ProcessFilterCloudModel) {
console.log('On filter change: ', filter);
}
onAction($event: ProcessFilterActionType) {
console.log('Clicked action: ', $event);
}
```
With this configuration, only the four listed properties will be shown.
**Note:** Currently, the `sort` property has a limited set of properties
to choose from: **_id_**, **_name_**, **_status_** and **_startDate_**.
## See also
- [Edit task filter cloud component](edit-task-filter-cloud.component.md)

View File

@ -5,11 +5,22 @@ Status: Experimental
Last reviewed: 2019-01-30 Last reviewed: 2019-01-30
--- ---
# [Edit Task Filter Cloud component](../../lib/process-services-cloud/src/lib/task/task-filters/components/edit-task-filter-cloud.component.ts "Defined in edit-task-filter-cloud.component.ts") # [Edit Task Filter Cloud component](../../../lib/process-services-cloud/src/lib/task/task-filters/components/edit-task-filter-cloud.component.ts "Defined in edit-task-filter-cloud.component.ts")
Edits Task Filter Details. Edits Task Filter Details.
![edit-task-filter-cloud](../docassets/images/edit-task-filter-cloud.component.png) ![edit-task-filter-cloud](../../docassets/images/edit-task-filter-cloud.component.png)
## Contents
- [Basic Usage](#basic-usage)
- [Class members](#class-members)
- [Properties](#properties)
- [Events](#events)
- [Details](#details)
- [Editing APS2 task filters](#editing-aps2-task-filters)
- [Filter properties](#filter-properties)
- [See also](#see-also)
## Basic Usage ## Basic Usage
@ -30,17 +41,17 @@ Edits Task Filter Details.
| Name | Type | Default value | Description | | Name | Type | Default value | Description |
| ---- | ---- | ------------- | ----------- | | ---- | ---- | ------------- | ----------- |
| appName | `string` | | (required) Name of the app. | | appName | `string` | | (required) Name of the app. |
| id | `string` | "" | (required) The id of the Task filter. | | filterProperties | `string[]` | | List of task filter properties to display. |
| filterProperties | `string []` | `['state', 'assignment', 'sort', 'order']` | List of task filter properties to display. | | id | `string` | | (required) ID of the task filter. |
| showFilterActions | `boolean` | `true` | Toggles edit task filter actions. | | showFilterActions | `boolean` | true | Toggles the filter actions. |
| showTitle | `boolean` | `true` | Toggles edit task filter title. | | showTitle | `boolean` | true | Toggles the title. |
### Events ### Events
| Name | Type | Description | | Name | Type | Description |
| ---- | ---- | ----------- | | ---- | ---- | ----------- |
| action | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FilterActionType`](../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts)`>` | Emitted when a filter action occurs (i.e Save, Save As, Delete). | | action | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FilterActionType`](../../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts)`>` | Emitted when a filter action occurs (i.e Save, Save As, Delete). |
| filterChange | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`TaskFilterCloudModel`](../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts)`>` | Emitted when a task filter property changes. | | filterChange | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`TaskFilterCloudModel`](../../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts)`>` | Emitted when a task filter property changes. |
## Details ## Details
@ -57,12 +68,12 @@ Use the `appName` and `id` properties to choose which task filter to edit:
### Filter properties ### Filter properties
You can supply various *filter properties* to edit that will determine You can supply various _filter properties_ to edit that will determine
which tasks are found by a filter. The full set of properties is which tasks are found by a filter. The full set of properties is
given below: given below:
| Name | Description | | Name | Description |
| -- | -- | | ---- | ----------- |
| **_appName_** | Name of the app | | **_appName_** | Name of the app |
| **_state_** | Execution state of the task. | | **_state_** | Execution state of the task. |
| **_assignment_** | User the task is assigned to | | **_assignment_** | User the task is assigned to |
@ -74,8 +85,8 @@ given below:
| **_processDefinitionId_** | Process definition ID | | **_processDefinitionId_** | Process definition ID |
| **_processDefinitionKey_** | Process definition key | | **_processDefinitionKey_** | Process definition key |
| **_processInstanceId_** | Process instance ID | | **_processInstanceId_** | Process instance ID |
| **_lastModifiedFrom_** | Finds tasks modified *after* this date | | **_lastModifiedFrom_** | Finds tasks modified _after_ this date |
| **_lastModifiedTo_** | Finds tasks modified *before* this date | | **_lastModifiedTo_** | Finds tasks modified _before_ this date |
| **_sort_** | Field on which the filter results will be sorted (doesn't participate in the filtering itself). Can be "id", "name", "createdDate", "priority", "processDefinitionId". | | **_sort_** | Field on which the filter results will be sorted (doesn't participate in the filtering itself). Can be "id", "name", "createdDate", "priority", "processDefinitionId". |
| **_order_** | Sort ordering of the filter results it can be ASC or DESC (doesn't participate in the filtering itself). | | **_order_** | Sort ordering of the filter results it can be ASC or DESC (doesn't participate in the filtering itself). |
@ -112,4 +123,4 @@ to choose from: **_id_**, **_name_**, **_status_** and **_startDate_**.
## See also ## See also
- [Edit process filter cloud component](edit-process-filter-cloud.component.md) - [Edit process filter cloud component](edit-process-filter-cloud.component.md)

View File

@ -5,7 +5,7 @@ Status: Experimental
Last reviewed: 2019-01-15 Last reviewed: 2019-01-15
--- ---
# [Group Cloud component](../../lib/process-services-cloud/src/lib/group/components/group-cloud.component.ts "Defined in group-cloud.component.ts") # [Group Cloud component](../../../lib/process-services-cloud/src/lib/group/components/group-cloud.component.ts "Defined in group-cloud.component.ts")
Searches Groups. Searches Groups.
@ -18,7 +18,7 @@ Searches Groups.
</adf-cloud-group> </adf-cloud-group>
``` ```
![adf-cloud-group](../docassets/images/group-cloud.component.png) ![adf-cloud-group](../../docassets/images/group-cloud.component.png)
## Class members ## Class members
@ -28,16 +28,16 @@ Searches Groups.
| ---- | ---- | ------------- | ----------- | | ---- | ---- | ------------- | ----------- |
| appName | `string` | | Name of the application. If specified this shows the users who have access to the app. | | appName | `string` | | Name of the application. If specified this shows the users who have access to the app. |
| mode | `string` | | User selection mode (single/multiple). | | mode | `string` | | User selection mode (single/multiple). |
| preSelectGroups | [`GroupModel`](../../lib/process-services-cloud/src/lib/group/models/group.model.ts)`[]` | \[] | Array of users to be pre-selected. This pre-selects all users in multi selection mode and only the first user of the array in single selection mode. | | preSelectGroups | [`GroupModel`](../../../lib/process-services-cloud/src/lib/group/models/group.model.ts)`[]` | \[] | Array of users to be pre-selected. This pre-selects all users in multi selection mode and only the first user of the array in single selection mode. |
| roles | `string[]` | | Role names of the groups to be listed. | | roles | `string[]` | \[] | Role names of the groups to be listed. |
| title | `string` | | Title of the field | | title | `string` | | Title of the field |
### Events ### Events
| Name | Type | Description | | Name | Type | Description |
| ---- | ---- | ----------- | | ---- | ---- | ----------- |
| removeGroup | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`GroupModel`](../../lib/process-services-cloud/src/lib/group/models/group.model.ts)`>` | Emitted when a group is removed. | | removeGroup | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`GroupModel`](../../../lib/process-services-cloud/src/lib/group/models/group.model.ts)`>` | Emitted when a group is removed. |
| selectGroup | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`GroupModel`](../../lib/process-services-cloud/src/lib/group/models/group.model.ts)`>` | Emitted when a group is selected. | | selectGroup | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`GroupModel`](../../../lib/process-services-cloud/src/lib/group/models/group.model.ts)`>` | Emitted when a group is selected. |
## Details ## Details
@ -52,7 +52,7 @@ is the default):
<adf-cloud-group></adf-cloud-group> <adf-cloud-group></adf-cloud-group>
``` ```
![adf-cloud-group](../docassets/images/group-cloud.component-single.png) ![adf-cloud-group](../../docassets/images/group-cloud.component-single.png)
#### Multiple selection #### Multiple selection
@ -62,7 +62,7 @@ is the default):
</adf-cloud-group> </adf-cloud-group>
``` ```
![adf-cloud-group](../docassets/images/group-cloud.component-multiple-mode.png) ![adf-cloud-group](../../docassets/images/group-cloud.component-multiple-mode.png)
### Pre-selection ### Pre-selection

View File

@ -5,7 +5,7 @@ Status: Experimental
Last reviewed: 2019-01-18 Last reviewed: 2019-01-18
--- ---
# [People Cloud Component](../../lib/process-services-cloud/src/lib/task/start-task/components/people-cloud/people-cloud.component.ts "Defined in people-cloud.component.ts") # [People Cloud Component](../../../lib/process-services-cloud/src/lib/task/start-task/components/people-cloud/people-cloud.component.ts "Defined in people-cloud.component.ts")
Allows one or more users to be selected (with auto-suggestion) based on the input parameters. Allows one or more users to be selected (with auto-suggestion) based on the input parameters.
@ -26,7 +26,7 @@ Allows one or more users to be selected (with auto-suggestion) based on the inpu
| ---- | ---- | ------------- | ----------- | | ---- | ---- | ------------- | ----------- |
| appName | `string` | | Name of the application. If specified, this shows the users who have access to the app. | | appName | `string` | | Name of the application. If specified, this shows the users who have access to the app. |
| mode | `string` | | User selection mode (single/multiple). | | mode | `string` | | User selection mode (single/multiple). |
| preSelectUsers | [`IdentityUserModel`](../../lib/core/userinfo/models/identity-user.model.ts)`[]` | | Array of users to be pre-selected. All users in the array are pre-selected in multi selection mode, but only the first user is pre-selected in single selection mode. Mandatory properties are: id, email, username | | preSelectUsers | [`IdentityUserModel`](../../../lib/core/userinfo/models/identity-user.model.ts)`[]` | | Array of users to be pre-selected. All users in the array are pre-selected in multi selection mode, but only the first user is pre-selected in single selection mode. Mandatory properties are: id, email, username |
| roles | `string[]` | | Role names of the users to be listed. | | roles | `string[]` | | Role names of the users to be listed. |
| validate | `Boolean` | false | This flag enables the validation on the preSelectUsers passed as input. In case the flag is true the components call the identity service to verify the validity of the information passed as input. Otherwise, no check will be done. | | validate | `Boolean` | false | This flag enables the validation on the preSelectUsers passed as input. In case the flag is true the components call the identity service to verify the validity of the information passed as input. Otherwise, no check will be done. |
@ -34,6 +34,6 @@ Allows one or more users to be selected (with auto-suggestion) based on the inpu
| Name | Type | Description | | Name | Type | Description |
| ---- | ---- | ----------- | | ---- | ---- | ----------- |
| removeUser | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`IdentityUserModel`](../../lib/core/userinfo/models/identity-user.model.ts)`>` | Emitted when a selected user is removed in multi selection mode. | | removeUser | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`IdentityUserModel`](../../../lib/core/userinfo/models/identity-user.model.ts)`>` | Emitted when a selected user is removed in multi selection mode. |
| selectUser | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`IdentityUserModel`](../../lib/core/userinfo/models/identity-user.model.ts)`>` | Emitted when a user is selected. | | selectUser | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`IdentityUserModel`](../../../lib/core/userinfo/models/identity-user.model.ts)`>` | Emitted when a user is selected. |
| warning | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when an warning occurs. | | warning | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when an warning occurs. |

View File

@ -5,7 +5,7 @@ Status: Experimental
Last reviewed: 2019-01-08 Last reviewed: 2019-01-08
--- ---
# [Process Filters Cloud Component](../../lib/process-services-cloud/src/lib/process/process-filters/components/process-filters-cloud.component.ts "Defined in process-filters-cloud.component.ts") # [Process Filters Cloud Component](../../../lib/process-services-cloud/src/lib/process/process-filters/components/process-filters-cloud.component.ts "Defined in process-filters-cloud.component.ts")
Lists all available process filters and allows to select a filter. Lists all available process filters and allows to select a filter.
@ -25,7 +25,7 @@ Lists all available process filters and allows to select a filter.
| Name | Type | Default value | Description | | Name | Type | Default value | Description |
| ---- | ---- | ------------- | ----------- | | ---- | ---- | ------------- | ----------- |
| appName | `string` | | (required) The application name | | appName | `string` | | (required) The application name |
| filterParam | [`FilterParamsModel`](../../lib/process-services/task-list/models/filter.model.ts) | | (optional) The filter to be selected by default | | filterParam | [`FilterParamsModel`](../../../lib/process-services/task-list/models/filter.model.ts) | | (optional) The filter to be selected by default |
| showIcons | `boolean` | false | (optional) Toggles showing an icon by the side of each filter | | showIcons | `boolean` | false | (optional) Toggles showing an icon by the side of each filter |
### Events ### Events
@ -33,5 +33,5 @@ Lists all available process filters and allows to select a filter.
| Name | Type | Description | | Name | Type | Description |
| ---- | ---- | ----------- | | ---- | ---- | ----------- |
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when any error occurs while loading the filters | | error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when any error occurs while loading the filters |
| filterClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ProcessFilterCloudModel`](../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts)`>` | Emitted when a filter is selected/clicked | | filterClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ProcessFilterCloudModel`](../../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts)`>` | Emitted when a filter is selected/clicked |
| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when filters are loaded successfully | | success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when filters are loaded successfully |

View File

@ -5,11 +5,11 @@ Status: Experimental
Last reviewed: 2019-03-08 Last reviewed: 2019-03-08
--- ---
# [Process Header Cloud Component](../../lib/process-services-cloud/src/lib/process/process-header/components/process-header-cloud.component.ts "Defined in process-header-cloud.component.ts") # [Process Header Cloud Component](../../../lib/process-services-cloud/src/lib/process/process-header/components/process-header-cloud.component.ts "Defined in process-header-cloud.component.ts")
Shows all the information related to a process instance. Shows all the information related to a process instance.
![adf-cloud-process-header](../docassets/images/adf-cloud-process-header.png) ![adf-cloud-process-header](../../docassets/images/adf-cloud-process-header.png)
## Basic Usage ## Basic Usage
@ -32,7 +32,7 @@ Shows all the information related to a process instance.
## Details ## Details
The component populates an internal array of The component populates an internal array of
[CardViewModel](../core/card-view.component.md) with the information that we want to display. [`CardViewModel`](../../core/components/card-view.component.md) with the information that we want to display.
By default all properties are displayed: By default all properties are displayed:

View File

@ -5,7 +5,7 @@ Status: Experimental
Last reviewed: 2018-11-09 Last reviewed: 2018-11-09
--- ---
# [Process Instance List Cloud component](../../lib/process-services-cloud/src/lib/process/process-list/components/process-list-cloud.component.ts "Defined in process-list-cloud.component.ts") # [Process Instance List Cloud component](../../../lib/process-services-cloud/src/lib/process/process-list/components/process-list-cloud.component.ts "Defined in process-list-cloud.component.ts")
Renders a list containing all the process instances matched by the parameters specified. Renders a list containing all the process instances matched by the parameters specified.
@ -31,7 +31,7 @@ Renders a list containing all the process instances matched by the parameters sp
</adf-cloud-process-list> </adf-cloud-process-list>
``` ```
### [Transclusions](../user-guide/transclusion.md) ### [Transclusions](../../user-guide/transclusion.md)
Any content inside an `<adf-custom-empty-content>` sub-component will be shown Any content inside an `<adf-custom-empty-content>` sub-component will be shown
when the process list is empty: when the process list is empty:
@ -50,17 +50,18 @@ when the process list is empty:
| Name | Type | Default value | Description | | Name | Type | Default value | Description |
| ---- | ---- | ------------- | ----------- | | ---- | ---- | ------------- | ----------- |
| appVersion | `string` | "" | The related application version. |
| appName | `string` | "" | The name of the application. | | appName | `string` | "" | The name of the application. |
| appVersion | `string` | "" | The related application version. |
| businessKey | `string` | "" | Filter the tasks to display only the ones with this businessKey value. | | businessKey | `string` | "" | Filter the tasks to display only the ones with this businessKey value. |
| id | `string` | "" | Filter the processes to display only the ones with this ID. | | id | `string` | "" | Filter the processes to display only the ones with this ID. |
| initiator | `string` | "" | Name of the initiator of the process. | | initiator | `string` | "" | Name of the initiator of the process. |
| multiselect | `boolean` | false | Toggles multiple row selection and renders checkboxes at the beginning of each row | | multiselect | `boolean` | false | Toggles multiple row selection and renders checkboxes at the beginning of each row |
| name | `string` | "" | Filter the processes to display only the ones with this name. | | name | `string` | "" | Filter the processes to display only the ones with this name. |
| presetColumn | `string` | | Custom preset column schema in JSON format. |
| processDefinitionId | `string` | "" | Filter the processes to display only the ones with this process definition ID. | | processDefinitionId | `string` | "" | Filter the processes to display only the ones with this process definition ID. |
| processDefinitionKey | `string` | "" | Filter the processes to display only the ones with this process definition key. | | processDefinitionKey | `string` | "" | Filter the processes to display only the ones with this process definition key. |
| 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. | | 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. |
| sorting | [`ProcessListCloudSortingModel`](../../lib/process-services-cloud/src/lib/process/process-list/models/process-list-sorting.model.ts)`[]` | | Array of objects specifying the sort order and direction for the list. The sort parameters are for BE sorting. | | sorting | [`ProcessListCloudSortingModel`](../../../lib/process-services-cloud/src/lib/process/process-list/models/process-list-sorting.model.ts)`[]` | | Array of objects specifying the sort order and direction for the list. The sort parameters are for BE sorting. |
| status | `string` | "" | Filter the processes to display only the ones with this status. | | status | `string` | "" | Filter the processes to display only the ones with this status. |
### Events ### Events
@ -105,7 +106,7 @@ You can define a custom schema for the list in the `app.config.json` file and ac
``` ```
You can also define the schema in the HTML using the You can also define the schema in the HTML using the
[Data column component](../core/data-column.component.md). You can combine this with schema [Data column component](../../core/components/data-column.component.md). You can combine this with schema
information defined in `app.config.json` as in the example below: information defined in `app.config.json` as in the example below:
```json ```json
@ -185,6 +186,6 @@ The Process Instance List also supports pagination:
## See also ## See also
- [Data column component](../core/data-column.component.md) - [Data column component](../../core/components/data-column.component.md)
- [Data Table Adapter interface](../core/datatable-adapter.interface.md) - [Data Table Adapter interface](../../core/interfaces/datatable-adapter.interface.md)
- [Pagination component](../core/pagination.component.md) - [Pagination component](../../core/components/pagination.component.md)

View File

@ -5,11 +5,11 @@ Status: Experimental
Last reviewed: 2019-01-08 Last reviewed: 2019-01-08
--- ---
# [Start Process Cloud Component](../../lib/process-services-cloud/src/lib/process/start-process/components/start-process-cloud.component.ts "Defined in start-process-cloud.component.ts") # [Start Process Cloud Component](../../../lib/process-services-cloud/src/lib/process/start-process/components/start-process-cloud.component.ts "Defined in start-process-cloud.component.ts")
Starts a process. Starts a process.
![adf-start-process](../docassets/images/startProcess.png) ![adf-start-process](../../docassets/images/startProcess.png)
## Basic Usage ## Basic Usage
@ -30,15 +30,15 @@ Starts a process.
| name | `string` | "" | Name of the process. | | name | `string` | "" | Name of the process. |
| processDefinitionName | `string` | | Name of the process definition. | | processDefinitionName | `string` | | Name of the process definition. |
| showSelectProcessDropdown | `boolean` | true | Show/hide the process dropdown list. | | showSelectProcessDropdown | `boolean` | true | Show/hide the process dropdown list. |
| variables | `Map<string, any>[]` | | Variables to attach to the payload. | | variables | `Map<string, object>[]` | | Variables to attach to the payload. |
### Events ### Events
| Name | Type | Description | | Name | Type | Description |
| ---- | ---- | ----------- | | ---- | ---- | ----------- |
| cancel | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ProcessInstanceCloud`](../../lib/process-services-cloud/src/lib/process/start-process/models/process-instance-cloud.model.ts)`>` | Emitted when the starting process is cancelled | | cancel | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ProcessInstanceCloud`](../../../lib/process-services-cloud/src/lib/process/start-process/models/process-instance-cloud.model.ts)`>` | Emitted when the starting process is cancelled |
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ProcessInstanceCloud`](../../lib/process-services-cloud/src/lib/process/start-process/models/process-instance-cloud.model.ts)`>` | Emitted when an error occurs. | | error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ProcessInstanceCloud`](../../../lib/process-services-cloud/src/lib/process/start-process/models/process-instance-cloud.model.ts)`>` | Emitted when an error occurs. |
| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ProcessInstanceCloud`](../../lib/process-services-cloud/src/lib/process/start-process/models/process-instance-cloud.model.ts)`>` | Emitted when the process is successfully started. | | success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ProcessInstanceCloud`](../../../lib/process-services-cloud/src/lib/process/start-process/models/process-instance-cloud.model.ts)`>` | Emitted when the process is successfully started. |
## Details ## Details

View File

@ -5,11 +5,11 @@ Status: Experimental
Last reviewed: 2019-01-08 Last reviewed: 2019-01-08
--- ---
# [Start Task Cloud Component](../../lib/process-services-cloud/src/lib/task/start-task/components/start-task-cloud.component.ts "Defined in start-task-cloud.component.ts") # [Start Task Cloud Component](../../../lib/process-services-cloud/src/lib/task/start-task/components/start-task-cloud.component.ts "Defined in start-task-cloud.component.ts")
Creates/starts a new task for the specified app. Creates/starts a new task for the specified app.
![adf-cloud-start-task](../docassets/images/adf-cloud-start-task.png) ![adf-cloud-start-task](../../docassets/images/adf-cloud-start-task.png)
## Basic Usage ## Basic Usage

View File

@ -5,7 +5,7 @@ Status: Experimental
Last reviewed: 2019-01-08 Last reviewed: 2019-01-08
--- ---
# [Task Filters Cloud component](../../lib/process-services-cloud/src/lib/task/task-filters/components/task-filters-cloud.component.ts "Defined in task-filters-cloud.component.ts") # [Task Filters Cloud component](../../../lib/process-services-cloud/src/lib/task/task-filters/components/task-filters-cloud.component.ts "Defined in task-filters-cloud.component.ts")
Shows all available filters. Shows all available filters.
@ -22,7 +22,7 @@ Shows all available filters.
| Name | Type | Default value | Description | | Name | Type | Default value | Description |
| ---- | ---- | ------------- | ----------- | | ---- | ---- | ------------- | ----------- |
| 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. |
| filterParam | [`FilterParamsModel`](../../lib/process-services/task-list/models/filter.model.ts) | | Parameters to use for the task filter cloud. If there is no match then the default filter (the first one in the list) is selected. | | filterParam | [`FilterParamsModel`](../../../lib/process-services/task-list/models/filter.model.ts) | | Parameters to use for the task filter cloud. If there is no match then the default filter (the first one in the list) is selected. |
| showIcons | `boolean` | false | Toggles display of the filter's icons. | | showIcons | `boolean` | false | Toggles display of the filter's icons. |
### Events ### Events
@ -30,7 +30,7 @@ Shows all available filters.
| Name | Type | Description | | Name | Type | Description |
| ---- | ---- | ----------- | | ---- | ---- | ----------- |
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when an error occurs during loading. | | error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when an error occurs during loading. |
| filterClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`TaskFilterCloudModel`](../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts)`>` | Emitted when a filter in the list is clicked. | | filterClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`TaskFilterCloudModel`](../../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts)`>` | Emitted when a filter in the list is clicked. |
| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when the list is loaded. | | success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when the list is loaded. |
## Details ## Details
@ -45,7 +45,7 @@ Use the `filterParam` property to restrict the range of filters that are shown:
</adf-cloud-task-filters> </adf-cloud-task-filters>
``` ```
You can use properties from [`FilterParamsModel`](../../lib/process-services/task-list/models/filter.model.ts) You can use properties from [`FilterParamsModel`](../../../lib/process-services/task-list/models/filter.model.ts)
as the value of `filterParam` as shown in the table below: as the value of `filterParam` as shown in the table below:
| Name | Type | Description | | Name | Type | Description |

View File

@ -5,11 +5,11 @@ Status: Experimental
Last reviewed: 2019-01-18 Last reviewed: 2019-01-18
--- ---
# [Task Header Cloud Component](../../lib/process-services-cloud/src/lib/task/task-header/components/task-header-cloud.component.ts "Defined in task-header-cloud.component.ts") # [Task Header Cloud Component](../../../lib/process-services-cloud/src/lib/task/task-header/components/task-header-cloud.component.ts "Defined in task-header-cloud.component.ts")
Shows all the information related to a task. Shows all the information related to a task.
![adf-task-header](../docassets/images/adf-task-header.png) ![adf-task-header](../../docassets/images/adf-task-header.png)
## Basic Usage ## Basic Usage
@ -40,7 +40,7 @@ Shows all the information related to a task.
## Details ## Details
The component populates an internal array of The component populates an internal array of
[CardViewModel](../core/card-view.component.md) with the information that we want to display. [CardViewModel](../../core/components/card-view.component.md) with the information that we want to display.
By default all properties are displayed: By default all properties are displayed:

View File

@ -5,7 +5,7 @@ Status: Experimental
Last reviewed: 2019-01-08 Last reviewed: 2019-01-08
--- ---
# [Task List Cloud component](../../lib/process-services-cloud/src/lib/task/task-list/components/task-list-cloud.component.ts "Defined in task-list-cloud.component.ts") # [Task List Cloud component](../../../lib/process-services-cloud/src/lib/task/task-list/components/task-list-cloud.component.ts "Defined in task-list-cloud.component.ts")
Renders a list containing all the tasks matched by the parameters specified. Renders a list containing all the tasks matched by the parameters specified.
@ -32,7 +32,7 @@ Renders a list containing all the tasks matched by the parameters specified.
</adf-cloud-task-list> </adf-cloud-task-list>
``` ```
### [Transclusions](../user-guide/transclusion.md) ### [Transclusions](../../user-guide/transclusion.md)
Any content inside an `<adf-custom-empty-content>` sub-component will be shown Any content inside an `<adf-custom-empty-content>` sub-component will be shown
when the task list is empty: when the task list is empty:
@ -55,20 +55,21 @@ when the task list is empty:
| assignee | `string` | "" | The assignee 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). | | assignee | `string` | "" | The assignee 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). |
| createdDate | `string` | "" | Filter the tasks. Display only tasks created on the supplied date. | | createdDate | `string` | "" | Filter the tasks. Display only tasks created on the supplied date. |
| dueDate | `string` | "" | Filter the tasks. Display only tasks with dueDate equal to the supplied date. | | dueDate | `string` | "" | Filter the tasks. Display only tasks with dueDate equal to the supplied date. |
| id | `string` | "" | Filter the tasks. Display only tasks with id equal to the supplied value. |
| lastModifiedFrom | `string` | "" | Filter the tasks. Display only tasks with lastModifiedFrom equal to the supplied date. | | lastModifiedFrom | `string` | "" | Filter the tasks. Display only tasks with lastModifiedFrom equal to the supplied date. |
| lastModifiedTo | `string` | "" | Filter the tasks. Display only tasks with lastModifiedTo equal to the supplied date. | | lastModifiedTo | `string` | "" | Filter the tasks. Display only tasks with lastModifiedTo equal to the supplied date. |
| id | `string` | "" | Filter the tasks. Display only tasks with id equal to the supplied value. |
| multiselect | `boolean` | false | Toggles multiple row selection, rendering a checkbox at the beginning of each row. | | multiselect | `boolean` | false | Toggles multiple row selection, rendering a checkbox at the beginning of each row. |
| name | `string` | "" | Filter the tasks. Display only tasks with the supplied name. | | name | `string` | "" | Filter the tasks. Display only tasks with the supplied name. |
| owner | `string` | "" | Filter the tasks. Display only tasks with owner equal to the supplied value. |
| parentTaskId | `string` | "" | Filter the tasks. Display only tasks with parentTaskId equal to the supplied value. | | parentTaskId | `string` | "" | Filter the tasks. Display only tasks with parentTaskId equal to the supplied value. |
| presetColumn | `string` | | Custom preset column schema in JSON format. |
| priority | `number` | | Filter the tasks. Display only tasks with priority equal to the supplied value. |
| processDefinitionId | `string` | "" | Filter the tasks. Display only tasks with processDefinitionId equal to the supplied value. | | processDefinitionId | `string` | "" | Filter the tasks. Display only tasks with processDefinitionId equal to the supplied value. |
| processInstanceId | `string` | "" | Filter the tasks. Display only tasks with processInstanceId equal to the supplied value. | | processInstanceId | `string` | "" | Filter the tasks. Display only tasks with processInstanceId equal to the supplied value. |
| selectionMode | `string` | "single" | Row selection mode. Can be none, `single` or `multiple`. For `multiple` mode, you can use the Cmd (macOS) or Ctrl (Win) modifier key to toggle selection for multiple rows. | | selectionMode | `string` | "single" | Row selection mode. Can be none, `single` or `multiple`. For `multiple` mode, you can use the Cmd (macOS) or Ctrl (Win) modifier key to toggle selection for multiple rows. |
| sorting | [`TaskListCloudSortingModel`](../../lib/process-services-cloud/src/lib/task/task-list/models/task-list-sorting.model.ts)`[]` | | Specifies how the table should be sorted. The parameters are for BE sorting. | | sorting | [`TaskListCloudSortingModel`](../../../lib/process-services-cloud/src/lib/task/task-list/models/task-list-sorting.model.ts)`[]` | | Specifies how the table should be sorted. The parameters are for BE sorting. |
| standAlone | `boolean` | false | Filter the tasks. Display only the tasks that belong to a process in case is false or tasks that doesn't belong to a process in case of true. |
| status | `string` | "" | Filter the tasks. Display only tasks with status equal to the supplied value. | | status | `string` | "" | Filter the tasks. Display only tasks with status equal to the supplied value. |
| owner | `string` | "" | Filter the tasks. Display only tasks with owner equal to the supplied value. |
| priority | `string` | "" | Filter the tasks. Display only tasks with priority equal to the supplied value. |
| standAlone | `string` | "" | Filter the tasks. Display only the tasks that belong to a process in case is false or tasks that doesn't belong to a process in case of true. |
### Events ### Events
@ -196,8 +197,8 @@ The Tasklist also supports pagination as shown in the example below:
### DataTableAdapter example ### DataTableAdapter example
See the [`DataTableAdapter`](../../lib/core/datatable/data/datatable-adapter.ts) 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`](../../lib/core/datatable/data/object-datatable-adapter.ts). 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
@ -211,10 +212,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`](../../lib/core/datatable/data/data-column.model.ts) 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/components/data-column.component.md)
- [`DataTableAdapter`](../../lib/core/datatable/data/datatable-adapter.ts) - [`DataTableAdapter`](../../../lib/core/datatable/data/datatable-adapter.ts)
- [Pagination component](../core/pagination.component.md) - [Pagination component](../../core/components/pagination.component.md)

View File

@ -1,203 +0,0 @@
---
Title: Edit Process Filter Cloud component
Added: v3.0.0
Status: Experimental
Last reviewed: 2019-01-30
---
# [Edit Process Filter Cloud component](../../lib/process-services-cloud/src/lib/process/process-filters/components/edit-process-filter-cloud.component.ts "Defined in edit-process-filter-cloud.component.ts")
Shows Process Filter Details.
![edit-process-filter-cloud](../docassets/images/edit-process-filter-cloud.component.png)
## Contents
- [Basic Usage](#basic-usage)
- [Class members](#class-members)
- [Properties](#properties)
- [Events](#events)
- [Details](#details)
- [Editing APS2 process filters](#editing-aps2-process-filters)
- [Filter properties](#filter-properties)
- [Sort properties](#sort-properties)
- [Action properties](#action-properties)
- [See also](#see-also)
## Basic Usage
```html
<adf-cloud-edit-process-filter
[id]="processFilterId"
[appName]="appName"
[filterProperties]="filterProperties"s
(filterChange)="onFilterChange($event)"
(action)="onAction($event)">
</adf-cloud-edit-process-filter>
```
## Class members
### Properties
| Name | Type | Default value | Description |
| ---- | ---- | ------------- | ----------- |
| actions | `string[]` | | List of sort actions. |
| appName | `string` | | The name of the application. |
| filterProperties | `string[]` | | List of process filter properties to display |
| id | `string` | | Id of the process instance filter. |
| showFilterActions | `boolean` | true | Toggles editing of process filter actions. |
| showTitle | `boolean` | true | Toggles editing of the process filter title. |
| sortProperties | `string[]` | | List of sort properties to display. |
### Events
| Name | Type | Description |
| ---- | ---- | ----------- |
| action | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ProcessFilterAction`](../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts)`>` | Emitted when a filter action occurs i.e Save, SaveAs, Delete. |
| filterChange | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ProcessFilterCloudModel`](../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts)`>` | Emitted when a process instance filter property changes. |
## Details
### Editing APS2 process filters
Use the `appName` and `id` properties to choose which process filter to edit:
```html
<adf-cloud-edit-process-filter
[id]="processFilterId"
[appName]="appName">
</adf-cloud-edit-process-filter>
```
### Filter properties
You can supply various _filter properties_ to edit that will determine
which processes are found by a filter. The full set of properties is
given below:
| Name | Description |
| ---- | ----------- |
| **_appName_** | Name of the app |
| **_processInstanceId_** | Process instance ID |
| **_processName_** | Process name. |
| **_initiator_** | ID of the user who initiated the process |
| **_status_** | Execution status of the process. |
| **_processDefinitionId_** | Process definition ID |
| **_processDefinitionKey_** | Process definition key |
| **_lastModified_** | Date the process was last modified. If lastModified defined the component will show the range **_lastModifiedTo_**, **_lastModifiedFrom_**|
| **_startDate_** | Date the process was started |
| **_sort_** | Field on which the filter results will be sorted (doesn't participate in the filtering itself). Can be "id", "name", "status" or "startDate". |
| **_order_** | Sort ordering of the filter results (this doesn't participate in the filtering itself) |
By default, the **_status_**, **_sort_** and **_order_** properties are
displayed in the editor. However, you can also choose which properties
to show using the `filterProperties` array.
For example, the code below initializes the editor with the **_appName_**,
**_processInstanceId_**, **_startDate_** and **_lastModified_** properties:
```ts
export class SomeComponent implements OnInit {
filterProperties: string[] = [
"appName",
"processInstanceId",
"startDate",
"lastModified"];
onFilterChange(filter: ProcessFilterCloudModel) {
console.log('On filter change: ', filter);
}
onAction($event: ProcessFilterAction) {
console.log('Clicked action: ', $event);
}
```
```html
<adf-cloud-edit-process-filter
[id]="processFilterId"
[appName]="applicationName"
[filterProperties]="filterProperties">
</adf-cloud-edit-process-filter>
```
With this configuration, only the four listed properties will be shown.
### Sort properties
You can supply various _sort properties_ to sort the processes.
By default, the **_id_**, **_name_**, **_status_** and **_startDate_** properties are
displayed in the editor. However, you can also choose which sort properties
to show using the `sortProperties` array.
For example, the code below initializes the editor with the **_startDate_** and **_lastModified_** properties:
```ts
export class SomeComponent implements OnInit {
sortProperties: string[] = [
"startDate",
"lastModified"];
onFilterChange(filter: ProcessFilterCloudModel) {
console.log('On filter change: ', filter);
}
onAction($event: ProcessFilterAction) {
console.log('Clicked action: ', $event);
}
```
```html
<adf-cloud-edit-process-filter
[id]="processFilterId"
[appName]="applicationName"
[sortProperties]="sortProperties">
</adf-cloud-edit-process-filter>
```
With this configuration, only the two listed sort properties will be shown.
### Action properties
You can supply various _actions_ to apply on process filter.
| Name | Description |
| ---- | ----------- |
| **_save_** | Save process filter. |
| **_saveAs_** | Creates a new process filter. |
| **_delete_** | Delete process filter. |
By default, the **_save_**, **_saveAs_** and **_delete_** actions are
displayed in the editor. However, you can also choose which actions to
show using the `actions` array.
For example, the code below initializes the editor with the **_save_** and **_delete_** actions:
```ts
export class SomeComponent implements OnInit {
actions: string[] = ['save', 'delete'];
onFilterChange(filter: ProcessFilterCloudModel) {
console.log('On filter change: ', filter);
}
onAction($event: ProcessFilterAction) {
console.log('Clicked action: ', $event);
}
```
```html
<adf-cloud-edit-process-filter
[id]="processFilterId"
[appName]="applicationName"
[actions]="actions">
</adf-cloud-edit-process-filter>
```
With this configuration, only the two actions will be shown.
## See also
- [Edit task filter cloud component](edit-task-filter-cloud.component.md)

View File

@ -5,7 +5,7 @@ Status: Active
Last reviewed: 2019-01-17 Last reviewed: 2019-01-17
--- ---
# [Group initial pipe](../../lib/process-services-cloud/src/lib/group/pipe/group-initial.pipe.ts "Defined in group-initial.pipe.ts") # [Group initial pipe](../../../lib/process-services-cloud/src/lib/group/pipe/group-initial.pipe.ts "Defined in group-initial.pipe.ts")
Extracts the initial character from a group name. Extracts the initial character from a group name.
@ -23,11 +23,11 @@ Extracts the initial character from a group name.
## Details ## Details
This pipe takes a [`GroupModel`](../../lib/process-services-cloud/src/lib/group/models/group.model.ts) This pipe takes a [`GroupModel`](../../../lib/process-services-cloud/src/lib/group/models/group.model.ts)
object as its parameter and extracts the initial character from the `name` object as its parameter and extracts the initial character from the `name`
property. The initial is a handy way to identify the group in lists and property. The initial is a handy way to identify the group in lists and
other situations where there is limited screen space available. other situations where there is limited screen space available.
## See also ## See also
- [Group cloud component](../process-services-cloud/group-cloud.component.md) - [Group cloud component](../components/group-cloud.component.md)

View File

@ -1,58 +0,0 @@
---
Title: Process Filter Cloud Service
Added: v3.0.0
Status: Experimental
Last reviewed: 2019-01-09
---
# [Process Filter Cloud Service](../../lib/process-services-cloud/src/lib/process/process-filters/services/process-filter-cloud.service.ts "Defined in process-filter-cloud.service.ts")
Manage Process Filters, which are pre-configured Process Instance queries.
## Class members
### Methods
- **addFilter**(filter: [`ProcessFilterCloudModel`](../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts))<br/>
Adds a new process instance filter
- _filter:_ [`ProcessFilterCloudModel`](../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts) - The new filter to add
- **deleteFilter**(filter: [`ProcessFilterCloudModel`](../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts))<br/>
Delete process instance filter
- _filter:_ [`ProcessFilterCloudModel`](../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts) - The new filter to delete
- **getAllProcessesFilter**(appName: `string`): [`ProcessFilterCloudModel`](../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts)<br/>
Creates and returns a filter for "All" Process instances.
- _appName:_ `string` - Name of the target app
- **Returns** [`ProcessFilterCloudModel`](../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts) - The newly created filter
- **getCompletedProcessesFilter**(appName: `string`): [`ProcessFilterCloudModel`](../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts)<br/>
Creates and returns a filter for "Completed" Process instances.
- _appName:_ `string` - Name of the target app
- **Returns** [`ProcessFilterCloudModel`](../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts) - The newly created filter
- **getProcessFilterById**(appName: `string`, id: `string`): [`ProcessFilterCloudModel`](../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts)<br/>
Get process instance filter for given filter id
- _appName:_ `string` - Name of the target app
- _id:_ `string` - Id of the target process instance filter
- **Returns** [`ProcessFilterCloudModel`](../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts) - Details of process filter
- **getProcessFilters**(appName: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessFilterCloudModel`](../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts)`[]>`<br/>
Gets all process instance filters for a process app.
- _appName:_ `string` - Name of the target app
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessFilterCloudModel`](../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts)`[]>` - Observable of process filter details
- **getRunningProcessesFilter**(appName: `string`): [`ProcessFilterCloudModel`](../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts)<br/>
Creates and returns a filter for "Running" Process instances.
- _appName:_ `string` - Name of the target app
- **Returns** [`ProcessFilterCloudModel`](../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts) - The newly created filter
- **updateFilter**(filter: [`ProcessFilterCloudModel`](../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts))<br/>
Update process instance filter
- _filter:_ [`ProcessFilterCloudModel`](../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts) - The new filter to update
## Details
The methods of this service generally return an instance of
[`ProcessFilterCloudModel`](../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts) or an array of instances.
You can use the returned filters to get matching process instances for the process app,
such as 'Running', 'Completed', 'All', etc.
## See also
- [Process filters cloud component](process-filters-cloud.component.md)
- [Task filter cloud service](task-filter-cloud.service.md)

View File

@ -1,31 +0,0 @@
---
Title: Process Header Cloud Service
Added: v3.0.0
Status: Experimental
Last reviewed: 2019-03-08
---
# [Process Header Cloud Service](../../lib/process-services-cloud/src/lib/process/process-header/services/process-header-cloud.service.ts "Defined in process-header-cloud.service.ts")
Manages cloud process instances.
## Class members
### Methods
- **getProcessInstanceById**(appName: `string`, processInstanceId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessInstanceCloud`](../../lib/process-services-cloud/src/lib/process/start-process/models/process-instance-cloud.model.ts)`>`<br/>
Gets details of a process instance.
- _appName:_ `string` - Name of the app
- _processInstanceId:_ `string` - ID of the process instance whose details you want
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessInstanceCloud`](../../lib/process-services-cloud/src/lib/process/start-process/models/process-instance-cloud.model.ts)`>` - Process instance details
## Details
The methods work in much the same way as the equivalent methods in the
[Processlist Cloud Component](./process-list-cloud.component.md)
but they use the cloud variants of the classes for return values. See the
[Processlist Cloud Service](./process-list-cloud.service.md) page for usage examples.
## See also
- [Processlist Cloud Service](./process-list-cloud.service.md)

View File

@ -1,25 +0,0 @@
---
Title: Process List Cloud Service
Added: v3.0.0
Status: Experimental
Last reviewed: 2019-02-06
---
# [Process List Cloud Service](../../lib/process-services-cloud/src/lib/process/process-list/services/process-list-cloud.service.ts "Defined in process-list-cloud.service.ts")
Searches processes.
## Class members
### Methods
- **getProcessByRequest**(requestNode: [`ProcessQueryCloudRequestModel`](../../lib/process-services-cloud/src/lib/process/process-list/models/process-cloud-query-request.model.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
Finds a process using an object with optional query properties.
- _requestNode:_ [`ProcessQueryCloudRequestModel`](../../lib/process-services-cloud/src/lib/process/process-list/models/process-cloud-query-request.model.ts) - Query object
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - Process information
## Details
Note that for a call to `getProcessByRequest`, the
[`ProcessQueryCloudRequestModel`](../../lib/process-services-cloud/src/lib/process/process-list/models/process-cloud-query-request.model.ts) object
must at minimum have the `appName` property correctly set.

View File

@ -5,7 +5,7 @@ Status: Experimental
Last reviewed: 2019-01-09 Last reviewed: 2019-01-09
--- ---
# [Apps Process Cloud Service](../../lib/process-services-cloud/src/lib/app/services/apps-process-cloud.service.ts "Defined in apps-process-cloud.service.ts") # [Apps Process Cloud Service](../../../lib/process-services-cloud/src/lib/app/services/apps-process-cloud.service.ts "Defined in apps-process-cloud.service.ts")
Gets details of deployed apps for the current user. Gets details of deployed apps for the current user.
@ -13,16 +13,16 @@ Gets details of deployed apps for the current user.
### Methods ### Methods
- **getDeployedApplicationsByStatus**(status: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ApplicationInstanceModel`](../../lib/process-services-cloud/src/lib/app/models/application-instance.model.ts)`[]>`<br/> - **getDeployedApplicationsByStatus**(status: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ApplicationInstanceModel`](../../../lib/process-services-cloud/src/lib/app/models/application-instance.model.ts)`[]>`<br/>
Gets a list of deployed apps for this user by status. Gets a list of deployed apps for this user by status.
- _status:_ `string` - Required status value - _status:_ `string` - Required status value
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ApplicationInstanceModel`](../../lib/process-services-cloud/src/lib/app/models/application-instance.model.ts)`[]>` - The list of deployed apps - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ApplicationInstanceModel`](../../../lib/process-services-cloud/src/lib/app/models/application-instance.model.ts)`[]>` - The list of deployed apps
## Details ## Details
This service implements some features of the [Apps process service](../core/apps-process.service.md) This service implements some features of the [Apps process service](../../core/services/apps-process.service.md)
with modifications for cloud use. with modifications for cloud use.
## See also ## See also
- [Apps process service](../core/apps-process.service.md) - [Apps process service](../../core/services/apps-process.service.md)

View File

@ -5,7 +5,7 @@ Status: Experimental
Last reviewed: 2019-02-06 Last reviewed: 2019-02-06
--- ---
# [Group Cloud Service](../../lib/process-services-cloud/src/lib/group/services/group-cloud.service.ts "Defined in group-cloud.service.ts") # [Group Cloud Service](../../../lib/process-services-cloud/src/lib/group/services/group-cloud.service.ts "Defined in group-cloud.service.ts")
Searches and gets information for groups. Searches and gets information for groups.
@ -29,9 +29,9 @@ Searches and gets information for groups.
- _groupId:_ `string` - ID of the target group - _groupId:_ `string` - ID of the target group
- _roleNames:_ `string[]` - Array of role names - _roleNames:_ `string[]` - Array of role names
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<boolean>` - True if the group has one or more of the roles, false otherwise - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<boolean>` - True if the group has one or more of the roles, false otherwise
- **findGroupsByName**(searchParams: [`GroupSearchParam`](../../lib/process-services-cloud/src/lib/group/models/group.model.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/> - **findGroupsByName**(searchParams: [`GroupSearchParam`](../../../lib/process-services-cloud/src/lib/group/models/group.model.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
Finds groups filtered by name. Finds groups filtered by name.
- _searchParams:_ [`GroupSearchParam`](../../lib/process-services-cloud/src/lib/group/models/group.model.ts) - Object containing the name filter string - _searchParams:_ [`GroupSearchParam`](../../../lib/process-services-cloud/src/lib/group/models/group.model.ts) - Object containing the name filter string
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - List of group information - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - List of group information
- **getClientIdByApplicationName**(applicationName: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<string>`<br/> - **getClientIdByApplicationName**(applicationName: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<string>`<br/>
Gets the client ID using the app name. Gets the client ID using the app name.
@ -42,14 +42,14 @@ Searches and gets information for groups.
- _groupId:_ `string` - ID of the target group - _groupId:_ `string` - ID of the target group
- _clientId:_ `string` - ID of the client - _clientId:_ `string` - ID of the client
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any[]>` - List of roles - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any[]>` - List of roles
- **getGroupDetailsById**(groupId: `string`): `any`<br/> - **getGroupRoles**(groupId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`GroupRoleModel`](../../../lib/process-services-cloud/src/lib/group/models/group.model.ts)`[]>`<br/>
Gets details for a specified group. Gets details for a specified group.
- _groupId:_ `string` - ID of the target group - _groupId:_ `string` - ID of the target group
- **Returns** `any` - Group details - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`GroupRoleModel`](../../../lib/process-services-cloud/src/lib/group/models/group.model.ts)`[]>` - Group details
## Details ## Details
See the See the
[Groups API](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/activiti-rest-api/docs/GroupsApi.md) [Groups API](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/activiti-rest-api/docs/GroupsApi.md)
page in the Alfresco JS-API docs for further details about the information about the format page in the Alfresco JS-API docs for further details about the information about the format
of the returned data. of the returned data.

View File

@ -0,0 +1,58 @@
---
Title: Process Filter Cloud Service
Added: v3.0.0
Status: Experimental
Last reviewed: 2019-01-09
---
# [Process Filter Cloud Service](../../../lib/process-services-cloud/src/lib/process/process-filters/services/process-filter-cloud.service.ts "Defined in process-filter-cloud.service.ts")
Manage Process Filters, which are pre-configured Process Instance queries.
## Class members
### Methods
- **addFilter**(filter: [`ProcessFilterCloudModel`](../../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts))<br/>
Adds a new process instance filter
- _filter:_ [`ProcessFilterCloudModel`](../../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts) - The new filter to add
- **deleteFilter**(filter: [`ProcessFilterCloudModel`](../../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts))<br/>
Delete process instance filter
- _filter:_ [`ProcessFilterCloudModel`](../../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts) - The new filter to delete
- **getAllProcessesFilter**(appName: `string`): [`ProcessFilterCloudModel`](../../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts)<br/>
Creates and returns a filter for "All" Process instances.
- _appName:_ `string` - Name of the target app
- **Returns** [`ProcessFilterCloudModel`](../../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts) - The newly created filter
- **getCompletedProcessesFilter**(appName: `string`): [`ProcessFilterCloudModel`](../../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts)<br/>
Creates and returns a filter for "Completed" Process instances.
- _appName:_ `string` - Name of the target app
- **Returns** [`ProcessFilterCloudModel`](../../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts) - The newly created filter
- **getProcessFilterById**(appName: `string`, id: `string`): [`ProcessFilterCloudModel`](../../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts)<br/>
Get process instance filter for given filter id
- _appName:_ `string` - Name of the target app
- _id:_ `string` - Id of the target process instance filter
- **Returns** [`ProcessFilterCloudModel`](../../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts) - Details of process filter
- **getProcessFilters**(appName: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessFilterCloudModel`](../../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts)`[]>`<br/>
Gets all process instance filters for a process app.
- _appName:_ `string` - Name of the target app
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessFilterCloudModel`](../../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts)`[]>` - Observable of process filter details
- **getRunningProcessesFilter**(appName: `string`): [`ProcessFilterCloudModel`](../../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts)<br/>
Creates and returns a filter for "Running" Process instances.
- _appName:_ `string` - Name of the target app
- **Returns** [`ProcessFilterCloudModel`](../../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts) - The newly created filter
- **updateFilter**(filter: [`ProcessFilterCloudModel`](../../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts))<br/>
Update process instance filter
- _filter:_ [`ProcessFilterCloudModel`](../../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts) - The new filter to update
## Details
The methods of this service generally return an instance of
[`ProcessFilterCloudModel`](../../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts) or an array of instances.
You can use the returned filters to get matching process instances for the process app,
such as 'Running', 'Completed', 'All', etc.
## See also
- [Process filters cloud component](../components/process-filters-cloud.component.md)
- [Task filter cloud service](task-filter-cloud.service.md)

View File

@ -0,0 +1,31 @@
---
Title: Process Header Cloud Service
Added: v3.0.0
Status: Experimental
Last reviewed: 2019-03-08
---
# [Process Header Cloud Service](../../../lib/process-services-cloud/src/lib/process/process-header/services/process-header-cloud.service.ts "Defined in process-header-cloud.service.ts")
Manages cloud process instances.
## Class members
### Methods
- **getProcessInstanceById**(appName: `string`, processInstanceId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessInstanceCloud`](../../../lib/process-services-cloud/src/lib/process/start-process/models/process-instance-cloud.model.ts)`>`<br/>
Gets details of a process instance.
- _appName:_ `string` - Name of the app
- _processInstanceId:_ `string` - ID of the process instance whose details you want
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessInstanceCloud`](../../../lib/process-services-cloud/src/lib/process/start-process/models/process-instance-cloud.model.ts)`>` - Process instance details
## Details
The methods work in much the same way as the equivalent methods in the
[Process list Cloud Component](../components/process-list-cloud.component.md)
but they use the cloud variants of the classes for return values. See the
[Process list Cloud Service](process-list-cloud.service.md) page for usage examples.
## See also
- [Process list Cloud Service](process-list-cloud.service.md)

View File

@ -0,0 +1,25 @@
---
Title: Process List Cloud Service
Added: v3.0.0
Status: Experimental
Last reviewed: 2019-02-06
---
# [Process List Cloud Service](../../../lib/process-services-cloud/src/lib/process/process-list/services/process-list-cloud.service.ts "Defined in process-list-cloud.service.ts")
Searches processes.
## Class members
### Methods
- **getProcessByRequest**(requestNode: [`ProcessQueryCloudRequestModel`](../../../lib/process-services-cloud/src/lib/process/process-list/models/process-cloud-query-request.model.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
Finds a process using an object with optional query properties.
- _requestNode:_ [`ProcessQueryCloudRequestModel`](../../../lib/process-services-cloud/src/lib/process/process-list/models/process-cloud-query-request.model.ts) - Query object
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - Process information
## Details
Note that for a call to `getProcessByRequest`, the
[`ProcessQueryCloudRequestModel`](../../../lib/process-services-cloud/src/lib/process/process-list/models/process-cloud-query-request.model.ts) object
must at minimum have the `appName` property correctly set.

View File

@ -0,0 +1,36 @@
---
Title: Start Process Cloud Service
Added: v3.0.0
Status: Experimental
Last reviewed: 2019-01-09
---
# [Start Process Cloud Service](../../../lib/process-services-cloud/src/lib/process/start-process/services/start-process-cloud.service.ts "Defined in start-process-cloud.service.ts")
Gets process definitions and starts processes.
## Class members
### Methods
- **getProcessDefinitions**(appName: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessDefinitionCloud`](../../../lib/process-services-cloud/src/lib/process/start-process/models/process-definition-cloud.model.ts)`[]>`<br/>
Gets the process definitions associated with an app.
- _appName:_ `string` - Name of the target app
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessDefinitionCloud`](../../../lib/process-services-cloud/src/lib/process/start-process/models/process-definition-cloud.model.ts)`[]>` - Array of process definitions
- **startProcess**(appName: `string`, requestPayload: [`ProcessPayloadCloud`](../../../lib/process-services-cloud/src/lib/process/start-process/models/process-payload-cloud.model.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessInstanceCloud`](../../../lib/process-services-cloud/src/lib/process/start-process/models/process-instance-cloud.model.ts)`>`<br/>
Starts a process based on a process definition, name, form values or variables.
- _appName:_ `string` - name of the Application
- _requestPayload:_ [`ProcessPayloadCloud`](../../../lib/process-services-cloud/src/lib/process/start-process/models/process-payload-cloud.model.ts) - Details of the process (definition key, name, variables, etc)
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessInstanceCloud`](../../../lib/process-services-cloud/src/lib/process/start-process/models/process-instance-cloud.model.ts)`>` - Details of the process instance just started
## Details
You can use the `startProcess` method in much the same way as the `startProcess` method in the
[Process service](../../process-services/services/process.service.md) (see the [Process service](../../process-services/services/process.service.md) page
for an example). However, the cloud version
combines the process details and variables conveniently into the
[`ProcessPayloadCloud`](../../../lib/process-services-cloud/src/lib/process/start-process/models/process-payload-cloud.model.ts) object.
## See also
- [Process service](../../process-services/services/process.service.md)

View File

@ -0,0 +1,30 @@
---
Title: Start Task Cloud Service
Added: v3.0.0
Status: Experimental
Last reviewed: 2019-01-09
---
# [Start Task Cloud Service](../../../lib/process-services-cloud/src/lib/task/start-task/services/start-task-cloud.service.ts "Defined in start-task-cloud.service.ts")
Starts standalone tasks.
## Class members
### Methods
- **createNewTask**(taskDetails: [`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts)`>`<br/>
Creates a new standalone task.
- _taskDetails:_ [`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts) - Details of the task to create
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts)`>` - Details of the newly created task
## Details
The `createNewTask` method works the same way as the method with the same name in the
[Tasklist service](../../process-services/services/tasklist.service.md)
but uses the cloud variants of the classes for the parameter and return value. See the
[Tasklist service](../../process-services/services/tasklist.service.md) page for usage examples.
## See also
- [Tasklist service](../../process-services/services/tasklist.service.md)

View File

@ -0,0 +1,66 @@
---
Title: Task Filter Cloud Service
Added: v3.0.0
Status: Experimental
Last reviewed: 2019-01-09
---
# [Task Filter Cloud Service](../../../lib/process-services-cloud/src/lib/task/task-filters/services/task-filter-cloud.service.ts "Defined in task-filter-cloud.service.ts")
Manages task filters.
## Class members
### Methods
- **addFilter**(filter: [`TaskFilterCloudModel`](../../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts))<br/>
Adds a new task filter.
- _filter:_ [`TaskFilterCloudModel`](../../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts) - The new filter to add
- **deleteFilter**(filter: [`TaskFilterCloudModel`](../../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts))<br/>
Deletes a task filter
- _filter:_ [`TaskFilterCloudModel`](../../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts) - The filter to delete
- **getCompletedTasksFilterInstance**(appName: `string`): [`TaskFilterCloudModel`](../../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts)<br/>
Creates and returns a filter for "Completed" task instances.
- _appName:_ `string` - Name of the target app
- **Returns** [`TaskFilterCloudModel`](../../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts) - The newly created filter
- **getMyTasksFilterInstance**(appName: `string`): [`TaskFilterCloudModel`](../../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts)<br/>
Creates and returns a filter for "My Tasks" task instances.
- _appName:_ `string` - Name of the target app
- **Returns** [`TaskFilterCloudModel`](../../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts) - The newly created filter
- **getTaskFilterById**(appName: `string`, id: `string`): [`TaskFilterCloudModel`](../../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts)<br/>
Gets a task filter.
- _appName:_ `string` - Name of the target app
- _id:_ `string` - ID of the task
- **Returns** [`TaskFilterCloudModel`](../../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts) - Details of the task filter
- **getTaskListFilters**(appName?: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskFilterCloudModel`](../../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts)`[]>`<br/>
Gets all task filters for a process app.
- _appName:_ `string` - (Optional) Name of the target app
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskFilterCloudModel`](../../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts)`[]>` - Observable of task filter details
- **getUsername**(): `string`<br/>
Gets the username field from the access token.
- **Returns** `string` - Username string
- **getValueFromToken**(key: `string`)<br/>
Gets a named value from the access token.
- _key:_ `string` - Key name of the value
- **updateFilter**(filter: [`TaskFilterCloudModel`](../../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts))<br/>
Updates a task filter.
- _filter:_ [`TaskFilterCloudModel`](../../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts) - The filter to update
## Details
The methods of this service generally return an instance of [`TaskFilterCloudModel`](../../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts) or
an array of instances. For example, you could use `getTaskListFilters` as follows:
```ts
this.taskFilterService.getTaskListFilters(appName).subscribe( (filters: TaskFilterCloudModel[]) => {
console.log('Task filters: ', filters);
}, error => {
console.log('Error: ', error);
});
```
These filters can now be used to get matching task instances for the process app.
## See also
- [Task filter service](../../process-services/services/task-filter.service.md)

View File

@ -5,7 +5,7 @@ Status: Experimental
Last reviewed: 2019-01-18 Last reviewed: 2019-01-18
--- ---
# [Task Header Cloud Service](../../lib/process-services-cloud/src/lib/task/task-header/services/task-header-cloud.service.ts "Defined in task-header-cloud.service.ts") # [Task Header Cloud Service](../../../lib/process-services-cloud/src/lib/task/task-header/services/task-header-cloud.service.ts "Defined in task-header-cloud.service.ts")
Manages cloud tasks. Manages cloud tasks.
@ -19,11 +19,11 @@ Manages cloud tasks.
- _taskId:_ `string` - ID of the task to claim - _taskId:_ `string` - ID of the task to claim
- _assignee:_ `string` - User to assign the task to - _assignee:_ `string` - User to assign the task to
- **Returns** `any` - Details of the claimed task - **Returns** `any` - Details of the claimed task
- **getTaskById**(appName: `string`, taskId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsCloudModel`](../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts)`>`<br/> - **getTaskById**(appName: `string`, taskId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts)`>`<br/>
Gets details of a task. Gets details of a task.
- _appName:_ `string` - Name of the app - _appName:_ `string` - Name of the app
- _taskId:_ `string` - ID of the task whose details you want - _taskId:_ `string` - ID of the task whose details you want
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsCloudModel`](../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts)`>` - Task details - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts)`>` - Task details
- **unclaimTask**(appName: `string`, taskId: `string`): `any`<br/> - **unclaimTask**(appName: `string`, taskId: `string`): `any`<br/>
Un-claims a task. Un-claims a task.
- _appName:_ `string` - Name of the app - _appName:_ `string` - Name of the app
@ -39,10 +39,10 @@ Manages cloud tasks.
## Details ## Details
The methods work in much the same way as the equivalent methods in the The methods work in much the same way as the equivalent methods in the
[Tasklist service](../process-services/tasklist.service.md) [Tasklist service](../../process-services/services/tasklist.service.md)
but they use the cloud variants of the classes for return values. See the but they use the cloud variants of the classes for return values. See the
[Tasklist service](../process-services/tasklist.service.md) page for usage examples. [Tasklist service](../../process-services/services/tasklist.service.md) page for usage examples.
## See also ## See also
- [Tasklist service](../process-services/tasklist.service.md) - [Tasklist service](../../process-services/services/tasklist.service.md)

View File

@ -0,0 +1,25 @@
---
Title: Task List Cloud Service
Added: v3.0.0
Status: Experimental
Last reviewed: 2019-02-06
---
# [Task List Cloud Service](../../../lib/process-services-cloud/src/lib/task/task-list/services/task-list-cloud.service.ts "Defined in task-list-cloud.service.ts")
Searches tasks.
## Class members
### Methods
- **getTaskByRequest**(requestNode: [`TaskQueryCloudRequestModel`](../../../lib/process-services-cloud/src/lib/task/task-list/models/filter-cloud-model.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
Finds a task using an object with optional query properties.
- _requestNode:_ [`TaskQueryCloudRequestModel`](../../../lib/process-services-cloud/src/lib/task/task-list/models/filter-cloud-model.ts) - Query object
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - Task information
## Details
Note that for a call to `getTaskByRequest`, the
[`TaskQueryCloudRequestModel`](../../../lib/process-services-cloud/src/lib/task/task-list/models/filter-cloud-model.ts) object
must at minimum have the `appName` property correctly set.

View File

@ -1,36 +0,0 @@
---
Title: Start Process Cloud Service
Added: v3.0.0
Status: Experimental
Last reviewed: 2019-01-09
---
# [Start Process Cloud Service](../../lib/process-services-cloud/src/lib/process/start-process/services/start-process-cloud.service.ts "Defined in start-process-cloud.service.ts")
Gets process definitions and starts processes.
## Class members
### Methods
- **getProcessDefinitions**(appName: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessDefinitionCloud`](../../lib/process-services-cloud/src/lib/process/start-process/models/process-definition-cloud.model.ts)`[]>`<br/>
Gets the process definitions associated with an app.
- _appName:_ `string` - Name of the target app
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessDefinitionCloud`](../../lib/process-services-cloud/src/lib/process/start-process/models/process-definition-cloud.model.ts)`[]>` - Array of process definitions
- **startProcess**(appName: `string`, requestPayload: [`ProcessPayloadCloud`](../../lib/process-services-cloud/src/lib/process/start-process/models/process-payload-cloud.model.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessInstanceCloud`](../../lib/process-services-cloud/src/lib/process/start-process/models/process-instance-cloud.model.ts)`>`<br/>
Starts a process based on a process definition, name, form values or variables.
- _appName:_ `string` - name of the Application
- _requestPayload:_ [`ProcessPayloadCloud`](../../lib/process-services-cloud/src/lib/process/start-process/models/process-payload-cloud.model.ts) - Details of the process (definition key, name, variables, etc)
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessInstanceCloud`](../../lib/process-services-cloud/src/lib/process/start-process/models/process-instance-cloud.model.ts)`>` - Details of the process instance just started
## Details
You can use the `startProcess` method in much the same way as the `startProcess` method in the
[Process service](../process-services/process.service.md) (see the [Process service](../process-services/process.service.md) page
for an example). However, the cloud version
combines the process details and variables conveniently into the
[`ProcessPayloadCloud`](../../lib/process-services-cloud/src/lib/process/start-process/models/process-payload-cloud.model.ts) object.
## See also
- [Process service](../process-services/process.service.md)

View File

@ -1,30 +0,0 @@
---
Title: Start Task Cloud Service
Added: v3.0.0
Status: Experimental
Last reviewed: 2019-01-09
---
# [Start Task Cloud Service](../../lib/process-services-cloud/src/lib/task/start-task/services/start-task-cloud.service.ts "Defined in start-task-cloud.service.ts")
Starts standalone tasks.
## Class members
### Methods
- **createNewTask**(taskDetails: [`TaskDetailsCloudModel`](../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsCloudModel`](../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts)`>`<br/>
Creates a new standalone task.
- _taskDetails:_ [`TaskDetailsCloudModel`](../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts) - Details of the task to create
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsCloudModel`](../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts)`>` - Details of the newly created task
## Details
The `createNewTask` method works the same way as the method with the same name in the
[Tasklist service](../process-services/tasklist.service.md)
but uses the cloud variants of the classes for the parameter and return value. See the
[Tasklist service](../process-services/tasklist.service.md) page for usage examples.
## See also
- [Tasklist service](../process-services/tasklist.service.md)

View File

@ -1,66 +0,0 @@
---
Title: Task Filter Cloud Service
Added: v3.0.0
Status: Experimental
Last reviewed: 2019-01-09
---
# [Task Filter Cloud Service](../../lib/process-services-cloud/src/lib/task/task-filters/services/task-filter-cloud.service.ts "Defined in task-filter-cloud.service.ts")
Manages task filters.
## Class members
### Methods
- **addFilter**(filter: [`TaskFilterCloudModel`](../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts))<br/>
Adds a new task filter.
- _filter:_ [`TaskFilterCloudModel`](../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts) - The new filter to add
- **deleteFilter**(filter: [`TaskFilterCloudModel`](../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts))<br/>
Deletes a task filter
- _filter:_ [`TaskFilterCloudModel`](../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts) - The filter to delete
- **getCompletedTasksFilterInstance**(appName: `string`): [`TaskFilterCloudModel`](../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts)<br/>
Creates and returns a filter for "Completed" task instances.
- _appName:_ `string` - Name of the target app
- **Returns** [`TaskFilterCloudModel`](../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts) - The newly created filter
- **getMyTasksFilterInstance**(appName: `string`): [`TaskFilterCloudModel`](../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts)<br/>
Creates and returns a filter for "My [`Tasks`](../../e2e/actions/APS-cloud/tasks.ts)" task instances.
- _appName:_ `string` - Name of the target app
- **Returns** [`TaskFilterCloudModel`](../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts) - The newly created filter
- **getTaskFilterById**(appName: `string`, id: `string`): [`TaskFilterCloudModel`](../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts)<br/>
Gets a task filter.
- _appName:_ `string` - Name of the target app
- _id:_ `string` - ID of the task
- **Returns** [`TaskFilterCloudModel`](../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts) - Details of the task filter
- **getTaskListFilters**(appName?: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskFilterCloudModel`](../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts)`[]>`<br/>
Gets all task filters for a process app.
- _appName:_ `string` - (Optional) Name of the target app
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskFilterCloudModel`](../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts)`[]>` - Observable of task filter details
- **getUsername**(): `string`<br/>
Gets the username field from the access token.
- **Returns** `string` - Username string
- **getValueFromToken**(key: `string`)<br/>
Gets a named value from the access token.
- _key:_ `string` - Key name of the value
- **updateFilter**(filter: [`TaskFilterCloudModel`](../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts))<br/>
Updates a task filter.
- _filter:_ [`TaskFilterCloudModel`](../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts) - The filter to update
## Details
The methods of this service generally return an instance of [`TaskFilterCloudModel`](../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts) or
an array of instances. For example, you could use `getTaskListFilters` as follows:
```ts
this.taskFilterService.getTaskListFilters(appName).subscribe( (filters: TaskFilterCloudModel[]) => {
console.log('Task filters: ', filters);
}, error => {
console.log('Error: ', error);
});
```
These filters can now be used to get matching task instances for the process app.
## See also
- [Task filter service](../process-services/task-filter.service.md)

View File

@ -1,25 +0,0 @@
---
Title: Task List Cloud Service
Added: v3.0.0
Status: Experimental
Last reviewed: 2019-02-06
---
# [Task List Cloud Service](../../lib/process-services-cloud/src/lib/task/task-list/services/task-list-cloud.service.ts "Defined in task-list-cloud.service.ts")
Searches tasks.
## Class members
### Methods
- **getTaskByRequest**(requestNode: [`TaskQueryCloudRequestModel`](../../lib/process-services-cloud/src/lib/task/task-list/models/filter-cloud-model.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
Finds a task using an object with optional query properties.
- _requestNode:_ [`TaskQueryCloudRequestModel`](../../lib/process-services-cloud/src/lib/task/task-list/models/filter-cloud-model.ts) - Query object
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - Task information
## Details
Note that for a call to `getTaskByRequest`, the
[`TaskQueryCloudRequestModel`](../../lib/process-services-cloud/src/lib/task/task-list/models/filter-cloud-model.ts) object
must at minimum have the `appName` property correctly set.

View File

@ -45,7 +45,7 @@ export class SomeComponent implements OnInit {
``` ```
You can use column templates with the [people list component](people-list.component.md), since it is based on the You can use column templates with the [people list component](people-list.component.md), since it is based on the
[Datatable component](../../core/datatable.component.md): [Datatable component](../../core/components/datatable.component.md):
<!-- {% raw %} --> <!-- {% raw %} -->
@ -79,11 +79,11 @@ You can use column templates with the [people list component](people-list.compon
| Name | Type | Default value | Description | | Name | Type | Default value | Description |
| ---- | ---- | ------------- | ----------- | | ---- | ---- | ------------- | ----------- |
| 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. | | users | [`UserProcessModel`](../../core/models/user-process.model.md)`[]` | | The array of user data used to populate the people list. |
### Events ### Events
| Name | Type | Description | | Name | Type | Description |
| ---- | ---- | ----------- | | ---- | ---- | ----------- |
| clickAction | [`EventEmitter`](https://angular.io/api/core/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`](https://angular.io/api/core/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. |
| clickRow | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`UserProcessModel`](../../core/user-process.model.md)`>` | Emitted when the user clicks a row in the people list. | | clickRow | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`UserProcessModel`](../../core/models/user-process.model.md)`>` | Emitted when the user clicks a row in the people list. |

View File

@ -20,7 +20,7 @@ Displays documents attached to a specified process instance.
</adf-process-attachment-list> </adf-process-attachment-list>
``` ```
Make sure to override the [`UploadService`](../../core/upload.service.md) with the [`ProcessUploadService`](../../../lib/process-services/task-list/services/process-upload.service.ts) Make sure to override the [`UploadService`](../../core/services/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';
@ -67,7 +67,7 @@ A default template will be used if you don't supply a custom one to override it:
| Name | Type | Description | | Name | Type | Description |
| ---- | ---- | ----------- | | ---- | ---- | ----------- |
| attachmentClick | [`EventEmitter`](https://angular.io/api/core/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`](https://developer.mozilla.org/en-US/docs/Web/API/Blob) representing the object that was clicked. | | attachmentClick | [`EventEmitter`](https://angular.io/api/core/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](https://developer.mozilla.org/en-US/docs/Web/API/Blob) representing the object that was clicked. |
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when the attachment list is not able to fetch the attachments (eg, following a network error). | | error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when the attachment list is not able to fetch the attachments (eg, following a network error). |
| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<Object>` | Emitted when the attachment list has fetched all the attachments. Returns a list of attachments. | | success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<Object>` | Emitted when the attachment list has fetched all the attachments. Returns a list of attachments. |
@ -76,7 +76,7 @@ A default template will be used if you don't supply a custom one to override it:
### How to Add Drag and Drop Functionality ### How to Add Drag and Drop Functionality
You can wrap the attachment list with an You can wrap the attachment list with an
[Upload Drag Area component](../../content-services/upload-drag-area.component.md) [Upload Drag Area component](../../content-services/components/upload-drag-area.component.md)
to let the user upload attachments to empty lists. When you do this, you can also supply to let the user upload attachments to empty lists. When you do this, you can also supply
a custom _no content template_ (using &lt;adf-empty-list>) to invite the user to add their attachments: a custom _no content template_ (using &lt;adf-empty-list>) to invite the user to add their attachments:

View File

@ -107,7 +107,7 @@ You can define a custom schema for the list in the `app.config.json` file and ac
``` ```
You can also define the schema in the HTML using the You can also define the schema in the HTML using the
[Data column component](../../core/data-column.component.md). You can combine this with schema [Data column component](../../core/components/data-column.component.md). You can combine this with schema
information defined in `app.config.json` as in the example below: information defined in `app.config.json` as in the example below:
```json ```json
@ -186,6 +186,6 @@ The Process Instance List also supports pagination:
## See also ## See also
- [Data column component](../../core/data-column.component.md) - [Data column component](../../core/components/data-column.component.md)
- [Data Table Adapter interface](../../core/datatable-adapter.interface.md) - [Data Table Adapter interface](../../core/interfaces/datatable-adapter.interface.md)
- [Pagination component](../../core/pagination.component.md) - [Pagination component](../../core/components/pagination.component.md)

View File

@ -61,7 +61,7 @@ A default "no content" template is displayed if you don't supply one to override
| Name | Type | Description | | Name | Type | Description |
| ---- | ---- | ----------- | | ---- | ---- | ----------- |
| attachmentClick | [`EventEmitter`](https://angular.io/api/core/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`](https://developer.mozilla.org/en-US/docs/Web/API/Blob) representing the clicked object. | | attachmentClick | [`EventEmitter`](https://angular.io/api/core/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](https://developer.mozilla.org/en-US/docs/Web/API/Blob) representing the clicked object. |
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when an error occurs while fetching the attachments. | | error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when an error occurs while fetching the attachments. |
| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<Object>` | Emitted when the attachment list has fetched all the attachments. Returns a list of attachments. | | success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<Object>` | Emitted when the attachment list has fetched all the attachments. Returns a list of attachments. |
@ -69,7 +69,7 @@ A default "no content" template is displayed if you don't supply one to override
### How to Add Drag and Drop Functionality ### How to Add Drag and Drop Functionality
You can wrap the component with an [Upload Drag Area component](../../content-services/upload-drag-area.component.md) You can wrap the component with an [Upload Drag Area component](../../content-services/components/upload-drag-area.component.md)
to enable the user to upload attachments for empty lists. When you do this, you can also pass to enable the user to upload attachments for empty lists. When you do this, you can also pass
a custom _no content template_ as shown below. The component invites the user to drag files to a custom _no content template_ as shown below. The component invites the user to drag files to
upload whenever the list is empty. upload whenever the list is empty.
@ -100,7 +100,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`](../../core/upload.service.md) with the [`TaskUploadService`](../../../lib/process-services/task-list/services/task-upload.service.ts) Make sure you override the [`UploadService`](../../core/services/upload.service.md) with the [`TaskUploadService`](../../../lib/process-services/task-list/services/task-upload.service.ts)
```ts ```ts
@Component({ @Component({
@ -116,4 +116,4 @@ export class MyCustomTaskAttachmentComponent {
## See also ## See also
- [Upload Drag Area Component](../../content-services/upload-drag-area.component.md) - [Upload Drag Area Component](../../content-services/components/upload-drag-area.component.md)

View File

@ -38,7 +38,7 @@ Shows all the information related to a task.
## Details ## Details
The component populates an internal array of The component populates an internal array of
[CardViewModel](../../core/card-view.component.md) with the information that we want to display. [CardViewModel](../../core/components/card-view.component.md) with the information that we want to display.
By default all properties are displayed: By default all properties are displayed:

View File

@ -209,7 +209,7 @@ The Tasklist also supports pagination as shown in the example below:
### DataTableAdapter example ### DataTableAdapter example
See the [Data Table Adapter interface](../../core/datatable-adapter.interface.md) page for full details of the interface and its standard See the [Data Table Adapter interface](../../core/interfaces/datatable-adapter.interface.md) page for full details of the interface and its standard
implementation, [`ObjectDataTableAdapter`](../../../lib/core/datatable/data/object-datatable-adapter.ts). 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.
@ -224,10 +224,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 [Data Column component](../../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 [Data Column component](../../core/components/data-column.component.md) page for more information about these features.
## See also ## See also
- [Data column component](../../core/data-column.component.md) - [Data column component](../../core/components/data-column.component.md)
- [Data Table Adapter interface](../../core/datatable-adapter.interface.md) - [Data Table Adapter interface](../../core/interfaces/datatable-adapter.interface.md)
- [Pagination component](../../core/pagination.component.md) - [Pagination component](../../core/components/pagination.component.md)

View File

@ -14,8 +14,8 @@ Github only: true
| [**Adding a new view**](new-view.md) | Beginner | In this tutorial you will learn how to create a new view in your application and how to access it using a defined endpoint. | | [**Adding a new view**](new-view.md) | Beginner | In this tutorial you will learn how to create a new view in your application and how to access it using a defined endpoint. |
| [**Using ADF Components**](using-components.md) | Basic | In this tutorial you will learn how to extend, use and configure ADF Components. | | [**Using ADF Components**](using-components.md) | Basic | In this tutorial you will learn how to extend, use and configure ADF Components. |
| [**Basic theming**](basic-theming.md) | Beginner | In this tutorial you will see how to theme an ADF app by modifying the CSS. | | [**Basic theming**](basic-theming.md) | Beginner | In this tutorial you will see how to theme an ADF app by modifying the CSS. |
| [**Customizing the Login component**](customising-login.md) | Intermediate | In this tutorial you will learn how to customize the Login component following the technical documentation. | | [**Customizing the Login component**](customising-login.md) | Intermediate | In this tutorial you will learn how to customize the [Login component](../core/components/login.component.md) following the technical documentation. |
| [**Working with a Data Table**](working-with-data-table.md) | Intermediate | In this tutorial you will learn how to populate a DataTable component. | | [**Working with a Data Table**](working-with-data-table.md) | Intermediate | In this tutorial you will learn how to populate a DataTable component. |
| [**Working with the Nodes API Service**](working-with-nodes-api-service.md) | Intermediate | In this tutorial you will learn how to use the [`NodesApiService`](../core/nodes-api.service.md). | | [**Working with the Nodes API Service**](working-with-nodes-api-service.md) | Intermediate | In this tutorial you will learn how to use the [`NodesApiService`](../core/services/nodes-api.service.md). |
| [**Working with Nodes using the JS API**](working-with-nodes-js-api.md) | Intermediate | In this tutorial you will learn how to use the [`AlfrescoCoreRestApi`](https://github.com/Alfresco/alfresco-js-api/tree/master/src/alfresco-core-rest-api). | | [**Working with Nodes using the JS API**](working-with-nodes-js-api.md) | Intermediate | In this tutorial you will learn how to use the [`AlfrescoCoreRestApi`](https://github.com/Alfresco/alfresco-js-api/tree/master/src/alfresco-core-rest-api). |
| [**Content metadata component**](content-metadata-component.md) | Advanced | In this tutorial you will learn how to work with the [`ContentMetadataComponent`](../content-services/content-metadata.component.md). | | [**Content metadata component**](content-metadata-component.md) | Advanced | In this tutorial you will learn how to work with the [`ContentMetadataComponent`](../content-services/components/content-metadata.component.md). |

View File

@ -5,13 +5,13 @@ Level: Advanced
# Content metadata component # Content metadata component
In this tutorial you will learn how to work with the [`ContentMetadataComponent`](../content-services/content-metadata.component.md). In this tutorial you will learn how to work with the [`ContentMetadataComponent`](../content-services/components/content-metadata.component.md).
This component is used to render the standard and custom metadata of generic content item (called a _node_) stored in Alfresco Content Services. With the usual approach "learning by doing", you will see here some practical examples you might find useful in your own applicatioin. As a starting point, we will use and customize the [Alfresco Content App](https://github.com/Alfresco/alfresco-content-app). This component is used to render the standard and custom metadata of generic content item (called a _node_) stored in Alfresco Content Services. With the usual approach "learning by doing", you will see here some practical examples you might find useful in your own applicatioin. As a starting point, we will use and customize the [Alfresco Content App](https://github.com/Alfresco/alfresco-content-app).
## About the `ContentMetadataComponent` ## About the `ContentMetadataComponent`
As described in the [`ContentMetadataComponent`](../content-services/content-metadata.component.md) documentation, the `adf-content-metadata-card` tag has some useful attributes, included the `preset` attribute, which is used to point to a collection of aspects/properties to render. As described in the [`ContentMetadataComponent`](../content-services/components/content-metadata.component.md) documentation, the `adf-content-metadata-card` tag has some useful attributes, included the `preset` attribute, which is used to point to a collection of aspects/properties to render.
Below, you can see the `preset` value requesting to render all the available aspects/properties: Below, you can see the `preset` value requesting to render all the available aspects/properties:

View File

@ -5,7 +5,7 @@ Level: Intermediate
# Customizing the Login component # Customizing the Login component
In this tutorial you will learn how to customize the [Login component](../core/login.component.md) following the technical documentation. In this tutorial you will learn how to customize the [Login component](../core/components/login.component.md) following the technical documentation.
The task will be very simple. See the documentation for further details about customizing this component, along with examples. The task will be very simple. See the documentation for further details about customizing this component, along with examples.
@ -16,17 +16,17 @@ Starting from an existing ADF application, the `Login` component, like any other
it is stored in the `/src/app/components/login` path. In an ADF app created with [Yeoman](http://yeoman.io/) it is stored in the `/src/app/components/login` path. In an ADF app created with [Yeoman](http://yeoman.io/)
it is stored in the `/src/app/login` path. it is stored in the `/src/app/login` path.
Once you have located the Login component for your application, you can customize it as described below. Once you have located the [Login component](../core/components/login.component.md) for your application, you can customize it as described below.
## Changing the header ## Changing the header
As with every regular As with every regular
[Angular Component](https://angular.io/guide/architecture-components), [Angular Component](https://angular.io/guide/architecture-components),
you can customize the Login component can be customised via CSS, HTML and Typescript. In this simple you can customize the [Login component](../core/components/login.component.md) can be customised via CSS, HTML and Typescript. In this simple
example, we will customize the header (as described also in the example, we will customize the header (as described also in the
[technical documentation](../core/login.component.md)). [technical documentation](../core/components/login.component.md)).
Open the [`login.component`](../core/login.component.md)`.html` file and change the content to match the following source code: Open the [`login.component`](../core/components/login.component.md)`.html` file and change the content to match the following source code:
```html ```html
<adf-login ...> <adf-login ...>
@ -40,7 +40,7 @@ After saving the file, the login form will look like this:
## More examples ## More examples
As mentioned earlier, this is a very basic example and the Login component can be customized As mentioned earlier, this is a very basic example and the [Login component](../core/components/login.component.md) can be customized
much more extensively than this. For a complete and detailed description, full of examples, check the much more extensively than this. For a complete and detailed description, full of examples, check the
[technical documentation about the component](../core/login.component.md). [technical documentation about the component](../core/components/login.component.md).
This describes every customization available for the Login component. This describes every customization available for the [Login component](../core/components/login.component.md).

View File

@ -9,7 +9,7 @@ In this tutorial you will learn how to extend, use and configure ADF Components.
![login](../docassets/images/login.jpg) ![login](../docassets/images/login.jpg)
We will be customizing the [Login component](../core/login.component.md) as an example, where we will remove the `Remember me`, `Need Help?` and `Register` links in the footer and setup an event listener that displays an alert when the login form is submitted. We will finish off by setting up a custom footer. We will be customizing the [Login component](../core/components/login.component.md) as an example, where we will remove the `Remember me`, `Need Help?` and `Register` links in the footer and setup an event listener that displays an alert when the login form is submitted. We will finish off by setting up a custom footer.
The final result will look like this: The final result will look like this:
@ -21,7 +21,7 @@ We have carefully picked these three customizations because they cover the three
2. Event Listeners 2. Event Listeners
3. HTML Extensions / _Content Projection_ 3. HTML Extensions / _Content Projection_
You should always consult the documentation for the component you are looking to use. For this exercise it would be useful to open a browser window with the [Login Component](../core/login.component.md) You should always consult the documentation for the component you are looking to use. For this exercise it would be useful to open a browser window with the [Login Component](../core/components/login.component.md)
documentation. documentation.
Let's do a practical example with each approach. Let's do a practical example with each approach.
@ -68,7 +68,7 @@ Save the file. The browser will automatically reload once the file is saved. The
Now that we've successfully configured properties on the `<adf-login/>` component, it's time to look at events. Now that we've successfully configured properties on the `<adf-login/>` component, it's time to look at events.
Again, looking at the [Login Component](../core/login.component.md) Again, looking at the [Login Component](../core/components/login.component.md)
docs, we can see that it emits three events: `success`, `error` and `executeSubmit`. docs, we can see that it emits three events: `success`, `error` and `executeSubmit`.
We can subscribe to these events and have our custom code executed when these events are emitted. Let's hook into the `executeSubmit` and do a simple `alert()` when the form is submitted. We can subscribe to these events and have our custom code executed when these events are emitted. Let's hook into the `executeSubmit` and do a simple `alert()` when the form is submitted.
@ -115,7 +115,7 @@ export class LoginComponent {
} }
``` ```
Save the files, go to the [login component,](../core/login.component.md) enter a valid username and password and you should now see an alert. Looking in the console in the browser, you'll see the event data. Here we get all the details for the form. Save the files, go to the [login component,](../core/components/login.component.md) enter a valid username and password and you should now see an alert. Looking in the console in the browser, you'll see the event data. Here we get all the details for the form.
## Content Projection / HTMl Extensions ## Content Projection / HTMl Extensions
@ -163,7 +163,7 @@ Inside the `<adf-login-footer/>` or `<adf-login-header/>` tags we can put anythi
### Bonus objective: Add a custom logo and background to the login screen ### Bonus objective: Add a custom logo and background to the login screen
Are you up for a challenge? Explore the [Login component](../core/login.component.md) Are you up for a challenge? Explore the [Login component](../core/components/login.component.md)
docs to find out how you can change the logo and background image! docs to find out how you can change the logo and background image!
# Next steps # Next steps

View File

@ -12,7 +12,7 @@ The custom data for the table generally comes from a generic back-end service or
## Prerequisites and data source ## Prerequisites and data source
Before diving deep into the technical description of the Before diving deep into the technical description of the
[DataTable component](../core/datatable.component.md), [DataTable component](../core/components/datatable.component.md),
let's start with a description of the development environment and its prerequisites. let's start with a description of the development environment and its prerequisites.
In this tutorial we will start from an existing ADF application set up to use (at least) Alfresco Content In this tutorial we will start from an existing ADF application set up to use (at least) Alfresco Content
@ -24,7 +24,7 @@ is well documented, and you can choose to
However, if you prefer to create a brand new ADF application from scratch then you should still be able However, if you prefer to create a brand new ADF application from scratch then you should still be able
to follow the tutorial without difficulty. to follow the tutorial without difficulty.
For this tutorial, the endpoint used to populate the [DataTable component](../../lib/core/datatable/components/datatable/datatable.component.ts) is the For this tutorial, the endpoint used to populate the [DataTable component](../core/components/datatable.component.md) is the
[`/people` service](https://api-explorer.alfresco.com/api-explorer/#!/people/listPeople) which lists [`/people` service](https://api-explorer.alfresco.com/api-explorer/#!/people/listPeople) which lists
all users available in an Alfresco Content Services instance. The `/people` service is suitable for the all users available in an Alfresco Content Services instance. The `/people` service is suitable for the
purpose of this tutorial because it is available by default in the Alfresco Content Services REST API. purpose of this tutorial because it is available by default in the Alfresco Content Services REST API.
@ -171,7 +171,7 @@ of the DataTable, and even smaller components like Attachment List, Comment List
Content Selector are also based on it. Content Selector are also based on it.
Looking at the Looking at the
[documentation](../core/datatable.component.md), [documentation](../core/components/datatable.component.md),
we can see that it has a lot of different options, including single/multi selection, click events, we can see that it has a lot of different options, including single/multi selection, click events,
context menus, actions and keyboard navigation. context menus, actions and keyboard navigation.
@ -201,10 +201,10 @@ access to all the data in the row, if required. When you click a row, you should
## DataTable columns ## DataTable columns
Let's dig a bit deeper into the different options for rendering columns within the DataTable. The documentation for the Let's dig a bit deeper into the different options for rendering columns within the DataTable. The documentation for the
[Data Column component](../core/data-column.component.md) [Data Column component](../core/components/data-column.component.md)
is quite in-depth and has lots of examples. We highly recommend checking it out. is quite in-depth and has lots of examples. We highly recommend checking it out.
From the documentation we can see that the [Data Column component](../core/data-column.component.md) has quite a few properties but the From the documentation we can see that the [Data Column component](../core/components/data-column.component.md) has quite a few properties but the
most important ones are `key`, `type`, `sortable`, `title` and `class`. most important ones are `key`, `type`, `sortable`, `title` and `class`.
- `key` is the name of the corresponding property in the [`ObjectDataTableAdapter`](../../lib/core/datatable/data/object-datatable-adapter.ts) object. - `key` is the name of the corresponding property in the [`ObjectDataTableAdapter`](../../lib/core/datatable/data/object-datatable-adapter.ts) object.

View File

@ -5,9 +5,9 @@ Level: Intermediate
# Working with the Nodes API Service # Working with the Nodes API Service
In this tutorial you will learn how to use the [`NodesApiService`](../core/nodes-api.service.md). In this tutorial you will learn how to use the [`NodesApiService`](../core/services/nodes-api.service.md).
We have developed some practical examples to show you how to interact with an instance of Alfresco Content Services without using the REST endpoints directly. With this approach the [`NodesApiService`](../core/nodes-api.service.md) is used as an abstraction layer, defined by one of the services in the ADF Core library. We have developed some practical examples to show you how to interact with an instance of Alfresco Content Services without using the REST endpoints directly. With this approach the [`NodesApiService`](../core/services/nodes-api.service.md) is used as an abstraction layer, defined by one of the services in the ADF Core library.
## Contents ## Contents
@ -25,7 +25,7 @@ We have developed some practical examples to show you how to interact with an in
## Preparing the development environment ## Preparing the development environment
To focus the description on the [`NodesApiService`](../core/nodes-api.service.md), we will develop on top of the To focus the description on the [`NodesApiService`](../core/services/nodes-api.service.md), we will develop on top of the
[Alfresco Example Content Application](https://github.com/Alfresco/alfresco-content-app). [Alfresco Example Content Application](https://github.com/Alfresco/alfresco-content-app).
If you don't have it already installed in your development environment then see the If you don't have it already installed in your development environment then see the
_how-to_ description in _how-to_ description in
@ -62,18 +62,18 @@ the preview of the content:
![nodesapiservices_myonnodedoubleclick](../docassets/images/nodesapiservices_myonnodedoubleclick.png) ![nodesapiservices_myonnodedoubleclick](../docassets/images/nodesapiservices_myonnodedoubleclick.png)
The Alfresco Example Content app is now set up to demonstrate the usage of the [`NodesApiService`](../core/nodes-api.service.md). The Alfresco Example Content app is now set up to demonstrate the usage of the [`NodesApiService`](../core/services/nodes-api.service.md).
## Basic examples of usage ## Basic examples of usage
For a first look at the [`NodesApiService`](../core/nodes-api.service.md), let's check the `FileComponent` component stored in For a first look at the [`NodesApiService`](../core/services/nodes-api.service.md), let's check the `FileComponent` component stored in
`src/app/components/files/files.component.ts`. In the source code, you can see the `nodesApi` `src/app/components/files/files.component.ts`. In the source code, you can see the `nodesApi`
property that represents the [`NodesApiService`](../core/nodes-api.service.md) in the [`FilesComponent`](../../demo-shell/src/app/components/files/files.component.ts). See the `fetchNode` and property that represents the [`NodesApiService`](../core/services/nodes-api.service.md) in the [`FilesComponent`](../../demo-shell/src/app/components/files/files.component.ts). See the `fetchNode` and
`fetchNodes` methods for some very basic examples. `fetchNodes` methods for some very basic examples.
## About the NodesApiService ## About the NodesApiService
Before going further, let's introduce the [`NodesApiService`](../core/nodes-api.service.md) class. Before going further, let's introduce the [`NodesApiService`](../core/services/nodes-api.service.md) class.
As you can see, the available methods are easy to understand and they should be all you need to As you can see, the available methods are easy to understand and they should be all you need to
manage the nodes of your content repository. manage the nodes of your content repository.
@ -84,7 +84,7 @@ Observables provide support for passing messages between publishers and subscrib
applications. Observables offer significant benefits over other techniques for event handling, applications. Observables offer significant benefits over other techniques for event handling,
asynchronous programming, and handling multiple values. asynchronous programming, and handling multiple values.
The return values of the [`NodesApiService`](../core/nodes-api.service.md) methods are managed in the usual way for Observables. The return values of the [`NodesApiService`](../core/services/nodes-api.service.md) methods are managed in the usual way for Observables.
You "subscribe" to the asynchronous messaging using the following syntax: You "subscribe" to the asynchronous messaging using the following syntax:
```ts ```ts
@ -103,13 +103,13 @@ for further details.
### NodePaging ### NodePaging
When a method returns a list of nodes rather than a single node, it usually returns an [`Observable`](http://reactivex.io/documentation/observable.html) of the [`NodePaging`](../../lib/content-services/document-list/models/document-library.model.ts) class. See the When a method returns a list of nodes rather than a single node, it usually returns an [`Observable`](http://reactivex.io/documentation/observable.html) of the [`NodePaging`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/NodePaging.md) class. See the
[`NodePaging`](../../lib/content-services/document-list/models/document-library.model.ts) [`NodePaging`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/NodePaging.md)
docs for further details. docs for further details.
## Retrieving info and metadata from a node ## Retrieving info and metadata from a node
As a first example of the usage of the [`NodesApiService`](../core/nodes-api.service.md), let's retrieve the properties of a content node using its identifier. Edit the `myOnNodeDoubleClick` method in `src/app/components/files/files.component.ts`, as shown below: As a first example of the usage of the [`NodesApiService`](../core/services/nodes-api.service.md), let's retrieve the properties of a content node using its identifier. Edit the `myOnNodeDoubleClick` method in `src/app/components/files/files.component.ts`, as shown below:
```ts ```ts
myOnNodeDoubleClick(nodeId) { myOnNodeDoubleClick(nodeId) {
@ -133,7 +133,7 @@ other visual component) then the principle is the same.
## Retrieving the node's children ## Retrieving the node's children
Another common use of the [`NodesApiService`](../core/nodes-api.service.md) is to retrieve a list of the children of a folder node. Another common use of the [`NodesApiService`](../core/services/nodes-api.service.md) is to retrieve a list of the children of a folder node.
Edit `src/app/components/files/files.component.ts` again, changing the `onNodeDoubleClick` method Edit `src/app/components/files/files.component.ts` again, changing the `onNodeDoubleClick` method
to match the source code below: to match the source code below:
@ -170,7 +170,7 @@ in the browser's console you will see something like the following screenshot:
## Creating and deleting a subfolder ## Creating and deleting a subfolder
The [`NodesApiService`](../core/nodes-api.service.md) class is not just for retrieving data. You can also use it to manage a The [`NodesApiService`](../core/services/nodes-api.service.md) class is not just for retrieving data. You can also use it to manage a
real CRUD of nodes (content and folders). In the following examples, you will see how to create real CRUD of nodes (content and folders). In the following examples, you will see how to create
a subfolder of the double clicked folder and also how to delete it. a subfolder of the double clicked folder and also how to delete it.

View File

@ -10,13 +10,15 @@ on an item below to see the corresponding guide page.
<!--guide start--> <!--guide start-->
- [Introduction to ADF](adf-introduction.md)
- [Angular Material Design](angular-material-design.md) - [Angular Material Design](angular-material-design.md)
- [App extensions](app-extensions.md)
- [Form Extensibility and Customisation](extensibility.md) - [Form Extensibility and Customisation](extensibility.md)
- [Internationalization in ADF](internationalization.md) - [Internationalization in ADF](internationalization.md)
- [Theming](theming.md) - [Theming](theming.md)
- [Right-to-left language support](rtl-support.md)
- [Transclusion](transclusion.md) - [Transclusion](transclusion.md)
- [Typography](typography.md) - [Typography](typography.md)
- [Walkthrough - adding indicators to highlight information about a node](metadata-indicators.md) - [Walkthrough - adding indicators to highlight information about a node](metadata-indicators.md)
- [Right-to-left language support](rtl-support.md)
<!--guide end--> <!--guide end-->

View File

@ -27,9 +27,9 @@ branding, and features that you need. Some examples of where this can be useful
You can find full instructions for installing ADF and its prerequisites in our You can find full instructions for installing ADF and its prerequisites in our
tutorial tutorial
[*Creating your first ADF application*](../tutorials/creating-your-first-adf-application.md). [_Creating your first ADF application_](../tutorials/creating-your-first-adf-application.md).
When you have the environment and the scaffold app set up, the other When you have the environment and the scaffold app set up, the other
[tutorials](../tutorials/README.md) then explain how to connect to the backend services [tutorials](../tutorials/README.md) then explain how to connect to the backend services
and add custom features to your app. Use the [component reference](../README.md) pages and add custom features to your app. Use the [component reference](../README.md) pages
to learn about component features and the [user guide](../user-guide/README.md) to learn [about component](../core/components/about.component.md) features and the [user guide](../user-guide/README.md)
to learn about specific tasks and topics in depth. to learn about specific tasks and topics in depth.

View File

@ -45,7 +45,7 @@ a place in the app where the actual content will be supplied dynamically.
ADF provides a number of features that offer extension points or help ADF provides a number of features that offer extension points or help
with extensibility in general: with extensibility in general:
- **Components**: The [Dynamic component](../extensions/dynamic.component.md) - **Components**: The [Dynamic component](../extensions/components/dynamic.component.md)
has no content of its own but it has an `id` property that has no content of its own but it has an `id` property that
references a registered component extension ID. The referenced component references a registered component extension ID. The referenced component
will be added as a child of the Dynamic component at runtime. will be added as a child of the Dynamic component at runtime.
@ -78,9 +78,9 @@ with extensibility in general:
## Setting up an app for extensibility ## Setting up an app for extensibility
You can register component classes for use with the [Dynamic component](../extensions/dynamic.component.md) You can register component classes for use with the [Dynamic component](../extensions/components/dynamic.component.md)
using the `setComponents` method of the using the `setComponents` method of the
[Extension service](../extensions/extension.service.md) (see the Dynamic component page for further details [Extension service](../extensions/services/extension.service.md) (see the Dynamic component page for further details
and code samples). The service also has `setAuthGuards` and and code samples). The service also has `setAuthGuards` and
`setEvaluators` methods that behave analogously. `setEvaluators` methods that behave analogously.
@ -117,7 +117,7 @@ below:
} }
``` ```
You can use the `load` method of the [Extension service](../extensions/extension.service.md) to read the file into a You can use the `load` method of the [Extension service](../extensions/services/extension.service.md) to read the file into a
convenient object that implements the [`ExtensionConfig`](../../lib/extensions/src/lib/config/extension.config.ts) and [`ExtensionRef`](../../lib/extensions/src/lib/config/extension.config.ts) interfaces. convenient object that implements the [`ExtensionConfig`](../../lib/extensions/src/lib/config/extension.config.ts) and [`ExtensionRef`](../../lib/extensions/src/lib/config/extension.config.ts) interfaces.
Note that the `extension.schema.json` file contains a [JSON schema](http://json-schema.org/) Note that the `extension.schema.json` file contains a [JSON schema](http://json-schema.org/)
that allows for format checking and also text completion in some editors. that allows for format checking and also text completion in some editors.
@ -144,7 +144,7 @@ following example:
``` ```
You can access routes from the config using the `getRouteById` method of the You can access routes from the config using the `getRouteById` method of the
[Extension service,](../extensions/extension.service.md) which returns a [`RouteRef`](../../lib/extensions/src/lib/config/routing.extensions.ts) object. Note that the references [Extension service,](../extensions/services/extension.service.md) which returns a [`RouteRef`](../../lib/extensions/src/lib/config/routing.extensions.ts) object. Note that the references
to the component and auth guards are extension IDs, to the component and auth guards are extension IDs,
[as described above](#extension-points). [as described above](#extension-points).
@ -173,7 +173,7 @@ The `actions` array has the following structure:
] ]
``` ```
The [Extension service](../extensions/extension.service.md) defines a `getActionById` method that returns an The [Extension service](../extensions/services/extension.service.md) defines a `getActionById` method that returns an
[`ActionRef`](../../lib/extensions/src/lib/config/action.extensions.ts) object corresponding to an item from this array. [`ActionRef`](../../lib/extensions/src/lib/config/action.extensions.ts) object corresponding to an item from this array.
The `type` property refers to an action type that must be provided by the The `type` property refers to an action type that must be provided by the
@ -185,7 +185,7 @@ a message, URL or other static text data. However, you can also define a
JavaScript expression here by surrounding it with `$( ... )`. The expression JavaScript expression here by surrounding it with `$( ... )`. The expression
has access to an object named `context` which typically contains information has access to an object named `context` which typically contains information
about the app state. You can supply the object that contains this data via the about the app state. You can supply the object that contains this data via the
`runExpression` method of the [Extension service,](../extensions/extension.service.md) which actually evaluates the `runExpression` method of the [Extension service,](../extensions/services/extension.service.md) which actually evaluates the
expression. Note that the result of the expression doesn't necessarily expression. Note that the result of the expression doesn't necessarily
have to be a string. have to be a string.
@ -204,7 +204,7 @@ The simplest type of rule is configured as shown below:
``` ```
The `type` is the ID of a `RuleEvaluator` function that has been registered using The `type` is the ID of a `RuleEvaluator` function that has been registered using
the `setEvaluators` method of the [Extension service](../extensions/extension.service.md). the `setEvaluators` method of the [Extension service](../extensions/services/extension.service.md).
The evaluator is a boolean function that represents whether a certain The evaluator is a boolean function that represents whether a certain
condition is true or false (eg, whether an item is selected, whether the user condition is true or false (eg, whether an item is selected, whether the user
has certain options enabled, etc). The evaluator has access to a context object has certain options enabled, etc). The evaluator has access to a context object

View File

@ -26,19 +26,19 @@ _Note: it is assumed you are familiar with Alfresco Process Services (powered by
## How components and widgets are rendered on a Form ## How components and widgets are rendered on a Form
All form field editors (aka widgets) on a [`Form`](../../lib/process-services/task-list/models/form.model.ts) are rendered by means of [`FormFieldComponent`](../core/form-field.component.md) All form field editors (aka widgets) on a [`Form`](../../lib/process-services/task-list/models/form.model.ts) are rendered by means of [`FormFieldComponent`](../core/components/form-field.component.md)
that takes an instance of a [`FormFieldModel`](../core/form-field.model.md): that takes an instance of a [`FormFieldModel`](../core/models/form-field.model.md):
```html ```html
<form-field [field]="field"></form-field> <form-field [field]="field"></form-field>
``` ```
This component depends on [`FormRenderingService`](../core/form-rendering.service.md) service to map [`FormFieldModel`](../core/form-field.model.md) to UI component This component depends on [`FormRenderingService`](../core/services/form-rendering.service.md) service to map [`FormFieldModel`](../core/models/form-field.model.md) to UI component
based on field type or metadata information. based on field type or metadata information.
### Component type resolvers ### Component type resolvers
[`FormRenderingService`](../core/form-rendering.service.md) maps field types to corresponding instances exposing `ComponentTypeResolver` interface: [`FormRenderingService`](../core/services/form-rendering.service.md) maps field types to corresponding instances exposing `ComponentTypeResolver` interface:
```ts ```ts
export interface ComponentTypeResolver { export interface ComponentTypeResolver {
@ -46,7 +46,7 @@ export interface ComponentTypeResolver {
} }
``` ```
Typically a `ComponentTypeResolver` is a function that takes [`FormFieldModel`](../core/form-field.model.md) and returns corresponding component type. Typically a `ComponentTypeResolver` is a function that takes [`FormFieldModel`](../core/models/form-field.model.md) and returns corresponding component type.
It can be either a predefined component type or a dynamically evaluated based on field properties and metadata. It can be either a predefined component type or a dynamically evaluated based on field properties and metadata.
#### Static component mapping #### Static component mapping
@ -66,7 +66,7 @@ formRenderingService.setComponentTypeResolver('text', () => CustomWidgetComponen
#### Dynamic component mapping #### Dynamic component mapping
Alternatively your resolver may return different component types based on [`FormFieldModel`](../core/form-field.model.md) state and condition: Alternatively your resolver may return different component types based on [`FormFieldModel`](../core/models/form-field.model.md) state and condition:
```ts ```ts
let customResolver: ComponentTypeResolver = (field: FormFieldModel): Type<{}> => { let customResolver: ComponentTypeResolver = (field: FormFieldModel): Type<{}> => {
@ -111,7 +111,7 @@ First let's create a simple APS form with `Text` widgets:
![default text widget](../docassets/images/text-default-widget.png) ![default text widget](../docassets/images/text-default-widget.png)
Every custom widget must inherit [`WidgetComponent`](../insights/widget.component.md) class in order to function properly: Every custom widget must inherit [`WidgetComponent`](../insights/components/widget.component.md) class in order to function properly:
```ts ```ts
import { Component } from '@angular/core'; import { Component } from '@angular/core';
@ -158,7 +158,7 @@ don't forget to import it into your main application one:
export class AppModule {} export class AppModule {}
``` ```
Now you can import [`FormRenderingService`](../core/form-rendering.service.md) in any of your Views and override default mapping similar to the following: Now you can import [`FormRenderingService`](../core/services/form-rendering.service.md) in any of your Views and override default mapping similar to the following:
```ts ```ts
import { Component } from '@angular/core'; import { Component } from '@angular/core';
@ -252,7 +252,7 @@ And import into your Application Module
export class AppModule {} export class AppModule {}
``` ```
Now you can import [`FormRenderingService`](../core/form-rendering.service.md) in any of your Views and provide new mapping: Now you can import [`FormRenderingService`](../core/services/form-rendering.service.md) in any of your Views and provide new mapping:
```ts ```ts
import { Component } from '@angular/core'; import { Component } from '@angular/core';
@ -274,7 +274,7 @@ At runtime you should now see your custom Angular component rendered in place of
## See Also ## See Also
- [Form field model](../core/form-field.model.md) - [Form field model](../core/models/form-field.model.md)
- [Form rendering service](../core/form-rendering.service.md) - [Form rendering service](../core/services/form-rendering.service.md)
- [Form component](../core/form.component.md) - [Form component](../core/components/form.component.md)
- [Widget component](../insights/widget.component.md) - [Widget component](../insights/components/widget.component.md)

View File

@ -71,11 +71,11 @@ below:
``` ```
The hierarchical structure is referred to in the UI using the familiar "dot" The hierarchical structure is referred to in the UI using the familiar "dot"
notation (so `FORM.START_FORM.TITLE` would be the key for the "Start [Form"](../../lib/process-services/task-list/models/form.model.ts) notation (so `FORM.START_FORM.TITLE` would be the key for the "Start Form"
string here). This is useful for grouping related messages and providing string here). This is useful for grouping related messages and providing
singular and plural versions, among other things. singular and plural versions, among other things.
The [Translation service](../core/translation.service.md) defines the `get` method to The [Translation service](../core/services/translation.service.md) defines the `get` method to
get the translation of a key in the current language. A simple component might get the translation of a key in the current language. A simple component might
contain code like this: contain code like this:
@ -140,11 +140,11 @@ should check you are using the key correctly.
## Using the translate pipe ## Using the translate pipe
Using [`TranslationService`](../core/translation.service.md)`.get` is straightforward but it is often more Using [`TranslationService`](../core/services/translation.service.md)`.get` is straightforward but it is often more
convenient to add translation keys directly into your page's HTML. convenient to add translation keys directly into your page's HTML.
Use the `translate` pipe to convert a key in the page directly to the Use the `translate` pipe to convert a key in the page directly to the
corresponding text. For example, the following will display the corresponding text. For example, the following will display the
"Start [Form"](../../lib/process-services/task-list/models/form.model.ts) text as above but without any code or variables in the "Start Form" text as above but without any code or variables in the
component's `.ts` file: component's `.ts` file:
<!-- {% raw %} --> <!-- {% raw %} -->
@ -178,7 +178,7 @@ following:
} }
``` ```
The [Translation service](../core/translation.service.md) page has full details The [Translation service](../core/services/translation.service.md) page has full details
of how to add custom translations, including the locations of the required files of how to add custom translations, including the locations of the required files
and code samples for enabling the new translations in your app. and code samples for enabling the new translations in your app.
@ -207,7 +207,7 @@ messages whose content can change at runtime. For example, in the built-in
The sections in curly braces are _interpolation variables_ that you supply The sections in curly braces are _interpolation variables_ that you supply
at runtime. You can specify them by passing an extra parameter to at runtime. You can specify them by passing an extra parameter to
[`TranslationService`](../core/translation.service.md)`.get`; this is an object whose properties have the same [`TranslationService`](../core/services/translation.service.md)`.get`; this is an object whose properties have the same
names as the interpolation variables in the string: names as the interpolation variables in the string:
```ts ```ts
@ -232,7 +232,7 @@ You can use interpolations with the `translate` pipe in a similar way:
## How the display language is selected ## How the display language is selected
The `locale` preference in the [user preferences](../core/user-preferences.service.md) The `locale` preference in the [user preferences](../core/services/user-preferences.service.md)
contains the language code that will be used to display the ADF app. Since the user contains the language code that will be used to display the ADF app. Since the user
preferences can only be saved by the app when it runs, they will not immediately be available when preferences can only be saved by the app when it runs, they will not immediately be available when
the app launches for the first time. The app uses the following priorities to determine the app launches for the first time. The app uses the following priorities to determine
@ -251,37 +251,37 @@ The table below illustrates how the selection is made:
| X | fr | jp | en | fr | | X | fr | jp | en | fr |
| it | fr | jp | en | it | | it | fr | jp | en | it |
The [translation service](../core/translation.service.md) probes the browser culture first, for example `en-GB`. The [translation service](../core/services/translation.service.md) probes the browser culture first, for example `en-GB`.
If the `en-GB.json` file does not exist, the service falls back to the language id: `en`. If the `en-GB.json` file does not exist, the service falls back to the language id: `en`.
Once the locale language is determined, it is saved to the user preferences and this saved value Once the locale language is determined, it is saved to the user preferences and this saved value
will be used from that point on, regardless of the `app.config.json` and browser settings. will be used from that point on, regardless of the `app.config.json` and browser settings.
However, you can change the `locale` user preference from code using the However, you can change the `locale` user preference from code using the
[User Preferences service](../core/user-preferences.service.md) and the updated value [User Preferences service](../core/services/user-preferences.service.md) and the updated value
will still override any browser or `app.config.json` settings. will still override any browser or `app.config.json` settings.
ADF also provides a [Language Menu component](../core/language-menu.component.md) that ADF also provides a [Language Menu component](../core/components/language-menu.component.md) that
you can add to a page to let the user set the `locale` preference easily. The you can add to a page to let the user set the `locale` preference easily. The
list of available languages is defined in the `app.config.json` file for the app. list of available languages is defined in the `app.config.json` file for the app.
The `translate` pipe reacts automatically to a change in the locale language and The `translate` pipe reacts automatically to a change in the locale language and
immediately updates the display. However, text added via a variable set using immediately updates the display. However, text added via a variable set using
[`TranslationService`](../core/translation.service.md)`.get`, as in the example above, will not be [`TranslationService`](../core/services/translation.service.md)`.get`, as in the example above, will not be
updated directly in this way. Instead, you will need to get a new translation and set the updated directly in this way. Instead, you will need to get a new translation and set the
variable's value again explicitly from the code. variable's value again explicitly from the code.
See the [Language Menu component](../core/language-menu.component.md) page for further See the [Language Menu component](../core/components/language-menu.component.md) page for further
details and usage examples. details and usage examples.
## Support for i18n within ADF components ## Support for i18n within ADF components
Some components allow you to use translation keys in places where you would normally Some components allow you to use translation keys in places where you would normally
supply your own messages directly. For example, the supply your own messages directly. For example, the
[Data Column component](../core/data-column.component.md) can accept a key instead of [Data Column component](../core/components/data-column.component.md) can accept a key instead of
normal text to specify the column title. Consult the documentation for a normal text to specify the column title. Consult the documentation for a
component to see if it has built-in support for i18n. component to see if it has built-in support for i18n.
## See also ## See also
- [Translation service](../core/translation.service.md) - [Translation service](../core/services/translation.service.md)
- [Language Menu component](../core/language-menu.component.md) - [Language Menu component](../core/components/language-menu.component.md)

View File

@ -13,11 +13,11 @@ most cases, this is used to make small customizations (for example, the various
list components let you supply custom content to show when the list is empty). list components let you supply custom content to show when the list is empty).
However, there are also a few "containers" whose entire content is set by the user However, there are also a few "containers" whose entire content is set by the user
with the container itself being mainly for convenient display and formatting with the container itself being mainly for convenient display and formatting
(for example, the [Info drawer component](../core/info-drawer.component.md)). (for example, the [Info drawer component](../core/components/info-drawer.component.md)).
You supply the content you want to transclude between the opening and closing tags of You supply the content you want to transclude between the opening and closing tags of
the main component. In a few cases, this content can be completely free-form as with the main component. In a few cases, this content can be completely free-form as with
the body section of the [Login component](../core/login.component.md): the body section of the [Login component](../core/components/login.component.md):
```html ```html
<adf-login ...> <adf-login ...>
@ -28,7 +28,7 @@ the body section of the [Login component](../core/login.component.md):
``` ```
More often, though, the main component makes use of one or more sub-components to add More often, though, the main component makes use of one or more sub-components to add
structure to the transclusion. For example, the [Login component](../core/login.component.md) structure to the transclusion. For example, the [Login component](../core/components/login.component.md)
also has sub-components for the header and footer regions in addition to the free-form also has sub-components for the header and footer regions in addition to the free-form
content of the body: content of the body:

View File

@ -9,7 +9,10 @@ var replaceZone = require("mdast-zone");
var graphql_1 = require("graphql"); var graphql_1 = require("graphql");
var MQ = require("../mqDefs"); var MQ = require("../mqDefs");
var libNamesRegex = /content-services|core|extensions|insights|process-services|process-services-cloud/; var libNamesRegex = /content-services|core|extensions|insights|process-services|process-services-cloud/;
var libNamesList = ['content-services', 'core', 'process-services']; var libNamesList = [
'content-services', 'core', 'extensions',
'insights', 'process-services', 'process-services-cloud'
];
var query = "\n query libIndex($libName: String) {\n documents(idFilter: $libName) {\n title: metadata(key: \"Title\")\n status: metadata(key: \"Status\")\n id\n classType: folder(depth: 2)\n heading {\n link {\n url\n }\n }\n paragraph {\n plaintext\n }\n }\n }\n"; var query = "\n query libIndex($libName: String) {\n documents(idFilter: $libName) {\n title: metadata(key: \"Title\")\n status: metadata(key: \"Status\")\n id\n classType: folder(depth: 2)\n heading {\n link {\n url\n }\n }\n paragraph {\n plaintext\n }\n }\n }\n";
function processDocs(mdCache, aggData, _errorMessages) { function processDocs(mdCache, aggData, _errorMessages) {
var docset = new GQDocset(mdCache); var docset = new GQDocset(mdCache);

View File

@ -12,7 +12,10 @@ import { graphql, buildSchema } from 'graphql';
import * as MQ from '../mqDefs'; import * as MQ from '../mqDefs';
let libNamesRegex = /content-services|core|extensions|insights|process-services|process-services-cloud/; let libNamesRegex = /content-services|core|extensions|insights|process-services|process-services-cloud/;
let libNamesList = ['content-services', 'core', 'process-services']; let libNamesList = [
'content-services', 'core', 'extensions',
'insights', 'process-services', 'process-services-cloud'
];
let query = ` let query = `

View File

@ -1,6 +1,6 @@
syntax: syntax:
return: return:
type: >- type: >-
<%- include("type", {type: child.type}).trim() %> <%- child['type'] ? include("type", {type: child.type}).trim() : '' %>
defaultValue: >- defaultValue: >-
<%- (child.defaultValue || "").length < 20 ? child.defaultValue : "" %> <%- (child.defaultValue || "").length < 20 ? child.defaultValue : "" %>

View File

@ -3,7 +3,7 @@ items:
name: <%= name %> name: <%= name %>
fullName: <%= name %> fullName: <%= name %>
source: source:
path: <%= 'lib/' + sources[0].fileName %> path: <%= sources[0].fileName %>
startLine: <%= sources[0].line %> startLine: <%= sources[0].line %>
children: children:
<%_ if (typeof children !== "undefined") { -%> <%_ if (typeof children !== "undefined") { -%>