| Deletions are marked like this. | Additions are marked like this. |
| Line 16: | Line 16: |
| 1. We plan to go to a single edit screen, instead of separate edit screens for the object data and classification. 1. File Category will be internal only (user should not see) | 1. We plan to go to a single edit screen, instead of separate edit screens for the object data and classification. |
| Line 21: | Line 20: |
| Line 29: | Line 28: |
| || User || Done || OPEN || OPEN || OPEN || || | || User || Done || Review || OPEN || OPEN || || |
| Line 61: | Line 60: |
|
1. If it's difficult to come to agreement then default to showing more data and then solicit real customer feedback for additional guidance 1. Don't over think or waste time defining layouts 1. Encourage customer feedback and interaction |
1. If it's difficult to come to agreement then default to showing more data and then solicit customer feedback for additional guidance |
| Line 67: | Line 64: |
|
1. '''Object''' - Refers to system objects such as documents, revisions, tasks, transmittals, users, etc. Block ordering is applicable to following Objects: |
1. '''Object''' - Refers to system objects such as documents, revisions, tasks, transmittals, users, etc. Block ordering is applicable to following Objects: |
| Line 86: | Line 81: |
| ''Not all block types are relevant to all Objects.'' | ''Not all block types are relevant to all Objects.'' |
| Line 92: | Line 87: |
|
* '''Title''' - ''Title, which depending on the type, could be multiple lines'' * '''Author/Issuer''' - ''to review'' * '''Date''' - ''to review'' * Object specific fields * '''(Status, Private/Public, External/ProjectTeam flags)''' - ''to be looked into'' |
* '''Title''' - ''Title, which depending on the ''type'', could be multiple lines'' * '''Author/Issuer''' - Depends on ''type'' * '''Date''' - Depends on ''type'' * ''Additional object specific fields'' * '''(Status, Private/Public, External/ProjectTeam flags)''' - '''''Issue:''''' to review |
| Line 98: | Line 93: |
|
* '''(Description/Summary)''' fields should be defining as classification fields 1. '''Folder Block''' - for ''Team Members'' OBS Block, with multiple entries |
* Note that ''Description/Summary'' fields should be defining in the classification configuration 1. '''Folder Block''' - for all objects except ''Team Members'' 1. '''OBS Block''' - For ''Team Members'' only, has multiple entries, one for each project role that the team member is assigned |
| Line 101: | Line 97: |
|
1. '''Classification Block''' - Only displayed if classification fields are defined or if one of the fields is as required 1. '''Properties Block''' - Only displayed if classification fields are defined or if one of the fields is as required 1. '''Message Block''' - For Transmittals 1. '''Revision Blocks''' - For documents, includes ''Files'' and ''Note'' sub-blocks 1. '''Note Blocks''' - For tasks 1. ''' Reference Blocks:''' - Sub-header 1. ''' Links Blocks''' 1. ''' Subscribers Blocks''' 1. ''' Transmittals Blocks''' |
1. '''Classification Block''' - Only displayed if classification values for the object are defined or if one of the fields is defined as ''display on detail'' 1. '''Properties Block''' - Only displayed if classification fields for the object are defined or if one of the fields is defined as ''display on detail'' 1. '''Message Block''' - For ''Transmittals'' 1. '''Revision Blocks''' - For ''Documents'', includes ''Files'' and ''Note'' sub-blocks 1. '''Note Blocks''' - For ''Tasks'' 1. '''References''' - Sub-header 1. '''Links Block''' 1. '''Subscribers Block''' 1. '''Transmittals Block''' |
| Line 121: | Line 117: |
|
1. '''Folder {lowestLevelFolderPath}''' - Folder block 1. '''Classification''' - Document classification block 1. '''Properties''' - Document data block. Only displayed if data fields are defined |
1. '''Folder {lowestLevelOfFolderPath}''' - Folder block 1. '''Classification''' - Document classification block. Optional 1. '''Properties''' - Document data block. Optional |
| Line 126: | Line 122: |
| 1. '''Revision {revisionNumber} {date} {startOfTitle}''' - Revision sub-block with button Edit (for editing all blocks ***) | 1. '''Revision {revisionNumber} {date} {startOfTitle}''' - Revision sub-block. Button '''Edit''' |
| Line 129: | Line 125: |
|
* '''Code''' - documentCode-revisionCode * '''Title''' - - 4-line document Title |
* '''Code''' - '''{documentCode}-{revisionCode}''' * '''Title''' - 4-line document Title |
| Line 136: | Line 132: |
|
1. '''Classification''' - Revision classification sub-sub-block 1. '''Properties''' - Revision Data sub-sub-block. Only displayed if data fields are defined 1. '''Revision Files''' - Revision file list sub-sub-block, table with following columns, button +File |
1. '''Classification''' - Revision classification sub-sub-block. Optional 1. '''Properties''' - Revision Data sub-sub-block. Optional 1. '''Revision Files''' - Revision file list sub-sub-block, table with following columns, button '''+File''' |
| Line 144: | Line 140: |
|
1. '''Notes''' sub-header 1. '''Notes''' sub-sub-block with button '''+Note/File''' 1. '''{initials} {datetimeStamp} {startOfNoteText}''' - Revision notes sub-sub-sub-block |
1. '''Notes''' - Sub-header 1. '''Notes''' - Sub-sub-block with button '''+Note/File''' 1. '''{initials} {datetimeStamp} {startOfNoteText}''' - Revision notes sub-sub-sub-block |
| Line 168: | Line 164: |
| 1. '''Identification {Title}''' - Task Identification block. | 1. '''Identification {startOfTitle}''' - Task Identification block. |
| Line 173: | Line 169: |
| * '''Date''' - Date/time stamp | * '''Date''' |
| Line 176: | Line 172: |
| 1. '''Folder {{lowestLevelFolderPath}''' - Folder block | 1. '''Folder {lowestLevelOfFolderPath}''' - Folder block |
| Line 178: | Line 174: |
|
1. '''Classification''' - Task classification block 1. '''Properties''' - Task data block. Only displayed if data fields are defined |
1. '''Classification''' - Task classification block. Optional 1. '''Properties''' - Task data block. Optional |
| Line 181: | Line 177: |
| 1. '''Notes''' block with button '''+Note/File''', followed by zero or more of the following: | 1. '''Notes''' - Notes container block with button '''+Note/File''' |
| Line 183: | Line 179: |
|
1. '''{noteText}''' 1. '''Attached Files''' - Block with button '''+File'''. Attachment file list block, a table with following columns: * '''Type''' - File type * '''Issuer''' - Who uploaded * '''Date''' - Date/time stamp * '''Description''' * '''Filename''' |
1. '''{noteText}''' - Display ''free floating'' (e.g. not in its own block) 1. '''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''' |
| Line 196: | Line 192: |
| Line 198: | Line 194: |
| 1. '''Identification {status} - {title}''' - Identification block | 1. '''Identification {status} - {startOfTitle}''' - Identification block |
| Line 202: | Line 198: |
|
* '''Status {dateAndTime}''' - ''pending'', ''scheduled'', ''sent'', ''error''. Date and time suppressed if status is ''pending'' * Classification fields assigned to identification block |
* '''Status {dateAndTime}''' - ''pending'', ''scheduled'', ''sent'', ''error''. The display of the date and time suppressed if the status is ''pending'' * Classification fields assigned to identification block. Optional |
| Line 206: | Line 202: |
|
1. '''Classification''' - Classification block ''if defined'' * Classification fields assigned to Classification Block 1. '''Properties''' - Properties block ''if defined'' * Classification fields assigned to Properties block |
1. '''Classification''' - Classification block. Optional 1. '''Properties''' - Data block. Optional |
| Line 211: | Line 205: |
| 1. '''Message''' - Block. Header text present or not? | 1. '''Message''' - Block. '''''Issue:''''' Header text present or not? |
| Line 215: | Line 209: |
| * '''To''' | * '''To''' |
| Line 223: | Line 217: |
| 1. '''Attachments''' - sub-block. Contains a table (no column headers) with the following columns (displayed as two rows): | 1. '''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): |
| Line 234: | Line 228: |
|
1. '''Identification''' {firstName lastName} * '''Type''' - Team Member Type |
1. '''Identification''' {firstName lastName} * '''Type''' - Team Member Type |
| Line 239: | Line 233: |
| * '''Company''' - '''''Issue:''''' New field. Not required | |
| Line 240: | Line 235: |
|
* '''Secondary Email''' - if this is considered required, otherwise as classification field located in Properties * '''Company''' - as informational text * Classification fields assigned to identification block 1. '''Project Organisation {lowestLevelOrgansiationalBreakdown}''' - Organisation block * '''Project Position''' - displayed same as Folder is displayed in other Objects 1. '''Classification''' - Classification block ''if defined'' * Classification fields assigned to Classification Block 1. '''Properties''' - Properties block ''if defined'' * Classification fields assigned to Properties block, e.g. contact info |
* '''Secondary Emails''' - Can contain multiple entries, display in vertical list * Classification fields assigned to identification block. Optional 1. '''Project Organisation {lowestLevelOrgansiationalBreakdown}''' - Organisation block * '''Project Position''' - displayed same as Folder is displayed in other Objects 1. '''Classification''' - Classification block. Optional 1. '''Properties''' - Data block. Optional. E.g. contact info 1. '''Access Privileges''' - Sub-header |
| Line 250: | Line 243: |
| * '''Login''' / enabled Y/N |
* '''Internal/External''' - '''''Issue:''''' Convert to radio button. Need to define header and names for the off/off values. * '''Login Enabled''' - '''''Issue:''''' Convert to radio button, with ''Yes'' and ''No'' values. |
| Line 260: | Line 254: |
|
4. Editing of Access Privileges should generally be from Project-> Project Team -> Access Privileges, in edit screen for a Team Member only allow editing of Global Privilege |
4. Editing of Access Privileges should generally be from Project-> Project Team -> Access Privileges, in edit screen for a Team Member only allow editing of Global Privilege |
| Line 263: | Line 256: |
|
6. Project Role removed from system data, replaced by Project Position, Project Role now mandatory system data similar to Folder; project role can be configured as a classification field (text description) if needed |
6. Project Role removed from system data, replaced by Project Position, Project Role now mandatory system data similar to Folder; project role can be configured as a classification field (text description) if needed |
V2 Screen Layouts
To Do
- Review button placement and titles on detail screens
- Review block headers and sub-headers (including font size)
- Review menu titles for configuration related menu items
- Review for correctness [ALL]
- Add buttons with button titles, tune button colors (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.
- Introduce different header background colors for each object (using subtle tones). One or a combination of the following:
- Apply color based on object type
- 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
Review
OPEN
OPEN
File
Done
OPEN
OPEN
OPEN
Dossier
Done
OPEN
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
- If it's difficult to come to agreement then default to showing more data and then solicit customer feedback for additional guidance
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
- Users
- Files
- Dossiers
- 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 block types are relevant to all Objects.
{Object} {Type} {Code} - Default 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 - 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)
Note that Description/Summary fields should be defining in the classification configuration
Folder Block - for all objects except Team Members
OBS Block - For Team Members only, has multiple entries, one for each project role that the team member is assigned
Responsibilities and Due Dates Block
Classification Block - Only displayed if classification values for the object are defined or if one of the fields is defined as display on detail
Properties Block - Only displayed if classification fields for the object are defined or if one of the fields is defined as display on detail
Message Block - For Transmittals
Revision Blocks - For Documents, includes Files and Note sub-blocks
Note Blocks - For Tasks
References - Sub-header
Links Block
Subscribers Block
Transmittals Block
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 {lowestLevelOfFolderPath} - Folder block
Classification - Document classification block. Optional
Properties - Document data block. Optional
Revisions - Sub-header
Revisions - Revisions Block with button +Revision
Revision {revisionNumber} {date} {startOfTitle} - Revision sub-block. Button Edit
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 - if required, define as a classification field assigned to the identification block
Responsibilities and Due Dates - Revision workflow sub-sub-block
Classification - Revision classification sub-sub-block. Optional
Properties - Revision Data sub-sub-block. Optional
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:
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)?
- 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 {startOfTitle} - Task Identification block.
Type - Task Type
Code - Task Code
Title - Task Title
Issuer
Date
- Classification fields assigned to identification block (for the given data type)
Summary - if required, define as a classification field assigned to the identification block
Folder {lowestLevelOfFolderPath} - Folder block
Responsibilities and Due Dates - Task sub-block
Classification - Task classification block. Optional
Properties - Task data block. Optional
Notes - Sub-header
Notes - Notes container block with button +Note/File
{initials} {datetimeStamp} {startOfNoteText} - Note sub-block
{noteText} - Display free floating (e.g. not in its own block)
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
References - Sub-header
Links - Links block(including dossiers?)
Subscribers - Subscribers block
Transmittals - Transmittals block
Transmittal Detail Layout
Transmittal - {type} {code} - Page title.
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 fields assigned to identification block. Optional
Folder {lowestLevelFolderPath} - Folder block
Responsibilities and Due Dates
Classification - Classification block. Optional
Properties - Data block. Optional
Message - sub-header
Message - Block. Issue: Header text present or not?
Header - sub-block
Issuer
Date - Date only, with display of time. The date is not set if status is pending
To
Initials - Last name, First name, primary email address
CC
Initials - Last name, First name, primary email address
BCC
Initials - Last name, First name, primary email address
Subject: {projectCode} Transmittal {type} {code} {title} - Read-only in edit screen
Text - sub-block
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
Project Team - {Type} - {firstName lastName} - Page title
Identification {firstName lastName}
Type - Team Member Type
First Name
Last Name
Initials
Company - Issue: New field. Not required
Primary Email
Secondary Emails - Can contain multiple entries, display in vertical list
- Classification fields assigned to identification block. Optional
Project Organisation {lowestLevelOrgansiationalBreakdown} - Organisation block
Project Position - displayed same as Folder is displayed in other Objects
Classification - Classification block. Optional
Properties - Data block. Optional. E.g. contact info
Access Privileges - Sub-header
Access Privileges - access privileges and responsibilities
Internal/External - Issue: Convert to radio button. Need to define header and names for the off/off values.
Login Enabled - Issue: 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:
- Display the User Detail page in a single column format, with blocks consistent with other object detail screens
- Quick Links block not needed, all links are already in banner menu
- Separate Email block not needed
Editing of Access Privileges should generally be from Project-> Project Team -> Access Privileges, in edit screen for a Team Member only allow editing of Global Privilege
- External flag can presumably be handled by Team Member Type (External preset as one Type)
- Project Role removed from system data, replaced by Project Position, 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
File ID={fileId}
File Properties
Issues:
- Currently the blocks titles/uses do not relate very well to the other blocks in other detail screens
Dossier Detail Layout
Identification
Items - Sub-header
Revisions - Sub-sub-header. List with the following columns
Resource - Contains: {documentRevisionCode}
Resource Type - Contains: Revision
Description - COntains {revisionTitle}
Tasks - Sub-sub-header?
todo
Users - Sub-sub-header?
todo
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
