Differences between revisions 2 and 3
Deletions are marked like this. Additions are marked like this.
Line 7: Line 7:
This section describes a proposal for the Excel Integration user interface for handling links between the planning documents and their related documents. This includes links to the following types of documents: 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:
Line 14: Line 14:
 1. '''''Grundlagen document''''' - A technical or contractual ''Grundlagen'' document
Line 15: Line 16:
 1. '''''Linked Document''''' - A documents linked to a planning document. It includes the documents types listed above  1. '''''Review document''''' - A ''Stellungnahmen'', ''Prüfberichte'' or ''Q-Eklärungen'' document
 1. '''''Target document''''' - A document linked to a planning document. This includes the ''Grundlagen'' and review document listed above

= Limitations of Excel Spreadsheet =

Features that are different between the Excel and Web interface.

 1. '''Possible:'''
   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. '''Not possible:'''
   1. Create or display link notes
   1. Delete document links to ''Grundladen'' documents
   1. Delete document links to review documents. Changing a serial code will cause the existing link to be replaced. See below
Line 19: Line 34:
 1. Links are from the latest revision of the planning document to the latest revision of the ''Grundlagen'' documents  1. Links are ''document-to-document'', and link the latest revision of the planning document to the latest revision of the linked document
Line 21: Line 36:
 1. Link types:  1. Link types depend on the spreadsheet column:
Line 24: Line 39:

'''Questions:'''

 * Notes
 * Deleting links
 * Multiple links 		 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
Line 32: Line 44:
= Links to Stellungnahmen, Prüfberichte and Q-Eklärungen Documents = = Links to Review Documents =
Line 34: Line 46:
 1. Links are from the specific revision of the planning document to the latest revision of the linked document
 1. The linked documents are identified by their ''Serial Code''
 1. Link types: 		 1. Links are ''revision-to-document'', and link the specific revision of the planning document to the latest revision of the target document
 1. The linked documents are identified by their ''Serial Codes''
 1. Link types depend on the spreadsheet column:
Line 40: Line 52:
 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
Line 41: Line 57:
'''Questions:''' '''Issues: for review/discussion'''
Line 43: Line 59:
  1. Is it possible for ''Stellungnahmen'', ''Prüfberichte'' and ''Q-Eklärungen'' to be in a different ''Bereich'' than the planning document. I am assuming that the answer is yes, which means that the ''Bereich'' of the linked document must be entered, which means, to avoid user confusion, the user should enter the complete serial code for the linked document.   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.

= Excel User Interface =

Will probably be implemented using a pop-up window

Performance issues:

 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)

Possible features:

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

'''''to be completed'''''

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

Definitions

  1. Grundlagen document - A technical or contractual Grundlagen document

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

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

  4. Target document - A document linked to a planning document. This includes the Grundlagen and review document listed above

Limitations of Excel Spreadsheet

Features that are different between the Excel and Web interface.

  1. Possible:

    1. Create additional links, the link types will be restricted by the column in which the link appears. See the following sections
    2. Display multiple links. 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 linked document

  2. The linked documents are identified by their Document Code (excluding the revision code)

  3. Link types depend on the spreadsheet column:

    • TGL - technische Grundlagen

    • VGL - vertragliche Grundlagen

  4. Link entry requires entering the entire document code
  5. Multiple links are allowed. Adding another document will add an additional link
  6. No checking of the target document is made beyond checking that a document exists with the given document code

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. The linked 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 entire serial code of the target document
  5. No checking of the target document is made beyond checking that a document exists with the given serial code.

  6. 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?)

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

Issues: for review/discussion

  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.

Excel User Interface

Will probably be implemented using a pop-up window

Performance issues:

  1. Displaying link information when ready from the server will be slow -- avoid doing this
  2. Or update server document read to include XML containing document codes to linked documents?

    1. Documents: list of Grundlagen documents

    2. Revisions: list of review documents (and their serial codes)

Possible features:

  1. Clicking on a link column will cause a pop-up window to appear
    1. Get/display link info
    2. Update link
  2. Multi-field entry of

    1. Serial Codes

    2. Document Codes for Grundlagen document -- this is harder

to be completed

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

Copyright 2008-2014, SoftXS GmbH, Switzerland