The type-v1.0 DTD

The root (aka "top-level") element of the type.xml file. Contains a set of type elements. Any kind of type can be specified in any order.

  <types>
     <type ...>
  </types>
      

The type element defines a Type and command module. If the "order" attribute is "Setting" or "Assembly", then the elements required to define the command Module are not required.

   <type
        name="TypeName"
        role="concrete"
        order="TypeName"
        uniqueInstances="true">

        <description>describe the type</description>

        <supertype>
            <typereference name="TypeName"/>
        </supertype>

	...
   </type>
   

A documentation block. Can contain any valid Apache Forrest xdoc tag. The doc tags can be used just about anywhere in the type.xml. When ProjectBuilder's generate-forrest-docs command is run, the doc tags are expanded into the generated forrest xdocs.

A sub-element of type, supertype specifies the parent type of this type. A typereference tag is used to specify the supertype by name.

Specifies a type.

Properties of the command module

     <command-settings>
         <notification notify="false"/>
         <template-directory></template-directory>
         <dependency-view parents="false" children="true" proximity="1"/>
         <logger name="TypeName"/>
     </command-settings>
      

Paramaters used as defaults for the Get-Properties command options

define attributes of the Type here. type-property values are the names of properties in the depo: namespace

    <attributes>
       <attribute name="attr_name" type-property="property-name"/>
       <attribute-default name="attr_name" value="VALUE"/>
    </attributes>
       

A sub-element of type. Type constraints are used to control the allowed kinds of dependencies (both parent and child). Also controls the allowed values for its RDF properties.

       <constraints>
            <allowedvalue-constraint
                enforced="true/false"
                type-property="depo-property-name">
                <allowedvalue value="<SOME VALUE>" default="true/false"/>
                <allowedvalue value="<SOME VALUE>" default="true/false"/>
            </allowedvalue-constraint>
            <dependency-constraint kind="parent/child" enforced="true/false">
                <allowedtypes>
                    <typereference name="<TYPE NAME>"/>
                    <typereference name="<TYPE NAME>"/>
                </allowedtypes>
                <singletontypes>
                    <typereference name="<TYPE NAME>"/>
                    <typereference name="<TYPE NAME>"/>
                </singletontypes>
            </dependency-constraint>
        </constraints>
      

Contains any number of allowed values.

An allowed value.

A sub-element of type, the commands element contains the command definitions for this type.

Defines a command for the type.

File to execute

Arguments to pass to executable. If the execution-string specifies an interpreter that can read script from stdin, the value of argument-string can be script code.

Ant tasks to execute.

BSF script to execute.

Command sequence to execute. Takes one more more command elements.

	 <command name="<WORKFLOW COMMAND NAME>"
                  description="<WORKFLOW COMMAND DESCRIPTION>"
                  command-type="WorkflowCommand"
                  error-handler-type="handler/ignore/fail"
                  >
           <error-handler quiet="true/false">
             <prompt>PROMPT MESSAGE</prompt>
             <command name="<ERROR HANDLER COMMAND NAME>"/>
             <notify email="NAME@HOST">
               <subject>SUBJECT</subject>
               <message-file>PATH</message-file>
             </notify>
             <report>REPORT MESSAGE</report>
           </error-handler>
           <success-handler notify-email="NAME@HOST">
             <notify-subject>SUBJECT</notify-subject>
             <notify-message-file>PATH</notify-message-file>
           </success-handler>
           <workflow threadcount="<INTEGER>">
             <command name="<COMMAND NAME>"/>
             <command name="<COMMAND NAME>"/>
           </workflow>
         </command>
       

Handles an error if one occurs

Example

           <error-handler quiet="true/false">
             <prompt>PROMPT MESSAGE</prompt>
             <command name="<ERROR HANDLER COMMAND NAME>"/>
             <notify email="NAME@HOST">
               <subject>SUBJECT</subject>
               <message-file>PATH</message-file>
             </notify>
             <report>REPORT MESSAGE</report>
           </error-handler>
      

Specifies the commands options

              <opts>
                <opt parameter="<OPT NAME>"
                     description="<OPT DESCRIPTION>"
                     required="{true|false}"
                     property="opts.<OPT NAME>"
                     type="{string|boolean}"
                     default="<DEFAULT STRING VALUE>"
                     defaultproperty="<PROPERTY NAME>"
                  />
               </opts>
       

Specifies one command option.

Attribute constraints can control the allowed values and defaults for the RDF properties of base types. The following is a listing of ones that can have constraints applied.