Documentation for IDML and idmlReporting

<element name="reportsAndEvaluations">
  <annotation>
    <documentation>The root element can contain any number of reports or evaluations.</documentation>
  </annotation>
  <complexType>
    <sequence>
      <element name="reportAndEvaluation" type="idmlReporting:reportType" maxOccurs="unbounded">
        <annotation>
          <documentation>A report or evaluation has a language, origin and creation date. If the same report exists in different languages every language is a "report" element.</documentation>
        </annotation>
      </element>
    </sequence>
    <attribute name="origin" type="string" use="required" default="unknown"/>
    <attribute name="date" type="date" use="optional"/>
  </complexType>
</element>

<element name="reportAndEvaluation" type="idmlReporting:reportType" maxOccurs="unbounded">
  <annotation>
    <documentation>A report or evaluation has a language, origin and creation date. If the same report exists in different languages every language is a "report" element.</documentation>
  </annotation>
</element>

<complexType name="detailedDescriptionType" mixed="false">
  <annotation>
    <documentation>Detailed information about the project or activity to which this report applies</documentation>
  </annotation>
  <sequence>
    <element name="background" type="idml:hyperTextType">
      <annotation>
        <documentation>Description of the project background or current state of project</documentation>
      </annotation>
    </element>
    <element name="expectedOutcome" type="idml:hyperTextType" minOccurs="0" maxOccurs="unbounded">
      <annotation>
        <documentation>Overall objective or outcome of project (may be repeated in element objective)</documentation>
      </annotation>
    </element>
    <element name="beneficiary" type="string" minOccurs="0" maxOccurs="unbounded">
      <annotation>
        <documentation>Target group that is helped. One beneficiary group per element</documentation>
      </annotation>
    </element>
    <element name="objective" minOccurs="0" maxOccurs="unbounded">
      <annotation>
        <documentation>Objectives of project (one objective per element).</documentation>
      </annotation>
      <complexType mixed="false">
        <complexContent mixed="false">
          <extension base="idmlReporting:objectiveType"/>
        </complexContent>
      </complexType>
    </element>
    <element name="problem" minOccurs="0" maxOccurs="unbounded">
      <annotation>
        <documentation>Problems that the project wants to address. One element per problem.</documentation>
      </annotation>
      <complexType mixed="false">
        <sequence>
          <element name="problemDescription" type="idml:hyperTextType"/>
          <element name="proposedSolution" type="idml:hyperTextType">
            <annotation>
              <documentation>Description of how to apporach problem and what the project outputs or deliverables are.</documentation>
            </annotation>
          </element>
        </sequence>
      </complexType>
    </element>
    <element name="risk" type="idml:hyperTextType" minOccurs="0" maxOccurs="unbounded">
      <annotation>
        <documentation>Evaluation of project risks and how they are accounted in project design. One risk per element.</documentation>
      </annotation>
    </element>
    <element name="strategicApproach" type="idml:hyperTextType" minOccurs="0">
      <annotation>
        <documentation>What approach will be chosen to solve the problems and take into account the risks</documentation>
      </annotation>
    </element>
    <element name="milestone" type="idml:hyperTextType" minOccurs="0" maxOccurs="unbounded">
      <annotation>
        <documentation>Milestones of project (most important steps with time frame)</documentation>
      </annotation>
    </element>
    <element name="relatedDocument" type="idml:textType" minOccurs="0" maxOccurs="unbounded">
      <annotation>
        <documentation>List of documents related to the project description.</documentation>
      </annotation>
    </element>
  </sequence>
</complexType>

<element name="background" type="idml:hyperTextType">
  <annotation>
    <documentation>Description of the project background or current state of project</documentation>
  </annotation>
</element>

<element name="expectedOutcome" type="idml:hyperTextType" minOccurs="0" maxOccurs="unbounded">
  <annotation>
    <documentation>Overall objective or outcome of project (may be repeated in element objective)</documentation>
  </annotation>
</element>

<element name="beneficiary" type="string" minOccurs="0" maxOccurs="unbounded">
  <annotation>
    <documentation>Target group that is helped. One beneficiary group per element</documentation>
  </annotation>
</element>

<element name="objective" minOccurs="0" maxOccurs="unbounded">
  <annotation>
    <documentation>Objectives of project (one objective per element).</documentation>
  </annotation>
  <complexType mixed="false">
    <complexContent mixed="false">
      <extension base="idmlReporting:objectiveType"/>
    </complexContent>
  </complexType>
</element>

