Schema


Schema wc-dataload-env.xsd
Target Namespace http://www.ibm.com/xmlns/prod/commerce/foundation/config
Namespace Table http://www.ibm.com/xmlns/prod/commerce/foundation/config
http://www.w3.org/2001/XMLSchema

Directives
include wc-dataload-common.xsd

Elements
DataLoadEnvConfiguration

Complex Types
Database
DataLoadEnvConfiguration
DataWriter
FilePath
IDResolver

Simple Types

Types


Complex Type Database
Namespace http://www.ibm.com/xmlns/prod/commerce/foundation/config
Diagram Database
Inheritance Hierarchy
anyType {http://www.w3.org/2001/XMLSchema}
    Database {http://www.ibm.com/xmlns/prod/commerce/foundation/config}
Content Details
Documentation
     

The database properties needed to connect to the target database.

Attribute Type Required Default Setting Description
type String Yes N/A

The database type. For example, "derby".

Supported values are "derby", "db2" and "oracle".

name String Yes N/A

The name of the database the data is being loaded into.

user String No N/A

The database user ID.

password String No N/A

The database password. The database password can be overridden on the command line. Do not specify the password inside the configuration file unless the password is encrypted.

server String No N/A

The name of the server the database is on.

port int No N/A

The port to connect to the database.

driverType String No N/A

The database driver type.

schema String No N/A

The name of the database schema.

Source
 <xsd:complexType name="Database"> 
   <xsd:attribute name="type" type="xsd:string" use="required" form="unqualified">  
    </xsd:attribute> 
   <xsd:attribute name="name" type="xsd:string" use="required" form="unqualified">  
    </xsd:attribute> 
   <xsd:attribute name="user" type="xsd:string" use="optional" form="unqualified">  
    </xsd:attribute> 
   <xsd:attribute name="password" type="xsd:string" use="optional" form="unqualified">  
    </xsd:attribute> 
   <xsd:attribute name="server" type="xsd:string" use="optional" form="unqualified">  
    </xsd:attribute> 
   <xsd:attribute name="port" type="xsd:int" use="optional" form="unqualified">  
    </xsd:attribute> 
   <xsd:attribute name="driverType" type="xsd:string" use="optional" form="unqualified">  

             </xsd:attribute> 
   <xsd:attribute name="schema" type="xsd:string" use="optional" form="unqualified">  
    </xsd:attribute> 
 </xsd:complexType>

Complex Type DataLoadEnvConfiguration
Namespace http://www.ibm.com/xmlns/prod/commerce/foundation/config
Diagram DataLoadEnvConfiguration FilePath FilePath BusinessContext BusinessContext Database Database IDResolver IDResolver DataWriter DataWriter
Inheritance Hierarchy
anyType {http://www.w3.org/2001/XMLSchema}
    DataLoadEnvConfiguration {http://www.ibm.com/xmlns/prod/commerce/foundation/config}
Content Details
FilePath [0..1]
BusinessContext

This node defines business context information specific to a load item. Note that global business context information can be specified in the environment configuration file and can be overridden at the load item.

Attribute Type Required Default Setting Description
storeIdentifier String No N/A

The store external identifier of the store. The utility resolves the store internal identifier based on the external identifier.

catalogIdentifier String No N/A

The catalog external identifier of the catalog. The utility resolves the catalog internal identifier based on the external identifier.

catalogIdentifier String No N/A

The catalog external identifier of the catalog. The utility resolves the catalog internal identifier based on the external identifier.

langId int No N/A

The language ID of the data. This attribute is the same as languageId.

languageId int No N/A

The language ID of the data. This attribute is the same as langId.

currency String No N/A

The currency of the data.

storeId int No N/A

The store internal identifier of the store. Do not specify if the storeIdentifier is provided.

catalogId long No N/A

The catalog internal identifier of the store. Do not specify if the catalogIdentifier is provided.

workspaceIdentifier String No N/A

The workspace code is the system generated identifier for the workspace, not the name assigned to the workspace by the Workspace Manager.

taskGroupIdentifier String No N/A

The task group code is the system generated identifier for the task groups, not the name assigned to the task group by the Workspace Manager. Specify either this attribute or the taskGroupName attribute.

taskIdentifier String No N/A

The task code is the system generated identifier for the task, not the name assigned to the task by the Workspace Manager. Specify either this attribute or the taskName attribute.

taskGroupName String No N/A

The name assigned to the task group by the Workspace Manager. Specify either this attribute or the taskGroupIdentifier attribute.

taskName String No N/A

The name assigned to the task by the Workspace Manager. Specify either this attribute or the taskIdentifier attribute.

Database [1..1]
IDResolver [0..1]
DataWriter [0..1]
Documentation
  

This configuration file defines the environment that the data is loaded into.

Source
 <xsd:complexType name="DataLoadEnvConfiguration"> 
   <xsd:sequence>  
     <xsd:element name="FilePath" type="_config:FilePath" minOccurs="0" maxOccurs="1"/>  
     <xsd:element name="BusinessContext" type="_config:BusinessContext" minOccurs="0" maxOccurs="1">   
      </xsd:element>  
     <xsd:element name="Database" type="_config:Database" minOccurs="1" maxOccurs="1"/>  
     <xsd:element name="IDResolver" type="_config:IDResolver" minOccurs="0" maxOccurs="1"/>  
     <xsd:element name="DataWriter" type="_config:DataWriter" minOccurs="0" maxOccurs="1"/>  
   </xsd:sequence> 
 </xsd:complexType>

Complex Type DataWriter
Namespace http://www.ibm.com/xmlns/prod/commerce/foundation/config
Diagram DataWriter NameValuePair NameValuePair
Inheritance Hierarchy
anyType {http://www.w3.org/2001/XMLSchema}
    DataWriter {http://www.ibm.com/xmlns/prod/commerce/foundation/config}
Content Details
property

An area defining custom properties for use with a custom data writer.

Documentation
     

The data writer to use for the entire load. This can be overridden in the business object configuration file.

Attribute Type Required Default Setting Description
className String Yes N/A

The data writer implementation class

  • com.ibm.commerce.foundation.dataload.datawriter.JDBCDataWriter:
    This data writer writes the physical objects to the database directly using JDBC with batch support. This is typically used in the delta data load scenario.
  • com.ibm.commerce.foundation.dataload.datawriter.NativeDBDataWriter:
    This data writer converts the physical objects to a file in the database native loadable format. This is usually used in the initial data load.

Source
 <xsd:complexType name="DataWriter"> 
         <xsd:sequence>  
     <xsd:element name="property" type="_config:NameValuePair" minOccurs="0" maxOccurs="unbounded">   
      </xsd:element>  
   </xsd:sequence> 
   <xsd:attribute name="className" type="xsd:string" use="required" form="unqualified">  
    </xsd:attribute> 
 </xsd:complexType>

Complex Type FilePath
Namespace http://www.ibm.com/xmlns/prod/commerce/foundation/config
Diagram FilePath
Inheritance Hierarchy
anyType {http://www.w3.org/2001/XMLSchema}
    FilePath {http://www.ibm.com/xmlns/prod/commerce/foundation/config}
Content Details
Documentation
     

This element defines the set of known paths for the configuration and data files.

Attribute Type Required Default Setting Description
boConfigFilePath String No N/A

The file path for the set of business object configuration files used during the data load process. This path is prepended to the business object configuration file names specifed in the load order file.

dataInputFilePath String No N/A

The file path for the set of data input files used during the data load process. This path is prepended to the data reader input data file names specifed in the load order file.

dataOutputFilePath String No N/A

The file path for the set of data output files generated during the data load process. This path is used by the native load data writer. It can be used with custom data writers.

Source
 <xsd:complexType name="FilePath">         
         <xsd:attribute name="boConfigFilePath" type="xsd:string" use="optional" form="unqualified">  
          </xsd:attribute> 
   <xsd:attribute name="dataInputFilePath" type="xsd:string" use="optional" form="unqualified">  
    </xsd:attribute> 
   <xsd:attribute name="dataOutputFilePath" type="xsd:string" use="optional" form="unqualified">  
    </xsd:attribute> 
    </xsd:complexType>

Complex Type IDResolver
Namespace http://www.ibm.com/xmlns/prod/commerce/foundation/config
Diagram IDResolver NameValuePair NameValuePair
Inheritance Hierarchy
anyType {http://www.w3.org/2001/XMLSchema}
    IDResolver {http://www.ibm.com/xmlns/prod/commerce/foundation/config}
Content Details
property

This area defines custom properties for use with a custom ID Resolver.

Documentation
  

The ID Resolver to use for the entire load.

The ID Resolver determines whether a business object already exists in the database.

The default implementation shipped with the data load utility will cache all sets of identifiers into memory.

If a different implementation is needed, the ID Resolver can be overridden here by specifying a class name and any additional properties that are needed for the custom implementation. The schema definition of the IDResolver element:

Attribute Type Required Default Setting Description
className String Yes com.ibm.commerce.foundation.dataload.idresolve.IDResolverImpl

The implementation class of the ID Resolver to use.

  • com.ibm.commerce.foundation.dataload.idresolve.IDResolverImpl:
    The default implementation caches all sets of identifiers into memory.

cacheSize nonNegativeInteger No 0

The cache size for the ID Resolver.

Source
 <xsd:complexType name="IDResolver"> 
         <xsd:sequence>  
     <xsd:element name="property" type="_config:NameValuePair" minOccurs="0" maxOccurs="unbounded">   
      </xsd:element>  
   </xsd:sequence> 
   <xsd:attribute name="className" type="xsd:string" use="required" form="unqualified">  
    </xsd:attribute> 
   <xsd:attribute name="cacheSize" type="xsd:nonNegativeInteger" use="optional" form="unqualified">  
    </xsd:attribute> 
 </xsd:complexType>

Elements


Element DataLoadEnvConfiguration
Namespace http://www.ibm.com/xmlns/prod/commerce/foundation/config
Diagram DataLoadEnvConfiguration FilePath FilePath BusinessContext BusinessContext Database Database IDResolver IDResolver DataWriter DataWriter DataLoadEnvConfiguration
Type DataLoadEnvConfiguration {http://www.ibm.com/xmlns/prod/commerce/foundation/config}
Documentation
  

This configuration file defines the environment that the data is loaded into.

Source
 <xsd:element name="DataLoadEnvConfiguration" type="_config:DataLoadEnvConfiguration"> 
  </xsd:element>

Groups


Attributes


Attribute Groups