Tickets.com Integration — Configuration
First of all, add Tickets.com as a ticketing system in Yesplan. You do this at “System Settings” under the “Integrations” tab. You click on the plus sign to add an integration.
Give the link a name, for example “Tickets.com”.
Click on “Add” and then select “Generic” under “Ticketing system”.
The fields to configure Tickets.com will appear.
The “URL”, “username” en “password” are determined by Tickets.com and can be requested from them. If you have received these, insert them here.
In the generic ticketing module, three things are supported from Yesplan towards ticketing:
- Server Supports Productions: this ensures that the performances are grouped in the ticketing software.
- Server Supports Deletion: a linked event can be deleted.
- Server Supports Retrieving Events by Month: this ensures that Yesplan can retrieve the latest information for all active events every night.
Tickets.com currently does not support the removal of events, so please uncheck the checkbox.
Create Custom Data§
To exchange data with your Tickets.com installation, 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 Tickets.com. 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 “Tickets.com Trigger”.
To display data from Tickets.com in Yesplan, such as number of tickets sold, you can use custom data fields of the ‘remote data’ type. Note that the content of custom data fields of the ‘remote data’ type cannot be edited.
In a next step we will link these custom data fields with the fields from Tickets.com when configuring the integration.
Overview of the fields that Yesplan retrieves from Tickets.com:
Link the created custom data fields and the external data to each other under “System Settings” under the “Integrations” tab in the “Tickets.com” section.
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 Tickets.com and therefore needs, to be able to publish the event in Tickets.com.
With some fields you can choose “default” for the Yesplan value. This way you make use of the most common settings and you don’t have to set anything else.
This is the overview of the default links between data in Yesplan and in Tickets.com:
|Tickets.com value||Default value in Yesplan|
|name||Name of the event|
|starttime||The displayed start time (indicated by the first red dot in the timetable)|
|endtime||The displayed end time (indicated by the second red dot in the timetable)|
If you do not want to follow the standard configuration, the custom data fields with which you want to link must be of the following types:
|Tickets.com value||Yesplan customdatatype|
|starttime||time input field|
|endtime||time input field|
If the “name” field is configured by default, the name of the event in Yesplan will be forwarded to Tickets.com. In this case you do not have to create a custom data field for this.
However, you can also create a custom data field of the ‘input field’ type and send the value of that custom data field to Tickets.com.
The “location” field is configured by default. The name of the location in Yesplan is automatically forwarded to Tickets.com.
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 Field§
One extra field must be configured for Tickets.com: pvm-event-id. This field is where the code for the event ends up (the show in Tickets.com).
In the column “Ticketing system value” you enter “pvm-event-id”. In the column “Yesplan value” you choose the entry field that you want to use for this from the drop-down menu and click on “Add”.
Relationships of the Data when Publishing Production§
If the “name” field for a production is configured by default, then the name of the production in Yesplan will be forwarded to Tickets.com.
Create Extra Field§
One extra field must be configured for Tickets.com: pvm-production-id. This field is where the code for the event ends up (the show in Tickets.com).
In the column “Ticketing system value” you enter “pvm-production-id”. In the column “Yesplan value” you choose the entry field that you want to use for this from the selection list and click on “Add”.
Under “Remote Data” you link the custom data fields of the ‘remote data’ type that you have previously created to the corresponding fields from Tickets.com.
You need to create this remote data one by one. In the “Ticketing system value” column, enter the label of the field from Tickets.com. 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”.
This is the overview of all fields available from Tickets.com:
|amt-reserved||Proceeds from reserved tickets|
|amt-sold||Proceeds from sold tickets|
|facility-capacity||Gross capacity of the room|
|no-available||Number of available tickets|
|no-complimentray||Number of free tickets|
|no-held||Number of blocked tickets / seats|
|no-reserved||Number of reserved tickets|
|no-sold||Number of tickets sold|
|no-taken||Number of seats taken (no-sold + no-reserved + no-complimentary)|
|performance-capacity||Capacity of the show|
|price-map-code||Price floor plan|
|price-map-description||Price floor plan description|