Re: [ubl] Idea about the structure of UBL package.

[jon.bosak@sun.com]

Hello Saito-san,

I think I understand what you mean now.

In fact, I was thinking something like this when I changed the
order of some of the lists in the 1.0 document from alphabetical
order (in 1.0 Beta) to process order (in 1.0 CD).

I agree that we should rework the document structure in 1.1 to be
easier to follow.  I have entered this on the version of the
"UBL11" work-item spreadsheet that I will be posting in the next day or
so under the heading "Document organization."

Jon

   Date: Wed, 09 Jun 2004 13:33:27 +0900
   From: Yukinori Saito <saito-yukinori@fujielectric.co.jp>
   Cc: UBL TC <ubl@lists.oasis-open.org>

   Dear Jon,

   I am sorry my poor explanation about my idea.
   I inserted my comments started 'YS:'
   Best Regards.
   Yukinori Saito


   ----- Original Message -----
   From: <jon.bosak@sun.com>
   To: <saito-yukinori@fujielectric.co.jp>
   Cc: <ubl@lists.oasis-open.org>
   Sent: Wednesday, June 09, 2004 9:04 AM
   Subject: Re: [ubl] Idea about the structure of UBL package.


   Hello Saito-san,

   I'm not sure how to interpret the first part of your suggestion.
   Since it is too late to make large-scale changes to 1.0, I assume
   that these are suggestions for 1.1.

   YS: I agree.

   | (1) The package had better to be divided to several parts
   | (folders).  The divided parts are classified by functions
   | (e.g. Business Process, Business Documents, XML Schema, Examples,
   | Formatting, others) or file format (e.g. pdf, gif, jpg, xls, html,
   | sxc, xml, xsd).

   This is how the package is currently structured.  Are you saying
   that this structure is hard to use?

   YS: The order (or turn) of the files of the current UBL package is the order
   of an
   alphanumeric characters.
   For example:
   +ASN.1-UBL-1.html
   +FS-UBL-DespatchAdvice.html
   +FS-UBL-DespatchAdvice.xml
   +FS-UBL-Invoice.html
   -
   -
   +JoineryDespatchAdvice.Example-a4.pdf
   +JoineryDespatchAdvice.Example-us.pdf

   In case we see the order (or turn) of the package, we have some troubles to
   understand.
   Because, (for example)
   - The order (or turn) of the package is not aligned or grouped
   functionally.
   - Many files are mixed in the package.
   Therefore, it is hard for us (users of UBL specifications) to understand the
   structure and to select the targeted file.

   My idea of the structure of the package is follows.
   The following categories might be actualized by zip or something.

   (1) General explanation of UBL specifications
   - Instruction how to use the package of UBL specifications
   (This is a new file for guidance to users.)
   - Business Process of UBL Procurement Activity.jpg
   ('+UBL-1.0-Procurement Activity.jpg' should be renamed to this name.)
   - Development procedures using UBL libraries.jpg
   (+UBL-1.0-DevProcess.jpg)
   - Structure of UBL components.jpg
   (+UBL-1.0-ModelDependency.jpg)

   (2) Class diagrams of UBL business documents
   - Class diagram of BD1: Order.jpg
   (+UBL-1.0-OrderDocumentAssembly.jpg)
   - Class diagram of BD2: Order Response.jpg
   (+UBL-1.0-OrderResponseDocumentAssembly.jpg)
   - Class diagram of BD3: Order Response Simple.jpg
   - Class diagram of BD4: Order Change.jpg
   - Class diagram of BD5: Order Cancellation.jpg
   - Class diagram of BD6: Despatch Advice.jpg
   - Class diagram of BD7: Receipt Advice.jpg
   - Class diagram of BD8: Invoice.jpg
   - Class diagram of BD9: Reusable.jpg

   (3) Spreadsheet of UBL business documents (MS Excel)
   - Spreadsheet of BD1: Order.xsl
   (+UBL-Order-1.0.xls)
   - Spreadsheet of BD2: Order Response.xsl

   (4) Spreadsheet of UBL business documents (Open Office)
   - Spreadsheet of BD1: Order.sxc
   (+UBL-Order-1.0.sxc)
   - Spreadsheet of BD2: Order Response.sxc

   (5) XML Schema of UBL business documents
   - XML Schema of BD1: Order.xsd
   (+UBL-Order-1.0.xsd)
   - XML Schema of BD2: Order Response.xsd

   (6) Code List of UBL business documents

   (7) Core Components of UBL business documents

   (8) Formatting specifications of UBL business documents

   (9) Example 1 (Office Order)
   - +OfficeOrder.Example-a4.pdf
   - +OfficeOrderResponseSimple.Example-a4.pdf
   - +UBL-Order-1.0-Office-Example.xml
   -

   (10) Example 2 (Joinnery Order)



   | (2) The order of files had better to be aligned. And all different files
   | (e.g. Business Documents, XML Schema, Examples, Others) would be aligned
   to
   | this order.
   | (for example)
   | BD1: Order
   | BD2: Order Response
   | BD3: Order Response Simple
   | BD4: Order Change
   | BD5: Order Cancellation
   | BD6: Despatch Advice
   | BD7: Receipt Advice
   | BD8: Invoice
   | BD9: Reusable

   I think you are suggesting that all the files (regardless of type
   or purpose) relating to Order should be put in an Order folder,
   all the ones relating to Order Response should be put in an Order
   Response folder, and so on.  Is this correct?

   YS: No.
   My idea is only that the order (or turn) of business documents is order of
   something.
   The order of business documents described above example is a kind of order
   of UBL purchasing business process.
   Usually, the order of files in a package (e.g. zip) is an order of
   alphanumeric characters. Therefore I named numbering to the business
   documents. (e.g. BD1, BD2, --)


   If so, what would you do with the files (such as the conceptual
   packages) that cannot be related to document types?

   YS: My idea is described at my comments described above.
   The conceptual packages will be inserted at '(1) General explanation of UBL
   specifications
   ', or it might be better to add the category such as 'Conceptual packages'.


   Jon