6.5 User Files

As you are developing AquaScripts, you may encounter the need to read from property files, dynamically generate binary files or modify existing files. All this is possible using the Aqua Open APIs. Similar to accessing Server connections from your AquaScripts, you can programmatically read and write to your project's User Files directory. The User Files tab gives you a graphical view of the what is currently in the User Files folder and lets you import new user file as well.

On this page:

• Manage User Files
  • Folder Management
  • Import User File
  • User File Management
• AquaScript Code Example

Manage User Files

The User Files tab lists all AquaScripts in the current project that you have access to.

Folder Management

Folders are provided so that you can organize your User Files as you choose. Folders work similar to the way they function in your Operating System (OS). You can create, rename and delete folders and move User Files into and out of folders. Similar to the OS, if you delete a folder, all content inside the folder gets deleted as well.

Import User File 

The Import File  button allows you to upload an User File into your current project. If an User File already exists in your project with the same name and in the same folder, you will be given a choice to overwrite the existing User File or cancel the operation. You may import only a single User File at a time. If you would like to upload several User Files, consider using Import Project Package.

User Files Management

You can Import , move and delete User Files, similar to the way you would manage files in your OS. However, there are a couple of differences to note

• You cannot create a new user file. User files can be created programmatically via AquaScripts or be imported.
• User files cannot be edited. You can overwrite them using import or AquaScripts or delete them.
• All user files are treated as binary content. When a user file link is clicked, the browser will receive a request to download the file. The content is not displayed within the application GUI.

AquaScript Code Example

User files are referenced by their URLs in AquaScripts.

URL of a file stored in the User Files folder can be obtained using the API function

String URL = aqua.project.getFileURL("path and name of the file")

In the tutorial HelloWorld project two images are saved in the User Files/Icons folder - green.png and blue.png

The images are used as icons for the toolbar buttons. The following code builds the toolbar buttons and use the images stored in the User Files.

function buildToolbar()
{
   var dashboard = aqua.response.dashboard;
   dashboard.addToolbarButton ( urlEntryPoint + "HelloWorld.xjs", "Hello World", "", aqua.project.getFileURL("Icons/green.png") );
   dashboard.addToolbarSeparator();
   dashboard.addToolbarButton (urlEntryPoint + "typeHelloWorld.xjs", "Type-in Hello World", "", aqua.project.getFileURL("Icons/blue.png") );
}

NOTE: The file is referenced with function

aqua.project.getFileURL("Icons/blue.png")

Which returned value is: "/files/userfile/Icons/blue.png"