XML schema for assets

The following sections contain the 5.2.0.4, 5.2.0.5, and 5.2.0.6 versions of the schema for assets.

Assets schema for V5.2.0.4

<?xml version="1.0" encoding="UTF-8"?>
<!--
/* 
 * Licensed Materials - Property of Veolia Environment-VE and IBM
 *
 * 5725-D69
 *
 * © Copyright Veolia Environment-VE 2017.
 * © Copyright International Business Machines Corporation 2015, 2017. 
 *
 * For IBM Corporation provided versions, releases and modifications: US Government Users
 * Restricted Rights - Use, duplication or disclosure restricted by GSA ADP Schedule Contract
 * with IBM Corporation.
 */
 -->
<xsd:schema targetNamespace="http://vds.com/assetTypes"
	xmlns:asset="http://vds.com/assetTypes" 
	xmlns:xsd="http://www.w3.org/2001/XMLSchema"
	elementFormDefault="qualified">
   <xsd:complexType name="modelrefType">
      <xsd:annotation>
	   <xsd:documentation>modelref will refer to the ID of the semantic
		model for a multi tenant environment.
		If the id attribute of
		modelref is empty all the request will
		executed played against
		the default
		model. </xsd:documentation>
	</xsd:annotation>
	<xsd:sequence>
	   <xsd:element maxOccurs="unbounded" name="request" type="asset:requestType" />
	</xsd:sequence>
	<xsd:attribute name="id" type="xsd:string" />
   </xsd:complexType>
   <xsd:complexType name="relationType">
      <xsd:annotation>
         <xsd:documentation>
			RelationType is made to describe relations between assets.
	  </xsd:documentation>
      </xsd:annotation>
	<xsd:attribute name="relationName" type="xsd:string" />
	<xsd:attribute name="targetExtWorkEquipmentType" type="xsd:string" />
	<xsd:attribute name="targetExtWorkEquipmentId" type="xsd:string" />
   </xsd:complexType>
   <xsd:complexType name="relationsType">
      <xsd:sequence>
	   <xsd:element maxOccurs="unbounded" minOccurs="1" name="relation" 
                                 type="asset:relationType" />
	</xsd:sequence>
   </xsd:complexType>
   <xsd:complexType name="thresholdType">
      <xsd:attribute name="range" type="xsd:string" />
      <xsd:attribute name="level" type="xsd:string" />
   </xsd:complexType>
   <xsd:complexType name="measureTypeType">
      <xsd:sequence>
	  <xsd:element minOccurs="0" maxOccurs="3" name="threshold" type="asset:thresholdType" />
	</xsd:sequence>
	<xsd:attribute name="unit" type="xsd:string" />
	<xsd:attribute name="no_reading_timeout" type="xsd:string" />
	<xsd:attribute name="name" type="xsd:string" />
	<xsd:attribute name="measureLabel" type="xsd:string" />
	<xsd:attribute name="isPrimaryMeasurement" type="xsd:string" />
   </xsd:complexType>
   <xsd:complexType name="measureTypesType">
      <xsd:sequence>
	  <xsd:element minOccurs="1" maxOccurs="unbounded" name="measureType"
				type="asset:measureTypeType" />
	</xsd:sequence>
   </xsd:complexType>
   <xsd:complexType name="attributeType">
      <xsd:sequence>
	  <xsd:element minOccurs="0" maxOccurs="1" name="value"
				type="xsd:string" />
	  <xsd:element minOccurs="0" maxOccurs="1" name="unit"
				type="xsd:string" />
	</xsd:sequence>
	   <xsd:attribute name="type" type="xsd:string" />
	   <xsd:attribute name="name" type="xsd:string" />
	</xsd:complexType>
	<xsd:complexType name="assetType">
	   <xsd:annotation>
	      <xsd:documentation>
			AssetType is to describe the asset to create/update/delete.
		</xsd:documentation>
	   </xsd:annotation>
         <xsd:sequence>
	     <xsd:element minOccurs="1" maxOccurs="1" name="internalLocation" type="xsd:string" />
	     <xsd:element minOccurs="0" maxOccurs="1" name="relations" type="asset:relationsType" />
	     <xsd:element minOccurs="0" maxOccurs="unbounded" name="attribute" type="asset:attributeType" />
	     <xsd:element minOccurs="0" maxOccurs="1" name="measureTypes" type="asset:measureTypesType" />
	   </xsd:sequence>
	   <xsd:attribute name="extWorkEquipmentType" type="xsd:string" />
	   <xsd:attribute name="extWorkEquipmentId" type="xsd:string" />
	   <xsd:attribute name="assetLabel" type="xsd:string" />
	   <xsd:attribute name="assetDescription" type="xsd:string" />
	   <xsd:attribute name="tenantId" type="xsd:string" />
	</xsd:complexType>
	<xsd:complexType name="requestType">
	   <xsd:annotation>
		<xsd:documentation>
				Request is the actual operation that will
				be executed. It captures the following informations :
				- request type :
				CREATE / UPDATE / DELETE
				- Assets data (attributes, relations etc...)
				the request type must be one of the following :
				- INSERT : create an asset.
				- DELETE : delete an asset.
				- UPDATE : update an asset.
		</xsd:documentation>
	   </xsd:annotation>
	   <xsd:sequence>
		<xsd:element maxOccurs="unbounded" name="asset" type="asset:assetType" />
	   </xsd:sequence>
	   <xsd:attribute name="type" type="xsd:string" />
	</xsd:complexType>
	<xsd:element name="operation">
	   <xsd:annotation>
		<xsd:documentation>
				Operation is the root element of the xml file. It
				will contain all the requests.
				rootTenant : root tenant for the ingested data.
				timestamp : xml file generation date.
		</xsd:documentation>
	   </xsd:annotation>
	<xsd:complexType>
	   <xsd:sequence>
	      <xsd:element maxOccurs="unbounded" name="modelref" type="asset:modelrefType" />
	   </xsd:sequence>
	   <xsd:attribute name="rootTenant" type="xsd:string" />
	   <xsd:attribute name="timestamp" type="xsd:string" />
	   <xsd:attribute name="timeout" type="xsd:string" />
	   <xsd:attribute name="timeoutTypeId" type="xsd:string" />
	</xsd:complexType>
   </xsd:element>
