Beacon schema

Build 1501 on 14/Nov/2017  This topic last edited on: 24/Oct/2016, at 14:37

In the below XML Beacon file example we have placed some comments (in green) which explain how the different information provided are used.

<?xml version="1.0"?>

<beacon_export>

 <product>

         <data> <!-- ONLY for Back4 import -->

      <product_title_name>Globe</product_title_name> <!-- Edition/Edition template title -->

      <cover_date value="42167">2015-06-13</cover_date> <!-- Edition Date -->

      <product_name>Henley Standard</product_name> <!-- Edition name -->

      <product_code>Test2Template</product_code> <!-- optional: Edition Template name: the new edition is passed on this edition template (masters and dimensions). If not specified he default GN4 values are used -->

      <total_pages value="80">80</total_pages>

    </data>

         <planned_pages>

                 <planned_page id="1">

                         <data>

                                 <page value="1">1</page> <!—REQUIRED: page number -->

                                 <page_group_name>ROP</page_group_name> <!-- optional, set GN4 section if the "section as GN4 zone" option is enabled, nothing otherwise. If not specified the default value is used -->

                                 <page_in_group value="1">1</page_in_group>

                                 <page_in_product value="1">1</page_in_product>

                                 <page_in_section value="1">1</page_in_section> <!-- optional, populate the externalSectionNumber extra attribute (0 if missing)-->

                                 <printable_hash value="1">1</printable_hash> <!-- optional, populate the externalPrintableNumber extra attribute (0 if missing) -->

                                 <printable_override_query>No</printable_override_query>

                                 <section value="6">1</section> <!-- optional, set GN4 zone if the "section as GN4 zone" option is enabled, section otherwise. If missing the default value is set -->

                                 <page_status value="1">1</page_status> <!-- optional, set the page workstate -->

                                 <sequential_hash value="1">1</sequential_hash>

                                 <next_page value="2">2</next_page>

                                 <paired_page value="104">104</paired_page>

                                 <verso_page value="2">2</verso_page>

                                 <planned_page_id>7BAAA600-2C0B-4D3B-ACA2-8BC8DA7271C7</planned_page_id> <!—REQUIRED: used internally -->

                                 <image_summary>Good - 1 present</image_summary>

                                 <page_ready_query>Yes</page_ready_query>

                                 <template>760 Compact ROP 8cols jan 2012/Standard Left</template> <!-- optional, GN4 master page name. Used to match the correct Master when import option “Assign masters from XML” is active -->

                                 <left_margin value="0.899993896484375">0.9 cm</left_margin>

                                 <right_margin value="0.899993896484375">0.9 cm</right_margin>

                                 <top_margin value="0.699996948242188">0.7 cm</top_margin>

                                 <bottom_margin value="1">1 cm</bottom_margin>

                         </data>

                 </planned_page>

         </planned_pages>

         <planned_rectangles>

                 <planned_adverts>

                         <planned_rectangle id="DCAC1B01-33CF-407C-8CCE-208C0DD1F301"> <!-- ID optional, is the AD name (4th choice)-->

                                 <data>

                                         <page value="1">1</page>  <!-- REQUIRED -->

                                         <collect_for_output_name>Dummy.pdf</collect_for_output_name> <!-- optional, is the AD name (1st choice), if missing use 'urn' node  -->

                                         <urn>000968315</urn> <!-- optional, is the AD name (2nd choice), if missing use 'identifier' node  -->

                                         <identifier>000968315</identifier> <!-- optional, is the AD name (3rd choice), if missing use the 'planned_rectangle@id -->

                                         <section>1</section> <!-- optional, set GN4 zone if "section as GN4 zone" is active, section otherwise, if missing set the default value -->

                                         <page_group_name>ROP</page_group_name> <!-- optional, set GN4 section if the "section as GN4 zone" option is active, nothing otherwise. If missing the default value is set -->

                                         <top_output value="5">5 cm</top_output>

                                         <bottom_output>0 cm</bottom_output> <!-- REQUIRED, use value attribute or inner text, is Y -->

                                         <left_output>0 cm</left_output> <!-- REQUIRED, use value attribute or inner text, is X -->

                                         <right_output value="28.6499938964844">28.65 cm</right_output>

                                         <customer>Newbury Audi</customer> <!-- optional, is Ad Client -->

                                         <width value="28.6499938964844">28.65 cm</width> <!-- REQUIRED, use VALUE attribute, width -->

                                         <depth value="5">5 cm</depth> <!-- REQUIRED, use VALUE attribute, height -->

                                 </data>

                         </planned_rectangle>

                 </planned_adverts>

                 <planned_fillers> <!-- same rule of planned_rectangles -->

                         <planned_rectangle id="33ECBEFD-744F-48D0-BDB3-5CB5099A8CE9">

                                 <data>

                                         <page value="1">1</page>

                                         <identifier>seen anything 10x2</identifier>

                                         <top_output value="19.7021026611328">19.7 cm</top_output>

                                         <left_output value="8.13748168945313">8.14 cm</left_output>

                                         <right_output value="15.0749664306641">15.07 cm</right_output>

                                         <bottom_output value="7.72630310058594">7.73 cm</bottom_output>

                                         <width value="6.93748474121094" colour="255">6.94 cm</width>

                                         <depth value="11.9757995605469" colour="255">11.98 cm</depth>

                                         <section value="6">1</section>

                                         <page_in_section value="1">1</page_in_section>

                                 </data>

                         </planned_rectangle>

                 </planned_fillers>

         </planned_rectangles>

 </product>

</beacon_export>