Template Variabelen - een overzicht

Transcriptie

1 Template n - een overzicht Gestandaardiseerde s worden gemaakt op basis van een template. In een template maakt u gebruik van dynamische velden (variabelen). Dit zijn velden waarvan de inhoud uit de achterliggende database wordt gehaald, bijvoorbeeld de door de klant opgegeven achternaam. n worden in i-reserve onder andere gebruikt in templates en in factuur templates. Een voorbeeld van het gebruik van basis variabelen in een template ziet u in onderstaande schermprint: Deze tutorial bevat een overzicht en omschrijving van variabelen die in i-reserve beschikbaar zijn. Er wordt hierbij onderscheid gemaakt tussen basis variabelen en geavanceerde variabelen. De basis variabelen zijn direct toepasbaar in de editor, voor de geavanceerde variabelen moet u een start- en eindcode in de achterliggende html bron opnemen. Hoe dit in zijn werk gaat wordt uitgelegd in de paragraaf Geavanceerde n. Basis n / factuur templates *V4* : Beschikbaar vanaf versie 4 (en hoger) Start/Eindcode: geen {COMPANY_NAME} {BOOKING_NUMBER} {FULLNAME} {SEX} {INITIALS} {PREFIX} {LASTNAME} {CITY} Uw bedrijfsnaam, zoals opgegeven in configuratie Reserveringsnummer Volledig samengestelde naam van de klant (bijv: Mw. S. de Groot) Geslacht van de klant Initialen van de klant Tussenvoegsel van de klant Achternaam van de klant Plaatsnaam van de klant Teqa Webdiensten Pagina 1

2 {USERNAME} Gebruikersnaam van de klant { } adres van de klant {POSTAL} Postcode van de klant {HOUSENUM} Huisnummer van de klant {HOUSENUMEXT} Huisnummer toevoeging van de klant {ADDRESS1} Eerste adresregel van de klant {ADDRESS2} Tweede adresregel van de klant {ADDRESS3} Derde adresregel van de klant {COUNTRY} Land behorend bij adres van de klant {TEL_HOME} Telefoon nummer thuis van de klant {TEL_WORK} Telefoon nummer werk van de klant {TEL_MOB} Telefoon nummer mobiel van de klant {TEL_FAX} Fax nummer van de klant {PROD_DESC} Product beschrijving van het product waar de boeking voor geldt {PROD_SHORT_DESC} Product korte beschrijving van het product waar de boeking voor geldt {PROD_LONG_DESC} Product lange beschrijving van het product waar de boeking voor geldt {PROD_MEMO} Product memo beschrijving van het product waar de boeking voor geldt {PROD_MAIN_DESC} De omschrijving van het hoofd object/product welke geboekt is {GROUP_DESC} De groep omschrijving van het object/product welke geboekt is {GROUP_LONG_DESC} De uitgebreide groep omschrijving van het object/product welke geboekt is {FROM} Vanaf datum/tijd van de boeking {TILL} Tot en met datum/tijd van de boeking {FROMTIME} Vanaf tijd van de boeking {TILLTIME} Tot en met tijd van de boeking {FROMDATE} Vanaf datum van de boeking {TILLDATE} Tot en met datum van de boeking {NUMBER_OF_PLACES} Aantal plaatsen waarvoor de boeking is gedaan {NUMBER_OF_PARTICIPANTS} Aantal deelnemers {TOTAL_PRICE} Totale prijs van de boeking {TOTAL_PRICE_WITHOUT_OPTIONS} Totale prijs van de boeking, zonder opties, ook wel reissom genoemd {TOTAL_PRICE_FEE} Totale commissie {TOTAL_PRICE_PAID} Hoeveel is er betaald {TOTAL_PRICETO_BE_PAID} Hoeveel moet er nog betaald worden (alleen gevuld met te betalen bedrag) {TOTAL_PRICETO_BE_RECEIVED} Hoeveel wordt er nog ontvangen (alleen gevuld met te ontvangen bedrag) {TOTAL_PRICE_LEFT} Bedrag zonder minteken, of het nu te betalen of te ontvangen is. Normaliter gebruikt in combinatie met PAYMENT_TEXT {BAIL} Openstaande borg {PAYMENT_TEXT} Afgeleid van de factuurinstellingen {CURRENCY} Munteenheid van de totale prijs van de boeking {WELCOME_MSG} aanhef, zoals gezet in het configuratiepaneel { _SIG} signatuur, zoals gezet in het configuratiepaneel {SITE_URL} De url van de site waarop i-reserve is geïnstalleerd {REMARKS} Opmerkingen die ingevoerd zijn bij de reservering {FACT_POSTAL} Postcode van het factuuradres {FACT_HOUSENUM} Huisnummer van het factuuradres {FACT_HOUSENUMEXT} Huisnummer toevoeging van het factuuradres {FACT_ADDRESS1} Factuur adresregel 1 Teqa Webdiensten Pagina 2

