Skip to content

Commit

Permalink
[DOCS-7347] Add new version (#1159)
Browse files Browse the repository at this point in the history
  • Loading branch information
oliveralfresco2018 authored Sep 29, 2023
1 parent e2a33fa commit deaa53f
Show file tree
Hide file tree
Showing 27 changed files with 1,417 additions and 5 deletions.
7 changes: 6 additions & 1 deletion _config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -117,6 +117,7 @@ defaults:
toc: "digital-workspace"
support: true
versions:
- 4.2
- 4.1
- 4.0
- 3.1
Expand All @@ -136,8 +137,12 @@ defaults:
- scope:
path: "digital-workspace/latest"
values:
version: 4.1
version: 4.2
latest: true
- scope:
path: "digital-workspace/4.1"
values:
version: 4.1
- scope:
path: "digital-workspace/4.0"
values:
Expand Down
54 changes: 53 additions & 1 deletion _data/toc/digital-workspace.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Digital Workspace
- version: 4.1
- version: 4.2
pages:
- title: 'Introduction'
path: '/digital-workspace/latest/'
Expand Down Expand Up @@ -51,6 +51,58 @@
path: '/digital-workspace/latest/develop/extensions/'
- title: 'Troubleshooting'
path: '/digital-workspace/latest/troubleshooting/'
- version: 4.1
pages:
- title: 'Introduction'
path: '/digital-workspace/4.1/'
- title: 'Install'
pages:
- title: 'Overview'
path: '/digital-workspace/4.1/install/'
- title: 'Install into Tomcat'
path: '/digital-workspace/4.1/install/tomcat/'
- title: 'Install into other webserver'
path: '/digital-workspace/4.1/install/other-webserver/'
- title: 'Install with Docker Compose'
path: '/digital-workspace/4.1/install/containerized/'
- title: 'Configure'
path: '/digital-workspace/4.1/config/'
- title: 'Governance Services'
pages:
- title: 'Governance Services overview'
path: '/digital-workspace/4.1/governance/'
- title: 'Security Controls'
path: '/digital-workspace/4.1/governance/security/'
- title: 'Working with records'
path: '/digital-workspace/4.1/governance/records/'
- title: 'Process Services'
pages:
- title: 'Process Services overview'
path: '/digital-workspace/4.1/process/'
- title: 'Starting processes'
path: '/digital-workspace/4.1/process/starting/'
- title: 'Managing processes'
path: '/digital-workspace/4.1/process/managing/'
- title: 'Managing Tasks'
path: '/digital-workspace/4.1/process/tasks/'
- title: 'Configuring Process Services'
path: '/digital-workspace/4.1/process/config/'
- title: 'Image Management'
path: '/digital-workspace/4.1/media/'
- title: 'Using'
path: '/digital-workspace/4.1/using/'
- title: 'Develop'
pages:
- title: 'Overview'
path: '/digital-workspace/4.1/develop/'
- title: 'Deploy'
path: '/digital-workspace/4.1/develop/deploy/'
- title: 'Manage Digital Workspace'
path: '/digital-workspace/4.1/develop/manage/'
- title: 'Build extensions'
path: '/digital-workspace/4.1/develop/extensions/'
- title: 'Troubleshooting'
path: '/digital-workspace/4.1/troubleshooting/'
- version: 4.0
pages:
- title: 'Introduction'
Expand Down
80 changes: 80 additions & 0 deletions digital-workspace/4.1/config/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
---
title: Configure Digital Workspace
---

Alfresco Digital Workspace settings are in the following file `../digital-workspace/app.config.json`. You can use the file to tailor Alfresco Digital Workspace easily and without making any code changes. The file can be updated while Alfresco Digital Workspace is still running and users will see the changes once their pages are reloaded.

For more in-depth documentation about how to configure Digital Workspace, see [Application features](https://alfresco-content-app.netlify.com/#/features/){:target="_blank"}.

The following settings can be configured in `../digital-workspace/app.config.json`.

| Property/Sub-property | Description |
| -------- | ----------- |
| adf-start-process/name | The name of the process as it appears in Alfresco Process Services including the current days date and time. The default setting for this is %{processDefinition} - %{datetime}, which will produce, 'Capital Approval Process - Jun 17, 2020, 11:02:07 AM'.|
| adf-start-process/processDefinitionName | The name of the definition of the process you are using to create an instance, for example `Capital Approval Process definition`.|
| adf-versions-manager/allowComments | Toggle version comments on/off.|
| aosHost | Server address of the AOS endpoint, for example `https://repository.domain.com/alfresco/aos`. **Note:** Server address has to be https.|
| application/name | Application name that will be shown in the header of the application and in the page/tab title, for example `Digital Workspace`|
| application/copyright | Copyright text shown on the login page, for example `© 2017 - 2020 Alfresco Software, Inc. All rights reserved`.|
| application/logo | Path to the logo shown in the application header for example, `assets/images/alfresco-logo-flower.svg`|
| authtype | Determines the type of authentication. To use Single Sign-on mode you must change this property to OAuth, for example `basic`. See [Single Sign-On (SSO)](https://www.alfresco.com/abn/adf/docs/core/components/login.component/#single-sign-on-sso).|
| bpmHost | Server address of Alfresco Process Services, for example `https://processservices.domain.com:port`|
| content-metadata/presets | Add custom aspects and properties to be shown in the information drawer. |
| content-metadata/custom | Add custom aspects and properties to be shown in the information drawer. |
| ecmHost | Server address of Alfresco Content Services, for example `https://repository.domain.com:port` |
| files/excluded | Restrict users from uploading certain types of files and folders by setting or extending the list of rules at the "files.excluded" path for example, ".DS_Store", "desktop.ini", "Thumbs.db", ".git" | |
| files/match-options, no case | Ensures that the exclusions are case insensitive, for example `true`. |
| files/allowDownload |Toggle downloads of versions on/off, `true` or `false`.|
| headerColor | Value for the header background color of the application, for example `#2196F3` |
| languagePicker | Enable manual language selection menu, `true` or `false`.|
| languages/key | Key for language picker menu options, for example `en` |
| languages/label | Label to display in the language picker menu, for example, `English`|
| pagination/size | Set the default number of items to be displayed on a page, for example `25` |
| pagination/supportedPageSizes | Change the items available in the pagination control, for example `25`, `50`, `100`. |
| processService | Toggles the Alfresco Process Services plugin to be on/off, `"true"` or `"false"`. **Note:** You must include the quotation marks. |
| search/include | Specify the node information returned by the API with the search results set. |
| search/sortng | Search result sorting options available, and which option is the default.|
| search/filterqueries | Specify what content should, and shouldn’t be returned in the results set.|
| search/facetFields | Allows the configuration of the search results filter options.|
| search/facetQueries | Allows the configuration of the search results filter options.|
| search/categories | Allows the configuration of the search results filter options.|
| search/aca:fields | Specify the metadata fields that will be included in search queries.|
| sidenav/preserveState | Remember the users choice of sidenav minimized or expanded, `true` or `false`.|
| sideNav/expandedSidenav | Side navigation expanded by default, `true` or `false`.|
| viewer.maxRetries | The preview mechanism used to view a file tries to open it and if its unsuccessful it waits 20 seconds and then tries again. The process involves converting the file (multiple file formats are supported depending on content type) and if it takes more than 20 seconds the system will say that the content isn't supported. This time out can be increased by adding a value for this property. If you enter 2 the wait time before time out will be 40 seconds|
| viewer.enableFileAutoDownload | Specify if a large file is automatically downloaded. Use either `true` or `false`. |
| viewer.enableDownloadPrompt | Specify if the Digital Workspace user is prompted before downloading a large file. The default is `true`. |
| viewer.downloadPromptDelay | In seconds, specify the amount of time to delay a prompt to the Digital Workspace user, before displaying a download large file message. The default is `50`. |
| viewer.enableDownloadPromptReminder | Specify if the Digital Workspace user is prompted with a reminder, before downloading a large file. The default is `true`. |
| viewer.downloadPromptReminderDelay | In seconds, specify the amount of time to delay a reminder prompt, to the Digital Workspace user, before displaying another download large file message. The default is `30`. |
| viewer.fileAutoDownloadSizeThresholdInMB | In megabytes, specify the largest file size a file can be, before the Digital Workspace does not download it automatically. The default is `15`. |

## Permissions

Permissions for folders and files in the Digital Workspace can be assigned and viewed easily.
To view the permissions of a folder or file in the Digital Workspace, select the file or folder, right click it, and select **Permissions**. You are presented with the Permissions tab.

The type of permissions a user or group has for a file is determined by what role they have.

For more information on roles see [User roles and permissions]({% link content-services/latest/using/permissions.md %})

### Setting permissions

Setting permissions for folders and files allows you to manage what type of access a user has for a folder or file. From within the Permissions tab you can assign a user or a group to have a specific type of access based on what role you assign them.
> **Note:** You can also delete permissions from here by using the Bin icon next to the user or group that has permissions assigned to it.
1. From within the permissions tab use the Add icon to add a user or group.

2. Search for the user or group you want to assign access to your folder or file and then click **SELECT**.

3. Select the role you want to assign to the user or group and then click **ADD**.

If you are assigning a role to a group you can select a different role for the administrator of that group than for the rest of the users in the group.

4. (Optional) Use the slider to allow the added users or groups to inherit the permissions from the parent folder.

## Search Configuration

The search filters that are available in the Digital Workspace can be refined and tailored to your specific needs by creating custom search forms. Each form can contain a set of filters that are relevant to a particular task or user group within your organization. You can select the most useful search form from the drop-down list on the search results page. For details on how to create and configure search forms for a more intuitive search experience see [Search Configuration Guide](https://github.com/Alfresco/alfresco-ng2-components/blob/develop/docs/user-guide/search-configuration-guide.md){:target="_blank"}.

![search]({% link digital-workspace/images/search-integration.png %})
Loading

0 comments on commit deaa53f

Please sign in to comment.