Skip to main content
All CollectionsPortal-X Pages
Design | Files | Global Files
Design | Files | Global Files

Global Files V3

Jason Liang avatar
Written by Jason Liang
Updated over 8 months ago

The new Global Files V3 service provides a flexible repository for organizing files that are globally available to all users of an app. V3 files are stored separately from the legacy global files.

From the Global Files page, you can:

  • upload, move, copy, and delete files

  • create, move, and delete folders

  • download an archive of all of an app’s global files

  • restore an archive of an app’s global files

To get started, find the Global Files page on the brainCloud portal.

  • Navigate to the "File Folders" dropdown menu located in the upper-left corner of the files list to access files organized within various folders.

Add Folder

  • Click the [Action...] button located at the right-top corner of the files list. Select Create Folder from the menu. Put a name for this folder (Note: only lowercase letters, numbers, the underscore "_" and hyphen "-" characters are allowed).

  • Root location is the default Folder Location, should you desire to alter the folder creation location, you may do so by selecting a pre-existing folder from the dropdown menu. Additionally, you have the option to provide a description for this folder in the designated Description text box.

Upload File

  • Click Upload File from [Actions] dropdown menu. Click the Choose File button from the open dialogue and select the file from your file explorer.

  • Click the Add button, the uploading file name will show up on the screen, select the folder to which you want to put the file from the right side folder section. Click the Upload File button at the right bottom corner of the dialogue box.

  • All done! Your file is uploaded to the brainCloud Files Storage System. You can do other operations, such as move, delete, and edit to better organize your files as you want from the page.

  • You may also want to back up all your global files to your local storage or import global files from other apps, you can do it through the Import Archive/ Export Archive options of the Actions menu.

Global Files V3 APIs

The Global File APIs are used to access the V3 of our Global Files Service. The V3 APIs bring new features to global files:

  • Ability to organize files into sub-directories.

  • Ability to upload global files from the Client Libraries (by migrating an uploaded User File).

Get global files list:

  • Navigate to Design | Cloud Code | API Explorer page, after authentication, select the GlobalFileV3 service and GetGlobalFileList operation, and hit Run, you will find the uploaded files and the created folder info from the response.

    You may notice each folder has a treeId - which allows us to rename and move directories without breaking the relationship with the associated files, this id represents the folder that the files are located within. If <null> or ““ or field is not present, then the file is assumed to be in the root directory. If the field is specified, but treeId cannot be found, then place the file in the “_recovered” directory, updating the treeId accordingly.

Did this answer your question?