ULYQUID | Plugin - File


Top Top | Previous Prev | Next Next


Using the File Plugin





Overview

Projects are normally required to handle certain types of files. The [File] plugin provides a simple way to allow project members to share and upload/download project files. Files belong to a category (or to make it understand clearer, think it as folders) and owners can be identified for each file. Also, all revisions are kept for each uploaded file so that history trace back can be done easily. In this way, an efficient file management is possible. The plugin also supports multiple file uploads by automatically expanding an uploaded archive file on server. During the expansion process, all the directory file structure within the archive file will be reflected, with new categories created if not already exist. Files with duplicate contents are avoidable by using the reverting function so that only files with new contents are added to the directory structure.


Virtual Directory

The [File] plugin is based on a file management concept - Virtual Directory. Physical files are stored on server in an one-dimensional storage, which means with no physically structured hierarchy. Instead, each file is assigned a file ID which links to a category ID. By traversing this information, the system is able to construct a virtual directory tree structure. All information regarding the file directory structure is stored in the database, which makes it easy and efficient to manage directories and its files. All files are stored under the project directory with the file name renamed with the assigned file ID.


File Management

The file management pages are accessible by all project members assigned to any of the projects. Here, you will be able to do all sorts of operations on the files, such as uploading/downloading, history tracking, managing categories, etc. Some features are only available for project managers, such as creating/updating/deleting categories. Following features are provided:


Also, project managers are allowed to modify all files regardless of the owner. Whereas, project workers are only allowed to modify the files that are owned (created/uploaded) by it self.


Main Menu

Following shows you the main menu that is present in all file plugin pages. By clicking each of the menu links, you will be able to access all other related pages.



File Plugin Main Menu



File List

Following shows you the file list page. This page lists all files and categories created in the project that you are viewing. By clicking any of the category name will show you a Category Context Menu. By clicking any of the file name will show you a File Context Menu.



File List


Category Context Menu

This context menu lists all the operations you can do with a category. Project manager-specific features will not be displayed here for project workers.



Category Context Menu


  • [Download]: Downloads an archive (assets.zip) of all the categories and files under the selected category in structured hierarchy
  • [Upload]: Short-cut to uploading a file to the selected category - directs to [Upload File] page
  • [Create Category]: Jumps to [Create Category] page with the specified category as parent category by default
  • [Update Category]: Jumps to [Update Category] page with the specified category
  • [Category Details]: Jumps to [Category Details] page with the specified category
  • [Delete Category]: Jumps to [Delete Category] page with the specified category


File Context Menu

This context menu lists all the operations you can do with a file.



File Context Menu


  • [Download]: Downloads a single file
  • [Revision]: Jumps to [File Revision List] page
  • [Update File]: Jumps to [Update File] page with the specified file
  • [File Details]: Jumps to [File Details] page with the specified file
  • [Delete File]: Jumps to [Delete File] page with the specified file


Upload File

Upload a file or multiple files from this page. A single file upload is easily done by selecting the local path to the file. For multiple uploads, you need to archive the directory with the file directory structure you wish to extract on server. You may also choose to revert files if the current revision file contains the same content as the one you are trying to upload. Press the [Upload] button to upload the file.



Upload File


  • [Category ID]: The category of which the file will belong to - a file MUST belong to a category
  • [File]: The local file to be uploaded
  • [Upload Type]: Choose [Multiple] for uploading multiple files from an archive file
  • [Unmodified File]: Choose [Revert] to not upload the file with the same contents


File Revision List

View all uploaded files with the same name under the same category by revision. The caption displays the total number of records stored. Long texts will be displayed as tool tip when mouse is over. Operation menu in each row allows you to manipulate on the selected file (Download, Details, Update, Delete). You can navigate the list if it exceeds the limit of displaying per page by using the pager at the bottom of the table, or display all data by clicking [View All].



File Revision List


File Details

View detailed file information from this page. The [Update] and [Delete] link will jump to the corresponding manipulation pages.



File Details


Update File

Update file information from this page. Note that the only information modifiable is the category and description of file. If you change the category, all file revisions will also be changed to the same category. Press the [Update] button to reflect the new information.



Update File


Delete File

Delete the file. All older file revisions will also be deleted, including the physical files on server. Be aware that this operation cannot be undone. Press the [Delete] button to delete.



Delete File



Category Management

Category management pages let you operate on file categories. Following features are provided:


Create Category

The first thing you must do before uploading a file is to create a category. It is a best practice to create a root category ("root" or "depot" or whatever) for better management.



Create Category


  • [Parent Category]: The parent category of which this new category will belong to. If creating a root category, leave as blank
  • [Category Name]: The category name
  • [Details]: Details of the category


Category Details

View detailed category information from this page. The [Update] and [Delete] link will jump to the corresponding manipulation pages. The two menus will only be available to the project manager.



Category Details


Update Category

Update category information from this page. Press the [Update] button to reflect the new information.



Update Category


Delete Category

Delete the category. All child categories and its files, including the physical files on server will be deleted. Be aware that this operation cannot be undone. Press the [Delete] button to delete.



Delete Category