mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-07-24 17:32:15 +00:00
[ADF-3745] Added docs for new PS cloud services (#4129)
This commit is contained in:
Andy Stark
committed by
Eugenio Romano
Eugenio Romano
parent
968c65ff70
commit
aee34184ca
@@ -32,12 +32,12 @@ for more information about installing and using the source code.
|
||||
|
||||
| Name | Description | Source link |
|
||||
| ---- | ----------- | ----------- |
|
||||
| [Process filter cloud service](process-filter-cloud.service.md) | Manage Process Filters, which are pre-configured Process Instance queries. | [Source](../../lib/process-services-cloud/src/lib/process/process-filters/services/process-filter-cloud.service.ts) |
|
||||
| [Start process cloud service](start-process-cloud.service.md) | Gets process definitions and starts processes. | [Source](../../lib/process-services-cloud/src/lib/process/start-process/services/start-process-cloud.service.ts) |
|
||||
| [Start task cloud service](start-task-cloud.service.md) | Starts standalone tasks. | [Source](../../lib/process-services-cloud/src/lib/task/start-task/services/start-task-cloud.service.ts) |
|
||||
| [Task filter cloud service](task-filter-cloud.service.md) | Manages task filters. | [Source](../../lib/process-services-cloud/src/lib/task/task-filters/services/task-filter-cloud.service.ts) |
|
||||
| _[Apps process cloud service](../../lib/process-services-cloud/src/lib/app/services/apps-process-cloud.service.ts)_ | _Not currently documented_ | [Source](../../lib/process-services-cloud/src/lib/app/services/apps-process-cloud.service.ts) |
|
||||
| _[Process filter cloud service](../../lib/process-services-cloud/src/lib/process/process-filters/services/process-filter-cloud.service.ts)_ | _Not currently documented_ | [Source](../../lib/process-services-cloud/src/lib/process/process-filters/services/process-filter-cloud.service.ts) |
|
||||
| _[Process list cloud service](../../lib/process-services-cloud/src/lib/process/process-list/services/process-list-cloud.service.ts)_ | _Not currently documented_ | [Source](../../lib/process-services-cloud/src/lib/process/process-list/services/process-list-cloud.service.ts) |
|
||||
| _[Start process cloud service](../../lib/process-services-cloud/src/lib/process/start-process/services/start-process-cloud.service.ts)_ | _Not currently documented_ | [Source](../../lib/process-services-cloud/src/lib/process/start-process/services/start-process-cloud.service.ts) |
|
||||
| _[Start task cloud service](../../lib/process-services-cloud/src/lib/task/start-task/services/start-task-cloud.service.ts)_ | _Not currently documented_ | [Source](../../lib/process-services-cloud/src/lib/task/start-task/services/start-task-cloud.service.ts) |
|
||||
| _[Task filter cloud service](../../lib/process-services-cloud/src/lib/task/task-filters/services/task-filter-cloud.service.ts)_ | _Not currently documented_ | [Source](../../lib/process-services-cloud/src/lib/task/task-filters/services/task-filter-cloud.service.ts) |
|
||||
| _[Process list cloud service](../../lib/process-services-cloud/src/lib/process/process-list/services/process-list-cloud.service.ts)_ | _Not curently documented_ | [Source](../../lib/process-services-cloud/src/lib/process/process-list/services/process-list-cloud.service.ts) |
|
||||
| _[Task list cloud service](../../lib/process-services-cloud/src/lib/task/task-list/services/task-list-cloud.service.ts)_ | _Not currently documented_ | [Source](../../lib/process-services-cloud/src/lib/task/task-list/services/task-list-cloud.service.ts) |
|
||||
|
||||
<!--process-services-cloud end-->
|
||||
|
||||
58
docs/process-services-cloud/process-filter-cloud.service.md
Normal file
58
docs/process-services-cloud/process-filter-cloud.service.md
Normal file
@@ -0,0 +1,58 @@
|
||||
---
|
||||
Title: Process Filter Cloud Service
|
||||
Added: v3.0.0
|
||||
Status: Active
|
||||
Last reviewed: 2019-01-09
|
||||
---
|
||||
|
||||
# [Process Filter Cloud Service](../../lib/process-services-cloud/src/lib/process/process-filters/services/process-filter-cloud.service.ts "Defined in process-filter-cloud.service.ts")
|
||||
|
||||
Manage Process Filters, which are pre-configured Process Instance queries.
|
||||
|
||||
## Class members
|
||||
|
||||
### Methods
|
||||
|
||||
- **addFilter**(filter: [`ProcessFilterCloudModel`](../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts))<br/>
|
||||
Adds a new process instance filter
|
||||
- _filter:_ [`ProcessFilterCloudModel`](../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts) - The new filter to add
|
||||
- **deleteFilter**(filter: [`ProcessFilterCloudModel`](../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts))<br/>
|
||||
Delete process instance filter
|
||||
- _filter:_ [`ProcessFilterCloudModel`](../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts) - The new filter to delete
|
||||
- **getAllProcessesFilter**(appName: `string`): [`ProcessFilterCloudModel`](../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts)<br/>
|
||||
Creates and returns a filter for "All" Process instances.
|
||||
- _appName:_ `string` - Name of the target app
|
||||
- **Returns** [`ProcessFilterCloudModel`](../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts) - The newly created filter
|
||||
- **getCompletedProcessesFilter**(appName: `string`): [`ProcessFilterCloudModel`](../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts)<br/>
|
||||
Creates and returns a filter for "Completed" Process instances.
|
||||
- _appName:_ `string` - Name of the target app
|
||||
- **Returns** [`ProcessFilterCloudModel`](../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts) - The newly created filter
|
||||
- **getProcessFilterById**(appName: `string`, id: `string`): [`ProcessFilterCloudModel`](../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts)<br/>
|
||||
Get process instance filter for given filter id
|
||||
- _appName:_ `string` - Name of the target app
|
||||
- _id:_ `string` - Id of the target process instance filter
|
||||
- **Returns** [`ProcessFilterCloudModel`](../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts) - Details of process filter
|
||||
- **getProcessFilters**(appName: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessFilterCloudModel`](../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts)`[]>`<br/>
|
||||
Gets all process instance filters for a process app.
|
||||
- _appName:_ `string` - Name of the target app
|
||||
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessFilterCloudModel`](../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts)`[]>` - Observable of process filter details
|
||||
- **getRunningProcessesFilter**(appName: `string`): [`ProcessFilterCloudModel`](../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts)<br/>
|
||||
Creates and returns a filter for "Running" Process instances.
|
||||
- _appName:_ `string` - Name of the target app
|
||||
- **Returns** [`ProcessFilterCloudModel`](../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts) - The newly created filter
|
||||
- **updateFilter**(filter: [`ProcessFilterCloudModel`](../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts))<br/>
|
||||
Update process instance filter
|
||||
- _filter:_ [`ProcessFilterCloudModel`](../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts) - The new filter to update
|
||||
|
||||
## Details
|
||||
|
||||
The methods of this service generally return an instance of
|
||||
[`ProcessFilterCloudModel`](../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts) or an array of instances.
|
||||
|
||||
You can use the returned filters to get matching process instances for the process app,
|
||||
such as 'Running', 'Completed', 'All', etc.
|
||||
|
||||
## See also
|
||||
|
||||
- [Process filters cloud component](process-filters-cloud.component.md)
|
||||
- [Task filter cloud service](task-filter-cloud.service.md)
|
||||
36
docs/process-services-cloud/start-process-cloud.service.md
Normal file
36
docs/process-services-cloud/start-process-cloud.service.md
Normal file
@@ -0,0 +1,36 @@
|
||||
---
|
||||
Title: Start Process Cloud Service
|
||||
Added: v3.0.0
|
||||
Status: Active
|
||||
Last reviewed: 2019-01-09
|
||||
---
|
||||
|
||||
# [Start Process Cloud Service](../../lib/process-services-cloud/src/lib/process/start-process/services/start-process-cloud.service.ts "Defined in start-process-cloud.service.ts")
|
||||
|
||||
Gets process definitions and starts processes.
|
||||
|
||||
## Class members
|
||||
|
||||
### Methods
|
||||
|
||||
- **getProcessDefinitions**(appName: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessDefinitionCloud`](../../lib/process-services-cloud/src/lib/process/start-process/models/process-definition-cloud.model.ts)`[]>`<br/>
|
||||
Gets the process definitions associated with an app.
|
||||
- _appName:_ `string` - Name of the target app
|
||||
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessDefinitionCloud`](../../lib/process-services-cloud/src/lib/process/start-process/models/process-definition-cloud.model.ts)`[]>` - Array of process definitions
|
||||
- **startProcess**(appName: `string`, requestPayload: [`ProcessPayloadCloud`](../../lib/process-services-cloud/src/lib/process/start-process/models/process-payload-cloud.model.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessInstanceCloud`](../../lib/process-services-cloud/src/lib/process/start-process/models/process-instance-cloud.model.ts)`>`<br/>
|
||||
Starts a process based on a process definition, name, form values or variables.
|
||||
- _appName:_ `string` - name of the Application
|
||||
- _requestPayload:_ [`ProcessPayloadCloud`](../../lib/process-services-cloud/src/lib/process/start-process/models/process-payload-cloud.model.ts) - Details of the process (definition key, name, variables, etc)
|
||||
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessInstanceCloud`](../../lib/process-services-cloud/src/lib/process/start-process/models/process-instance-cloud.model.ts)`>` - Details of the process instance just started
|
||||
|
||||
## Details
|
||||
|
||||
You can use the `startProcess` method in much the same way as the `startProcess` method in the
|
||||
[Process service](../process-services/process.service.md) (see the [Process service](../process-services/process.service.md) page
|
||||
for an example). However, the cloud version
|
||||
combines the process details and variables conveniently into the
|
||||
[`ProcessPayloadCloud`](../../lib/process-services-cloud/src/lib/process/start-process/models/process-payload-cloud.model.ts) object.
|
||||
|
||||
## See also
|
||||
|
||||
- [Process service](../process-services/process.service.md)
|
||||
30
docs/process-services-cloud/start-task-cloud.service.md
Normal file
30
docs/process-services-cloud/start-task-cloud.service.md
Normal file
@@ -0,0 +1,30 @@
|
||||
---
|
||||
Title: Start Task Cloud Service
|
||||
Added: v3.0.0
|
||||
Status: Active
|
||||
Last reviewed: 2019-01-09
|
||||
---
|
||||
|
||||
# [Start Task Cloud Service](../../lib/process-services-cloud/src/lib/task/start-task/services/start-task-cloud.service.ts "Defined in start-task-cloud.service.ts")
|
||||
|
||||
Starts standalone tasks.
|
||||
|
||||
## Class members
|
||||
|
||||
### Methods
|
||||
|
||||
- **createNewTask**(taskDetails: [`TaskDetailsCloudModel`](../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsCloudModel`](../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts)`>`<br/>
|
||||
Creates a new standalone task.
|
||||
- _taskDetails:_ [`TaskDetailsCloudModel`](../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts) - Details of the task to create
|
||||
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsCloudModel`](../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts)`>` - Details of the newly created task
|
||||
|
||||
## Details
|
||||
|
||||
The `createNewTask` method works the same way as the method with the same name in the
|
||||
[Tasklist service](../process-services/tasklist.service.md)
|
||||
but uses the cloud variants of the classes for the parameter and return value. See the
|
||||
[Tasklist service](../process-services/tasklist.service.md) page for usage examples.
|
||||
|
||||
## See also
|
||||
|
||||
- [Tasklist service](../process-services/tasklist.service.md)
|
||||
66
docs/process-services-cloud/task-filter-cloud.service.md
Normal file
66
docs/process-services-cloud/task-filter-cloud.service.md
Normal file
@@ -0,0 +1,66 @@
|
||||
---
|
||||
Title: Task Filter Cloud Service
|
||||
Added: v3.0.0
|
||||
Status: Active
|
||||
Last reviewed: 2019-01-09
|
||||
---
|
||||
|
||||
# [Task Filter Cloud Service](../../lib/process-services-cloud/src/lib/task/task-filters/services/task-filter-cloud.service.ts "Defined in task-filter-cloud.service.ts")
|
||||
|
||||
Manages task filters.
|
||||
|
||||
## Class members
|
||||
|
||||
### Methods
|
||||
|
||||
- **addFilter**(filter: [`TaskFilterCloudModel`](../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts))<br/>
|
||||
Adds a new task filter.
|
||||
- _filter:_ [`TaskFilterCloudModel`](../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts) - The new filter to add
|
||||
- **deleteFilter**(filter: [`TaskFilterCloudModel`](../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts))<br/>
|
||||
Deletes a task filter
|
||||
- _filter:_ [`TaskFilterCloudModel`](../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts) - The filter to delete
|
||||
- **getCompletedTasksFilterInstance**(appName: `string`): [`TaskFilterCloudModel`](../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts)<br/>
|
||||
Creates and returns a filter for "Completed" task instances.
|
||||
- _appName:_ `string` - Name of the target app
|
||||
- **Returns** [`TaskFilterCloudModel`](../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts) - The newly created filter
|
||||
- **getMyTasksFilterInstance**(appName: `string`): [`TaskFilterCloudModel`](../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts)<br/>
|
||||
Creates and returns a filter for "My [`Tasks`](../../e2e/actions/APS-cloud/tasks.ts)" task instances.
|
||||
- _appName:_ `string` - Name of the target app
|
||||
- **Returns** [`TaskFilterCloudModel`](../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts) - The newly created filter
|
||||
- **getTaskFilterById**(appName: `string`, id: `string`): [`TaskFilterCloudModel`](../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts)<br/>
|
||||
Gets a task filter.
|
||||
- _appName:_ `string` - Name of the target app
|
||||
- _id:_ `string` - ID of the task
|
||||
- **Returns** [`TaskFilterCloudModel`](../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts) - Details of the task filter
|
||||
- **getTaskListFilters**(appName?: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskFilterCloudModel`](../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts)`[]>`<br/>
|
||||
Gets all task filters for a process app.
|
||||
- _appName:_ `string` - (Optional) Name of the target app
|
||||
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskFilterCloudModel`](../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts)`[]>` - Observable of task filter details
|
||||
- **getUsername**(): `string`<br/>
|
||||
Gets the username field from the access token.
|
||||
- **Returns** `string` - Username string
|
||||
- **getValueFromToken**(key: `string`)<br/>
|
||||
Gets a named value from the access token.
|
||||
- _key:_ `string` - Key name of the value
|
||||
- **updateFilter**(filter: [`TaskFilterCloudModel`](../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts))<br/>
|
||||
Updates a task filter.
|
||||
- _filter:_ [`TaskFilterCloudModel`](../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts) - The filter to update
|
||||
|
||||
## Details
|
||||
|
||||
The methods of this service generally return an instance of [`TaskFilterCloudModel`](../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts) or
|
||||
an array of instances. For example, you could use `getTaskListFilters` as follows:
|
||||
|
||||
```ts
|
||||
this.taskFilterService.getTaskListFilters(appName).subscribe( (filters: TaskFilterCloudModel[]) => {
|
||||
console.log('Task filters: ', filters);
|
||||
}, error => {
|
||||
console.log('Error: ', error);
|
||||
});
|
||||
```
|
||||
|
||||
These filters can now be used to get matching task instances for the process app.
|
||||
|
||||
## See also
|
||||
|
||||
- [Task filter service](../process-services/task-filter.service.md)
|
||||
Reference in New Issue
Block a user