AVEVA AIM Workhub XML Schema Reference

Note: IDs must not contain any of the following characters: left brace ({), right brace (}), vertical bar (|).

This example defines the SI system of units of measure (UOM), and also defines the two UOM classes – one for Metre (m) and another for Centimetre (cm).

Measure classes are defined as given in this snippet:

<MeasureClass>
<ClassID>Length Measure</ClassID>
<ClassName>Length Measure</ClassName>
<Definition>Length Measure</Definition>
<UnitOfMeasure>
<UOMClassID>Metre</UOMClassID>
</UnitOfMeasure>
<UnitOfMeasure>
<UOMClassID>Centimetre</UOMClassID>
<Scale>0.01</Scale>
</UnitOfMeasure>
</MeasureClass>

Here, a Length Measure is defined with its base UOM as Metre and another UOM of Centimetre.

Note: The Scale factor converts Centimetre to the base unit Metre.

Following is the definition of a PropertyClass that makes use of a UOM:

<PropertyClass>
<ClassID>LENGTH</ClassID>
<ParentClassID>PHYSICAL PROPERTY</ParentClassID>
<ClassName>Length</ClassName>
<Definition>Length</Definition>
<MeasureClassID>Length Measure</MeasureClassID>
</PropertyClass>

To import an Object that uses this Property
<Object>
<ID>TestObject02</ID>
<Context>
<ID>IPE</ID>
</Context>
<Property>
<Name>LENGTH</Name>
<Value>10</Value>
<Units>cm</Units>
</Property>
</Object>

A Property can be provided with an empty <Units/> element (or <Units></Units>). If Units are not provided, then the Property will not gain the Base Unit, but will be set to Null. If a Characteristic is supplied for an attribute that is actually a Property, then it will gain the Base Unit for the Property. EIA SearchResults will return an empty <Units/> element for Properties that have null Units to match the EIWM schema.

The EIWM allows for the creation of Rights and the assignment of those Rights to appropriate Roles and Persons.

The following is an EIWM example of creating a Right:

<?xml version="1.0" encoding="UTF-8" ?>
<?vnet xslt="NULL" ?>
<vl:VNETList xmlns:vl="http://www.aveva.com/VNET/List" xmlns="http://www.aveva.com/VNET/eiwm">
<Right>
<Name>NewRight</Name>
</Right>
</vl:VNETList>

The following is an EIWM example of assigning a Right to a Person and a Role:

<?xml version="1.0" encoding="UTF-8" ?>
<?vnet xslt="NULL" ?>
<vl:VNETList xmlns:vl="http://www.aveva.com/VNET/List" xmlns="http://www.aveva.com/VNET/eiwm">
<Template>
<ID>BootStrapSampleUsers.xml::template</ID>
<Object>
<ID>AVEVA\Person1</ID>
<ClassID>PERSON</ClassID>
<Association type="has right">
<Right>
<Name>NewRight</Name>
</Right>
</Association>
</Object>
<Object>
<ID>Default User</ID>
<ClassID>ROLE</ClassID>
<Association type="has right">
<Right>
<Name>NewRight</Name>
</Right>
</Association>
</Object>
</Template>
</vl:VNETList>

Rights can be assigned to either Roles or Persons with the following conditions:

• Right should be existing before assigning it to a Role or a Person. If it is not existing, then Import Controller displays the message: Right not assigned - no such Right '<name of the right>'

• Associating any object other than Role or Person to the Right is not permissible. If the Administrator tries to assign any other object apart from Role or Person to a new or existing Right, the following message is shown to the user while importing the XML: Cannot assign '<name of the right>' right to '<name of the object>' object. Rights can be assigned only to persons and roles.

• Rights cannot be deleted if there are some references still existing. Only the unreferenced rights are deleted and then the Import Controller displays messages like this for each existing referenced rights: Right '<name of the right>' not deleted as it is still referenced.