6.1 Workspace

On this page:

• What is a Workspace?
• Creating a Dashboard

What is a Workspace?

As an AquaScript developer, you might want to create AquaScripts that require user input and/or display output to the user. The Workspace tab is the place where users can view the output of and interact with your script. For example, as shown in the screenshot below, a developer has created a report that displays the company's annual revenue by country and provides the ability to filter and export the data. When a user clicks on the "Company Revenue" project from his My Projects page, he is immediately taken to the project's workspace (View Workspace Project Permission required) and can view the script's output and interact with the report. 

Depending upon your project settings, the report could be displayed "full screen" or even made public.

The workspace tab renders all HTML output produced by your AquaScript via the aqua.response.write API. This allows you to output tables, buttons, text areas, input fields, images, charts and any other HTML elements.  The behavior, placement and functionality of each element is also controlled via your AquaScript.

Though you can add an unlimited number of AquaScripts to a project, only a single AquaScript can be linked to the project's workspace, specified in the Project's Settings tab. The next section explains how to programmatically link multiple AquaScripts together and display them in the workspace. 

Creating a Dashboard

As an AquaScript developer you might want to create several related scripts inside of a single project and provide the user ability to navigate amongst them within the project's workspace. This is where the concept of a dashboard comes in. The section normally referred to as the Action Bar is called the Dashboard in the Workspace tab. This is the area just below the "Workspace" tab. A dashboard can contain custom buttons that are placed programmatically via AquaScripts, using the aqua.response.dashboard.addToolBar Aqua Open API function.

Dashboard buttons are links to the AquaScripts in the project. Clicking on the button will launch a corresponding script. The script's output will be displayed in the same Workspace.

The following example places two buttons and a separator on the Dashboard as shown on the screenshot below:

Buttons launch two project AquaScripts CompanyRevenueBasic.xjs and CompanyRevenueAdvanced.xjs

var urlEntryPoint = aqua.project.getDashboardURL() + "/"; // Returns project URL that is used as a prefix for referensing scripts below.

function buildToolbar()
{
   // Build toolbar
   var dashboard = aqua.response.dashboard;

   dashboard.addToolbarButton(urlEntryPoint + "CompanyRevenueBasic.xjs", "Company Revenue - Basic", "Company Revenue - Basic", aqua.getIconURL("aquafold/database/database.png") );
   dashboard.addToolbarSeparator();
   dashboard.addToolbarButton(urlEntryPoint + "CompanyRevenueAdvanced.xjs", "Company Revenue - Advanced ", "Company Revenue - Advanced", aqua.getIconURL("aquafold/database/table.png"));
}