V2 Screen Layouts

V2Master | V2HighLevelDesign

• Contents

  1. V2 Screen Layouts
  2. To Do
  3. Work Status
  4. General Notes
     1. Process
     2. Terminology
     3. Block Ordering
  5. Detail Screens
     1. Document Detail Layout
        1. Document Detail Buttons
        2. Document Detail Issues
     2. Task Detail Layout
     3. Transmittal Detail Layout
     4. Project Team Detail Layout
     5. File Detail Layout
     6. Dossier Detail Layout
  6. Edit Screens
     1. Document Edit Layout
     2. Task Edit Layout
     3. Transmittal Edit Layout
     4. User Edit Layout
     5. File Edit Layout
     6. Dossier Edit Layout
  7. List Screens
     1. Document List Layout
     2. Task List Layout
     3. Transmittal List Layout
     4. User List Layout
     5. File List Layout
     6. Dossier List Layout

To Do

1. Review button (new, edit and delete) placement on detail screens

2. Define the contents of the Transmittals Block

3. Review block headers and sub-headers (including font size)
4. Review menu titles for configuration related menu items
5. Review for correctness [ALL]
6. Add buttons with button titles, tune button colors (should be less glaring)
7. Check widths of selects, to be consistent across screens
8. Check links for consistent actions
9. We plan to go to a single edit screen, instead of separate edit screens for the object data and classification.
10. Introduce different header background colors for each object (using subtle tones). One or a combination of the following:
    1. Apply color based on object type
    2. Apply color based on block type

Work Status

• Item	Draft	Spec.	Coding	Review	Notes
  Detail Screens
  Document	Done	Done	OPEN	OPEN
  Task	Done	Done	OPEN	OPEN
  Transmittal	Done	Done	OPEN	OPEN
  User	Done	Done	OPEN	OPEN
  File	Done	Done	OPEN	OPEN
  Dossier	Done	Done	OPEN	OPEN
  New/Edit Screens
  Document	OPEN	OPEN	OPEN	OPEN
  Task	OPEN	OPEN	OPEN	OPEN
  Transmittal	OPEN	OPEN	OPEN	OPEN
  User	OPEN	OPEN	OPEN	OPEN
  File	OPEN	OPEN	OPEN	OPEN
  Dossier	OPEN	OPEN	OPEN	OPEN
  List Screens
  Documents	OPEN	OPEN	OPEN	OPEN
  Tasks	OPEN	OPEN	OPEN	OPEN
  Transmittals	OPEN	OPEN	OPEN	OPEN
  Users	OPEN	OPEN	OPEN	OPEN
  Files	OPEN	OPEN	OPEN	OPEN
  Dossiers	OPEN	OPEN	OPEN	OPEN
  Folders	OPEN	OPEN	OPEN	OPEN
  Invitations	OPEN	OPEN	OPEN	OPEN
  Configuration Screens
  Folders	Open	Open	Open	Open
  Task	Open	Open	Open	Open
  Classification Lists	Open	Open	Open	Open
  Classification Classes	Open	Open	Open	Open
  Classification Schemas	Open	Open	Open	Open
  Resource Subtypes	Open	Open	Open	Open
  Access privileges	Open	Open	Open	Open

General Notes

Process

1. If it's difficult to come to agreement then default to showing more data and then solicit customer feedback for additional guidance

Terminology

1. Object - Refers to system objects such as documents, revisions, tasks, transmittals, users, etc. Block ordering is applicable to following Objects:

   • Documents and Revisions
   • Tasks
   • Transmittals
   • Users
   • Files
   • Dossiers
   • Project Team
   • (Folders - lower priority)
   • (Classification Fields - lower priority)

2. Type - A field associated with the object that determines its classification class, and consequently:

   • The allowed set of classification fields and their properties
   • The screen display of the classification fields

Block Ordering

Not all block types are relevant to all Objects.

1. {Object} {Type} {Code} - Default page title

2. Identification Block

   • Type - e.g. Document type

   • Code - e.g. Document code

   • Title - Could be multiple lines, depending on the type

   • Author/Issuer - Depends on type

   • Date - Depends on type

   • Additional object specific fields

     • (Status, Private/Public, External/ProjectTeam flags) - Issue: to review

   • Identification block classification fields (for the given data type) - Only displayed of classification values for the identification block, for the given type, are defined or if one of the fields is defined as display on detail

     • Note that Description/Summary fields should be defining in the classification configuration TN: why?

3. Folder Block - for all objects except Team Members

4. Project Position Block - For Team Members only, can contain multiple entries if the team member is assigned more than one project position

   • TN: not a classification?

   • AH: in the initial release this block will not be implemented. The short-term workaround is to define project position as a classification field, which will be displayed in one of the other blocks

5. Responsibilities and Due Dates Block - Not implemented in the first release

