Ga naar inhoud

Custom data

Naast de standaardgegevens die ingevoerd kunnen worden voor evenementen, resources en contacten is het mogelijk om zelf bijkomende velden te definiëren in Yesplan. Dit noemen wij custom data. Hierdoor kan Yesplan vrij geconfigureerd worden. Je kan immers zelf extra velden toevoegen die specifiek zijn voor een bepaalde workflow of een bepaalde organisatie.

Customdatavelden kunnen toegevoegd worden aan:

  • evenementen
  • resources
  • boekingen van resources
  • contacten
  • boekingen van contacten.

Ze worden getoond op hun respectievelijke infovensters, op een tabblad naar keuze. Je kan zelf extra tabbladen aanmaken hiervoor.

Opmerking

Voor elk element waaraan custom data kan toegevoegd worden is er een apart scherm om die custom data te beheren. Deze schermen zijn te vinden bij de systeeminstellingen, onder het tabblad “Evenementen”, “Resources” en “Contacten”, bij het onderdeel “Custom data” of “Custom data voor boekingen”.

Vermits de configuratie van de customdatavelden voor de verschillende elementen vrij gelijkaardig verloopt, bespreken we niet alle afzonderlijke schermen in detail, maar lichten we de algemene werking toe van het configuratiescherm voor custom data.

Structuur van custom data§

Voor een bepaald soort element (zoals evenementen, resources en contacten) kunnen er meerdere customdatavelden gedefinieerd worden. In plaats van deze velden voor te stellen als één enkele lange lijst, biedt Yesplan twee mogelijkheden aan om customdatavelden onder te verdelen. Bij het tonen van de waardes van de customdatavelden op de infovensters zal deze onderverdeling ook aangehouden worden.

  • Groepen: Groepen zijn het hoogste niveau van onderverdelen van customdatavelden in Yesplan. Een groep heeft een naam en wordt boven de tabel getoond in het configuratiescherm. Merk op dat het configuratiescherm steeds maar de details van één enkele groep tegelijk zal laten zien. Om de details van een andere groep te zien, klik je op de knop “Open” naast de groepsnaam. Verder kan de volgorde van de groepen aangepast worden (om zo de volgorde te bepalen waarop deze getoond worden in de infovensters). Hiervoor maak je gebruik van de pijltjes naar boven en naar beneden naast de groepsnaam. Om de naam van een groep te wijzigen dubbelklik je erop. Om een groep in zijn geheel te verwijderen klik je op “Verwijder deze groep”, helemaal rechts in het venster.

  • Blokken: Binnen een groep kunnen de customdatavelden verder onderverdeeld worden in blokken. Zo zien we bijvoorbeeld in de afbeelding hierboven dat er binnen de groep “Production” één blok is, “Info”. Gelijkaardig aan groepen kunnen blokken verplaatst worden door op “Omhoog” of “Omlaag” te klikken (in de rechter kolom). Om de naam van een blok te wijzigen dubbelklik je erop. Om een blok in zijn geheel te verwijderen klik je op “Verwijder” in de rechter kolom.

    Om een customdataveld toe te voegen aan een blok schuif je het veld als het ware in het blok door gebruik te maken van “Omhoog” en “Omlaag”.

Tip

Een customdataveld of een blok kan naar een andere groep verplaatst worden door het helemaal naar boven of beneden te verplaatsen binnen de groep, en dan vervolgens nog één keer respectievelijk “Omhoog” of “Omlaag” te klikken.

Label, keyword en beschrijving§

Als je customdatavelden aanpast, kan je het label, het keyword en de beschrijving aanpassen.

Tip

Nieuw in v27 Wil je in een infovenster het keyword van customdatavelden makkelijk achterhalen? Druk dan de toetsen CTRL-ALT (Windows) of CTRL-Option (macOS) in: het label van het veld verandert in het keyword. Wil je het keyword kopiëren? Klik het label dan aan terwijl je diezelfde toetsen ingedrukt houdt.

Label§

Het label van een customdataveld geeft een (korte) naam aan het veld. Dit label wordt getoond op het infovenster, links van of vlak boven de invulvelden. Om het label te wijzigen dubbelklik je erop.

Keyword§

Veranderd in v27

