SyncElectronicCatalog schema, example, validation rules, validation stylesheet

SyncElectronicCatalog type: SyncElectronicCatalog

SyncElectronicCatalog extends: BusinessObjectDocument
Structure:
Elements:
Name Type Description
DataArea SyncElectronicCatalogDataArea

Is where the information that the BOD message carries is provided, in this case SyncElectronicCatalog. The information consists of a Verb and one or more Nouns. The verb (Sync) indicates the action to be performed on the Noun (ElectronicCatalog).

SyncElectronicCatalogDataArea extends: DataArea
Structure:
Elements:
Name Type Description
ElectronicCatalog reference
Sync reference

SyncElectronicCatalog Scenario Diagram

Sync schema

Sync type: Sync

The Sync verb is used when the owner of the data is passing or publishing that information or change in information to other software components. This is to be used when the receiver of the SyncBOD does not own the data. This verb is commonly used when mass changes are necessary or when a publish and subscribe mechanism is used in the integration architecture.The purposes of this verb include application integrity and ease of data entry for the business user by enabling a single point of input.

Sync extends: ConfirmableVerb
Structure:
Elements:
Name Type Description
SyncCriteria SyncExpressionCriteria

SyncExpressionCriteria
Structure:
Elements:
Name Type Description
SyncExpression
Attributes:
Name Type Usage Description
action required
expressionLanguage
Enumerations:
Add
Change
Delete
Replace

ElectronicCatalog schema

ElectronicCatalog type: ElectronicCatalog

ElectronicCatalog is a list of items or commodities. The items may be arranged according to a classification scheme. The catalog can identify the classification scheme it uses, and the classifications and features that are defined within that scheme. Within the catalog, each item can be classified into one oe more categories , and the specifications of each item can be identified. A catalog has at least one publisher and one or many suppliers for the items in the catalog.

Header type: ElectronicCatalogHeader

ClassificationMaster type: ClassificationMaster

Describes the individual classifications available in the Classification Scheme. Individual classifications are put together in a hierarchical manner to create a classification structure.

ClassificationStructure type: ClassificationStructure

Describes a hierarchical association of classifications. A unique identifier for each ClassificationStructure can also be specified.

Feature type: FeatureValue

This identifies the features of an item or a classification

ItemPrice type: ItemPrice

Identifies the price of the item.

LinePriceBreak type: LinePriceBreak

ClassificationScheme type: ClassificationScheme

ItemClassification type: ItemClassification

Identifies the classification families to which an item belongs

CatalogQualifier type: CatalogQualifier

This identifies the usage of the catalog. The Catalog may be intended for use by a specific business or a division of business within an organization, or it may be for specific customers or suppliers. The usage restriction could be made more specific to sites within a customer organization or business entity

CatalogItemLine type: CatalogItemLine

CatalogCommodityLine type: CatalogCommodityLine

CatalogCommodityLine

This is applicable when the catalog is used to identify commodities rather than line items

Structure:
Elements:
Name Type Description
CommodityCode Commodity

Are codes that identify user-defined groupings of items.

Description Description

Free-form text description of the Noun or Componenet in which the description occurs. The lang attribute indicates the language the description is in. Owner inidcates the user or entity that provided teh description..

LineNumber LineNumber

Identifies the instance of a Line within a given document.

Parties reference

The SupplierPartyReference within the CatalogItemCategory identifies the suppliers of the item in this catalog. The SupplierPartyReference can be specified either in the Catalog Header, or optionally here in the CatalogItem

UserArea reference

CatalogItemLine

The CatalogItem represents a line item in a catalog. The PartyReferences in the CatalogItemLine identify the provider of the item. Depending on the exchange scenario, the provider may be either a Supplier, Manufacturer or a Catalog Party. If no PartyReference is specified at line level, the header value of the PartyReference is assumed to hold true for the line

Structure:
Elements:
Name Type Description
Attachments reference
Description Description

Free-form description of the Catalog Line.

Free-form text description of the Noun or Componenet in which the description occurs. The lang attribute indicates the language the description is in. Owner inidcates the user or entity that provided teh description..

Feature reference
ItemClassification ItemClassification

The ClassificationIds identify a single or hierarchical association of classifications. For example, Pump, Centrifugal would be represented by two ClassificationIds, the first one as Pump, the second as Centrifugal

ItemId reference

Identifies Item code. This can be a UPC or an EAN or a company assigned Id. Along with a revision number of the Item.

ItemPrice reference
ItemType ItemType

Indicates whether the item is a good, a service, or a resource. This is used to describe inventoried items. Examples of this value include documents, jigs, fixtures, tools, or bulk items. SYNONYMS Resource Classification Item Category

LineNumber LineNumber

Identifies the instance of a Line within a given document.

Parties reference

The PartyReference within the CatalogItem identifies the suppliers of the item in this catalog. The SupplierParty can be specified either in the Catalog Header, or optionally here in the CatalogItem

UnitOfMeasure UOM