3 {FACT_ADDRESS2} Factuur adresregel 2 {FACT_ADDRESS3} Factuur adresregel 3 {FACT_CITY} Plaatsnaam van het factuuradres {FACT_COUNTRY} Land behorend bij het factuuradres {COMP_NAME} Bedrijfsnaam (van de klant) {COMP_TEL} Telefoonnummer van het bedrijf (van de klant) {COMP_FAX} Faxnummer van het bedrijf (van de klant) {STUDENT} Studentnummer {CUSTOM01} {CUSTOM02} {CUSTOM03} {CUSTOM04} {CUSTOM05} {CUSTOM06} {CUSTOM07} {CUSTOM08} {CUSTOM09} {CUSTOM10} {CUSTOMER_ID} Klantnummer {RES_CUSTOM01} {RES_CUSTOM02} {RES_CUSTOM03} {RES_CUSTOM04} {RES_CUSTOM05} {RES_CUSTOM06} {RES_CUSTOM07} {RES_CUSTOM08} {RES_CUSTOM09} {RES_CUSTOM10} {DATE_CURRENT} Huidige datum, conform Standaard datum opmaak in Configuratie {DATE_BOOKING} Datum waarop reservering gemaakt is, conform Standaard datum opmaak in Configuratie {TIME_CURRENT} Huidige tijd, conform Standaard tijd opmaak in Configuratie {TIME_BOOKING} Tijdstip waarop reservering gemaakt is, conform Standaard tijd opmaak in Configuratie {USERCREATED} Gebruikersnaam welke de boeking heeft aangemaakt {USERCHANGED} Gebruikersnaam welke de boeking voor het laatst heeft gewijzigd {LOCATION} Naam van de locatie {LOCATION_DESC} van de locatie {INVOICE} Factuur als pdf bijlage toevoegen {INVOICE_NUMBER} Factuurnummer {INVOICE_DATE} Factuurdatum {EVENT_DESC} Evenement omschrijving {VAL_FRANCHISE} Vestiging {S_DETAIL} die aangeeft of de details gevuld zijn of niet {S_COMBIDETAIL} die aangeeft of de combidetails gevuld zijn of niet {S_PARTICIPANTS} die aangeeft of de deelnemers gevuld zijn of niet {S_OPTIONS} die aangeeft of de opties gevuld zijn of niet {S_PAYMENTS} die aangeeft of de betalingen gevuld zijn of niet {S_ADDITIONALDETAIL } die aangeeft of de terugkeerboekingen gevuld zijn of niet {S_QUESTIONS} die aangeeft of de vragen gevuld zijn of niet {BANKACCOUNT} Bankrekeningnummer (*V4*) Teqa Webdiensten Pagina 3

