inteligr8/alfresco-ng2-components
1
0
Fork 0
mirror of https://github.com/Alfresco/alfresco-ng2-components.git synced 2025-07-24 17:32:15 +00:00
Code Issues Packages Projects Releases Wiki Activity

Documentation build (#6762)

Browse Source 
* move doc dependency in doctools

* add ignore link

* rebuild doc

* version index

* put it back some deps
This commit is contained in:
Eugenio Romano
2021-03-03 14:08:15 +00:00
committed by GitHub
parent e05c80f04f
commit c3452a4f62
227 changed files with 6994 additions and 4146 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/process-services-cloud/components/app-list-cloud.component.md
View File

@@ -46,11 +46,11 @@ For example :
### Properties
| Name | Type | Default value | Description |
| --- | --- | --- | --- |
| ---- | ---- | ------------- | ----------- |
| layoutType | `string` | | (**required**) Defines the layout of the apps. There are two possible values, "GRID" and "LIST". |
### Events
| 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 | `any` | Emitted when an app entry is clicked. |

99
docs/process-services-cloud/components/edit-process-filter-cloud.component.md
View File

@@ -13,17 +13,17 @@ Shows/edits process filter details.
## 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)
* [Saving custom filters](#saving-custom-filters)
* [See also](#see-also)
- [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)
- [Saving custom filters](#saving-custom-filters)
- [See also](#see-also)
## Basic Usage
@@ -42,7 +42,7 @@ Shows/edits process filter details.
### 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 |
@@ -52,13 +52,14 @@ Shows/edits process filter details.
| showProcessFilterName | `boolean` | true | Toggles the appearance of the process filter name . |
| showTitle | `boolean` | true | Toggles editing of the process filter title. |
| sortProperties | `string[]` | | List of sort properties to display. |
| processFilter | [`ProcessFilterCloudModel`](../../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts) | | |
### 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<ProcessFilterCloudModel>` | Emitted when a process instance filter property changes. |
| ---- | ---- | ----------- |
| action | `any` | Emitted when a filter action occurs i.e Save, SaveAs, Delete. |
| filterChange | `any` | Emitted when a process instance filter property changes. |
## Details
@@ -75,28 +76,28 @@ Use the `appName` and `id` properties to choose which process filter to edit:
### Filter properties
You can supply various *filter properties* to edit. These will determine
You can supply various _filter properties_ to edit. These will determine
which processes are found by a filter. The full set of properties is
given below:
| Name | Description |
| -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ |
| ***appName*** | Name of the app |
| ***id*** | Process instance ID |
| ***name*** | 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*** |
| ***sort*** | Field on which the filter results will be sorted. Can be "id", "name", "status", "startDate". |
| ***order*** | Sort ordering of the filter results (this doesn't participate in the filtering itself) |
| Name | Description |
| ---- | ----------- |
| **_appName_** | Name of the app |
| **_id_** | Process instance ID |
| **_name_** | 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_** |
| **_sort_** | Field on which the filter results will be sorted. Can be "id", "name", "status", "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
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***,
***id***, ***name*** and ***lastModified*** properties:
For example, the code below initializes the editor with the **_appName_**,
**_id_**, **_name_** and **_lastModified_** properties:
```ts
export class SomeComponent implements OnInit {
@@ -129,14 +130,14 @@ With this configuration, only the four listed properties will be shown.
### Sort properties
You can supply a list of *sort properties* to sort the processes. You can use
You can supply a list of _sort properties_ to sort the processes. You can use
any of the [filter properties](#filter-properties) listed above as
sort properties and you can also use the process's ***startDate***.
sort properties and you can also use the process's **_startDate_**.
By default, the ***id***, ***name***, ***status*** and ***startDate*** properties are
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:
For example, the code below initializes the editor with the **_startDate_** and **_lastModified_** properties:
```ts
export class SomeComponent implements OnInit {
@@ -166,18 +167,18 @@ With this configuration, only the two listed sort properties will be shown.
### Action properties
You can supply various *actions* to apply on process filter.
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. |
| 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
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:
For example, the code below initializes the editor with the **_save_** and **_delete_** actions:
```ts
export class SomeComponent implements OnInit {
@@ -207,13 +208,13 @@ With this configuration, only the two actions will be shown.
Users can save a filter if they make any changes to it in an application using the **Save** icon. How it is saved is dictated by the Activiti version used:
* An Activiti 7 community version stores saved filters in the local browser storage. This restricts a user's custom filters to that single session.
- An Activiti 7 community version stores saved filters in the local browser storage. This restricts a user's custom filters to that single session.
* An Activiti Enterprise version uses the preference service to store saved filters. This allows for user's custom filters to be available between sessions and between devices.
- An Activiti Enterprise version uses the preference service to store saved filters. This allows for user's custom filters to be available between sessions and between devices.
## See also
* [Edit task filter cloud component](edit-task-filter-cloud.component.md)
* [Process Filter Cloud Service](../services/process-filter-cloud.service.md)
* [Local preference Cloud Service](../services/local-preference-cloud.service.md)
* [User preference Cloud Service](../services/user-preference-cloud.service.md)
- [Edit task filter cloud component](edit-task-filter-cloud.component.md)
- [Process Filter Cloud Service](../services/process-filter-cloud.service.md)
- [Local preference Cloud Service](../services/local-preference-cloud.service.md)
- [User preference Cloud Service](../services/user-preference-cloud.service.md)

110
docs/process-services-cloud/components/edit-task-filter-cloud.component.md
View File

@@ -13,17 +13,17 @@ Edits task filter details.
## 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)
* [Sort properties](#sort-properties)
* [Action properties](#action-properties)
* [Saving custom filters](#saving-custom-filters)
* [See also](#see-also)
- [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)
- [Sort properties](#sort-properties)
- [Action properties](#action-properties)
- [Saving custom filters](#saving-custom-filters)
- [See also](#see-also)
## Basic Usage
@@ -42,7 +42,7 @@ Edits task filter details.
### Properties
| Name | Type | Default value | Description |
| --- | --- | --- | --- |
| ---- | ---- | ------------- | ----------- |
| actions | `string[]` | | List of task filter actions. |
| appName | `string` | "" | (required) Name of the app. |
| filterProperties | `string[]` | \[] | List of task filter properties to display. |
@@ -56,9 +56,9 @@ Edits task filter details.
### Events
| Name | Type | Description |
| --- | --- | --- |
| action | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`TaskFilterAction`](../../../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<>` | Emitted when a task filter property changes. |
| ---- | ---- | ----------- |
| action | `any` | Emitted when a filter action occurs (i.e Save, Save As, Delete). |
| filterChange | `any` | Emitted when a task filter property changes. |
## Details
@@ -75,33 +75,33 @@ Use the `appName` and `id` properties to choose which task filter to edit:
### 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
given below:
| Name | Description |
| ------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| ***appName*** | Name of the app |
| ***status*** | Execution state of the task. |
| ***assignee*** | [`User`](../../../lib/core/pipes/user-initial.pipe.ts) the task is assigned to |
| ***taskName*** | Name of the task |
| ***taskId*** | ID of the task |
| ***parentTaskId*** | ID of the task's parent task |
| ***priority*** | Task priority |
| ***createdDate*** | Date the task was created |
| ***standalone*** | Standalone status of the task |
| ***owner*** | [`User`](../../../lib/core/pipes/user-initial.pipe.ts) ID of the task's owner |
| ***processDefinitionId*** | Process definition ID |
| ***processInstanceId*** | Process instance ID |
| ***lastModified*** | Date the task was last modified. If lastModified defined the component will show the range ***lastModifiedFrom***, ***lastModifiedTo*** |
| ***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). |
| Name | Description |
| ---- | ----------- |
| **_appName_** | Name of the app |
| **_status_** | Execution state of the task. |
| **_assignee_** | [`User`](../../../lib/core/pipes/user-initial.pipe.ts) the task is assigned to |
| **_taskName_** | Name of the task |
| **_taskId_** | ID of the task |
| **_parentTaskId_** | ID of the task's parent task |
| **_priority_** | Task priority |
| **_createdDate_** | Date the task was created |
| **_standalone_** | Standalone status of the task |
| **_owner_** | [`User`](../../../lib/core/pipes/user-initial.pipe.ts) ID of the task's owner |
| **_processDefinitionId_** | Process definition ID |
| **_processInstanceId_** | Process instance ID |
| **_lastModified_** | Date the task was last modified. If lastModified defined the component will show the range **_lastModifiedFrom_**, **_lastModifiedTo_** |
| **_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). |
By default, the ***status***, ***assignee***, ***sort*** and ***order*** properties
By default, the **_status_**, **_assignee_**, **_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***, ***createdDate*** and
***lastModified*** properties:
the editor with the **_appName_**, **_processInstanceId_**, **_createdDate_** and
**_lastModified_** properties:
```ts
import { UserProcessModel } from '@alfresco/adf-core';
@@ -127,15 +127,15 @@ With this configuration, only the four listed properties will be shown.
### Sort properties
You can supply a list of *sort properties* to sort the tasks. You can use
You can supply a list of _sort properties_ to sort the tasks. You can use
any of the [filter properties](#filter-properties) listed above as
sort properties and you can also use the task ***id*** property and
use ***name*** as a shorthand for ***taskName***.
sort properties and you can also use the task **_id_** property and
use **_name_** as a shorthand for **_taskName_**.
By default, the ***id***, ***name***, ***createdDate*** and ***priority*** properties are
By default, the **_id_**, **_name_**, **_createdDate_** and **_priority_** 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 ***createdDate*** , ***lastModified*** and ***priority*** properties:
For example, the code below initializes the editor with the **_createdDate_** , **_lastModified_** and **_priority_** properties:
```ts
export class SomeComponent implements OnInit {
@@ -166,18 +166,18 @@ With this configuration, only the three listed sort properties will be shown.
### Action properties
You can supply various *actions* to apply on task filter.
You can supply various _actions_ to apply on task filter.
| Name | Description |
| ------------ | -------------------------- |
| ***save*** | Save task filter. |
| ***saveAs*** | Creates a new task filter. |
| ***delete*** | Delete task filter. |
| Name | Description |
| ---- | ----------- |
| **_save_** | Save task filter. |
| **_saveAs_** | Creates a new task filter. |
| **_delete_** | Delete task filter. |
By default, the ***save***, ***saveAs*** and ***delete*** actions are
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:
For example, the code below initializes the editor with the **_save_** and **_delete_** actions:
```ts
export class SomeComponent implements OnInit {
@@ -207,13 +207,13 @@ With this configuration, only the two actions will be shown.
Users can save a filter if they make any changes to it in an application using the **Save** icon. How it is saved is dictated by the Activiti version used:
* An Activiti 7 community version stores saved filters in the local browser storage. This restricts a user's custom filters to that single session.
- An Activiti 7 community version stores saved filters in the local browser storage. This restricts a user's custom filters to that single session.
* An Activiti Enterprise version uses the preference service to store saved filters. This allows for user's custom filters to be available between sessions and between devices.
- An Activiti Enterprise version uses the preference service to store saved filters. This allows for user's custom filters to be available between sessions and between devices.
## See also
* [Edit process filter cloud component](edit-process-filter-cloud.component.md)
* [Task filters Cloud Service](../services/task-filter-cloud.service.md)
* [Local preference Cloud Service](../services/local-preference-cloud.service.md)
* [User preference Cloud Service](../services/user-preference-cloud.service.md)
- [Edit process filter cloud component](edit-process-filter-cloud.component.md)
- [Task filters Cloud Service](../services/task-filter-cloud.service.md)
- [Local preference Cloud Service](../services/local-preference-cloud.service.md)
- [User preference Cloud Service](../services/user-preference-cloud.service.md)

60
docs/process-services-cloud/components/form-cloud.component.md
View File

@@ -11,18 +11,18 @@ Shows a [`form`](../../../lib/process-services-cloud/src/lib/form/models/form-cl
## Contents
* [Basic Usage](#basic-usage)
* [Custom form outcomes template](#custom-form-outcomes-template)
* [Empty form template](#empty-form-template)
* [Class members](#class-members)
* [Properties](#properties)
* [Events](#events)
* [Details](#details)
* [Displaying a form](#displaying-a-form)
* [Controlling outcome execution behaviour](#controlling-outcome-execution-behaviour)
* [Field Validators](#field-validators)
* [Common scenarios](#common-scenarios)
* [See also](#see-also)
- [Basic Usage](#basic-usage)
- [Custom form outcomes template](#custom-form-outcomes-template)
- [Empty form template](#empty-form-template)
- [Class members](#class-members)
- [Properties](#properties)
- [Events](#events)
- [Details](#details)
- [Displaying a form](#displaying-a-form)
- [Controlling outcome execution behaviour](#controlling-outcome-execution-behaviour)
- [Field Validators](#field-validators)
- [Common scenarios](#common-scenarios)
- [See also](#see-also)
## Basic Usage
@@ -75,15 +75,15 @@ The template defined inside `empty-form` will be shown when no form definition i
### Properties
| Name | Type | Default value | Description |
| --- | --- | --- | --- |
| ---- | ---- | ------------- | ----------- |
| appName | `string` | "" | App name to fetch corresponding form and values. |
| appVersion | `number` | | The application version to use when fetching data |
| data | [`TaskVariableCloud`](../../../lib/process-services-cloud/src/lib/form/models/task-variable-cloud.model.ts)`[]` | | Custom form values map to be used with the rendered form. |
| disableCompleteButton | `boolean` | false | If true then the `Complete` outcome button is shown but it will be disabled. |
| disableSaveButton | `boolean` | false | If true then the `Save` outcome button is shown but will be disabled. |
| disableStartProcessButton | `boolean` | false | If true then the `Start Process` outcome button is shown but it will be disabled. |
| fieldValidators | [`FormFieldValidator`](../../../lib/core/form/components/widgets/core/form-field-validator.ts)`[]` | | [`FormFieldValidator`](../../../lib/core/form/components/widgets/core/form-field-validator.ts) allow to override the form field validators provided. |
| form | [`FormModel`](../../../lib/core/form/components/widgets/core/form.model.ts) | | Underlying [form model](../../../lib/core/form/components/widgets/core/form.model.ts) instance. |
| fieldValidators | [`FormFieldValidator`](../../../lib/core/form/components/widgets/core/form-field-validator.ts)`[]` | | [FormFieldValidator](../../../lib/core/form/components/widgets/core/form-field-validator.ts) allow to override the form field validators provided. |
| form | [`FormModel`](../../../lib/core/form/components/widgets/core/form.model.ts) | | Underlying form model instance. |
| formId | `string` | | Task id to fetch corresponding form and values. |
| nameNode | `string` | | Name to assign to the new node where the metadata are stored. |
| path | `string` | | Path of the folder where the metadata will be stored. |
@@ -99,15 +99,15 @@ The template defined inside `empty-form` will be shown when no form definition i
### Events
| Name | Type | Description |
| --- | --- | --- |
| ---- | ---- | ----------- |
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when any error occurs. |
| executeOutcome | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormOutcomeEvent`](../../../lib/core/form/components/widgets/core/form-outcome-event.model.ts)`>` | Emitted when any outcome is executed. Default behaviour can be prevented via `event.preventDefault()`. |
| formCompleted | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormModel`](../../../lib/core/form/components/widgets/core/form.model.ts)`>` | Emitted when the form is submitted with the `Complete` outcome. |
| formContentClicked | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ContentLinkModel`](../../../lib/core/form/components/widgets/core/content-link.model.ts)`>` | Emitted when form content is clicked. |
| formDataRefreshed | `EventEmitter<FormModel>` | Emitted when form values are refreshed due to a data property change. |
| formError | `EventEmitter<FormFieldModel[]>` | Emitted when the supplied form values have a validation error. |
| formLoaded | `EventEmitter<FormModel>` | Emitted when the form is loaded or reloaded. |
| formSaved | `EventEmitter<FormModel>` | Emitted when the form is submitted with the `Save` or custom outcomes. |
| formCompleted | `any` | Emitted when the form is submitted with the `Complete` outcome. |
| formContentClicked | `any` | Emitted when form content is clicked. |
| formDataRefreshed | `any` | Emitted when form values are refreshed due to a data property change. |
| formError | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormFieldModel`](../../core/models/form-field.model.md)`[]>` | Emitted when the supplied form values have a validation error. |
| formLoaded | `any` | Emitted when the form is loaded or reloaded. |
| formSaved | `any` | Emitted when the form is submitted with the `Save` or custom outcomes. |
## Details
@@ -166,7 +166,7 @@ In unusual circumstances, you may need to take complete control of form outcome
You can do this by implementing the `executeOutcome` event, which is emitted for both system
outcomes and custom ones.
Note that by default, the code in your `executeOutcome` handler is executed *before* the default
Note that by default, the code in your `executeOutcome` handler is executed _before_ the default
behavior but you can switch the default behavior off using `event.preventDefault()`.
You might want to do this, for example, to provide custom form validation or to show a summary
of the form validation before it is submitted.
@@ -209,8 +209,8 @@ export class MyView {
There are two other functions that can be very useful when you need to control form outcomes:
* `saveTaskForm()` - Saves the current form
* `completeTaskForm(outcome?: string)` Saves and completes the form with a given outcome name
- `saveTaskForm()` - Saves the current form
- `completeTaskForm(outcome?: string)` Saves and completes the form with a given outcome name
### Field Validators
@@ -284,8 +284,8 @@ In the CSS, you can target any outcome ID and change the style as in this exampl
## See also
* [Form Field Validator interface](../../core/interfaces/form-field-validator.interface.md)
* [Extensibility](../../user-guide/extensibility.md)
* [Form rendering service](../../core/services/form-rendering.service.md)
* [Form field model](../../core/models/form-field.model.md)
* [Form cloud service](../services/form-cloud.service.md)
- [Form Field Validator interface](../../core/interfaces/form-field-validator.interface.md)
- [Extensibility](../../user-guide/extensibility.md)
- [Form rendering service](../../core/services/form-rendering.service.md)
- [Form field model](../../core/models/form-field.model.md)
- [Form cloud service](../services/form-cloud.service.md)

4
docs/process-services-cloud/components/form-definition-selector-cloud.component.md
View File

@@ -22,11 +22,11 @@ Allows one form to be selected from a dropdown list. For forms to be displayed i
### Properties
| Name | Type | Default value | Description |
| --- | --- | --- | --- |
| ---- | ---- | ------------- | ----------- |
| appName | `string` | "" | Name of the application. If specified, this shows the users who have access to the app. |
### Events
| Name | Type | Description |
| --- | --- | --- |
| ---- | ---- | ----------- |
| selectForm | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<string>` | Emitted when a form is selected. |

30
docs/process-services-cloud/components/group-cloud.component.md
View File

@@ -11,14 +11,14 @@ Searches Groups.
## Contents
* [Basic Usage](#basic-usage)
* [Class members](#class-members)
* [Properties](#properties)
* [Events](#events)
* [Details](#details)
* [Selection Mode](#selection-mode)
* [Pre-selection](#pre-selection)
* [Read-only](#read-only)
- [Basic Usage](#basic-usage)
- [Class members](#class-members)
- [Properties](#properties)
- [Events](#events)
- [Details](#details)
- [Selection Mode](#selection-mode)
- [Pre-selection](#pre-selection)
- [Read-only](#read-only)
## Basic Usage
@@ -36,7 +36,7 @@ Searches Groups.
### Properties
| Name | Type | Default value | Description |
| --- | --- | --- | --- |
| ---- | ---- | ------------- | ----------- |
| appName | `string` | | Name of the application. If specified this shows the groups who have access to the app. |
| groupChipsCtrl | `FormControl` | | FormControl to list of group |
| mode | [`ComponentSelectionMode`](../../../lib/process-services-cloud/src/lib/types.ts) | "single" | Group selection mode (single/multiple). |
@@ -45,16 +45,16 @@ Searches Groups.
| roles | `string[]` | \[] | Role names of the groups to be listed. |
| searchGroupsControl | `FormControl` | | FormControl to search the group |
| title | `string` | | Title of the field |
| validate | `Boolean` | false | This flag enables the validation on the preSelectGroups 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 preSelectGroups passed as input. In case the flag is true the components call the [identity service](../../../lib/testing/src/lib/core/actions/identity/identity.service.ts) to verify the validity of the information passed as input. Otherwise, no check will be done. |
### Events
| Name | Type | Description |
| --- | --- | --- |
| changedGroups | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`IdentityGroupModel`](../../../lib/core/models/identity-group.model.ts)`[]>` | Emitted when a group selection change. |
| removeGroup | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`IdentityGroupModel`](../../../lib/core/models/identity-group.model.ts)`>` | Emitted when a group is removed. |
| selectGroup | `EventEmitter<IdentityGroupModel>` | Emitted when a group is selected. |
| warning | `EventEmitter<any>` | Emitted when an warning occurs. |
| ---- | ---- | ----------- |
| changedGroups | `any` | Emitted when a group selection change. |
| removeGroup | `any` | Emitted when a group is removed. |
| selectGroup | `any` | Emitted when a group is selected. |
| warning | `any` | Emitted when an warning occurs. |
## Details

20
docs/process-services-cloud/components/people-cloud.component.md
View File

@@ -1,4 +1,4 @@
***
* * *
Title: [People Cloud Component](../../process-services-cloud/components/people-cloud.component.md)
Added: v3.0.0
@@ -24,26 +24,26 @@ Allows one or more users to be selected (with auto-suggestion) based on the inpu
### Properties
| Name | Type | Default value | Description |
| --- | --- | --- | --- |
| ---- | ---- | ------------- | ----------- |
| appName | `string` | | Name of the application. If specified, this shows the users who have access to the app. |
| excludedUsers | [`IdentityUserModel`](../../../lib/core/models/identity-user.model.ts)`[]` | \[] | Array of users to be excluded. Mandatory properties are: id, email, username |
| mode | [`ComponentSelectionMode`](../../../lib/process-services-cloud/src/lib/types.ts) | "single" | [`User`](../../../lib/core/pipes/user-initial.pipe.ts) selection mode (single/multiple). |
| mode | [`ComponentSelectionMode`](../../../lib/process-services-cloud/src/lib/types.ts) | "single" | User selection mode (single/multiple). |
| preSelectUsers | [`IdentityUserModel`](../../../lib/core/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 |
| readOnly | `boolean` | false | Show the info in readonly mode |
| roles | `string[]` | | Role names of the users to be listed. |
| searchUserCtrl | `FormControl` | | FormControl to search the user |
| searchUserCtrl | `any` | | FormControl to search the user |
| title | `string` | | Placeholder translation key |
| userChipsCtrl | `FormControl` | | FormControl to list of users |
| 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](../../../lib/testing/src/lib/core/actions/identity/identity.service.ts) to verify the validity of the information passed as input. Otherwise, no check will be done. |
### Events
| Name | Type | Description |
| --- | --- | --- |
| changedUsers | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`IdentityUserModel`](../../../lib/core/models/identity-user.model.ts)`[]>` | Emitted when a user selection change. |
| removeUser | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`IdentityUserModel`](../../../lib/core/models/identity-user.model.ts)`>` | Emitted when a selected user is removed in multi selection mode. |
| selectUser | `EventEmitter<IdentityUserModel>` | Emitted when a user is selected. |
| warning | `EventEmitter<any>` | Emitted when an warning occurs. |
| ---- | ---- | ----------- |
| changedUsers | `any` | Emitted when a user selection change. |
| removeUser | `any` | Emitted when a selected user is removed in multi selection mode. |
| selectUser | `any` | Emitted when a user is selected. |
| warning | `any` | Emitted when an warning occurs. |
## Details

18
docs/process-services-cloud/components/process-filters-cloud.component.md
View File

@@ -23,7 +23,7 @@ Lists all available process filters and allows to select a filter.
### Properties
| Name | Type | Default value | Description |
| --- | --- | --- | --- |
| ---- | ---- | ------------- | ----------- |
| appName | `string` | "" | (required) The application name |
| filterParam | [`FilterParamsModel`](../../../lib/process-services/src/lib/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 |
@@ -31,14 +31,14 @@ Lists all available process filters and allows to select a filter.
### Events
| Name | Type | Description |
| --- | --- | --- |
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when any error occurs while loading the filters |
| filterClicked | [`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 being clicked from the UI. |
| filterSelected | `EventEmitter<ProcessFilterCloudModel>` | Emitted when a filter is being selected based on the filterParam input. |
| success | `EventEmitter<any>` | Emitted when filters are loaded successfully |
| ---- | ---- | ----------- |
| error | `any` | Emitted when any error occurs while loading the filters |
| filterClicked | `any` | Emitted when a filter is being clicked from the UI. |
| filterSelected | `any` | Emitted when a filter is being selected based on the filterParam input. |
| success | `any` | Emitted when filters are loaded successfully |
## See also
* [Process Filter Cloud Service](./services/process-filter-cloud.service.md)
* [Local preference Cloud Service](./services/local-preference-cloud.service.md)
* [User preference Cloud Service](./services/user-preference-cloud.service.md)
- [Process Filter Cloud Service](./services/process-filter-cloud.service.md)
- [Local preference Cloud Service](./services/local-preference-cloud.service.md)
- [User preference Cloud Service](./services/user-preference-cloud.service.md)

6
docs/process-services-cloud/components/process-header-cloud.component.md
View File

@@ -25,7 +25,7 @@ Shows all the information related to a process instance.
### Properties
| Name | Type | Default value | Description |
| --- | --- | --- | --- |
| ---- | ---- | ------------- | ----------- |
| appName | `string` | "" | (Required) The name of the application. |
| processInstanceId | `string` | | (Required) The id of the process instance. |
@@ -36,7 +36,7 @@ The component populates an internal array of
By default all properties are displayed:
***id***, ***name***, ***status***, ***initiator***, ***startDate***, ***lastModified***, ***parentId***, ***businessKey***.
**_id_**, **_name_**, **_status_**, **_initiator_**, **_startDate_**, **_lastModified_**, **_parentId_**, **_businessKey_**.
However, you can also choose which properties to show using a configuration in `app.config.json`:
@@ -52,4 +52,4 @@ With this configuration, only the four listed properties will be shown.
## See also
* [Process header cloud service](../../process-services-cloud/services/process-header-cloud.service.md)
- [Process header cloud service](../../process-services-cloud/services/process-header-cloud.service.md)

38
docs/process-services-cloud/components/process-list-cloud.component.md
View File

@@ -11,15 +11,15 @@ Renders a list containing all the process instances matched by the parameters sp
## Contents
* [Basic Usage](#basic-usage)
* [Transclusions](#transclusions)
* [Class members](#class-members)
* [Properties](#properties)
* [Events](#events)
* [Details](#details)
* [Setting Sorting Order for the list](#setting-sorting-order-for-the-list)
* [Pagination strategy](#pagination-strategy)
* [See also](#see-also)
- [Basic Usage](#basic-usage)
- [Transclusions](#transclusions)
- [Class members](#class-members)
- [Properties](#properties)
- [Events](#events)
- [Details](#details)
- [Setting Sorting Order for the list](#setting-sorting-order-for-the-list)
- [Pagination strategy](#pagination-strategy)
- [See also](#see-also)
## Basic Usage
@@ -49,7 +49,7 @@ when the process list is empty:
### Properties
| Name | Type | Default value | Description |
| --- | --- | --- | --- |
| ---- | ---- | ------------- | ----------- |
| actionsPosition | `string` | "right" | Position of the actions dropdown menu. Can be "left" or "right". |
| appName | `string` | "" | The name of the application. |
| appVersion | `number \| number[]` | | The version of the application. |
@@ -79,14 +79,14 @@ when the process list is empty:
### Events
| Name | Type | Description |
| --- | --- | --- |
| ---- | ---- | ----------- |
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when an error occurs while loading the list of process instances from the server. |
| executeRowAction | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`DataRowActionEvent`](../../../lib/core/datatable/components/data-row-action.event.ts)`>` | Emitted when the user executes a row action. |
| executeRowAction | `any` | Emitted when the user executes a row action. |
| rowClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<string>` | Emitted when a row in the process list is clicked. |
| rowsSelected | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any[]>` | Emitted when rows are selected/unselected. |
| showRowActionsMenu | `EventEmitter<DataCellEvent>` | Emitted before the actions menu is displayed for a row. |
| showRowContextMenu | `EventEmitter<DataCellEvent>` | Emitted before the context menu is displayed for a row. |
| success | `EventEmitter<any>` | Emitted when the list of process instances has been loaded successfully from the server. |
| showRowActionsMenu | `any` | Emitted before the actions menu is displayed for a row. |
| showRowContextMenu | `any` | Emitted before the context menu is displayed for a row. |
| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when the list of process instances has been loaded successfully from the server. |
## Details
@@ -161,7 +161,7 @@ information defined in `app.config.json` as in the example below:
```
These are all the available columns that can be displayed in this component:
***appName***, ***businessKey***, ***description***, ***id***, ***initiator***, ***lastModified***, ***processName***, ***parentId***, ***processDefinitionId***, ***processDefinitionKey***, and ***status***.
**_appName_**, **_businessKey_**, **_description_**, **_id_**, **_initiator_**, **_lastModified_**, **_processName_**, **_parentId_**, **_processDefinitionId_**, **_processDefinitionKey_**, and **_status_**.
### Setting Sorting Order for the list
@@ -319,6 +319,6 @@ earlier), and perform the corresponding actions.
## See also
* [Data column component](../../core/components/data-column.component.md)
* [Data Table Adapter interface](../../core/interfaces/datatable-adapter.interface.md)
* [Pagination component](../../core/components/pagination.component.md)
- [Data column component](../../core/components/data-column.component.md)
- [Data Table Adapter interface](../../core/interfaces/datatable-adapter.interface.md)
- [Pagination component](../../core/components/pagination.component.md)

32
docs/process-services-cloud/components/start-process-cloud.component.md
View File

@@ -13,14 +13,14 @@ Starts a process.
## Contents
* [Basic Usage](#basic-usage)
* [Class members](#class-members)
* [Properties](#properties)
* [Events](#events)
* [Details](#details)
* [Starting a process with a default name and a pre-selected process definition name](#starting-a-process-with-a-default-name-and-a-pre-selected-process-definition-name)
* [Starting a process with variables](#starting-a-process-with-variables)
* [Starting a process with values passed to the form](#starting-a-process-with-values-passed-to-the-form)
- [Basic Usage](#basic-usage)
- [Class members](#class-members)
- [Properties](#properties)
- [Events](#events)
- [Details](#details)
- [Starting a process with a default name and a pre-selected process definition name](#starting-a-process-with-a-default-name-and-a-pre-selected-process-definition-name)
- [Starting a process with variables](#starting-a-process-with-variables)
- [Starting a process with values passed to the form](#starting-a-process-with-values-passed-to-the-form)
## Basic Usage
@@ -35,24 +35,24 @@ Starts a process.
### Properties
| Name | Type | Default value | Description |
| --- | --- | --- | --- |
| ---- | ---- | ------------- | ----------- |
| appName | `string` | "" | (required) Name of the app. |
| maxNameLength | `number` | | Maximum length of the process name. |
| name | `string` | "" | Name of the process. |
| processDefinitionName | `string` | | Name of the process definition. |
| showSelectProcessDropdown | `boolean` | true | Show/hide the process dropdown list. |
| values | [`TaskVariableCloud`](../../../lib/process-services-cloud/src/lib/form/models/task-variable-cloud.model.ts)`[]` | | Parameter to pass form field values in the start form if one is associated. |
| variables | `Function` | | Variables to attach to the payload. |
| variables | `__type` | | Variables to attach to the payload. |
### Events
| 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 |
| 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. |
| formContentClicked | `EventEmitter<ContentLinkModel>` | Emitted when form content is clicked. |
| processDefinitionSelection | `EventEmitter<ProcessDefinitionCloud>` | Emitted when process definition selection changes. |
| success | `EventEmitter<ProcessInstanceCloud>` | Emitted when the process is successfully started. |
| ---- | ---- | ----------- |
| cancel | `any` | Emitted when the starting process is cancelled |
| error | `any` | Emitted when an error occurs. |
| formContentClicked | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ContentLinkModel`](../../../lib/core/form/components/widgets/core/content-link.model.ts)`>` | Emitted when form content is clicked. |
| processDefinitionSelection | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ProcessDefinitionCloud`](../../../lib/process-services-cloud/src/lib/models/process-definition-cloud.model.ts)`>` | Emitted when process definition selection changes. |
| success | `any` | Emitted when the process is successfully started. |
## Details

6
docs/process-services-cloud/components/start-task-cloud.component.md
View File

@@ -24,7 +24,7 @@ Creates/starts a new task for the specified app.
### Properties
| Name | Type | Default value | Description |
| --- | --- | --- | --- |
| ---- | ---- | ------------- | ----------- |
| appName | `string` | "" | (required) Name of the app. |
| maxNameLength | `number` | | Maximum length of the task name. |
| name | `string` | "" | Name of the task. |
@@ -32,7 +32,7 @@ Creates/starts a new task for the specified app.
### Events
| Name | Type | Description |
| --- | --- | --- |
| ---- | ---- | ----------- |
| cancel | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<void>` | Emitted when the cancel button is clicked by the user. |
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when an error occurs. |
| success | `EventEmitter<any>` | Emitted when the task is successfully created. |
| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when the task is successfully created. |

40
docs/process-services-cloud/components/task-filters-cloud.component.md
View File

@@ -9,6 +9,17 @@ Last reviewed: 2019-01-08
Shows all available filters.
## Contents
- [Basic Usage](#basic-usage)
- [Class members](#class-members)
- [Properties](#properties)
- [Events](#events)
- [Details](#details)
- [Filtering APS2 task filters](#filtering-aps2-task-filters)
- [Showing Filter Counters](#showing-filter-counters)
- [See also](#see-also)
## Basic Usage
```html
@@ -20,7 +31,7 @@ Shows all available filters.
### Properties
| Name | Type | Default value | Description |
| --- | --- | --- | --- |
| ---- | ---- | ------------- | ----------- |
| appName | `string` | "" | Display filters available to the current user for the application with the specified name. |
| filterParam | [`FilterParamsModel`](../../../lib/process-services/src/lib/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. |
@@ -28,11 +39,12 @@ Shows all available filters.
### Events
| Name | Type | Description |
| --- | --- | --- |
| ---- | ---- | ----------- |
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when an error occurs during loading. |
| filterClicked | [`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 is being clicked from the UI. |
| filterSelected | `EventEmitter<TaskFilterCloudModel>` | Emitted when a filter is being selected based on the filterParam input. |
| success | `EventEmitter<any>` | Emitted when the list is loaded. |
| filterClicked | `any` | Emitted when a filter is being clicked from the UI. |
| filterCounterUpdated | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`TaskCloudEngineEvent`](../../../lib/process-services-cloud/src/lib/models/engine-event-cloud.model.ts)`[]>` | Emitted when filter counters are updated. |
| filterSelected | `any` | Emitted when a filter is being selected based on the filterParam input. |
| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when the list is loaded. |
## Details
@@ -49,21 +61,21 @@ Use the `filterParam` property to restrict the range of filters that are shown:
You can use properties from [`FilterParamsModel`](../../../lib/process-services/src/lib/task-list/models/filter.model.ts)
as the value of `filterParam` as shown in the table below:
| Name | Type | Description |
| ----- | ------ | --------------------------------------------------- |
| id | string | The id of the task filter |
| name | string | The name of the task filter, lowercase is checked |
| key | string | The key of the task filter |
| Name | Type | Description |
| ---- | ---- | ----------- |
| id | string | The id of the task filter |
| 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. |
### Showing Filter Counters
By default, filter counters are hidden. If you want to display filter counters you will need to add the `showCounter` property set to `true` in your TaskFilterCloudModel.
By default, filter counters are hidden. If you want to display filter counters you will need to add the `showCounter` property set to `true` in your [TaskFilterCloudModel](../../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts).
![](../../docassets/images/task-filter-counter.png)
## See also
* [Task filter Cloud Service](../services/task-filter-cloud.service.md)
* [Local preference Cloud Service](../services/local-preference-cloud.service.md)
* [User preference Cloud Service](../services/user-preference-cloud.service.md)
- [Task filter Cloud Service](../services/task-filter-cloud.service.md)
- [Local preference Cloud Service](../services/local-preference-cloud.service.md)
- [User preference Cloud Service](../services/user-preference-cloud.service.md)

24
docs/process-services-cloud/components/task-form-cloud.component.md
View File

@@ -34,7 +34,7 @@ Save and Complete buttons get disabled when at least one of the form's inputs ar
### Properties
| Name | Type | Default value | Description |
| --- | --- | --- | --- |
| ---- | ---- | ------------- | ----------- |
| appName | `string` | "" | App id to fetch corresponding form and values. |
| readOnly | `boolean` | false | Toggle readonly state of the task. |
| showCancelButton | `boolean` | true | Toggle rendering of the `Cancel` button. |
@@ -47,18 +47,18 @@ Save and Complete buttons get disabled when at least one of the form's inputs ar
### Events
| Name | Type | Description |
| --- | --- | --- |
| cancelClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<string>` | Emitted when the cancel button is clicked. |
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when any error occurs. |
| formCompleted | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormModel`](../../../lib/core/form/components/widgets/core/form.model.ts)`>` | Emitted when the form is submitted with the `Complete` outcome. |
| ---- | ---- | ----------- |
| cancelClick | `any` | Emitted when the cancel button is clicked. |
| error | `any` | Emitted when any error occurs. |
| formCompleted | `any` | Emitted when the form is submitted with the `Complete` outcome. |
| formContentClicked | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ContentLinkModel`](../../../lib/core/form/components/widgets/core/content-link.model.ts)`>` | Emitted when form content is clicked. |
| formSaved | `EventEmitter<FormModel>` | Emitted when the form is saved. |
| taskClaimed | `EventEmitter<string>` | Emitted when the task is claimed. |
| taskCompleted | `EventEmitter<string>` | Emitted when the task is completed. |
| taskUnclaimed | `EventEmitter<string>` | Emitted when the task is unclaimed. |
| formSaved | `any` | Emitted when the form is saved. |
| taskClaimed | `any` | Emitted when the task is claimed. |
| taskCompleted | `any` | Emitted when the task is completed. |
| taskUnclaimed | `any` | Emitted when the task is unclaimed. |
## See also
* [Form component](./form-cloud.component.md)
* [Form field model](../../core/models/form-field.model.md)
* [Form cloud service](../services/form-cloud.service.md)
- [Form component](./form-cloud.component.md)
- [Form field model](../../core/models/form-field.model.md)
- [Form cloud service](../services/form-cloud.service.md)

8
docs/process-services-cloud/components/task-header-cloud.component.md
View File

@@ -25,7 +25,7 @@ Shows all the information related to a task.
### Properties
| Name | Type | Default value | Description |
| --- | --- | --- | --- |
| ---- | ---- | ------------- | ----------- |
| appName | `string` | "" | (Required) The name of the application. |
| showTitle | `boolean` | true | Show/Hide the task title |
| taskId | `string` | | (Required) The id of the task. |
@@ -33,10 +33,10 @@ Shows all the information related to a task.
### Events
| Name | Type | Description |
| --- | --- | --- |
| ---- | ---- | ----------- |
| claim | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when the task is claimed. |
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when the given task has errors. |
| unclaim | `EventEmitter<any>` | Emitted when the task is unclaimed (ie, requeued). |
| unclaim | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when the task is unclaimed (ie, requeued). |
## Details
@@ -45,7 +45,7 @@ The component populates an internal array of
By default all properties are displayed:
***assignee***, ***status***, ***priority***, ***dueDate***, ***category***, ***parentName***, ***created***, ***id***, ***description***, ***formName***, ***candidateUsers***, ***candidateGroups***.
**_assignee_**, **_status_**, **_priority_**, **_dueDate_**, **_category_**, **_parentName_**, **_created_**, **_id_**, **_description_**, **_formName_**, **_candidateUsers_**, **_candidateGroups_**.
However, you can also choose which properties to show using a configuration in `app.config.json`:

42
docs/process-services-cloud/components/task-list-cloud.component.md
View File

@@ -11,18 +11,18 @@ Renders a list containing all the tasks matched by the parameters specified.
## Contents
* [Basic Usage](#basic-usage)
* [Transclusions](#transclusions)
* [Class members](#class-members)
* [Properties](#properties)
* [Events](#events)
* [Details](#details)
* [Setting the column schema](#setting-the-column-schema)
* [Setting Sorting Order for the list](#setting-sorting-order-for-the-list)
* [Pagination strategy](#pagination-strategy)
* [DataTableAdapter example](#datatableadapter-example)
* [DataColumn Features](#datacolumn-features)
* [See also](#see-also)
- [Basic Usage](#basic-usage)
- [Transclusions](#transclusions)
- [Class members](#class-members)
- [Properties](#properties)
- [Events](#events)
- [Details](#details)
- [Setting the column schema](#setting-the-column-schema)
- [Setting Sorting Order for the list](#setting-sorting-order-for-the-list)
- [Pagination strategy](#pagination-strategy)
- [DataTableAdapter example](#datatableadapter-example)
- [DataColumn Features](#datacolumn-features)
- [See also](#see-also)
## Basic Usage
@@ -50,7 +50,7 @@ when the task list is empty:
### Properties
| Name | Type | Default value | Description |
| --- | --- | --- | --- |
| ---- | ---- | ------------- | ----------- |
| actionsPosition | `string` | "right" | Position of the actions dropdown menu. Can be "left" or "right". |
| appName | `string` | "" | The name of the application. |
| 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). |
@@ -88,14 +88,14 @@ when the task list is empty:
### Events
| Name | Type | Description |
| --- | --- | --- |
| ---- | ---- | ----------- |
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when an error occurs. |
| executeRowAction | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`DataRowActionEvent`](../../../lib/core/datatable/components/data-row-action.event.ts)`>` | Emitted when the user executes a row action. |
| executeRowAction | `any` | Emitted when the user executes a row action. |
| rowClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<string>` | Emitted when a task in the list is clicked |
| rowsSelected | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any[]>` | Emitted when rows are selected/unselected |
| showRowActionsMenu | `EventEmitter<DataCellEvent>` | Emitted before the actions menu is displayed for a row. |
| showRowContextMenu | `EventEmitter<DataCellEvent>` | Emitted before the context menu is displayed for a row. |
| success | `EventEmitter<any>` | Emitted when the task list is loaded |
| showRowActionsMenu | `any` | Emitted before the actions menu is displayed for a row. |
| showRowContextMenu | `any` | Emitted before the context menu is displayed for a row. |
| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when the task list is loaded |
## Details
@@ -344,6 +344,6 @@ earlier), and perform the corresponding actions.
## See also
* [Data column component](../../core/components/data-column.component.md)
* [Data Table Adapter interface](../../core/interfaces/datatable-adapter.interface.md)
* [Pagination component](../../core/components/pagination.component.md)
- [Data column component](../../core/components/data-column.component.md)
- [Data Table Adapter interface](../../core/interfaces/datatable-adapter.interface.md)
- [Pagination component](../../core/components/pagination.component.md)

4
docs/process-services-cloud/directives/claim-task-cloud.directive.md
View File

@@ -20,13 +20,13 @@ Claims a task
### Properties
| Name | Type | Default value | Description |
| --- | --- | --- | --- |
| ---- | ---- | ------------- | ----------- |
| appName | `string` | "" | (Required) The name of the application. |
| taskId | `string` | | (Required) The id of the task. |
### Events
| Name | Type | Description |
| --- | --- | --- |
| ---- | ---- | ----------- |
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when the task cannot be completed. |
| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when the task is completed. |

4
docs/process-services-cloud/directives/complete-task.directive.md
View File

@@ -20,13 +20,13 @@ Completes a task.
### Properties
| Name | Type | Default value | Description |
| --- | --- | --- | --- |
| ---- | ---- | ------------- | ----------- |
| appName | `string` | "" | (Required) The name of the application. |
| taskId | `string` | | (Required) The id of the task. |
### Events
| Name | Type | Description |
| --- | --- | --- |
| ---- | ---- | ----------- |
| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when the task cannot be completed. |
| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when the task is completed. |

17
docs/process-services-cloud/services/apps-process-cloud.service.md
View File

@@ -13,15 +13,16 @@ Gets details of deployed apps for the current user.
### Methods
* **getDeployedApplicationsByStatus**(status: `string`, role?: `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`, role?: `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.
* *status:* `string` - Required status value
* *role:* `string` - (Optional) to filter the 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
* **hasDeployedApps**(): `boolean`<br/>
- _status:_ `string` - Required status value
- _role:_ `string` - (Optional) to filter the 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
- **hasDeployedApps**(): `boolean`<br/>
* **Returns** `boolean` -
* **loadApps**()<br/>
- **Returns** `boolean` -
- **loadApps**()<br/>
## Details
@@ -30,4 +31,4 @@ with modifications for cloud use.
## See also
* [Apps process service](../../core/services/apps-process.service.md)
- [Apps process service](../../core/services/apps-process.service.md)

104
docs/process-services-cloud/services/form-cloud.service.md
View File

@@ -26,67 +26,69 @@ class MyComponent {
### Methods
* **completeTaskForm**(appName: `string`, taskId: `string`, processInstanceId: `string`, formId: `string`, formValues: [`FormValues`](../../../lib/core/form/components/widgets/core/form-values.ts), outcome: `string`, version: `number`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts)`>`<br/>
- **completeTaskForm**(appName: `string`, taskId: `string`, processInstanceId: `string`, formId: `string`, formValues: [`FormValues`](../../../lib/core/form/components/widgets/core/form-values.ts), outcome: `string`, version: `number`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts)`>`<br/>
Completes a task form.
* *appName:* `string` - Name of the app
* *taskId:* `string` - ID of the target task
* *processInstanceId:* `string` - ID of processInstance
* *formId:* `string` - ID of the form to complete
* *formValues:* [`FormValues`](../../../lib/core/form/components/widgets/core/form-values.ts) - [Form](../../../lib/process-services/src/lib/task-list/models/form.model.ts) values object
* *outcome:* `string` - [Form](../../../lib/process-services/src/lib/task-list/models/form.model.ts) outcome
* *version:* `number` - of the form
* **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts)`>` - Updated task details
* **createTemporaryRawRelatedContent**(file: `any`, nodeId: `string`, contentHost: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
- _appName:_ `string` - Name of the app
- _taskId:_ `string` - ID of the target task
- _processInstanceId:_ `string` - ID of processInstance
- _formId:_ `string` - ID of the form to complete
- _formValues:_ [`FormValues`](../../../lib/core/form/components/widgets/core/form-values.ts) - [Form](../../../lib/process-services/src/lib/task-list/models/form.model.ts) values object
- _outcome:_ `string` - [Form](../../../lib/process-services/src/lib/task-list/models/form.model.ts) outcome
- _version:_ `number` - of the form
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts)`>` - Updated task details
- **createTemporaryRawRelatedContent**(file: `any`, nodeId: `string`, contentHost: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
* *file:* `any` -
* *nodeId:* `string` -
* *contentHost:* `string` -
* **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` -
* **getBasePath**(appName: `string`): `string`<br/>
- _file:_ `any` -
- _nodeId:_ `string` -
- _contentHost:_ `string` -
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` -
* *appName:* `string` -
* **Returns** `string` -
* **getDropDownJsonData**(url: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
- **getBasePath**(appName: `string`): `string`<br/>
- _appName:_ `string` -
- **Returns** `string` -
- **getDropDownJsonData**(url: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
Parses JSON data to create a corresponding form.
* *url:* `string` - String data to make the request
* **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - Array of FormFieldOption object
* **getForm**(appName: `string`, formKey: `string`, version?: `number`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`FormContent`](../../../lib/process-services-cloud/src/lib/services/form-fields.interfaces.ts)`>`<br/>
- _url:_ `string` - String data to make the request
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - Array of FormFieldOption object
- **getForm**(appName: `string`, formKey: `string`, version?: `number`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`FormContent`](../../../lib/process-services-cloud/src/lib/services/form-fields.interfaces.ts)`>`<br/>
Gets a form definition.
* *appName:* `string` - Name of the app
* *formKey:* `string` - key of the target task
* *version:* `number` - (Optional) Version of the form
* **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`FormContent`](../../../lib/process-services-cloud/src/lib/services/form-fields.interfaces.ts)`>` - Form definition
* **getTask**(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/>
- _appName:_ `string` - Name of the app
- _formKey:_ `string` - key of the target task
- _version:_ `number` - (Optional) Version of the form
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`FormContent`](../../../lib/process-services-cloud/src/lib/services/form-fields.interfaces.ts)`>` - Form definition
- **getTask**(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
* *appName:* `string` - Name of the app
* *taskId:* `string` - ID of the target task
* **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 task
* **getTaskForm**(appName: `string`, taskId: `string`, version?: `number`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
- _appName:_ `string` - Name of the app
- _taskId:_ `string` - ID of the target task
- **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 task
- **getTaskForm**(appName: `string`, taskId: `string`, version?: `number`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
Gets the form definition of a task.
* *appName:* `string` - Name of the app
* *taskId:* `string` - ID of the target task
* *version:* `number` - (Optional) Version of the form
* **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - Form definition
* **getTaskVariables**(appName: `string`, taskId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskVariableCloud`](../../../lib/process-services-cloud/src/lib/form/models/task-variable-cloud.model.ts)`[]>`<br/>
- _appName:_ `string` - Name of the app
- _taskId:_ `string` - ID of the target task
- _version:_ `number` - (Optional) Version of the form
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - Form definition
- **getTaskVariables**(appName: `string`, taskId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskVariableCloud`](../../../lib/process-services-cloud/src/lib/form/models/task-variable-cloud.model.ts)`[]>`<br/>
Gets the variables of a task.
* *appName:* `string` - Name of the app
* *taskId:* `string` - ID of the target task
* **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskVariableCloud`](../../../lib/process-services-cloud/src/lib/form/models/task-variable-cloud.model.ts)`[]>` - Task variables
* **parseForm**(json: `any`, data?: [`TaskVariableCloud`](../../../lib/process-services-cloud/src/lib/form/models/task-variable-cloud.model.ts)`[]`, readOnly: `boolean` = `false`): [`FormModel`](../../../lib/core/form/components/widgets/core/form.model.ts)<br/>
- _appName:_ `string` - Name of the app
- _taskId:_ `string` - ID of the target task
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskVariableCloud`](../../../lib/process-services-cloud/src/lib/form/models/task-variable-cloud.model.ts)`[]>` - Task variables
- **parseForm**(json: `any`, data?: [`TaskVariableCloud`](../../../lib/process-services-cloud/src/lib/form/models/task-variable-cloud.model.ts)`[]`, readOnly: `boolean` = `false`): [`FormModel`](../../../lib/core/form/components/widgets/core/form.model.ts)<br/>
Parses JSON data to create a corresponding form.
* *json:* `any` - JSON data to create the form
* *data:* [`TaskVariableCloud`](../../../lib/process-services-cloud/src/lib/form/models/task-variable-cloud.model.ts)`[]` - (Optional) Values for the form's fields
* *readOnly:* `boolean` - Toggles whether or not the form should be read-only
* **Returns** [`FormModel`](../../../lib/core/form/components/widgets/core/form.model.ts) - [Form](../../../lib/process-services/src/lib/task-list/models/form.model.ts) created from the JSON specification
* **saveTaskForm**(appName: `string`, taskId: `string`, processInstanceId: `string`, formId: `string`, values: [`FormValues`](../../../lib/core/form/components/widgets/core/form-values.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/>
- _json:_ `any` - JSON data to create the form
- _data:_ [`TaskVariableCloud`](../../../lib/process-services-cloud/src/lib/form/models/task-variable-cloud.model.ts)`[]` - (Optional) Values for the form's fields
- _readOnly:_ `boolean` - Toggles whether or not the form should be read-only
- **Returns** [`FormModel`](../../../lib/core/form/components/widgets/core/form.model.ts) - [Form](../../../lib/process-services/src/lib/task-list/models/form.model.ts) created from the JSON specification
- **saveTaskForm**(appName: `string`, taskId: `string`, processInstanceId: `string`, formId: `string`, values: [`FormValues`](../../../lib/core/form/components/widgets/core/form-values.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/>
Saves a task form.
* *appName:* `string` - Name of the app
* *taskId:* `string` - ID of the target task
* *processInstanceId:* `string` - ID of processInstance
* *formId:* `string` - ID of the form to save
* *values:* [`FormValues`](../../../lib/core/form/components/widgets/core/form-values.ts) - [Form](../../../lib/process-services/src/lib/task-list/models/form.model.ts) values object
* **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts)`>` - Updated task details
- _appName:_ `string` - Name of the app
- _taskId:_ `string` - ID of the target task
- _processInstanceId:_ `string` - ID of processInstance
- _formId:_ `string` - ID of the form to save
- _values:_ [`FormValues`](../../../lib/core/form/components/widgets/core/form-values.ts) - [Form](../../../lib/process-services/src/lib/task-list/models/form.model.ts) values object
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts)`>` - Updated task details
## See also
* [Form cloud component](../components/form-cloud.component.md)
- [Form cloud component](../components/form-cloud.component.md)

52
docs/process-services-cloud/services/group-cloud.service.md
View File

@@ -13,39 +13,39 @@ Searches and gets information for groups.
### Methods
* **checkGroupHasAnyClientAppRole**(groupId: `string`, clientId: `string`, roleNames: `string[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<boolean>`<br/>
- **checkGroupHasAnyClientAppRole**(groupId: `string`, clientId: `string`, roleNames: `string[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<boolean>`<br/>
Check if a group has any of the client app roles in the supplied list.
* *groupId:* `string` - ID of the target group
* *clientId:* `string` - ID of the client
* *roleNames:* `string[]` - Array of role names to check
* **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<boolean>` - True if the group has one or more of the roles, false otherwise
* **checkGroupHasClientApp**(groupId: `string`, clientId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<boolean>`<br/>
- _groupId:_ `string` - ID of the target group
- _clientId:_ `string` - ID of the client
- _roleNames:_ `string[]` - Array of role names to check
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<boolean>` - True if the group has one or more of the roles, false otherwise
- **checkGroupHasClientApp**(groupId: `string`, clientId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<boolean>`<br/>
Checks if a group has a client app.
* *groupId:* `string` - ID of the target group
* *clientId:* `string` - ID of the client
* **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<boolean>` - True if the group has the client app, false otherwise
* **checkGroupHasRole**(groupId: `string`, roleNames: `string[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<boolean>`<br/>
- _groupId:_ `string` - ID of the target group
- _clientId:_ `string` - ID of the client
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<boolean>` - True if the group has the client app, false otherwise
- **checkGroupHasRole**(groupId: `string`, roleNames: `string[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<boolean>`<br/>
Check that a group has one or more roles from the supplied list.
* *groupId:* `string` - ID of the target group
* *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
* **findGroupsByName**(searchParams: [`GroupSearchParam`](../../../lib/process-services-cloud/src/lib/group/models/group.model.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
- _groupId:_ `string` - ID of the target group
- _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
- **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.
* *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
* **getClientIdByApplicationName**(applicationName: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<string>`<br/>
- _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
- **getClientIdByApplicationName**(applicationName: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<string>`<br/>
Gets the client ID using the app name.
* *applicationName:* `string` - Name of the app
* **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<string>` - client ID string
* **getClientRoles**(groupId: `string`, clientId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any[]>`<br/>
- _applicationName:_ `string` - Name of the app
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<string>` - client ID string
- **getClientRoles**(groupId: `string`, clientId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any[]>`<br/>
Gets client roles.
* *groupId:* `string` - ID of the target group
* *clientId:* `string` - ID of the client
* **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any[]>` - List of roles
* **getGroupRoles**(groupId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`GroupRoleModel`](../../../lib/process-services-cloud/src/lib/group/models/group.model.ts)`[]>`<br/>
- _groupId:_ `string` - ID of the target group
- _clientId:_ `string` - ID of the client
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any[]>` - List of roles
- **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.
* *groupId:* `string` - ID of the target group
* **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`GroupRoleModel`](../../../lib/process-services-cloud/src/lib/group/models/group.model.ts)`[]>` - Group details
- _groupId:_ `string` - ID of the target group
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`GroupRoleModel`](../../../lib/process-services-cloud/src/lib/group/models/group.model.ts)`[]>` - Group details
## Details

53
docs/process-services-cloud/services/local-preference-cloud.service.md
View File

@@ -13,38 +13,39 @@ Manages Local Storage preferences.
### Methods
* **createPreference**(\_: `string`, key: `string`, newPreference: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
- **createPreference**(\_: `string`, key: `string`, newPreference: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
Creates local preference.
* *\_:* `string` - Name of the target app
* *key:* `string` - Key of the target preference
* *newPreference:* `any` - Details of new local preference
* **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - Observable of created local preferences
* **deletePreference**(key: `string`, preferences: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
- _\_:_ `string` - Name of the target app
- _key:_ `string` - Key of the target preference
- _newPreference:_ `any` - Details of new local preference
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - Observable of created local preferences
- **deletePreference**(key: `string`, preferences: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
Deletes local preference by given preference key.
* *key:* `string` - Key of the target preference
* *preferences:* `any` - Details of updated preferences
* **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - Observable of preferences without deleted preference
* **getPreferenceByKey**(\_: `string`, key: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
- _key:_ `string` - Key of the target preference
- _preferences:_ `any` - Details of updated preferences
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - Observable of preferences without deleted preference
- **getPreferenceByKey**(\_: `string`, key: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
Gets local preference.
* *\_:* `string` - Name of the target app
* *key:* `string` - Key of the target preference
* **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - Observable of local preference
* **getPreferences**(\_: `string`, key: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
- _\_:_ `string` - Name of the target app
- _key:_ `string` - Key of the target preference
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - Observable of local preference
- **getPreferences**(\_: `string`, key: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
Gets local preferences
* *\_:* `string` - Name of the target app
* *key:* `string` - Key of the target preference
* **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - List of local preferences
* **prepareLocalPreferenceResponse**(key: `string`): `any`<br/>
- _\_:_ `string` - Name of the target app
- _key:_ `string` - Key of the target preference
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - List of local preferences
- **prepareLocalPreferenceResponse**(key: `string`): `any`<br/>
* *key:* `string` -
* **Returns** `any` -
* **updatePreference**(\_: `string`, key: `string`, updatedPreference: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
- _key:_ `string` -
- **Returns** `any` -
- **updatePreference**(\_: `string`, key: `string`, updatedPreference: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
Updates local preference.
* *\_:* `string` - Name of the target app
* *key:* `string` - Key of the target preference
* *updatedPreference:* `any` - Details of updated preference
* **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - Observable of updated local preferences
- _\_:_ `string` - Name of the target app
- _key:_ `string` - Key of the target preference
- _updatedPreference:_ `any` - Details of updated preference
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - Observable of updated local preferences
## See also
* [User preference Cloud Service](user-preference-cloud.service.md)
- [User preference Cloud Service](user-preference-cloud.service.md)

39
docs/process-services-cloud/services/process-cloud.service.md
View File

@@ -13,28 +13,29 @@ Manages cloud process instances.
### Methods
* **cancelProcess**(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/>
- **cancelProcess**(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/>
Cancels a process.
* *appName:* `string` - Name of the app
* *processInstanceId:* `string` - Id of the process to cancel
* **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessInstanceCloud`](../../../lib/process-services-cloud/src/lib/process/start-process/models/process-instance-cloud.model.ts)`>` - Operation Information
* **getApplicationVersions**(appName: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ApplicationVersionModel`](../../../lib/process-services-cloud/src/lib/models/application-version.model.ts)`[]>`<br/>
- _appName:_ `string` - Name of the app
- _processInstanceId:_ `string` - Id of the process to cancel
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessInstanceCloud`](../../../lib/process-services-cloud/src/lib/process/start-process/models/process-instance-cloud.model.ts)`>` - Operation Information
- **getApplicationVersions**(appName: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ApplicationVersionModel`](../../../lib/process-services-cloud/src/lib/models/application-version.model.ts)`[]>`<br/>
Gets the application versions associated with an app.
* *appName:* `string` - Name of the target app
* **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ApplicationVersionModel`](../../../lib/process-services-cloud/src/lib/models/application-version.model.ts)`[]>` - Array of Application Version Models
* **getBasePath**(appName: `string`): `string`<br/>
- _appName:_ `string` - Name of the target app
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ApplicationVersionModel`](../../../lib/process-services-cloud/src/lib/models/application-version.model.ts)`[]>` - Array of Application Version Models
- **getBasePath**(appName: `string`): `string`<br/>
* *appName:* `string` -
* **Returns** `string` -
* **getProcessDefinitions**(appName: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessDefinitionCloud`](../../../lib/process-services-cloud/src/lib/models/process-definition-cloud.model.ts)`[]>`<br/>
- _appName:_ `string` -
- **Returns** `string` -
- **getProcessDefinitions**(appName: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessDefinitionCloud`](../../../lib/process-services-cloud/src/lib/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/models/process-definition-cloud.model.ts)`[]>` - Array of process definitions
* **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/>
- _appName:_ `string` - Name of the target app
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessDefinitionCloud`](../../../lib/process-services-cloud/src/lib/models/process-definition-cloud.model.ts)`[]>` - Array of process definitions
- **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
- _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
@@ -45,5 +46,5 @@ but they use the cloud variants of the classes for return values. See the
## See also
* [Process list Cloud Service](process-list-cloud.service.md)
* [Process header cloud component](../../process-services-cloud/components/process-header-cloud.component.md)
- [Process list Cloud Service](process-list-cloud.service.md)
- [Process header cloud component](../../process-services-cloud/components/process-header-cloud.component.md)

54
docs/process-services-cloud/services/process-filter-cloud.service.md
View File

@@ -13,31 +13,43 @@ Manage Process Filters, which are pre-configured Process Instance queries.
### Methods
* **addFilter**(newFilter: [`ProcessFilterCloudModel`](../../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessFilterCloudModel`](../../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts)`[]>`<br/>
- **addFilter**(newFilter: [`ProcessFilterCloudModel`](../../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessFilterCloudModel`](../../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts)`[]>`<br/>
Adds a new process instance filter
* *newFilter:* [`ProcessFilterCloudModel`](../../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts) -
* **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 instance filters with newly added filter
* **deleteFilter**(deletedFilter: [`ProcessFilterCloudModel`](../../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessFilterCloudModel`](../../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts)`[]>`<br/>
- _newFilter:_ [`ProcessFilterCloudModel`](../../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts) -
- **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 instance filters with newly added filter
- **deleteFilter**(deletedFilter: [`ProcessFilterCloudModel`](../../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessFilterCloudModel`](../../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts)`[]>`<br/>
Delete process instance filter
* *deletedFilter:* [`ProcessFilterCloudModel`](../../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts) -
* **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 instance filters without deleted filter
* **getFilterById**(appName: `string`, id: `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/>
- _deletedFilter:_ [`ProcessFilterCloudModel`](../../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts) -
- **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 instance filters without deleted filter
- **getFilterById**(appName: `string`, id: `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/>
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** [`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 instance filter details
* **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/>
- _appName:_ `string` - Name of the target app
- _id:_ `string` - Id of the target process instance filter
- **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 instance filter details
- **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 filters details
* **isDefaultFilter**(filterName: `string`): `boolean`<br/>
- _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 filters details
- **isDefaultFilter**(filterName: `string`): `boolean`<br/>
Checks if given filter is a default filter
* *filterName:* `string` - Name of the target process filter
* **Returns** `boolean` - Boolean value for whether the filter is a default filter
* **updateFilter**(updatedFilter: [`ProcessFilterCloudModel`](../../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessFilterCloudModel`](../../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts)`[]>`<br/>
- _filterName:_ `string` - Name of the target process filter
- **Returns** `boolean` - Boolean value for whether the filter is a default filter
- **readQueryParams**(obj: `Object`): [`ProcessFilterCloudModel`](../../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts)<br/>
- _obj:_ `Object` -
- **Returns** [`ProcessFilterCloudModel`](../../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts) -
- **updateFilter**(updatedFilter: [`ProcessFilterCloudModel`](../../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessFilterCloudModel`](../../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts)`[]>`<br/>
Update process instance filter
* *updatedFilter:* [`ProcessFilterCloudModel`](../../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts) -
* **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 instance filters with updated filter
- _updatedFilter:_ [`ProcessFilterCloudModel`](../../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts) -
- **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 instance filters with updated filter
- **writeQueryParams**(value: `Object`, filterProperties: `string[]`, appName?: `string`, id?: `string`): `Object`<br/>
- _value:_ `Object` -
- _filterProperties:_ `string[]` -
- _appName:_ `string` - (Optional)
- _id:_ `string` - (Optional)
- **Returns** `Object` -
## Inject Preference service
@@ -81,5 +93,5 @@ export class ExampleModule {}
## See also
* [Process filters cloud component](../components/process-filters-cloud.component.md)
* [Task filter cloud service](task-filter-cloud.service.md)
- [Process filters cloud component](../components/process-filters-cloud.component.md)
- [Task filter cloud service](task-filter-cloud.service.md)

16
docs/process-services-cloud/services/process-list-cloud.service.md
View File

@@ -13,14 +13,16 @@ Searches processes.
### Methods
* **getBasePath**(appName: `string`): `string`<br/>
- **getBasePath**(appName: `string`): `string`<br/>
* *appName:* `string` -
* **Returns** `string` -
* **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/>
- _appName:_ `string` -
- **Returns** `string` -
- **getProcessByRequest**(requestNode: [`ProcessQueryCloudRequestModel`](../../../lib/process-services-cloud/src/lib/process/process-list/models/process-cloud-query-request.model.ts), queryUrl?: `string`): [`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
- _requestNode:_ [`ProcessQueryCloudRequestModel`](../../../lib/process-services-cloud/src/lib/process/process-list/models/process-cloud-query-request.model.ts) - Query object
- _queryUrl:_ `string` - (Optional) Query url
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - Process information
## Details
@@ -40,4 +42,4 @@ For example :
## See also
* [App list cloud component](../components/app-list-cloud.component.md)
- [App list cloud component](../components/app-list-cloud.component.md)

59
docs/process-services-cloud/services/start-process-cloud.service.md
View File

@@ -13,41 +13,42 @@ Gets process definitions and starts processes.
### Methods
* **createProcess**(appName: `string`, payload: [`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/>
- **createProcess**(appName: `string`, payload: [`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/>
Create a process based on a process definition, name, form values or variables.
* *appName:* `string` - name of the [Application](../../../lib/testing/src/lib/core/structure/application.ts)
* *payload:* [`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 created
* **deleteProcess**(appName: `string`, processInstanceId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<void>`<br/>
- _appName:_ `string` - name of the [Application](../../../lib/testing/src/lib/core/structure/application.ts)
- _payload:_ [`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 created
- **deleteProcess**(appName: `string`, processInstanceId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<void>`<br/>
Delete an existing process instance
* *appName:* `string` - name of the [Application](../../../lib/testing/src/lib/core/structure/application.ts)
* *processInstanceId:* `string` - process instance to update
* **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<void>` -
* **getBasePath**(appName: `string`): `string`<br/>
- _appName:_ `string` - name of the [Application](../../../lib/testing/src/lib/core/structure/application.ts)
- _processInstanceId:_ `string` - process instance to update
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<void>` -
- **getBasePath**(appName: `string`): `string`<br/>
* *appName:* `string` -
* **Returns** `string` -
* **getProcessDefinitions**(appName: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessDefinitionCloud`](../../../lib/process-services-cloud/src/lib/models/process-definition-cloud.model.ts)`[]>`<br/>
- _appName:_ `string` -
- **Returns** `string` -
- **getProcessDefinitions**(appName: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessDefinitionCloud`](../../../lib/process-services-cloud/src/lib/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/models/process-definition-cloud.model.ts)`[]>` - Array of process definitions
* **startCreatedProcess**(appName: `string`, createdProcessInstanceId: `string`, payload: [`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/>
- _appName:_ `string` - Name of the target app
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessDefinitionCloud`](../../../lib/process-services-cloud/src/lib/models/process-definition-cloud.model.ts)`[]>` - Array of process definitions
- **startCreatedProcess**(appName: `string`, createdProcessInstanceId: `string`, payload: [`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 an already created process using the process instance id.
* *appName:* `string` -
* *createdProcessInstanceId:* `string` - process instance id of the process previously created
* *payload:* [`ProcessPayloadCloud`](../../../lib/process-services-cloud/src/lib/process/start-process/models/process-payload-cloud.model.ts) -
* **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
* **startProcess**(appName: `string`, payload: [`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/>
- _appName:_ `string` -
- _createdProcessInstanceId:_ `string` - process instance id of the process previously created
- _payload:_ [`ProcessPayloadCloud`](../../../lib/process-services-cloud/src/lib/process/start-process/models/process-payload-cloud.model.ts) -
- **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
- **startProcess**(appName: `string`, payload: [`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](../../../lib/testing/src/lib/core/structure/application.ts)
* *payload:* [`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
* **updateProcess**(appName: `string`, processInstanceId: `string`, payload: [`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/>
- _appName:_ `string` - name of the [Application](../../../lib/testing/src/lib/core/structure/application.ts)
- _payload:_ [`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
- **updateProcess**(appName: `string`, processInstanceId: `string`, payload: [`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/>
Update an existing process instance
* *appName:* `string` - name of the [Application](../../../lib/testing/src/lib/core/structure/application.ts)
* *processInstanceId:* `string` - process instance to update
* *payload:* [`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
- _appName:_ `string` - name of the [Application](../../../lib/testing/src/lib/core/structure/application.ts)
- _processInstanceId:_ `string` - process instance to update
- _payload:_ [`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
@@ -59,4 +60,4 @@ combines the process details and variables conveniently into the
## See also
* [Process service](../../process-services/services/process.service.md)
- [Process service](../../process-services/services/process.service.md)

16
docs/process-services-cloud/services/start-task-cloud.service.md
View File

@@ -13,14 +13,14 @@ Starts standalone tasks.
### 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/>
(**Deprecated:** in 3.5.0, use TaskCloudService instead. 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
* **getBasePath**(appName: `string`): `string`<br/>
- **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/>
(**Deprecated:** in 3.5.0, use TaskCloudService instead. 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
- **getBasePath**(appName: `string`): `string`<br/>
* *appName:* `string` -
* **Returns** `string` -
- _appName:_ `string` -
- **Returns** `string` -
## Details
@@ -31,4 +31,4 @@ but uses the cloud variants of the classes for the parameter and return value. S
## See also
* [Tasklist service](../../process-services/services/tasklist.service.md)
- [Tasklist service](../../process-services/services/tasklist.service.md)

135
docs/process-services-cloud/services/task-cloud.service.md
View File

@@ -13,88 +13,91 @@ Manages task cloud.
### Methods
* **assign**(appName: `string`, taskId: `string`, assignee: `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/>
- **assign**(appName: `string`, taskId: `string`, assignee: `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/>
Updates the task assignee.
* *appName:* `string` - Name of the app
* *taskId:* `string` - ID of the task to update assignee
* *assignee:* `string` - assignee to update current user task assignee
* **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts)`>` - Updated task details with new assignee
* **canClaimTask**(taskDetails: [`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts)): `boolean`<br/>
- _appName:_ `string` - Name of the app
- _taskId:_ `string` - ID of the task to update assignee
- _assignee:_ `string` - assignee to update current user task assignee
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts)`>` - Updated task details with new assignee
- **canClaimTask**(taskDetails: [`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts)): `boolean`<br/>
Validate if a task can be claimed.
* *taskDetails:* [`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts) - task details object
* **Returns** `boolean` - Boolean value if the task can be completed
* **canCompleteTask**(taskDetails: [`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts)): `boolean`<br/>
- _taskDetails:_ [`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts) - task details object
- **Returns** `boolean` - Boolean value if the task can be completed
- **canCompleteTask**(taskDetails: [`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts)): `boolean`<br/>
Validate if a task can be completed.
* *taskDetails:* [`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts) - task details object
* **Returns** `boolean` - Boolean value if the task can be completed
* **canUnclaimTask**(taskDetails: [`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts)): `boolean`<br/>
- _taskDetails:_ [`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts) - task details object
- **Returns** `boolean` - Boolean value if the task can be completed
- **canUnclaimTask**(taskDetails: [`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts)): `boolean`<br/>
Validate if a task can be unclaimed.
* *taskDetails:* [`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts) - task details object
* **Returns** `boolean` - Boolean value if the task can be completed
* **claimTask**(appName: `string`, taskId: `string`, assignee: `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/>
- _taskDetails:_ [`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts) - task details object
- **Returns** `boolean` - Boolean value if the task can be completed
- **claimTask**(appName: `string`, taskId: `string`, assignee: `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/>
Claims a task for an assignee.
* *appName:* `string` - Name of the app
* *taskId:* `string` - ID of the task to claim
* *assignee:* `string` - [User](../../../lib/core/pipes/user-initial.pipe.ts) to assign the task to
* **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 claimed task
* **completeTask**(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/>
- _appName:_ `string` - Name of the app
- _taskId:_ `string` - ID of the task to claim
- _assignee:_ `string` - User to assign the task to
- **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 claimed task
- **completeTask**(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/>
Complete a task.
* *appName:* `string` - Name of the app
* *taskId:* `string` - ID of the task to complete
* **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 task that was completed
* **createNewTask**(startTaskRequest: [`StartTaskCloudRequestModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/start-task-cloud-request.model.ts), appName: `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/>
- _appName:_ `string` - Name of the app
- _taskId:_ `string` - ID of the task to complete
- **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 task that was completed
- **createNewTask**(startTaskRequest: [`StartTaskCloudRequestModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/start-task-cloud-request.model.ts), appName: `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/>
Creates a new standalone task.
* *startTaskRequest:* [`StartTaskCloudRequestModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/start-task-cloud-request.model.ts) -
* *appName:* `string` -
* **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
* **getBasePath**(appName: `string`): `string`<br/>
- _startTaskRequest:_ [`StartTaskCloudRequestModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/start-task-cloud-request.model.ts) -
- _appName:_ `string` -
- **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
- **getBasePath**(appName: `string`): `string`<br/>
* *appName:* `string` -
* **Returns** `string` -
* **getCandidateGroups**(appName: `string`, taskId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<string[]>`<br/>
- _appName:_ `string` -
- **Returns** `string` -
- **getCandidateGroups**(appName: `string`, taskId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<string[]>`<br/>
Gets candidate groups of the task.
* *appName:* `string` - Name of the app
* *taskId:* `string` - ID of the task
* **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<string[]>` - Candidate groups
* **getCandidateUsers**(appName: `string`, taskId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<string[]>`<br/>
- _appName:_ `string` - Name of the app
- _taskId:_ `string` - ID of the task
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<string[]>` - Candidate groups
- **getCandidateUsers**(appName: `string`, taskId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<string[]>`<br/>
Gets candidate users of the task.
* *appName:* `string` - Name of the app
* *taskId:* `string` - ID of the task
* **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<string[]>` - Candidate users
* **getPriorityLabel**(priority: `number`): `string`<br/>
- _appName:_ `string` - Name of the app
- _taskId:_ `string` - ID of the task
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<string[]>` - Candidate users
- **getPriorityLabel**(priority: `number`): `string`<br/>
* *priority:* `number` -
* **Returns** `string` -
* **getProcessDefinitions**(appName: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessDefinitionCloud`](../../../lib/process-services-cloud/src/lib/models/process-definition-cloud.model.ts)`[]>`<br/>
- _priority:_ `number` -
- **Returns** `string` -
- **getProcessDefinitions**(appName: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessDefinitionCloud`](../../../lib/process-services-cloud/src/lib/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/models/process-definition-cloud.model.ts)`[]>` - Array of process definitions
* **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/>
- _appName:_ `string` - Name of the target app
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessDefinitionCloud`](../../../lib/process-services-cloud/src/lib/models/process-definition-cloud.model.ts)`[]>` - Array of process definitions
- **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.
* *appName:* `string` - Name of the app
* *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
* **isAssigneePropertyClickable**(taskDetails: [`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts), candidateUsers: [`CardViewArrayItem`](../../../lib/core/card-view/models/card-view-arrayitem.model.ts)`[]`, candidateGroups: [`CardViewArrayItem`](../../../lib/core/card-view/models/card-view-arrayitem.model.ts)`[]`): `boolean`<br/>
- _appName:_ `string` - Name of the app
- _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
- **isAssigneePropertyClickable**(taskDetails: [`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts), candidateUsers: [`CardViewArrayItem`](../../../lib/core/card-view/models/card-view-arrayitem.model.ts)`[]`, candidateGroups: [`CardViewArrayItem`](../../../lib/core/card-view/models/card-view-arrayitem.model.ts)`[]`): `boolean`<br/>
* *taskDetails:* [`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts) -
* *candidateUsers:* [`CardViewArrayItem`](../../../lib/core/card-view/models/card-view-arrayitem.model.ts)`[]` -
* *candidateGroups:* [`CardViewArrayItem`](../../../lib/core/card-view/models/card-view-arrayitem.model.ts)`[]` -
* **Returns** `boolean` -
* **isTaskEditable**(taskDetails: [`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts)): `boolean`<br/>
- _taskDetails:_ [`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts) -
- _candidateUsers:_ [`CardViewArrayItem`](../../../lib/core/card-view/models/card-view-arrayitem.model.ts)`[]` -
- _candidateGroups:_ [`CardViewArrayItem`](../../../lib/core/card-view/models/card-view-arrayitem.model.ts)`[]` -
- **Returns** `boolean` -
- **isTaskEditable**(taskDetails: [`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts)): `boolean`<br/>
Validate if a task is editable.
* *taskDetails:* [`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts) - task details object
* **Returns** `boolean` - Boolean value if the task is editable
* **unclaimTask**(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/>
- _taskDetails:_ [`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts) - task details object
- **Returns** `boolean` - Boolean value if the task is editable
- **unclaimTask**(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/>
Un-claims a task.
* *appName:* `string` - Name of the app
* *taskId:* `string` - ID of the task to unclaim
* **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 task that was unclaimed
* **updateTask**(appName: `string`, taskId: `string`, payload: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts)`>`<br/>
- _appName:_ `string` - Name of the app
- _taskId:_ `string` - ID of the task to unclaim
- **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 task that was unclaimed
- **updateTask**(appName: `string`, taskId: `string`, payload: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts)`>`<br/>
Updates the details (name, description, due date) for a task.
* *appName:* `string` - Name of the app
* *taskId:* `string` - ID of the task to update
* *payload:* `any` - Data to update the task
* **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts)`>` - Updated task details
- _appName:_ `string` - Name of the app
- _taskId:_ `string` - ID of the task to update
- _payload:_ `any` - Data to update the task
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts)`>` - Updated task details
## Details
@@ -105,4 +108,4 @@ but they use the cloud variants of the classes for return values. See the
## See also
* [Tasklist service](../../process-services/services/tasklist.service.md)
- [Tasklist service](../../process-services/services/tasklist.service.md)

54
docs/process-services-cloud/services/task-filter-cloud.service.md
View File

@@ -13,31 +13,45 @@ Manages task filters.
### Methods
* **addFilter**(newFilter: [`TaskFilterCloudModel`](../../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskFilterCloudModel`](../../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts)`[]>`<br/>
- **addFilter**(newFilter: [`TaskFilterCloudModel`](../../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskFilterCloudModel`](../../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts)`[]>`<br/>
Adds a new task filter.
* *newFilter:* [`TaskFilterCloudModel`](../../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts) -
* **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 instance filters with newly added filter
* **deleteFilter**(deletedFilter: [`TaskFilterCloudModel`](../../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskFilterCloudModel`](../../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts)`[]>`<br/>
- _newFilter:_ [`TaskFilterCloudModel`](../../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts) -
- **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 instance filters with newly added filter
- **deleteFilter**(deletedFilter: [`TaskFilterCloudModel`](../../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskFilterCloudModel`](../../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts)`[]>`<br/>
Deletes a task filter
* *deletedFilter:* [`TaskFilterCloudModel`](../../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts) -
* **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 instance filters without deleted filter
* **getTaskFilterById**(appName: `string`, id: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskFilterCloudModel`](../../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts)`>`<br/>
- _deletedFilter:_ [`TaskFilterCloudModel`](../../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts) -
- **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 instance filters without deleted filter
- **getBasePath**(appName: `string`): `string`<br/>
- _appName:_ `string` -
- **Returns** `string` -
- **getTaskFilterById**(appName: `string`, id: `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 a task filter.
* *appName:* `string` - Name of the target app
* *id:* `string` - ID of the task
* **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`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/>
- _appName:_ `string` - Name of the target app
- _id:_ `string` - ID of the task
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskFilterCloudModel`](../../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts)`>` - Details of the task filter
- **getTaskFilterCounter**(taskFilter: [`TaskFilterCloudModel`](../../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
Finds a task using an object with optional query properties.
- _taskFilter:_ [`TaskFilterCloudModel`](../../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts) -
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - Task information
- **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 task 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
* **isDefaultFilter**(filterName: `string`): `boolean`<br/>
- _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
- **getTaskNotificationSubscription**(appName: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskCloudEngineEvent`](../../../lib/process-services-cloud/src/lib/models/engine-event-cloud.model.ts)`[]>`<br/>
- _appName:_ `string` -
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskCloudEngineEvent`](../../../lib/process-services-cloud/src/lib/models/engine-event-cloud.model.ts)`[]>` -
- **isDefaultFilter**(filterName: `string`): `boolean`<br/>
Checks if given filter is a default filter
* *filterName:* `string` - Name of the target task filter
* **Returns** `boolean` - Boolean value for whether the filter is a default filter
* **updateFilter**(updatedFilter: [`TaskFilterCloudModel`](../../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskFilterCloudModel`](../../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts)`[]>`<br/>
- _filterName:_ `string` - Name of the target task filter
- **Returns** `boolean` - Boolean value for whether the filter is a default filter
- **updateFilter**(updatedFilter: [`TaskFilterCloudModel`](../../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskFilterCloudModel`](../../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts)`[]>`<br/>
Updates a task filter.
* *updatedFilter:* [`TaskFilterCloudModel`](../../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts) -
* **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 instance filters with updated filter
- _updatedFilter:_ [`TaskFilterCloudModel`](../../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts) -
- **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 instance filters with updated filter
## Details
@@ -96,4 +110,4 @@ export class ExampleModule {}
## See also
* [Task filter service](../../process-services/services/task-filter.service.md)
- [Task filter service](../../process-services/services/task-filter.service.md)

14
docs/process-services-cloud/services/task-list-cloud.service.md
View File

@@ -13,14 +13,16 @@ Searches tasks.
### Methods
* **getBasePath**(appName: `string`): `string`<br/>
- **getBasePath**(appName: `string`): `string`<br/>
* *appName:* `string` -
* **Returns** `string` -
* **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/>
- _appName:_ `string` -
- **Returns** `string` -
- **getTaskByRequest**(requestNode: [`TaskQueryCloudRequestModel`](../../../lib/process-services-cloud/src/lib/task/task-list/models/filter-cloud-model.ts), queryUrl?: `string`): [`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
- _requestNode:_ [`TaskQueryCloudRequestModel`](../../../lib/process-services-cloud/src/lib/task/task-list/models/filter-cloud-model.ts) - Query object
- _queryUrl:_ `string` - (Optional) Query url
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - Task information
## Details

51
docs/process-services-cloud/services/user-preference-cloud.service.md
View File

@@ -13,37 +13,38 @@ Manages user preferences.
### Methods
* **createPreference**(appName: `string`, key: `string`, newPreference: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
- **createPreference**(appName: `string`, key: `string`, newPreference: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
Creates user preference.
* *appName:* `string` - Name of the target app
* *key:* `string` - Key of the target preference
* *newPreference:* `any` -
* **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - Observable of created user preferences
* **deletePreference**(appName: `string`, key: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
- _appName:_ `string` - Name of the target app
- _key:_ `string` - Key of the target preference
- _newPreference:_ `any` -
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - Observable of created user preferences
- **deletePreference**(appName: `string`, key: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
Deletes user preference by given preference key.
* *appName:* `string` - Name of the target app
* *key:* `string` - Key of the target preference
* **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - Observable of delete operation status
* **getBasePath**(appName: `string`): `string`<br/>
- _appName:_ `string` - Name of the target app
- _key:_ `string` - Key of the target preference
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - Observable of delete operation status
- **getBasePath**(appName: `string`): `string`<br/>
* *appName:* `string` -
* **Returns** `string` -
* **getPreferenceByKey**(appName: `string`, key: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
- _appName:_ `string` -
- **Returns** `string` -
- **getPreferenceByKey**(appName: `string`, key: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
Gets user preference.
* *appName:* `string` - Name of the target app
* *key:* `string` - Key of the target preference
* **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - Observable of user preference
* **getPreferences**(appName: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
- _appName:_ `string` - Name of the target app
- _key:_ `string` - Key of the target preference
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - Observable of user preference
- **getPreferences**(appName: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
Gets user preferences
* *appName:* `string` - Name of the target app
* **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - List of user preferences
* **updatePreference**(appName: `string`, key: `string`, updatedPreference: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
- _appName:_ `string` - Name of the target app
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - List of user preferences
- **updatePreference**(appName: `string`, key: `string`, updatedPreference: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
Updates user preference.
* *appName:* `string` - Name of the target app
* *key:* `string` - Key of the target preference
* *updatedPreference:* `any` - Details of updated preference
* **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - Observable of updated user preferences
- _appName:_ `string` - Name of the target app
- _key:_ `string` - Key of the target preference
- _updatedPreference:_ `any` - Details of updated preference
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - Observable of updated user preferences
## See also
* [Local preference Cloud Service](local-preference-cloud.service.md)
- [Local preference Cloud Service](local-preference-cloud.service.md)