Adding a Shared Workspace to your Designer
Description
LogicNets' Shared Workspaces functionality allows you to set up a Designer workspace that can hold collaborative projects and that multiple Designer users can access. This article describes the steps for how to set up shared workspaces and get started using them:
- Set up a shared workspace and permissions
- Load content to a shared workspace
- Set up local access to a shared workspace
- Work with projects in a shared workspace
Set Up Workspace and Permissions
This section walks you through how to create a workspace and assign permissions to those users who can load, view, and edit projects in the shared workspace. To perform these steps you must have access rights to the Access Management module.
- Navigate to the Workspaces page in Access Management (A) and create a new workspace (B). In the image below we name it TeamVault.
- With the image below as an example, create a user group (A and B) and add to it the users (C) who are allowed to load initial content. You can also use an existing group.
- Add the shared workspace to the group's dashboard (D). The system places the workspace on their landing page.
- (Optional) Add a description for the group (E).
- Add RepositoryAPI as a group role with readonly rights (F). Note: The dotted line indicates some options removed from screenshot for simplicity.
- Create user groups using existing groups containing users who are allowed to view and/or modify the content from their own Designer. For each group, after creating and saving the group name, click Modify and perform the following steps:
- DO NOT add the shared Designer to the Workspaces on Dashboard, because users will access the shared workspace using API calls from their local workspace.
- Add RepositoryAPI as a group role with readonly rights.
- In the Workspace roles section, add a workspace (A), choose the name (B), and choose one or more roles for the group (C).
- For viewing rights, select remote-read.
- For editing and viewing rights, select remote-modify.
- For admin rights, select admin role. See Workspace Role Assignments for more detailed notes on the role choices.
Load Content to a Shared Workspace
Users in the appropriate group can load content to share using the steps below for each shared project. Projects that are not checked in are not available for others to view or edit.
Create or import the project to the Shared Workspace Designer. See A in the image above.
- Verify the Project Details.
- Click Modify (B) to edit the Author, Owner, Version, and Description fields, which are visible to others when this project is shared.
- Click Create Revision (C).
- Select a status option: Draft, Beta, or Released.
- Enter revision notes that explain the changes to the revision. This could be "Initial shared version" or a list of the features added, and defects fixed and is available for others to see what was included in the latest revision versus earlier versions of the project.
- Click Submit to save the revision to the shared workspace. This makes the project visible to other users with the correct permissions.
Access a Shared Workspace
Users with the correct permissions can set up access to the shared workspace from their local Designer workspace by following the steps below.
- From your Designer, click the workspaces folder.
- Click the "Link to Shared Workspace" icon at the top of the project tree.
- Accept the default URL Root, unless you are sharing content from a different installation or company *
- Enter the exact name of the Shared Workspace, which your Access Management Administrator can provide.
- Use the prefilled name or enter one of your choosing.
- Click Link.
When successful, the name of the shared workspace appears in your workspaces folder, along with details of the permissions. Expand the shared workspace icon to reveal the list of shared projects.
Troubleshooting
If the system is not able to link to the shared workspace you will see an error code and error message. See Troubleshooting Version Control and Shared Workspaces for information on troubleshooting.
External (different root URL) Workspaces
* if you are trying to set up a shared workspace from a different root URL (a partner or other installation) you will need to whitelist the directory before these steps. See this article for more information on whitelisting. https://community.logicnets.com/t/g9y6wz5