Return XM: Filename Conventions: Protocol File Set

The Return XML Protocol File Set was developed as the document ID name reference for use by our customer’s programmers. The programmers can develop their client’s proprietary matching import files, using Return XML as the import/export facility.

The protocol file set is a zip file containing two files for each tax application. They are listed as follows:

Tax Application	Protocol File Set (PFS)
1040	2021 RXML 1040 PFS (YYYY-MM-DD).ZIP
1065	2021 RXML 1065 PFS (YYYY-MM-DD).ZIP
1120	2021 RXML 1120 PFS (YYYY-MM-DD).ZIP

Tax Application	Individual Files within PFS
1040	AIEX1_BUILD_REPORT.XLS TTA1040IEX1Schema.XSD
1065	PIEX1_BUILD_REPORT.XLS TTA1065IEX1Schema.XSD
1120	CIEX1_BUILD_REPORT.XLS TTA1120IEX1Schema.XSD

Description of Worksheets inside the Build Report.XLS

Each BUILD_REPORT.XLS (an Excel file) contains the worksheets listed below. All worksheets are sorted by DocumentID, sections, and DataTag.

Org_XML_DataDict_Xref (DATA DICTIONARY) This lists all form and field names in the subject tax application enabled for Return XML. It includes pertinent information for the data fields such as DocumentID, DataTag, Xrefname, data type, length, and so forth. To determine if a tax return Organizer data field is enabled for Return XML, find the DocumentID and DataTag of the subject data field, then search the tax application Data Dictionary for said value. If the value is not included in this tab, the subject data field is not enabled for Return XML import and export.

Txf_XML_DataDict_Xref This is blank as tax forms are not enabled for Return XML.

Wkp_XML_DataDict_Xref This is blank as workpapers are not enabled for Return XML.

XML_Required_Fields This lists Document ID and DataTag combinations that are required to be in an import file if the activity member or group member is to be created. If a required field is missing from the import file but other items in the associated group exist, then the import will be stopped before it begins. We validate the import file before import.

XML_Master_Group_Forms This tab lists master group activities. Master group activities are different types of income or assets that use common fields. The DocumentID determines which master group to associate the common field data.

XML_Child_Forms This tab lists child forms. Child forms are activities with common fields that can be associated underneath different tax forms. For example the document ID for Form 2106 is a child form and appears within the Schedule C in an XML file.

Field_Collections This tab lists groups of fields where, if one field contains data, the others in that group must also contain data.

Field_Collection_Field_Rules This tab lists instances where having data in one field is mutually exclusive with having data in another field.

Field_Collection_Group_Rules This tab lists instances where having data in one group of fields is mutually exclusive with having data in another group of fields. For example, if some parts of a US address are populated, then no part of the corresponding foreign address should be populated.

XML_Discontinued_Fields This lists the field values included in the prior PFS. They have been removed from the mapping for the current period PFS.

XML_Changed_Fields This lists current and prior field values for DocumentID, sections, and DataTag.

XML_New_Fields This lists new fields added with values for DocumentID, sections, and DataTag. They were not in a prior PFS.

XML_Data_Changes This lists field values for current and prior data type, length, and precision. These changes are tied to DocumentID, sections, and DataTag.

XML_String_Values This lists all the string values used in the current PFS by DocumentID, section, and DataTag.

Discontinued_XML_String_Values This lists string values that were in a prior period PFS and are no longer in the current PFS.

New_XML_String_Values This lists new string values for DocumentIDs that have been added to the PFS that were not of the prior PFS.

Changed_XML_String_Values This lists previous string values from a prior PFS to the current string values.

Org_Navigation This worksheet lists the navigation in the return for enabled Organizer fields.

Txf_Navigation This worksheet lists the navigation in the return for enabled Tax Form fields, which is blank here as tax forms are not enabled for Return XML.

Wkp_Navigation This worksheet lists the navigation in the return for enabled Workpaper fields, which is blank here as workpapers are not enabled for Return XML.

Users of the Build Report.XLS and the *Schema.XSD

The BUILD_REPORT.XLS is easier for accountants to understand. They will be able to sort cross-reference values and notice if items are added or deleted.

The *Schema.XSD is easier for programmers to understand. The *Schema.XSD file specifies formal descriptions of the elements in the XML file. These elements have rules for the data such as field length, field type, and field precision.

Validation Routine

Data is only validated on import. The reason to validate is to prevent unacceptable data from impacting the tax return. Validation checks items like field length, field attribute, if required, and structure for groupings. Upon export, the data is not validated. This is so that clients will be able to see data layout in an XML file or so they can use the data for other purposes.

 

 

 

Import/Export/rxml_online_9.htm/TY2021

Last Modified: 03/20/2020

Last System Build: 10/18/2022

©2021-2022 Thomson Reuters/Tax & Accounting.