Instructions for discoverying potential ebXML Core Component definitions

Martin Bryan, The SGML Centre

28th September 2000

The following instructions describe how Microsoft's Internet Explorer 5.0 (IE5) can be used to capture core component definitions as XML files.

WARNING: This process will not work on Netscape Explorer or on older versions of Internet Explorer as it relies on Microsoft specific extensions to HTML.

For the discovery process only two types of core components are recognized

The HTML forms used for discovery purposes (simple.htm and complex.htm) allow each of these data types to be recorded. Each form ends with buttons that allow the current contents to be submitted for storage, reset so that a new entry of the same type can be made or to request the other form.

The package has been designed to be run within a directory called ebxml within the My Documents section of your C drive. If wish to use another drive or root directory you should search each of the above files for any occurrences of the string "C:/My Documents/ebxml/" and replace this with the appropriate identifier for the directory you wish to use.

Within the directory that is used to contain the forms you will need to create two subdirectories prior to using the forms. These subdirectories should be labelled complex and simple respectively.  (Directories with these names should be automatically created for you when you unzipped the source files, if the settings of your file unzipper allow automatic creation of subdirectories.)

Because the forms submit their contents to the local file store rather than to a remote directory you will need to ensure that IE5 has been set up to permit this. Enter the Tools Menu select the Internet Options entry and then select the Security tab. If your security level is High you will not be able to use these forms. If it is set to Medium you will be asked to confirm that each record may be written to disc. If it is Low you will be able to write the files without having to confirm each one, but must take care if using the Internet. (I find that the Medium level, which requires me to confirm before writing but still provides for a safe level of Internet access is an adequate compromise.)

 

Defining a Complex Core Component

The following figures show the fields used to define a new entry for use as a core component which has embedded elements. The status line at the foot of the form will change as you move from field to field to provide you with information about the type of data to be entered in each field.

The fields provided in the first part of the form are:

The fields used to select the context in which the component is intended to be used are:

Each line in the section headed Embedded Components has the following fields:

The buttons at the foot of the Entity Definition form are:

The following figures show a typical completed ebXML Complex Core Component Definition

Defining a Simple Core Component

The following figures show the fields used to define a Simple Core Component. The status line at the foot of the form will change as you move from field to field to provide you with information about the type of data to be entered in each field.

The fields provided on this form are:

The fields used to select the context in which the component is intended to be used are:

The Data Representation Type field can used to identify the basic type of data constraint required. (For more complex constraints the you will need to use the full set of Core Component forms.) The definitions of each of the permitted classes is given in the following table:

Representation ClassebXML Definition
Uncontrolled Text StringA character string generally in the form of words.
Code List (permitted entries listed below)A character string that represents a member of a set of values defined in this form
Code List (externally defined)A character string that represents a member of a set of values as defined in an external reource (URL of resource to be placed in adjacent field)
Code List (locally maintained)A character string that represents a member of a set of values where the set of permitted values is application dependent
AmountA number of monetary units specified in a currrency where the unit of currency is explicit or it may be implied.
BooleanAn enumerated list of two, and only two, values which indicates a condition such as on/off; true/false etc.
DateA day within a particular calendar year. Note: Reference ISO 8601.
TimeThe time within any day in public use locally, independent of a particular day. Reference ISO 8601:1988. "
DateAndTimeA particular point in the progression of time. Note: This may incorporate dependent on the level of precision, the concept of date
MeasureA numeric value that is always associated with a unit of measure.
QuantityA number of non-monetary units. It is normally associated with a unit of measure.
NumberA numeric value which is often used to imply a sequence or a member of a series
RateA ratio of two measures [not otherwise expressable as a measure]
IdentifierA character string used to identify and distinguish uniquely, one instance of an object within an identification scheme"
NameA word or phrase that constitutes the distinctive designation of a person, object, place, event, concept etc.

If an external resource is being used to define a code list the URL of that resource, or of a document explaining that resource, should be entered into the adjacent URL of external code list field.

If the Simple Core Component is one that is only allowed to contain specified values (i.e. if the Code List entry has been selected in the Data Representation Type field) the List of Permitted Component Values table can be used to define a list of valid values. The following fields are provided in each row:

The following figures show a completed form for a test code set:

The form ends with the following buttons:

Troubleshooting

The forms described in this document have not been exhaustively tested to date. If you encounter any problems using them please contact their author, Martin Bryan, via email at mtbryan@sgml.u-net.com.