Hierarchy Developer's Guide for Oracle Self-Service E-Billing > Hierarchy Manager XML Exchange Schema >

XML Exchange Schema file Contents

The contents of the XML Exchange Schema file are:

<?xml version="1.0"?>

<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" version="1.0">

<xs:annotation>

<xs:documentation>

This file contains the XML schema definition that edocs hierarchy module

uses for interchanging hierarchical business structures.

Do not modify this file for deployment specific requirements.

Any deployment specific information should be made in the

instance-hierarchy-interchange-1.0.xsd schema definition file.

</xs:documentation>

</xs:annotation>

<xs:include schemaLocation="instance-hierarchy-interchange-1.0.xsd">

<xs:annotation>

<xs:documentation>

Includes the document containing instance/deployment specific schema details.

</xs:documentation>

</xs:annotation>

</xs:include>

<xs:element name="ListOfHierarchies">

<xs:complexType>

<xs:sequence>

<xs:element name="DeltaHierarchy" minOccurs="0">

<xs:complexType>

<xs:sequence>

<xs:element name="Move" maxOccurs="unbounded" minOccurs="0">

<xs:complexType>

<xs:all>

<xs:element name="SrcHierarchy" type="HierarchyDef"/>

<xs:element name="SrcNode" type="DeltaNodeDef"/>

<xs:element name="DestHierarchy" type="HierarchyDef"/>

<xs:element name="DestNode" type="DeltaNodeDef"/>

</xs:all>

</xs:complexType>

</xs:element>

<xs:element name="Add" maxOccurs="unbounded" minOccurs="0">

<xs:complexType>

<xs:all>

<xs:element name="SrcNode" type="DeltaNodeDef"/>

<xs:element name="DestHierarchy" type="HierarchyDef"/>

<xs:element name="DestNode" type="DeltaNodeDef"/>

</xs:all>

</xs:complexType>

</xs:element>

<xs:element name="Delete" maxOccurs="unbounded" minOccurs="0">

<xs:complexType>

<xs:all>

<xs:element name="SrcNode" type="DeltaNodeDef"/>

<xs:element name="DestHierarchy" type="HierarchyDef"/>

</xs:all>

</xs:complexType>

</xs:element>

</xs:sequence>

</xs:complexType>

</xs:element>

<xs:element name="CompleteHierarchy" type="Hierarchy" minOccurs="0" maxOccurs="unbounded"/>

</xs:sequence>

</xs:complexType>

</xs:element>

<xs:complexType name="DeltaNodeDef">

<xs:sequence>

<xs:element name="BusinessObject" type="BusinessObjectType"/>

</xs:sequence>

</xs:complexType>

<xs:complexType name="Hierarchy">

<xs:annotation>

<xs:documentation>

Always the hierarchy will be created using the user given name,

and the name in the XML file will be ignored.

</xs:documentation>

</xs:annotation>

<xs:sequence>

<xs:element name="AcceptableBusinessObjectTypes" type="AcceptableBusinessObject" minOccurs="0"/>

<xs:element name="RootNode" type="HierarchyNode"/>

</xs:sequence>

<xs:attributeGroup ref="HierarchyAttrs"/>

</xs:complexType>

<xs:complexType name="AcceptableBusinessObject">

<xs:annotation>

<xs:documentation>

A list of xml tag names of acceptable business object types to be

considered when importing a hierarchy.

If there were any tags which were not specified here in the XML file,

then those and their child nodes will be ignored.

When overriding an existing hierarchy, any nodes with any other

type than specified here will be unaltered by the import process.

If this section is not present then the content of the whole XML file will be imported.

</xs:documentation>

</xs:annotation>

<xs:sequence maxOccurs="unbounded">

<xs:element name="tagName" type="xs:string"/>

</xs:sequence>

</xs:complexType>

<xs:attributeGroup name="HierarchyAttrs">

<xs:attribute name="domainID" type="xs:string" use="optional">

<xs:annotation>

<xs:documentation>

When the domain ID is not available, user's domain ID will be used.

</xs:documentation>

</xs:annotation>

</xs:attribute>

<xs:attribute name="type" type="HierarchyType" use="optional">

<xs:annotation>

<xs:documentation>

When the hierarchy type is not available, user's default hierarchy type will be used

which be set by the importer/exporter hooks.

</xs:documentation>

</xs:annotation>

</xs:attribute>

<xs:attribute name="name" type="xs:string" use="required"/>

<xs:attribute name="displayName" type="xs:string" use="optional">

<xs:annotation>

<xs:documentation>

When the display name is not available, name will be used.

</xs:documentation>

</xs:annotation>

</xs:attribute>

<xs:attribute name="period" type="xs:date" use="optional">

<xs:annotation>

<xs:documentation>

Period is optional and will be ignored for the first release.

</xs:documentation>

</xs:annotation>

</xs:attribute>

</xs:attributeGroup>

<xs:complexType name="NodeList">

