Cloud Workspace Tool

SECTIONS

</aside>

Overview

Cloud workspace Tool is a handy tool for managing cloud workspaces. With this tool, you have control to customize your cloud workspace environment—install and remove apps, set permissions for users on specific apps, set permissions for agents in specific apps, upload and manage files, and more. Think of it as your own server: a secure, centralized space for everything you need to run and scale your projects in the cloud.

Prerequisite

To start using the Cloud Workspace Tool, you’ll need access to a cloud workspace. You can either receive permission to access an existing workspace or request your own by contacting a Remix admin.

Cloud Workspace Tool walkthrough

You can use the tool on web page or use the tool as a plugin within Remix Studio by getting to the plugins menu and select Cloud Workspace POC.

Upon opening the tool, you'll be directed to a screen, where you'll be prompted to enter the cloud workspace you want to manage. If you have access, you'll proceed to the next screen; otherwise, an error message will appear on the current screen.

Once you've accessed the workspace to be managed, you'll arrive at the workspace overview screen, where you'll find:

A menu of options that allows you to view and manage various aspects of your workspace.
A cloud button ☁️ at the top left, which returns you to the workspace entry screen.
A pin 📌 button at the top right, allowing you to pin the current workspace. When pinned, you'll automatically be directed to this workspace's overview screen each time you open the tool.

Deploy app

On the Deploy App screen, you’ll find a form to install an app into your cloud workspace. You can select from two project sources:

Builder - This source uses the last published state of the selected project, which will be packaged and deployed to your workspace. When choosing Builder as the source, you’ll have an option to include builder assets, which is necessary if you plan to host libraries in your workspace. Note - the builder option is only available if you’re using the tool in the builder.
Hosted - This source uses a .remix file hosted at a publicly accessible URL and deploys it to your workspace.

Workspace permissions

On the Workspace permissions screen you’ll find:

A search bar to look up specific users by email and view their permissions in the current workspace.
A table with two columns where each row corresponds to the user’s email and the role they have to the workspace.
A “+” button that opens a screen to view/add workspace-level permissions. When assigning permissions, review the role descriptions to understand the access each role provides. If assigning permissions to multiple users, ensure each email is entered on a separate line.

App hub

The App Hub screen provides a selection of apps that you can install from a pre-configured list of tools into your cloud workspace and assign the necessary permissions to get the app working. Currently, the available apps are:

Files - A general file management app that allows you to upload, view, and delete files within your cloud workspace.
Federated Search: A search tool that lets you find components from your personal libraries hosted in your cloud workspace. Read more about it here

The blue download icon indicates that the app has not yet been installed in the workspace and on tap would be the initial install. The green update icon shows that the app is already installed, and tapping it would reinstall the latest version of the app into the workspace.

App overview

On the App overview screen, you’ll find:

A search bar to look up specific users by email and view their permissions in the current app.
A table with two columns where each row corresponds to the user’s email and the role they have to the app.
A “+” button that opens a screen to view/add app-level permissions. When assigning permissions, review the role descriptions to understand the access each role provides. If assigning permissions to multiple users, ensure each email is entered on a separate line.
A “VIEW AGENT PERMISSIONS” button, which opens a screen to view or assign individual agents with specific permissions.
A “DELETE THIS APP” button, which, when tapped, opens a form prompting you to enter a randomly generated code into a text box to confirm app deletion.

Agent permissions

On the Agent permissions screen you’ll find:

A search bar to find specific agents by name and view their permissions in the current app.
A table with two columns where each row is an agent and their assigned access type, generally showing who can call the agent. Each row in the table is tappable to view more detailed information about the agent's permissions.
- Whitelist - Specific authenticated users have been given access to call the agent.
- Anonymous - Any users authenticated or not have access to call the agent.
- Authenticated - Any authenticated user has access to call the agent.
A “+” button that opens a screen to add agent-level permissions. *When assigning permissions, review the role descriptions to understand the access each role provides. If assigning permissions to multiple users, ensure each email is entered on a separate line.

Note - any agents that do not have a permission set will not appear on this list*