Quality assurance on use of Oxford English (and finding other problems)

["G. Ken Holman" <gkholman@CraneSoftwrights.com>]

Hi, everyone,

In my latest test a number of obvious spelling errors were 
serendipitously discovered.  I thought of a way to check for this and 
I have attached my results.

I went through the PRD2 definitions and dictionary entry names, 
distilling the definitions and splitting up any camel case words in 
those definitions (assuming they make reference to element names).  I 
then opened that file in OpenOffice as a OpenOffice text file, 
changed the language to "English(UK)" for the entire file, and saved 
the file again.  That is what is attached.

When you open the attachment in OpenOffice, all of the BIEs are 
listed with their spreadsheet row number in their respective model 
spreadsheet.  All the misspelled words are highlighted.  Jumping to 
each one using spell-check (F7) reveals a number of a number of 
interesting anomalies that need to be fixed:

- incorrectly formatted property terms, for example:
   Request for Quotation
   16 Request For Quotation RequestedValidity Period Period
   An association to Validity Period (the requested validity
   period for the quote).
- incorrectly formatted class names (and a typo as well), for example:
   UBL Common Library 2.1
   2217 WebSiteAccess Details
   Information about how to access the suppliere website.
- a missing apostrophe (which should be fixed with a single quote
  to be ASCII) from the definition, for example in the very first definition:
    UBL Application Response 2.1
    2 Application Response Details
    A document to indicate the application s response to a transaction.
    This may be a business response and/or a technical response, sent
    automatically by an application or initiated by a user.

I have updated the model checker to look for things like camel case 
in the dictionary entry name, which should catch a number of the 
problems.  But that won't catch the simple typos.  The new PRD2 model 
checker report now includes:

Bad dictionary entry names: 9
"Consumption Point. WebSiteAccess": Consumption Point. Web Site Access
"Inventory Report. InventoryReporting_ Party. Party": Inventory 
Report. Inventory Reporting_ Party. Party
"Item Instance. BestBefore Date. Date": Item Instance. Best Before Date. Date
"Request For Quotation. RequestedValidity_ Period. Period": Request 
For Quotation. Requested Validity_ Period. Period
"Stock Availability Report. InventoryReporting_ Party. Party": Stock 
Availability Report. Inventory Reporting_ Party. Party
"WebSiteAccess. Details": Web Site Access. Details
"WebSiteAccess. Login. Text": Web Site Access. Login. Text
"WebSiteAccess. Password. Text": Web Site Access. Password. Text
"WebSiteAccess. URI. Identifier": Web Site Access. URI. Identifier

