Setup of Workbench

Public Preview | Workbench | Advanced

Setup Guide

If Workbench is not already configured from the landing page and running, click on the Posit Workbench logo.

Begin Workbench installation

Begin Workbench installation
Note

Workbench setup requires application roles POSIT_TEAM_ADMIN or POSIT_WORKBENCH_ADMIN. See top right corner to see your permissions. If you originally installed the Native Application you will have all roles.

Activation

Posit Workbench requires a valid Advanced license file. If you think you have a valid license file just upload via the file input and it will be validated. If you don’t have a license file please contact Posit sales.

Uploading a valid license

Uploading a valid license

Next, configure the compute pool to use for Workbench. The compute pool size can be resized later as well, taking about 15 minutes.

If you would like to migrate from an existing listing such as Posit Workbench or a private listing of Posit Team please see launching from backups.

Once you click continue, Workbench will begin to provision. This will take roughly 10 minutes to create the compute pool and start the Workbench container.

Wait for Workbench to start

Wait for Workbench to start

Using application backups

The last configuration option on the activation page allows launching Workbench from a backup from the current application or another Native Application. You can launch Posit Workbench within the Posit Team Native Application using a previously created backup. Backups from the Workbench Native Application or from another Posit Team Native Application are supported.

Using backups from the Workbench Native Application

The Posit Team Native Application needs to be granted the WORKBENCH_ADMIN application role in order to enumerate and access the backups associated with your Workbench Native Application.

Assuming that your Workbench Native Application is named POSIT_WORKBENCH and your Posit Team native application is named POSIT_TEAM, run the following Snowflake SQL to grant access:

GRANT APPLICATION ROLE POSIT_WORKBENCH.WORKBENCH_ADMIN TO APPLICATION POSIT_TEAM;

After running this code, you can ask that backups from POSIT_WORKBENCH be used when launching Workbench in the Posit Team Native Application named POSIT_TEAM.

Using backups from another Posit Team Native Application

The target Posit Team Native Application needs to be granted the POSIT_TEAM_ADMIN application role in order to enumerate and access the backups associated with your source Posit Team Native Application.

Assuming that your source Posit Team Native Application is named POSIT_TEAM_SOURCE and your target Posit Team native application is named POSIT_TEAM_TARGET, run the following Snowflake SQL to grant access:

GRANT APPLICATION ROLE POSIT_TEAM_SOURCE.POSIT_TEAM_ADMIN TO APPLICATION POSIT_TEAM_TARGET;

After running this code, you can ask that backups from POSIT_TEAM_SOURCE be used when launching Workbench in the Posit Team Native Application named POSIT_TEAM_TARGET.

Snowflake Managed Credentials

While this step is optional and you can click Skip OAuth Setup this step is critical to the functionality of Workbench within Snowflake. This step configures Workbench to manage Snowflake credentials for users allowing transparent access to Snowflake when using Workbench IDEs. For more details see the official Workbench docs on Snowflake managed credentials.

Click the Copy button on the SQL and run it in a Snowsight Worksheet with ACCOUNTADMIN credentials.

Snowflake Managed Credentials for Snowflake

Snowflake Managed Credentials for Snowflake

Copy the CLIENT_ID and CLIENT_SECRET from running this query into the UI

Copy the client id and client secret

Copy the client id and client secret

Next, click Continue. This will restart Workbench with these credentials and it will be available in 3-4 minutes.

Manage User Access

In order for Snowflake users to access Workbench their roles need to be given access. We recommend giving the application role POSIT_TEAM_USER to those users.

GRANT APPLICATION ROLE POSIT_TEAM.POSIT_TEAM_USER TO ROLE YOUR_USER_ROLE;

Workbench user access

Workbench user access

Ready

Finally once user access has been configured you will be taken to a Ready page.

Workbench ready page

Workbench ready page

After a few seconds you will be redirected to the Workbench management page.

Workbench management page

Workbench management page

Click on the “Service Endpoint” to be taken to the Workbench landing page

Workbench home page

Workbench home page
Note

Users will typically click and launch Workbench from the landing page

Back to top