4 {BANKNAME} {IBAN} {BIC} {VATCODE} {INVOICESENDING} {CUST_PAYMENTMETHOD} {CUST_PAYMENTMETHOD_DESC} {INV_PAYMENTMETHOD} {INV_PAYMENTMETHOD_DESC} Tenaamstelling bank (*V4*) Het IBAN nummer (*V4*) Het BIC nummer (*V4*) Het BTW nummer van de klant (*V4*) Methode van verzending van de factuur(*v4*) Betaalwijze van de klant Code (*V4*) Betaalwijze van de klant (*V4*) Betaalwijze van de factuur Code (*V4*) Betaalwijze van de factuur (*V4*) Basis n - Alleen Start/Eindcode: geen {ICALENDAR} {ACCEPTLINK} {EDITBOOKLINK} {EDITOPTIONSLINK} {EDITPARTSLINK} {BIRTHDATE} {SIGNUPDATE} {EXPIREDATE} {MEMBER_ID} {ID_NUMBER} {ID_TYPE} Een bestand wordt bijgesloten in het internationale icalendar formaat. Dit is een bestand met de gegevens van de boeking en kan direct in de agenda worden opgenomen door de ontvanger Accepteer link. Via deze link kan de klant kiezen uit de opties om de reservering te accepteren of te annuleren. Dit is afhankelijk van de status die de reservering heeft en/of de status staat ingesteld om te mogen accepteren in status instellingen Link voor het wijzigen van een boeking. Werkt met een speciale code, waardoor niet ingelogd hoeft te worden. Link voor het wijzigen van de opties bij een boeking. Werkt met een speciale code, waardoor niet ingelogd hoeft te worden. Link voor het wijzigen van de deelnemers van een boeking. Werkt met een speciale code, waardoor niet ingelogd hoeft te worden. De geboortedatum De aanmelddatum De opzegdatum Het lidmaatschapsnummer Het nummer van het identiteitsbewijs Het type van het identiteitsbewijs (paspoort, rijsbewijs) Basis n - Alleen Object Start/Eindcode: geen {OBJ_SHORT_DESC} {OBJ_DESC} {OBJ_LONG_DESC} {OBJ_LONG_MEMO} {OBJ_PLACES_SINGLE} {OBJ_PLACES_PLURAL} {OBJ_ _WELCOME} {OBJ_ _SIGNATURE} {OBJ_POSTAL} {OBJ_HOUSENUM} Korte omschrijving Uitgebreide omschrijving Memo tekst Plaatsen enkelvoud Plaatsen meervoud welkomsttekst handtekening Postcode Huisnummer Teqa Webdiensten Pagina 4

5 {OBJ_HOUSENUMEXT} Huisnummer extensie {OBJ_ADDRESS1} Adres regel 1 {OBJ_ADDRESS2} Adres regel 2 {OBJ_ADDRESS3} Adres regel 3 {OBJ_CITY} Plaats {OBJ_STATE} Staat {OBJ_REGION} Regio {OBJ_COUNTRY} Land {OBJ_TEL_WORK} Telefoon werk {OBJ_WEBSITE} Website {OBJ_ } adres {OBJ_CHK_CUSTOMxx} Waar/niet waar velden bij object {OBJ_LONG_CUSTOMxx} Uitgebreide extra tekst velden bij object {OBJ_TXT_CUSTOMxx} Tekstvelden bij object Geavanceerde n Deze variabelen zijn onderverdeeld in vier soorten: Details Opties Deelnemers Extra Vragen Voor iedere soort is er een zogenaamde start- en eindcode die u moet opnemen in de html bron van de template. Hoe u dat doet wordt hieronder beschreven aan de hand van een uitgewerkt voorbeeld m.b.t. de Deelnemers n. Daarna volgen vier subparagrafen waarin voor iedere soort geavanceerde variabele wordt aangegeven voor welke templates deze ter beschikking staan en wat de benodigde start- en eindcodes zijn. Iedere subparagraaf wordt afgesloten met een tabel waarin u een overzicht en omschrijving van betreffende geavanceerde variabelen kunt vinden. Uitleg gebruik van start- en eindcodes Open de template die u wilt bewerken of maak een nieuwe template, het scherm Wijzig Templates verschijnt. Indien u niet weet hoe u dit moet doen is het zinvol eerst de tutorial Template te lezen. In de editor maakt u bijvoorbeeld onderstaande tabel die de gegevens van de deelnemers moet laten zien; onderstaande schermprint toont slechts een deel van de gemaakte tabel: Klik vervolgens op de HTML BUTTON in de editor om de achterliggende html bron in een nieuw venster te openen, zie schermprint op de volgende pagina: Teqa Webdiensten Pagina 5

