mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-07-24 17:32:15 +00:00
[ADF-4249] Updates for doc review (#4470)
* [ADF-4249] Updated review checker tool to work with new doc subfolders * [ADF-4249] Updates for doc review
This commit is contained in:
Andy Stark
committed by
Eugenio Romano
Eugenio Romano
parent
10e91bed2a
commit
e5c7ffb314
@@ -379,7 +379,7 @@ for more information about installing and using the source code.
|
||||
| Name | Description | Source link |
|
||||
| ---- | ----------- | ----------- |
|
||||
| [Process Filter Service](process-services/services/process-filter.service.md) | Manage Process Filters, which are pre-configured Process Instance queries. | [Source](../lib/process-services/process-list/services/process-filter.service.ts) |
|
||||
| [Process Service](process-services/services/process.service.md) | Manages Process Instances, Process Variables, and Process Audit Log. | [Source](../lib/process-services/process-list/services/process.service.ts) |
|
||||
| [Process Service](process-services/services/process.service.md) | Manages process instances, process variables, and process audit Log. | [Source](../lib/process-services/process-list/services/process.service.ts) |
|
||||
| [Task Filter Service](process-services/services/task-filter.service.md) | Manage Task Filters, which are pre-configured Task Instance queries. | [Source](../lib/process-services/task-list/services/task-filter.service.ts) |
|
||||
| [Tasklist Service](process-services/services/tasklist.service.md) | Manages Task Instances. | [Source](../lib/process-services/task-list/services/tasklist.service.ts) |
|
||||
|
||||
@@ -401,8 +401,8 @@ for more information about installing and using the source code.
|
||||
| Name | Description | Source link |
|
||||
| ---- | ----------- | ----------- |
|
||||
| [App List Cloud Component](process-services-cloud/components/app-list-cloud.component.md)  | Shows all deployed cloud application instances. | [Source](../lib/process-services-cloud/src/lib/app/components/app-list-cloud.component.ts) |
|
||||
| [Edit Process Filter Cloud component](process-services-cloud/components/edit-process-filter-cloud.component.md)  | Shows Process Filter Details. | [Source](../lib/process-services-cloud/src/lib/process/process-filters/components/edit-process-filter-cloud.component.ts) |
|
||||
| [Edit Task Filter Cloud component](process-services-cloud/components/edit-task-filter-cloud.component.md)  | Edits Task Filter Details. | [Source](../lib/process-services-cloud/src/lib/task/task-filters/components/edit-task-filter-cloud.component.ts) |
|
||||
| [Edit Process Filter Cloud component](process-services-cloud/components/edit-process-filter-cloud.component.md)  | Shows/edits process filter details. | [Source](../lib/process-services-cloud/src/lib/process/process-filters/components/edit-process-filter-cloud.component.ts) |
|
||||
| [Edit Task Filter Cloud component](process-services-cloud/components/edit-task-filter-cloud.component.md)  | Edits task filter details. | [Source](../lib/process-services-cloud/src/lib/task/task-filters/components/edit-task-filter-cloud.component.ts) |
|
||||
| [Group Cloud component](process-services-cloud/components/group-cloud.component.md)  | Searches Groups. | [Source](../lib/process-services-cloud/src/lib/group/components/group-cloud.component.ts) |
|
||||
| [People Cloud Component](process-services-cloud/components/people-cloud.component.md)  | Allows one or more users to be selected (with auto-suggestion) based on the input parameters. | [Source](../lib/process-services-cloud/src/lib/task/start-task/components/people-cloud/people-cloud.component.ts) |
|
||||
| [Process Filters Cloud Component](process-services-cloud/components/process-filters-cloud.component.md)  | Lists all available process filters and allows to select a filter. | [Source](../lib/process-services-cloud/src/lib/process/process-filters/components/process-filters-cloud.component.ts) |
|
||||
@@ -439,7 +439,6 @@ for more information about installing and using the source code.
|
||||
| [Start Task Cloud Service](process-services-cloud/services/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 Cloud Service](process-services-cloud/services/task-cloud.service.md)  | Manages task cloud. | [Source](../lib/process-services-cloud/src/lib/task/task-header/services/task-cloud.service.ts) |
|
||||
| [Task Filter Cloud Service](process-services-cloud/services/task-filter-cloud.service.md)  | Manages task filters. | [Source](../lib/process-services-cloud/src/lib/task/task-filters/services/task-filter-cloud.service.ts) |
|
||||
| [Task Header Cloud Service](process-services-cloud/services/task-header-cloud.service.md)  | Manages cloud tasks. | [Source](../lib/process-services-cloud/src/lib/task/task-header/services/task-header-cloud.service.ts) |
|
||||
| [Task List Cloud Service](process-services-cloud/services/task-list-cloud.service.md)  | Searches tasks. | [Source](../lib/process-services-cloud/src/lib/task/task-list/services/task-list-cloud.service.ts) |
|
||||
|
||||
<!--process-services-cloud end-->
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
Title: Content Node Selector Panel component
|
||||
Added: v2.1.0
|
||||
Status: Active
|
||||
Last reviewed: 2019-01-16
|
||||
Last reviewed: 2019-03-20
|
||||
---
|
||||
|
||||
# [Content Node Selector Panel component](../../../lib/content-services/content-node-selector/content-node-selector-panel.component.ts "Defined in content-node-selector-panel.component.ts")
|
||||
@@ -33,7 +33,7 @@ Opens a [Content Node Selector](content-node-selector.component.md) in its own
|
||||
| breadcrumbTransform | `Function` | | Transformation to be performed on the chosen/folder node before building the breadcrumb UI. Can be useful when custom formatting is needed for the breadcrumb. You can change the path elements from the node that are used to build the breadcrumb using this function. |
|
||||
| currentFolderId | `string` | null | [Node](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/Node.md) ID of the folder currently listed. |
|
||||
| dropdownHideMyFiles | `boolean` | false | Hide the "My Files" option added to the site list by default. See the [Sites Dropdown component](sites-dropdown.component.md) for more information. |
|
||||
| dropdownSiteList | [`SitePaging`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/SitePaging.md) | null | Custom site for site dropdown. This is the same as the `siteList`. property of the Sites Dropdown component (see its doc page for more information). |
|
||||
| dropdownSiteList | [`SitePaging`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/SitePaging.md) | null | Custom site for site dropdown. This is the same as the `siteList` property of the Sites Dropdown component (see its doc page for more information). |
|
||||
| imageResolver | `ImageResolver` | null | Custom image resolver function. See the [Image Resolver Model](../models/image-resolver.model.md) page for more information. |
|
||||
| isSelectionValid | `ValidationFunction` | defaultValidation | Function used to decide if the selected node has permission to be selected. Default value is a function that always returns true. |
|
||||
| pageSize | `number` | | Number of items shown per page in the list. |
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
Title: Document List component
|
||||
Added: v2.0.0
|
||||
Status: Active
|
||||
Last reviewed: 2019-02-08
|
||||
Last reviewed: 2019-03-20
|
||||
---
|
||||
|
||||
# [Document List component](../../../lib/content-services/document-list/components/document-list.component.ts "Defined in document-list.component.ts")
|
||||
@@ -477,28 +477,10 @@ documentation for a full explanation of the component lifecycle.
|
||||
### Underlying node object
|
||||
|
||||
The [Document List component](document-list.component.md) assigns an instance of
|
||||
[`MinimalNode`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeMinimalEntry.md)
|
||||
the [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/Node.md) class
|
||||
(defined in the [Alfresco JS API](https://github.com/Alfresco/alfresco-js-api)) as the data context
|
||||
for each row. You can make use of the properties of this object when defining custom columns:
|
||||
|
||||
```js
|
||||
export interface MinimalNode {
|
||||
id: string;
|
||||
parentId: string;
|
||||
name: string;
|
||||
nodeType: string;
|
||||
isFolder: boolean;
|
||||
isFile: boolean;
|
||||
modifiedAt: Date;
|
||||
modifiedByUser: UserInfo;
|
||||
createdAt: Date;
|
||||
createdByUser: UserInfo;
|
||||
content: ContentInfo;
|
||||
path: PathInfoEntity;
|
||||
properties: NodeProperties;
|
||||
}
|
||||
```
|
||||
|
||||
Binding to nested properties is also supported. You can define a column key as a property path similar to the following:
|
||||
|
||||
```text
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
Title: Search Filter component
|
||||
Added: v2.3.0
|
||||
Status: Active
|
||||
Last reviewed: 2018-06-12
|
||||
Last reviewed: 2019-03-20
|
||||
---
|
||||
|
||||
# [Search Filter component](../../../lib/content-services/search/components/search-filter/search-filter.component.ts "Defined in search-filter.component.ts")
|
||||
@@ -19,7 +19,7 @@ Represents a main container component for custom search and faceted search setti
|
||||
- [Categories and widgets](#categories-and-widgets)
|
||||
- [Facet Fields](#facet-fields)
|
||||
- [Facet Queries](#facet-queries)
|
||||
- [highlight](#highlight)
|
||||
- [Highlight](#highlight)
|
||||
- [Facet Intervals](#facet-intervals)
|
||||
- [See also](#see-also)
|
||||
|
||||
@@ -372,7 +372,9 @@ The default page size of 5 will be used if you set the value to 0 or omit it ent
|
||||
|
||||
### Facet Intervals
|
||||
|
||||
These provide custom categories based on admin defined ranges inside `intervals`. What is wanted for every interval can be specified exactly in the config file, and having overlapping ranges could also be possible.
|
||||
These provide custom categories based on admin defined ranges inside `intervals`.
|
||||
You can specify exactly what you want for each interval in the config file and you can
|
||||
use overlapping ranges if necessary.
|
||||
|
||||
#### FacetIntervals Properties
|
||||
|
||||
@@ -381,7 +383,8 @@ These provide custom categories based on admin defined ranges inside `intervals`
|
||||
| intervals | array | Specifies the fields to facet by interval. |
|
||||
| expanded | boolean | Toggles expanded state of the facet intervals. |
|
||||
|
||||
Note: `sets` parameter from Search API (Sets the intervals for all fields) is not yet supported.
|
||||
Note: the `sets` parameter from the Search API (which sets the intervals for all fields)
|
||||
is not yet supported.
|
||||
|
||||
```json
|
||||
{
|
||||
@@ -414,16 +417,17 @@ Note: `sets` parameter from Search API (Sets the intervals for all fields) is no
|
||||
```
|
||||
|
||||
You can specify a value for the `mincount` property inside each `intervals` item to set the minimum count required for a facet interval to be displayed. By default, only the intervals that have 1 or more response entries are displayed at runtime.
|
||||
Check the [schema.json](https://github.com/Alfresco/alfresco-ng2-components/blob/master/lib/core/app-config/schema.json)
|
||||
for more details about what is the structure and the properties of `intervals` that you can set inside the configuration file.
|
||||
Check the [schema.json](https://github.com/Alfresco/alfresco-ng2-components/blob/master/lib/core/app-config/schema.json) file
|
||||
for further details about the structure and properties of `intervals` that you can set inside the configuration file.
|
||||
|
||||
Each `intervals` item defined is collected into its collapsible category identified uniquely by its `label`. The top code snippet will result in the following display of the facet intervals:
|
||||
Each defined `intervals` item is collected into its own collapsible category identified uniquely
|
||||
by its `label`. The code snippet just above will result in the following display of facet intervals:
|
||||
|
||||
|
||||
|
||||
### Highlight
|
||||
|
||||
You can configure the Highlight using the `search` entry in the `app.config.json` file.
|
||||
You can configure highlighting using the `search` entry in the `app.config.json` file.
|
||||
An example query for search highlighting could look like this:
|
||||
|
||||
```json
|
||||
@@ -450,29 +454,31 @@ An example query for search highlighting could look like this:
|
||||
|
||||
```
|
||||
|
||||
The example above changes the highlighting prefix and postfix from the default for all fields to ¿? and just for the "description" field to (). The highlight information will then be added in each node entry response; here is an example partial response:
|
||||
The example above changes the highlighting prefix and postfix from the default to '¿?' for all
|
||||
fields except the "description" field, which uses '()' instead. The highlight information will
|
||||
then be added in each node entry response. An example partial response is shown below:
|
||||
|
||||
```json
|
||||
"entry": {
|
||||
"createdAt": "2016-10-12T15:24:31.202+0000",
|
||||
"isFolder": true,
|
||||
"search": {
|
||||
"score": 1,
|
||||
"highlight": [
|
||||
{
|
||||
"field": "cm:title",
|
||||
"snippets": [
|
||||
"createdAt": "2016-10-12T15:24:31.202+0000",
|
||||
"isFolder": true,
|
||||
"search": {
|
||||
"score": 1,
|
||||
"highlight": [
|
||||
{
|
||||
"field": "cm:title",
|
||||
"snippets": [
|
||||
"Customized ¿Workflow? Process Definitions"
|
||||
]
|
||||
},
|
||||
{
|
||||
"field": "description",
|
||||
"snippets": [
|
||||
]
|
||||
},
|
||||
{
|
||||
"field": "description",
|
||||
"snippets": [
|
||||
"Customized (Workflow) Process Definitions"
|
||||
]
|
||||
}
|
||||
]
|
||||
},
|
||||
]
|
||||
}
|
||||
]
|
||||
},
|
||||
```
|
||||
## See also
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
Title: DataTable component
|
||||
Added: v2.0.0
|
||||
Status: Active
|
||||
Last reviewed: 2018-11-12
|
||||
Last reviewed: 2019-03-20
|
||||
---
|
||||
|
||||
# [DataTable component](../../../lib/core/datatable/components/datatable/datatable.component.ts "Defined in datatable.component.ts")
|
||||
@@ -28,10 +28,6 @@ See it live: [DataTable Quickstart](https://embed.plnkr.co/80qr4YFBeHjLMdAV0F6l/
|
||||
- [Card view](#card-view)
|
||||
- [Using events](#using-events)
|
||||
- [Customizing the component's styles](#customizing-the-components-styles)
|
||||
- [Truncated text](#truncated-text)
|
||||
- [Expanded cells](#expanded-cells)
|
||||
- [Combining classes](#combining-classes)
|
||||
- [Sticky header](#sticky-header)
|
||||
- [See also](#see-also)
|
||||
|
||||
## Basic usage
|
||||
@@ -160,7 +156,7 @@ export class DataTableDemo {
|
||||
</adf-datatable>
|
||||
```
|
||||
|
||||
You can also set rows to the [`ObjectDataTableAdapter`](../../../lib/core/datatable/data/object-datatable-adapter.ts) and set columns as an input as shown below :
|
||||
You can also set rows in the [`ObjectDataTableAdapter`](../../../lib/core/datatable/data/object-datatable-adapter.ts) and set columns as an input as shown below :
|
||||
|
||||
```ts
|
||||
import { ObjectDataTableAdapter } from '@alfresco/adf-core';
|
||||
@@ -569,17 +565,19 @@ earlier), and perform the corresponding actions.
|
||||
|
||||
### Customizing the component's styles
|
||||
|
||||
The datatable component is ready to be used out of the box although you might want to customize it to better fit your needs.
|
||||
The datatable component is ready to be used out of the box but you can
|
||||
customize the styling to suit your needs as described in the following
|
||||
sections.
|
||||
|
||||
### Truncated text
|
||||
#### Truncated text
|
||||
|
||||
By default, the content of the cells is wrapped so you can see all the data inside. See picture bellow.
|
||||
By default, the content of the cells is wrapped so you can see all the data inside, as shown below:
|
||||
|
||||
|
||||
|
||||
However, you can also truncate the text within these cells by using the `adf-ellipsis-cell` class in the desired column.
|
||||
However, you can also truncate the text within these cells using the `adf-ellipsis-cell` class in the desired column:
|
||||
|
||||
```json
|
||||
```js
|
||||
{
|
||||
type: 'text',
|
||||
key: 'createdOn',
|
||||
@@ -591,19 +589,23 @@ However, you can also truncate the text within these cells by using the `adf-ell
|
||||
|
||||
|
||||
|
||||
### Expanded cells
|
||||
#### Expanded cells
|
||||
|
||||
This component makes use of a flex layout. All cells have the same semantic importance, so all of them have the same width. You can alter this behavior by adding one of the following classes in the desired column to make it grow wider.
|
||||
This component uses a flexible layout. By default, all cells are assumed
|
||||
to have the same semantic importance, so all of them have the same width. We provide a predefined set of CSS classes that you can use to
|
||||
vary the relative widths of the columns.
|
||||
|
||||
The classes have names of the form `adf-expand-cell-X`, going from `adf-expand-cell-1` to `adf-expand-cell-5`. The higher the number in the
|
||||
class the wider the column will be. Use these classes to vary the column
|
||||
widths according to your needs:
|
||||
|
||||
|
||||
|
||||
This classes go from `adf-expand-cell-1` to `adf-expand-cell-5`. The higher the number in the class the wider the column will get. You can choose the one that better suits your needs.
|
||||
#### Combining classes
|
||||
|
||||
### Combining classes
|
||||
You can combine the CSS classes described above to customize the table as needed:
|
||||
|
||||
All these classes can be combined together to fully fit your needs and make your datatable component look as you want.
|
||||
|
||||
```json
|
||||
```js
|
||||
{
|
||||
type: 'text',
|
||||
key: 'name',
|
||||
@@ -612,11 +614,12 @@ All these classes can be combined together to fully fit your needs and make your
|
||||
}
|
||||
```
|
||||
|
||||
### Sticky header
|
||||
#### Sticky header
|
||||
|
||||
If you have a long list of rows and you want to fix the header in place so you always see it you only have to follow this 2-step process.
|
||||
If you have a long table with many rows, you might want to fix the header in place so it is
|
||||
always visible. You can do this using the following steps.
|
||||
|
||||
First, you will need to set the stickyHeader property of your datatable to `true`:
|
||||
First, set the `stickyHeader` property of your datatable to `true`:
|
||||
|
||||
```html
|
||||
<adf-datatable
|
||||
@@ -625,7 +628,9 @@ First, you will need to set the stickyHeader property of your datatable to `true
|
||||
</adf-datatable>
|
||||
```
|
||||
|
||||
Second and last, you will need to set the height of your datatable in its parent's container so that the datatable adapts to it, i.e. `height: 300px;`. You will also need to set the overflow-y attribute to auto, `overflow-y: auto;`, so it hides when the rows exceed the height of the datatable component.
|
||||
Then, set the height of your datatable in its parent's container so that the datatable adapts to it (i.e. `height: 300px;` in the example below). You must also set the parent's
|
||||
[`overflow-y`](https://developer.mozilla.org/en-US/docs/Web/CSS/overflow-y) attribute to `auto`. This will allow the list to scroll when
|
||||
the total height of all rows exceeds the fixed height of the parent element.
|
||||
|
||||
```html
|
||||
<div style="height: 300px; overflow-y: auto;">
|
||||
@@ -636,7 +641,7 @@ Second and last, you will need to set the height of your datatable in its parent
|
||||
</div>
|
||||
```
|
||||
|
||||
Final result
|
||||
Once set up, the sticky header behaves as shown in the image below:
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
Title: Infinite Pagination component
|
||||
Added: v2.0.0
|
||||
Status: Active
|
||||
Last reviewed: 2019-02-08
|
||||
Last reviewed: 2019-03-20
|
||||
---
|
||||
|
||||
# [Infinite Pagination component](../../../lib/core/pagination/infinite-pagination.component.ts "Defined in infinite-pagination.component.ts")
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
Title: Login component
|
||||
Added: v2.0.0
|
||||
Status: Active
|
||||
Last reviewed: 2019-02-06
|
||||
Last reviewed: 2019-03-20
|
||||
---
|
||||
|
||||
# [Login component](../../../lib/core/login/components/login.component.ts "Defined in login.component.ts")
|
||||
@@ -299,11 +299,10 @@ automatically to the authorization server when the user is not logged-in
|
||||
|
||||
#### Silent login
|
||||
|
||||
You can also enable automatic redirection to OAuth provider
|
||||
by utilising the following properties:
|
||||
You can also enable automatic redirection to the OAuth provider using the following properties:
|
||||
|
||||
- silentLogin
|
||||
- redirectSilentIframeUri
|
||||
- `silentLogin`
|
||||
- `redirectSilentIframeUri`
|
||||
|
||||
```json
|
||||
{
|
||||
@@ -322,8 +321,8 @@ by utilising the following properties:
|
||||
},
|
||||
```
|
||||
|
||||
Please note that if you deploy the application to a virtual folder,
|
||||
for example `http://<ADDRESS>/my-app`, then `redirectSilentIframeUri`
|
||||
Note that if you deploy the application to a virtual folder
|
||||
(for example `http://<ADDRESS>/my-app`) then `redirectSilentIframeUri`
|
||||
must contain the full URI value:
|
||||
|
||||
```json
|
||||
|
||||
@@ -2,6 +2,7 @@
|
||||
Title: Logout directive
|
||||
Added: v2.0.0
|
||||
Status: Active
|
||||
Last reviewed: 2019-03-20
|
||||
---
|
||||
|
||||
# [Logout directive](../../../lib/core/directives/logout.directive.ts "Defined in logout.directive.ts")
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
Title: Thumbnail service
|
||||
Added: v2.0.0
|
||||
Status: Active
|
||||
Last reviewed: 2018-11-13
|
||||
Last reviewed: 2019-03-20
|
||||
---
|
||||
|
||||
# [Thumbnail service](../../../lib/core/services/thumbnail.service.ts "Defined in thumbnail.service.ts")
|
||||
|
||||
@@ -2,12 +2,12 @@
|
||||
Title: Edit Process Filter Cloud component
|
||||
Added: v3.0.0
|
||||
Status: Experimental
|
||||
Last reviewed: 2019-01-30
|
||||
Last reviewed: 2019-03-20
|
||||
---
|
||||
|
||||
# [Edit Process Filter Cloud component](../../../lib/process-services-cloud/src/lib/process/process-filters/components/edit-process-filter-cloud.component.ts "Defined in edit-process-filter-cloud.component.ts")
|
||||
|
||||
Shows Process Filter Details.
|
||||
Shows/edits process filter details.
|
||||
|
||||
|
||||
|
||||
@@ -72,7 +72,7 @@ Use the `appName` and `id` properties to choose which process filter to edit:
|
||||
|
||||
### Filter properties
|
||||
|
||||
You can supply various _filter properties_ to edit that 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:
|
||||
|
||||
|
||||
@@ -2,12 +2,12 @@
|
||||
Title: Edit Task Filter Cloud component
|
||||
Added: v3.0.0
|
||||
Status: Experimental
|
||||
Last reviewed: 2019-01-30
|
||||
Last reviewed: 2019-03-20
|
||||
---
|
||||
|
||||
# [Edit Task Filter Cloud component](../../../lib/process-services-cloud/src/lib/task/task-filters/components/edit-task-filter-cloud.component.ts "Defined in edit-task-filter-cloud.component.ts")
|
||||
|
||||
Edits Task Filter Details.
|
||||
Edits task filter details.
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
Title: Group Cloud component
|
||||
Added: v3.0.0
|
||||
Status: Experimental
|
||||
Last reviewed: 2019-01-15
|
||||
Last reviewed: 2019-03-20
|
||||
---
|
||||
|
||||
# [Group Cloud component](../../../lib/process-services-cloud/src/lib/group/components/group-cloud.component.ts "Defined in group-cloud.component.ts")
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
Title: People Cloud Component
|
||||
Added: v3.0.0
|
||||
Status: Experimental
|
||||
Last reviewed: 2019-01-18
|
||||
Last reviewed: 2019-03-20
|
||||
---
|
||||
|
||||
# [People Cloud Component](../../../lib/process-services-cloud/src/lib/task/start-task/components/people-cloud/people-cloud.component.ts "Defined in people-cloud.component.ts")
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
Title: Process Instance List Cloud component
|
||||
Added: v3.0.0
|
||||
Status: Experimental
|
||||
Last reviewed: 2018-11-09
|
||||
Last reviewed: 2019-03-20
|
||||
---
|
||||
|
||||
# [Process Instance List Cloud component](../../../lib/process-services-cloud/src/lib/process/process-list/components/process-list-cloud.component.ts "Defined in process-list-cloud.component.ts")
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
Title: Start Process Cloud Component
|
||||
Added: v3.0.0
|
||||
Status: Experimental
|
||||
Last reviewed: 2019-01-08
|
||||
Last reviewed: 2019-03-20
|
||||
---
|
||||
|
||||
# [Start Process Cloud Component](../../../lib/process-services-cloud/src/lib/process/start-process/components/start-process-cloud.component.ts "Defined in start-process-cloud.component.ts")
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
Title: Start Task Cloud Component
|
||||
Added: v3.0.0
|
||||
Status: Experimental
|
||||
Last reviewed: 2019-01-08
|
||||
Last reviewed: 2019-03-20
|
||||
---
|
||||
|
||||
# [Start Task Cloud Component](../../../lib/process-services-cloud/src/lib/task/start-task/components/start-task-cloud.component.ts "Defined in start-task-cloud.component.ts")
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
Title: Task Header Cloud Component
|
||||
Added: v3.0.0
|
||||
Status: Experimental
|
||||
Last reviewed: 2019-01-18
|
||||
Last reviewed: 2019-03-20
|
||||
---
|
||||
|
||||
# [Task Header Cloud Component](../../../lib/process-services-cloud/src/lib/task/task-header/components/task-header-cloud.component.ts "Defined in task-header-cloud.component.ts")
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
Title: Task List Cloud component
|
||||
Added: v3.0.0
|
||||
Status: Experimental
|
||||
Last reviewed: 2019-01-08
|
||||
Last reviewed: 2019-03-20
|
||||
---
|
||||
|
||||
# [Task List Cloud component](../../../lib/process-services-cloud/src/lib/task/task-list/components/task-list-cloud.component.ts "Defined in task-list-cloud.component.ts")
|
||||
@@ -217,5 +217,5 @@ You can customize the styling of a column and also add features like tooltips an
|
||||
## See also
|
||||
|
||||
- [Data column component](../../core/components/data-column.component.md)
|
||||
- [`DataTableAdapter`](../../../lib/core/datatable/data/datatable-adapter.ts)
|
||||
- [Data Table Adapter interface](../../core/interfaces/datatable-adapter.interface.md)
|
||||
- [Pagination component](../../core/components/pagination.component.md)
|
||||
|
||||
@@ -1,48 +0,0 @@
|
||||
---
|
||||
Title: Task Header Cloud Service
|
||||
Added: v3.0.0
|
||||
Status: Experimental
|
||||
Last reviewed: 2019-01-18
|
||||
---
|
||||
|
||||
# [Task Header Cloud Service](../../../lib/process-services-cloud/src/lib/task/task-header/services/task-header-cloud.service.ts "Defined in task-header-cloud.service.ts")
|
||||
|
||||
Manages cloud tasks.
|
||||
|
||||
## Class members
|
||||
|
||||
### Methods
|
||||
|
||||
- **claimTask**(appName: `string`, taskId: `string`, assignee: `string`): `any`<br/>
|
||||
Claims a task for an assignee.
|
||||
- _appName:_ `string` - Name of the app
|
||||
- _taskId:_ `string` - ID of the task to claim
|
||||
- _assignee:_ `string` - User to assign the task to
|
||||
- **Returns** `any` - Details of the claimed task
|
||||
- **getTaskById**(appName: `string`, taskId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts)`>`<br/>
|
||||
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
|
||||
- **unclaimTask**(appName: `string`, taskId: `string`): `any`<br/>
|
||||
Un-claims a task.
|
||||
- _appName:_ `string` - Name of the app
|
||||
- _taskId:_ `string` - ID of the task to unclaim
|
||||
- **Returns** `any` - Details of the task that was unclaimed
|
||||
- **updateTask**(appName: `string`, taskId: `string`, updatePayload: `any`): `any`<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
|
||||
- _updatePayload:_ `any` - Data to update the task
|
||||
- **Returns** `any` - Updated task details
|
||||
|
||||
## Details
|
||||
|
||||
The methods work in much the same way as the equivalent methods in the
|
||||
[Tasklist service](../../process-services/services/tasklist.service.md)
|
||||
but they use the cloud variants of the classes for return values. See the
|
||||
[Tasklist service](../../process-services/services/tasklist.service.md) page for usage examples.
|
||||
|
||||
## See also
|
||||
|
||||
- [Tasklist service](../../process-services/services/tasklist.service.md)
|
||||
@@ -33,7 +33,7 @@ special sub-components in the body of the `<adf-people-search>` element:
|
||||
|
||||
| Name | Type | Default value | Description |
|
||||
| ---- | ---- | ------------- | ----------- |
|
||||
| results | [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`UserProcessModel`](../../core/user-process.model.md)`[]>` | | Parameters for displaying the list. |
|
||||
| results | [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`UserProcessModel`](../../core/models/user-process.model.md)`[]>` | | Parameters for displaying the list. |
|
||||
|
||||
### Events
|
||||
|
||||
@@ -41,7 +41,7 @@ special sub-components in the body of the `<adf-people-search>` element:
|
||||
| ---- | ---- | ----------- |
|
||||
| closeSearch | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<Object>` | Emitted when the "close" button is clicked. |
|
||||
| searchPeople | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when a search is performed with a new keyword. |
|
||||
| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`UserProcessModel`](../../core/user-process.model.md)`>` | Emitted when a user is selected and the action button is clicked. |
|
||||
| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`UserProcessModel`](../../core/models/user-process.model.md)`>` | Emitted when a user is selected and the action button is clicked. |
|
||||
|
||||
## Details
|
||||
|
||||
|
||||
@@ -39,7 +39,7 @@ Displays users involved with a specified task
|
||||
|
||||
| Name | Type | Default value | Description |
|
||||
| ---- | ---- | ------------- | ----------- |
|
||||
| people | [`UserProcessModel`](../../core/user-process.model.md)`[]` | \[] | The array of User objects to display. |
|
||||
| people | [`UserProcessModel`](../../core/models/user-process.model.md)`[]` | \[] | The array of User objects to display. |
|
||||
| readOnly | `boolean` | false | Should the data be read-only? |
|
||||
| taskId | `string` | "" | The numeric ID of the task. |
|
||||
|
||||
|
||||
@@ -2,12 +2,12 @@
|
||||
Title: Process Service
|
||||
Added: v2.0.0
|
||||
Status: Active
|
||||
Last reviewed: 2018-03-20
|
||||
Last reviewed: 2019-03-20
|
||||
---
|
||||
|
||||
# [Process Service](../../../lib/process-services/process-list/services/process.service.ts "Defined in process.service.ts")
|
||||
|
||||
Manages Process Instances, Process Variables, and Process Audit Log.
|
||||
Manages process instances, process variables, and process audit Log.
|
||||
|
||||
## Class members
|
||||
|
||||
|
||||
@@ -54,7 +54,7 @@ We will keep these packages until material data picker supports setting the time
|
||||
|
||||
Continuing on our journey for ADF, this release had a big focus on enhancing the Alfresco Digital Business Platform story. We have added new features to enable deeper Process and Content integration between ACS and APS, meaning you can now browse and attach content from ACS in your APS Forms. We've also added more configuration around the Process Start [Form,](../../lib/process-services/task-list/models/form.model.ts) allowing you to pre-populate fields. This enables use cases to start processes directly from a document.
|
||||
|
||||
The [Content Metadata component](../content-services/components/content-metadata.component.md) also got a lot of new features: It now has full support for custom metadata and aspects. It's dynamic and has complex configuration to enable exactly which aspects and properties you want to show in your app. These are just a few highlights for this release. See the full details below.
|
||||
The [Content Metadata component](../content-services/components/content-metadata-card.component.md) also got a lot of new features: It now has full support for custom metadata and aspects. It's dynamic and has complex configuration to enable exactly which aspects and properties you want to show in your app. These are just a few highlights for this release. See the full details below.
|
||||
|
||||
This release builds on the one from last month and contains bug fixes and new features as listed below.
|
||||
Please report issues with this release in the [issue tracker](https://github.com/Alfresco/alfresco-ng2-components/issues). You can collaborate on this release or share feedback by using the discussion tools on [Gitter](https://gitter.im/Alfresco/alfresco-ng2-components).
|
||||
@@ -66,7 +66,7 @@ Below are the most important new features of this release:
|
||||
- Viewer Enhancements
|
||||
- Upload file from CS widget
|
||||
- Attach Folder from CS Widget
|
||||
- [Content metadata component](../content-services/components/content-metadata.component.md) enhancements
|
||||
- [Content metadata component](../content-services/components/content-metadata-card.component.md) enhancements
|
||||
- Start process from a file
|
||||
- Start form process pre-filling value
|
||||
- Task List - Support custom HTML template and static columns
|
||||
@@ -107,11 +107,11 @@ As you can see this widget works like the attach file widget in terms of navigat
|
||||
|
||||
|
||||
|
||||
The purpose of the [content metadata component](../content-services/components/content-metadata.component.md) is to display the metadata belonging to a given node. Until now, the component was capable of displaying and making the basic properties editable, but with the latest enhancements, all of the system wide and custom aspects related to a particular node can be displayed and edited.
|
||||
The purpose of the [content metadata component](../content-services/components/content-metadata-card.component.md) is to display the metadata belonging to a given node. Until now, the component was capable of displaying and making the basic properties editable, but with the latest enhancements, all of the system wide and custom aspects related to a particular node can be displayed and edited.
|
||||
|
||||
The component can be configured from the application configuration. This way, you can easily restrict the displayed metadata to a list of aspects or even further, to just a subset or properties belonging to an aspect.
|
||||
|
||||
For more information about the component see its [documentation](https://community.alfresco.com/docs/DOC-7301-introduction-to-the-new-content-metadata-component) or [this article](../content-services/components/content-metadata.component.md).
|
||||
For more information about the component see its [documentation](https://community.alfresco.com/docs/DOC-7301-introduction-to-the-new-content-metadata-component) or [this article](../content-services/components/content-metadata-card.component.md).
|
||||
|
||||
### 5. Start process from a file
|
||||
|
||||
|
||||
@@ -67,7 +67,7 @@ Below are the most important new features of this release:
|
||||
- Inherit Permission Button
|
||||
- [Permission List Component](../content-services/components/permission-list.component.md)
|
||||
- [Sidenav Layout Component](../core/components/sidenav-layout.component.md)
|
||||
- [Content metadata component](../content-services/components/content-metadata.component.md) enhancement
|
||||
- [Content metadata component](../content-services/components/content-metadata-card.component.md) enhancement
|
||||
- Search Enhancements
|
||||
- Search Chip List
|
||||
- Version Management Enhancements
|
||||
|
||||
@@ -201,7 +201,7 @@ links to documentation and source code:
|
||||
| [Start process cloud service](../process-services-cloud/services/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](../process-services-cloud/services/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](../process-services-cloud/services/task-filter-cloud.service.md)  | Manages task filters. | [Source](../../lib/process-services-cloud/src/lib/task/task-filters/services/task-filter-cloud.service.ts) |
|
||||
| [Task header cloud service](../process-services-cloud/services/task-header-cloud.service.md)  | Manages cloud tasks. | [Source](../../lib/process-services-cloud/src/lib/task/task-header/services/task-header-cloud.service.ts) |
|
||||
| [Task cloud service](../process-services-cloud/services/task-cloud.service.md)  | Manages cloud tasks. | [Source](../../lib/process-services-cloud/src/lib/task/task-header/services/task-cloud.service.ts) |
|
||||
| [Task list cloud service](../process-services-cloud/services/task-list-cloud.service.md)  | Searches tasks. | [Source](../../lib/process-services-cloud/src/lib/task/task-list/services/task-list-cloud.service.ts) |
|
||||
|
||||
<!--process-services-cloud end-->
|
||||
|
||||
@@ -18,4 +18,4 @@ Github only: true
|
||||
| [**Working with a Data Table**](working-with-data-table.md) | Intermediate | In this tutorial you will learn how to populate a DataTable component. |
|
||||
| [**Working with the Nodes API Service**](working-with-nodes-api-service.md) | Intermediate | In this tutorial you will learn how to use the [`NodesApiService`](../core/services/nodes-api.service.md). |
|
||||
| [**Working with Nodes using the JS API**](working-with-nodes-js-api.md) | Intermediate | In this tutorial you will learn how to use the [`AlfrescoCoreRestApi`](https://github.com/Alfresco/alfresco-js-api/tree/master/src/alfresco-core-rest-api). |
|
||||
| [**Content metadata component**](content-metadata-component.md) | Advanced | In this tutorial you will learn how to work with the [`ContentMetadataComponent`](../content-services/components/content-metadata.component.md). |
|
||||
| [**Content metadata component**](content-metadata-component.md) | Advanced | In this tutorial you will learn how to work with the [`ContentMetadataComponent`](../content-services/components/content-metadata-card.component.md). |
|
||||
|
||||
@@ -5,13 +5,13 @@ Level: Advanced
|
||||
|
||||
# Content metadata component
|
||||
|
||||
In this tutorial you will learn how to work with the [`ContentMetadataComponent`](../content-services/components/content-metadata.component.md).
|
||||
In this tutorial you will learn how to work with the [`ContentMetadataComponent`](../content-services/components/content-metadata-card.component.md).
|
||||
|
||||
This component is used to render the standard and custom metadata of generic content item (called a _node_) stored in Alfresco Content Services. With the usual approach "learning by doing", you will see here some practical examples you might find useful in your own applicatioin. As a starting point, we will use and customize the [Alfresco Content App](https://github.com/Alfresco/alfresco-content-app).
|
||||
|
||||
## About the `ContentMetadataComponent`
|
||||
|
||||
As described in the [`ContentMetadataComponent`](../content-services/components/content-metadata.component.md) documentation, the `adf-content-metadata-card` tag has some useful attributes, included the `preset` attribute, which is used to point to a collection of aspects/properties to render.
|
||||
As described in the [`ContentMetadataComponent`](../content-services/components/content-metadata-card.component.md) documentation, the `adf-content-metadata-card` tag has some useful attributes, included the `preset` attribute, which is used to point to a collection of aspects/properties to render.
|
||||
|
||||
Below, you can see the `preset` value requesting to render all the available aspects/properties:
|
||||
|
||||
|
||||
@@ -72,7 +72,6 @@ backend services have been tested with each released version of ADF.
|
||||
- [Task filter cloud service](process-services-cloud/services/task-filter-cloud.service.md)
|
||||
- [Task filters cloud component](process-services-cloud/components/task-filters-cloud.component.md)
|
||||
- [Task header cloud component](process-services-cloud/components/task-header-cloud.component.md)
|
||||
- [Task header cloud service](process-services-cloud/services/task-header-cloud.service.md)
|
||||
- [Task list cloud component](process-services-cloud/components/task-list-cloud.component.md)
|
||||
- [Task list cloud service](process-services-cloud/services/task-list-cloud.service.md)
|
||||
- [Tree view component](content-services/components/tree-view.component.md)
|
||||
|
||||
@@ -20,7 +20,7 @@ var angFilePattern = /(component)|(directive)|(model)|(pipe)|(service)|(widget)/
|
||||
var srcData = {};
|
||||
var stoplist = new stoplist_1.Stoplist(stoplistFilePath);
|
||||
var docsFolderPath = path.resolve("docs");
|
||||
var libFolders = ["core", "content-services", "process-services", "insights", "process-services-cloud"];
|
||||
var libFolders = ["core", "content-services", "extensions", "insights", "process-services", "process-services-cloud"];
|
||||
libsearch(srcData, path.resolve(libFolder));
|
||||
/*
|
||||
let keys = Object.keys(srcData);
|
||||
@@ -89,15 +89,35 @@ function getDocFilePaths(folderPath) {
|
||||
var result = [];
|
||||
libFolders.forEach(function (element) {
|
||||
var libPath = path.resolve(folderPath, element);
|
||||
var files = fs.readdirSync(libPath);
|
||||
files = files.filter(function (filename) {
|
||||
return (path.extname(filename) === ".md") &&
|
||||
(filename !== "README.md") &&
|
||||
(filename.match(angFilePattern));
|
||||
});
|
||||
files.forEach(function (element) {
|
||||
result.push(path.join(libPath, element));
|
||||
});
|
||||
addItemsRecursively(libPath, result);
|
||||
var items = fs.readdirSync(libPath);
|
||||
/*
|
||||
|
||||
files = files.filter(filename =>
|
||||
(path.extname(filename) === ".md") &&
|
||||
(filename !== "README.md") &&
|
||||
(filename.match(angFilePattern))
|
||||
);
|
||||
|
||||
files.forEach(element => {
|
||||
result.push(path.join(libPath, element));
|
||||
});
|
||||
*/
|
||||
});
|
||||
return result;
|
||||
function addItemsRecursively(folderPath, resultList) {
|
||||
var items = fs.readdirSync(folderPath);
|
||||
items.forEach(function (item) {
|
||||
var fullItemPath = path.resolve(folderPath, item);
|
||||
var itemInfo = fs.statSync(fullItemPath);
|
||||
if (itemInfo.isDirectory()) {
|
||||
addItemsRecursively(fullItemPath, resultList);
|
||||
}
|
||||
else if ((path.extname(fullItemPath) === ".md") &&
|
||||
(item !== "README.md") &&
|
||||
(item.match(angFilePattern))) {
|
||||
resultList.push(fullItemPath);
|
||||
}
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
@@ -29,7 +29,7 @@ let stoplist = new Stoplist(stoplistFilePath);
|
||||
|
||||
let docsFolderPath = path.resolve("docs");
|
||||
|
||||
let libFolders = ["core", "content-services", "process-services", "insights", "process-services-cloud"];
|
||||
let libFolders = ["core", "content-services", "extensions", "insights", "process-services", "process-services-cloud"];
|
||||
|
||||
libsearch(srcData, path.resolve(libFolder));
|
||||
|
||||
@@ -146,7 +146,10 @@ function getDocFilePaths(folderPath) {
|
||||
|
||||
libFolders.forEach(element => {
|
||||
let libPath = path.resolve(folderPath, element);
|
||||
let files = fs.readdirSync(libPath);
|
||||
addItemsRecursively(libPath, result);
|
||||
let items = fs.readdirSync(libPath);
|
||||
|
||||
/*
|
||||
|
||||
files = files.filter(filename =>
|
||||
(path.extname(filename) === ".md") &&
|
||||
@@ -157,8 +160,28 @@ function getDocFilePaths(folderPath) {
|
||||
files.forEach(element => {
|
||||
result.push(path.join(libPath, element));
|
||||
});
|
||||
*/
|
||||
});
|
||||
|
||||
|
||||
return result;
|
||||
|
||||
function addItemsRecursively(folderPath: string, resultList: string[]) {
|
||||
let items = fs.readdirSync(folderPath);
|
||||
|
||||
items.forEach(item => {
|
||||
let fullItemPath = path.resolve(folderPath, item);
|
||||
let itemInfo = fs.statSync(fullItemPath);
|
||||
|
||||
if (itemInfo.isDirectory()) {
|
||||
addItemsRecursively(fullItemPath, resultList);
|
||||
} else if (
|
||||
(path.extname(fullItemPath) === ".md") &&
|
||||
(item !== "README.md") &&
|
||||
(item.match(angFilePattern))
|
||||
) {
|
||||
resultList.push(fullItemPath);
|
||||
}
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user