<element name="problem" minOccurs="0" maxOccurs="unbounded">
  <annotation>
    <documentation>Problems that the project wants to address. One element per problem.</documentation>
  </annotation>
  <complexType mixed="false">
    <sequence>
      <element name="problemDescription" type="idml:hyperTextType"/>
      <element name="proposedSolution" type="idml:hyperTextType">
        <annotation>
          <documentation>Description of how to apporach problem and what the project outputs or deliverables are.</documentation>
        </annotation>
      </element>
    </sequence>
  </complexType>
</element>

<element name="problemDescription" type="idml:hyperTextType"/>

<element name="proposedSolution" type="idml:hyperTextType">
  <annotation>
    <documentation>Description of how to apporach problem and what the project outputs or deliverables are.</documentation>
  </annotation>
</element>

<element name="risk" type="idml:hyperTextType" minOccurs="0" maxOccurs="unbounded">
  <annotation>
    <documentation>Evaluation of project risks and how they are accounted in project design. One risk per element.</documentation>
  </annotation>
</element>

<element name="strategicApproach" type="idml:hyperTextType" minOccurs="0">
  <annotation>
    <documentation>What approach will be chosen to solve the problems and take into account the risks</documentation>
  </annotation>
</element>

<element name="milestone" type="idml:hyperTextType" minOccurs="0" maxOccurs="unbounded">
  <annotation>
    <documentation>Milestones of project (most important steps with time frame)</documentation>
  </annotation>
</element>

<element name="relatedDocument" type="idml:textType" minOccurs="0" maxOccurs="unbounded">
  <annotation>
    <documentation>List of documents related to the project description.</documentation>
  </annotation>
</element>

<complexType name="evaluationType">
  <annotation>
    <documentation>Evaluation of project that is reported on.</documentation>
  </annotation>
  <sequence>
    <element name="projectPerformanceIndicator" type="idmlReporting:indicatorType" minOccurs="0" maxOccurs="unbounded"/>
    <element name="outcome" type="idml:hyperTextType" minOccurs="0" maxOccurs="unbounded">
      <annotation>
        <documentation>Outcome or impact of project at time of evaluation.</documentation>
      </annotation>
    </element>
    <element name="lessonLearned" type="idml:hyperTextType" minOccurs="0" maxOccurs="unbounded">
      <annotation>
        <documentation>Lessons learned in project (one lesson per element). Pros and cons of implementation approach.</documentation>
      </annotation>
    </element>
    <element name="sustainability" type="idml:hyperTextType" minOccurs="0" maxOccurs="unbounded">
      <annotation>
        <documentation>Project sustainability after the end of funding. (Are the achieved results having a long term impact? Is the project viable at the end.) Comments on environmental aspects may be added.</documentation>
      </annotation>
    </element>
    <element name="comment" type="string" minOccurs="0" maxOccurs="unbounded">
      <annotation>
        <documentation>General comments on evaluation.</documentation>
      </annotation>
    </element>
    <element name="relatedDocument" type="idml:textType" minOccurs="0" maxOccurs="unbounded">
      <annotation>
        <documentation>List of documents that are related to this evaluation.</documentation>
      </annotation>
    </element>
  </sequence>
</complexType>

<element name="projectPerformanceIndicator" type="idmlReporting:indicatorType" minOccurs="0" maxOccurs="unbounded"/>

<element name="outcome" type="idml:hyperTextType" minOccurs="0" maxOccurs="unbounded">
  <annotation>
    <documentation>Outcome or impact of project at time of evaluation.</documentation>
  </annotation>
</element>

<element name="lessonLearned" type="idml:hyperTextType" minOccurs="0" maxOccurs="unbounded">
  <annotation>
    <documentation>Lessons learned in project (one lesson per element). Pros and cons of implementation approach.</documentation>
  </annotation>
</element>

<element name="sustainability" type="idml:hyperTextType" minOccurs="0" maxOccurs="unbounded">
  <annotation>
    <documentation>Project sustainability after the end of funding. (Are the achieved results having a long term impact? Is the project viable at the end.) Comments on environmental aspects may be added.</documentation>
  </annotation>
</element>

<element name="comment" type="string" minOccurs="0" maxOccurs="unbounded">
  <annotation>
    <documentation>General comments on evaluation.</documentation>
  </annotation>
</element>

<element name="relatedDocument" type="idml:textType" minOccurs="0" maxOccurs="unbounded">
  <annotation>
    <documentation>List of documents that are related to this evaluation.</documentation>
  </annotation>
</element>

