Showing:

Annotations
Attributes
Diagrams
Facets
Instances
Used by

Table of Contents

Group by:

No namespace

Main schema Branch.xsd
Annotations
 
Master Branch List carries information which describes each branch and can identify individual branches as separate business entities.  Branches typically have one or more warehouses associated with them.
[ top ]
Included schema CommonElements.xsd
[ top ]
Element BranchListSubmit
Diagram
Diagram Branch.tmp#CommonAttributes Branch.tmp#Branches Branch.tmp#Errors
Instance
 
<BranchListSubmit Culture="en" EndTime="" ErrorCount="0" LoadFilter="" LoadType="" SiteID="" StartTime="" StatusID="" TransactionID="" Transformed="false" Version="">
  <Branches Version="">{1,1}</Branches>
  <Errors>{0,1}</Errors>
</BranchListSubmit>
Attributes
QName Type Default Use Annotation
Culture xs:string en optional
EndTime xs:dateTime optional
ErrorCount xs:integer 0 optional
LoadFilter xs:string optional 
LoadFilter must indicate the Entity Type.  Only one Entity Type per file is allowed. i.e. “Product”
LoadType xs:string required 
FULL, FULLBranch, or PARTIAL
Note: partial loads require each record to explicitly declare if it is deprecated or not.  Full loads assume anything not in the load is deprecated.
SiteID xs:string optional
StartTime xs:dateTime optional
StatusID xs:integer optional
TransactionID xs:string optional
Transformed xs:boolean false optional
Version xs:decimal required
[ top ]
Element Branches
Diagram
Diagram Branch.tmp#Branches_Version Branch.tmp#Branch
Used by
Instance
 
<Branches Version="">
  <Branch Deprecated="" Version="">{0,unbounded}</Branch>
</Branches>
Attributes
QName Type Use
Version xs:decimal optional
[ top ]
Element Branch
Diagram
Diagram Branch.tmp#Branch_Version Branch.tmp#Branch_Deprecated Branch.tmp#Branch_BranchCode Branch.tmp#Branch_Description Branch.tmp#Branch_NationalBusinessIdentifier Branch.tmp#Address Branch.tmp#Branch_SalesTaxNumber
Used by
Element Branches
Instance
 
<Branch Deprecated="" Version="">
  <BranchCode>{1,1}</BranchCode>
  <Description>{1,1}</Description>
  <NationalBusinessIdentifier>{0,1}</NationalBusinessIdentifier>
  <Address Type="" Version="">{1,1}</Address>
  <SalesTaxNumber>{0,1}</SalesTaxNumber>
</Branch>
Attributes
QName Type Use
Deprecated xs:boolean optional
Version xs:decimal optional
[ top ]
Element Branch / BranchCode
Annotations
 
ERP External unique identifier
Diagram
Diagram
Facets
maxLength 36
[ top ]
Element Branch / Description
Annotations
 
Branch Name / Descriptions
Diagram
Diagram
Facets
maxLength 100
[ top ]
Element Branch / NationalBusinessIdentifier
Annotations
 
Unique Business identifier – could be Company Registration no for example
Diagram
Diagram
Facets
maxLength 20
[ top ]
Element Address
Annotations
 
Generic Address Element
Diagram
Diagram Branch.tmp#Address_Type Branch.tmp#Address_Version Branch.tmp#Address_Name Branch.tmp#Address_Street1 Branch.tmp#Address_Street2 Branch.tmp#Address_Suburb Branch.tmp#Address_City Branch.tmp#Address_Area Branch.tmp#Address_State Branch.tmp#Address_Country Branch.tmp#Address_Other Branch.tmp#Address_PostCode Branch.tmp#Address_GeoRef Branch.tmp#Address_Phone Branch.tmp#Address_Fax Branch.tmp#Address_Email Branch.tmp#Address_Social Branch.tmp#Address_Notes Branch.tmp#Address_TimeZone Branch.tmp#Address_TimeZoneName
Used by
Element Branch
Instance
 
<Address Type="" Version="">
  <Name>{1,1}</Name>
  <Street1>{1,1}</Street1>
  <Street2>{1,1}</Street2>
  <Suburb>{0,1}</Suburb>
  <City>{1,1}</City>
  <Area>{0,1}</Area>
  <State>{0,1}</State>
  <Country>{0,1}</Country>
  <Other>{0,1}</Other>
  <PostCode>{1,1}</PostCode>
  <GeoRef>{0,1}</GeoRef>
  <Phone>{0,1}</Phone>
  <Fax>{0,1}</Fax>
  <Email>{0,1}</Email>
  <Social>{0,1}</Social>
  <Notes>{0,1}</Notes>
  <TimeZone>{0,1}</TimeZone>
  <TimeZoneName>{0,1}</TimeZoneName>
