forecast

iati-activities/iati-activity/fss/forecast

This is the reference page for the XML element forecast. See also the relevant overview page: CRS & FSS

Definition

A container to hold separate forecasts for each of the years specified Text() holds the forecast value for each year.

Rules

The text in this element must be of type xsd:decimal.

This element may occur any number of times.

The time between budget/period-start/@iso-date and budget/period-end/@iso-date must not be over a year

If count(@lang) = 0 evaluates to true, then count(narrative/@lang) > 0 and (count(narrative) = count(narrative/@lang)) must evaluate to true.

If count(transaction/provider-org/@ref) = 0 evaluates to true, then count(transaction/provider-org/narrative) > 0 must evaluate to true.

If count(@default-currency) = 0 evaluates to true, then count(crs-add/loan-status/@currency) > 0 must evaluate to true.

If count(@default-currency) = 0 evaluates to true, then count(fss/forecast/@currency) > 0 must evaluate to true.

If count(transaction/receiver-org/@ref) = 0 evaluates to true, then count(transaction/provider-org/narrative) > 0 must evaluate to true.

If count(other-identifier/owner-org/@ref) = 0 evaluates to true, then count(other-identifier/owner-org/narrative) > 0 must evaluate to true.

If count(sector[@vocabulary=98 or @vocabulary=99]) > 0 evaluates to true, then count(sector/narrative) > 0 must evaluate to true.

@xml-lang must exist, otherwise all lang must exist.

sector must exist, otherwise all sector must exist.

@default-currency must exist, otherwise all currency must exist.

@last-updated-datetime must not be more recent than the current date

Each expression defined in number(recipient-country/@percentage) >= 0.0 must resolve to true.

Each expression defined in number(recipient-region/@percentage) >= 0.0 must resolve to true.

Each expression defined in number(sector/@percentage) >= 0.0 must resolve to true.

Each expression defined in number(capital-spend/@percentage) >= 0.0 must resolve to true.

All elements in sector[@vocabulary != '1']/@vocabulary are evaluated under the rules inside {u'strict_sum': {u'cases': [{u'paths': [u"sector[@vocabulary = '$1']/@percentage"], u'sum': 100}]}}.

Attributes

@year

The calendar year that the forward spend covers

This attribute is required.

This value must be of type xsd:decimal.

The time between budget/period-start/@iso-date and budget/period-end/@iso-date must not be over a year

If count(@lang) = 0 evaluates to true, then count(narrative/@lang) > 0 and (count(narrative) = count(narrative/@lang)) must evaluate to true.

If count(transaction/provider-org/@ref) = 0 evaluates to true, then count(transaction/provider-org/narrative) > 0 must evaluate to true.

If count(@default-currency) = 0 evaluates to true, then count(crs-add/loan-status/@currency) > 0 must evaluate to true.

If count(@default-currency) = 0 evaluates to true, then count(fss/forecast/@currency) > 0 must evaluate to true.

If count(transaction/receiver-org/@ref) = 0 evaluates to true, then count(transaction/provider-org/narrative) > 0 must evaluate to true.

If count(other-identifier/owner-org/@ref) = 0 evaluates to true, then count(other-identifier/owner-org/narrative) > 0 must evaluate to true.

If count(sector[@vocabulary=98 or @vocabulary=99]) > 0 evaluates to true, then count(sector/narrative) > 0 must evaluate to true.

@xml-lang must exist, otherwise all lang must exist.

sector must exist, otherwise all sector must exist.

@default-currency must exist, otherwise all currency must exist.

@last-updated-datetime must not be more recent than the current date

Each expression defined in number(recipient-country/@percentage) >= 0.0 must resolve to true.

Each expression defined in number(recipient-region/@percentage) >= 0.0 must resolve to true.

Each expression defined in number(sector/@percentage) >= 0.0 must resolve to true.

Each expression defined in number(capital-spend/@percentage) >= 0.0 must resolve to true.

All elements in sector[@vocabulary != '1']/@vocabulary are evaluated under the rules inside {u'strict_sum': {u'cases': [{u'paths': [u"sector[@vocabulary = '$1']/@percentage"], u'sum': 100}]}}.

@currency

The ISO 4217 alphabetic currency code of the value reported. This is required unless the iati-activity/@default-currency is present and applies.

This value must be of type xsd:string.

This value must be on the Currency codelist.

The time between budget/period-start/@iso-date and budget/period-end/@iso-date must not be over a year