<complexType name="financialInformationType">
  <annotation>
    <documentation>Information about budget, expenses and income</documentation>
  </annotation>
  <sequence>
    <element name="budget" minOccurs="0">
      <complexType>
        <sequence minOccurs="0">
          <element name="comment" type="idml:hyperTextType" minOccurs="0" maxOccurs="unbounded"/>
        </sequence>
      </complexType>
    </element>
    <element name="expenditure" type="idml:moneyType" minOccurs="0"/>
    <element name="income" type="idml:fundingType" minOccurs="0"/>
  </sequence>
</complexType>

<element name="budget" minOccurs="0">
  <complexType>
    <sequence minOccurs="0">
      <element name="comment" type="idml:hyperTextType" minOccurs="0" maxOccurs="unbounded"/>
    </sequence>
  </complexType>
</element>

<element name="comment" type="idml:hyperTextType" minOccurs="0" maxOccurs="unbounded"/>

<element name="expenditure" type="idml:moneyType" minOccurs="0"/>

<element name="income" type="idml:fundingType" minOccurs="0"/>

<complexType name="indicatorType">
  <annotation>
    <documentation>Desciption of project performance indicators</documentation>
  </annotation>
  <sequence>
    <element name="indicatorName">
      <annotation>
        <documentation>An indicator has a name. For every indicator there can be several measure dates. The indicator can measure a state (point in time) or a development (duration). For every date there is a value and information on who measured.</documentation>
      </annotation>
      <complexType mixed="true">
        <sequence>
          <element name="measure" minOccurs="0" maxOccurs="unbounded">
            <complexType>
              <sequence>
                <choice>
                  <element name="duration">
                    <annotation>
                      <documentation>Indicator measures a development for a certain duration</documentation>
                    </annotation>
                    <complexType mixed="false">
                      <attribute name="startDate" type="date" use="required"/>
                      <attribute name="endDate" type="date" use="required"/>
                    </complexType>
                  </element>
                  <element name="pointInTime">
                    <annotation>
                      <documentation>Indicator measures a state at a certain point in time.</documentation>
                    </annotation>
                    <complexType mixed="false">
                      <attribute name="date" type="date" use="required"/>
                    </complexType>
                  </element>
                </choice>
                <element name="value" type="string">
                  <annotation>
                    <documentation>numeric or descriptive value for measure</documentation>
                  </annotation>
                </element>
                <element name="targetValue" type="string" minOccurs="0"/>
                <element name="measuredBy" type="string" minOccurs="0">
                  <annotation>
                    <documentation>Who measured?</documentation>
                  </annotation>
                </element>
              </sequence>
            </complexType>
          </element>
        </sequence>
      </complexType>
    </element>
    <element name="indicatorDescription" type="idml:hyperTextType" minOccurs="0">
      <annotation>
        <documentation>Description of indicator: what is measured, how often, by whom. What project objectives is indicator contributing to.</documentation>
      </annotation>
    </element>
  </sequence>
</complexType>

<element name="indicatorName">
  <annotation>
    <documentation>An indicator has a name. For every indicator there can be several measure dates. The indicator can measure a state (point in time) or a development (duration). For every date there is a value and information on who measured.</documentation>
  </annotation>
  <complexType mixed="true">
    <sequence>
      <element name="measure" minOccurs="0" maxOccurs="unbounded">
        <complexType>
          <sequence>
            <choice>
              <element name="duration">
                <annotation>
                  <documentation>Indicator measures a development for a certain duration</documentation>
                </annotation>
                <complexType mixed="false">
                  <attribute name="startDate" type="date" use="required"/>
                  <attribute name="endDate" type="date" use="required"/>
                </complexType>
              </element>
              <element name="pointInTime">
                <annotation>
                  <documentation>Indicator measures a state at a certain point in time.</documentation>
                </annotation>
                <complexType mixed="false">
                  <attribute name="date" type="date" use="required"/>
                </complexType>
              </element>
            </choice>
            <element name="value" type="string">
              <annotation>
                <documentation>numeric or descriptive value for measure</documentation>
              </annotation>
            </element>
            <element name="targetValue" type="string" minOccurs="0"/>
            <element name="measuredBy" type="string" minOccurs="0">
              <annotation>
                <documentation>Who measured?</documentation>
              </annotation>
            </element>
          </sequence>
        </complexType>
      </element>
    </sequence>
  </complexType>
</element>