Indicates the UnitOfMeasure in which the Item is available to be sold.

Standard values from ISO / SI ????

UserArea reference

CatalogQualifier
Structure:
Elements:
Name Type Description
Business reference
Description Description

Description of the PriceList.

Free-form text description of the Noun or Componenet in which the description occurs. The lang attribute indicates the language the description is in. Owner inidcates the user or entity that provided teh description..

Parties reference
Site reference
UserArea reference

ClassificationLevel restricts: xs:string

ClassificationMaster

This identifies the individual entities that are strung together in defining a hierarchical classification structure

Structure:
Elements:
Name Type Description
ClassificationId Id

The ClassificationId identifies a unique classification element

Generic identifier type with open qualifyingAgency.

ClassificationLevel ClassificationLevel

This is an enumeration with suggested/ resticted values - ROOT, BRANCH, LEAF

Description Description

Free-form description of the Catalog Classification.

Free-form text description of the Noun or Componenet in which the description occurs. The lang attribute indicates the language the description is in. Owner inidcates the user or entity that provided teh description..

UserArea reference

ClassificationScheme

This identifies the classification scheme used by all the items in the catalog. Additionally, this also identifies all the classifications within this scheme and their hierarchical representation. The features that are defined in this classification scheme and also the features that are associated with each hierarchical classification representation can also be specified

Structure:
Elements:
Name Type Description
ClassificationMaster reference
ClassificationSchemeId DocumentIdType

Is the identifier of the Classification Scheme.

ClassificationStructure reference
Description Description

Description of the Classification Scheme.

Free-form text description of the Noun or Componenet in which the description occurs. The lang attribute indicates the language the description is in. Owner inidcates the user or entity that provided teh description..

Feature reference
Note reference

A free form note. The lang attribute identifies the language that the note is in. The author identifies the author of the note. The enrtyDate indicates the date the note was entered or last modified.

UserArea reference

ClassificationStructure

This identifies a hierarchical association of ClassificationIds

Structure:
Elements:
Name Type Description
ClassificationId Id

The ClassificationIds identify a single or hierarchical association of classifications. For example, Pump, Centrifugal would be represented by two ClassificationIds, the first one as Pump, the second as Centrifugal

Generic identifier type with open qualifyingAgency.

ClassificationStructureId Id

This Id is a unique reference to a classification hierarchy. It can also be used to represent a concatenated set of associated classifications

Generic identifier type with open qualifyingAgency.

Description Description

Description of the Classification Structure.

Free-form text description of the Noun or Componenet in which the description occurs. The lang attribute indicates the language the description is in. Owner inidcates the user or entity that provided teh description..

Feature reference

Features that are common to the classification are specified here. For example, if PUMP is a classification, then the features speified here would apply to ALL pumps

Note Note

A free form note. The lang attribute identifies the language that the note is in. The author identifies the author of the note. The enrtyDate indicates the date the note was entered or last modified.

UserArea reference

ElectronicCatalog extends: Noun
Structure:
Elements:
Name Type Description
CatalogCommodityLine reference
CatalogItemLine reference
Header reference

ElectronicCatalogHeader

This identifies header information about the catalog. This information applies to all the lines in the catalog. PartyReferences in the Header are defaults that apply to all the catalog lines, if there is no value specified at line level

Structure:
Elements:
Name Type Description
Business reference
CatalogQualifier reference
ClassificationScheme reference
Currency Currency

Is the default currency of the Catalog. If a Currencey is specified for the catalog, all the prices in the catalog are assumed to be in the corresponding currency.

Description Description

Free-form description of the Catalog.

Free-form text description of the Noun or Componenet in which the description occurs. The lang attribute indicates the language the description is in. Owner inidcates the user or entity that provided teh description..

DocumentId PartyGenericIdType

Is the Catalog identifier. The business use for revisions of catalogs is in the area of conflict resolution. The highest revision of a given catalog name will always supercede lower revision numbers. For example, if the Engineering Supplies Spring Catalog version 2 with effective dates of February 28th through May 31st will always supercede Engineering Supplies Spring Catalog version 1 with effective dates of February 28th through May 31st

EffectivePeriod TimePeriod

Is the effective period of the Catalog or Catalog revision. The EffectiveTimePeriod indicates the effectivity date and the expiration date for the validity of the catalog. Often times the effectivity of a Catalog Revision is indicated by the release of a new revision of the Catalog. As such the Finish Effectivity date is never specified but assumed to be the Starting Effectivity date on the next revision

Name Name

Is the name of the Catalog.

Parties reference
PublisherParty reference
Site reference

Is the GLEntity that is issuing the catalog

UsageRestriction Usage

UsageRestriction is used to indicate additional restrictions on the catalog usage. The implementation of this is to be agreed upon between trading partners. An example of usage of this is when a supplier has different catalogs – one for general usage and others for usage by specific customers/ group of customers. In this scenario, the UsageRestriction can be specified as PUBLIC/ PRIVATE

UserArea reference

