Easily find issues by searching: #<Issue ID>
Example: #1832
Easily find members by searching in: <username>, <first name> and <last name>.
Example: Search smith, will return results smith and adamsmith
A project represents a complete software solution, and defines project-wide settings. A project contains a set of AquaScripts, Servers and User Files. AquaScripts contain the source code and logic of the software solution, servers are registration parameters for database servers and User Files are a set of files which are used by the logic of the software solution for configuration or file output as part of an action within the application. Within the project, scheduled jobs may be defined to schedule the execution of AquaScripts at defined intervals. Each project has a defined set of users, roles and permissions to control the access of the software logic.
The Workspace of a project defines the User Interface area which may be used by the AquaScript logic of the project. In the Project Settings, an AquaScript may be defined as the starting script or the entry point to the software solution. Defining the AquaScript of a project is the equivalent to launching the Java Virtual Machine and passing a Java class with a method main(String[] args). When the user initially enters the project, this AquaScript will be executed. The Workspace embodies the concept of a toolbar, which may be populated by the AQDashboard Open API to display a set of actions that hyperlink to the execution of other AquaScripts. This allows a developer to create an AquaScript for each action and UI screen, which are hyperlinked and bound to permissions by AquaScripts.
When creating a project, you will need to define a project descriptor. The descriptor defines the unique name to be used in the URL naming. For example, the project with a descriptor of "aquafold_project", would have a URL entry point of "http://localhost/app/home/project/aquafold_project".
When creating the UI of a page, toolbar buttons maybe associated with images from a pre-defined set of icons that are bundled with Aqua Data Server. The icon URLs may be accessed using the Open API AQAqua.getIconURL. Example :
aqua.getIconURL("aquafold/database/database.png")
For more on Projects, see the Project section.
The icon set is included in the Aqua Data Server binaries under a package naming convention "aquafold/<TOPIC>/<ICON_NAME>", eg : "aquafold/database/database.png";
Aqua Data Server projects can be set for public access where visitors can view the project workspace and run AquaScripts accessible through the GUI elements on the workspace. An example of such a project is the “MAC Finder” project built as an illustration of Aqua Data Server capabilities.
External visitors will not be able to see the source code of the public project, make any modifications or access any project areas other than the Workspace.
Public access to a project can be set at User Home->Project->Settings . Once the “Public” checkbox is checked the public URL will be displayed in the “Project Settings” pane.
Visitors should use this URL to access the Workspace of a public project.
Some Aqua Data Server users will never be working with the development environment of Aqua Data Server but only viewing (or otherwise using) results of AquaScripts developed by other users. From the perspective of such users GUI elements related to project development and administration will be redundant, consuming the workspace area that can alternatively be used for displaying script results and controls.
Aqua Data Server projects can be configured to hide unnecessary tabs and utilize the entire window area for the Workspace only.
The “Fullscreen” option can be set at the “User Home”->Project->”Settings” tab.
Once the “Fullscreen” checkbox is checked, only the Workspace tab will be displayed to the project users. Other tabs and the project owner information pane will be hidden. Only the project owner will still see the regular project tabs and will not be impacted by the "Fullscreen" setting. Note that fullscreen only controls how the project's workspace is displayed to the user. Fullscreen does not impact project permissions. Users can still access the individual project tabs if they know the URL and have been granted the necessary project permissions.
The image below shows the "Hello World" project workspace with the “Fullscreen” option turned off.
The image below shows the "Hello World" project workspace with the “Fullscreen” option turned on.