</Address>
Attributes
QName Type Use
Type restriction of xs:string optional
Version xs:decimal optional
[ top ]
Element Address / Name
Diagram
Diagram
Facets
maxLength 100
[ top ]
Element Address / Street1
Diagram
Diagram
Facets
maxLength 100
[ top ]
Element Address / Street2
Diagram
Diagram
Facets
maxLength 100
[ top ]
Element Address / Suburb
Diagram
Diagram
Facets
maxLength 50
[ top ]
Element Address / City
Diagram
Diagram
Facets
maxLength 50
[ top ]
Element Address / Area
Diagram
Diagram
Facets
maxLength 50
[ top ]
Element Address / State
Diagram
Diagram
Facets
maxLength 50
[ top ]
Element Address / Country
Diagram
Diagram
Facets
maxLength 50
[ top ]
Element Address / Other
Diagram
Diagram
Facets
maxLength 50
[ top ]
Element Address / PostCode
Diagram
Diagram
Facets
maxLength 50
[ top ]
Element Address / GeoRef
Diagram
Diagram Branch.tmp#Address_Address_GeoRef_Lat Branch.tmp#Address_Address_GeoRef_Long
Instance
 
<GeoRef>
  <Lat>{1,1}</Lat>
  <Long>{1,1}</Long>
</GeoRef>
[ top ]
Element Address / GeoRef / Lat
Diagram
Diagram
[ top ]
Element Address / GeoRef / Long
Diagram
Diagram
[ top ]
Element Address / Phone
Diagram
Diagram Branch.tmp#Address_Address_Phone_Number
Instance
 
<Phone>
  <Number Description="" Seq="" Type="">{0,unbounded}</Number>
</Phone>
[ top ]
Element Address / Phone / Number
Diagram
Diagram Branch.tmp#Address_Address_Phone_Address_Address_Phone_Number_Type Branch.tmp#Address_Address_Phone_Address_Address_Phone_Number_Seq Branch.tmp#Address_Address_Phone_Address_Address_Phone_Number_Description
Attributes
QName Type Use
Description restriction of xs:string optional
Seq xs:integer optional
Type restriction of xs:string required
[ top ]
Element Address / Fax
Diagram
Diagram Branch.tmp#Address_Address_Fax_Number
Instance
 
<Fax>
  <Number Description="" Seq="" Type="">{0,unbounded}</Number>
</Fax>
[ top ]
Element Address / Fax / Number
Diagram
Diagram Branch.tmp#Address_Address_Fax_Address_Address_Fax_Number_Type Branch.tmp#Address_Address_Fax_Address_Address_Fax_Number_Seq Branch.tmp#Address_Address_Fax_Address_Address_Fax_Number_Description
Attributes
QName Type Use
Description restriction of xs:string optional
Seq xs:integer optional
Type restriction of xs:string required
[ top ]
Element Address / Email
Diagram
Diagram Branch.tmp#Address_Address_Email_Address
Instance
 
<Email>
  <Address Description="" Seq="" Type="">{0,unbounded}</Address>
</Email>
[ top ]
Element Address / Email / Address
Diagram
Diagram Branch.tmp#Address_Address_Email_Address_Address_Email_Address_Type Branch.tmp#Address_Address_Email_Address_Address_Email_Address_Seq Branch.tmp#Address_Address_Email_Address_Address_Email_Address_Description
Attributes
QName Type Use
Description restriction of xs:string optional
Seq xs:integer optional
Type restriction of xs:string required
[ top ]
Element Address / Social
Diagram
Diagram Branch.tmp#Address_Address_Social_Address
Instance
 
<Social>
  <Address Description="" Seq="" Type="">{0,unbounded}</Address>
</Social>
[ top ]
Element Address / Social / Address
Diagram
Diagram Branch.tmp#Address_Address_Social_Address_Address_Social_Address_Type Branch.tmp#Address_Address_Social_Address_Address_Social_Address_Seq Branch.tmp#Address_Address_Social_Address_Address_Social_Address_Description
Attributes
QName Type Use
Description restriction of xs:string optional
Seq xs:integer optional
Type restriction of xs:string required
[ top ]
Element Address / Notes
Annotations
 
Address notes – may be used for special purposes such as delivery address notes
Diagram
Diagram
[ top ]
Element Address / TimeZone
Annotations
 