ElectronicCatalogLine
Structure:
Elements:
Name Type Description
CatalogCommodityLine CatalogCommodityLine
CatalogItemLine CatalogItemLine
LineNumber LineNumber

Identifies the instance of a Line within a given document.

UserArea reference

ItemClassification
Structure:
Elements:
Name Type Description
Attachments reference
ClassificationId Id

The ClassificationIds identify a single or hierarchical association of classifications. For example, Pump, Centrifugal would be represented by two ClassificationIds, the first one as Pump, the second as Centrifugal

Generic identifier type with open qualifyingAgency.

ClassificationStructureId Id

This Id is a unique reference to a classification hierarchy. It can also be used to represent a concatenated set of associated classifications

Generic identifier type with open qualifyingAgency.

Description Description

Free-form text description of the Noun or Componenet in which the description occurs. The lang attribute indicates the language the description is in. Owner inidcates the user or entity that provided teh description..

Note Note

A free form note. The lang attribute identifies the language that the note is in. The author identifies the author of the note. The enrtyDate indicates the date the note was entered or last modified.

UserArea reference

ItemPrice

This identifies a unit price for an item

Structure:
Elements:
Name Type Description
CustomerReference reference

The PartyReference in ItemPrice is used to indicate prices applicable for a specific customer

Description Description

Free-form text description of the Noun or Componenet in which the description occurs. The lang attribute indicates the language the description is in. Owner inidcates the user or entity that provided teh description..

DocumentReferences reference
EffectivePeriod TimePeriodAny

Is the effective time period of the ItemPrice.

LinePriceBreak reference
Note Note

A free form note. The lang attribute identifies the language that the note is in. The author identifies the author of the note. The enrtyDate indicates the date the note was entered or last modified.

PriceCode Code

Is a price code the communicates pricing information,

Base type for a Code of any kind

PriceType Type

The PriceType identifies if the Price is List Price, Cost Price, Discounted Price, Special Price etc. This is not an enumerated list

UnitPrice AmountPerQuantity

Indicates the amount per quantity.

Indicates the cost or price of something represented as a value per a number of units. The price of eggs for example would be 1.29 per 1 dozen.

UserArea reference

LinePriceBreak
Structure:
Elements:
Name Type Description
Description Description

Description of the PriceBreak.

Free-form text description of the Noun or Componenet in which the description occurs. The lang attribute indicates the language the description is in. Owner inidcates the user or entity that provided teh description..

DiscountPercent Percent

Indicates the percentage of the PriceBreak.

Indicates the percentage.

DiscountValue Amount

Allows a flat amount to be discounted per item.

Simple content with the currency as an attrbute

EffectivePeriod TimePeriodAny

Indicates the period in which the Line Price Break is in effect.

OverRidePrice AmountPerQuantity

This is the price that overrides the list price when a given price break requirement is reached. For example, if a customer orders over 50,000 dollars worth of computer equipment, he may qualify for an overriding price. The list price of $800 per will be modified to $700 per

Indicates the cost or price of something represented as a value per a number of units. The price of eggs for example would be 1.29 per 1 dozen.

PriceBreakAmount Amount

The monetary amount that must be spent on a given price list line before the benefit or until the detriment of a given price break line will apply. For example, if a customer orders up to 5000 dollars worth of flour, they will get a price of $8:00 a case. If the customer buys 5500 dollars worth of flour they will get a price of $7.50 a case

Simple content with the currency as an attrbute

PriceBreakQuantity Quantity

The quantity that must be purchased of the item or commodity on a given price list line before the benefit, or until the detriment of a given price break line will apply. For example, if a customer orders up to 5000 units of flour, they will get a price of $8:00 a case. If the customer buys 5500 units of flour they will get a price of $7.50 a case

A decimal value.

PriceCode Code

Is a Code that can be used to identify the price

Base type for a Code of any kind

UserArea reference

Verb Common Files

Verb.xsd schema

AcknowledgableVerb extends: ConfirmableVerb
Structure:
Attributes:
Name Type Usage Description
acknowledge AcknowledgementType

AcknowledgementType restricts: xs:NMTOKEN
Enumerations:
Always
Never
OnChange

ConfirmableVerb extends: Verb
Structure:
Attributes:
Name Type Usage Description
confirm ConfirmType

ConfirmType restricts: xs:NMTOKEN
Enumerations:
Always
Never
OnChange

Expression restricts: xs:string

ExpressionCriteria
Structure:
Elements:
Name Type Description
SelectExpression Expression

Allows the 1-n number of selection expressions for the information to be returned.

Attributes:
Name Type Usage Description
expressionLanguage xs:string optional

RequestVerb extends: ConfirmableVerb
Structure:
Elements:
Name Type Description
ReturnCriteria

Allows the initator of the BOD to indicate the information (down to the field level) that is requested to be returned. The expressionLanguage indicates the expression language being used.

VerbBase.xsd schema

Verb type: Verb

Verb
Structure:

Noun Common Files