<xs:sequence maxOccurs="unbounded">

<xs:element name="Node" type="HierarchyNode"/>

</xs:sequence>

</xs:complexType>

<xs:complexType name="AccessDef">

<xs:sequence>

<xs:element name="userId" type="xs:string" maxOccurs="unbounded"/>

</xs:sequence>

</xs:complexType>

<xs:complexType name="HierarchyNode">

<xs:sequence>

<xs:element name="BusinessObject" type="BusinessObjectType"/>

<xs:element name="CanBeAccessedBy" type="AccessDef" minOccurs="0"/>

<xs:element name="ChildNodeList" type="NodeList" minOccurs="0"/>

</xs:sequence>

</xs:complexType>

<xs:complexType name="FolderDef">

<xs:annotation>

<xs:documentation>

Folder is the default business object type.

</xs:documentation>

</xs:annotation>

<xs:all>

<xs:element name="Description" type="xs:string" minOccurs="0"/>

<xs:element name="AttributeList" minOccurs="0">

<xs:complexType>

<xs:sequence>

<xs:element name="Attribute" minOccurs="0" maxOccurs="unbounded">

<xs:complexType>

<xs:attribute name="name" type="xs:string"/>

<xs:attribute name="value" type="xs:string"/>

</xs:complexType>

</xs:element>

</xs:sequence>

</xs:complexType>

</xs:element>

</xs:all>

<xs:attribute name="name" type="xs:string"/>

<xs:attribute name="externalID" type="xs:string"/>

</xs:complexType>

<xs:complexType name="ServiceAgreementDef">

<xs:sequence>

<xs:element name="ExtAttr1" type="xs:string" minOccurs="0"/>

<xs:element name="ExtAttr2" type="xs:string" minOccurs="0"/>

<xs:element name="ExtAttr3" type="xs:string" minOccurs="0"/>

<xs:element name="ExtAttr4" type="xs:string" minOccurs="0"/>

<xs:element name="ExtAttr5" type="xs:string" minOccurs="0"/>

</xs:sequence>

<xs:attribute name="serviceNo" use="required">

<xs:simpleType>

<xs:restriction base="xs:string">

<xs:minLength value="1"/>

<xs:maxLength value="255"/>

</xs:restriction>

</xs:simpleType>

</xs:attribute>

<xs:attribute name="accountNo" use="optional">

<xs:simpleType>

<xs:restriction base="xs:string">

<xs:minLength value="1"/>

<xs:maxLength value="255"/>

</xs:restriction>

</xs:simpleType>

</xs:attribute>

<xs:attribute name="billerId" use="optional">

<xs:simpleType>

<xs:restriction base="xs:string">

<xs:minLength value="1"/>

<xs:maxLength value="255"/>

</xs:restriction>

</xs:simpleType>

</xs:attribute>

</xs:complexType>

<xs:complexType name="ServiceChargeDef">

<xs:attribute name="serviceNo" use="required">

<xs:simpleType>

<xs:restriction base="xs:string">

<xs:minLength value="1"/>

<xs:maxLength value="255"/>

</xs:restriction>

</xs:simpleType>

</xs:attribute>

<xs:attribute name="accountNo" type="xs:string"/>

<xs:attribute name="billerId" type="xs:string"/>

<xs:attribute name="chargeType" use="required">

<xs:simpleType>

<xs:restriction base="xs:string">

<xs:minLength value="1"/>

<xs:maxLength value="32"/>

</xs:restriction>

</xs:simpleType>

</xs:attribute>

</xs:complexType>

<xs:complexType name="CompanyDef">

<xs:attribute name="fiscalCode" type="xs:string"/>

<xs:attribute name="companyTitle" type="xs:string"/>

</xs:complexType>

<xs:complexType name="HierarchyDef">

<xs:attributeGroup ref="HierarchyAttrs"/>

</xs:complexType>

<xs:complexType name="AccountDef">

<xs:attribute name="accountNo" use="required">

<xs:simpleType>

<xs:restriction base="xs:string"><xs:minLength value="1"/>

<xs:maxLength value="255"/>

</xs:restriction>

</xs:simpleType>

</xs:attribute>

<xs:attribute name="billerId" use="optional">

<xs:simpleType>

<xs:restriction base="xs:string">

<xs:minLength value="1"/>

<xs:maxLength value="255"/>

</xs:restriction>

</xs:simpleType>

</xs:attribute>

</xs:complexType>

<xs:complexType name="BusinessObjectType">

<xs:choice>

<xs:group ref="DeploymentSpecificBusinessObjectType"/>

<xs:element name="Folder" type="FolderDef"/>

<xs:element name="ServiceAgreement" type="ServiceAgreementDef"/>

<xs:element name="ServiceCharge" type="ServiceChargeDef"/>

<xs:element name="Company" type="CompanyDef"/>

<xs:element name="Account" type="AccountDef"/>

</xs:choice>

</xs:complexType>

</xs:schema>