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-1453] Restructure README.md files (#2239)

Browse Source 
* ADF-1453: Restructured Activiti Analytics readme

* ADF-1453: Restructured Activiti Diagrams readme

* ADF-1453: Restructured Activiti Form readme

* ADF-1453: Restructured Activiti Process List readme

* ADF-1453: Restructured Activiti Task List readme

* ADF-1453: Restructured Alfresco Core readme

* [ADF-1453] Restructured DataTable readme

* [ADF-1453] Restructured Document List readme

* [ADF-1453] Restructured Login readme

* [ADF-1453] Restructured Alfresco Search readme

* [ADF-1453] Restructured Alfresco Social readme

* [ADF-1453] Restructured Alfresco Tag readme

* [ADF-1453] Restructured Alfresco User Info readme

* [ADF-1453] Restructured Alfresco Viewer readme

* [ADF-1453] Restructured Alfresco Webscript readme

* [ADF-1453] Fixed table display glitch

* [ADF-1453] Fixed Markdown lint errors in readme files

* [ADF-1453] Adding missing fileUploadDelete event to table in Upload readme

* [ADF-1453] Resolved merge conflict with Upload readme

* [ADF-1453] Changes from npm run doc
This commit is contained in:
Andy Stark
2017-08-25 17:27:09 +01:00
committed by Mario Romano
parent 541cbcb258
commit 54f4a07f53
25 changed files with 2034 additions and 1666 deletions
Download Patch File Download Diff File Expand all files Collapse all files

216
ng2-components/ng2-activiti-processlist/README.md
View File

@@ -1,71 +1,75 @@
# Activiti Process List Component
# Activiti Process List library
Contains the Activiti Process Instance List component and other related components and classes.
<!-- markdown-toc start - Don't edit this section. npm run toc to generate it-->
<!-- toc -->
- [Prerequisites](#prerequisites)
- [Install](#install)
- [Activiti Process Instance List](#activiti-process-instance-list)
* [Properties](#properties)
* [Events](#events)
* [Basic Usage](#basic-usage)
+ [Properties](#properties)
+ [Events](#events)
* [Details](#details)
- [Process Filters Component](#process-filters-component)
* [Properties](#properties-1)
* [Events](#events-1)
* [How filter the activiti process filters](#how-filter-the-activiti-process-filters)
- [FilterParamsModel](#filterparamsmodel)
* [How to create an accordion menu with the processes filter](#how-to-create-an-accordion-menu-with-the-processes-filter)
* [Basic Usage](#basic-usage-1)
+ [Properties](#properties-1)
+ [Events](#events-1)
* [Details](#details-1)
+ [How filter the activiti process filters](#how-filter-the-activiti-process-filters)
+ [FilterParamsModel](#filterparamsmodel)
+ [How to create an accordion menu with the processes filter](#how-to-create-an-accordion-menu-with-the-processes-filter)
- [Start Process component](#start-process-component)
* [Properties](#properties-2)
* [Events](#events-2)
* [Basic Usage](#basic-usage-2)
+ [Properties](#properties-2)
+ [Events](#events-2)
- [Process Details component](#process-details-component)
* [Properties](#properties-3)
* [Events](#events-3)
* [Basic Usage](#basic-usage-3)
+ [Properties](#properties-3)
+ [Events](#events-3)
- [Process Instance Details Header component](#process-instance-details-header-component)
* [Properties](#properties-4)
* [Events](#events-4)
* [Basic Usage](#basic-usage-4)
+ [Properties](#properties-4)
+ [Events](#events-4)
- [Process Instance Tasks component](#process-instance-tasks-component)
* [Properties](#properties-5)
* [Events](#events-5)
* [Basic Usage](#basic-usage-5)
+ [Properties](#properties-5)
+ [Events](#events-5)
- [Process Instance Comments component](#process-instance-comments-component)
* [Properties](#properties-6)
* [Basic Usage](#basic-usage-6)
+ [Properties](#properties-6)
- [Process Attachment List component](#process-attachment-list-component)
* [Properties](#properties-7)
* [Events](#events-6)
* [Basic Usage](#basic-usage-7)
+ [Properties](#properties-7)
+ [Events](#events-6)
- [Create Process Attachment component](#create-process-attachment-component)
* [Properties](#properties-8)
* [Events](#events-7)
* [Basic Usage](#basic-usage-8)
+ [Properties](#properties-8)
+ [Events](#events-7)
- [Process Audit Directive](#process-audit-directive)
* [Properties](#properties-9)
* [Basic Usage](#basic-usage-9)
+ [Properties](#properties-9)
+ [Events](#events-8)
- [Build from sources](#build-from-sources)
- [NPM scripts](#npm-scripts)
- [Demo](#demo)
- [License](#license)
- [Project Information](#project-information)
* [Prerequisites](#prerequisites)
* [Install](#install)
* [Build from sources](#build-from-sources)
* [NPM scripts](#npm-scripts)
* [Demo](#demo)
* [License](#license)
<!-- tocstop -->
<!-- markdown-toc end -->
Displays lists of process instances both active and completed, using any defined process filter, and renders details for any chosen instance.
## Prerequisites
Before you start using this development framework, make sure you have installed all required software and done all the
necessary configuration [prerequisites](https://github.com/Alfresco/alfresco-ng2-components/blob/master/PREREQUISITES.md).
> If you plan using this component with projects generated by Angular CLI, please refer to the following article: [Using ADF with Angular CLI](https://github.com/Alfresco/alfresco-ng2-components/wiki/Angular-CLI)
## Install
```sh
npm install ng2-activiti-processlist
```
<!-- Displays lists of process instances both active and completed, using any defined process filter, and renders details for any chosen instance.-->
## Activiti Process Instance List
This component renders a list containing all the process instances matched by the parameters specified.
### Basic Usage
**app.component.html**
```html
@@ -75,7 +79,7 @@ This component renders a list containing all the process instances matched by th
</adf-process-instance-list>
```
### Properties
#### Properties
| Name | Description |
| --- | --- |
@@ -83,9 +87,17 @@ This component renders a list containing all the process instances matched by th
| processDefinitionKey | The processDefinitionKey of the process. |
| state | Define state of the processes. Possible values are `running`, `completed` and `all` |
| sort | Define sort of the processes. Possible values are `created-desc`, `created-asc`, `ended-desc`, `ended-asc` |
| schemaColumn | List of columns to display in the process instances datatable |
| schemaColumn | List of columns to display in the process instances datatable (see the [Details](#details) section below) |
Example:
#### Events
- **rowClick**: Emitted when a row in the process list is clicked
- **onSuccess**: Emitted when the list of process instances has been loaded successfully from the server
- **onError**: Emitted when an error is encountered loading the list of process instances from the server
### Details
Example value for the schemaColumn property (see [Properties](#properties) section above):
```json
[
@@ -96,20 +108,11 @@ Example:
]
```
### Events
- **rowClick**: Emitted when a row in the process list is clicked
- **onSuccess**: Emitted when the list of process instances has been loaded successfully from the server
- **onError**: Emitted when an error is encountered loading the list of process instances from the server
## Process Filters Component
Process filters are a collection of criteria used to filter process instances, which may be customized
by users. This component displays a list of available filters and allows the user to select any given
filter as the active filter.
Collection of criteria used to filter process instances, which may be customized by users.
The most common usage is in driving a process instance list to allow the user to choose which
process instances are displayed in the list.
### Basic Usage
```html
<adf-process-instance-filters
@@ -117,10 +120,10 @@ process instances are displayed in the list.
</adf-process-instance-filters>
```
### Properties
#### 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. |
@@ -128,7 +131,7 @@ process instances are displayed in the list.
If both `appId` and `appName` are specified then `appName` will take precedence and `appId` will be ignored.
### Events
#### Events
| Name | Description |
| --- | --- |
@@ -136,7 +139,15 @@ If both `appId` and `appName` are specified then `appName` will take precedence
| onError | Raised when an error occurs |
| filterClick | Raised when the user selects a filter from the list |
### How filter the activiti process filters
### Details
This component displays a list of available filters and allows the user to select any given
filter as the active filter.
The most common usage is in driving a process instance list to allow the user to choose which
process instances are displayed in the list.
#### How filter the activiti process filters
```html
<adf-process-instance-filters
@@ -144,9 +155,9 @@ If both `appId` and `appName` are specified then `appName` will take precedence
</adf-filters>
```
You can use inside the filterParam one of the following property.
You can use inside the filterParam one of the properties defined by [FilterParamsModel](#filterparamsmodel) (see below).
## FilterParamsModel
#### FilterParamsModel
```json
{
@@ -162,7 +173,7 @@ You can use inside the filterParam one of the following property.
| name | string | The name of the task filter, lowercase is checked. |
| index | number | Zero-based position of the filter in the array. |
### How to create an accordion menu with the processes filter
#### How to create an accordion menu with the processes filter
You can create an accordion menu using the AccordionComponent that wrap the activiti task filter.
The AccordionComponent is exposed by the alfresco-core.
@@ -188,6 +199,8 @@ The AccordionComponent is exposed by the alfresco-core.
Displays Start Process, allowing the user to specify some basic details needed to start a new process instance.
### Basic Usage
```html
<adf-start-process
appId="YOUR_APP_ID" >
@@ -195,14 +208,14 @@ Displays Start Process, allowing the user to specify some basic details needed t
```
![adf-start-process ](docs/assets/start-process.png)
### Properties
#### Properties
| Name | Description |
| --- | --- |
| appId | (required): Limit the list of processes which can be started to those contained in the specified app |
| variables | Variables in input to the process [RestVariable](https://github.com/Alfresco/alfresco-js-api/tree/master/src/alfresco-activiti-rest-api/docs/RestVariable.md)|
### Events
#### Events
| Name | Description |
| --- | --- |
@@ -212,7 +225,9 @@ Displays Start Process, allowing the user to specify some basic details needed t
## Process Details component
This component displays detailed information on a specified process instance
Displays detailed information on a specified process instance
### Basic Usage
```html
<adf-process-instance-details
@@ -220,13 +235,13 @@ This component displays detailed information on a specified process instance
</adf-process-instance-details>
```
### Properties
#### Properties
| Name | Type | Description |
| --- | --- | --- |
| processInstanceId | string | (required): The numeric ID of the process instance to display |
### Events
#### Events
| Name | Description |
| --- | --- |
@@ -236,7 +251,9 @@ This component displays detailed information on a specified process instance
## Process Instance Details Header component
This is a sub-component of the process details component, which renders some general information about the selected process.
Sub-component of the process details component, which renders some general information about the selected process.
### Basic Usage
```html
<adf-process-instance-header
@@ -245,20 +262,22 @@ This is a sub-component of the process details component, which renders some gen
```
![adf-process-instance-header](docs/assets/adf-process-instance-header-attachment.png)
### Properties
#### Properties
| Name | Type| Description |
| --- | --- | --- |
| processInstance | [ProcessInstanceModel](https://github.com/Alfresco/alfresco-ng2-components/blob/master/ng2-components/ng2-activiti-processlist/src/models/process-instance.model.ts) | (**required**): Full details of the process instance to display information about |
### Events
#### Events
No events
This component does not define any events.
## Process Instance Tasks component
Lists both the active and completed tasks associated with a particular process instance
### Basic Usage
```html
<adf-process-instance-tasks
processInstanceId="YOUR_PROCESS_INSTANCE_ID"
@@ -266,14 +285,14 @@ Lists both the active and completed tasks associated with a particular process i
</adf-process-instance-tasks>
```
### Properties
#### Properties
| Name | Type | Description |
| --- | --- | --- |
| processInstanceId | string | (**required**): The ID of the process instance to display tasks for |
| showRefreshButton | boolean | (default: `true`): Whether to show a refresh button next to the list of tasks to allow this to be updated from the server |
### Events
#### Events
| Name | Description |
| --- | --- |
@@ -283,13 +302,15 @@ Lists both the active and completed tasks associated with a particular process i
Displays comments associated with a particular process instance and allows the user to add new comments
### Basic Usage
```html
<adf-process-instance-comments
processInstanceId="YOUR_PROCESS_INSTANCE_ID">
</adf-process-instance-comments>
```
### Properties
#### Properties
| Name | Type | Description |
| --- | --- | --- |
@@ -297,7 +318,9 @@ Displays comments associated with a particular process instance and allows the u
## Process Attachment List component
This component displays attached documents on a specified process instance
Displays attached documents on a specified process instance
### Basic Usage
```html
<adf-process-attachment-list
@@ -307,14 +330,14 @@ This component displays attached documents on a specified process instance
```
![process-attachment-list-sample](docs/assets/process-attachment-list.png)
### Properties
#### Properties
| Name | Type | Description |
| --- | --- | -- |
| processInstanceId | string | (**required**): The ID of the process instance to display |
| disabled | boolean | false | Disable/Enable read only mode for attachement list |
### Events
#### Events
| Name | Description |
| --- | --- |
@@ -324,7 +347,9 @@ This component displays attached documents on a specified process instance
## Create Process Attachment component
This component displays Upload Component(Drag and Click) to upload the attachment to a specified process instance
Displays Upload Component(Drag and Click) to upload the attachment to a specified process instance
### Basic Usage
```html
<adf-create-process-attachment
@@ -336,13 +361,13 @@ This component displays Upload Component(Drag and Click) to upload the attachmen
![process-create-attachment](docs/assets/process-create-attachment.png)
### Properties
#### Properties
| Name | Type | Description |
| --- | --- | --- |
| processInstanceId | string | (**required**): The ID of the process instance to display |
### Events
#### Events
| Name | Description |
| --- | --- |
@@ -351,7 +376,9 @@ This component displays Upload Component(Drag and Click) to upload the attachmen
## Process Audit Directive
This directive provide a way to fetch the Process Audit information in the pdf or json format.
Provide a way to fetch the Process Audit information in the pdf or json format.
### Basic Usage
```html
<button
@@ -366,7 +393,7 @@ This directive provide a way to fetch the Process Audit information in the pdf o
![adf-process-audit-directive](docs/assets/adf-process-audit-directive.png)
### Properties
#### Properties
| Name | Type | Default | Description |
| --- | --- | --- | --- |
@@ -382,7 +409,22 @@ This directive provide a way to fetch the Process Audit information in the pdf o
| clicked | Raised when the task audit info is ready |
| error | Raised if there is an error during fetching task information |
## Build from sources
## Project Information
### Prerequisites
Before you start using this development framework, make sure you have installed all required software and done all the
necessary configuration [prerequisites](https://github.com/Alfresco/alfresco-ng2-components/blob/master/PREREQUISITES.md).
> If you plan using this component with projects generated by Angular CLI, please refer to the following article: [Using ADF with Angular CLI](https://github.com/Alfresco/alfresco-ng2-components/wiki/Angular-CLI)
### Install
```sh
npm install ng2-activiti-processlist
```
### Build from sources
You can build component from sources with the following commands:
@@ -394,7 +436,7 @@ npm run build
> The `build` task rebuilds all the code, runs tslint, license checks
> and other quality check tools before performing unit testing.
## NPM scripts
### NPM scripts
| Command | Description |
| --- | --- |
@@ -403,7 +445,7 @@ npm run build
| npm run test-browser | Run unit tests in the browser
| npm run coverage | Run unit tests and display code coverage report |
## Demo
### Demo
Please check the demo folder for a demo project
@@ -413,6 +455,6 @@ npm install
npm start
```
## License
### License
[Apache Version 2.0](https://github.com/Alfresco/alfresco-ng2-components/blob/master/LICENSE)