Creating an XML Overlay
Posted by Maddison Mitchell, Last modified by Amy Wallace on 16 June 2021 01:43 PM

Creating an XML Overlay

 

1.   Create word document you wish to display as XML overlay

 

2.   Open document in PDF format and ensure rulers are visible in millimeters. Please note the PDF file provided must be PDF version 1.4 or lower.

 

3.   Measure both horizontally (xPos) and vertically(yPos) from top left corner as to where the first merge field is to appear

 

4.   Open a Notepad document and type <fields>

 

5.   Below this heading type the details of the first merge field as below

 

<field>

 

<name>xx</name>          (where xx is the name of the merge field)

 

<xPos>xx</xPos>               (where xx is the horizontal distance in millimeters)

 

<yPos>xx</yPos>               (where xx is the vertical distance in millimeters)

 

<font>xx</font>                 (where xx is the font you wish to use for the document)

 

<fontSize>10</fontSize>     (where xx is the font size you wish to use for the document)

 

<fontWeight/>

 

</field>

 

6.   Repeat step 5 for each merge field for the entire document

 

7.   At the end of the document type </fields>

 

8.   Save document with the file extension .xml

 

XML Field Options

 

The following fields are available for use in your XML overlay for online Membership Purchases.

  • site_name
  • id
  • people_id
  • product_id
  • product_description
  • up_front_payment
  • payment_type
  • first_name
  • last_name
  • gender
  • date_of_birth
  • street
  • suburb
  • state
  • postcode
  • home_phone
  • work_phone
  • mobile_phone
  • email
  • join_fee
  • retail_price
  • period
  • period_unit
  • dd_start_date
  • pro_rata
  • pro_rata_desc
  • pay_for_next_period
  • next_dd_payment_date
    • cc_amount
      • client_ip
      • emergency_primary_name
      • emergency_primary_relationship
      • emergency_primary_phone
      • emergency_primary_mobile
      • emergency_secondary_name
      • emergency_secondary_relationship
      • emergency_secondary_phone
      • emergency_secondary_mobile
      • links_membership_contract_id
      • links_transaction_id
      • linkspay_transaction_id
      • start_date
      • date_created
      • product_code
      • cc_card_type

       

      Where does the come from in the Links database?

      XML Compass Field Links DB Table Links DB Column
           
      site_name NA/AC Only or Calculated Field NA
      id NA/AC Only or Calculated Field NA
      people_id People Id
      product_id Products Id
      product_description Products Description
      up_front_payment NA/AC Only or Calculated Field NA
      payment_type MembershipContracts PaymentType
      first_name People GivenNames
      last_name People Surname
      gender People Gender
      date_of_birth People DateOfBirth
      street People Address
      suburb People Suburb
      state People State
      postcode People Postcode
      home_phone People HomePhone
      work_phone People WorkPhone
      mobile_phone People MobilePhone
      email People Email
      join_fee ProductLocations RetailPrice
      retail_price MembershipTypes RetailPriceTermUpfront / RetailPriceDirDebitPayment
      period MembershipVPCategories DDPeriodNo
      period_unit MembershipVPCategories DDPeriodUnit
      dd_start_date MembershipVPCategories DDStartDate
      pro_rata MembershipVPCategories DDMaxDaysProrata
      pro_rata_desc NA/AC Only or Calculated Field NA
      pay_for_next_period NA/AC Only or Calculated Field NA
      next_dd_payment_date NA/AC Only or Calculated Field NA
      cc_name_on_card NA/AC Only or Calculated Field NA
      cc_credit_card_number NA/AC Only or Calculated Field NA
      cc_expiry_month NA/AC Only or Calculated Field NA
      cc_expiry_year NA/AC Only or Calculated Field NA
      cc_cvv NA/AC Only or Calculated Field NA
      cc_amount NA/AC Only or Calculated Field NA
      dd_bsb NA/AC Only or Calculated Field NA
      dd_account_name NA/AC Only or Calculated Field NA
      dd_account_number NA/AC Only or Calculated Field NA
      dd_bank_name NA/AC Only or Calculated Field NA
      dd_branch_name NA/AC Only or Calculated Field NA
      dd_usa_payment_type NA/AC Only or Calculated Field NA
      client_ip NA/AC Only or Calculated Field NA
      emergency_primary_name People EmergName
      emergency_primary_relationship People EmergRelship
      emergency_primary_phone People EmergPhone
      emergency_primary_mobile People EmergMobPhone
      emergency_secondary_name People EmergName1
      emergency_secondary_relationship People EmergRelship1
      emergency_secondary_phone People EmergPhone1
      emergency_secondary_mobile People EmergMobPhone1
      links_membership_contract_id MembershipContracts Id
      links_transaction_id Transactions Id
      linkspay_transaction_id NA/AC Only or Calculated Field NA
      start_date MembershipContracts DateStarted
      date_created NA NA
      product_code Products ProductCode
      cc_card_type NA/AC Only or Calculated Field NA


      Attachments