The UCF Record Examples XML specification
This describes the XML representation of the UCF's Record Examples XML Schema Definition (XSD). Each of the elements, types, and attributes that make up the format are described in detail.
The URL for the Record Examples XML structure is as follows:
http://unifiedcompliance.com/NFI/XSDs/2_2/UCF_Record_Examples_v2_2.xsd
The primary goal of the Record Examples XML table is to allow the attaching of specific record or file examples to the Record_Category_List.
UCF_RecEx_Item (UCF_RecEx_Item_Type)
The UCF_RecEx_List is comprised of the UCF_RecEx_Item containers. The UCF RecEx Item defines each individual "record" within the list. Each container is split into three key elements that must be present at all times:
-
UCF_Meta_Data
-
UCF_Basic_Info
-
UCF_References
UCF_Meta_Data (UCF_Meta_Data_Type)
For detailed documentation of Meta Data fields, please refer to the Meta Data documentation. Below is a list of the meta data fields that are included in the RecEx list.
-
UCF_RecEx_Release_Version
-
UCF_RecEx_SNED
-
UCF_RecEx_ID
-
UCF_RecEx_ID_CheckDigit
-
UCF_RecEx_Live_Status
-
UCF_RecEx_Deprecated_By
-
UCF_RecEx_Deprecation_Notes
-
UCF_RecEx_Date_Added
-
UCF_RecEx_Date_Modified
UCF_Basic_Info (UCF_Basic_Info_Type)
The UCF_Basic_Info element has exactly what you'd expect - the most critical information that pertains to all types of Organizational RecExs.
UCF_RecEx_Name (ucf:non-empty-string)
This is the name of the Record Example itself.
UCF_RecEx_Description (xs:string)
This is the description of the record example.
UCF_References (UCF_Reference_Type)
The final section in this UCF XML is the references section. In this section, you will find a list of ID's for every related record from all tables that are visible from the table the XML is generated for. Only one-to-many relationships are accounted for here as many-to-many joins have their own XML exports, XSDs, and documentation. For Organizational RecExs, the following field is exported:
UCF_RecCat_ID (UCF_ID2_Type)
Each Record Example is related to a Record Category. The 7-digit ID contained in this field represents the primary key of the UCF_Record_Categories_List.xml file that is related to the given Record Example.

Post a comment