6. Classification Block - Only displayed if classification values for the classification block, for the given type, are defined or if one of the fields is defined as display on detail

7. Properties Block - Only displayed if classification values for the data block, for the given type, are defined or if one of the fields is defined as display on detail

8. Message Block - For Transmittals

9. Revision Blocks - For Documents, includes Files and Note sub-blocks

10. Note Blocks - For Tasks

11. References - Sub-header

12. Links Block - Not implemented in the first release

13. Subscribers Block - Not implemented in the first release

14. Transmittals Block

15. Links Block - Not implemented in the first release (except for Dossier links).

    • To review: should this block include references to Dossiers? Or should that be in a separate block?

16. Subscribers Block - Not implemented in the first release.

17. Transmittals Block - Only implemented for the Documents Detail screen

Detail Screens

Document Detail Layout

1. Document - {type} {code} - Page title. The code is the only document code, which excludes the revision code

2. Identification {startOfTitle} - Document identification block

   • Type - Document type

   • Code - Document code

   • Title - 4-line document Title. To review: The title comes from the revision being displayed (e.g. what was selected from the URL)

   • Document Identification fields - Optional. To review: These are the document's identification fields. Given the title is from the revision, will there be confusion?

3. Folder {lowestLevelOfFolderPath} - Folder block

4. Classification - Document classification block. Optional

5. Properties - Document data block. Optional

6. Revisions - Sub-header

7. Revisions - Revisions Block with button +Revision

   1. Revision {revisionNumber} {date} {startOfTitle} - Revision sub-block. Buttons eEdit, xDelete (Requires confirm). Note that there must always be at least one revision present.

      1. Identification - Revision identification sub-sub-block

         • Type - Revision Type

         • Code - {documentCode}-{revisionCode}

         • Title - 4-line document Title.

         • Author

         • Date

         • Revision Identification Fields - Optional

      2. Responsibilities and Due Dates - Revision workflow sub-sub-block

      3. Classification - Revision classification sub-sub-block. Optional

      4. Properties - Revision Data sub-sub-block. Optional

      5. Revision Files - Revision file list sub-sub-block, table with following columns, button +File

         • Type - File type

         • Author - Who uploaded

         • Date - Date/time stamp

         • Description

         • Filename

         • Buttons: Edit, De-attach (yellow), eDelete,

      6. Notes - Sub-header

      7. Notes - Sub-sub-block with button +Note/File

         1. {initials} {datetimeStamp} {startOfNoteText} - Revision notes sub-sub-sub-block. Buttons eEdit, xDelete

            1. {noteText}

            2. Attached Files - Attachment file list block, a table with following columns, with buttons +File

               • Type - File type

               • Author - Who uploaded

               • Date - Date/time stamp

               • Description

               • Filename

               • Buttons: Edit, De-attach (yellow), eDelete,

8. References - Sub-header

9. Links - Links block

10. Subscribers - Subscribers block

11. Transmittals - Transmittals block

Document Detail Buttons

1. Documents/Revisions

   1. Edit document & revision - Edits all document and revision fields, including their associated classification fields. Excludes:

      • Notes
      • Files
      • Workflow fields - Deal with this after the first release
      • Linked items
   2. New revision
   3. Delete revision - Deleting the last revision also deletes the document (perhaps displaying a pop-warning)

2. Notes

   1. New note
   2. Edit note
   3. Delete note

3. Files - Both revision files and notes files:

   1. New file - Includes both uploading files and attaching files
   2. Edit file - Edit the file's metadata
   3. Delete file
   4. De-attach file

Note: In the edit/new screens, there is only a Save button and there are no Back, Cancel, Preview, Confirm, etc. buttons.

Document Detail Issues

1. Compare with transmittal detail screen layout and see how the files are displayed. Will it still be possible to easily transmit notes attachments files (instead of working files)?

2. Editing of Revision blocks (see *** above): how to handle editing of individual notes? Probably best to have a separate Edit button on each Note.
3. Clicking on Document Revision N in a List should open detail screen with Revision block and sub-block for Revision N open.

Task Detail Layout

1. Task - {type} {code} - Page Title

2. Identification {startOfTitle} - Task Identification block.

   • Type - Task Type

   • Code - Task Code

   • Title - Task Title

   • Issuer

   • Date

   • Task Identification fields - Optional

3. Folder {lowestLevelOfFolderPath} - Folder block

4. Responsibilities and Due Dates - Task sub-block

5. Classification - Task classification block. Optional

6. Properties - Task data block. Optional

7. Notes - Sub-header

8. Notes - Notes container block with button +Note/File. To review: How does +File work?

   1. {initials} {datetimeStamp} {startOfNoteText} - Note sub-block

      1. {noteText} - Display free floating (e.g. not in its own block)

      2. Attached Files - Attachment file list block, ith button +File. Table with following columns:

         • Type - File type

         • Issuer - Who uploaded

         • Date - Date/time stamp

         • Description

         • Filename

