{"id":22262,"date":"2026-07-29T10:35:07","date_gmt":"2026-07-29T10:35:07","guid":{"rendered":"https:\/\/tenthplanet.in\/idempiere\/?p=22262"},"modified":"2026-08-20T09:57:24","modified_gmt":"2026-08-20T09:57:24","slug":"how-to-use-export-format-in-idempiere","status":"publish","type":"post","link":"https:\/\/tenthplanet.in\/idempiere\/how-to-use-export-format-in-idempiere\/","title":{"rendered":"How to Use Export Format in iDempiere"},"content":{"rendered":"\n<p class=\"wp-block-paragraph\">Learn how the Export Format window in iDempiere defines XML export structure, fields, and reusable templates for data replication.<\/p>\n\n\n\n<h2 class=\"wp-block-heading\"><strong>Introduction<\/strong><\/h2>\n\n\n\n<p class=\"wp-block-paragraph\">The Export Format window defines the XML structure used when exporting iDempiere data. It specifies the source table, exported fields, and their sequence, acting as a reusable template for export operations.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">It is used within the standard replication framework to support data synchronization between systems.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">By standardizing export structure, it ensures consistent, accurate data replication without repeated custom development effort.<\/p>\n\n\n\n<h2 class=\"wp-block-heading\"><strong>Process Flow<\/strong><\/h2>\n\n\n\n<figure class=\"wp-block-image size-full\"><img loading=\"lazy\" decoding=\"async\" width=\"1024\" height=\"342\" src=\"https:\/\/tenthplanet.in\/idempiere\/wp-content\/uploads\/sites\/13\/2026\/07\/TenthPlanet-iDempiere-ExportFormat-WorkFlow.png\" alt=\"\" class=\"wp-image-27941\" title=\"\" srcset=\"https:\/\/tenthplanet.in\/idempiere\/wp-content\/uploads\/sites\/13\/2026\/07\/TenthPlanet-iDempiere-ExportFormat-WorkFlow.png 1024w, https:\/\/tenthplanet.in\/idempiere\/wp-content\/uploads\/sites\/13\/2026\/07\/TenthPlanet-iDempiere-ExportFormat-WorkFlow-300x100.png 300w, https:\/\/tenthplanet.in\/idempiere\/wp-content\/uploads\/sites\/13\/2026\/07\/TenthPlanet-iDempiere-ExportFormat-WorkFlow-768x257.png 768w\" sizes=\"auto, (max-width: 1024px) 100vw, 1024px\" \/><\/figure>\n\n\n\n<h2 class=\"wp-block-heading\"><strong>Business Rules<\/strong><\/h2>\n\n\n\n<ul class=\"wp-block-list\">\n<li>Every Export Format is associated with a single database table.<\/li>\n\n\n\n<li>The selected table determines which columns are available for export.<\/li>\n\n\n\n<li>One Export Format can contain multiple Export Format Lines.<\/li>\n\n\n\n<li>An inactive Export Format is excluded from export processing.<\/li>\n\n\n\n<li>SQL WHERE can restrict which records are exported, when defined.<\/li>\n\n\n\n<li>Position on each line controls the sequence of XML elements.<\/li>\n\n\n\n<li>Mandatory flag identifies XML elements that must be included in the export.<\/li>\n\n\n\n<li>XML Element type exports the database column value directly.<\/li>\n\n\n\n<li>Referenced EXP Format exports a related object using another Export Format.<\/li>\n\n\n\n<li>Embedded Format determines how referenced objects appear within the XML.<\/li>\n\n\n\n<li>Part Unique Index marks fields that contribute to record identification.<\/li>\n<\/ul>\n\n\n\n<h2 class=\"wp-block-heading\"><strong>Prerequisites<\/strong><\/h2>\n\n\n\n<ul class=\"wp-block-list\">\n<li>User access to the Replication module in the standard iDempiere menu.<\/li>\n\n\n\n<li>The source database table (e.g., M_Product, C_BPartner) must already exist in the Application Dictionary.<\/li>\n\n\n\n<li>Any referenced Export Formats must be created beforehand if used within Export Format Lines.<\/li>\n\n\n\n<li>A working knowledge of the target table structure and its key fields.<\/li>\n<\/ul>\n\n\n\n<h2 class=\"wp-block-heading\"><strong>Configuration Steps<\/strong><\/h2>\n\n\n\n<h3 class=\"wp-block-heading\"><strong>Step 1 \u2014 Create Export Format<\/strong><\/h3>\n\n\n\n<p class=\"wp-block-paragraph\">Why this step is required: An Export Format header must exist before individual export fields can be defined. It identifies the source table and overall export definition.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">Navigate to Replication \u2192 Export Format. Create a new record, enter a unique Search Key and Name, set the Version, select the source Table, and ensure Active is checked.<\/p>\n\n\n\n<figure class=\"wp-block-table\"><table><thead><tr><td><strong>Field<\/strong><\/td><td><strong>Sample Value<\/strong><\/td><td><strong>Description<\/strong><\/td><\/tr><\/thead><tbody><tr><td>Search Key<\/td><td>M_Product<\/td><td>Unique identifier of the export format<\/td><\/tr><tr><td>Name<\/td><td>Product<\/td><td>Display name of the export format<\/td><\/tr><tr><td>Version<\/td><td>3.2.0<\/td><td>Version of the export definition<\/td><\/tr><tr><td>Table<\/td><td>M_Product_Product<\/td><td>Source database table to export<\/td><\/tr><tr><td>Active<\/td><td>Yes<\/td><td>Indicates whether the export format is available for use<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n<figure class=\"wp-block-image size-full\"><img loading=\"lazy\" decoding=\"async\" width=\"1023\" height=\"436\" src=\"https:\/\/tenthplanet.in\/idempiere\/wp-content\/uploads\/sites\/13\/2026\/07\/TenthPlanet-iDempiere-GeneralRules-ExportFormat.png\" alt=\"\" class=\"wp-image-22265\" title=\"\" srcset=\"https:\/\/tenthplanet.in\/idempiere\/wp-content\/uploads\/sites\/13\/2026\/07\/TenthPlanet-iDempiere-GeneralRules-ExportFormat.png 1023w, https:\/\/tenthplanet.in\/idempiere\/wp-content\/uploads\/sites\/13\/2026\/07\/TenthPlanet-iDempiere-GeneralRules-ExportFormat-300x128.png 300w, https:\/\/tenthplanet.in\/idempiere\/wp-content\/uploads\/sites\/13\/2026\/07\/TenthPlanet-iDempiere-GeneralRules-ExportFormat-768x327.png 768w\" sizes=\"auto, (max-width: 1023px) 100vw, 1023px\" \/><\/figure>\n\n\n\n<h3 class=\"wp-block-heading\"><strong>Step 2 \u2014 Define Export Format Lines<\/strong><\/h3>\n\n\n\n<p class=\"wp-block-paragraph\">Each Export Format Line specifies one XML element included in the exported document, including its source column and how it is represented.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">In the Export Format Line tab, add a new line for each field. Set the Position, source Column, Type (XML Element or Referenced EXP Format), and Mandatory flag as needed.<\/p>\n\n\n\n<figure class=\"wp-block-table\"><table><thead><tr><td><strong>Field<\/strong><\/td><td><strong>Sample Value<\/strong><\/td><td><strong>Description<\/strong><\/td><\/tr><\/thead><tbody><tr><td>Position<\/td><td>10<\/td><td>Controls the sequence of the XML element in the export<\/td><\/tr><tr><td>Column<\/td><td>AD_Client_ID<\/td><td>Database column being exported<\/td><\/tr><tr><td>Type<\/td><td>Referenced EXP Format<\/td><td>Defines how the value is represented in the XML<\/td><\/tr><tr><td>Mandatory<\/td><td>Yes<\/td><td>Marks the element as required in the export<\/td><\/tr><tr><td>Part Unique Index<\/td><td>No<\/td><td>Indicates whether the field contributes to record identification<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n<figure class=\"wp-block-image size-full\"><img loading=\"lazy\" decoding=\"async\" width=\"1024\" height=\"728\" src=\"https:\/\/tenthplanet.in\/idempiere\/wp-content\/uploads\/sites\/13\/2026\/07\/TenthPlanet-iDempiere-GeneralRules-ExportFormat1.png\" alt=\"\" class=\"wp-image-22266\" title=\"\" srcset=\"https:\/\/tenthplanet.in\/idempiere\/wp-content\/uploads\/sites\/13\/2026\/07\/TenthPlanet-iDempiere-GeneralRules-ExportFormat1.png 1024w, https:\/\/tenthplanet.in\/idempiere\/wp-content\/uploads\/sites\/13\/2026\/07\/TenthPlanet-iDempiere-GeneralRules-ExportFormat1-300x213.png 300w, https:\/\/tenthplanet.in\/idempiere\/wp-content\/uploads\/sites\/13\/2026\/07\/TenthPlanet-iDempiere-GeneralRules-ExportFormat1-768x546.png 768w\" sizes=\"auto, (max-width: 1024px) 100vw, 1024px\" \/><\/figure>\n\n\n\n<h3 class=\"wp-block-heading\"><strong>Step 3 \u2014 Save the Export Format<\/strong><\/h3>\n\n\n\n<p class=\"wp-block-paragraph\">Saving stores the export definition so it can be referenced by other standard processes.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">Save the record after the header and lines are configured. No additional fields are required for this action step.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">Once saved, the Export Format becomes available for selection in the Test Export Model process and within Replication Strategy configuration.<\/p>\n\n\n\n<h2 class=\"wp-block-heading\"><strong>Common Issues and Resolutions<\/strong><\/h2>\n\n\n\n<figure class=\"wp-block-table\"><table><thead><tr><td><strong>Issue<\/strong><\/td><td><strong>Cause<\/strong><\/td><td><strong>Resolution<\/strong><\/td><\/tr><\/thead><tbody><tr><td>Export Format does not appear in export processes<\/td><td>The record is marked Inactive<\/td><td>Set the Active flag to Yes and save the record<\/td><\/tr><tr><td>Incorrect XML structure generated<\/td><td>Export Format Lines are misconfigured or out of sequence<\/td><td>Review line positions and column mappings<\/td><\/tr><tr><td>Referenced data missing from export<\/td><td>Referenced EXP Format is not linked correctly<\/td><td>Verify the referenced Export Format is configured correctly<\/td><\/tr><tr><td>Exported records are missing<\/td><td>SQL WHERE clause is too restrictive<\/td><td>Review and adjust the SQL WHERE condition<\/td><\/tr><tr><td>Related object data fails to export<\/td><td>Embedded Format is not defined for the referenced object<\/td><td>Configure Embedded Format on the relevant line<\/td><\/tr><tr><td>Wrong columns appear in the export<\/td><td>Incorrect Table selected in the header<\/td><td>Confirm the correct Table is selected in the Export Format header<\/td><\/tr><tr><td>Duplicate or unidentifiable records in XML<\/td><td>Part Unique Index not marked on key fields<\/td><td>Mark the relevant identifying fields as Part Unique Index<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n<h2 class=\"wp-block-heading\"><strong>Next Steps<\/strong><\/h2>\n\n\n\n<ol class=\"wp-block-list\">\n<li>Configure the Export Format Lines for the export definition.<\/li>\n\n\n\n<li>Associate the Export Format with a Replication Strategy.<\/li>\n\n\n\n<li>Configure an Export Processor.<\/li>\n\n\n\n<li>Run the Test Export Model process to generate the XML output.<\/li>\n\n\n\n<li>Validate the generated XML before using it for replication.<\/li>\n<\/ol>\n","protected":false},"excerpt":{"rendered":"<p>Learn how the Export Format window in iDempiere defines XML export structure, fields, and reusable templates for data replication. Introduction [&hellip;]<\/p>\n","protected":false},"author":3,"featured_media":0,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[91,10],"tags":[],"class_list":["post-22262","post","type-post","status-publish","format-standard","hentry","category-idempiere-general-rules","category-idempiere-product"],"_links":{"self":[{"href":"https:\/\/tenthplanet.in\/idempiere\/wp-json\/wp\/v2\/posts\/22262","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/tenthplanet.in\/idempiere\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/tenthplanet.in\/idempiere\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/tenthplanet.in\/idempiere\/wp-json\/wp\/v2\/users\/3"}],"replies":[{"embeddable":true,"href":"https:\/\/tenthplanet.in\/idempiere\/wp-json\/wp\/v2\/comments?post=22262"}],"version-history":[{"count":0,"href":"https:\/\/tenthplanet.in\/idempiere\/wp-json\/wp\/v2\/posts\/22262\/revisions"}],"wp:attachment":[{"href":"https:\/\/tenthplanet.in\/idempiere\/wp-json\/wp\/v2\/media?parent=22262"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/tenthplanet.in\/idempiere\/wp-json\/wp\/v2\/categories?post=22262"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/tenthplanet.in\/idempiere\/wp-json\/wp\/v2\/tags?post=22262"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}