Het keyword is de interne, technische naam voor het customdataveld en zal gebruikt worden om te verwijzen naar dit veld, bijvoorbeeld in de zoektaal, in rapporten en bij integraties die gebruik maken van de API. Het keyword kan automatisch gegenereerd worden of je kan het zelf instellen.

Het customdataveld met het label “Designer” in onderstaande afbeelding krijgt automatisch het keyword production_info_designer terwijl aan het customdataveld met het label “Operator” manueel het keyword “operator” werd toegekend. Een zelfgekozen keyword wordt dus weergegeven als zwarte tekst, terwijl een automatisch gegenereerd keyword wordt weergegeven als grijze cursieve tekst.

Automatisch toegekende keywords worden telkens op dezelfde manier opgebouwd:

  • Het is een samenstelling van de groep, het blok en het label van het customdataveld, telkens gescheiden door een _ (underscore). Merk op dat alle spaties en speciale karakters (zoals ! ? ; enzovoort) verwijderd worden en dat hoofdletters omgezet worden naar kleine letters.
  • Als je een customdataveld verplaatst (bijvoorbeeld naar een andere groep), dan zal het automatisch toegekende keyword niet automatisch mee veranderen.

Het is vaak duidelijker als je de keywords voor de customdatavelden zelf instelt. Om het keyword te wijzigen dubbelklik je erop:

  • Het keyword moet uniek zijn in Yesplan, vermits het dient om het veld te identificeren. Indien je een keyword invult dat reeds bestaat zal Yesplan hiervoor een waarschuwing geven én het veld automatisch een andere naam geven die wel uniek is.
  • Als je een zelfgekozen keyword wilt verwijderen en vervangen door een automatisch toegekend keyword, dan kan je dubbelklikken op het keyword, de zelfgekozen waarde verwijderen en op “OK” klikken. Een nieuw keyword wordt dan aangemaakt op basis van de huidige positie van het customdataveld in de hiërarchie.
  • Als je zelf een keyword kiest, zal het automatisch toegekende keyword niet meer werken in de zoektaal, integraties en rapporten.

Let op

Als je het keyword aanpast van customdatavelden die gebruikt worden in rapporten of bij een integratie, dan zullen deze velden daar niet langer werken. Keywords worden immers gebruikt om customdatavelden op te vragen in rapporten en integraties.

Spring dus steeds zeer voorzichtig om met het aanpassen van keywords, en bedenk op voorhand een systeem om je keywords vorm te geven.

Beschrijving§

De beschrijving is een optioneel veld waarin je het gebruik of het doel van het customdataveld kunt beschrijven. Deze beschrijving wordt vervolgens in de infovensters onder het customdataveld getoond.

Types van customdatavelden§

