| Deletions are marked like this. | Additions are marked like this. |
| Line 196: | Line 196: |
| 1. '''{projectShortCode} Transmittal {type} {code}''' - Page title | 1. '''Transmittal {type} {code}''' - Page title |
| Line 201: | Line 201: |
| * '''Status''' - ''pending'', ''scheduled'', ''sent'', ''error'' | * '''Status {dateAndTime}''' - ''pending'', ''scheduled'', ''sent'', ''error''. Date and time suppressed if status is ''pending'' |
| Line 207: | Line 207: |
|
* '''Sender''' * '''Date''' |
* '''Issuer''' * '''Date''' - Date only. No time. Only set if not status is not ''pending'' |
| Line 212: | Line 212: |
| * '''Subject''' - ''code'' - ''title''. Read-only in edit screen | * '''Subject:'' {projectCode} Transmittal {type} {code} {title}'' - Read-only in edit screen |
V2 Screen Layouts
To Do
- Review for correctness [ALL]
- Review headers and sub-headers (including font size)
- Add buttons with button titles, tune button colours (should be less glaring)
- Check widths of selects, to be consistent across screens
- Check links for consistent actions
- We plan to go to a single edit screen, instead of separate edit screens for the object data and classification.
- File Category will be internal only (user should not see)
- Introduce different header background colours for each object (using subtle tones)
General Notes
Process
- If it's difficult to come to agreement then default to showing more data and then solicit real customer feedback for additional guidance
- Don't over think or waste time defining layouts
- Encourage customer feedback and interaction
Terminology
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
- Dossiers
- Files
- Project Team
- (Folders - lower priority)
- (Classification Fields - lower priority)
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 blocks are relevant to all Objects.
{Object} {Type} {Code} - Page title
Identification Block
Type - e.g. Document type
Code - e.g. Document code
Title - Title, which depending on the type, could be multiple lines
Author/Issuer - to review
Date - to review
- Object specific fields
(Description/Summary) - suggest defining description as a classification field
(Status, Private/Public, External/ProjectTeam flags) - to be looked into
(Message) - used for Transmittals, move to its own Block
- Classification fields assigned to identification block (for the given data type)
Folder Block - for Team Members OBS Block, with multiple entries
Responsibilities and Due Dates
Classification Block
Properties Block
Revision Files or Note Blocks - each revision or note has its own block
Reference Blocks:
Links
Subscribers
Transmittals
Detail Screens
Document Detail Layout
Document - {Type} {Code} - Page title. The code is the only document code, which excludes the revision code
Identification {startOfTitle} - Document identification block
Type - Document type
Code - Document code
Title - 4-line document Title
Identification fields
Folder {folderPath} - Folder block
Classification - Document classification block
Properties - Document data block. Only displayed if data fields are defined
Revisions - Sub-header
Revisions - Revisions Block with button +Revision
Revision {revisionNumber} {date} {startOfTitle} - Revision sub-block with button Edit (for editing all blocks ***)
Identification - Revision identification sub-sub-block
Type - Revision Type
Code - documentCode-revisionCode
Title - - 4-line document Title
Author
Date
- Classification fields assigned to identification block (for the given data type)
(Description) - define description as a classification field assigned to identification block
Responsibilities and Due Dates - Revision workflow sub-sub-block
Classification - Revision classification sub-sub-block
Properties - Revision Data sub-sub-block. Only displayed if data fields are defined
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
Notes sub-header
Notes sub-sub-block with button +Note/File
{initials} {datetimeStamp} {startOfNoteText} - Revision notes sub-sub-sub-block
{noteText}
Attached Files - Attachment file list block, a table with following columns, with button +File
Type - File type
Author - Who uploaded
Date - Date/time stamp
Description
Filename
References - Sub-header
Links - Links block(including dossiers?)
Subscribers - Subscribers block
Transmittals - Transmittals block
Issues:
See transmittal detail and how the files are displayed. Will it still be possible to easily transmit notes attachments files (instead of working files)?
- Editing of Revision blocks (see *** above): how to handle editing of individual notes? Probably best to have a separate Edit button on each Note.
- 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
Task - {Type} {Code} - Page Title
Identification {Title} - Task Identification block.
Type - Task Type
Code - Task Code
Title - Task Title
Issuer
Date - Date/time stamp
- Classification fields assigned to identification block (for the given data type)
(Summary) - define description as a classification field assigned to identification block
Folder {folderPath} - Folder block
Responsibilities and Due Dates - Revision task sub-block
Classification - Task classification block
Properties - Task data block. Only displayed if data fields are defined
Notes - Sub-header
Notes block with button +Note/File followed by zero or more of the following:
{initials} {datetimeStamp} {startOfNoteText} - Note sub-block
{noteText}
Attached Files - Attachment file list block, a table with following columns:
Type - File type
Issuer - Who uploaded
Date - Date/time stamp
Description
Filename
References - Sub-header
Links - Links block(including dossiers?)
Subscribers - Subscribers block
Transmittals - Transmittals block
Transmittal Detail Layout
Transmittal - {Type} {Code} - Page title.
Identification {title} - {status} - Identification block
Type - Transmittal type
Code - Transmittal code
Title
Issuer
Date
Status
- Classification fields assigned to identification block
Message - Message block
Message
Folder {folderPath} - Folder block
Classification - Classification block
- Classification fields assigned to Classification Block
Properties - Data block. Only displayed if data fields are defined
- Classification fields assigned to Properties block
References - Sub-header
Recipients - Recipients block. Contains a table (no column headers) with following columns:
To
To
CC
BCC
Initials - Last name, First name
primary email address
Documents - Documents block. Contains a table (no column headers) with the following columns:
{sequenceNumber}
{documentCode}-{revisionCode}
{title}
Revision File or Note Attachment
{fileType}
{documentCode-revisionCode-sequenceAlpha} or {fileNamePrefixedByDocumentCode} - for respectively Revision File or Note Attachment
Issues:
Discussion Draft
Transmittal {type} {code} - Page title
Identification
Type
Code
Title
Status {dateAndTime} - pending, scheduled, sent, error. Date and time suppressed if status is pending
Folder
Classification - if defined
Properties - if defined
Message
Header
Issuer
Date - Date only. No time. Only set if not status is not pending
To
CC
BCC
Subject: {projectCode} Transmittal {type} {code} {title} - Read-only in edit screen
Text
Attachements
Dossier Detail Layout
Identification
Items - Sub-header
Revisions - Sub-sub-header. List with the following columns
Resource Type - Contains: Revision
Description - COntains {revisionTitle}
Tasks - Sub-sub-header?
Users - Sub-sub-header?
User Detail Layout
Profile
Classification
Data
Quick Links
Email Addresses
Issues:
Suggestions:
Identification - Name, etc. File Detail Layout
File ID={fileId} Edit Screens
Document Edit Layout
Task Edit Layout
Transmittal Edit Layout
Dossier Edit Layout
User Edit Layout
File Edit Layout
List Screens
Document List Layout
Task List Layout
Transmittal List Layout
Dossier List Layout
User List Layout
File List Layout