TimeZone Offset. Decimal 9.5 =  “+9:30”        http://wwp.greenwichmeantime.com/info/timezone.htm
Diagram
Diagram
[ top ]
Element Address / TimeZoneName
Annotations
 
Name of Time Zone (Microsoft)
Diagram
Diagram
[ top ]
Element Branch / SalesTaxNumber
Annotations
 
Typically Customers VAT or GST no will display on Invoice.  Could be the same for all branches but allows for each branch to be an individual entity
Diagram
Diagram
[ top ]
Element Errors
Diagram
Diagram Branch.tmp#Errors_Error
Used by
Instance
 
<Errors>
  <Error>{0,unbounded}</Error>
</Errors>
[ top ]
Element Errors / Error
Diagram
Diagram Branch.tmp#Errors_Errors_Error_ErrorCode Branch.tmp#Errors_Errors_Error_ErrorRef Branch.tmp#Errors_Errors_Error_ErrorMsg Branch.tmp#Errors_Errors_Error_AdditionalInfo
Instance
 
<Error>
  <ErrorCode>{1,1}</ErrorCode>
  <ErrorRef>{1,1}</ErrorRef>
  <ErrorMsg>{1,1}</ErrorMsg>
  <AdditionalInfo>{0,1}</AdditionalInfo>
</Error>
[ top ]
Element Errors / Error / ErrorCode
Diagram
Diagram
[ top ]
Element Errors / Error / ErrorRef
Diagram
Diagram
[ top ]
Element Errors / Error / ErrorMsg
Diagram
Diagram
[ top ]
Element Errors / Error / AdditionalInfo
Diagram
Diagram
[ top ]
Element RestrictionList
Diagram
Diagram Branch.tmp#RestrictionList_RestrictionCode
Instance
 
<RestrictionList>
  <RestrictionCode RestrictionType="">{0,unbounded}</RestrictionCode>
</RestrictionList>
[ top ]
Element RestrictionList / RestrictionCode
Diagram
Diagram Branch.tmp#RestrictionList_RestrictionList_RestrictionCode_RestrictionType
Attributes
QName Type Use Annotation
RestrictionType xs:string required 
RestrictTo, Permit, or Deny
[ top ]
Element Attribute
Diagram
Diagram Branch.tmp#Attribute_Deprecated Branch.tmp#Attribute_Scope Branch.tmp#Attribute_EntityCode Branch.tmp#Attribute_Name Branch.tmp#Attribute_Value
Used by
Element Attributes
Instance
 
<Attribute Deprecated="" Scope="">
  <EntityCode>{0,1}</EntityCode>
  <Name>{1,1}</Name>
  <Value DataType="">{0,1}</Value>
</Attribute>
Attributes
QName Type Use Annotation
Deprecated xs:boolean optional
Scope xs:string optional 
Public, Private, Admin : defines the visibility of the attribute within the site.  Default determined by the of Entity type.
[ top ]
Element Attribute / EntityCode
Annotations
 
The code of the entity these attributes belong t  - i.e. ProductItemCode  Field is mandatory if attributes are ssent on a separate file.
Diagram
Diagram
Facets
maxLength 36
[ top ]
Element Attribute / Name
Annotations
 
Name of the Attribute
Diagram
Diagram
[ top ]
Element Attribute / Value
Annotations
 
Value of the Attribute, must be the string representation of the appropriate type
Diagram
Diagram Branch.tmp#Attribute_Attribute_Value_DataType
Attributes
QName Type Use
DataType xs:string optional
[ top ]
Element Attributes
Annotations
 
Deprecated at Entity Level..  Please use the separate AttributeList Load File to load entity specific attributes.
Diagram
Diagram Branch.tmp#Attributes_Version Branch.tmp#Attribute
Instance
 
<Attributes Version="">
  <Attribute Deprecated="" Scope="">{0,unbounded}</Attribute>