6 Zoals gezegd verschijnt de html bron in een nieuw venster. Het deel van de html code dat de Deelnemers n bevat, ziet u in onderstaande schermprint: Om ervoor te zorgen dat deze dynamische velden worden gevuld met de gegevens die in de database zijn opgeslagen, moet u voor geavanceerde variabelen de juiste start- en eindcode in de html bron toevoegen. U plaatst de start- en eindcode dusdanig dat alle variabelen van deze soort als het ware ingekapseld zijn tussen deze twee codes. In ons voorbeeld komt dit er als volgt uit te zien: Klik vervolgens op de BUTTON TOEPASSEN om de wijzigingen op te slaan en het venster met de html bron te sluiten. U bent nu terug in het scherm Wijzig Templates. Teqa Webdiensten Pagina 6

7 Klik onder de editor op de BUTTON WIJZIGINGEN OPSLAAN en vul vervolgens een (bestaand!) reserveringsnummer in en klik op de BUTTON TOON PREVIEW: Een nieuw venster opent waarin u kan controleren of de dynamische velden correct worden ingevuld en of het resultaat naar wens is. Ons voorbeeld geeft het volgende resultaat: Details De hier omschreven variabelen hebben betrekking op de reserveringsdetails zoals omschrijving, tijdstip, aantal dagen/nachten, prijs etc. / factuur templates Startcode: <!-- BEGIN detail --> Eindcode: <!-- END detail --> De geavanceerde variabelen Details kunnen in Detail Velden en/of in Totaal Velden worden opgenomen. De bijbehorende parameterwaarden staan in onderstaande tabel. Op de volgende pagina staan twee schermprints die duidelijk maken wat Detail Velden en wat Totaal Velden zijn! Detail Velden Totaal Velden {detail.detail} Detail van het product en/of detail van de optie etc. {detail.description} {TOTAL_DESCRIPTION} {detail.currency} {TOTAL_CURRENCY} Valuta {detail.from} {TOTAL_FROM} Datum vanaf {detail.till} {TOTAL_TILL} Datum tot {detail.fromtime} {TOTAL_FROMTIME} Tijdstip vanaf {detail.tilltime} {TOTAL_TILLTIME} Tijdstip tot {detail.days} {TOTAL_DAYS} Aantal dagen {detail.nights} {TOTAL_NIGHTS} Aantal nachten {detail.participants} {TOTAL_PARTICIPANTS} Deelnemers {detail.number_of_places} {TOTAL_NUMBER_OF_PLACES} Aantal {detail.s_positive} Waar of niet waar als bedrag positief is {detail.price} {TOTAL_PRICE} Prijs {detail.discount} {TOTAL_DISCOUNT} Korting omschrijving {detail.discount_total} {TOTAL_DISCOUNT_TOTAL} Korting {detail.vat_description} BTW omschrijving {detail.vat} {TOTAL_VAT} BTW Teqa Webdiensten Pagina 7

8 {detail.vat_exclusive} {TOTAL_VAT_EXCLUSIVE} excl. BTW {detail.subtotal} {TOTAL_TOTAL} Subtotaal / Totaal {detail.per_desc} Periode omschrijving {detail.part_desc} Deelnemer omschrijving {detail.prod_desc} Product omschrijving {detail.fee_desc} {TOTAL_FEE_DESC} commissie {detail.fee_amount} {TOTAL_FEE_AMOUNT} Commissie bedrag {detail.fee_sub} {TOTAL_FEE_SUB} Netto bedrag (Subtotaal minus commissie) {detail.fee_vat} {TOTAL_FEE_VAT} BTW van netto bedrag {detail.fee_vat_exclusive } {TOTAL_FEE_VAT_EXCLUSIVE} Excl. BTW van netto bedrag In onderstaande schermprints zijn de Detail Velden rood gearceerd. De Totaal Velden zijn groen gearceerd. De bovenste schermprint toont de template in de editor, de onderste schermprint toont het resultaat: Deelnemers De hier omschreven variabelen halen hun waardes uit de (door de klant opgegeven) informatie in het optionele formulier speciaal voor deelnemers (zogenaamde Deelnemers velden). Startcode: <!-- BEGIN participants --> Eindcode: <!-- END participants --> {participants.name} {participants.description} {participants.initials} {participants.prefix} {participants.lastname} {participants.sex} {participants.membernumber} {participants.birthdate} {participants.id_number} {participants.id_type} {participants.customxx} Deelnemertype Deelnemeromschrijving Initialen Voorvoegsel Achternaam Geslacht Lidmaatschapnummer Geboortedatum Identificatie nummer Identificatie type Aangepast veld xx: geef voor xx het nummer op van betreffende veld! Zie uitleg aangepaste velden/taalinstellingen in de tutorial Deelnemers. Details arrangement De hier omschreven variabelen halen hun waardes uit de gegevens van een arrangement. Teqa Webdiensten Pagina 8

