Exchange
De Activity Stream Data Exchange (hierna Exchange) wordt gebruikt door zowel de eigen producten van Activity Stream Group als door goedgekeurde partners om ticketgegevens op te halen uit meerdere ticketsystemen in een consistent en gestandaardiseerd formaat.
Met deze integratie kan je de volgende acties uitvoeren:
- In Yesplan evenementen koppelen aan evenementen in Exchange.
- Gegevens uit Exchange (bijv. aantal verkochte tickets) tonen op het evenement in Yesplan.
Configuratie§
Om de integratie in te stellen moet je de volgende stappen zetten:
- Verplichte customdatavelden aanmaken.
- Customdatavelden aanmaken voor gegevens uit Exchange.
- De integratie instellen.
Verplichte customdatavelden aanmaken§
Om evenementen te kunnen koppelen met evenementen in Exchange, moet je onderstaande customdatavelden aanmaken in Yesplan:
- een publicatieknop om het evenement te koppelen
- een veld voor integratiegegevens van gegevenstype “Tekst (één regel)”, voor de “Exchange ID” in Exchange
Tip
- Je kan de zichtbaarheid van customdatavelden aanpassen en bepalen waar ze moeten verschijnen. Zie Zichtbaarheid van customdatavelden voor meer informatie.
- We raden aan om al de customdatavelden voor Exchange samen te brengen op één tabblad in het infovenster voor evenementen, bijvoorbeeld met de naam ‘Ticketing’.
Ga naar “Systeeminstellingen” > “Evenementen” > “Custom data” en maak een nieuwe groep aan voor Exchange, of je kan ervoor kiezen om de velden toe te voegen aan een bestaande groep. Voeg vervolgens onderstaande customdatavelden toe aan de groep, en wijs ze toe aan een tabblad:
| Type customdataveld | Label | Keyword |
|---|---|---|
| Publicatieknop | Koppelen met Exchange | exchange_publicatieknop |
| Integratiegegevens – Tekst (één regel) | Exchange ID | exchange_id |
Tip
- Je kan de waarde voor het label en het keyword zelf kiezen, maar in het vervolg van deze handleiding verwijzen we naar de waardes in bovenstaande tabel.
Customdatavelden aanmaken voor gegevens uit Exchange§
Het is mogelijk om gegevens uit Exchange te tonen in Yesplan, in customdatavelden van het type “Externe gegevens”. Als je beslist om dit te doen, ga dan als beheerder naar “Systeeminstellingen” > “Evenementen” > “Custom data”. Maak vervolgens een nieuwe groep aan voor Exchange, of je kan er ook voor kiezen om het veld toe te voegen aan een bestaande groep. Maak ten slotte customdatavelden aan van het juiste type:
| Veld in Exchange | Type customdataveld in Yesplan |
|---|---|
| Capacity | Externe gegevens – Getal |
| Earliest transaction | Externe gegevens – Datum-tijd |
| Latest transaction | Externe gegevens – Datum-tijd |
| Tickets sold | Externe gegevens – Getal |
| Tickets sold amount | Externe gegevens – Getal |
| Mean ticket sold price | Externe gegevens – Getal |
| Tickets refunded | Externe gegevens – Getal |
| Tickets refunded amount | Externe gegevens – Getal |
| Mean ticket refunded price | Externe gegevens – Getal |
| Tickets net | Externe gegevens – Getal |
| Tickets net amount | Externe gegevens – Getal |
Tip
- Je kan de zichtbaarheid van customdatavelden aanpassen en bepalen waar ze moeten verschijnen. Zie Zichtbaarheid van customdatavelden voor meer informatie.
- We raden aan om al de customdatavelden voor Exchange samen te brengen op één tabblad in het infovenster voor evenementen, bijvoorbeeld met de naam ‘Ticketing’.
Integratie instellen§
Om de integratie in te stellen, moet je onderstaande stappen zetten:
- integratie aanmaken
- verplichte velden koppelen
- externe gegevens instellen
Integratie aanmaken§
Je maakt de integratie aan op de volgende manier:
- Ga als beheerder naar “Systeeminstellingen” > “Integraties”.
- Klik op het ‘+’-icoontje en geef een naam aan de integratie, bijv. ‘Exchange’.
- Selecteer “Exchange” in de keuzelijst naast “Type integratie”.
Vervolgens verschijnen velden die je moet invullen om te verbinden met Exchange:
- Je ontvangt de waardes voor “URL” en “API key” van Exchange.
- Vul deze waardes in en klik op “Verifieer authenticatie” om de integratie te testen.
Verplichte velden koppelen§
Om de evenementen vanuit Yesplan te koppelen met evenementen in Exchange, moet je een publicatieknop koppelen aan de integratie:
- Ga als beheerder naar de pagina van “Exchange” in “Systeeminstellingen” > “Integraties”. Je kan de publicatieknop instellen in de tabel onder “Acties”.
- Selecteer naast de actie “Publiceer” het keyword van de publicatieknop die je aangemaakt hebt onder Verplichte customdatavelden aanmaken. In ons voorbeeld was dat ‘exchange_publicatieknop’.
Eens de publicatieknop aangemaakt is, kan je de verplichte velden instellen.
- Onder “Integratiegegevens – Gegevensstroom van ticketingsysteem naar Yesplan”:
- Kies in de keuzelijst naast “Exchange ID” het keyword van het customdataveld dat je hiervoor aangemaakt hebt. In ons voorbeeld was dat ‘exchange_id’.
Tip
Verplichte customdatavelden aanmaken legt uit hoe je deze verplichte velden kan aanmaken.
Externe gegevens instellen§
Je kan in Yesplan ook de waardes tonen van velden in Exchange:
- Ga als beheerder naar de pagina van “Exchange” in “Systeeminstellingen” > “Integraties”. Je kan customdatavelden instellen in de tabel onder “Externe gegevens – Gegevensstroom van ticketingsysteem naar Yesplan”.
- Selecteer in de keuzelijst naast het veld in kwestie het keyword van het customdataveld dat je wilt gebruiken. Customdatavelden aanmaken voor gegevens uit Exchange legt uit hoe je deze velden kan aanmaken.
Gebruik§
Eens alles correct ingesteld is, kan je de integratie gebruiken om evenementgegevens op te halen uit Exchange.
Een alleenstaand evenement koppelen§
Als je een alleenstaand evenement koppelt met een evenement in Exchange, raden we aan om minstens de onderstaande velden in te vullen:
- Naam van het evenement
- Tijdschema
Om het evenement te koppelen moet je op de publicatieknop (“Koppel evenement…”) klikken:
- Yesplan haalt de beschikbare evenementen uit Exchange. De beschikbare evenementen zijn alle evenementen op de datum van het evenement in Yesplan. Selecteer het juiste evenement in de keuzelijst.
- Klik op “Koppel” om het evenement te koppelen.
Evenementen herroepen§
Eens je een evenement gekoppeld hebt, verandert de tekst op de publicatieknop in “Evenement ontkoppelen”. Als je dan op de publicatieknop klikt, verbreek je de koppeling tussen Yesplan en Exchange.
Evenementen kopiëren§
Je kan in Yesplan evenementen kopiëren die al gekoppeld zijn met Exchange. Deze nieuwe evenementen zijn echter niet automatisch gekoppeld met Exchange:
- Klik op de publicatieknop om het evenement te koppelen met een evenement in Exchange.
Evenementen verwijderen§
We raden af om gekoppelde evenementen te verwijderen in Yesplan. Je kan ze beter een bepaalde status toekennen in Yesplan, bijv. ‘Geannuleerd’. Afhankelijk van je werkwijze kan je ook de koppeling tussen Yesplan en Exchange verbreken voor het evenement in kwestie. Zie Evenementen herroepen voor meer informatie.
Gegevens uit Exchange bekijken§
Je kan in Yesplan ook gegevens uit Exchange zien (bijv. aantal verkochte tickets) als je er customdatavelden voor aangemaakt hebt. Zie Externe gegevens instellen.
- De gegevens worden automatisch opgehaald als het langer dan een uur geleden is dat het tabblad met customdatavelden in kwestie geopend is door een gebruiker.
- Je kan de gegevens ook manueel ophalen via de knop “Vernieuwen” rechts van het veld.
Veelgestelde vragen§
Overzicht (on)gepubliceerde evenementen§
Je kan in Yesplan op twee manieren een overzicht maken van evenementen met hun publicatiestatus in Exchange: via dataviews en via de zoektaal.
Via dataviews§
Het proces staat beschreven in de voorbeelden van dataviews: zie Tickets publiceren voor meer informatie.
Voor Exchange moet je dan het volgende doen:
- De publicatieknop voor Exchange toevoegen als kolom.
- Filteren op “{Publicatieknop} bevat uit” voor alle evenementen die niet gekoppeld zijn met Exchange.
- Filteren op “{Publicatieknop} bevat actief” voor alle evenementen die wel gekoppeld zijn met Exchange.
Tip
Gebruik ook de datumfilter in je dataview. Als je veel evenementen opvraagt kan het immers even duren voor al de gegevens verschijnen.
Via de zoektaal§
Je kan met onderstaande zoekopdrachten een overzicht opvragen in het algemeen zoekvenster of in het zoekvenster voor evenementen:
event:{keyword-van-de-publicatieknop}:active: Toon al de evenementen die gekoppeld zijn met Exchange.event:{keyword-van-de-publicatieknop}:"": Geef al de evenementen die niet gekoppeld zijn met Exchange.event:{keyword-van-de-publicatieknop}:error: Zoek al de evenementen waar iets fout loopt in de koppeling met Exchange.