Importing and exporting XML files

Commands used to import and export XML files

Objecteering Scope Manager provides the following commands to work with XML files:

· the "Scope Manager/Import XML file" command

· the "Scope Manager/Export to XML file" command

· the "Scope Manager/Export whole project to XML file" command

The "Import XML file" command

The "Import XML file" command is used to import the elements contained in the specified XML file into the element on which the command is being run.

This command can only be run on requirement containers, goal container, business rule containers and dictionaries.

To run this command, simply carry out the steps shown below.

Running the "Scope Manager/Import XML file" command

Steps:

1. In the or tab of the explorer, right-click on the requirement container, goal container, business rule container or dictionary into which you wish to import the contents of the XML file. A context menu then appears.

2. From the context menu, run the "Scope Manager/Import XML file..." command. The "Import XML file" window then appears.

3. In this window, in the "Look in" field, select the location of the XML file you are going to import.

4. Select the XML file you wish to import.

5. Click on "Open" to confirm.

The contents of the XML file are then imported into the element you selected.

The "Export to XML file" command

The "Export to XML file" command is used to export an element and the elements contained within this element into an XML file. This XML file will then be available for future XML file import operations.

This command can only be run on requirement containers, goal containers, business rule containers or dictionaries.

To run this command, simply carry out the steps shown below.

Running the "Export to XML file" command

Steps:

1. In the or tab of the explorer, right-click on the requirement container, goal container, business rule container or dictionary which you wish to export into an XML file. A context menu then appears.

2. From the context menu, run the "Scope Manager/Export to XML file..." command. The "Export to XML file" window then appears.

3. In this window, select the location where the XML file into which you wish to export your element will be located.

4. Click on "OK" to confirm.

The element selected and all its contents are then exported into the XML file indicated.

The "Export whole project to XML file" command

The "Export whole project to XML file" command is similar to the "Export to XML file" command, in so far as it exports elements to an indicated XML file. However, in the case of the "Export whole project to XML file" command, the entire project is exported into the XML file, and not simply certain elements.

DTD used in the import and export of requirements

The DTD used in the import and export of requirements to and from outside sources is notably used when generating an XML file after marking a Word document (for more details on using Word with Objecteering Scope Manager, please see "Introduction to using Word with Objecteering Scope Manager").

DTD structure

The following is the DTD used in the import/export of Scope elements.

<?xml version="1.0" encoding="UTF-8"?>

<!--

***********************************************

** XML Requirement exchange DTD **

***********************************************

-->

<!ELEMENT ObjecteeringRequirementsModel (Info*, RootPropertySet, RequirementContainer?, Dictionary?, Info*)>

<!ATTLIST ObjecteeringRequirementsModel

Origin CDATA #REQUIRED

<!ELEMENT RootPropertySet (PropertySet*, RootEnumeration)>

<!ELEMENT PropertySet (Info*, Description?, Property*)>

<!ATTLIST PropertySet

ID ID #REQUIRED

Name CDATA #REQUIRED

<!ELEMENT Property (Info*, Description?)>

<!ATTLIST Property

ID ID #REQUIRED

Name CDATA #REQUIRED

DefaultValue CDATA #IMPLIED

EnumerationTypeID IDREF #IMPLIED

isEditable (true | false) #IMPLIED

applicableFor (Containers | Requirements | ContainersAndRequirements) #IMPLIED

<!ELEMENT Description (#PCDATA)>

<!ELEMENT Info (#PCDATA)>

<!ATTLIST Info

Vendor CDATA #REQUIRED

Key CDATA #REQUIRED

Value CDATA #IMPLIED

<!ELEMENT RootEnumeration (Enumeration*)>

<!ELEMENT Enumeration (Description?, (Info | EnumerationLitteral)*)>

<!ATTLIST Enumeration

ID ID #REQUIRED

Name CDATA #REQUIRED

<!ELEMENT EnumerationLitteral (Info*, Description?)>

<!ATTLIST EnumerationLitteral

ID ID #REQUIRED

Name CDATA #REQUIRED

<!ATTLIST RequirementContainer

ID ID #REQUIRED

Name CDATA #REQUIRED

PropertySetID IDREF #IMPLIED

<!ELEMENT BusinessRuleContainer (Info*, Description?, (PropertyValue | Info | BusinessRuleContainer | BusinessRule)*, Traceability*)>

<!ATTLIST BusinessRuleContainer

ID ID #REQUIRED

Name CDATA #REQUIRED

PropertySetID IDREF #IMPLIED

<!ELEMENT GoalContainer (Info*, Description?, (PropertyValue | Info | GoalContainer | Goal)*, Traceability*)>

<!ATTLIST GoalContainer

ID ID #REQUIRED

Name CDATA #REQUIRED

PropertySetID IDREF #IMPLIED

<!ELEMENT Dictionary (Info*, Description?, (Info | Dictionary | Term | PropertyValue)*, Traceability*)>

<!ATTLIST Dictionary

ID ID #REQUIRED

Name CDATA #REQUIRED

PropertySetID IDREF #IMPLIED

<!ELEMENT Requirement (Info*, Description?, (Info | PropertyValue | Traceability)*)>

<!ATTLIST Requirement

ID ID #REQUIRED

Name CDATA #REQUIRED

<!ELEMENT BusinessRule (Info*, Description?, (Info | PropertyValue | Traceability)*)>

<!ATTLIST BusinessRule

ID ID #REQUIRED

Name CDATA #REQUIRED

<!ELEMENT Goal (Info*, Description?, (Info | PropertyValue | Traceability)*)>

<!ATTLIST Goal

ID ID #REQUIRED

Name CDATA #REQUIRED

<!ELEMENT Term (Info*, Description?, (Info | PropertyValue | Traceability)*)>

<!ATTLIST Term

ID ID #REQUIRED

Name CDATA #REQUIRED

<!ELEMENT PropertyValue (Info*)>

<!ATTLIST PropertyValue

PropertyID IDREF #REQUIRED

Value CDATA #REQUIRED

<!ELEMENT Traceability (Info*)>

<!ATTLIST Traceability

DestinationID IDREF #IMPLIED