[ADF-2847] Added class members headings to proces and insights docs (#3263)

This commit is contained in:
Andy Stark 2018-05-03 15:14:41 +01:00 committed by Eugenio Romano
parent 513915b3d9
commit 96fddbdc39
30 changed files with 66 additions and 5 deletions

View File

@ -15,6 +15,8 @@ Generates and shows charts
</adf-analytics> </adf-analytics>
``` ```
## Class members
### Properties ### Properties
| Name | Type | Default value | Description | | Name | Type | Default value | Description |

View File

@ -14,6 +14,8 @@ Shows a list of all available reports
</analytics-report-list> </analytics-report-list>
``` ```
## Class members
### Properties ### Properties
| Name | Type | Default value | Description | | Name | Type | Default value | Description |

View File

@ -17,6 +17,8 @@ Shows the charts related to the reportId passed as input
</adf-analytics> </adf-analytics>
``` ```
## Class members
### Properties ### Properties
| Name | Type | Default value | Description | | Name | Type | Default value | Description |

View File

@ -24,6 +24,8 @@ The below component shows the diagram of a running process instance with the act
</adf-diagram> </adf-diagram>
``` ```
## Class members
### Properties ### Properties
| Name | Type | Description | | Name | Type | Description |

View File

@ -29,6 +29,8 @@ If we intend to show a custom template if there are no apps present
</adf-apps> </adf-apps>
``` ```
## Class members
### Properties ### Properties
| Name | Type | Default value | Description | | Name | Type | Default value | Description |

View File

@ -16,6 +16,8 @@ Shows the checklist task functionality.
</adf-checklist> </adf-checklist>
``` ```
## Class members
### Properties ### Properties
| Name | Type | Default value | Description | | Name | Type | Default value | Description |

View File

@ -18,6 +18,8 @@ Displays Upload Component (Drag and Click) to upload the attachment to a specifi
</adf-create-process-attachment> </adf-create-process-attachment>
``` ```
## Class members
### Properties ### Properties
| Name | Type | Default value | Description | | Name | Type | Default value | Description |

View File

@ -18,6 +18,8 @@ Displays Upload Component (Drag and Click) to upload the attachment to a specifi
</adf-create-task-attachment> </adf-create-task-attachment>
``` ```
## Class members
### Properties ### Properties
| Name | Type | Description | | Name | Type | Description |

View File

@ -71,6 +71,8 @@ In the component template use the people list component:
Note that the people list component is based on the Note that the people list component is based on the
[Datatable component](../core/datatable.component.md). [Datatable component](../core/datatable.component.md).
## Class members
### Properties ### Properties
| Name | Type | Default value | Description | | Name | Type | Default value | Description |

View File

@ -12,6 +12,8 @@ Searches users/people.
<adf-people-search></adf-people-search> <adf-people-search></adf-people-search>
``` ```
## Class members
### Properties ### Properties
| Name | Type | Default value | Description | | Name | Type | Default value | Description |

View File

@ -6,6 +6,8 @@ Status: Active
Displays users involved with a specified task Displays users involved with a specified task
![activiti-people](../docassets/images/activiti_people.png)
## Contents ## Contents
- [Basic Usage](#basic-usage) - [Basic Usage](#basic-usage)
@ -30,7 +32,7 @@ Displays users involved with a specified task
</adf-people> </adf-people>
``` ```
![activiti-people](../docassets/images/activiti_people.png) ## Class members
### Properties ### Properties

View File

@ -36,6 +36,8 @@ export class MyCustomProcessAttachmentComponent {
} }
``` ```
## Class members
### Properties ### Properties
| Name | Type | Default value | Description | | Name | Type | Default value | Description |

View File

@ -14,6 +14,8 @@ Displays comments associated with a particular process instance and allows the u
</adf-process-instance-comments> </adf-process-instance-comments>
``` ```
## Class members
### Properties ### Properties
| Name | Type | Default value | Description | | Name | Type | Default value | Description |

View File

@ -8,7 +8,9 @@ Last reviewed: 2018-03-21
Manage Process Filters, which are pre-configured Process Instance queries. Manage Process Filters, which are pre-configured Process Instance queries.
## Methods ## Class members
### Methods
- `getProcessFilters(appId: number): Observable<FilterProcessRepresentationModel[]>` - `getProcessFilters(appId: number): Observable<FilterProcessRepresentationModel[]>`
Gets all filters defined for a Process App. Gets all filters defined for a Process App.

View File

@ -14,6 +14,8 @@ Collection of criteria used to filter process instances, which may be customized
</adf-process-instance-filters> </adf-process-instance-filters>
``` ```
## Class members
### Properties ### Properties
| Name | Type | Default value | Description | | Name | Type | Default value | Description |

View File

@ -14,6 +14,8 @@ Displays detailed information on a specified process instance
</adf-process-instance-details> </adf-process-instance-details>
``` ```
## Class members
### Properties ### Properties
| Name | Type | Default value | Description | | Name | Type | Default value | Description |

View File

@ -16,6 +16,8 @@ Sub-component of the process details component, which renders some general infor
</adf-process-instance-details> </adf-process-instance-details>
``` ```
## Class members
### Properties ### Properties
| Name | Type | Default value | Description | | Name | Type | Default value | Description |

View File

@ -15,6 +15,8 @@ Lists both the active and completed tasks associated with a particular process i
</adf-process-instance-tasks> </adf-process-instance-tasks>
``` ```
## Class members
### Properties ### Properties
| Name | Type | Default value | Description | | Name | Type | Default value | Description |

View File

@ -19,6 +19,8 @@ Renders a list containing all the process instances matched by the parameters sp
</adf-process-instance-list> </adf-process-instance-list>
``` ```
## Class members
### Properties ### Properties
| Name | Type | Default | Description | | Name | Type | Default | Description |

View File

@ -8,7 +8,9 @@ Last reviewed: 2018-03-20
Manages Process Instances, Process Variables, and Process Audit Log. Manages Process Instances, Process Variables, and Process Audit Log.
## Methods ## Class members
### Methods
- `getProcessInstances(requestNode: ProcessFilterParamRepresentationModel, processDefinitionKey?: string): Observable<ProcessListModel>` - `getProcessInstances(requestNode: ProcessFilterParamRepresentationModel, processDefinitionKey?: string): Observable<ProcessListModel>`
Get process instances for a filter and optionally a process definition. Get process instances for a filter and optionally a process definition.

View File

@ -18,6 +18,8 @@ Starts a process.
</adf-start-process> </adf-start-process>
``` ```
## Class members
### Properties ### Properties
| Name | Type | Description | | Name | Type | Description |

View File

@ -16,6 +16,8 @@ Creates/Starts new task for the specified app
</adf-start-task> </adf-start-task>
``` ```
## Class members
### Properties ### Properties
| Name | Type | Default value | Description | | Name | Type | Default value | Description |

View File

@ -18,6 +18,8 @@ Displays attached documents on a specified task.
</adf-task-attachment-list> </adf-task-attachment-list>
``` ```
## Class members
### Properties ### Properties
| Name | Type | Default value | Description | | Name | Type | Default value | Description |

View File

@ -16,6 +16,8 @@ Shows the details of the task ID passed in as input.
</adf-task-details> </adf-task-details>
``` ```
## Class members
### Properties ### Properties
| Name | Type | Default value | Description | | Name | Type | Default value | Description |

View File

@ -7,7 +7,9 @@ Status: Active
Manage Task Filters, which are pre-configured Task Instance queries. Manage Task Filters, which are pre-configured Task Instance queries.
## Methods ## Class members
### Methods
- `createDefaultFilters(appId: number): Observable<FilterRepresentationModel[]>` - `createDefaultFilters(appId: number): Observable<FilterRepresentationModel[]>`
Creates and returns the default filters for a process app. Creates and returns the default filters for a process app.

View File

@ -12,6 +12,8 @@ Shows all available filters.
<adf-filters></adf-filters> <adf-filters></adf-filters>
``` ```
## Class members
### Properties ### Properties
| Name | Type | Default value | Description | | Name | Type | Default value | Description |

View File

@ -18,6 +18,8 @@ Shows all the information related to a task.
</adf-task-header> </adf-task-header>
``` ```
## Class members
### Properties ### Properties
| Name | Type | Default value | Description | | Name | Type | Default value | Description |

View File

@ -18,6 +18,8 @@ Renders a list containing all the tasks matched by the parameters specified.
</adf-tasklist> </adf-tasklist>
``` ```
## Class members
### Properties ### Properties
| Name | Type | Default value | Description | | Name | Type | Default value | Description |

View File

@ -20,6 +20,9 @@ This component can be used when there is no form attached to a task.
[taskName]= "taskname"> [taskName]= "taskname">
</adf-task-standalone> </adf-task-standalone>
``` ```
## Class members
### Properties ### Properties
| Name | Type | Default value | Description | | Name | Type | Default value | Description |

View File

@ -8,7 +8,9 @@ Last reviewed: 2018-03-22
Manages Task Instances. Manages Task Instances.
## Methods ## Class members
### Methods
- `getFilterForTaskById(taskId: string, filterList: FilterRepresentationModel[]): Observable<FilterRepresentationModel>` - `getFilterForTaskById(taskId: string, filterList: FilterRepresentationModel[]): Observable<FilterRepresentationModel>`
Gets all the filters in the list that belong to a task. Gets all the filters in the list that belong to a task.