V2 File Handling

V2Master

• Contents

  1. V2 File Handling
  2. Issues
     1. First Release
     2. Design Issues
     3. Items to Prototype
  3. Introduction
  4. Access and Upload Permissions
  5. File Metadata
     1. Metadata Fields
  6. Basic Transaction
  7. Uploading Files and Attaching to Objects
     1. Uploading Files
     2. Selecting File From a Basket
     3. Selecting a non-Attached File
     4. Selecting a Flagged File
  8. Editing File Metadata
  9. File Versioning
  10. Future Releases

• 2013.08.31 ah & jk

Issues

First Release

1. Include flags in the first release?

Design Issues

1. Files attached attached to tasks or task notes?

2. How to handle file category for files attached to task/task notes?

3. Is the is attached to something flag in the metadata required in the database of should be be derived?

4. Will paging be required when selecting:

   1. Selecting folders
   2. Selecting baskets
   3. Selecting items from baskets
5. How should file versioning and file locking work?

Items to Prototype

1. Selecting folders
2. Selecting baskets
3. Selecting items from baskets

Introduction

1. A file can only be attached to one object
2. The first release will allow files to be attached to the following objects:
   1. Revisions
   2. Task notes (or directly to tasks?)
3. It is possible to search for and generate lists of files
   1. By default only non-attached files are displayed

Access and Upload Permissions

1. When a file is not attached to an object:
   1. The file must be assigned to a folder
   2. Folder determines who can view the file's metadata and download the file
2. When a file is attached to an object:
   1. Access to the file is controlled by the folder associated with the object
3. Anyone with write permission on a folder can upload files

File Metadata

1. File metadata is stored in the File Assets table

2. The File Assets table contains:
   1. Metadata associated with each file
   2. Links to the actual files stored in the file system

Metadata Fields

1. Filename (required. set automatically, can be overridden)
2. Date uploaded (required, set automatically. can be overridden)
3. Who uploaded (required. set automatically. can be overridden)
4. Description (optional)

5. File format (required? set automatically. .doc, .dwg, .etc)

6. File category (optional? working file, revision file)
   1. What is the meaning for task note attachments?

7. File type (optional. publish, source, mark-up, etc.)

8. Folder (required when the file is not attached to an object, otherwise ignored)

9. Flag is attached to something (required)

   1. Set automatically

Basic Transaction

1. List files, including specifying search/sort criterion:
   1. Search/sort by metadata fields
      1. Folder
      2. Filename
      3. Date
      4. Who uploaded
      5. Description (optional)
   2. By default display only non-attached files
   3. But also able to include attached files (and exclude non-attached files)
   4. Add files in the resulting list into to a basket
   5. Select files and add to a (new) basket
2. File detail screen showing the file's metadata and a download link
3. Edit file details, including the file name
4. Download a file
5. Delete uploaded files
6. Re-upload files

Uploading Files and Attaching to Objects

1. From a revision detail screen or comment note screen, press the Add File button:

2. A new screen, or part of a screen, appears with the following choices:
   1. Upload a file
   2. Add the file from a basket
   3. Select a files which is not attached to anything

   4. Select a flagged file (include in first release?)

Uploading Files

1. A form appears
2. The user enters the metadata
3. The user selects a file to upload

4. The users presses Go and the file is uploaded (displaying a progress bar)

5. When the upload is complete:
   1. The file and metadata is automatically saved
   2. If the upload was performed in the context of an object, the file is attached to it
   3. There is no confirmation required

Selecting File From a Basket

1. Select a basket (paging required?)
2. The basket's content is displayed (paging required?)
3. Select a file from the basket
4. Enter the metadata
5. Press 'Go'
6. The metadata is saved and the file is attached to the object

Selecting a non-Attached File

1. Select a Folder
2. The non-attached files in the folder are displayed (paging required?)
3. Select a file from the folder
4. Review file's metadata, and possible change it
5. Press 'Go'
6. The metadata is saved and the file is attached to the object

Selecting a Flagged File

1. The list of flagged files is displayed (paging required?)
2. Select a file from the list
3. Review file's metadata, and possible change it
4. Press 'Go'
5. The metadata is saved and the file is attached to the object

Editing File Metadata

1. It is possible to edit a file's metadata

File Versioning

1. If a file is deleted, it is retained in the system
2. Files which have been transmitted are locked (what does this mean)
3. When files that are re-uploaded, the previous file is retained in the system

Future Releases

1. Upload a ZIP file
   1. The ZIP file is unpacked
   2. Each individual file is saved separately
   3. The metadata for the files is only entered once and is the same for each file (except for the file name)