</xsd:schema>

 
 

Assets schema for V5.2.0.5

<?xml version="1.0" encoding="UTF-8"?>
<!--
/* 
 * Licensed Materials - Property of Veolia Environment-VE and IBM
 *
 * 5725-D69
 *
 * © Copyright Veolia Environment-VE 2017.
 * © Copyright International Business Machines Corporation 2015, 2017. 
 *
 * For IBM Corporation provided versions, releases and modifications: US Government Users
 * Restricted Rights - Use, duplication or disclosure restricted by GSA ADP Schedule Contract
 * with IBM Corporation.
 */
 -->
<xsd:schema targetNamespace="http://vds.com/assetTypes"
	xmlns:asset="http://vds.com/assetTypes" 
	xmlns:xsd="http://www.w3.org/2001/XMLSchema"
	elementFormDefault="qualified">
   <xsd:complexType name="modelrefType">
      <xsd:annotation>
	   <xsd:documentation>modelref will refer to the ID of the semantic
		model for a multi tenant environment.
		If the id attribute of
		modelref is empty all the request will
		executed played against
		the default
		model. </xsd:documentation>
	</xsd:annotation>
	<xsd:sequence>
	   <xsd:element maxOccurs="unbounded" name="request" type="asset:requestType" />
	</xsd:sequence>
	<xsd:attribute name="id" type="xsd:string" />
   </xsd:complexType>
   <xsd:complexType name="relationType">
      <xsd:annotation>
         <xsd:documentation>
			RelationType is made to describe relations between assets.
	  </xsd:documentation>
      </xsd:annotation>
	<xsd:attribute name="relationName" type="xsd:string" />
	<xsd:attribute name="targetExtWorkEquipmentType" type="xsd:string" />
	<xsd:attribute name="targetExtWorkEquipmentId" type="xsd:string" />
   </xsd:complexType>
   <xsd:complexType name="relationsType">
      <xsd:sequence>
	   <xsd:element maxOccurs="unbounded" minOccurs="1" name="relation" 
                                 type="asset:relationType" />
	</xsd:sequence>
   </xsd:complexType>
   <xsd:complexType name="thresholdType">
      <xsd:attribute name="range" type="xsd:string" />
      <xsd:attribute name="level" type="xsd:string" />
   </xsd:complexType>
   <xsd:complexType name="measureTypeType">
      <xsd:sequence>
	  <xsd:element minOccurs="0" name="threshold" type="asset:thresholdType" /> 
	</xsd:sequence>
	<xsd:attribute name="unit" type="xsd:string" />
	<xsd:attribute name="no_reading_timeout" type="xsd:string" />
	<xsd:attribute name="name" type="xsd:string" />
	<xsd:attribute name="measureLabel" type="xsd:string" />
	<xsd:attribute name="isPrimaryMeasurement" type="xsd:string" />
   </xsd:complexType>
   <xsd:complexType name="measureTypesType">
      <xsd:sequence>
	  <xsd:element minOccurs="1" maxOccurs="unbounded" name="measureType"
				type="asset:measureTypeType" />
	</xsd:sequence>
   </xsd:complexType>
   <xsd:complexType name="attributeType">
      <xsd:sequence>
	  <xsd:element minOccurs="0" maxOccurs="1" name="value"
				type="xsd:string" />
	  <xsd:element minOccurs="0" maxOccurs="1" name="unit"
				type="xsd:string" />
	</xsd:sequence>
	   <xsd:attribute name="type" type="xsd:string" />
	   <xsd:attribute name="name" type="xsd:string" />
	</xsd:complexType>
	<xsd:complexType name="assetType">
	   <xsd:annotation>
	      <xsd:documentation>
			AssetType is to describe the asset to create/update/delete.
		</xsd:documentation>
	   </xsd:annotation>
         <xsd:sequence>
	     <xsd:element minOccurs="1" maxOccurs="1" name="internalLocation" type="xsd:string" />
	     <xsd:element minOccurs="0" maxOccurs="1" name="relations" type="asset:relationsType" />
	     <xsd:element minOccurs="0" maxOccurs="unbounded" name="attribute" type="asset:attributeType" />
	     <xsd:element minOccurs="0" name="measureTypes" type="asset:measureTypesType" /> 
	   </xsd:sequence>
	   <xsd:attribute name="extWorkEquipmentType" type="xsd:string" />
	   <xsd:attribute name="extWorkEquipmentId" type="xsd:string" />
	   <xsd:attribute name="assetLabel" type="xsd:string" />
	   <xsd:attribute name="assetDescription" type="xsd:string" />
	   <xsd:attribute name="tenantId" type="xsd:string" />
	</xsd:complexType>
	<xsd:complexType name="requestType">
	   <xsd:annotation>
		<xsd:documentation>
				Request is the actual operation that will
				be executed. It captures the following informations :
				- request type :
				CREATE / UPDATE / DELETE
				- Assets data (attributes, relations etc...)
				the request type must be one of the following :
				- INSERT : create an asset.
				- DELETE : delete an asset.
				- UPDATE : update an asset.
		</xsd:documentation>
	   </xsd:annotation>
	   <xsd:sequence>
		<xsd:element maxOccurs="unbounded" name="asset" type="asset:assetType" />
	   </xsd:sequence>
	   <xsd:attribute name="type" type="xsd:string" />
	</xsd:complexType>
	<xsd:element name="operation">
	   <xsd:annotation>
		<xsd:documentation>
				Operation is the root element of the xml file. It
				will contain all the requests.
				rootTenant : root tenant for the ingested data.
				timestamp : xml file generation date.
		</xsd:documentation>
	   </xsd:annotation>
	<xsd:complexType>
	   <xsd:sequence>
	      <xsd:element maxOccurs="unbounded" name="modelref" type="asset:modelrefType" />
	   </xsd:sequence>
	   <xsd:attribute name="rootTenant" type="xsd:string" />
	   <xsd:attribute name="flowSource" type="xsd:string" />
         <xsd:attribute name="timestamp" type="xsd:string" />
	   <xsd:attribute name="timeout" type="xsd:string" />
	   <xsd:attribute name="timeoutTypeId" type="xsd:string" />
	</xsd:complexType>
   </xsd:element>