Yesplan ondersteunt verschillende types van custom data. Het type van de custom data bepaalt welke waardes ingevoerd kunnen worden. Merk op dat bepaalde types slechts onder bepaalde voorwaarden gebruiken kunnen worden. Onderstaande lijst geeft een overzicht van de verschillende types van customdatavelden, wanneer ze gebruikt kunnen worden en wat hun doel is.

  • Invulveld: een kort stukje tekst; vrije invoer.

  • Tekstveld: een langer stuk tekst; vrije invoer.

  • Numeriek invulveld: een numerieke waarde. Nieuw in v27 Eens aangemaakt, kan je in de kolom “Waarden” aangeven of het veld getoond moet worden als een percentage of niet.

  • Bijlageveld: het versturen van een bestand als bijlage, of een link naar een bestand via een URL. De maximum bestandsgrootte voor uploads in Yesplan is 15MB.

  • Ja/Nee-veld: een veld met als opties “Ja” of “Nee”.

  • Keuzelijst: een lijst met een aantal voorgedefinieerde keuzes.

  • Checkboxen: een of meerdere checkboxen met elk hun label.

  • Datumveld: een datum.

  • Tijdveld: een tijdstip (uren en minuten).

  • Datum-tijdveld: een combinatie van datum en tijdstip.

  • Commentaarveld: dit veld laat geen invoer toe maar maakt het mogelijk om een stuk tekst als commentaar te tonen tussen andere velden, bijv. een richtlijn met betrekking tot het invullen van een bepaald veld. Deze commentaarvelden verschijnen op de infovensters als groene tekst tussen de customdatavelden.

  • Resourceveld: een veld dat gebruikt kan worden om een resource te boeken. Via dit veld kunnen zowel bestaande resources geboekt worden als nieuwe resources aangemaakt en geboekt worden.

    Dit veld is enkel beschikbaar voor evenementen. Een resource die via dit customdataveld geboekt wordt, wordt ook getoond in de lijst met geboekte resources voor dat evenement.

  • Contactveld: een veld dat gebruikt kan worden om een contact te boeken. Via dit veld kunnen zowel bestaande contacten geboekt worden als nieuwe contacten aangemaakt en geboekt worden.

  • Uniekereeksveld: een customdataveld die een unieke waarde genereert.

    Een uniekereeksveld is standaard leeg, en zal een unieke waarde krijgen op het moment dat er op de knop gedrukt wordt (bij het evenement, de resource of het contact waarop dit customdataveld getoond wordt).

    Je kan zoveel uniekereeksvelden aanmaken als je wenst. Er kunnen dus meerdere reeksen naast elkaar bestaan. Het is steeds binnen zijn eigen reeks dat een waarde uniek is.

    Een uniekereeksveld kan bestaan uit meer dan een volgnummer; het kan opgebouwd worden met de volgende elementen:

    • het volgnummer
    • stukken vaste tekst
    • de Yesplan ID van het evenement, de resource of het contact waarop het toegepast wordt
    • (delen van) de datum en/of de tijd waarop de knop ingedrukt wordt

    Op het moment dat je op de knop drukt wordt de waarde van het uniekereeksveld gegenereerd voor dit evenement, deze resource of dit contact. Het volgende evenement, resource of contact waarbij er op de knop van dit customdataveld gedrukt wordt krijgt de volgende waarde (die op dat moment van toepassing is). Het volgnummer binnen de unieke reeks wordt telkens met 1 opgehoogd. Het wordt echter nooit verlaagd.

    Een uniekereeksveld kan ook terug leeg gemaakt worden. Het hiermee verwijderde volgnummer wordt echter níét meer opnieuw gebruikt. Een volgnummer binnen een reeks is dus steeds uniek, maar daarom niet per definitie aaneensluitend genummerd.

    Bij het aanmaken van het customdataveld kan je instellen wat de beginwaarde is van het volgnummer. Later kan je ook zien wat de actuele waarde is van het volgnummer en dit, indien gewenst, verhogen voor de volgende gebruiken.

Opmerking

Je kan de waarde van het volgnummer niet verlagen omdat het unieke karakter ervan hiermee verloren kan gaan.

Je kan dus voor een uniekereeksveld gebruik maken van een combinatie van het volgnummer, de Yesplan ID, vrije tekst, en datum en tijd. Met deze elementen kan je een patroon samenstellen. Het volgnummer wordt in dit patroon voorgesteld door {sequence} en de Yesplan ID door {id}.

Bijvoorbeeld:

  • Als je een uniekereeksveld wil laten bestaan uit de tekst “evenement” gevolgd door een spatie en een volgnummer, dan geef je het patroon op als: evenement {sequence}
  • Als je een uniekereeksveld wil van boeking nr. 123 met Yesplan ID 12438-028283, die eruit ziet zoals “boeking-123/12438-028283”, dan geef je het patroon op als: boeking-{sequence}/{id}

Om de schrijfwijze van datum en/of tijd uit te drukken maak je gebruik van {datetime:…} en een vaste datum, namelijk zaterdag 3 februari 2001 om 16:05:06. Het is belangrijk dat je steeds deze referentiedatum gebruikt om het formaat van de datum en/of tijd uit te drukken.

Merk op dat je de datum- en tijdelementen steeds in het Engels hoort op te schrijven bij het definiëren van het uniekereeksveld. Het resultaat wordt echter getoond in de systeemtaal van de Yesplan installatie. Je kan ook vrije tekst gebruiken in de {datetime:…} parameter, maar deze wordt letterlijk overgenomen, en dus niet vertaald naar de taal van de installatie.

Bijvoorbeeld:

  • Als de datum waarop er op de knop gedrukt werd 2 februari 2014 is, en je wilt dit in het uniekereeksveld zien als “2014-02-21”, dan geef je het patroon op als: {datetime:2001-02-03}
  • Als de datum waarop er op de knop gedrukt werd 23 januari 2014 is, en je wilt dit in het uniekereeksveld zien als “don 23 jan 2014 om 20:22”, dan geef je het patroon op als: {datetime:sat 3 feb 2001 om 16:05}