If count(@lang) = 0 evaluates to true, then count(narrative/@lang) > 0 and (count(narrative) = count(narrative/@lang)) must evaluate to true.

If count(transaction/provider-org/@ref) = 0 evaluates to true, then count(transaction/provider-org/narrative) > 0 must evaluate to true.

If count(@default-currency) = 0 evaluates to true, then count(crs-add/loan-status/@currency) > 0 must evaluate to true.

If count(@default-currency) = 0 evaluates to true, then count(fss/forecast/@currency) > 0 must evaluate to true.

If count(transaction/receiver-org/@ref) = 0 evaluates to true, then count(transaction/provider-org/narrative) > 0 must evaluate to true.

If count(other-identifier/owner-org/@ref) = 0 evaluates to true, then count(other-identifier/owner-org/narrative) > 0 must evaluate to true.

If count(sector[@vocabulary=98 or @vocabulary=99]) > 0 evaluates to true, then count(sector/narrative) > 0 must evaluate to true.

@xml-lang must exist, otherwise all lang must exist.

sector must exist, otherwise all sector must exist.

@default-currency must exist, otherwise all currency must exist.

@last-updated-datetime must not be more recent than the current date

Each expression defined in number(recipient-country/@percentage) >= 0.0 must resolve to true.

Each expression defined in number(recipient-region/@percentage) >= 0.0 must resolve to true.

Each expression defined in number(sector/@percentage) >= 0.0 must resolve to true.

Each expression defined in number(capital-spend/@percentage) >= 0.0 must resolve to true.

All elements in sector[@vocabulary != '1']/@vocabulary are evaluated under the rules inside {u'strict_sum': {u'cases': [{u'paths': [u"sector[@vocabulary = '$1']/@percentage"], u'sum': 100}]}}.

@value-date

The date to be used for determining the exchange rate for currency conversions.

This value must be of type xsd:date.

The time between budget/period-start/@iso-date and budget/period-end/@iso-date must not be over a year

If count(@lang) = 0 evaluates to true, then count(narrative/@lang) > 0 and (count(narrative) = count(narrative/@lang)) must evaluate to true.

If count(transaction/provider-org/@ref) = 0 evaluates to true, then count(transaction/provider-org/narrative) > 0 must evaluate to true.

If count(@default-currency) = 0 evaluates to true, then count(crs-add/loan-status/@currency) > 0 must evaluate to true.

If count(@default-currency) = 0 evaluates to true, then count(fss/forecast/@currency) > 0 must evaluate to true.

If count(transaction/receiver-org/@ref) = 0 evaluates to true, then count(transaction/provider-org/narrative) > 0 must evaluate to true.

If count(other-identifier/owner-org/@ref) = 0 evaluates to true, then count(other-identifier/owner-org/narrative) > 0 must evaluate to true.

If count(sector[@vocabulary=98 or @vocabulary=99]) > 0 evaluates to true, then count(sector/narrative) > 0 must evaluate to true.

@xml-lang must exist, otherwise all lang must exist.

sector must exist, otherwise all sector must exist.

@default-currency must exist, otherwise all currency must exist.

@last-updated-datetime must not be more recent than the current date

Each expression defined in number(recipient-country/@percentage) >= 0.0 must resolve to true.

Each expression defined in number(recipient-region/@percentage) >= 0.0 must resolve to true.

Each expression defined in number(sector/@percentage) >= 0.0 must resolve to true.

Each expression defined in number(capital-spend/@percentage) >= 0.0 must resolve to true.

All elements in sector[@vocabulary != '1']/@vocabulary are evaluated under the rules inside {u'strict_sum': {u'cases': [{u'paths': [u"sector[@vocabulary = '$1']/@percentage"], u'sum': 100}]}}.

Example Usage

Example of forecast for the fss of an iati-activity.

An example date is declared in the @value-date attribute.
This example date format conform to the xsd:date standard - for most cases YYYY-MM-DD is sufficient.
This example declares the attribute @year as 2014.
This example declares a Currency code GBP, using the @currency attribute.
Note: A Currency code should only be declared if different to @default-currency in the iati-activity element.
  <fss extraction-date="2014-05-06" priority="1" phaseout-year="2016">
   <forecast year="2014" value-date="2013-07-03" currency="GBP">10000</forecast>
  </fss>
Note: multiple forecasts are expressed by repeating the forecast element.

Changelog

1.03

New in 1.03
Added the optional fss element and its child elements

Developer tools

Find the source of this documentation on github: