GetElectronicCatalog schema, example, validation rules, validation stylesheet |
GetElectronicCatalog type: GetElectronicCatalog | |
The purpose of the GetElectronicCatalog is to enable a business application module or system to request catalog information. The Catalog information that is requested by the GetElectronicCatalog may include · Item Identifiers · Specifications · Pricing Information agreed on either · Purchase Agreements · Price Lists · Availability and Delivery Information · Related Items and accessories There are many possible business applications in several environments that may use this capability. Some examples of usage scenarios are: · Manufacturer exchanging catalogs with distributors/ suppliers/e-marketplaces · Distributors/ Suppliers/ e-marketplaces exchanging catalogs with Buyers or other trading partners It may also be necessary to support Component Supplier Management (CSM) scenarios. In this scenario a company will provide a service of sourcing and codifying the products of many companies and publishing a consolidated catalog. The Catalog exchange scenario can be implemented either as a simple scenario using a single BOD, or in the case or large catalogs involving complex pricing scenarios or partner specific details, as multiple BODs. |
GetElectronicCatalog extends: BusinessObjectDocument | |||||||
Structure: |
![]() |
||||||
Elements: |
|
GetElectronicCatalogDataArea extends: DataArea | ||||||||||
Structure: |
![]() |
|||||||||
Elements: |
|
GetElectronicCatalog Scenario Diagram |
Get schema |
Get type: Get | |
The GET verb is to communicate to a business software component a request for an existing piece of information to be returned. The GET may be paired with most of the nouns defined in the OAGIS specification.The response to this request is the SHOW verb. The behavior of a BOD with a GET verb is quite predictable across most of the nouns it may be paired with.The GET is designed to retrieve a single piece of information by using that information's primary retrieval field, or key field. The GET verb is not used to request several documents at once. The GETLIST verb is designed to achieve that purpose and will be covered in more detail later.Selection Criteria:There are two types of selection capabilities for most BOD's that use the GET verb.1) The first selection capability is called Field-Based Selection. Within a GET-based Business Object Document, the first Data Type that occurs in a specific BOD structure is commonly used to provide the Field-Based Selection criteria. This is always defined within the specific BOD and is commonly the required fields for that specific Data type.The Field-Based Selection enables the requester to provide a value or values (in the case of multiple required Field Identifiers), in the required fields. Then the responding component uses those values to find and return the requested information to the originating business software component.2) The second type of selection capability for GET-based BODs is called Data Type Selection. Data Type selection enables the requester to identify which Data Types within the noun are requested to be returned in the response. The use of this capability is described for each corresponding Data Type for all BODs that use the GET verb. The Data Types are identified for retrieval within the GET instance of a BOD by including the name of the Data Type in the meta data but without any Field Identifiers or Segments identified within the Data Type. This will signify to the responding application that all of the data that corresponds to that Data Type is to be included in the response.If the Data Type is not requested, the Data Type identifier is not included in the GET request and this will signify to the responding component that the Data Type is not to be returned. |
Get extends: RequestVerb | |||||||||
Structure: |
![]() |
||||||||
Attributes: |
|
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: |
|
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: |
|
CatalogQualifier | |||||||||||||||||||
Structure: |
![]() |
||||||||||||||||||
Elements: |
|
ClassificationLevel restricts: xs:string | |
ClassificationMaster | ||||||||||||||||
This identifies the individual entities that are strung together in defining a hierarchical classification structure |
||||||||||||||||
Structure: |
![]() |
|||||||||||||||
Elements: |
|
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: |
|
ClassificationStructure | ||||||||||||||||||||||
This identifies a hierarchical association of ClassificationIds |
||||||||||||||||||||||
Structure: |
![]() |
|||||||||||||||||||||
Elements: |
|
ElectronicCatalog extends: Noun | |||||||||||||
Structure: |
![]() |
||||||||||||
Elements: |
|
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: |
|
ElectronicCatalogLine | ||||||||||||||||
Structure: |
![]() |
|||||||||||||||
Elements: |
|
ItemClassification | ||||||||||||||||||||||
Structure: |
![]() |
|||||||||||||||||||||
Elements: |
|
ItemPrice | ||||||||||||||||||||||||||||||||||
This identifies a unit price for an item |
||||||||||||||||||||||||||||||||||
Structure: |
![]() |
|||||||||||||||||||||||||||||||||
Elements: |
|
LinePriceBreak | |||||||||||||||||||||||||||||||
Structure: |
![]() |
||||||||||||||||||||||||||||||
Elements: |
|
Verb Common Files |
Verb.xsd schema |
AcknowledgableVerb extends: ConfirmableVerb | |||||||||
Structure: |
![]() |
||||||||
Attributes: |
|
AcknowledgementType restricts: xs:NMTOKEN | |||||||
Enumerations: |
|
ConfirmableVerb extends: Verb | |||||||||
Structure: |
![]() |
||||||||
Attributes: |
|
ConfirmType restricts: xs:NMTOKEN | |||||||
Enumerations: |
|
Expression restricts: xs:string | |
ExpressionCriteria | |||||||||
Structure: |
![]() |
||||||||
Elements: |
|
||||||||
Attributes: |
|
RequestVerb extends: ConfirmableVerb | |||||||
Structure: |
![]() |
||||||
Elements: |
|
VerbBase.xsd schema |
Verb type: Verb | |
Verb | |
Structure: |
![]() |
Noun Common Files |