Je kan al deze elementen uiteraard ook combineren.

Bijvoorbeeld:

  • Als je een uniekereeksveld wenst zoals “event-123-jan-2014” dan geef je het patroon op als: event-{sequence}-{datetime:feb-2001}

Dit is het volledige overzicht van de mogelijkheden van {datetime:…}, de referentiedatum is “Saturday February 3 2001 16:05:06” (zaterdag 3 februari 2001 om 16:05:06):

Beschrijving Gebruik in het patroon
jaar 2001
jaar met voorloopnullen 01
maand 2
maand met voorloopnullen 02
maandnaam february
maandnaam met hoofdletter February
maandnaam in hoofdletters FEBRUARY
maandnaam afgekort feb
maandnaam afgekort met hoofdletter Feb
maandnaam afgekort en in hoofdletters FEB
dag 3
dag met spatie _3
dag met voorloopnullen 03
weekdag saturday
weekdag met hoofdletter Saturday
weekdag in hoofdletters SATURDAY
weekdag afgekort sat
weekdag afgekort met hoofdletter Sat
weekdag afgekort en in hoofdletters SAT
uur in 12u formaat 4
uur in 12u formaat met voorloopnullen 04
uur in 24u formaat met voorloopnullen 16
dagdeel pm
dagdeel in hoofdletters PM
minuut 5
minuut met voorloopnullen 05
seconde 6
seconde met voorloopnullen 06
tijdzone Z Z
tijdzone +00:00
tijdzone afgekort UTC
  • Evenementlabels: Dit veld toont de labels van het evenement. Via dit veld kunnen labels toegevoegd en verwijderd worden aan een evenement (of evenementgroep).

    Dit veld is enkel van toepassing op evenementen. Op het niveau van een evenementgroep toont dit veld alle labels die voorkomen op één van de onderliggende evenementen.

Let op

Er is slechts één set van labels voor een evenement. Indien je dit customdataveld meerdere keren definieert om bijvoorbeeld in verschillende groepen of op verschillende tabbladen te laten zien, dan zijn dit steeds exact dezelfde labels. Met andere woorden, een label toevoegen of verwijderen op één plaats waar die getoond worden, zal dit ook toevoegen of verwijderen op alle andere plaatsen waar de labels van het evenement getoond worden.

Naast de bovenstaande velden zijn er ook een aantal velden die specifiek dienen om de koppeling met externe systemen (zoals bijvoorbeeld een integratie met een ticketingsysteem) aan te sturen. Deze velden zullen enkel zichtbaar zijn indien er een koppeling geactiveerd is die het gebruik ervan vereist. Voor meer informatie omtrent het gebruik van deze velden verwijzen we naar de handleidingen van de integraties die Yesplan ondersteunt.

  • Publicatieknop: dit veld wordt gebruikt om gegevens van Yesplan door te sturen naar een extern systeem. Bijvoorbeeld, indien er een ticketingsysteem gekoppeld is met Yesplan, dan kan dit veld toegevoegd worden aan de custom data van evenementen om het evenement, eens het daarvoor klaar is, door te sturen naar het ticketingsysteem, zodat het in verkoop kan.
  • Externe gegevens: dit veld wordt gebruikt om gegevens van een extern systeem te tonen in Yesplan. Bijvoorbeeld, indien er een ticketingsysteem gekoppeld is met Yesplan, dan kan dit veld gebruikt worden om de ticketstanden te tonen in Yesplan.
  • Nieuw in v27 Integratiegegevens: customdatavelden voor integratiegegevens kunnen gebruikt worden door webhooks. Bij het aanmaken van een veld voor integratiegegevens kan je het type kiezen:
    • Tekst (één regel): een kort stukje tekst; vrije invoer van één regel.
    • Tekst (meerdere regels): een langer stuk tekst; vrije invoer waarbij meerdere regels toegelaten zijn.
    • Getal: een numerieke waarde.
    • Datum: een datum.
    • Tijd: een tijdstip.
    • Datum-tijd: een combinatie van datum en tijdstip.
    • Één optie: één enkele waarde, die het resultaat is van een selectie uit bijvoorbeeld een keuzelijst.
    • Meerdere opties: een lijst met één of meerdere waarden, die het resultaat is van een selectie uit bijvoorbeeld een reeks checkboxes.