</Attributes>
Attributes
QName Type Use
Version xs:decimal optional
[ top ]
Attribute Address / Phone / Number / @Type
Facets
enumeration business
enumeration other
enumeration mobile
enumeration work
enumeration home
Used by
[ top ]
Attribute Address / Phone / Number / @Seq
Used by
[ top ]
Attribute Address / Phone / Number / @Description
Facets
maxLength 25
Used by
[ top ]
Attribute Address / Fax / Number / @Type
Facets
enumeration business
enumeration other
enumeration work
enumeration home
Used by
[ top ]
Attribute Address / Fax / Number / @Seq
Used by
[ top ]
Attribute Address / Fax / Number / @Description
Facets
maxLength 25
Used by
[ top ]
Attribute Address / Email / Address / @Type
Facets
enumeration business
enumeration other
enumeration work
enumeration personal
Used by
[ top ]
Attribute Address / Email / Address / @Seq
Used by
[ top ]
Attribute Address / Email / Address / @Description
Facets
maxLength 100
Used by
[ top ]
Attribute Address / Social / Address / @Type
Facets
enumeration other
enumeration lynkedin
enumeration skype
enumeration im
enumeration twitter
enumeration facebook
enumeration website
Used by
[ top ]
Attribute Address / Social / Address / @Seq
Used by
[ top ]
Attribute Address / Social / Address / @Description
Facets
maxLength 100
Used by
[ top ]
Attribute Address / @Type
Facets
enumeration business
enumeration other
enumeration physical
enumeration postal
enumeration delivery
enumeration home
enumeration work
Used by
Element Address
[ top ]
Attribute Address / @Version
Used by
Element Address
[ top ]
Attribute Branch / @Version
Used by
Element Branch
[ top ]
Attribute Branch / @Deprecated
Used by
Element Branch
[ top ]
Attribute Branches / @Version
Used by
Element Branches
[ top ]
Attribute CommonAttributes / @Culture
Used by
Attribute Group CommonAttributes
[ top ]
Attribute CommonAttributes / @Version
Used by
Attribute Group CommonAttributes
[ top ]
Attribute CommonAttributes / @LoadType
Annotations
 
FULL, FULLBranch, or PARTIAL
Note: partial loads require each record to explicitly declare if it is deprecated or not.  Full loads assume anything not in the load is deprecated.
Used by
Attribute Group CommonAttributes
[ top ]
Attribute CommonAttributes / @LoadFilter
Annotations
 
LoadFilter must indicate the Entity Type.  Only one Entity Type per file is allowed. i.e. “Product”
Used by
Attribute Group CommonAttributes
[ top ]
Attribute CommonAttributes / @TransactionID
Used by
Attribute Group CommonAttributes
[ top ]
Attribute CommonAttributes / @StartTime
Used by
Attribute Group CommonAttributes
[ top ]
Attribute CommonAttributes / @EndTime
Used by
Attribute Group CommonAttributes
[ top ]
Attribute CommonAttributes / @SiteID
Used by
Attribute Group CommonAttributes
[ top ]
Attribute CommonAttributes / @StatusID
Used by
Attribute Group CommonAttributes
[ top ]
Attribute CommonAttributes / @ErrorCount
Used by
Attribute Group CommonAttributes
[ top ]
Attribute CommonAttributes / @Transformed
Used by
Attribute Group CommonAttributes
[ top ]
Attribute RestrictionList / RestrictionCode / @RestrictionType
Annotations
 
RestrictTo, Permit, or Deny
Used by
[ top ]
Attribute Attribute / Value / @DataType
Used by
Element Attribute/Value
[ top ]
Attribute Attribute / @Deprecated
Used by
Element Attribute
[ top ]
Attribute Attribute / @Scope
Annotations
 
Public, Private, Admin : defines the visibility of the attribute within the site.  Default determined by the of Entity type.
Used by
Element Attribute
[ top ]
Attribute Attributes / @Version
Used by
Element Attributes
[ top ]
Attribute Group CommonAttributes
Diagram
Diagram Branch.tmp#CommonAttributes_Culture Branch.tmp#CommonAttributes_Version Branch.tmp#CommonAttributes_LoadType Branch.tmp#CommonAttributes_LoadFilter Branch.tmp#CommonAttributes_TransactionID Branch.tmp#CommonAttributes_StartTime Branch.tmp#CommonAttributes_EndTime Branch.tmp#CommonAttributes_SiteID Branch.tmp#CommonAttributes_StatusID Branch.tmp#CommonAttributes_ErrorCount Branch.tmp#CommonAttributes_Transformed
Used by
Attributes
QName Type Default Use Annotation
Culture xs:string en optional
EndTime xs:dateTime optional
ErrorCount xs:integer 0 optional
LoadFilter xs:string optional 
LoadFilter must indicate the Entity Type.  Only one Entity Type per file is allowed. i.e. “Product”
LoadType xs:string required 
FULL, FULLBranch, or PARTIAL
Note: partial loads require each record to explicitly declare if it is deprecated or not.  Full loads assume anything not in the load is deprecated.
SiteID xs:string optional
StartTime xs:dateTime optional
StatusID xs:integer optional
TransactionID xs:string optional
Transformed xs:boolean false optional
Version xs:decimal required
[ top ]
XML Schema documentation generated by ® XML Editor.