diff --git a/docs/insights/README.md b/docs/insights/README.md index 87f73b30c8..d2ade5bc8c 100644 --- a/docs/insights/README.md +++ b/docs/insights/README.md @@ -16,7 +16,7 @@ for more information about installing and using the source code. | 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) | +| [Widget component](widget.component.md) | Base class for standard and custom [widget](../../e2e/pages/adf/process_services/widgets/widget.ts) 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) | diff --git a/docs/insights/analytics-generator.component.md b/docs/insights/analytics-generator.component.md index 67f5cb2c74..7931e84b9b 100644 --- a/docs/insights/analytics-generator.component.md +++ b/docs/insights/analytics-generator.component.md @@ -4,7 +4,7 @@ Added: v2.0.0 Status: Active --- -# Analytics Generator Component +# [Analytics Generator Component](../../lib/insights/analytics-process/components/analytics-generator.component.ts "Defined in analytics-generator.component.ts") Generates and shows charts diff --git a/docs/insights/analytics-report-list.component.md b/docs/insights/analytics-report-list.component.md index da20315434..4d478d11e1 100644 --- a/docs/insights/analytics-report-list.component.md +++ b/docs/insights/analytics-report-list.component.md @@ -4,7 +4,7 @@ Added: v2.0.0 Status: Active --- -# APS Analytics List Component +# [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 diff --git a/docs/insights/analytics.component.md b/docs/insights/analytics.component.md index c2049bef1d..1dfa89c4fe 100644 --- a/docs/insights/analytics.component.md +++ b/docs/insights/analytics.component.md @@ -4,7 +4,7 @@ Added: v2.0.0 Status: Active --- -# APS Analytics Component +# [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 diff --git a/docs/insights/diagram.component.md b/docs/insights/diagram.component.md index 1ad3494600..196b6e0482 100644 --- a/docs/insights/diagram.component.md +++ b/docs/insights/diagram.component.md @@ -4,7 +4,7 @@ Added: v2.0.0 Status: Active --- -# Diagram Component +# [Diagram Component](../../lib/insights/diagram/components/diagram.component.ts "Defined in diagram.component.ts") Displays process diagrams. diff --git a/docs/insights/widget.component.md b/docs/insights/widget.component.md index b1d4a06953..e1f012aa46 100644 --- a/docs/insights/widget.component.md +++ b/docs/insights/widget.component.md @@ -5,9 +5,9 @@ Status: Active Last reviewed: 2018-03-29 --- -# Widget component +# [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](../../e2e/pages/adf/process_services/widgets/widget.ts) classes. ## Basic Usage diff --git a/docs/process-services-cloud/README.md b/docs/process-services-cloud/README.md index 86af23afb0..3577a153c3 100644 --- a/docs/process-services-cloud/README.md +++ b/docs/process-services-cloud/README.md @@ -20,17 +20,17 @@ for more information about installing and using the source code. | [Process list cloud component](process-list-cloud.component.md) | Renders a list containing all the process instances matched by the parameters specified. | [Source](../../lib/process-services-cloud/src/lib/process-list-cloud/components/process-list-cloud.component.ts) | | [Task filters cloud component](task-filters-cloud.component.md) | Shows all available filters. | [Source](../../lib/process-services-cloud/src/lib/task-cloud/task-filters-cloud/task-filters-cloud.component.ts) | | [Task list cloud component](task-list-cloud.component.md) | Renders a list containing all the tasks matched by the parameters specified. | [Source](../../lib/process-services-cloud/src/lib/task-list-cloud/components/task-list-cloud.component.ts) | -| _App details cloud component_ | _Not currently documented_ | [Source](../../lib/process-services-cloud/src/lib/app-list-cloud/components/app-details-cloud.component.ts) | -| _Process filters cloud component_ | _Not currently documented_ | [Source](../../lib/process-services-cloud/src/lib/process-cloud/process-filters-cloud/process-filters-cloud.component.ts) | +| _[App details cloud component](../../lib/process-services-cloud/src/lib/app-list-cloud/components/app-details-cloud.component.ts)_ | _Not currently documented_ | [Source](../../lib/process-services-cloud/src/lib/app-list-cloud/components/app-details-cloud.component.ts) | +| _[Process filters cloud component](../process-services-cloud/process-filters-cloud.component.md)_ | _Not currently documented_ | [Source](../../lib/process-services-cloud/src/lib/process-cloud/process-filters-cloud/process-filters-cloud.component.ts) | ## Services | Name | Description | Source link | | ---- | ----------- | ----------- | -| _Apps process cloud service_ | _Not currently documented_ | [Source](../../lib/process-services-cloud/src/lib/app-list-cloud/services/apps-process-cloud.service.ts) | -| _Process filter cloud service_ | _Not currently documented_ | [Source](../../lib/process-services-cloud/src/lib/process-cloud/services/process-filter-cloud.service.ts) | -| _Process list cloud service_ | _Not currently documented_ | [Source](../../lib/process-services-cloud/src/lib/process-list-cloud/services/process-list-cloud.service.ts) | -| _Task filter cloud service_ | _Not currently documented_ | [Source](../../lib/process-services-cloud/src/lib/task-cloud/services/task-filter-cloud.service.ts) | -| _Task list cloud service_ | _Not currently documented_ | [Source](../../lib/process-services-cloud/src/lib/task-list-cloud/services/task-list-cloud.service.ts) | +| _[Apps process cloud service](../../lib/process-services-cloud/src/lib/app-list-cloud/services/apps-process-cloud.service.ts)_ | _Not currently documented_ | [Source](../../lib/process-services-cloud/src/lib/app-list-cloud/services/apps-process-cloud.service.ts) | +| _[Process filter cloud service](../../lib/process-services-cloud/src/lib/process-cloud/services/process-filter-cloud.service.ts)_ | _Not currently documented_ | [Source](../../lib/process-services-cloud/src/lib/process-cloud/services/process-filter-cloud.service.ts) | +| _[Process list cloud service](../../lib/process-services-cloud/src/lib/process-list-cloud/services/process-list-cloud.service.ts)_ | _Not currently documented_ | [Source](../../lib/process-services-cloud/src/lib/process-list-cloud/services/process-list-cloud.service.ts) | +| _[Task filter cloud service](../../lib/process-services-cloud/src/lib/task-cloud/services/task-filter-cloud.service.ts)_ | _Not currently documented_ | [Source](../../lib/process-services-cloud/src/lib/task-cloud/services/task-filter-cloud.service.ts) | +| _[Task list cloud service](../../lib/process-services-cloud/src/lib/task-list-cloud/services/task-list-cloud.service.ts)_ | _Not currently documented_ | [Source](../../lib/process-services-cloud/src/lib/task-list-cloud/services/task-list-cloud.service.ts) | diff --git a/docs/process-services-cloud/app-list-cloud.component.md b/docs/process-services-cloud/app-list-cloud.component.md index 1f66340ab8..cbf0dcd9d9 100644 --- a/docs/process-services-cloud/app-list-cloud.component.md +++ b/docs/process-services-cloud/app-list-cloud.component.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2018-18-10 --- -# App List Cloud Component +# [App List Cloud Component](../../lib/process-services-cloud/src/lib/app-list-cloud/components/app-list-cloud.component.ts "Defined in app-list-cloud.component.ts") Shows all deployed cloud application instances. @@ -43,4 +43,4 @@ You can show custom content when there are no apps available by supplying an | Name | Type | Description | | ---- | ---- | ----------- | -| appClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ApplicationInstanceModel`](../../lib/process-services-cloud/apps-list/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-list-cloud/models/application-instance.model.ts)`>` | Emitted when an app entry is clicked. | diff --git a/docs/process-services-cloud/process-filter-cloud.component.md b/docs/process-services-cloud/process-filters-cloud.component.md similarity index 51% rename from docs/process-services-cloud/process-filter-cloud.component.md rename to docs/process-services-cloud/process-filters-cloud.component.md index d03f85a324..9d8d05ca18 100644 --- a/docs/process-services-cloud/process-filter-cloud.component.md +++ b/docs/process-services-cloud/process-filters-cloud.component.md @@ -4,18 +4,10 @@ Status: Active Last reviewed: 2018-21-11 --- -# Process Filter Cloud Component +# [Process Filters Cloud Component](../../lib/process-services-cloud/src/lib/process-cloud/process-filters-cloud/process-filters-cloud.component.ts "Defined in process-filters-cloud.component.ts") Lists all available process filters and allows to select a filter. -## Contents - -- [Basic Usage](#basic-usage) -- [Class members](#class-members) - - [Properties](#properties) - - [Events](#events) - - ## Basic Usage ```html @@ -32,32 +24,13 @@ Lists all available process filters and allows to select a filter. | Name | Type | Default value | Description | | ---- | ---- | ------------- | ----------- | | appName | `string` | | (required) The application name | -| filterParam | `ProcessFilterParamModel` | | (optional) The filter to be selected by default | +| filterParam | [`ProcessFilterParamModel`](../../lib/process-services-cloud/src/lib/process-cloud/models/process-filter-cloud.model.ts) | | (optional) The filter to be selected by default | | showIcons | `boolean` | false | (optional) The flag hides/shows icon against each filter | ### Events | Name | Type | Description | | ---- | ---- | ----------- | -| filterClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ProcessFilterRepresentationModel`](../../lib/process-services-cloud/src/lib/process-cloud/models/process-filter-cloud.model.ts)`>` | Emitted when a filter is selected/clicked. | -| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when filters are loaded successfully. | -| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when any error occurs while loading the filters. | - -### Details - -The `filterParam` input can be used to select a filter as mentioned below. - -```html - - -``` - -A filter can be selected by using any of the `ProcessFilterParamModel` property. - -| Name | Type | Description | -| ---- | ---- | ----------- | -| id | string | The id of the filter | -| name | string | The name of the filter | -| key | string | The key of the filter | -| index | string | The zero-based position of the filter in the array | \ No newline at end of file +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when any error occurs while loading the filters | +| filterClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ProcessFilterRepresentationModel`](../../lib/process-services-cloud/src/lib/process-cloud/models/process-filter-cloud.model.ts)`>` | Emitted when a filter is selected/clicked | +| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when filters are loaded successfully | diff --git a/docs/process-services-cloud/process-list-cloud.component.md b/docs/process-services-cloud/process-list-cloud.component.md index f798b75177..3d0dd371a9 100644 --- a/docs/process-services-cloud/process-list-cloud.component.md +++ b/docs/process-services-cloud/process-list-cloud.component.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2018-11-09 --- -# Process Instance List Cloud component +# [Process Instance List Cloud component](../../lib/process-services-cloud/src/lib/process-list-cloud/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. diff --git a/docs/process-services-cloud/start-task-cloud.component.md b/docs/process-services-cloud/start-task-cloud.component.md index 218f3de3e3..f1a7fb6aeb 100644 --- a/docs/process-services-cloud/start-task-cloud.component.md +++ b/docs/process-services-cloud/start-task-cloud.component.md @@ -4,7 +4,7 @@ Status: Active Last reviewed: 2018-23-10 --- -# Start Task Cloud Component +# [Start Task Cloud Component](../../lib/process-services-cloud/src/lib/start-task-cloud/components/start-task-cloud.component.ts "Defined in start-task-cloud.component.ts") Creates/Starts new task for the specified app @@ -24,9 +24,9 @@ Creates/Starts new task for the specified app | Name | Type | Default value | Description | | ---- | ---- | ------------- | ----------- | -| appName | `string` | | (required) The name of the app. | -| name | `string` | | Name of the task. | -| maxNameLength | `number` | 255 | Maximum length of the task name. | +| appName | `string` | | (required) Name of the app. | +| maxNameLength | `number` | | Maximum length of the task name. | +| name | `string` | "" | Name of the task. | ### Events diff --git a/docs/process-services-cloud/task-filters-cloud.component.md b/docs/process-services-cloud/task-filters-cloud.component.md index 137bca9b79..b47c00d157 100644 --- a/docs/process-services-cloud/task-filters-cloud.component.md +++ b/docs/process-services-cloud/task-filters-cloud.component.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2018-20-11 --- -# Task Filters Cloud component +# [Task Filters Cloud component](../../lib/process-services-cloud/src/lib/task-cloud/task-filters-cloud/task-filters-cloud.component.ts "Defined in task-filters-cloud.component.ts") Shows all available filters. @@ -54,8 +54,3 @@ as the value of `filterParam` as shown in the table below: | name | string | The name of the task filter, lowercase is checked | | key | string | The key of the task filter | | index | string | The zero-based position of the filter in the array. | - -### How to create an accordion menu with the task filter cloud - -The task filter cloud often works well as an item in an accordion menu. See the -[Material Accordion component]((https://material.angular.io/components/expansion/overview#accordion)) diff --git a/docs/process-services-cloud/task-list-cloud.component.md b/docs/process-services-cloud/task-list-cloud.component.md index f9bf3ef7a7..bb746e9c84 100644 --- a/docs/process-services-cloud/task-list-cloud.component.md +++ b/docs/process-services-cloud/task-list-cloud.component.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2018-11-28 --- -# Task List Cloud component +# [Task List Cloud component](../../lib/process-services-cloud/src/lib/task-list-cloud/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.