9. References - Sub-header

10. Links - Links block

11. Subscribers - Subscribers block

12. Transmittals - Transmittals block

Transmittal Detail Layout

1. Transmittal - {type} {code} - Page title.

2. Identification {status} - {startOfTitle} - Identification block

   • Type - Transmittal type

   • Code - Transmittal code

   • Title

   • Status {dateAndTime} - pending, scheduled, sent, error. The display of the date and time suppressed if the status is pending

   • Classification Identification Fields - Optional

3. Folder {lowestLevelFolderPath} - Folder block

4. Responsibilities and Due Dates

5. Classification - Transmittal classification block. Optional

6. Properties - Transmittal data block. Optional

7. Message - sub-header

8. Message - Block

   1. Header - sub-block

      • Issuer

      • Date - Date only, with display of time. The date is not set if status is pending

      • To - Contains: {initials} - {lastName}, {firstName}, {primaryEmailAddress}

      • CC - Contains: {initials} - {lastName}, {firstName}, {primaryEmailAddress}

      • BCC - Contains: {initials} - {lastName}, {firstName}, {primaryEmailAddress}

      • Subject - Contains: {projectCode} Transmittal {type} {code} {title} - Read-only in edit screen

   2. Text - sub-block

   3. Attachments - sub-block. Contains table (no column headers. Issue Change background color of the line with the document code and title to provide visual hint) with the following columns (displayed as two rows):

      • {sequenceNumber}

      • {documentCode}-{revisionCode}

      • {title}

        • Revision File or Note Attachment

        • {fileType}

        • {documentCode-revisionCode-sequenceAlpha} or {fileNamePrefixedByDocumentCode} - for respectively Revision File or Note Attachment

Project Team Detail Layout

1. Project Team - {Type} - {firstName lastName} - Page title

2. Identification {firstName lastName}

   • Type - Team Member Type

   • First Name

   • Last Name

   • Initials

   • Company - Note: New database field. Not required

   • Primary Email

   • Secondary Emails - Can contain multiple entries, displayed in vertical list

   • User Identification Fields - Optional

3. Project Organisation {lowestLevelOrgansiationalBreakdown} - Organisation block

   • Project Position - displayed same as Folder is displayed in other Objects

4. Classification - User classification block. Optional

5. Properties - Use data block. Optional. Can be used to define the user's contact info

6. Access Privileges - Sub-header

7. Access Privileges - access privileges and responsibilities

   • Internal/External - Issue: Convert to radio button. Need to define field header and and the names for the off/off values

   • Login Enabled - Note: Convert to radio button, with Yes and No values

   • Access Privileges Contains a table with the following columns (no column headers):

     • Privilege

     • Folder Path (global + assigned folders)

Issues:

1. Display the User Detail page in single column format (e.g. like all the other detail pages), with blocks consistent with other object detail screens
   1. Remove the Quick Links block, all necessary links are already in banner menu

2. Project Role should be removed from system data and be replaced by Project Position.

   1. Project Role now mandatory system data similar to Folder; project role can be configured as a classification field (text description) if needed

File Detail Layout

1. File - {type} {filename} - Page title

2. Identification {filename} - File identification block

   • Type - File Type = Revision File or Note Attachment (or blank if not-attached)

   • File Name - current file name

   • Attached to

   • File ID={fileId}

   • Uploader

   • Date - upload date

   • Description - description required as system data since files do not allow classification

3. Folder {lowestLevelOfFolderPath} - Folder block

4. Properties - File properties block. Displays fields from the file_assets database table, not classification fields

   • File Format

   • Size

   • Original File Name

Issues:

1. Currently the blocks titles/uses do not relate very well to the other blocks in other detail screens

Dossier Detail Layout

1. Dossier - {name} - Page title

2. Identification {name} - Dossier identification block

   • Name - Dossier name

   • Issuer

   • Private Dossier Yes/No

   • Date - creation date

   • Description - The description field is required, because dossiers do not allow classification

3. Folder {lowestLevelOfFolderPath} - Folder block

4. Items - Sub-header

5. Document Revisions - Revision items block, contains a table with the following columns:

   • Item - Contains: {documentCode}-{revisionCode}

   • Description - Contains {revisionTitle}

6. Tasks - Task items block, contains a table with the following columns:

   • todo

Issues:

1. To review: Is Document Revisions a sensible block title?

2. The Resource Type in the Document Revisions / Task blocks doesn't seem required, as this is given by the block header

Edit Screens

Document Edit Layout

Task Edit Layout

Transmittal Edit Layout

User Edit Layout

File Edit Layout

Dossier Edit Layout

List Screens

Document List Layout

Task List Layout

Transmittal List Layout

User List Layout

File List Layout

Dossier List Layout