Overview
The Bluescape plugin for Rocket.Chat allows you to quickly launch Bluescape workspaces directly from Rocket.Chat. It uses a simple slash command /bluescape workspace which will create a new workspace and add all users in the rocket.chat room. It will also set the requestor as the owner of the workspace and respond with a link to the workspace.
Users can add the Bluescape plugin for Rocket.Chat directly from the Rocket.Chat Marketplace or by contacting Bluescape.
Installation
There are two ways to install the plugin, either download the release package .zip file and install it in the rocket.chat app management console, or clone the GitHub repo and use the rc-apps CLI tool to deploy directly to your server.
Note: As of version 6.0.0, the app is also available in the Rocket.Chat Marketplace.
Example command to deploy to a cloud instance with 2FA enabled:
rc-apps deploy -u <username> -p <password> --url https://<instance>.rocket.chat --i2fa
Using the app does require a Bluescape Account, along with a clientID and clientSecret, to call our Bluescape API. Please contact your Bluescape representative or reply to this topic for additional information on signing up for Bluescape and creating your API keys.
After installing, you must specify the clientID, clientSecret, and any other settings before using the slash command to create a workspace (see below).
Settings
The Bluescape app has the following settings:
bluescapeURL : STRING
The URL used to access your instance of Bluescape. Defaults to “https://client.apps.us.bluescape.com”.
graphQLURL : STRING
The URL used for graphQL API calls to your instance of Bluescape. Defaults to “https://api.apps.us.bluescape.com/v3/graphql”.
clientID : STRING
The clientID for your Bluescape App. By default, this is not set, and you must obtain one from Bluescape (it will be hidden for non-admins).
clientSecret : STRING
The clientSecret for your Bluescape App. By default, this is not set, and you must obtain one from Bluescape (it will be hidden for non-admins).
defaultOrg : STRING
The Organization / Team Name from Bluescape to create workspaces in. The Team must exist in the instance, and the Bluescape App Bot must be a member of the Team.
(optional) defaultWorkspaceRole : STRING
The role to assign to users inside the Bluescape workspace. If not set, it will default to “Editor”. The Workspace Role must exist in the instance and Team where the workspace is being created.
(optional) defaultWorkspaceOwner : STRING
The owner to assign the workspace to if you want the same owner for all new workspaces. If not set, it will default to the user issuing the command.
Troubleshooting
Most common back-end workflow issues occur due to permissions. By design, the user creating the Bluescape workspace must have permission to create a workspace in the instance and Team specified. If you have trouble creating workspaces, first check that the user has permissions in the defaultOrg and uses the correct setting for clientID and clientSecret. If you are unsure why you cannot create workspaces, contact your Bluescape representative or reply to this topic for support.
For issues installing or configuring the Bluescape app, check the documentation on Rocket.chat and then contact Rocket or Bluescape for help.