Het configuratiescherm voor custom data laat voor elk veld het type zien. Indien het type bijkomstige parameters vereist, dan worden deze getoond in de kolom “Waarden”. Deze parameters kunnen gewijzigd worden door erop te dubbelklikken. Voor customdatavelden die een lijst van opties verwachten (zoals een keuzelijst of een checkbox), dienen de waardes ervan ingevoerd te worden gescheiden door komma’s.

Let op

Het is niet mogelijk om het type van een customdataveld te veranderen eenmaal het ingesteld is.

Zichtbaarheid van custom data§

Het is vaak niet gewenst om een customdataveld overal en altijd te tonen. Soms wil je het customdataveld slechts op bepaalde tabbladen van het infovenster tonen, of je wil het slechts onder bepaalde voorwaarden laten zien. Bijvoorbeeld, de ticketstanden van een evenement zijn pas van belang indien het evenement de status ‘gepland’ heeft, of een veld dat de afmetingen van een resource bijhoudt, is enkel nuttig voor resources van het type materiaal.

Je kan de zichtbaarheid van een customdataveld instellen door in de kolom “Wanneer of waar tonen” op “Voeg toe” te klikken. Je krijgt vervolgens een keuzelijst te zien van alle mogelijke voorwaarden. Als je een voorwaarde kiest dan wordt deze getoond in een van de bijhorende kolommen links ervan. Zo zien we in bovenstaande afbeelding (voor evenementen) bijvoorbeeld de kolommen “Tabbladen”, “Profiel”, “Status” en “Locatie”. Als je uit de lijst met voorwaarden kiest voor het tabblad “Info”, dan zal “Info” verschijnen in de kolom “Tabbladen”; deze voorwaarde is nu actief. Je kan de actieve voorwaarde terug verwijderen door op het verwijderknopje te klikken ernaast.

Onderstaande tabellen geven, per type element, een overzicht van de voorwaarden die gebruikt kunnen worden om de zichtbaarheid van een customdataveld te bepalen, en de bijhorende regels.

Evenementen§

Voorwaarde Beschrijving
Tabblad Het customdataveld is enkel zichtbaar op de opgegeven tabbladen. Indien er voor dit veld géén tabbladen worden opgegeven is het nergens zichtbaar.
Locatie Het customdataveld is enkel zichtbaar indien het evenement plaatsvindt in de gekozen locaties. Indien er géén locaties worden opgegeven voor dit veld, dan is het customdataveld zichtbaar ongeacht de locatie waar het evenement plaatsvindt.
Profiel Het customdataveld is enkel zichtbaar indien het evenement een bepaald profiel heeft. Indien er géén profielen worden opgegeven voor dit veld, dan is het customdataveld zichtbaar ongeacht het profiel van het evenement.
Status Het customdataveld is enkel zichtbaar indien het evenement een bepaalde status heeft. Indien er geen statussen worden opgegeven voor dit veld, dan is het customdataveld zichtbaar ongeacht de status van het evenement.

Resources en boekingen van resources§

Voorwaarde Beschrijving
Tabblad Het customdataveld is enkel zichtbaar op de opgegeven tabbladen. Indien er voor dit veld géén tabbladen worden opgegeven, dan is het customdataveld nergens zichtbaar.
Rol Het customdataveld is enkel zichtbaar voor resources met een bepaalde rol. Indien er géén rollen worden opgegeven voor dit veld, dan is het customdataveld zichtbaar ongeacht de rol van de resource.
Type Resource Het customdataveld is enkel zichtbaar voor resources van een bepaald type. Indien er géén types worden opgegeven voor dit veld, dan is het customdataveld zichtbaar ongeacht het type van de resource.

Contacten en boekingen van contacten§

Voorwaarde Beschrijving
Tabblad Het customdataveld is enkel zichtbaar op de opgegeven tabbladen. Indien er voor dit veld géén tabbladen worden opgegeven, dan is het customdataveld nergens zichtbaar.
Label Het customdataveld is enkel zichtbaar voor contacten die een bepaald label hebben. Indien er géén labels worden opgegeven voor dit veld, dan is het customdataveld zichtbaar ongeacht welke labels het contact heeft.

