From 47d0daaf2433727b7b6eebad45aae6b05d7f0cb8 Mon Sep 17 00:00:00 2001 From: Eugenio Romano Date: Tue, 28 Apr 2020 16:53:07 +0100 Subject: [PATCH] documentation update (#5644) * documentation update * fix update children projects --- docs/README.md | 3 ++- docs/core/services/discovery-api.service.md | 4 ++++ docs/core/services/upload.service.md | 1 + .../process-filters-cloud.component.md | 2 +- .../process-list-cloud.component.md | 1 + .../task-filters-cloud.component.md | 2 +- .../services/start-process-cloud.service.md | 10 ++++++++++ .../components/process-filters.component.md | 2 +- .../components/process-list.component.md | 7 ++++--- .../components/task-filters.component.md | 2 +- .../components/task-form.component.md | 7 ++++--- .../components/task-list.component.md | 10 +++++----- docs/versionIndex.md | 1 + scripts/travis/update/update-children.sh | 2 ++ scripts/travis/update/update-project.sh | 20 +------------------ 15 files changed, 39 insertions(+), 35 deletions(-) diff --git a/docs/README.md b/docs/README.md index ad9ca8352d..0c391aeb6f 100644 --- a/docs/README.md +++ b/docs/README.md @@ -215,7 +215,7 @@ for more information about installing and using the source code. | [JWT helper service](core/services/jwt-helper.service.md) | Decodes a JSON Web Token (JWT) to a JavaScript object. | [Source](../lib/core/services/jwt-helper.service.ts) | | [Log Service](core/services/log.service.md) | Provides log functionality. | [Source](../lib/core/services/log.service.ts) | | [Login Dialog service](core/services/login-dialog.service.md) | Manages login dialogs. | [Source](../lib/core/services/login-dialog.service.ts) | -| [Node Service](core/services/node.service.md) | *Deprecated.* Use the Nodes Api service instead. | [Source](../lib/core/form/services/node.service.ts) | +| [Node Service](core/services/node.service.md) | use Nodes Api service instead of this. | [Source](../lib/core/form/services/node.service.ts) | | [Nodes Api service](core/services/nodes-api.service.md) | Accesses and manipulates ACS document nodes using their node IDs. | [Source](../lib/core/services/nodes-api.service.ts) | | [Notification Service](core/services/notification.service.md) | Shows a notification message with optional feedback. | [Source](../lib/core/notifications/services/notification.service.ts) | | [Page Title service](core/services/page-title.service.md) | Sets the page title. | [Source](../lib/core/services/page-title.service.ts) | @@ -387,6 +387,7 @@ for more information about installing and using the source code. | [Task Attachment List Component](process-services/components/task-attachment-list.component.md) | Displays documents attached to a specified task. | [Source](../lib/process-services/src/lib/attachment/task-attachment-list.component.ts) | | [Task Details component](process-services/components/task-details.component.md) | Shows the details of the task ID passed in as input. | [Source](../lib/process-services/src/lib/task-list/components/task-details.component.ts) | | [Task Filters component](process-services/components/task-filters.component.md) | Shows all available filters. | [Source](../lib/process-services/src/lib/task-list/components/task-filters.component.ts) | +| [Task Form component](process-services/components/task-form.component.md) | Shows a form for a task. | [Source](../lib/process-services/src/lib/task-list/components/task-form/task-form.component.ts) | | [Task Header component](process-services/components/task-header.component.md) | Shows all the information related to a task. | [Source](../lib/process-services/src/lib/task-list/components/task-header.component.ts) | | [Task List component](process-services/components/task-list.component.md) | Renders a list containing all the tasks matched by the parameters specified. | [Source](../lib/process-services/src/lib/task-list/components/task-list.component.ts) | | [Task Standalone component](process-services/components/task-standalone.component.md) | This component can be used when the task doesn't belong to any processes. | [Source](../lib/process-services/src/lib/task-list/components/task-standalone.component.ts) | diff --git a/docs/core/services/discovery-api.service.md b/docs/core/services/discovery-api.service.md index bc18b451b7..a8569eeb50 100644 --- a/docs/core/services/discovery-api.service.md +++ b/docs/core/services/discovery-api.service.md @@ -13,6 +13,10 @@ Gets version and license information for Process Services and Content Services. ### Methods +- **getBPMSystemProperties**(): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SystemPropertiesRepresentation`](../../../node_modules/@alfresco/js-api/src/api/activiti-rest-api/model/systemPropertiesRepresentation.ts)`>`
+ + - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SystemPropertiesRepresentation`](../../../node_modules/@alfresco/js-api/src/api/activiti-rest-api/model/systemPropertiesRepresentation.ts)`>` - + - **getBpmProductInfo**(): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`BpmProductVersionModel`](../../../lib/core/models/product-version.model.ts)`>`
Gets product information for Process Services. - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`BpmProductVersionModel`](../../../lib/core/models/product-version.model.ts)`>` - ProductVersionModel containing product details diff --git a/docs/core/services/upload.service.md b/docs/core/services/upload.service.md index ce11d8f76e..0a73a47d59 100644 --- a/docs/core/services/upload.service.md +++ b/docs/core/services/upload.service.md @@ -87,6 +87,7 @@ node module. } } ``` + From vesion 3.8.0 It's possible filter also for the folder whilst uploading a whole folder. **app.config.json** diff --git a/docs/process-services-cloud/components/process-filters-cloud.component.md b/docs/process-services-cloud/components/process-filters-cloud.component.md index 8f79d4c6c6..4c32e6e13b 100644 --- a/docs/process-services-cloud/components/process-filters-cloud.component.md +++ b/docs/process-services-cloud/components/process-filters-cloud.component.md @@ -25,7 +25,7 @@ Lists all available process filters and allows to select a filter. | Name | Type | Default value | Description | | ---- | ---- | ------------- | ----------- | | appName | `string` | "" | (required) The application name | -| filterParam | [`FilterParamsModel`](../../../lib/process-services/src/lib/task-list/models/filter.model.ts) | | (optional) The filter to be selected by default. If there is no match no filter is selected by default. | +| filterParam | [`FilterParamsModel`](../../../lib/process-services/src/lib/task-list/models/filter.model.ts) | | (optional) The filter to be selected by default | | showIcons | `boolean` | false | (optional) Toggles showing an icon by the side of each filter | ### Events diff --git a/docs/process-services-cloud/components/process-list-cloud.component.md b/docs/process-services-cloud/components/process-list-cloud.component.md index c856e59bb0..e828ef73c2 100644 --- a/docs/process-services-cloud/components/process-list-cloud.component.md +++ b/docs/process-services-cloud/components/process-list-cloud.component.md @@ -52,6 +52,7 @@ when the process list is empty: | ---- | ---- | ------------- | ----------- | | actionsPosition | `string` | "right" | Position of the actions dropdown menu. Can be "left" or "right". | | appName | `string` | "" | The name of the application. | +| appVersion | `number` | | The release version of the application. | | businessKey | `string` | "" | Filter the processes to display only the ones with this businessKey value. | | id | `string` | "" | Filter the processes to display only the ones with this ID. | | initiator | `string` | "" | Name of the initiator of the process. | diff --git a/docs/process-services-cloud/components/task-filters-cloud.component.md b/docs/process-services-cloud/components/task-filters-cloud.component.md index 5460b7fbd3..99bcefb9a4 100644 --- a/docs/process-services-cloud/components/task-filters-cloud.component.md +++ b/docs/process-services-cloud/components/task-filters-cloud.component.md @@ -22,7 +22,7 @@ Shows all available filters. | Name | Type | Default value | Description | | ---- | ---- | ------------- | ----------- | | appName | `string` | "" | Display filters available to the current user for the application with the specified name. | -| filterParam | [`FilterParamsModel`](../../../lib/process-services/src/lib/task-list/models/filter.model.ts) | | Parameters to use for the task filter cloud. If there is no match no filter is selected by default. | +| filterParam | [`FilterParamsModel`](../../../lib/process-services/src/lib/task-list/models/filter.model.ts) | | Parameters to use for the task filter cloud. If there is no match then the default filter (the first one in the list) is selected. | | showIcons | `boolean` | false | Toggles display of the filter's icons. | ### Events diff --git a/docs/process-services-cloud/services/start-process-cloud.service.md b/docs/process-services-cloud/services/start-process-cloud.service.md index 624f682c5b..0dcb9393b2 100644 --- a/docs/process-services-cloud/services/start-process-cloud.service.md +++ b/docs/process-services-cloud/services/start-process-cloud.service.md @@ -13,6 +13,11 @@ Gets process definitions and starts processes. ### Methods +- **createProcess**(appName: `string`, payload: [`ProcessPayloadCloud`](../../../lib/process-services-cloud/src/lib/process/start-process/models/process-payload-cloud.model.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessInstanceCloud`](../../../lib/process-services-cloud/src/lib/process/start-process/models/process-instance-cloud.model.ts)`>`
+ Create a process based on a process definition, name, form values or variables. + - _appName:_ `string` - name of the [Application](../../../lib/testing/src/lib/core/structure/application.ts) + - _payload:_ [`ProcessPayloadCloud`](../../../lib/process-services-cloud/src/lib/process/start-process/models/process-payload-cloud.model.ts) - Details of the process (definition key, name, variables, etc) + - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessInstanceCloud`](../../../lib/process-services-cloud/src/lib/process/start-process/models/process-instance-cloud.model.ts)`>` - Details of the process instance just created - **getBasePath**(appName: `string`): `string`
- _appName:_ `string` - @@ -22,6 +27,11 @@ Gets process definitions and starts processes. Gets the process definitions associated with an app. - _appName:_ `string` - Name of the target app - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessDefinitionCloud`](../../../lib/process-services-cloud/src/lib/process/start-process/models/process-definition-cloud.model.ts)`[]>` - Array of process definitions +- **startCreatedProcess**(appName: `string`, createdProcessInstanceId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessInstanceCloud`](../../../lib/process-services-cloud/src/lib/process/start-process/models/process-instance-cloud.model.ts)`>`
+ Starts an already created process using the process instance id. + - _appName:_ `string` - + - _createdProcessInstanceId:_ `string` - process instance id of the process previously created + - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessInstanceCloud`](../../../lib/process-services-cloud/src/lib/process/start-process/models/process-instance-cloud.model.ts)`>` - Details of the process instance just started - **startProcess**(appName: `string`, payload: [`ProcessPayloadCloud`](../../../lib/process-services-cloud/src/lib/process/start-process/models/process-payload-cloud.model.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessInstanceCloud`](../../../lib/process-services-cloud/src/lib/process/start-process/models/process-instance-cloud.model.ts)`>`
Starts a process based on a process definition, name, form values or variables. - _appName:_ `string` - name of the [Application](../../../lib/testing/src/lib/core/structure/application.ts) diff --git a/docs/process-services/components/process-filters.component.md b/docs/process-services/components/process-filters.component.md index 5ccb2aaa13..47f740d932 100644 --- a/docs/process-services/components/process-filters.component.md +++ b/docs/process-services/components/process-filters.component.md @@ -36,7 +36,7 @@ Collection of criteria used to filter process instances, which may be customized | ---- | ---- | ------------- | ----------- | | appId | `number` | | 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. | -| filterParam | [`FilterProcessRepresentationModel`](../../../lib/process-services/src/lib/process-list/models/filter-process.model.ts) | | The parameters to filter the task filter. If there is no match no filter is selected by default. | +| filterParam | [`FilterProcessRepresentationModel`](../../../lib/process-services/src/lib/process-list/models/filter-process.model.ts) | | The parameters to filter the task filter. If there is no match then the default one (ie, the first filter in the list) is selected. | | showIcon | `boolean` | true | Toggle to show or hide the filter's icon. | ### Events diff --git a/docs/process-services/components/process-list.component.md b/docs/process-services/components/process-list.component.md index 7f7906acf1..f77d5c8e2a 100644 --- a/docs/process-services/components/process-list.component.md +++ b/docs/process-services/components/process-list.component.md @@ -61,10 +61,10 @@ when the process list is empty: | resolverFn | `Function` | null | Resolver function is used to show dynamic complex column objects see the docs to learn how to configure a resolverFn. | | selectFirstRow | `boolean` | true | Toggles default selection of the first row | | selectionMode | `string` | "single" | Row selection mode. Can be none, `single` or `multiple`. For `multiple` mode, you can use Cmd (macOS) or Ctrl (Win) modifier key to toggle selection for multiple rows. | +| showContextMenu | `boolean` | false | Toggles custom context menu for the component. | | size | `number` | | The number of processes to fetch in each page. | | sort | `string` | | Defines the sort ordering of the list. Possible values are `created-desc`, `created-asc`, `ended-desc`, `ended-asc`. | | state | `string` | | Defines the state of the processes. Possible values are `running`, `completed` and `all` | -| showContextMenu | `boolean` | false | Toggles custom context menu for the component. | | stickyHeader | `boolean` | false | Toggles the sticky header mode. | ### Events @@ -73,8 +73,8 @@ when the process list is empty: | ---- | ---- | ----------- | | error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs while loading the list of process instances from the server. | | rowClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when a row in the process list is clicked. | -| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ProcessListModel`](../../../lib/process-services/src/lib/process-list/models/process-list.model.ts)`>` | Emitted when the list of process instances has been loaded successfully from the server. | | showRowContextMenu | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`DataCellEvent`](../../../lib/core/datatable/components/datatable/data-cell.event.ts)`>` | Emitted before the context menu is displayed for a row. | +| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ProcessListModel`](../../../lib/process-services/src/lib/process-list/models/process-list.model.ts)`>` | Emitted when the list of process instances has been loaded successfully from the server. | ## Details @@ -193,7 +193,7 @@ The Process Instance List also supports pagination: Emitted before the context menu is displayed for a row. -Note that the ProcessInstanceListComponent itself does not populate the context menu with items. You can provide all necessary content via the handler. +Note that the [ProcessInstanceListComponent](../../../lib/process-services/src/lib/process-list/components/process-list.component.ts) itself does not populate the context menu with items. You can provide all necessary content via the handler. ```html ` | Emitted when any outcome is executed. Default behaviour can be prevented via `event.preventDefault()`. | | formCompleted | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormModel`](../../../lib/core/form/components/widgets/core/form.model.ts)`>` | Emitted when the form is submitted with the `Complete` outcome. | | formContentClicked | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ContentLinkModel`](../../../lib/core/form/components/widgets/core/content-link.model.ts)`>` | Emitted when the form field content is clicked. | -| formLoaded | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormModel`](../../../lib/core/form/components/widgets/core/form.model.ts)`>` | Emitted when the form is loaded or reloaded. | | formError | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormFieldModel`](../../core/models/form-field.model.md)`[]>` | Emitted when the supplied form values have a validation error. | +| formLoaded | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormModel`](../../../lib/core/form/components/widgets/core/form.model.ts)`>` | Emitted when the form is loaded or reloaded. | | formSaved | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FormModel`](../../../lib/core/form/components/widgets/core/form.model.ts)`>` | Emitted when the form is submitted with the `Save` or custom outcomes. | +| showAttachForm | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the form associated with the form task is attached. | ## See also diff --git a/docs/process-services/components/task-list.component.md b/docs/process-services/components/task-list.component.md index 0bb39c6b00..9039afceb3 100644 --- a/docs/process-services/components/task-list.component.md +++ b/docs/process-services/components/task-list.component.md @@ -68,13 +68,13 @@ when the task list is empty: | processInstanceId | `string` | | The Instance Id of the process. | | selectFirstRow | `boolean` | true | Toggles default selection of the first row | | selectionMode | `string` | "single" | Row selection mode. Can be none, `single` or `multiple`. For `multiple` mode, you can use Cmd (macOS) or Ctrl (Win) modifier key to toggle selection for multiple rows. | +| showContextMenu | `boolean` | false | Toggles custom context menu for the component. | | size | `number` | | The number of tasks to fetch. Default value: 25. | | sort | `string` | | Define the sort order of the tasks. Possible values are : `created-desc`, `created-asc`, `due-desc`, `due-asc` | | start | `number` | | Starting point of the list within the full set of tasks. | | state | `string` | | Current state of the process. Possible values are: `completed`, `active`. | -| taskId | `string` | | The id of a task | -| showContextMenu | `boolean` | false | Toggles custom context menu for the component. | | stickyHeader | `boolean` | false | Toggles the sticky header mode. | +| taskId | `string` | | The id of a task | ### Events @@ -83,8 +83,8 @@ when the task list is empty: | error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs. | | rowClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when a task in the list is clicked | | rowsSelected | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when rows are selected/unselected | -| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the task list is loaded | | showRowContextMenu | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`DataCellEvent`](../../../lib/core/datatable/components/datatable/data-cell.event.ts)`>` | Emitted before the context menu is displayed for a row. | +| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the task list is loaded | ## Details @@ -235,7 +235,7 @@ You can customize the styling of a column and also add features like tooltips an Emitted before the context menu is displayed for a row. -Note that the TaskListComponent itself does not populate the context menu with items. +Note that the [TaskListComponent](../../process-services/components/task-list.component.md) itself does not populate the context menu with items. You can provide all necessary content via the handler. ```html @@ -270,7 +270,7 @@ onShowRowContextMenu(event: DataCellEvent) { This event is cancellable. You can use `event.preventDefault()` to prevent the default behavior. -The TaskListComponent will automatically render the supplied menu items. +The [TaskListComponent](../../process-services/components/task-list.component.md) will automatically render the supplied menu items. See the [ContextMenu](https://www.npmjs.com/package/ng2-alfresco-core) documentation for more details on the format and behavior of context actions. diff --git a/docs/versionIndex.md b/docs/versionIndex.md index 76b15881de..f4ab32bfc6 100644 --- a/docs/versionIndex.md +++ b/docs/versionIndex.md @@ -436,6 +436,7 @@ backend services have been tested with each released version of ADF. - [Task details component](process-services/components/task-details.component.md) - [Task filter service](process-services/services/task-filter.service.md) - [Task filters component](process-services/components/task-filters.component.md) +- [Task form component](process-services/components/task-form.component.md) - [Task header component](process-services/components/task-header.component.md) - [Task list component](process-services/components/task-list.component.md) - [Task standalone component](process-services/components/task-standalone.component.md) diff --git a/scripts/travis/update/update-children.sh b/scripts/travis/update/update-children.sh index f8ec24aade..a252ee98eb 100755 --- a/scripts/travis/update/update-children.sh +++ b/scripts/travis/update/update-children.sh @@ -19,4 +19,6 @@ echo "Update AMA" ./scripts/travis/update/update-project.sh -gnu -t $GITHUB_ENTERPRISE_TOKEN -n 'Alfresco/alfresco-modeler-app' -v $VERSION -vjs $JS_VERSION echo "Update Workspace" ./scripts/travis/update/update-project.sh -gnu -t $GITHUB_ENTERPRISE_TOKEN -n 'Alfresco/alfresco-process-workspace-app' -v $VERSION -vjs $JS_VERSION +echo "Update Digital Workspace" +./scripts/travis/update/update-project.sh -gnu -t $GITHUB_ENTERPRISE_TOKEN -n 'Alfresco/digital-workspace' -v $VERSION -vjs $JS_VERSION diff --git a/scripts/travis/update/update-project.sh b/scripts/travis/update/update-project.sh index 737dc20f45..f2184da4cd 100755 --- a/scripts/travis/update/update-project.sh +++ b/scripts/travis/update/update-project.sh @@ -1,7 +1,5 @@ #!/usr/bin/env bash -eval GNU=false - set -e TEMP_GENERATOR_DIR=".tmp-generator"; VERSION=$(npm view @alfresco/adf-core@beta version) @@ -14,12 +12,6 @@ show_help() { echo "-n or --name Github name of the project" echo "-v or --version ADF version if not passed will use the beta" echo "-vjs or --vjs JS API version if not passed will use the beta" - echo "-gnu for gnu" -} - -gnu_mode() { - echo "====== GNU MODE =====" - GNU=true } token() { @@ -42,7 +34,6 @@ while [[ $1 == -* ]]; do case "$1" in -h|--help|-\?) show_help; exit 0;; -n|--name|-\?) name_repo $2; shift 2;; - -gnu) gnu_mode; shift;; -t|--token) token $2; shift 2;; -v|--version) version $2; shift 2;; -vjs|--vjs) vjs $2; shift 2;; @@ -59,16 +50,7 @@ git checkout development BRANCH="ADF-update-beta-$VERSION" git checkout -b $BRANCH -if $GNU; then - if [ $NAME_REPO == 'Alfresco/generator-alfresco-adf-app' ] || [ $NAME_REPO == 'Alfresco/alfresco-modeler-app' ] || [ $NAME_REPO == 'Alfresco/alfresco-content-app' ]; then - ./scripts/update-version.sh -gnu -v $VERSION -vj $JS_VERSION - else - npm install @alfresco/adf-cli@alpha --no-save - npx adf-cli update-version --pathPackage "$(pwd)" --version $VERSION --vjs $JS_VERSION - fi -else - npx adf-cli update-version --pathPackage "$(pwd)" --version $VERSION --vjs $JS_VERSION --skipGnu -fi +./scripts/update-version.sh -gnu -v $VERSION -vj $JS_VERSION git add . git commit -m "Update ADF packages version $VERSION"