</xsd:schema>

 
 

Assets schema for V5.2.0.6

<?xml version="1.0" encoding="UTF-8"?>
<!--
/* 
 * Licensed Materials - Property of Veolia Environment-VE and IBM
 *
 * 5725-D69
 *
 * © Copyright Veolia Environment-VE 2017, 2018.
 * © Copyright International Business Machines Corporation 2015, 2018. 
 *
 * For IBM Corporation provided versions, releases and modifications: US Government Users
 * Restricted Rights - Use, duplication or disclosure restricted by GSA ADP Schedule Contract
 * with IBM Corporation.
 */
 -->
<xsd:schema targetNamespace="http://vds.com/assetTypes"
	xmlns:asset="http://vds.com/assetTypes" 
	xmlns:xsd="http://www.w3.org/2001/XMLSchema"
	elementFormDefault="qualified">
   <xsd:complexType name="modelrefType">
      <xsd:annotation>
	   <xsd:documentation>modelref will refer to the ID of the semantic
		model for a multi tenant environment.
		If the id attribute of
		modelref is empty all the requests will
		be executed against the default model. </xsd:documentation>
	</xsd:annotation>
	<xsd:sequence>
	   <xsd:element maxOccurs="unbounded" name="request" type="asset:requestType" />
	</xsd:sequence>
	<xsd:attribute name="id" type="xsd:string" />
   </xsd:complexType>
   <xsd:complexType name="relationType">
      <xsd:annotation>
         <xsd:documentation>
			RelationType describes relationships between assets.
	  </xsd:documentation>
      </xsd:annotation>
	<xsd:attribute name="relationName" type="xsd:string" />
	<xsd:attribute name="targetExtWorkEquipmentType" type="xsd:string" />
	<xsd:attribute name="targetExtWorkEquipmentId" type="xsd:string" />
   </xsd:complexType>
   <xsd:complexType name="relationsType">
      <xsd:sequence>
	   <xsd:element maxOccurs="unbounded" minOccurs="1" name="relation" 
                                 type="asset:relationType" />
	</xsd:sequence>
   </xsd:complexType>
   <xsd:complexType name="thresholdType">
      <xsd:attribute name="range" type="xsd:string" />
      <xsd:attribute name="level" type="xsd:string" />
   </xsd:complexType>
   <xsd:complexType name="measureTypeType">
      <xsd:sequence>
	  <xsd:element minOccurs="0" maxOccurs="unbounded" name="threshold" type="asset:thresholdType" />
	</xsd:sequence>
	<xsd:attribute name="unit" type="xsd:string" />
	<xsd:attribute name="no_reading_timeout" type="xsd:string" />
	<xsd:attribute name="name" type="xsd:string" />
	<xsd:attribute name="measureLabel" type="xsd:string" />
	<xsd:attribute name="isPrimaryMeasurement" type="xsd:string" />
   </xsd:complexType>
   <xsd:complexType name="measureTypesType">
      <xsd:sequence>
	  <xsd:element minOccurs="1" maxOccurs="unbounded" name="measureType"
				type="asset:measureTypeType" />
	</xsd:sequence>
   </xsd:complexType>
   <xsd:complexType name="attributeType">
      <xsd:sequence>
	  <xsd:element minOccurs="0" maxOccurs="1" name="value"
				type="xsd:string" />
	  <xsd:element minOccurs="0" maxOccurs="1" name="unit"
				type="xsd:string" />
	</xsd:sequence>
	   <xsd:attribute name="type" type="xsd:string" />
	   <xsd:attribute name="name" type="xsd:string" />
	</xsd:complexType>
	<xsd:complexType name="assetType">
	   <xsd:annotation>
	      <xsd:documentation>
			AssetType describes the asset to create/update/delete.
		</xsd:documentation>
	   </xsd:annotation>
         <xsd:sequence>
	     <xsd:element minOccurs="1" maxOccurs="1" name="internalLocation" type="xsd:string" />
	     <xsd:element minOccurs="0" maxOccurs="1" name="relations" type="asset:relationsType" />
	     <xsd:element minOccurs="0" maxOccurs="unbounded" name="attribute" type="asset:attributeType" />
	     <xsd:element minOccurs="0" name="measureTypes" type="asset:measureTypesType" />
	   </xsd:sequence>
	   <xsd:attribute name="extWorkEquipmentType" type="xsd:string" />
	   <xsd:attribute name="extWorkEquipmentId" type="xsd:string" />
	   <xsd:attribute name="assetLabel" type="xsd:string" />
	   <xsd:attribute name="assetDescription" type="xsd:string" />
	   <xsd:attribute name="tenantId" type="xsd:string" />
	</xsd:complexType>
	<xsd:complexType name="requestType">
	   <xsd:annotation>
		<xsd:documentation>
				Request is the actual operation that will
				be executed. It captures the following informations :
				- request type :
				CREATE / UPDATE / DELETE
				- Assets data (attributes, relations etc...)
				the request type must be one of the following :
				- INSERT : create an asset.
				- DELETE : delete an asset.
				- UPDATE : update an asset.
		</xsd:documentation>
	   </xsd:annotation>
	   <xsd:sequence>
		<xsd:element maxOccurs="unbounded" name="asset" type="asset:assetType" />
	   </xsd:sequence>
	   <xsd:attribute name="type" type="xsd:string" />
	</xsd:complexType>
	<xsd:element name="operation">
	   <xsd:annotation>
		<xsd:documentation>
				Operation is the root element of the xml file. It
				will contain all the requests.
				rootTenant : root tenant for the ingested data.
				timestamp : xml file generation date.
		</xsd:documentation>
	   </xsd:annotation>
	<xsd:complexType>
	   <xsd:sequence>
	      <xsd:element maxOccurs="unbounded" name="modelref" type="asset:modelrefType" />
	   </xsd:sequence>
	   <xsd:attribute name="rootTenant" type="xsd:string" />
         <xsd:attribute name="flowSource" type="xsd:string" />
	   <xsd:attribute name="timestamp" type="xsd:string" />
	   <xsd:attribute name="timeout" type="xsd:string" />
	   <xsd:attribute name="timeoutTypeId" type="xsd:string" />
	</xsd:complexType>
   </xsd:element>
</xsd:schema>