Differences between revisions 3 and 4
Deletions are marked like this. Additions are marked like this.
Line 12: Line 12:
The proposals listed here are for discuss and the details may change during the implementation.
Line 14: Line 17:
 1. '''''Planning document''''' - A document defined in the Excel Integration planning spreadsheet
Line 15: Line 19:
 1. '''''Planning document''''' - A document defined in the Excel Integration planning spreadsheet
Line 17: Line 20:
 1. '''''Target document''''' - A document linked to a planning document. This includes the ''Grundlagen'' and review document listed above  1. '''''Target document''''' - A document linked to a planning document. E.g. the ''Grundlagen'' and review documents listed above
Line 24: Line 27:
   1. Create additional links, the link types will be restricted by the column in which the link appears. See the following sections
   1. Display multiple links. Multiple links will be displayed in cell comments 		   1. Create links to target documents, the link types will be restricted by the column in which the link appears. See the following sections
   1. Display multiple links (for ''Grundlagen'' documents only). Multiple links will be displayed in cell comments
Line 34: Line 37:
 1. Links are ''document-to-document'', and link the latest revision of the planning document to the latest revision of the linked document
 1. The linked documents are identified by their ''Document Code'' (excluding the revision code) 		 1. Links are ''document-to-document'', and link the latest revision of the planning document to the latest revision of the target document
 1. Target documents are identified by their ''Document Codes'' (excluding the revision code)
Line 39: Line 42:
 1. Link entry requires entering the entire document code
 1. Multiple links are allowed. Adding another document will add an additional link
 1. No checking of the target document is made beyond checking that a document exists with the given document code 		 1. Link entry requires entering document code of the target document
 1. Multiple links are allowed. Adding another target document will add an additional link
 1. No checking of the target document is made except to check that it exists
Line 47: Line 50:
 1. The linked documents are identified by their ''Serial Codes''  1. Target documents are identified by their ''Serial Codes''
Line 52: Line 55:
 1. Link creation/update requires the user to enter the entire serial code of the target document
 1. No checking of the target document is made beyond checking that a document exists with the given serial code.
 1. Only one linked document can be created. If the serial code is changed and the link is saved, then the linked document will be replaced by the new code. ('''''Is this OK?''''')
 1. The serial code must be of the correct type for the column. E.g. the ''Stellungnahme'' column will only accept ''Stellungnahme'' serial codes. If the serial code is an incorrect type, then the link cannot be saved an error will occur. The row will be highlighted and cell comment with the error will be created 		 1. Link creation/update requires the user to enter the serial code of the target document
 1. No checking of the target document is made except to check that it exists
 1. Only one target document link for a review document can be created. If the serial code is changed and the link is saved, then the old target document link will be replaced by the new one ('''''Is this OK? See assumptions below''''')
 1. The serial code must be of the correct type for the spreadsheet column. E.g. the ''Stellungnahme'' column will only accept ''Stellungnahme'' serial codes. If the serial code is an incorrect type, then the link cannot be saved an error will occur
Line 57: Line 60:
'''Issues: for review/discussion'''
Line 59: Line 61:
  1. I am assuming that it is possible for ''Stellungnahmen'', ''Prüfberichte'' and ''Q-Eklärungen'' to be in a different ''Bereich'' than the planning document. This means that the ''Bereich'' of the linked document must be entered, and consequently the entire serial code. '''Assumptions:''' (for review/discussion)

 1. Only one link for a review document is possible
  1. It is possible for ''Stellungnahmen'', ''Prüfberichte'' and ''Q-Eklärungen'' to be in a different ''Bereich'' than the planning document to which it refers
Line 63: Line 68:
Will probably be implemented using a pop-up window DIsplay and entry of document links will probably be implemented using a pop-up window.
Line 65: Line 70:
Performance issues: Performance issues for display of linked documents: Choices:
Line 67: Line 72:
 1. Displaying link information when ready from the server will be slow -- avoid doing this
 1. Or update server document read to include XML containing document codes to linked documents?
    1. Documents: list of ''Grundlagen'' documents
    1. Revisions: list of review documents (and their serial codes) 		 1. Displaying link information when reading documents from the server will be slow -- Try avoid doing this
 
 1. Update server's ''document read'' transaction to include XML containing document and serial codes of all target documents (possibly containing a field filter based on the link type)
    * ''Document read'' transaction: include a list document codes of linked ''Grundlagen'' documents
    * ''Revision read'' transaction: include a list serial codes of linked review documents
Line 72: Line 78:
Possible features: Possible user interface:
Line 74: Line 80:
 1. Clicking on a link column will cause a pop-up window to appear
    1. Get/display link info
    1. Update link
 1. Multi-field entry of
    1. ''Serial Codes''
    1. ''Document Codes'' for ''Grundlagen'' document -- '''''this is harder''''' 		 1. Clicking on a link column will cause a pop-up window to appear.
 1. The behavior of the pop-up window will change based on whether the column is for a ''Grundlagen'' document link or a review document link.