Beheer§

Custom data aanmaken§

Een groep kan toegevoegd worden door onderaan het scherm op “Voeg een groep toe” te klikken. Om een blok of een customdataveld toe te voegen zorg je eerst dat de groep waaraan dit moet toegevoegd worden geopend is. Klik dan op “Voeg item toe”. Kies vervolgens uit de keuzelijst het juiste type (of de optie “Blok”), vul het label in, en indien vereist, ook de opties gescheiden door een komma. Afronden doe je met de knop “Voeg toe”.

Checkboxen en keuzelijsten aanpassen§

Veranderd in v27

Eens customdatavelden van het type checkbox of keuzelijst aangemaakt zijn, kan je de lijst van voorgedefinieerde waardes wijzigen door te dubbelklikken. Het is echter mogelijk dat deze waardes op dat moment al geselecteerd zijn, bijvoorbeeld op een evenement. Als dat het geval is, doet Yesplan het volgende:

  • Na het wijzigen van de waarde in de Systeeminstellingen zal de oude waarde een rood verbodsteken achter zich krijgen. Dit geeft aan dat deze waarde weliswaar geselecteerd is, maar niet meer bestaat in de Systeeminstellingen.
  • Als een gebruiker een andere waarde selecteert dan de gewijzigde waarde met het verbodsteken, verdwijnt deze laatste automatisch uit de lijst met checkboxen of keuzes.

Bijvoorbeeld:

  • Je maakt een keuzelijst met de waardes “menu 1”, “menu 2” en “menu 3”.
  • Een gebruiker selecteert op het evenement “Hamlet” de waarde “menu 2” voor die keuzelijst.
  • Je verwijdert “menu 2” uit de keuzelijst:
    • In “Hamlet” zal voor die keuzelijst “menu 2” een rood verbodsteken achter zich krijgen.
    • Bij het selecteren van een andere waarde (bijvoorbeeld “menu 1”) verdwijnt “menu 2” als keuzemogelijkheid.

Customdatavelden exporteren/importeren§

Om de configuratie van customdatavelden te vergemakkelijken is het mogelijk om velden te exporteren of te importeren in Yesplan.

Velden exporteren van een bepaalde groep doe je door de checkboxen aan te vinken van de velden die je wenst te exporteren. Vervolgens klik je “Exporteer selecties” om die bepaalde velden te exporteren naar een bestand. Om een groep in zijn geheel te exporteren klik je op “Exporteer alles”.

Bij het importeren heb je de keuze tussen het importeren van een nieuwe groep, of het importeren van velden naar een bestaande groep. Een nieuwe groep importeren doe je door op “Importeer een groep” te klikken (helemaal onderaan, onder de lijst met custom data). Om velden te importeren naar een bestaande groep zorg je ervoor dat de groep waaraan dit moet toegevoegd worden geopend is, en klik je vervolgens op “Importeer velden”.

Merk op dat het niet mogelijk is om een bestand met customdatavelden te importeren, dat geëxporteerd werd in een oudere versie van Yesplan. Om te achterhalen wat het huidige versienummer van Yesplan is, klik je op “Release notes” in het navigatiemenu-item “Help”.

Verwijderde customdatavelden terugzetten§

Groepen, blokken en customdatavelden die verwijderd worden verdwijnen niet onmiddellijk volledig uit het systeem maar kunnen teruggezet worden. Indien er verwijderde customdatavelden zijn, zal de optie “Toon verwijderde velden” verschijnen (helemaal onderaan, onder de lijst met custom data). Door hierop te klikken wordt er een lijst getoond met de verwijderde velden.

Naast de details van de velden, zie je in de kolom “Wijzigen” de mogelijkheid om velden te herstellen. Indien het blok of de groep waartoe het customdataveld behoorde nog steeds aanwezig is, dan zal het veld teruggezet worden binnen dit blok of groep. Indien dit niet meer het geval is, wordt een keuzelijst gepresenteerd met alle bestaande blokken en groepen zodat je kan aangeven waar de velden aan toegevoegd moeten worden. Door op “Definitief verwijderen” te klikken wordt het veld voor eeuwig en altijd verwijderd uit Yesplan. Let hier dus mee op.