AquaScripts and AquaProjects

Within Aqua Data Studio, we have introduced the concept of projects, which consist of AquaScripts, Server Connections and User Files.  The projects provide a self contained programming unit that allows users to create a set of AquaScripts that work on a specific set of database servers with the ability to store and access configuration files.  Once a project is completed, it may be exported and shared with other users.

Creating a New AquaProject: Creating a new Project is similar to creating a new folder in the Schema Browser or Files Browser. Within the Projects Browser (found next to the Schema and Server Browser tabs) merely right click and select New Project then enter a Project path and name.  To create a new AquaScript, right click in the Project's AquaScript folder and select New from the context menu. To Register a Server, right click on the Servers Folder and select Register Server, or drag an exisiting server from the Schema Browser into the Servers folder of your project to make a copy. To create a new User File, right click in the User Files folder and select New. To organize multiple Projects, right click on the Projects Browser's root folder icon and select New Folder. Folders can contain other folders or groups of Projects.

Creating a New Project	Creating an AquaScript	Register Servers for a Project	Drag and Drop Servers to a Project	Creating Files in User Files

Projects Browser:  Projects are presented in a tree of virtual folders that may be used for grouping projects. Similar to folders in the Servers Browser, the virtual folders may contain multiple AquaProjects, and may be moved from one folder to another by dragging and dropping.  Each project is mapped to a fixed path on the local filesystem, which is independant of the virtual tree. For a diagram of the AquaScript Project Browser Workspace, click here.

AquaScripts, Servers and User Files: Every project has an AquaScripts directory, a Servers directory and a User Files directory. The AquaScripts Folder holds all of the AquaScript (.xjs) files which can be executed and debugged. The Servers Folder can contain one or many registered database server connections for use by the AquaScripts in that project. If there is a server in the Schema Browser you wish to use in a Project, drag that server from your Schema Browser into a desired Project and the connection information will copy over.  The User Files Folder contains files for input or output of the AquaScripts. The AquaScripts, Servers and User Files folders can also contain multiple subfolders to assist with organizing Project content. Every Project is self-contained along with its properties and can be exported as a .zip or compressed file for archiving. 

Projects Tree	Projects Browser	AquaScripts Folder	Servers Folder	User Files Folder

Version Control Support for Projects: The ADStudio version control system also supports AquaProjects. This allows teams to collaborate in the development of AquaScripts in a project. Users can update and commit project scripts, files and server registrations. Commiting server registrations are prompted with a warning to alert the user that the a potential server password will be commited to a shared repository which could be a security concern. The version control system works similiarly in AquaProjects as the rest of the application.

Version Control of Projects

Exporting Projects to File: AquaScript Projects can be exported to compressed files. During export, users can select which of the Project directories to export: database server connection information, AquaScripts and/or User Files content. The project zip file may be sent to other users who are able to unzip the file, and then mount the project in their environment by right-mouse-clicking in the Projects tree and selecting "Mount Project".

Export Projects

Searching in Projects: AquaScripts Projects can be searched for specific files or content using the Project Search feature available in the right-click context menu.

Search Projects