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

[ADF-2152] Updated See Also sections in docs (#2842)

Browse Source
This commit is contained in:
Andy Stark
2018-01-17 13:56:08 +00:00
committed by Eugenio Romano
parent ed6c62b990
commit 244234db4f
26 changed files with 388 additions and 466 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
docs/highlight-transform.service.md
View File

@@ -13,10 +13,10 @@ A typical use case for this service is to display the results from a search engi
An excerpt of a retrieved document can be shown with the matching search terms
highlighted to indicate where they were found.
The service works by adding HTML <span> elements around all sections of text
The service works by adding HTML <span> elements around all sections of text
that match the `search` string. You can specify multiple search strings at once by
separating them with spaces, so passing "Apple Banana Cherry" in `search` will
highlight any of those words individually. The <span> element includes a
highlight any of those words individually. The <span> element includes a
`class` attribute which defaults to "highlight" but you can pass any class name
you like using the `wrapperClass` parameter.
@@ -33,13 +33,7 @@ interface HightlightTransformResult {
The `changed` flag will be false if the search string was not found (ie, no highlighting
took place) and true otherwise.
<!-- Don't edit the See also section. Edit seeAlsoGraph.json and run config/generateSeeAlso.js -->
<!-- seealso start -->
## See also
- [Text highlight pipe](text-highlight.pipe.md)
- [Highlight directive](highlight.directive.md)
<!-- seealso end -->

7
docs/highlight.directive.md
View File

@@ -35,8 +35,8 @@ If the search string contain spaces then each section between the spaces will
be treated as a separate item to highlight. For example, you could use this to
highlight all occurrences of words in a list.
The highlighting works by adding an HTML &lt;span&gt; element around the
selected text. The &lt;span&gt; includes a CSS class; this defaults to
The highlighting works by adding an HTML &lt;span> element around the
selected text. The &lt;span> includes a CSS class; this defaults to
"adf-highlight" but you can supply your own class using the `adf-highlight-class`
property:
@@ -51,10 +51,7 @@ property:
</div>
```
<!-- Don't edit the See also section. Edit seeAlsoGraph.json and run config/generateSeeAlso.js -->
<!-- seealso start -->
## See also
- [Text highlight pipe](text-highlight.pipe.md)
- [Highlight transform service](highlight-transform.service.md)
<!-- seealso end -->

6
docs/host-settings.component.md
View File

@@ -14,13 +14,11 @@ Validates the URLs for ACS and APS and saves them in the user's local storage
### Properties
| Name | Type | Default Value | Description |
| --- | --- | --- | --- |
| ---- | ---- | ------------- | ----------- |
| providers | string | ALL | Possible valid values are ECM, BPM or ALL. It indicate which URL configurations show |
### Events
| Name | Returned Type | Description |
| --- | --- | --- |
| ---- | ------------- | ----------- |
| error | string | emitted when the url inserted is wrong |

7
docs/infinite-pagination.component.md
View File

@@ -17,7 +17,7 @@ Adds "infinite" pagination to the component it is used with.
### Properties
| Name | Type | Default | Description |
| --- | --- | --- | --- |
| ---- | ---- | ------- | ----------- |
| pagination | Pagination | `InfinitePaginationComponent.DEFAULT_PAGINATION` | Pagination object |
| pageSize | number | `InfinitePaginationComponent.DEFAULT_PAGE_SIZE` | Number of items that are added with each "load more" event |
| loading | boolean | false | |
@@ -25,7 +25,7 @@ Adds "infinite" pagination to the component it is used with.
### Events
| Name | Description |
| --- | --- |
| ---- | ----------- |
| loadMore | Emitted when the "Load More" button is clicked |
## Details
@@ -43,10 +43,7 @@ page within the list to be shown, whether there are more items left to show, etc
See the [Pagination component](pagination.component.md) for more information about the alternative "finite" pagination scheme.
<!-- Don't edit the See also section. Edit seeAlsoGraph.json and run config/generateSeeAlso.js -->
<!-- seealso start -->
## See also
- [Document list component](document-list.component.md)
- [Pagination component](pagination.component.md)
<!-- seealso end -->

3
docs/info-drawer-layout.component.md
View File

@@ -30,9 +30,6 @@ As the name suggests, this is basically just a layout with CSS styling. There ar
- info-drawer-buttons
- info-drawer-content
<!-- Don't edit the See also section. Edit seeAlsoGraph.json and run config/generateSeeAlso.js -->
<!-- seealso start -->
## See also
- [Info drawer component](info-drawer.component.md)
<!-- seealso end -->

5
docs/info-drawer.component.md
View File

@@ -27,7 +27,7 @@ Displays a sidebar-style information panel with tabs.
### Properties
| Name | Type | Default | Description |
| --- | --- | --- | --- |
| ---- | ---- | ------- | ----------- |
| title | string | null | The title of the info drawer |
| selectedIndex | number | 0 | The selected index tab |
| currentTab | any | null | The currently active tab |
@@ -38,9 +38,6 @@ This is a variant of the [Info Drawer Layout component](info-drawer-layout.compo
You can also customize the three regions (title, buttons and content) as with the Info Drawer Layout component.
<!-- Don't edit the See also section. Edit seeAlsoGraph.json and run config/generateSeeAlso.js -->
<!-- seealso start -->
## See also
- [Info drawer layout component](info-drawer-layout.component.md)
<!-- seealso end -->

6
docs/language-menu.component.md
View File

@@ -39,6 +39,7 @@ This is how the configuration looks like in the the "app.config.json"
}
]
```
In case no setting is provided, the component shows only the English language.
### Nested Menu language
@@ -58,12 +59,9 @@ How to attach an ADF Language Menu as nested menu
<adf-language-menu></adf-language-menu>
</mat-menu>
```
![Nested Language Menu screenshot](docassets/images/languages-menu-nested.png)
### Nested menu details
In the previous example we are using the ADF Language Menu as nested menu.
<!-- Don't edit the See also section. Edit seeAlsoGraph.json and run config/generateSeeAlso.js -->
<!-- seealso start -->
<!-- seealso end -->

7
docs/like.component.md
View File

@@ -13,19 +13,16 @@ Allows a user to add "likes" to an item.
### Properties
| Attribute | Type | Default | Description |
| --- | --- | --- | --- |
| --------- | ---- | ------- | ----------- |
| nodeId | string | | The identifier of a node. |
### Events
| Name | Description |
| --- | --- |
| ---- | ----------- |
| changeVote | Raised when vote gets changed |
<!-- Don't edit the See also section. Edit seeAlsoGraph.json and run config/generateSeeAlso.js -->
<!-- seealso start -->
## See also
- [Rating component](rating.component.md)
- [Rating service](rating.service.md)
<!-- seealso end -->

4
docs/login.component.md
View File

@@ -227,3 +227,7 @@ export class MyCustomLogin {
**Please note that if `event.preventDefault()` is not called then default behaviour
will also be executed after your custom code.**
## See Also
- [Logout directive](logout.directive.md)

5
docs/logout.directive.md
View File

@@ -8,11 +8,6 @@ Logs the user out when the decorated element is clicked.
<button adf-logout>Logout</button>
```
<!-- Don't edit the See also section. Edit seeAlsoGraph.json and run config/generateSeeAlso.js -->
<!-- seealso start -->
## See also
- [Login component](login.component.md)
<!-- seealso end -->

3
docs/mime-type-icon.pipe.md
View File

@@ -15,9 +15,6 @@ Retrieves an icon to represent a MIME type.
The pipe takes a MIME type as input and returns the URL of an SVG file that
symbolizes that type (see the [Thumbnail service](thumbnail.service.md) for the mapping between types and icons). The pipe will return a "miscellaneous" icon when no specific mapping is defined.
<!-- Don't edit the See also section. Edit seeAlsoGraph.json and run config/generateSeeAlso.js -->
<!-- seealso start -->
## See also
- [Thumbnail service](thumbnail.service.md)
<!-- seealso end -->

10
docs/node-delete.directive.md
View File

@@ -20,16 +20,20 @@ Deletes multiple files and folders.
### Properties
| Name | Type | Default | Description |
| ----------------- | ------------------- | ------- | --------------------------- |
| adf-delete | MinimalNodeEntity[] | [] | Nodes to delete |
| ---- | ---- | ------- | ----------- |
| adf-delete | MinimalNodeEntity\[] | \[] | Nodes to delete |
| permanent | boolean | false | Permanent delete |
### Events
| Name | Description |
| ------------------------- | -------------------------------------------- |
| ---- | ----------- |
| delete | emitted when delete process is done |
## Details
See **Demo Shell**
## See also
- [Node Restore directive](node-restore.directive.md)

10
docs/node-restore.directive.md
View File

@@ -23,14 +23,14 @@ Restores deleted nodes to their original location.
### Properties
| Name | Type | Default | Description |
| ----------------- | ------------------- | ------- | ------------------------------- |
| adf-restore | DeletedNodeEntry[] | [] | Deleted nodes to restore |
| ---- | ---- | ------- | ----------- |
| adf-restore | DeletedNodeEntry\[] | \[] | Deleted nodes to restore |
| location | string | '' | Route path to view restored node |
### Events
| Name | Description |
| --------- | ------------------------------- |
| ---- | ----------- |
| restore | Raised when the restore is done |
## Details
@@ -39,3 +39,7 @@ Restores deleted nodes to their original location.
If the original location doesn't exist anymore, then they remain in the trash list.
For single node restore, there is action to jump to the location where the node has been restored and for this `location` is used to specify the route path where the list of nodes are rendered
## See Also
- [Node delete directive](node-delete.directive.md)

11
docs/node.service.md
View File

@@ -1,4 +1,5 @@
# Node Service
Gets Alfresco Repository node metadata and creates nodes with metadata.
This service cannot be used to create nodes with content.
@@ -17,6 +18,7 @@ export class SomePageComponent implements OnInit {
## Methods
#### getNodeMetadata(nodeId: string): Observable`<NodeMetadata>`
Get the metadata and type for passed in node ID (e.g. 3062d73b-fe47-4040-89d2-79efae63869c):
```ts
@@ -39,14 +41,12 @@ or the name of the node (i.e. `cm:name`).
The `metadata` response looks like in this example:
```
author: "Martin"
description: "Installation guide for Alfresco 3.3 on Linux"
lastThumbnailModification: "doclib:1505900632400"
title: "Install 3.3 Linux"
versionLabel: "1.0"
versionType: "MAJOR"
```
Note that the properties are missing namespace prefix. The `nodeType` response will be returned with namespace prefix,
such as `cm:content`.
@@ -54,6 +54,7 @@ such as `cm:content`.
Executing this method on a folder node returns no metadata, just the type.
#### createNode(name: string, nodeType: string, properties: any, path: string): Observable`<any>`
Creates a node in the Alfresco Repository with passed in `name`, `nodeType`, and metadata `properties`.
It will be created in the folder `path` that is passed in.
@@ -71,11 +72,11 @@ this.nodeService2.createNode(nodeName, nodeType, properties, nodePath).subscribe
console.log('Error: ', error);
});
```
Note that the `path` property should not include the **/Company Home** bit.
The response includes all metadata about the new node:
```
entry:
aspectNames: (2) ["cm:titled", "cm:auditable"]
createdAt: Mon Nov 06 2017 13:04:49 GMT+0000 (GMT) {}
@@ -89,9 +90,9 @@ entry:
nodeType: "cm:folder"
parentId: "a29b5fe3-81f6-46a7-9bed-6a53620acb32"
properties: {cm:title: "Some title", cm:description: "Some description"}
```
#### createNodeMetadata(nodeType: string, nameSpace: any, data: any, path: string, name?: string): Observable`<any>`
This is a convenience method if your property list is missing namespace prefix for property names.
The namespace prefix can then be supplied separately and this method will prepend it automatically.
This method calls the `createNode` method internally:
@@ -114,9 +115,7 @@ this.nodeService2.createNodeMetadata(nodeType, propNamespacePrefix, properties,
See the `createNode` method for information about the response object.
<!-- seealso start -->
## See also
- [Nodes api service](nodes-api.service.md)
- [Deleted nodes api service](deleted-nodes-api.service.md)
<!-- seealso end -->

5
docs/nodes-api.service.md
View File

@@ -152,14 +152,9 @@ and
pages in the Alfresco JS API for further details and options. Note that you can also use the
[Deleted Nodes Api service](deleted-nodes-api.service.md) get a list of all items currently in the trashcan.
<!-- Don't edit the See also section. Edit seeAlsoGraph.json and run config/generateSeeAlso.js -->
<!-- seealso start -->
## See also
- [Document library model](document-library.model.md)
- [Deleted nodes api service](deleted-nodes-api.service.md)
- [Document list component](document-list.component.md)
- [Node service](node.service.md)
<!-- seealso end -->

6
docs/page-title.service.md
View File

@@ -16,12 +16,6 @@ a result of the form "PageName - AppName" (see
is not supplied then just the app name is used; this will default to
"Alfresco ADF Application" when no app name set in the config file.
<!-- Don't edit the See also section. Edit seeAlsoGraph.json and run config/generateSeeAlso.js -->
<!-- seealso start -->
## See also
- [App config service](app-config.service.md)
<!-- seealso end -->

3
docs/people-content.service.md
View File

@@ -21,10 +21,7 @@ See the
[getPerson](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/PeopleApi.md#getPerson)
method in the Alfresco JS API for more information about the REST calls used by this service.
<!-- Don't edit the See also section. Edit seeAlsoGraph.json and run config/generateSeeAlso.js -->
<!-- seealso start -->
## See also
- [People process service](people-process.service.md)
- [Ecm user model](ecm-user.model.md)
<!-- seealso end -->

11
docs/people-list.component.md
View File

@@ -59,22 +59,19 @@ In the component template use the people list component:
</data-columns>
</adf-people-list>
```
Note that the people list component is based on the `<adf-datatable` component.
### Properties
| Name | Type | Default | Description |
| --- | --- | --- | --- |
| users | UserProcessModel[] | | The array of user data that should be used to populate the people list |
| ---- | ---- | ------- | ----------- |
| users | UserProcessModel\[] | | The array of user data that should be used to populate the people list |
| actions | boolean | false | true if actions should be visible, i.e. the 'Three-Dots' menu |
### Events
| Name | Description |
| --- | --- |
| ---- | ----------- |
| clickRow | Emitted when the user clicks a row in the people list. |
| clickAction | Emitted when the user clicks in the 'Three Dots' drop down menu for a row. |
<!-- seealso start -->
<!-- seealso end -->

6
docs/people-process.service.md
View File

@@ -19,7 +19,7 @@ Removes a user who is currently involved with a task.
## Details
Use `getWorkflowUsers` to find users across all tasks, optionally filtering by the `searchWord`
in the task name. The `taskId` parameter, if used, specifies a task to be *excluded* from the
in the task name. The `taskId` parameter, if used, specifies a task to be _excluded_ from the
results. You would typically use this feature to find new users to assign to a task, in which
case you would want to exclude users already assigned to that task.
@@ -34,12 +34,8 @@ You can find more information about the REST API methods used by this service in
(for `getWorkflowUsers`) and the
[User API](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-activiti-rest-api/docs/UserApi.md#getuserprofilepictureurl)(for `getUserImage`).
<!-- Don't edit the See also section. Edit seeAlsoGraph.json and run config/generateSeeAlso.js -->
<!-- seealso start -->
## See also
- [User process model](user-process.model.md)
- [Bpm user model](bpm-user.model.md)
- [People content service](people-content.service.md)
<!-- seealso end -->

7
docs/permissions-style.model.md
View File

@@ -5,7 +5,7 @@ Sets custom CSS styles for rows of a [Document List](document-list.component.md)
## Properties
| Property | Type | Description |
| --- | --- | --- |
| -------- | ---- | ----------- |
| isFile | boolean | Does this style apply to files? |
| isFolder | boolean | Does this style apply to folders? |
| permission | Permissions | An enum value defining the permissions that this style applies to (see below) |
@@ -48,11 +48,9 @@ adf-document-list ::ng-deep adf-datatable tr.document-list__create {
If you want to change the style on the folders where the user doesn't have the permission to update:
```ts
let permissionsStyle: PermissionStyleModel[] = [];
this.permissionsStyle.push(new PermissionStyleModel('document-list__disable', PermissionsEnum.NOT_UPDATE, false, true));
```
```html
@@ -66,9 +64,6 @@ adf-document-list ::ng-deep adf-datatable tr.document-list__disable {
}
```
<!-- Don't edit the See also section. Edit seeAlsoGraph.json and run config/generateSeeAlso.js -->
<!-- seealso start -->
## See also
- [Document list component](document-list.component.md)
<!-- seealso end -->

25
docs/process-filter.service.md
View File

@@ -1,4 +1,5 @@
# Process Filter Service
Manage Process Filters, which are pre-configured Process Instance queries.
## Importing
@@ -15,6 +16,7 @@ export class SomePageComponent implements OnInit {
## Methods
#### createDefaultFilters(appId: number): Observable`<any[]>`
Create and return the default filters for a Process App:
```ts
@@ -29,7 +31,6 @@ this.processFilterService.createDefaultFilters(processAppId)
The response is an array of `FilterProcessRepresentationModel` objects:
```
filters:
0: {
appId: 2
@@ -45,12 +46,12 @@ filters:
}
1: {id: null, appId: 2, name: "Completed", recent: false, icon: "glyphicon-ok-sign", …}
2: {id: null, appId: 2, name: "All", recent: true, icon: "glyphicon-th", …}
```
These filters can now be used to get matching process instances for Process App with ID 2,
such as 'Running', 'Completed', and 'All' .
#### getProcessFilters(appId: number): Observable`<FilterProcessRepresentationModel[]>`
Get all filters defined for a Process App:
```ts
@@ -65,7 +66,6 @@ this.processFilterService.getProcessFilters(processAppId)
The response is an array of `FilterProcessRepresentationModel` objects:
```
filters:
0: {id: 15, appId: 2, name: "Running", recent: true, icon: "glyphicon-random", …}
1: {id: 14, appId: 2, name: "Completed", recent: false, icon: "glyphicon-ok-sign", …}
@@ -74,7 +74,7 @@ filters:
4: {id: 3004, appId: 2, name: "Completed", recent: false, icon: "glyphicon-ok-sign", …}
5: {id: 3005, appId: 2, name: "All", recent: false, icon: "glyphicon-th", …}
```
In this example I had run the `createDefaultFilters` method ones and that created the duplicate of
the default filters.
@@ -82,6 +82,7 @@ These filters can now be used to get matching process instances for Process App
such as 'Running', 'Completed', and 'All' .
#### getProcessFilterById(filterId: number, appId?: number): Observable`<FilterProcessRepresentationModel>`
Get a specific Process Filter based on its ID, optionally pass in Process App ID to improve performance
when searching for filter:
@@ -98,18 +99,17 @@ this.processFilterService.getProcessFilterById(filterId, processAppId)
The response is a `FilterProcessRepresentationModel` object:
```
appId: 2
filter: {sort: "created-desc", name: "", state: "running"}
icon: "glyphicon-random"
id: 3003
name: "Running"
recent: false
```
The filter can now be used to get 'Running' process instances for Process App with ID 2.
#### getProcessFilterByName(filterName: string, appId?: number): Observable`<FilterProcessRepresentationModel>`
Get a specific Process Filter based on its name, optionally pass in Process App ID to improve performance
when searching for filter:
@@ -126,20 +126,20 @@ this.processFilterService.getProcessFilterByName(filterName, processAppId)
The response is a `FilterProcessRepresentationModel` object:
```
appId: 2
filter: {sort: "created-desc", name: "", state: "running"}
icon: "glyphicon-random"
id: 15
name: "Running"
recent: true
```
If there are several filters with the same name for the Process App, then you get back the
first one found matching the name.
The filter can now be used to get 'Running' process instances for Process App with ID 2.
#### addProcessFilter(filter: FilterProcessRepresentationModel): Observable`<FilterProcessRepresentationModel>`
Add a new Process Instance filter:
```ts
@@ -162,13 +162,11 @@ this.processFilterService.addProcessFilter(filterRunningAsc)
The response is a `FilterProcessRepresentationModel` object:
```
appId: 2
icon: "glyphicon-random"
id: 3008
name: "RunningAsc"
recent: false
```
The filter can now be used to get 'Running' process instances for
Process App with ID 2 in created date ascending order.
@@ -176,6 +174,7 @@ Process App with ID 2 in created date ascending order.
See also the `getRunningFilterInstance` method.
#### getRunningFilterInstance(appId: number): FilterProcessRepresentationModel
Convenience method to create and return a filter that matches `running` process instances
for passed in Process App ID:
@@ -187,7 +186,6 @@ console.log('Running filter', runningFilter);
The response is a `FilterProcessRepresentationModel` object:
```
appId: 2
filter: {sort: "created-desc", name: "", state: "running"}
icon: "glyphicon-random"
@@ -195,11 +193,6 @@ id: null
index: undefined
name: "Running"
recent: true
```
The filter can now be used to get 'Running' process instances for
Process App with ID 2 in created date ascending order.
<!-- seealso start -->
<!-- seealso end -->

9
docs/process-filters.component.md
View File

@@ -13,7 +13,7 @@ Collection of criteria used to filter process instances, which may be customized
### Properties
| Name | Type | Description |
| --- | --- | --- |
| ---- | ---- | ----------- |
| filterParam | [FilterParamsModel](#filterparamsmodel) | The params to filter the task filter. If there is no match the default one (first filter of the list) is selected |
| appId | string | Display filters available to the current user for the application with the specified ID. |
| appName | string | Display filters available to the current user for the application with the specified name. |
@@ -24,7 +24,7 @@ If both `appId` and `appName` are specified then `appName` will take precedence
### Events
| Name | Description |
| --- | --- |
| ---- | ----------- |
| success | Raised when the list of filters has been successfully loaded from the server |
| error | Raised when an error occurs |
| filterClick | Raised when the user selects a filter from the list |
@@ -58,7 +58,7 @@ You can use inside the filterParam one of the properties defined by [FilterParam
```
| Name | Type | Description |
| --- | --- | --- |
| ---- | ---- | ----------- |
| id | string | The id of the task filter. |
| name | string | The name of the task filter, lowercase is checked. |
| index | number | Zero-based position of the filter in the array. |
@@ -68,9 +68,6 @@ You can use inside the filterParam one of the properties defined by [FilterParam
The process filter often works well as an item in an accordion menu. See the [Accordion component](accordion.component.md)
page for an example of how to do set this up.
<!-- Don't edit the See also section. Edit seeAlsoGraph.json and run config/generateSeeAlso.js -->
<!-- seealso start -->
## See also
- [Filter model](filter.model.md)
<!-- seealso end -->

43
docs/process.service.md
View File

@@ -1,4 +1,5 @@
# Process Service
Manage Process Instances, Process Variables, and Process Audit Log.
## Importing
@@ -16,6 +17,7 @@ export class SomePageComponent implements OnInit {
## Methods
#### getProcess(processInstanceId: string): Observable`<ProcessInstance>`
Get Process Instance metadata for passed in Process Instance ID:
```ts
@@ -30,7 +32,6 @@ this.processService.getProcess(processInstanceId).subscribe( (processInstance: P
The `processInstanceId` refers to a process instance ID for a running process in APS.
The returned `processInstance` object is of type `ProcessInstance` and looks like in this sample:
```
businessKey: null
ended: null
graphicalNotationDefined: true
@@ -56,9 +57,9 @@ The returned `processInstance` object is of type `ProcessInstance` and looks lik
4: {name: "invoiceFileName", type: "string", value: " - [Alfresco_Enterprise_Edition_3_3_Windows_Simple_Install.pdf]"}
5: {name: "comments", value: null}
6: {name: "form8outcome", type: "string", value: "Reject"}
```
#### startProcess(processDefinitionId: string, name: string, outcome?: string, startFormValues?: any, variables?: ProcessInstanceVariable[]): Observable`<ProcessInstance>`
#### startProcess(processDefinitionId: string, name: string, outcome?: string, startFormValues?: any, variables?: ProcessInstanceVariable\[]): Observable`<ProcessInstance>`
Start a process based on passed in Process Definition, name, form values or variables.
When starting you can choose to pass in form field values or process variables (you cannot pass in both).
@@ -84,7 +85,6 @@ this.processService.startProcess(processDefinitionId, name, outcome, startFormVa
A `ProcessInstance` object is returned for a successfully started process:
```
businessKey: null
ended: null
graphicalNotationDefined: true
@@ -107,8 +107,6 @@ variables:
2: {name: "initiator", type: "string", value: "1"}
3: {name: "invoicetobeapproved", value: null}
```
We can see here that the form field values have been converted to process variables.
To start the process with process variables instead of form field values do:
@@ -144,6 +142,7 @@ this.processService.startProcess(processDefinitionId, name)
```
#### cancelProcess(processInstanceId: string): Observable`<void>`
Cancel a process instance by passing in its process instance ID:
```ts
@@ -163,7 +162,8 @@ Once a Process Instance is cancelled it will show up under processes with status
You typically get the `processInstanceId` when you start a process. It is then
contained in the `ProcessInstance.id` response.
#### createOrUpdateProcessInstanceVariables(processDefinitionId: string, variables: ProcessInstanceVariable[]): Observable`<ProcessInstanceVariable[]>`
#### createOrUpdateProcessInstanceVariables(processDefinitionId: string, variables: ProcessInstanceVariable\[]): Observable`<ProcessInstanceVariable[]>`
Create or update variables for a Process Instance:
```ts
@@ -182,17 +182,16 @@ this.processService.createOrUpdateProcessInstanceVariables(processInstanceId, va
The response is an array of the successfully created `ProcessInstanceVariable`:
```
Response:
0: {name: "sampleVar1", type: "string", value: "hello", scope: "global"}
1: {name: "sampleVar2", type: "string", value: "bye", scope: "global"}
```
If a variable already exist, then its value will be updated.
**Note**. you need to pass in a Process Instance ID here, not a Process Definition ID.
#### deleteProcessInstanceVariable(processDefinitionId: string, variableName: string): Observable`<void>`
Delete a variable for a Process Instance:
```ts
@@ -211,6 +210,7 @@ The response will be `null` if the variable was successfully deleted from the Pr
**Note**. you need to pass in a Process Instance ID here, not a Process Definition ID.
#### getProcessInstanceVariables(processDefinitionId: string): Observable`<ProcessInstanceVariable[]>`
Get all the variables for a Process Instance:
```ts
@@ -225,7 +225,6 @@ this.processService.getProcessInstanceVariables(processInstanceId)
The response is an array of `ProcessInstanceVariable`:
```
procVars:
0: {name: "approver", scope: "global", value: null, valueUrl: null}
1: {name: "companyemail", scope: "global", value: "someone@acme.com", valueUrl: null}
@@ -233,12 +232,11 @@ procVars:
3: {name: "sampleVar2", scope: "global", value: "bye", valueUrl: null}
4: {name: "invoicetobeapproved", scope: "global", value: null, valueUrl: null}
5: {name: "invoiceFileName", scope: "global", value: " - [UNKNOWN]", valueUrl: null}
```
**Note**. you need to pass in a Process Instance ID here, not a Process Definition ID.
#### getProcessDefinitions(appId?: number): Observable`<ProcessDefinitionRepresentation[]>`
Get Process Definitions associated with a Process App:
```ts
@@ -253,7 +251,6 @@ this.processService.getProcessDefinitions(processAppId)
The response is an array of `ProcessDefinitionRepresentation` objects looking like in this example:
```
0:
category: "http://www.activiti.org/processdef"
deploymentId: "18"
@@ -265,7 +262,6 @@ The response is an array of `ProcessDefinitionRepresentation` objects looking li
name: "Invoice Approval Process"
tenantId: "tenant_1"
version: 2
```
If you wanted a list of all available process definitions call the method without specifying the
process application ID:
@@ -280,6 +276,7 @@ this.processService.getProcessDefinitions()
```
#### getProcessInstances(requestNode: ProcessFilterParamRepresentationModel, processDefinitionKey?: string): Observable`<ProcessInstance[]>`
Get Process Instances for passed in filter and optionally Process Definition:
```ts
@@ -298,7 +295,6 @@ this.processService.getProcessInstances(filterRunningAsc, processDefKey)
The response is an array of `ProcessInstance` objects as in this example:
```
0: {id: "7501", name: "Invoice Approval Process - October 9th 2017", businessKey: null, processDefinitionId: "InvoiceApprovalProcess:3:2511", tenantId: "tenant_1", …}
1: {id: "7520", name: "Invoice Approval Process - October 9th 2017", businessKey: null, processDefinitionId: "InvoiceApprovalProcess:2:21", tenantId: "tenant_1", …}
2: {id: "8206", name: "Invoice Approval Process - October 9th 2017", businessKey: null, processDefinitionId: "InvoiceApprovalProcess:2:21", tenantId: "tenant_1", …}
@@ -307,12 +303,13 @@ The response is an array of `ProcessInstance` objects as in this example:
5: {id: "11437", name: "Invoice Approval Process - October 10th 2017", businessKey: null, processDefinitionId: "InvoiceApprovalProcess:2:21", tenantId: "tenant_1", …}
6: {id: "67143", name: "Sample Invoice Approval 2017-10-26", businessKey: null, processDefinitionId: "InvoiceApprovalProcess:5:62514", tenantId: "tenant_1", …}
7: {id: "75001", name: "Sample Invoice Process", businessKey: null, processDefinitionId: "InvoiceApprovalProcess:2:21", tenantId: "tenant_1", …}
```
You can also narrow down the search via other properties in the `ProcessFilterParamRepresentationModel`, such as
`processDefinitionId` and `appDefinitionId`.
The number of Process Instances that are returned can be controlled with the `page` and `size` properties.
#### getProcessTasks(processInstanceId: string, state?: string): Observable`<TaskDetailsModel[]>`
Get Task Instances for passed in Process Instance, optionally filter by task state:
```ts
@@ -327,7 +324,6 @@ this.processService.getProcessTasks(processInstanceId)
The response is an array of `TaskDetailsModel` objects as in this example:
```
{
"size":1,
"total":1,
@@ -366,7 +362,7 @@ The response is an array of `TaskDetailsModel` objects as in this example:
}
]
}
```
You can also filter by task state, which can be `active` or `completed`:
```ts
@@ -381,6 +377,7 @@ this.processService.getProcessTasks(processInstanceId, taskState)
```
#### fetchProcessAuditJsonById(processId: string): Observable`<any>`
Fetch Process Audit log as JSON for a Process Instance ID:
```ts
@@ -395,7 +392,6 @@ this.processService.fetchProcessAuditJsonById(processInstanceId)
The response is JSON object with the Process Instance audit log:
```
{
"processInstanceId": "75001",
"processInstanceName": "Sample Invoice Process",
@@ -484,9 +480,9 @@ The response is JSON object with the Process Instance audit log:
"appliedRules": []
}
}
```
#### fetchProcessAuditPdfById(processId: string): Observable`<Blob>`
Fetch Process Audit log as a PDF for a Process Instance ID:
```ts
@@ -501,11 +497,4 @@ this.processService.fetchProcessAuditPdfById(processInstanceId)
The response is a BLOB as follows:
```
Process Audit log BLOB: Blob {size: 124511, type: "text/xml"}
```
<!-- seealso start -->
<!-- seealso end -->

3
docs/product-version.model.md
View File

@@ -67,9 +67,6 @@ class VersionModuleModel {
}
```
<!-- Don't edit the See also section. Edit seeAlsoGraph.json and run config/generateSeeAlso.js -->
<!-- seealso start -->
## See also
- [Discovery api service](discovery-api.service.md)
<!-- seealso end -->

7
docs/rating.component.md
View File

@@ -15,19 +15,16 @@ Allows a user to add ratings to an item.
### Properties
| Attribute | Type | Default | Description |
| --- | --- | --- | --- |
| --------- | ---- | ------- | ----------- |
| nodeId | string | | The identifier of a node |
### Events
| Name | Description |
| --- | --- |
| ---- | ----------- |
| changeVote | Raised when vote gets changed |
<!-- Don't edit the See also section. Edit seeAlsoGraph.json and run config/generateSeeAlso.js -->
<!-- seealso start -->
## See also
- [Like component](like.component.md)
- [Rating service](rating.service.md)
<!-- seealso end -->

3
docs/rating.service.md
View File

@@ -25,10 +25,7 @@ See the [Ratings API](https://github.com/Alfresco/alfresco-js-api/blob/master/sr
in the Alfresco JS API for more information about the returned data and the
REST API that this service is based on.
<!-- Don't edit the See also section. Edit seeAlsoGraph.json and run config/generateSeeAlso.js -->
<!-- seealso start -->
## See also
- [Like component](like.component.md)
- [Rating component](rating.component.md)
<!-- seealso end -->