Line 81: Line 83:
'''''to be completed''''' Popup buttons:

 1. '''Display link info:'''
    * ''Grundlagen'' documents - If there is only one target document, put document code in the cell, otherwise create a cell-comment containing all the document codes of the target documents
    * Review documents - Put the serial code of the target document in the cell. '''Question:''' How to handle display of multiple links (entered via the web interface)? Probably using cell comments.

 1. '''Update link:''' Has a field for entering a document or serial code
    * ''Grundlagen'' documents - Create a new link from the document code
    * Review documents - Replace the existing link with the serial code
    

Excel Integration - Document Links

Introduction

This section describes a proposal for the Excel Integration user interface for handling links between planning documents and their background and review documents. This includes links to the following types of documents:

  1. Technical and contractual Grundlagen documents

  2. Stellungnahmen, Prüfberichte and Q-Eklärungen documents

The proposals listed here are for discuss and the details may change during the implementation.

Definitions

  1. Planning document - A document defined in the Excel Integration planning spreadsheet

  2. Grundlagen document - A technical or contractual Grundlagen document

  3. Review document - A Stellungnahmen, Prüfberichte or Q-Eklärungen document

  4. Target document - A document linked to a planning document. E.g. the Grundlagen and review documents listed above

Limitations of Excel Spreadsheet

Features that are different between the Excel and Web interface.

  1. Possible:

    1. Create links to target documents, the link types will be restricted by the column in which the link appears. See the following sections

    2. Display multiple links (for Grundlagen documents only). Multiple links will be displayed in cell comments

  2. Not possible:

    1. Create or display link notes

    2. Delete document links to Grundladen documents

    3. Delete document links to review documents. Changing a serial code will cause the existing link to be replaced. See below

Links to Grundlagen Documents

  1. Links are document-to-document, and link the latest revision of the planning document to the latest revision of the target document

  2. Target documents are identified by their Document Codes (excluding the revision code)

  3. Link types depend on the spreadsheet column:

    • TGL - technische Grundlagen

    • VGL - vertragliche Grundlagen

  4. Link entry requires entering document code of the target document
  5. Multiple links are allowed. Adding another target document will add an additional link
  6. No checking of the target document is made except to check that it exists

Links to Review Documents

  1. Links are revision-to-document, and link the specific revision of the planning document to the latest revision of the target document

  2. Target documents are identified by their Serial Codes

  3. Link types depend on the spreadsheet column:

    • STN - Stellungnahme

    • PRB - Prüfbericht

    • QEK - Q-Erklärung

  4. Link creation/update requires the user to enter the serial code of the target document
  5. No checking of the target document is made except to check that it exists

  6. Only one target document link for a review document can be created. If the serial code is changed and the link is saved, then the old target document link will be replaced by the new one (Is this OK? See assumptions below)

  7. The serial code must be of the correct type for the spreadsheet column. E.g. the Stellungnahme column will only accept Stellungnahme serial codes. If the serial code is an incorrect type, then the link cannot be saved an error will occur

Assumptions: (for review/discussion)

  1. Only one link for a review document is possible

  2. It is possible for Stellungnahmen, Prüfberichte and Q-Eklärungen to be in a different Bereich than the planning document to which it refers

Excel User Interface

DIsplay and entry of document links will probably be implemented using a pop-up window.

Performance issues for display of linked documents: Choices:

  1. Displaying link information when reading documents from the server will be slow -- Try avoid doing this

  2. Update server's document read transaction to include XML containing document and serial codes of all target documents (possibly containing a field filter based on the link type)

    • Document read transaction: include a list document codes of linked Grundlagen documents

    • Revision read transaction: include a list serial codes of linked review documents

Possible user interface:

  1. Clicking on a link column will cause a pop-up window to appear.

  2. The behavior of the pop-up window will change based on whether the column is for a Grundlagen document link or a review document link.

Popup buttons:

  1. Display link info:

    • Grundlagen documents - If there is only one target document, put document code in the cell, otherwise create a cell-comment containing all the document codes of the target documents

    • Review documents - Put the serial code of the target document in the cell. Question: How to handle display of multiple links (entered via the web interface)? Probably using cell comments.

  2. Update link: Has a field for entering a document or serial code

    • Grundlagen documents - Create a new link from the document code

    • Review documents - Replace the existing link with the serial code

ExcelIntegrationDocumentLinks (last edited 2011-07-29 11:30:30 by vali)

Copyright 2008-2014, SoftXS GmbH, Switzerland