Possible missing quote: 90
"Allowance Charge. Accounting Cost Code. Code": The buyer s 
accounting code as applied to the Allowance Charge.
"Allowance Charge. Accounting Cost. Text": The buyer s accounting 
cost centre as applied to the Allowance Charge expressed as text.
"Application Response. Details": A document to indicate the 
application s response to a transaction. This may be a business 
response and/or a technical response, sent automatically by an 
application or initiated by a user.
"Application Response. Issue Date. Date": The date assigned by the 
sender s application on which the Application Response was created.
"Application Response. Issue Time. Time": The time assigned by the 
sender s application at which the Application Response was created.
"Awarded Notification. Issue Date. Date": The date assigned by the 
sender s application at which the Notification was created.
"Awarded Notification. Issue Time. Time": The time assigned by the 
sender s application at which the Notification was created.
"Bill Of Lading. Declared Carriage_ Value. Amount": Value, declared 
by the shipper or his agent solely for the purpose of varying the 
carrier s level of liability from that provided in the contract of 
carriage, in case of loss or damage to goods or delayed delivery.
"Bill Of Lading. Freight Forwarder_ Party. Party": The party 
combining individual smaller consignments into a single larger 
shipment (so called consolidated shipment) that is sent to a 
counterpart who mirrors the consolidator s activity by dividing the 
consolidated consignment into its original components.
"Certificate Of Origin Application. Reference. Identifier": Holds the 
unique number that identifies the Despatch Advice, typically 
according to the seller s system that generated the Despatch Advice.
"Consignment. Declared For Carriage_ Value. Amount": Value, declared 
by the shipper or his agent solely for the purpose of varying the 
carrier s level of liability from that provided in the contract of 
carriage, in case of loss or damage to goods or delayed delivery.
"Consignment. Freight Forwarder_ Party. Party": The party combining 
individual smaller consignments into a single larger shipment (so 
called consolidated shipment) that is sent to a counterpart who 
mirrors the consolidator s activity by dividing the consolidated 
consignment into its original components.
"Consignment. Gross_ Weight. Measure": Total weight (mass) of goods 
for a declaration, including packaging but excluding the carrier s equipment.
"Contracting Party. Buyer Profile_ URI. Identifier": Uniform Resource 
Identifier (URI) communication information for this party s buyer 
profile. A buyer profile is a website where the party publishes its 
procurement opportunities.
"Credit Note Line. Accounting Cost Code. Code": The buyer s 
accounting code applied to the Credit Note Line.
"Credit Note Line. Accounting Cost. Text": The buyer s accounting 
cost centre applied to the Credit Note Line, expressed as text.
"Credit Note. Accounting Cost Code. Code": The Buyer s accounting 
code applied to the Credit Note as a whole.
"Credit Note. Accounting Cost. Text": The Buyer s accounting code 
applied to the Credit Note as a whole, expressed as text.
"Customer Party. Additional_ Account Identifier. Identifier": An 
identifier for the Customer s account, assigned by a third party.
"Customer Party. Customer Assigned_ Account Identifier. Identifier": 
An identifier for the Customer s account, assigned by the Customer itself.
"Customer Party. Supplier Assigned_ Account Identifier. Identifier": 
An identifier for the Customer s account, assigned by the Supplier.
"Debit Note Line. Accounting Cost Code. Code": The buyer s accounting 
code applied to the Debit Note Line.
"Debit Note Line. Accounting Cost. Text": The buyer s accounting cost 
centre applied to the Debit Note Line, expressed as text.
"Debit Note. Accounting Cost Code. Code": The Buyer s accounting code 
applied to the Credit Note as a whole.
"Debit Note. Accounting Cost. Text": The Buyer s accounting code 
applied to the Credit Note as a whole, expressed as text.
"Document Status Request. Issue Date. Date": The date assigned by the 
sender s application on which the Status Request was created.
"Document Status Request. Issue Time. Time": The time assigned by the 
sender s application at which the Status Request was created.
"Document Status. Issue Date. Date": The date assigned by the sender 
s application on which the Status Response was created.
"Document Status. Issue Time. Time": The time assigned by the sender 
s application at which the Status Response was created.
"Forwarding Instructions. Declared Carriage_ Value. Amount": Value, 
declared by the shipper or his agent solely for the purpose of 
varying the carrier s level of liability from that provided in the 
contract of carriage, in case of loss or damage to goods or delayed delivery.
"Forwarding Instructions. Freight Forwarder_ Party. Party": The party 
combining individual smaller consignments into a single larger 
consignment (so-called consolidated consignment) that is sent to a 
counterpart who mirrors the consolidator s activity by dividing the 
consolidated consignment into its original components.
"Freight Invoice. Accounting Cost Code. Code": The Buyer s accounting 
code applied to the Freight Invoice as a whole.
"Freight Invoice. Accounting Cost. Text": The Buyer s accounting cost 
centre applied to the Freight Invoice as a whole, expressed as text.
"Goods Item. Declared For Carriage_ Value. Amount": Value declared by 
the shipper or his agent solely for the purpose of varying the 
carrier s level of liability from that provided in the contract of 
carriage in case of loss or damage to goods or delayed delivery.
"Goods Item. Gross_ Weight. Measure": Weight (mass) of goods, 
including packaging but excluding the carrier s equipment.
"Invoice Line. Accounting Cost Code. Code": The buyer s accounting 
code applied to the Invoice Line.
"Invoice Line. Accounting Cost. Text": The buyer s accounting cost 
centre applied to the Invoice Line, expressed as text.
"Invoice. Accounting Cost Code. Code": The Buyer s accounting code 
applied to the Invoice as a whole.
"Invoice. Accounting Cost. Text": The Buyer s accounting code applied 
to the Invoice as a whole, expressed as text.
"Item. Buyers_ Item Identification. Item Identification": Associates 
the item with its identification according to the buyer s system.
"Item. Manufacturers_ Item Identification. Item Identification": 
Associates the item with its identification according to the 
manufacturer s system.
"Item. Sellers_ Item Identification. Item Identification": Associates 
the item with its identification according to the seller s system.
"Line Item. Accounting Cost Code. Code": The buyer s accounting code 
applied to the Line Item.
"Line Item. Accounting Cost. Text": The buyer s accounting cost 
centre applied to the Line Item, expressed as text.
"Meter. Meter Name. Text": Statement af the meter name, so it s 
possible to identifier if it concern about a main meter or a sub meter.
"Order Change. Accounting Cost Code. Code": The Buyer s accounting 
code applied to the Order Change as a whole.
"Order Change. Accounting Cost. Text": The Buyer s accounting code 
applied to the Order Change as a whole, expressed as text.
"Order. Accounting Cost Code. Code": The Buyer s accounting code 
applied to the Order as a whole.
"Order. Accounting Cost. Text": The Buyer s accounting cost centre 
applied to the Order as a whole, expressed as text.
"Packing List. Freight Forwarder_ Party. Party": The party combining 
individual smaller shipments into a single larger consignment (so 
called consolidated consignment) that is sent to a counterpart who 
mirrors the consolidator s activity by dividing the consolidated 
consignment into its original components.
"Party Identification. Details": Information about a party s identification.
"Party Name. Details": Information about a party s name.
"Party Tax Scheme. Details": Information about a party s Tax Scheme.
"Party Tax Scheme. Exemption Reason Code. Code": A reason for a party 
s exemption from tax, expressed as a code.
"Party Tax Scheme. Exemption_ Reason. Text": A reason for a party s 
exemption from tax, expressed as text.
"Party. Logo Reference. Identifier": A party s logo.
"Party. Physical_ Location. Location": The party s physical location.
"Party. Postal_ Address. Address": The party s postal address.
"Payment Mandate. Payer_ Financial Account. Financial Account": An 
association to the payer s Financial Account.
"Payment Means. Payee_ Financial Account. Financial Account": An 
association to the payee s Financial Account.
"Payment Means. Payer_ Financial Account. Financial Account": An 
association to the payer s Financial Account.
"Person. Family_ Name. Name": A person s surname or family name.
"Person. First_ Name. Name": A person s forename or first name.
"Person. Job Title. Text": A person s job title within an 
organization (for a particular role).
"Person. Middle_ Name. Name": A person s middle name(s) and/or initial(s).
"Person. Name Suffix. Text": A suffix to a person s name, e.g., PhD, OBE, Jnr.
"Person. Title. Text": A person s title of address, e.g., Mr, Ms, Dr, Sir.
"Reminder Line. Accounting Cost Code. Code": The buyer s accounting 
code applied to the Reminder Line.
"Reminder Line. Accounting Cost. Text": The buyer s accounting cost 
centre applied to the Reminder Line, expressed as text.
"Reminder. Accounting Cost Code. Code": The Buyer s accounting code 
applied to the Reminder as a whole.
"Reminder. Accounting Cost. Text": The Buyer s accounting code 
applied to the Reminder as a whole, expressed as text.
"Remittance Advice. Payer_ Reference. Text": An internal reference to 
the Payer s order for payment.
"Remittance Advice. Payment Order Reference. Text": An internal 
reference to the order for payment from the Payer to the Payer s bank.
"Self Billed Credit Note. Accounting Cost Code. Code": The Buyer s 
accounting code applied to the Self Billed Credit Note as a whole.
"Self Billed Credit Note. Accounting Cost. Text": The Buyer s 
accounting code applied to the Self Billed Credit Note as a whole, 
expressed as text.
"Shipment. Declared For Carriage_ Value. Amount": Value, declared by 
the shipper or his agent solely for the purpose of varying the 
carrier s level of liability from that provided in the contract of 
carriage, in case of loss or damage to goods or delayed delivery.
"Supplier Party. Additional_ Account Identifier. Identifier": The 
customer s internal identifier for the supplier.
"Supplier Party. Customer Assigned_ Account Identifier. Identifier": 
The customer s internal identifier for the supplier.
"Tender Receipt. Contract Name. Text": The time assigned by the 
sender s application at which the Notification was created.
"Tender Receipt. Issue Date. Date": The date assigned by the sender s 
application at which the Notification was created.
"Tender Receipt. Issue Time. Time": The time assigned by the sender s 
application at which the Notification was created.
"Tender Receipt. Registered Date. Date": The date assigned by the 
sender s application at which the Notification was created.
"Tender Receipt. Registered Time. Time": The time assigned by the 
sender s application at which the Notification was created.
"Transport Equipment. Refrigeration On_ Indicator. Indicator": 
Indicates whether the transport equipment s refrigeration is on 
(true) or off (false).
"Unawarded Notification. Issue Date. Date": The date assigned by the 
sender s application at which the Notification was created.
"Unawarded Notification. Issue Time. Time": The time assigned by the 
sender s application at which the Notification was created.
"Utility Statement. Accounting Cost Code. Code": The Buyer s 
accounting cost code applied to the UtilityStatement.
"Utility Statement. Accounting Cost. Text": The Buyer s accounting 
cost applied to the UtilityStatement, expressed as text.
"Waybill. Declared Carriage_ Value. Amount": Value, declared by the 
shipper or his agent solely for the purpose of varying the carrier s 
level of liability from that provided in the contract of carriage, in 
case of loss or damage to goods or delayed delivery.
"Waybill. Freight Forwarder_ Party. Party": The party combining 
individual smaller consignments into a single larger shipment 
(so-called consolidated consignment ) that is sent to a counterpart 
who mirrors the consolidator s activity by dividing the consolidated 
consignment into its original components.


But I think each of PSC and TSC should use this OpenOffice attachment 
to add action items to clean up the use of English in the definitions.

I hope this helps.

. . . . . . . . . . . . Ken

Attachment: UBL-2.1-PRD2-20110821b-definitions.odt
Description: application/vnd.oasis.opendocument.text

--
Contact us for world-wide XML consulting and instructor-led training
Free 5-hour video lecture: XSLT/XPath 1.0 & 2.0 http://ude.my/t37DVX
Crane Softwrights Ltd.            http://www.CraneSoftwrights.com/o/
G. Ken Holman                   mailto:gkholman@CraneSoftwrights.com
Google+ profile: https://plus.google.com/116832879756988317389/about
Legal business disclaimers:    http://www.CraneSoftwrights.com/legal