<element name="measure" minOccurs="0" maxOccurs="unbounded">
  <complexType>
    <sequence>
      <choice>
        <element name="duration">
          <annotation>
            <documentation>Indicator measures a development for a certain duration</documentation>
          </annotation>
          <complexType mixed="false">
            <attribute name="startDate" type="date" use="required"/>
            <attribute name="endDate" type="date" use="required"/>
          </complexType>
        </element>
        <element name="pointInTime">
          <annotation>
            <documentation>Indicator measures a state at a certain point in time.</documentation>
          </annotation>
          <complexType mixed="false">
            <attribute name="date" type="date" use="required"/>
          </complexType>
        </element>
      </choice>
      <element name="value" type="string">
        <annotation>
          <documentation>numeric or descriptive value for measure</documentation>
        </annotation>
      </element>
      <element name="targetValue" type="string" minOccurs="0"/>
      <element name="measuredBy" type="string" minOccurs="0">
        <annotation>
          <documentation>Who measured?</documentation>
        </annotation>
      </element>
    </sequence>
  </complexType>
</element>

<element name="duration">
  <annotation>
    <documentation>Indicator measures a development for a certain duration</documentation>
  </annotation>
  <complexType mixed="false">
    <attribute name="startDate" type="date" use="required"/>
    <attribute name="endDate" type="date" use="required"/>
  </complexType>
</element>

<element name="pointInTime">
  <annotation>
    <documentation>Indicator measures a state at a certain point in time.</documentation>
  </annotation>
  <complexType mixed="false">
    <attribute name="date" type="date" use="required"/>
  </complexType>
</element>

<element name="value" type="string">
  <annotation>
    <documentation>numeric or descriptive value for measure</documentation>
  </annotation>
</element>

<element name="targetValue" type="string" minOccurs="0"/>

<element name="measuredBy" type="string" minOccurs="0">
  <annotation>
    <documentation>Who measured?</documentation>
  </annotation>
</element>

<element name="indicatorDescription" type="idml:hyperTextType" minOccurs="0">
  <annotation>
    <documentation>Description of indicator: what is measured, how often, by whom. What project objectives is indicator contributing to.</documentation>
  </annotation>
</element>

<complexType name="lastUpdateType">
  <annotation>
    <documentation>Information about when and who updated the report last</documentation>
  </annotation>
</complexType>

<complexType name="objectiveType">
  <annotation>
    <documentation>Description of project objectives and their relationships between each other</documentation>
  </annotation>
  <sequence>
    <element name="objectiveName"/>
    <element name="objectiveIsPartOf" type="string" minOccurs="0">
      <annotation>
        <documentation>with this element an objective hierarchy can be modelled.</documentation>
      </annotation>
    </element>
    <element name="objectiveDescription" type="idml:hyperTextType" minOccurs="0"/>
  </sequence>
</complexType>

<element name="objectiveName"/>

<element name="objectiveIsPartOf" type="string" minOccurs="0">
  <annotation>
    <documentation>with this element an objective hierarchy can be modelled.</documentation>
  </annotation>
</element>

<element name="objectiveDescription" type="idml:hyperTextType" minOccurs="0"/>

<complexType name="reportedActivityType">
  <annotation>
    <documentation>Complex type for the description of activities that have been carried out or that are planned. </documentation>
  </annotation>
  <sequence>
    <element name="reportedActivitiy" maxOccurs="unbounded">
      <annotation>
        <documentation>Activity which we want to report on. One activity per "reportedActivity" element</documentation>
      </annotation>
      <complexType>
        <sequence>
          <element name="activityName" type="string"/>
          <element name="activityDescription" type="idml:hyperTextType" minOccurs="0"/>
          <element name="output" type="idml:hyperTextType" minOccurs="0" maxOccurs="unbounded">
            <annotation>
              <documentation>Output of activity</documentation>
            </annotation>
          </element>
          <element name="startDate" type="idml:dateType" minOccurs="0"/>
          <element name="endDate" type="idml:dateType" minOccurs="0"/>
          <element name="personInvolved" type="idml:personRole" minOccurs="0" maxOccurs="unbounded"/>
          <element name="statusOfImplementation" type="idml:statusType" minOccurs="0"/>
          <element namespan class="textOperator">="comment" type="idml:textType" minOccurs="0"/>
          <element name="eingesetzteMittel" minOccurs="0"/>
        </sequence>
        <attribute name="dateReported" type="date" use="optional"/>
      </complexType>
    </element>
    <element name="relatedDocument" type="idml:textType" minOccurs="0" maxOccurs="unbounded">
      <annotation>
        <documentation>List of documents related to this reporting.</documentation>
      </annotation>
    </element>
  </sequence>
</complexType>

