OASIS Mailing List ArchivesView the OASIS mailing list archive below
or browse/search using MarkMail.

 


Help: OASIS Mailing Lists Help | MarkMail Help

ubl-lcsc message

[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [List Home]


Subject: Finalizing of Common Core Component Documentation


Title: Finalizing of Common Core Component Documentation

Hello Common Core Components volunteers,

I attached the current documentation and the xsd-files of the common core components. Both should be finalized until our next face-to-face meeting in London (28.4 - 2.5.2003). It would be very glad, if you can help me to solve this effort.

I filled out the description and structure for a number of components. But the content of another components still missing. I need the help for the description of this components. That will be:

        --> Core Component Types:
                - RateType
        --> Data Types of Secondary Representation Terms:
                - DateType
                - DayType
                - DurationType
                - FactorType
                - FloatType
                - IntType
                - MonthType
                - MonthDayType
                - NameType
                - PercentType
                - PosIntType
                - TimeType
                - ValueType
                - YearType
                - YearMonthType
        --> Comon Aggregation Core Components
                - PeriodDetails (partially finished)
                - RecurrenceDetails (partially finished)

The colleagues, which said they would voluntary work on this document are:
        - Lisa Seaburg 
        - Mavis Cournane
        - Joerg Walther (DIN)
        - Sue Probert
        - Mike Adcock
        - Kris Ketels
        - Regenald Kramer
        - Garret Minakawa
        - Gunther Stuhec
        - Mark Crawford
        - Jim Wilson

If this true, than can every volunteer pick out maximally two types, which she or he would like to describe. Please let me know soon, which type you would like to describe. Or do you know, who can help us to describe on or more types?

The description based always on the same document structure with the following sections:

- Dictionary Entry Name - This is the unique official name of Core Component Type (CCT), Data Type (DT) or Common Aggregate Core Component (CACC). It must be based on the conventions of the ebXML CCTS V1.9.

- Defintion -  This is the unique semantic meaning of a CCT, DT or CACC. It must be structured as described in the ebXML CCTS V 1.9. It should be not longer as two sentences and it should be included all terms and qualifiers of the dictionary entry name.

- Use - Information about the possibilities of usage of CCT, DT or CACC.

- Structure - The table in the section "structure" provides the structure of CCT, DT or ACCs. The first line after header includes the CCT, DT or ACC itself and the representation characteristics of the content component. The second and further lines are for the supplementary components, which are represented as attributes and the representation characteristics of these attributes or the BCCs and/or ASCCs of the specific ACC:

The table exists of the following columns.
For CCTs:
        - CCT - with the xsd based type name, including the truncation rules of the name
        - Attribute - the supplementary components, with the correct attribute names, including the truncation rules of the name

        - Object Class - The logical data grouping (in a logical data model) to which a data element belongs
        - Property Term - A semantically meaningful name for the characteristic of the Object Class that is represented by the Core Component Property.

        - Representation Term - The type of valid values of CCTs (primary representation terms)
        - Base Type - the based type or "XSD built in data type (xsd:..type)" of the content component or supplementary component

        - Length - min length, max length or fix length. The convention is:
                1..n (min length = 1 character, max length = unbounded)
                5..15 (min length = 5, max length = 15 characters)
                ..20 (no min length required and max length = 20 characters)
                23 (fix length of 23 characters)
                12.9 (fix decimal representation, 12 digits before decimal point and 9 digits after decimal point)
        - Cardinality - minimal or maximal occurences of each suplementary components. The convention is:
                1 (mandatory, the supplementary component must be occur exactly one time)
                0..1 (optional, the supplementary component could be occur one time, maximally)
                0..n (optional, the supplementary component could be occur infinitely)
                1..5 (mandatory, the supplementary component could be occure at least one time and maximally 5 times)
        - Remarks - additional remarks about the representation of the CCT or suplementary component

For DTs:
        - RT (for representation term) - with the xsd based type name, including the truncation rules of the name
        - Attribute - the supplementary components, with the correct attribute names, including the truncation rules of the name

        - Qualifier Term - A semantically meaningful name for the characteristic of the Data Type.
        - Representation Term - The primary representation term (same as the CCTs), which the specific DT based on it.
        - Base Type - the based type or "XSD built in data type (xsd:..type)" of the content component or supplementary component

        - Length - min length, max length or fix length. The convention is:
                1..n (min length = 1 character, max length = unbounded)
                5..15 (min length = 5, max length = 15 characters)
                ..20 (no min length required and max length = 20 characters)
                23 (fix length of 23 characters)
                12.9 (fix decimal representation, 12 digits before decimal point and 9 digits after decimal point)
        - Cardinality - minimal or maximal occurences of each suplementary components. The convention is:
                1 (mandatory, the supplementary component must be occur exactly one time)
                0..1 (optional, the supplementary component could be occur one time, maximally)
                0..n (optional, the supplementary component could be occur infinitely)
                1..5 (mandatory, the supplementary component could be occure at least one time and maximally 5 times)
        - Remarks - additional remarks about the representation of the CCT or suplementary component

- Details and Value Ranges - Detailed description of the representation characteristics of content components or supplementary components. It gives detailed information about the representation and usability of values.

- Example (Instance) - Small XML instance as an example of each CCT
- XML Schema - The equivalent XML schema of each CCT

If you have further questions or comments to the types or structure, don't hestitate to ask me or send Mavis Cournane or me this comments.

The UBL TC would be appreciated, if you can help me to finalize this documentation.

Garret, is it possible that you fit the xsd-schemas of the common core components, please?

Thank you very much, to all.

Kind regards,

        Gunther
               



[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [List Home]