Differences between revisions 75 and 76
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''
    * Classifica
tion fields assigned to Classification Block
 1. '''Properties''' - Properties block ''if defined''
    * Classifica
tion 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

V2Master | V2HighLevelDesign

To Do

  1. Review button placement and titles on detail screens
  2. Review block headers and sub-headers (including font size)
  3. Review menu titles for configuration related menu items
  4. Review for correctness [ALL]
  5. Add buttons with button titles, tune button colors (should be less glaring)
  6. Check widths of selects, to be consistent across screens
  7. Check links for consistent actions
  8. We plan to go to a single edit screen, instead of separate edit screens for the object data and classification.
  9. 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

    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

  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 - 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

  3. Folder Block - for all objects except Team Members

  4. OBS Block - For Team Members only, has multiple entries, one for each project role that the team member is assigned

  5. Responsibilities and Due Dates Block

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

  7. Properties Block - Only displayed if classification fields for the object 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

  13. Subscribers Block

  14. Transmittals Block

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

    • Identification fields

  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. Button Edit

      1. 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

      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

      6. Notes - Sub-header

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

        1. {initials} {datetimeStamp} {startOfNoteText} - Revision notes sub-sub-sub-block

          1. {noteText}

          2. 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

  8. References - Sub-header

  9. Links - Links block(including dossiers?)

  10. Subscribers - Subscribers block

  11. Transmittals - Transmittals block

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

    • Classification fields assigned to identification block (for the given data type)
      • Summary - if required, define as a classification field assigned to the identification block

  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

    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(including dossiers?)

  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 fields assigned to identification block. Optional
  3. Folder {lowestLevelFolderPath} - Folder block

  4. Responsibilities and Due Dates

  5. Classification - Classification block. Optional

  6. Properties - Data block. Optional

  7. Message - sub-header

  8. Message - Block. Issue: Header text present or not?

    1. 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

    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 - Issue: New field. Not required

    • Primary Email

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

    • Classification fields assigned to identification block. Optional
  3. Project Organisation {lowestLevelOrgansiationalBreakdown} - Organisation block

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

  4. Classification - Classification block. Optional

  5. Properties - Data block. Optional. E.g. contact info

  6. Access Privileges - Sub-header

  7. 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:

  1. Display the User Detail page in a single column format, with blocks consistent with other object detail screens
  2. Quick Links block not needed, all links are already in banner menu
  3. Separate Email block not needed
  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

  5. External flag can presumably be handled by Team Member Type (External preset as one Type)
  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

File Detail Layout

  1. File ID={fileId}

  2. File Properties

Issues:

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

Dossier Detail Layout

  1. Identification

  2. Items - Sub-header

  3. Revisions - Sub-sub-header. List with the following columns

    • Resource - Contains: {documentRevisionCode}

    • Resource Type - Contains: Revision

    • Description - COntains {revisionTitle}

  4. Tasks - Sub-sub-header?

    • todo

  5. 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

Dossier List Layout

V2ScreenLayouts (last edited 2014-01-27 12:20:36 by gw)

Copyright 2008-2014, SoftXS GmbH, Switzerland