Below you will find the general description for creating a ticketing integration that uses the generic ticketing module in Yesplan for an integration with Tix.
Go to “System Settings” under the “Integrations” tab. You click on the plus sign to add an integration.
Give the link a name, for example “My ticketing” and click on “Add”.
Then choose “Generic” under “Integration”.
The fields to configure the ticketing system will appear.
Create API Key§
Tix needs an API key to set up the integration on their side. You will have to create a user that has read and write permissions on events.
- Create a user group “Tix Group”.
- Add this user group to the common permissions template that is used to manage the read and write permissions.
- Create a user “Tix”, add it to “Tix Group” and apply the common permission template to this user.
- Create an API key for this user in “System Settings” > “Integrations” > “API Keys”.
- Send the key together with the url of your installation to TIX so they can set up the integration on their side.
The “Username” and “Password” are determined by Tix. You can request this from them and add it here.
Depending on the country you work in the URL will be as follows:
For some values that Yesplan sends to the ticketing system, an identification code(ID) must be sent instead of the corresponding string (a simple piece of text or string). This is so if the ticketing system does not itself handle the mapping between the string and the identification code during the communication. In such cases, the ticketing system can provide a URL that includes these mappings. In this way, both the identification code and the string will be available in Yesplan. The string is shown to the user within Yesplan. The associated identification code, on the other hand, will be forwarded to the ticketing system in the background.
By clicking on “Click to update”, the new mappings are retrieved to be added to the linked custom fields. Mappings can currently only be used in combination with custom data fields of the type drop-down menu. Therefore, only 1 value can be chosen from the drop-down menu.
For the application of this, see: Relationships of the Data at Event Publication.
If you edit the predefined values of a drop-down menu, you have to click the button “Click to update” to push the new value to the ticketing system.
In the Tix module, three things are supported from Yesplan towards ticketing:
- Server Supports Productions: this ensures that the performances are grouped in the ticketing system. To do this, you must designate a parent group of events in Yesplan as ‘Production’.
- Server Supports Deletion: this means that a linked event can be deleted. Often the link is removed but the event itself is not deleted.
- Server Supports Retrieving Events by Month: this ensures that Yesplan can retrieve the latest information for all active events every night.
Create Custom Data§
To exchange data with the ticketing system, the necessary custom data fields must be created, such as a publication trigger and fields for remote data. You can do this at “System Settings” under the “Events” tab under the “Custom data” section.
The publication trigger is a button that ensures that the event is sent from Yesplan to the ticketing system. This is a custom data field of the ‘publication trigger’ type.
Give the publication trigger a name in the “Label” field. You can freely choose this name, for example “Publish in Tix”.
To display data from the ticketing system in Yesplan, such as number of tickets sold, you can use custom data fields of the ‘remote data’ type.
These fields are created in the “System Settings” under the “Events” tab in the “Custom Data” section. Note that the content of custom data fields of the ‘remote data’ type cannot be edited.
For the Tix integration you need to create the fields as follows:
|ticketsavailable||Total available tickets (Capacity – Blocked – Allocated – Reserved – Sold)|
|ticketssold||Total sold tickets|
|ticketstotal||Total sold and reserved|
|ticketsreserved||Total reserved tickets|
|ticketsrevenue||Total sold revenue|
|ticketscapacity||The capacity for the hall|
|ticketsallocated||Number of allocated tickets/seats|
|ticketsblocked||Number of blocked tickets/seats|
|productiononline||Is the production displayed online|
|eventonline||Is the event displayed online|
For more information on the meaning of the fields please address Tix.
You can link the created custom data fields and the external data to each other under “System Settings” under the “Integrations” tab in the section that you created yourself, for example “My ticketing”.
Under “Actions” you link the custom data field of the type of publication trigger that you created with the custom data of the event (see above) to the “Publish” action. You can select the publication trigger that you have created from the drop-down menu. It is based on the keyword of this custom data field.
Relationships of the Data at Event Publication§
Here you link the data that Yesplan sends to the ticketing system and therefore needs, to be able to publish the event in the ticketing system.
If the custom field is in the “Yesplan value” column of the drop-down menu, you can choose to use a ‘mapping’. The mapping ensures that the drop-down menu is automatically filled with the correct values from the ticketinsystem: a string that you see in Yesplan, and the corresponding identification code (ID) that is used in the background by the integration.
Mandatory for mapping:
|Value ticketing system||Default value in Yesplan|
|hallconfigurations||A custom field created as drop-down menu|
|promotors||A custom field created as drop-down menu|
|seasons||A custom field created as drop-down menu|
|salesstart||A custom field created as date and time input|
|available online||A custom field created as date and time input|
- Hallconfiguration:Here you choose the correct hall configuration that is used for the event, each option in the drop-down menu is the Venue name + Hall name + HallConfiguration name.
- Promotors: A drop-down menu of all promoters registered in Tix.
- Seasons: A drop-down menu of all seasons registered in Tix.
- Salesstart: The start of sales online (If not used then Today + 7 days 10:00).
- Available online: The date and time when the event should be visible online (If not used then Today + 7 days 10:00).
|Value ticketing system||Custom data type in Yesplan|
|starttime||time input field|
|endtime||time input field|
The name field is configured by default as the event name, the name of the event in Yesplan will be forwarded to the ticketing system.
However, you can also create a custom field of the ‘input field’ type and send the value of that custom data field to the ticketing system by selecting this custom data field in the dropdown menu instead of “default”.
The “location” field is configured by default. The name of the location in Yesplan is automatically forwarded to the ticketing system.
Starttime and endtime§
The “starttime” and “endtime” fields are almost always configured by default.
- If no timetable is created for the event, the event will automatically last from day line to day line. This depends on the setting of the shifted day line in Yesplan. For example, with a day line at 7 a.m., the event will automatically last from 7 a.m. to 7 a.m. of the following day.
- If a timetable is created for the event without specific times being explicitly indicated as displayed start or end time (the ‘red dots’), then the start and end time of the entire timetable of the event will be taken over.
- If a timetable is created for the event where certain times were designated as the displayed start and end time (the ‘red dots’), then the displayed start and end time will be taken from Yesplan.
Create Extra Fields§
Extra fields can be added that will be sent to the ticketing system. These fields are specific for Tix.
|Value ticketing system||Definition|
|project||The external reference number, sometimes called Project Number (used mainly in accounting software).|
|free||Is the event a free event, just used to display on the event calendar for the website (Tix Event API). This cannot be used in updating the event.|
|tickettitle||The event name that is printed on the ticket (if not used then the name of the event is used)|
|note-||Custom text that will be added to notes on the event in Tix (note-001-price-a: 100, note-002-price-b: 200)|
Under “Remote Data” you link the custom data fields of the ‘remote data’ type that you have previously created to the corresponding fields from the ticketing system.
You need to create this remote data one by one. In the “Ticketing system value” column, enter the label of the field from the ticketing system. In the “Custom data element” column, choose the Yesplan custom data field in which you want to display the value from the drop-down menu. Then click “Add”.
|Value ticketing system||Custom data element|