Workspace templates make it easy to create new Workspaces using a predefined folder structure and permission set. Different Workspace templates can be set up based on the specific business needs.
Creating a Workspace Template
Users can create Workspace templates in the Egnyte Collaborate Web UI. They are stored in /Shared/Egnyte Templates/Workspace Templates. Perform the following steps to create a Workspace template:
- Create a folder under /Shared/Egnyte Templates/Workspace Templates. The name of your folder will be the template name.
- Add subfolders and files to the template
- Optionally define template permissions by using Workspace Template Settings from the More menu.
- The Workspace Template Settings dialog will open. The Workspace Template Permissions section allows users to configure which users will have access to Workspaces created from this template. In addition to predefined users and groups, users can configure dynamic roles which will be mapped to users when a Workspace is created from this template. Users can download a sample JSON file from the Workspace Template Settings dialog, which provides examples for reference.
In the example JSON below, there are four dynamic roles defined:
1. Account Manager
2. Account Team
3. Account Verification Team
4. Client.
The Account Manager and Account Team are granted access to the entire workspace, but with different permission levels. The Account Verification Team is given Editor access and the user Bill Smith (username - bsmith) is given Full access to the Onboarding folder. The user group Legal Team is given Owner access to the Contracts folder and permission inheritance is turned off for Contracts folder.
The Client is granted Viewer access to the Client Access subfolder.
Note: The dynamic roles are only available during workspace creation and will not be accessible afterwards.
A sample permissions JSON is listed below:
{
"folders": [
{
"path": "/",
"permissions": {
"userPerms": {
"{{Account Manager}}": "Owner",
"{{Account Team}}": "Full"
}
}
},
{
"path": "/Onboarding",
"permissions": {
"groupPerms": {
"Account Verification Team": "Editor"
},
"userPerms": {
"bsmith": "Full"
}
}
},
{
"path": "/Contracts",
"permissions": {
"groupPerms": {
"Legal Team": "Full"
},
"inheritsPermissions": false
}
},
{
"path": "/Client Access",
"permissions": {
"userPerms": {
"{{Client}}": "Viewer"
}
}
}
]
}
The following table describes the fields of the Permissions JSON object.
| Field | Description | Required | Possible Values |
| folders | Top-level key that contains the definition of folders and their permissions | Yes | Array of folder definition objects |
| folder.path | The folder for which you want to set permissions | Yes |
Path, relative to the root of the project, e.g.: / /Onboarding /Client Access |
| folder.permissions | Object with details about the permissions | Yes | See fields below. The structure is the same as is used in the Set Folder Permissions Public API |
| folder.permissions.groupPerms | Object with details on groups and their permissions. | No |
An object where the keys represent group names and the values the permissions those groups should have. Groups can be existing groups, e.g., “Finance” or can be created upon creating a workspace. Valid folder permissions include: None, Viewer, Editor, Full, Owner |
| folder.permissions.userPerms | Object with details on users and their permissions. | No |
An object where the keys represent configurable dynamic roles or usernames and the values represent permissions those users should have. To give permissions to a specific user, list their username, e.g., bsmith. To define a dynamic role, enter a role name enclosed in double curly braces, e.g., {{Account Manager}} Valid folder permissions include: None, Viewer, Editor, Full, Owner |
| folder.permissions.inheritsPermissions | Whether or not the folder should inherit permissions from its parent folder. | No |
true or false Defaults to true |
Managing Workspace Templates Access
Users can control who can create new workspaces from a specific template, set permissions on the template folder using the Share > Manage Folder Permissions dialog. Any user with Viewer permissions on the template will be able to create a new Workspace from the template.
By giving Editor permissions to the template folder, users will be able to create a Workspace from a template as well as modify the Workspace template.
Creating A Workspace from a Workspace Template
You can create a workspace from available template(s). Refer to Create a Workspace From a Template for more information.
Related Articles
To learn more about Document Portal, refer to the following additional resources.