Integratie aanmaken§
Allereerst voeg je ReCreateX toe als ticketingsysteem in Yesplan. Dit doe je bij “Systeeminstellingen” onder het tabblad “Integraties”. Je klikt op het plusje om een integratie toe te voegen.
Geef de koppeling een naam, bijvoorbeeld “ReCreateX”.
Klik op “Voeg toe” en kies vervolgens bij “Ticketingsysteem” voor “Generic”.
De velden om ReCreateX te configureren zullen verschijnen.
Instellingen§
De “URL” wordt bepaald door ReCreateX en kan je bij hen opvragen. Als je deze ontvangen hebt voeg je ze hier in.
Merk op: momenteel is “username” en “password” niet nodig om de koppeling te gebruiken, je mag ze dan ook leeg laten.
Protocol support§
In de generieke ticketing module worden er drie zaken ondersteund vanuit Yesplan richting ticketing:
- Server ondersteunt producties: dit zorgt ervoor dat uw voorstellingen gegroepeerd worden in de software van de ticketing
- Server ondersteunt verwijderen: een gekoppeld evenement kan verwijderd worden
- Server ondersteunt ophalen van evenementen per maand
Voor ReCreateX geldt het volgende:
- ReCreateX werkt enkel met evenementen, gelieve de checkbox bij “Server ondersteunt producties” uit te vinken
- ReCreateX ondersteunt het verwijderen van de evenementen momenteel niet, gelieve dan ook de checkbox uit te vinken bij “Server ondersteunt verwijderen”
Custom data aanmaken§
Om gegevens met je ReCreateX installatie uit te wisselen dienen de nodige customdatavelden te worden aangemaakt, zoals een publicatieknop en velden voor externe gegevens. Dit doe je bij “Systeeminstellingen” onder het tabblad “Evenementen” bij het onderdeel “Custom data”.
Publicatieknop§
De publicatieknop is de knop die ervoor zorgt dat het evenement uit Yesplan naar ReCreateX wordt verstuurd. Dit is een customdataveld van het type ‘publicatieknop’.
Geef de publicatieknop een naam bij het veld “Label”. Deze naam kan je vrij kiezen, bijvoorbeeld “naarrecreatex” of “recreatex_trigger”.
Externe gegevens§
Om gegevens uit ReCreateX in Yesplan te tonen, zoals bijvoorbeeld ticketstanden, kan je gebruik maken van customdatavelden van het type ‘externe gegevens’. Merk op dat je de inhoud van dergelijke customdatavelden niet kan wijzigen in Yesplan.
Deze customdatavelden zullen we in een volgende stap linken met de velden uit ReCreateX bij de configuratie van de koppeling.
Overzicht van de velden die Yesplan uit ReCreateX ophaalt (de labels die erbij horen kies je zelf):
Gegevens linken§
De aangemaakte customdatavelden en de externe gegevens met elkaar linken (mappen) doe je bij “Systeeminstellingen” onder het tabblad “Integraties” bij het onderdeel “ReCreateX”.
Acties§
Bij “Acties” koppel je het customdataveld van het type publicatieknop dat je aangemaakt hebt bij de custom data van het evenement (zie hierboven) aan de actie “Publiceer”. Je kan de publicatieknop die je aangemaakt hebt selecteren uit de keuzelijst aan de hand van het keyword van dit customdataveld.
Relaties van de gegevens bij publicatie van evenement§
Hier koppel je de gegevens die Yesplan naar ReCreateX stuurt en dus nodig heeft om het evenement te kunnen publiceren in ReCreateX.
Standaardwaarden§
Bij sommige velden kan er bij de Yesplan waarde voor “Standaard” gekozen worden. Zo maak je gebruik van de meest gebruikelijke standaard instellingen en dien je verder niets in te stellen.
Dit is het overzicht van de standaard links tussen gegevens in Yesplan en in ReCreateX:
| ReCreateX waarde | Standaardwaarde in Yesplan |
|---|---|
| name | Naam van het evenement |
| location | De locatie |
| starttime | De getoonde starttijd (aangeduid met het eerste rode bolletje bij het tijdschema) |
| endtime | De getoonde eindtijd (aangeduid met het tweede rode bolletje bij het tijdschema) |
Indien je de standaard configuratie niet wenst te volgen, dan moeten de customdatavelden waarmee je wilt linken van de volgende types zijn:
| ReCreateX waarde | Yesplan customdatatype |
|---|---|
| name | invulveld |
| location | invulveld |
| starttime | tijdveld |
| endtime | tijdveld |
Name§
Als het veld “name” standaard geconfigureerd wordt, dan zal hiervoor de naam van het evenement in Yesplan doorgestuurd worden naar ReCreateX. In dit geval dien je hiervoor geen customdataveld aan te maken.
Je kan echter ook een customdataveld van het type invulveld aanmaken en de waarde van dat customdataveld doorsturen naar ReCreateX.
Location§
Het veld “location” wordt standaard geconfigureerd. De naam van de locatie in Yesplan wordt automatisch doorgestuurd naar ReCreateX.
Starttime en endtime§
De velden “starttime” en “endtime” worden bijna altijd standaard geconfigureerd.
- Indien er géén tijdschema wordt aangemaakt voor het evenement, dan zal het evenement automatisch duren van daglijn tot daglijn. Dit is afhankelijk van de instelling van de verplaatste daglijn in Yesplan. Bijvoorbeeld, bij een daglijn om 7 uur zal het evenement automatisch duren van 7 uur ’s morgens tot 7 uur ’s morgens van de daarop volgende dag.
- Indien er een tijdschema wordt aangemaakt voor het evenement zonder dat bepaalde tijdstippen expliciet werden aangeduid als getoonde start- of eindtijd (de ‘rode bolletjes’), dan zullen de start- en eindtijd van het gehele tijdschema van het evenement worden overgenomen.
- Indien er een tijdschema wordt aangemaakt voor het evenement waarbij bepaalde tijdstippen werden aangeduid als getoonde start- en eindtijd (de ‘rode bolletjes’), dan zullen die getoonde start- en eindtijd uit Yesplan overgenomen worden.
Extra veld aanmaken§
Er kan één extra veld geconfigureerd worden om door te sturen naar ReCreateX: PA. In dit veld komt de een komma-gescheiden lijst van rij en stoelnummers voor het evenement terecht.
In de kolom “Waarde ticketingsysteem” vul je “PA” in, in de kolom “Yesplan waarde” kies je het invulveld dat je hiervoor wilt gebruiken uit de keuzelijst en je klikt op “Voeg toe”.
PA: kommagescheiden lijst van zitjes kan doorgestuurd worden vanuit Yesplan, deze worden dan in ReCreateX als geblokkeerd gezet met een instelbare blokkeringscode (parameter in de webservice).
Formaat zitje: XX-YY waarbij XX de rij voorstelt en YY het nummer van het zitje, bijvoorbeeld PA: H-32;H-33;H-34;I-32;I-33;I-34
Externe gegevens§
Bij “Externe gegevens” koppel je de customdatavelden van het type ‘externe gegevens’ die je eerder aangemaakt hebt aan de overeenkomstige velden uit ReCreateX.
Deze externe gegevens dien je een voor een aan te maken. In de linkse kolom “Waarde ticketingsysteem” vul je het gewenste label van ReCreateX in. In de rechtse kolom “Customdataveld” kies je het Yesplan customdataveld waarin je de waarde wil tonen uit de keuzelijst en je klikt op “Voeg toe”.
Als alle velden gebruikt zijn, ziet het er ongeveer zo uit:
Dit is het overzicht van alle velden die beschikbaar zijn uit ReCreateX; je kiest zelf welke gegevens je wil gebruiken en tonen:
| ReCreateX label | Betekenis |
|---|---|
| blocked_seats | kommagescheiden lijst van geblokkeerde zitjes wordt doorgestuurd vanuit ReCreateX. Formaat zitje: XX-YY waarbij XX de rij voorstelt en YY het nummer van het zitje, bijvoorbeeld blocked_seats: L-7;F-45; |
| capacity | veld Max.bezoekers uit het evenement (CultureEvents.MaxVisitors) |
| freetickets | aantal verkochte kaarten aan 0.00€ |
| takings_vatExcl | totale ticketomzet exclusief BTW |
| takings_vatIncl | totale ticketomzet inclusief BTW |
| tickets_available | aantal beschikbare tickets |
| tickets_reserved | aantal niet geboekte tickets (= er bestaat een registratie, maar dit werd nog niet geboekt, dus geen verkoop in ReCreateX) |
| tickets_sold | aantal reeds geboekte tickets (= er bestaat een verkoop in ReCreateX) |
| ticket_total | totaal aantal besproken tickets |