[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [List Home]
Subject: code list categorization for 2.0
Hi, Following up on my AI ... Below, in Category 1a, #s 1-8, and Category 2, #s 1-5, are the 13 Code Lists UBL provided values for in 1.0. The categories are based on Tony's paper from http://lists.oasis-open.org/archives/ubl/200508/msg00043.html and subsequent F2F discussion. I've separated Category 1 into 'a' and 'b', reasons below. Category 1a ----------- Codes that are created and owned by UBL or unlikely to change between UBL major releases. 1. UBL-CodeList-AcknowledgementResponseCode-1.0.xsd Values: OrderResponseComplex, OrderResponseSimple 2. UBL-CodeList-DocumentStatusCode-1.0.xsd Values: Cancelled, Disputed, NoStatus, Revised Notes: UNECE also defines a 'Document Status Code'. See http://www.unece.org/trade/untdid/d03a/tred/tred1373.htm. We did not use these values because they did not fit our use of D.S.C. Rather, UNECE 'Status Description Code' was closer to what we wanted. See http://www.unece.org/trade/untdid/d00a/tred/tred4405.htm. Our 'Document Status Code' overlaps, not duplicates, tred 4405. 3. UBL-CodeList-LineStatusCode-1.0.xsd Values: Added, Cancelled, Disputed, NoStatus, Revised Notes: Same as DocumentStatusCode, but with additional value: 'Added'. 4. UBL-CodeList-LatitudeDirectionCode-1.0.xsd Values: North, South Notes: See LongitudeDirectionCode. 5. UBL-CodeList-LongitudeDirectionCode-1.0.xsd Values: East, West Notes: UNECE defines Latitude Degree (http://www.unece.org/trade/untdid/d03a/tred/tred6000.htm) and Longitude Degree (http://www.unece.org/trade/untdid/d03a/tred/tred6002.htm) as part of 'Additional Location Information' (http://www.unece.org/trade/untdid/d03a/tisd/tisdals.htm) and 'Geographic Details' (http://www.unece.org/trade/untdid/d03a/ticd/ticde008.htm). However, none of these specify North/South/East/West, presumably derived by context. North/Souht/East/West, however, is all we needed. 6. UBL-CodeList-OperatorCode-1.0.xsd Values: Divide, Multiply 7. UBL-CodeList-SubstitutionStatusCode-1.0.xsd Values: Original, Substitution 8. UBL-CodeList-ChipCode-1.0.xsd Values: Chip, MagneticStripe Notes: This came from Mike Adcock, I believe and we didn't have a standard code identified for it. I think it's one for which we should be using a standard code, though, and move it to Category 2, as I see additional values that identified with these two values when searching through codes, and this just seems quite far afield for something for UBL to maintain. We'd have to find the right standard code, though. Category 1b ----------- Codes that are owned/provided by ATG2. These are the only ones I see from most recent schema delivery: - Currency - Language - MIMEMediaType - Unit If I've missed something we'll need to re-evaluate, but ... The only one of these we use is Currency, but we had discussed this as a category 2. It's not clear to me that any of these should go into category 1, as I believe they are codes that are outside of UBL purview and can change without UBL agreement, and may very well change in between UBL releases. I think these should all be put as Category 2. From David Krupke: Due to using the ATG2-UnqualifiedDatatype schema module there is a change concerning the currency code list. ATG2 has a predefined code list for currency codes. We assumed that the UBL CurrencyCodeType and UBLAmountType should also use this predefined code list. In order to do this we had to change the values for code list agency and code list name. As a result CurrencyCodeType is now located in the SpecializedDataType schema, because it does not have an own simpletype for the content. I think this would be a good chance to do this in general, to store all specialized data types in the SpecializedDataType schema including the code lists. This would be the same behavier like ATG2. Another item is to get rid off UBLAmountType. It is now redundant. Anne: I was under the impression that these 'common' .xsd files would be coming from ATG2 (CCT, CCP, UDT and possibly SDT depending on what we needed). But the diffs I see are: - the new CBC now has our UBL-defined codes - SDT has CurrencyCode and AmountType; it used to only have AmountType - Unspecialized DataTypes is now Unqualified DataTypes - besides code lists there are several new files in the 'common' directory - there is no CCT - CCP is the same I think it would be helpful at this point to have a mapping from UBL 1.0 common files to UBL 2.0 common files so we - know where the line is drawn between ubl files and atg2 files, - can align names of the remaining files, - can understand what if anything should be kept in the ndrs in reference to any of the resulting files in 'common' Regarding 'AmountType', I'm not sure why it was created, so Tim should take a look and comment on that move. Separately, regarding schemas, David is suggesting we put all code lists in SDT. Category 2 ---------- Codes that are created and maintained external to UBL, some likelihood of changes between UBL releases. UBL has no control over whether or when they change. 1. UBL-CodeList-AllowanceChargeReasonCode-1.0.xsd (UN/ECE 4465) Values: See http://www.unece.org/trade/untdid/d03a/tred/tred4465.htm. Notes: Appears to be exact duplicate of UNECE 4465 code, 'Adjustment reason description code'. We call it 'AllowanceChargeReasonCode' though. What is the impact of changing the name of the code to match 4465? 2. UBL-CodeList-ChannelCode-1.0.xsd (UN/ECE 3155) Values: See http://www.unece.org/trade/untdid/d03a/tred/tred3155.htm. Notes: Appears to be exact duplicate of the UNECE 3155 code, 'Communication address code qualifier'. We call it 'ChannelCode, though. What is the impact of changing the name of the code to match 3155? 3. UBL-CodeList-CountryIdentificationCode-1.0.xsd Values: See www.iso.org/iso/en/prods-services/iso3166ma/02iso-3166-code-lists/list-en1.html Notes: We only use the first part of iso 3166 (3166-1). iso 3166-2 has the country subentities but we didn't implement that. 4. UBL-CodeList-CurrencyCode-1.0.xsd Values: See http://www.bsi-global.com/British_Standards/currency/index.xalter. Notes: In the latest schemas from David, this is now in the SDT. See note under ATG2 codes (category 1a). Further discussion is probably needed on these. 5. UBL-CodeList-PaymentMeansCode-1.0.xsd Values: See http://www.unece.org/trade/untdid/d03a/tred/tred4461.htm Notes: Exact duplicate of UNECE 4461 'Payment Means Code'. Further considerations: - This breakdown doesn't take into account that some of the category 2 codes will be coming from gefeg. Don't know if we need to make that distinction. - In looking at this again, going back to the original lists of codes we have in our models, these were only the beginning - the codes we though we had to define in order to achieve a positive out-of-the-box experience. - The attached spreadsheet has a complete list of codes as they were in 1.0 Beta. I'm not sure if we should, before 2.0, look at these again and if we don't add any more codes to the UBL codes, possibly give some guidance on how to use the codes for which we don't point to un codes or give values. - We seem to be going back to a twist on the original model we had where we provided xml files with the code values (placebo, etc). This is in some ways comforting, in others disconcerting. I can't recall the issues raised in that implementation that caused us to pull it, but I believe the schema template will solve that problem.