Below you will find the general description for creating a ticketing integration that uses the generic ticketing module in Yesplan. For specific details of your ticketing system you can go to the relevant documentation.

Create Integration§

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.

Settings§

The “URL”, “Username” and “Password” are determined by the ticketing system that is integrated with. You can request this from them and add it here.

Mappings§

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 data 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.

Protocol Support§

In the generic ticketing module, three things are supported from Yesplan towards ticketing:

If the ticketing system does not support a certain part, the corresponding checkbox must be unchecked.

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.

Publication Trigger§

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 “Forward”.

Remote Data§

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.

Linking Data§

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”.

Actions§

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.

Default Values§

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 the ticketing system:

value ticketing system Default value in Yesplan
name Name of the event
location The location
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:

value ticketing system Custom data type in Yesplan
name input field
location input field
starttime time input field
endtime time input field

Name§

If the “name” field is configured by default, the name of the event in Yesplan will be forwarded to the ticketing system. 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 the ticketing system by selecting this custom data field in the drop-down menu instead of “default”.

Location§

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.

Create Extra Fields§

Extra fields can be added that will be sent to the ticketing system.

These extra fields are specific to each ticketing system. You can find them in the specific documentation for your ticketing system.

Extra fields that are forwarded can only be of the following type:

Mapping§

If the custom data field is in the “Yesplan value” column of the drop-down menu, you can choose to use a ‘mapping’. This must of course be supported by the ticketing system. The mapping ensures that the drop-down menu is automatically filled with the correct values from the ticketing system: a string that you see in Yesplan, and the corresponding identification code (ID) that is used in the background by the integration.

Relationships of the Data when Publishing Production§

Default Values§

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.

Name§

If the “name” field for a production is configured by default, then the name of the production in Yesplan will be forwarded to the ticketing system.

Create Extra Fields§

Extra fields can be added that will be sent to the ticketing system at the production level.

These extra fields are specific to each ticketing system. You can find them in the specific documentation for your ticketing system.

Extra fields that are forwarded can only be of the following type:

Remote Data§

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”.

The available values of the ticketing system are described in the specific manual for the ticketing system.