9 Startcode: <!-- BEGIN combidetail --> Eindcode: <!-- END combidetail --> {combidetail.booking_number} {combidetail.prod_desc} {combidetail.prod_long_desc} {combidetail.prod_long_memo} {combidetail.fromdate} {combidetail.tilldate} {combidetail.number_of_places} {combidetail.fromtime} {combidetail.tiltime} {combidetail.price} {combidetail.price_no_opt} {combidetail.paid} {combidetail.price_fee} {combidetail.currency} {combidetail.res_customxx} {combidetail.obj_xx} Arrangementsnummer Uitgebreide omschrijving Uitgebreide omschrijving Vanaf Tot en met Aantal Tijd vanaf Tijd tot Prijs Prijs zonder opties Reeds betaald Commissie prijs Valuta Aangepast veld xx: geef voor xx het nummer op van betreffende veld! Alle object velden die beschreven zijn bij de sectie object in dit document Details terugkerende boekingen De hier omschreven variabelen halen hun waardes uit de gegevens van de boekingen die in een reeks zijn opgenomen. Startcode: <!-- BEGIN additionaldetail --> Eindcode: <!-- END additionaldetail --> {additionaldetail.booking_number} {additionaldetail.description} {additionaldetail.long_desc} {additionaldetail.long_memo} {additionaldetail.fromdate} {additionaldetail.number_of_places} {additionaldetail.fromtime} {additionaldetail.tiltime} {additionaldetail.res_customxx} {additionaldetail.obj_xx} Arrangementsnummer Uitgebreide omschrijving Uitgebreide omschrijving Vanaf Aantal Tijd vanaf Tijd tot Aangepast veld xx: geef voor xx het nummer op van betreffende veld! Alle object velden die beschreven zijn bij de sectie object in dit document Opties: De hier omschreven variabelen halen hun waardes uit de (door de klant opgegeven) informatie in het optionele Opties scherm. Teqa Webdiensten Pagina 9

10 Startcode: <!-- BEGIN options --> Eindcode: <!-- END options --> {options.description} van de optie {options.number} Aantal {options.price} Prijs (= zonder valuta teken) {options.format_price} Geformatteerde prijs (= opgemaakte prijs, bijv. 25,00) {options.total_price} De totale prijs {options.format_total_price} Geformatteerde totaalprijs {options.currency} Valuta {options.group} Groep Extra vragen: De hier omschreven variabelen halen hun waardes uit de (door de klant opgegeven) informatie in het optionele Extra Vragen scherm. Startcode: <!-- BEGIN questions --> Eindcode: <!-- END questions --> {questions.question} {questions.answer} Vraag Antwoord Betaalschema: De hier omschreven variabelen halen hun waardes uit de betaalschema s. Startcode: <!-- BEGIN paymentschedules --> Eindcode: <!-- END paymentschedules --> {paymentschedules.name} Naam van het betaalschema {paymentschedules.description} van het betaalschema {paymentschedules.price} Prijs (=functionele prijs, bijvoorbeeld 20 %) {paymentschedules.date} Datum (= functionele datum, bijvoorbeeld Direct na boeking ) {paymentschedules.actual_price} Werkelijke prijs {paymentschedules.actual_date} Werkelijke datum {paymentschedules.status} Status {paymentschedules.paid} Betaald {paymentschedules.payment_method} Betaalmethode {paymentschedules.remarks} Opmerkingen Teqa Webdiensten Pagina 10