<element name="reportedActivitiy" maxOccurs="unbounded">
  <annotation>
    <documentation>Activity which we want to report on. One activity per "reportedActivity" element</documentation>
  </annotation>
  <complexType>
    <sequence>
      <element name="activityName" type="string"/>
      <element name="activityDescription" type="idml:hyperTextType" minOccurs="0"/>
      <element name="output" type="idml:hyperTextType" minOccurs="0" maxOccurs="unbounded">
        <annotation>
          <documentation>Output of activity</documentation>
        </annotation>
      </element>
      <element name="startDate" type="idml:dateType" minOccurs="0"/>
      <element name="endDate" type="idml:dateType" minOccurs="0"/>
      <element name="personInvolved" type="idml:personRole" minOccurs="0" maxOccurs="unbounded"/>
      <element name="statusOfImplementation" type="idml:statusType" minOccurs="0"/>
      <element name="comment" type="idml:textType" minOccurs="0"/>
      <element name="eingesetzteMittel" minOccurs="0"/>
    </sequence>
    <attribute name="dateReported" type="date" use="optional"/>
  </complexType>
</element>

<element name="activityName" type="string"/>

<element name="activityDescription" type="idml:hyperTextType" minOccurs="0"/>

<element name="output" type="idml:hyperTextType" minOccurs="0" maxOccurs="unbounded">
  <annotation>
    <documentation>Output of activity</documentation>
  </annotation>
</element>

<element name="startDate" type="idml:dateType" minOccurs="0"/>

<element name="endDate" type="idml:dateType" minOccurs="0"/>

<element name="personInvolved" type="idml:personRole" minOccurs="0" maxOccurs="unbounded"/>

<element name="statusOfImplementation" type="idml:statusType" minOccurs="0"/>

<element name="comment" type="idml:textType" minOccurs="0"/>

<element name="eingesetzteMittel" minOccurs="0"/>

<element name="relatedDocument" type="idml:textType" minOccurs="0" maxOccurs="unbounded">
  <annotation>
    <documentation>List of documents related to this reporting.</documentation>
  </annotation>
</element>

<complexType name="reportType">
  <annotation>
    <documentation>The complexType report holds all elements necessary for reporting and evaluation.</documentation>
  </annotation>
  <sequence>
    <element name="ID" type="idml:IDType" minOccurs="0">
      <annotation>
        <documentation>Report ID of submiting organisation.</documentation>
      </annotation>
    </element>
    <element name="Name" type="string" minOccurs="0">
      <annotation>
        <documentation>Name of report or evaluation.</documentation>
      </annotation>
    </element>
    <element name="reportDescription" type="string" minOccurs="0">
      <annotation>
        <documentation>What can be found in this report or evaluation?</documentation>
      </annotation>
    </element>
    <element name="lastUpdate" type="idml:dateType" minOccurs="0">
      <annotation>
        <documentation>Last update of information in this record.</documentation>
      </annotation>
    </element>
    <element name="detailedDescription" type="idmlReporting:detailedDescriptionType" minOccurs="0">
      <annotation>
        <documentation>Description of project or programme.</documentation>
      </annotation>
    </element>
    <element name="reporting" type="idmlReporting:reportedActivityType" minOccurs="0">
      <annotation>
        <documentation>List of reported activities.</documentation>
      </annotation>
    </element>
    <element name="evaluation" minOccurs="0">
      <annotation>
        <documentation>Evaluation of project.</documentation>
      </annotation>
      <complexType>
        <complexContent>
          <extension base="idmlReporting:evaluationType"/>
        </complexContent>
      </complexType>
    </element>
    <element name="financialInformation" type="idmlReporting:financialInformationType" minOccurs="0">
      <annotation>
        <documentation>Information on project finance. (Reference to Biztalk Project Management  Schema)</documentation>
      </annotation>
    </element>
  </sequence>
  <attribute name="lang" type="language" use="required" default="EN"/>
  <attribute name="reportOrigin" type="string" use="required" default="unknown"/>
  <attribute name="creationDate" type="date" use="optional" form="unqualified"/>
</complexType>

<element name="ID" type="idml:IDType" minOccurs="0">
  <annotation>
    <documentation>Report ID of submiting organisation.</documentation>
  </annotation>
</element>

<element name="Name" type="string" minOccurs="0">
  <annotation>
    <documentation>Name of report or evaluation.</documentation>
  </annotation>
</element>

<element name="reportDescription" type="string" minOccurs="0">
  <annotation>
    <documentation>What can be found in this report or evaluation?</documentation>
  </annotation>
</element>