cfiXML.org

capital facilities industry XML

engineering data for the facility life cycle

Documentation

Guidelines

XML Schema Reference Guide V4.0, 2012, Review Draft  [Download]

The 2012 guidelines (V4.0) detail significant alterations in the schema model and the development of the cfiXML Light (LT) version, made available from July 2011 in Schema Public Release V4.0.

These guidelines are completely restructured when compared with the 2009 guidelines.  This is to provide high level support so that a user can pick and choose features and link to detail in appendices, as required.   This format supports phased introduction and learning.

New sections or major updates are provided on: substitution groups replacing derivable types; the rationale for elements versus attributes; clarification of the use of namespaces; new reference property ids; optional objectIDs, and dx.xsd document cover.

All key information on data dictionaries is compiled together and further detail provided to support the newly available dictionaries for various equipment items.  Key text from the cfiXML Light (LT) Specifications document is also included.  

Chapters 1-5 now consist of 23 pages, as follows:

  • Chapter 1 - introduces the cfiXML schema model, including benefits of the design and features, and how it works to solve interoperability problems. (Intended for any interested party and assumes no detailed knowledge of IT.)
  • Chapter 2 - outlines the architecture of the cfiXML schema model (Intended for schema and application developers in particular.)
  • Chapter 3 - lists considerations for an application developer using cfiXML LT.
  • Chapter 4 - lists considerations for an application developer using full cfiXML.
  • Chapter 5 - outlines key considerations for a schema developer.

All chapters link to details in the comprehensive appendices.  A basic index is provided.

Back to top ]


XML Schema Reference Guide V3.0, 2009, Review Draft  [Download]

The 2009 guidelines (V3.0) are associated with schema releases prior to Public Release V4.0.  It is a detailed update of earlier guidelines, building on lessons learned through schema development requirements  and real usage scenario demonstrations.

  • Chapter 1 - introduces the cfiXML schema model, including benefits of the design and features, and how it works to solve interoperability problems. (Intended for any interested party and assumes no detailed knowledge of IT.)
  • Chapters 2&3 - build on Chapter 1 and detail key concepts of the cfiXML design and contents. (Intended for schema and application developers in particular.)
  • Chapter 4 - provides specifics on schema design for schema and application developers, building on previous chapters.
  • Chapter 5 - provides additional points to be considered by application developers.
  • The appendices include details on schema components of key equipment items, and support for a user to navigate through and become familiar with the cfiXML schema model. (Intended for everyone.)

Back to top ]


cfiXML Light (LT) Specifications  [Download]

The cfiXML Light (LT) schema version is a subset of the full schema model.  Schema LT has been developed to support the use of simple XML serialization tools and so enable developers with limited XML experience to be able to develop data exchange systems easily and cost-effectively.  Public Release V4.0 includes a download for both full and LT schemas. (Intended for application and schema developers.)

The purpose of this document is to:

  • aid application developers new to cfiXML in making the decision on whether full or LT schema will meet their requirements;
  • detail specifications for the use of cfiXML LT schema;
  • provide recommendations on testing criteria to be met to confirm a successful data exchange system has been implemented;
  • outline the process to create LT and full versions of cfiXML and the LT-tool functionality.

Back to top ]


cfiXML Procedures  [Download]

This document provides a description for the work processes and procedures for reviewing and submitting XML schemas for consideration into cfiXML working group development activities. (Intended for schema developers)

Back to top ]

Demonstration slides and Other documents

Demonstration of cfiXML in real usage scenario  [Download]

This is a compilation of ppt slides showing electronic data exchange of real capital project data for the procurement of centrifugal pumps. (Intended for everyone)

Back to top ]

Open Source Licenses

Alar Open Source License - provides the full text of the Alar Engineering Software, Inc. open source license for users of the currently published XML schemas. (Intended for everyone)

FIATECH Open Source License - provides the full text of the FIATECH open source license for users of the currently published XML schemas. (Intended for everyone)

AIChE-DIPPR Open Source License - provides the full text of the AIChE-DIPPR open source license for users of the currently published XML schemas. (Intended for everyone)

Back to top ]

Feedback?

If you have any feedback on the contents of the documents, or have suggestions for other information that be useful, please contact us.