11 Betalingen: De hier omschreven variabelen halen hun waardes uit de succesvolle betalingen. Startcode: <!-- BEGIN payments --> Eindcode: <!-- END payments --> {payments.statuscode} {payments.statusdesc} {payments.statuslongdesc} {payments.transactionid} {payments.price} {payments.currency} {payments.format_price} {payments.method} {payments.remarks} {payments.desc} {payments.long_desc} Status code Status omschrijving Status uitgebreide omschrijving Transactie ID Betaald bedrag Valuta Opgemaakte prijs Methode Opmerkingen Uitgebreide omschrijving n voor kortingsbon module: Deze paragraaf is alleen van toepassing voor de opmaak van de kortingsbonnen. Beschikbaar in: kadobon module Startcode: geen Eindcode: geen {VOUCHER_NAME} {VOUCHER_DESC} {VOUCHER_LONG_DESC} {VOUCHER_LONG_MEMO} {GIFT_VOUCHER} {GIFT_VALIDFROM} {GIFT_VALIDTILL} {GIFT_PRICEFORMAT} {GIFT_PRICE} {GIFT_CURRENCY} {COMPANY_NAME} {FULLNAME} {SEX} {INITIALS} {PREFIX} {LASTNAME} {CITY} {USERNAME} { } {POSTAL} {HOUSENUM} Kadobon naam Kadobon omschrijving Kadobon uitgebreide omschrijving Kadobon memo Kadobon code Geldig vanaf Geldig tot Opgemaakte prijs Prijs Valuta Uw bedrijfsnaam, zoals opgegeven in configuratie Volledig samengestelde naam van de klant (bijv: Mw. S. de Groot) Geslacht van de klant Initialen van de klant Tussenvoegsel van de klant Achternaam van de klant Plaatsnaam van de klant Gebruikersnaam van de klant adres van de klant Postcode van de klant Huisnummer van de klant Teqa Webdiensten Pagina 11

12 {HOUSENUMEXT} Huisnummer toevoeging van de klant {ADDRESS1} Eerste adresregel van de klant {ADDRESS2} Tweede adresregel van de klant {ADDRESS3} Derde adresregel van de klant {COUNTRY} Land behorend bij adres van de klant {TEL_HOME} Telefoon nummer thuis van de klant {TEL_WORK} Telefoon nummer werk van de klant {TEL_MOB} Telefoon nummer mobiel van de klant {TEL_FAX} Fax nummer van de klant {WELCOME_MSG} aanhef, zoals gezet in het configuratiepaneel { _SIG} signatuur, zoals gezet in het configuratiepaneel {SITE_URL} De url van de site waarop i-reserve is geïnstalleerd {FACT_POSTAL} Postcode van het factuuradres {FACT_HOUSENUM} Huisnummer van het factuuradres {FACT_HOUSENUMEXT} Huisnummer toevoeging van het factuuradres {FACT_ADDRESS1} Factuur adresregel 1 {FACT_ADDRESS2} Factuur adresregel 2 {FACT_ADDRESS3} Factuur adresregel 3 {FACT_CITY} Plaatsnaam van het factuuradres {FACT_COUNTRY} Land behorend bij het factuuradres {COMP_NAME} Bedrijfsnaam (van de klant) {COMP_TEL} Telefoonnummer van het bedrijf (van de klant) {COMP_FAX} Faxnummer van het bedrijf (van de klant) {STUDENT} Studentnummer {CUSTOM01} {CUSTOM02} {CUSTOM03} {CUSTOM04} {CUSTOM05} {CUSTOM06} {CUSTOM07} {CUSTOM08} {CUSTOM09} {CUSTOM10} {DATE_CURRENT} Huidige datum, conform Standaard datum opmaak in Configuratie {TIME_CURRENT} Huidige tijd, conform Standaard tijd opmaak in Configuratie {LOCATION} Naam van de locatie Teqa Webdiensten Pagina 12