Rabix Composer configuration
Before you can use Rabix Composer, you must either add a local workspace or connect a platform account, or both. Your local workspace is where you create and store your local apps and data files. Your Platform account connection allows you to access and edit apps from your Platform projects, and also to access public apps from the Platform.
You can connect multiple platform user accounts from multiple platforms to Rabix Composer. Only one user is active at any one time, but you can seamlessly switch between Platform user accounts.
The left-hand navigation pane, under My Projects, will always display the Local Files from your local workspace, along with those project files you imported from the active Platform account (e.g. Seven Bridges).
Add a local workspace
- In the Rabix Composer left-hand navigation pane, click + Open a project. In the Open a project dialog, select the Local option, then click Select a folder.
- Navigate to the folder you want to add as your workspace. Click Add to workspace and Done. The folder you have selected is added as a local workspace. If you do add a higher level folder by mistake, you can right-click it and select Remove from Workspace.
Now you can create apps in your local workspace and edit them using the Rabix Composer tool and workflow editors. You can also select an app from this area and drag and drop it into a workflow.
Connect a Platform account
To connect a Platform account to Rabix Composer, you need:
- A Platform user account. This can be either on either the Seven Bridges Platform, Cancer Genomics Cloud (CGC), or Cavatica, and at least one project associated with that account. If you don’t already have a Platform account, you can register for a free account on the CGC (select the option to register with an email and password, not the eRA Commons option) then create a project in that account. Note that CGC accounts are intended for academic users. If you like what you see, and want to continue using the functionality on the CGC Platform for ongoing commercial purposes, you can contact Seven Bridges Genomics and discuss a paid-for account on the Seven Bridges Platform.
- A valid Platform authentication token. (Seven Bridges Platform, CGC or Cavatica)
You can have several Platform accounts connected to Rabix Composer. Deactivate, Edit, and Remove the connected accounts from the Settings tab. The active account is labelled as such in the Settings tab and is displayed in the top right corner of Rabix Composer.
Follow the steps below to connect the first Platform account to a particular instance of Rabix Composer. If you’ve already connected at least one account, you can add projects from your active account, or you can go to the Settings tab to connect other Platform accounts.
- Click +Open a project in the left-hand navigation pane.
- In the popup, select the Platform tab.
- Click Add an Account.
- In the popup, select the platform name from the dropdown menu and paste in the corresponding Authentication Token. If you don’t have your token handy, click Get Token.
- Click Add to finish connecting the Platform account. This brings you back to the Open a Project popup.
- Click inside the text box to see a list of projects associated with the active account.
- Select each project you want to add to your workspace. You need to add at least one project to follow the tutorials here.
- Click Done to add the selected projects to Rabix Composer.
Set up integration with Rabix Executor
Local or Platform apps that are opened in Rabix Composer can be executed locally using the integration with Rabix Executor. Follow the procedure below to set up Rabix Executor integration.
- Open the dropdown menu in the top-right corner of the screen.
- Select Settings.
- In the Rabix Executor section, select which Rabix Executor version to use:
- Bundled - The Rabix Executor version that is bundled with the Rabix Composer installation. This is the default option.
- Custom - Your local Rabix Executor installation. If you select this option, click Browse to provide the path to the Rabix Executor executable file.
Note: This form of integration will work with Rabix Executor version 1.0.5 or later.
- Define the Output folder. This folder will contain a subfolders and files for every execution of an app.
Add projects from your active platform account
Adding a platform account does not automatically add all the projects associated with the account. To add one or more projects from the active platform account, follow the instructions below:
- Click + Open a Project in the left-hand navigation pane.
- In the popup, select the Platform option.
- Click inside the text box to see a list of projects associated with the account.
- Select each project you want to add to your workspace. You will need to add at least one project in order to follow the tutorials here.
- Click Done to add the selected projects to Rabix Composer.