Table of Contents:

  1. FEAT Programmer's Reference Guide
  2. Federation Engineering Agreements Schema

How to use this Reference Guide:

Copy the contents of the schemas directory to someplace it will be accessible to your XML editor or XML-enabled tool, then reference the root schema from within your document. As an example, if you have created your document in directory foo, and you have placed the schemas in foo/schemas you would need the following line as the root element in your schemas document:

<fedagree:agreement xmlns:fedagree=""
    xsi:schemaLocation=" file:./schemas/fedagreements.xsd">

Federation Engineering Agreements Template (FEAT) Programmer's Reference Guide

Federation agreements are critical to the successful design, execution, and reuse of federation assets. However, inconsistent formats and use across federations have made it difficult to capture and compare agreements between federations. This lack of a consistent approach to documenting federation agreements makes reuse and understanding more difficult. Lack of consistent format also prevents tool development and automation.

The federation agreements template is intended to provide a standardized format for recording federation agreements to increase their usability and reuse. The template is an eXtensible Markup Language (XML) schema from which compliant XML-based federation agreement documents can be created. XML was chosen for encoding agreements documents because it is both human and machine-readable and has wide tool support. Creating the template as an XML schema allows XML-enabled tools to both validate conformant documents, and edit and exchange agreements documents without introducing incompatibilities.

Wherever possible, the team that prepared the template leveraged existing, authoritative schemas for the representation of elements in this schema including:

The federation agreements are decomposed into eight categories:
  1. Metadata—Information about the federation agreements document itself.
  2. Design—Agreements about the basic purpose and design of the federation.
  3. Execution—Technical and process agreements affecting execution of the federation.
  4. Management—Systems/software engineering and project management agreements.
  5. Data—Agreements about structure, values, and semantics of data to be exchanged during federation execution.
  6. Infrastructure—Technical agreements about hardware, software, network protocols, and processes for implementing the infrastructure to support federation execution.
  7. Modeling—Agreements to be implemented in the member applications that semantically affect the current execution of the federation.
  8. Variances—Exceptions to the federation agreements deemed necessary during integration and testing.
This Programmer’s Reference provides specific technical guidance on the syntax and semantics required to create a conformant XML-based federation agreements document.