3 Business Object Structure

This chapter describes the directories that contain the Oracle Retail Business Objects.

Base and Custom Directories

The base directory contains the Oracle Retail Business Objects, as delivered with each release and used by Oracle Retail applications within the integration products. The packaging structure reflects the namespace and the versioning within the namespace.

For example:

The ASNInBO.xsd namespace:

targetNamespace="http://www.oracle.com/retail/integration/base/bo/ASNInBO/v1"
version="1.0"
xmlns=http://www.oracle.com/retail/integration/base/bo/ASNInBO/v1

The ASNInBO.xsd within the packaging structure:

retail/integration/base/bo/ASNInBO/v1/ASNInBO.xsd

Custom and Localization Directories and Namespaces

Additional directories, placeholder XSDs and hooks in the base XSDs are optionally created using the Template Creator tool.

The Template Creator creates the custom and localization directories and hooks for a specific business object (for example, ASNIn).

Note: For more information, see the Oracle Retail Artifact Generator Guide.

On demand for the business object specified, the Template Generator will create the hooks to customize or localize the Oracle Retail Business Object.

For example:

The LocOfASNInBO.xsd namespace:

targetNamespace="http://www.oracle.com/retail/integration/base/bo/LocOfASNInBO/v1"
version="1.0"
xmlns=http://www.oracle.com/retail/integration/base/bo/LocOfASNInBO/v1

The LocOfASNInBO.xsd within the packaging structure:

retail/integration/base/bo/LocOfASNInBO/v1/LocOfASNInBO.xsd

The custom business objects will be contained within the Custom sub directory, mimicking the base directory but prefaced ExtOf, EOf[locale], where locale is the ISO standard alpha-2 country code.

For example:

• The ExtOfASNInBO.xsd namespace:

  targetNamespace="http://www.oracle.com/retail/integration/custom/bo/ExtOfASNInBO/v1"
      version="1.0"
      xmlns=http://www.oracle.com/retail/integration/custom/bo/ExtOfASNInBO/v1
  

  The ExtOfASNInBO.xsd within the packaging structure:

  retail/integration/custom/bo/ExtOfASNInBO/v1/ExtOfASNInBO.xsd
  

• The EOfBrASNInBO.xsd namespace

  targetNamespace="http://www.oracle.com/retail/integration/custom/bo/EOfBrASNInBO/v1"
      version="1.0"
      xmlns=http://www.oracle.com/retail/integration/custom/bo/EOfBrASNInBO/v1
  

  The EOfBrASNInBO.xsd within the packaging structure.

  retail/integration/custom/bo/EOfBrASNInBO/v1/EOfBrASNInBO.xsd
  

The Localization directories will be contained within the Localization subdirectory, mimicking the base directory, but prefaced within the ISO standard alpha-2 country code.

For example:

The BrASNInBO.xsd namespace:

targetNamespace="http://www.oracle.com/retail/integration/localization/bo/BrASNInBO/v1"
    version="1.0"
    xmlns=http://www.oracle.com/retail/integration/localization/bo/BrASNInBO/v1

The BrASNInBO.xsd within the packaging structure.

retail/integration/localization/bo/BrASNInBO/v1/BrASNInBO.xsd

Within one artifact deliverable (packaged release) there will be only the latest version of each BO XSD file. For a breaking change, the XSD is moved to a directory with the same name as the version number in the changed namespace.