Yesplan

Yesplan

With the Yesplan integration, you can easily publish events from Yesplan and synchronize event data, such as sales and scan numbers. This article will guide you through the following topics:
  1. Setting up the Yesplan integration in Paylogic
  2. Setting up the integration in Yesplan
  3. Publishing an event from Yesplan to Paylogic
  4. Additional information
Info
Before you can set up the Yesplan integration, Yesplan must be activated for your account. Please contact your Client Success Manager to have this activated.

1. Setting up the Yesplan integration in Paylogic

  1. Go to the Paylogic Backoffice. Click on 'Merchant' in the menu, then on 'Integrations' and then on 'Yesplan'.
  2. You will arrive on the Yesplan integration page. Click on 'Create API token'.
  3. Your API credentials have now been created and are displayed. Copy and store the secret and Client ID in a safe place. You will need both in later steps.
  4. Click 'Continue'.
  5. Now that you have created the API credentials, you can also add template events. A template event is required for the integration. This template event is used as the basis for your new event.
  6. Click 'Add template events'.
  7. A window opens in which you can select all events you want to use as templates for creating events from Yesplan. After selecting the template events, click 'Add selected events'.
  8. The selected events are now shown as template events and you have completed this part of the integration.

2. Setting up the integration in Yesplan

2.1 Add Group

  1. Go to your Yesplan application and log in.
  2. Hover your mouse over your account name in the bottom menu and select 'System settings'.
  3. Click 'Events' in the top row of menu items.
  4. Click '+ Add a Group'.
  5. Double-click 'New' and replace 'New' with 'Paylogic'. Confirm with 'OK'.
  6. Now click 'Open' next to the Paylogic group.
  7. Click '+ Add a Field'.
    1. Select 'Publication trigger' as type and enter 'Publish on Paylogic' as the label. Click 'Add'.
  8. Click '+ Add a Field' again.
    1. Select 'Dropdown' as type and enter 'Event Template' as the label. Click 'Add'.
  9. Click '+ Add a Field' again.
    1. Select 'Date and time input' as type and enter 'Sale Start' as the label. Click 'Add'.
  10. Click '+ Add a Field' again.
    1. Select 'Date and time input' as type and enter 'Sale End' as the label. Click 'Add'.
  11. Click 'Add' under 'Where or When to Show' in the table.
  12. Select 'Info'.
  13. You will now see 'Info' in the 'Inspector Tabs' column for all your fields.
  14. Finally, double-click 'Description' in the 'Event Template' row and add the following sentence:
    1. "The template event to be used when first publishing this event on Paylogic. Note: this option cannot be changed after publishing for the first time."
    2. Confirm with 'OK'.

2.2 Add Integration

  1. Go to your Yesplan application and log in.
  2. Hover your mouse over your account name in the bottom menu and select 'System settings'.
  3. Click 'Integrations' in the top row of menu items.
  4. Click the '+' icon. Enter 'Paylogic' as the name and click 'Add'.
  5. Select 'Generic ticketing' as 'Integration Type'.
  6. A series of new options will now appear. Configure the following settings:
    1. Authentication Type: OAuth 2.0
    2. Grant Type → Client Credentials
    3. URL of resources server: https://partner.paylogic.com/yesplan
    4. URL of authorization server: https://partner.paylogic.com/yesplan/token
    5. Client ID: Enter the Client ID here that you generated in Paylogic (step 1.3).
    6. Client Secret: Enter the secret here that you generated in Paylogic (step 1.3).
  7. Click 'Verify' in the 'Connection to Ticketing System' field. You should now see 'Verified' next to the button.
  8. Go to the 'Mappings' setting and click 'Click to update'. You should now see 'Updated' next to the button.
  9. Uncheck all checkboxes under 'Protocol Support'.
  10. Go to Actions → Publish and select the trigger you created in the events group (see 2.1.8).
  11. Click 'Click to update' again next to the 'Mappings' setting. You should now see 'Updated' next to the button.
  12. In the 'Publishing Events – Data Flow from Yesplan to Ticketing System' section, add the following fields:
    1. event_uid
      1. Select 'paylogic_template' in the dropdown as 'Field in Yesplan'.
      2. Select 'template_events' in the dropdown as 'Mapping'.
      3. Click 'Add'.
    2. sale_start
      1. Select 'paylogic_salestart' in the dropdown as 'Field in Yesplan'.
      2. Click 'Add'.
    3. sale_end
      1. Select 'paylogic_saleend' in the dropdown as 'Field in Yesplan'.
      2. Click 'Add'.
    4. subtitle
      1. This field is optional, but you can use it to prefill the subtitle in the Paylogic event as well.
      2. For example, you can map this to 'production_subtitle'.
    5. project_code
      1. This field is also optional, but can be used to prefill the project code field in a Paylogic event. This can be useful to store an internal ID you use for an event in Yesplan also in Paylogic.
      2. Map this to the corresponding data field in Yesplan.
  13. It is also possible to synchronize data from Paylogic to Yesplan. If you want this, you can configure the fields as below or select only the fields you want to use. In the 'Remote Data – Data Flow from Ticketing System to Yesplan' section, you can add the following fields:
    1. total_available_tickets
      1. Select 'ticketing_available_tickets' in the dropdown as 'Field in Yesplan'.
      2. Click 'Add'.
    2. total_capacity
      1. Select 'ticketing_capacity' in the dropdown as 'Field in Yesplan'.
      2. Click 'Add'.
    3. total_not_scanned_tickets
      1. Select 'ticketing_tickets_not_scanned' in the dropdown as 'Field in Yesplan'.
      2. Click 'Add'.
    4. Total_scanned_tickets
      1. Select 'ticketing_tickets_scanned' in the dropdown as 'Field in Yesplan'.
      2. Click 'Add'.
    5. total_sold_tickets
      1. Select 'ticketing_sold_tickets_paid' in the dropdown as 'Field in Yesplan'.
      2. Click 'Add'.

3. Publishing an event from Yesplan to Paylogic

Now that the integration is set up, you can publish your event from Yesplan to Paylogic. Follow these steps:
  1. Go to your Yesplan application and log in.
  2. Select 'Events' in the bottom menu.
  3. Open the event you want to publish to Paylogic.
  4. Find the 'Paylogic' section.
  5. Click 'Show all'.
  6. In the 'Event Template' field, you can select the template event you want to use as the basis for your new event.
  7. Important to know: all settings from the template event are copied to the new event, except for the following fields. These are filled in Paylogic with data from your Yesplan event:
    1. Event Title
    2. Event subtitle (optional)
    3. Event date/time start
    4. Event date/time end
    5. Location
    6. Sale date/time start
    7. Sale date/time end
    8. Project code (optional)
  8. Enter the dates and times for the 'Sale Start' and 'Sale End' fields.
  9. Click 'Publish Event' in the 'Publish on Paylogic' field.
  10. You should receive a confirmation that the action was successful.
  11. The event has now been created in Paylogic. Go to the Paylogic Backoffice to check the event.

Idea
4. Additional information

  1. When you want to add a new template event and you have added it in the Paylogic Backoffice, you must also update the mappings in Yesplan. You can do this via System settings > Integrations > Paylogic.
  2. Total sold tickets that are synchronized from Paylogic to Yesplan may include guest list tickets, discount cards, etc., and might not exactly reflect what is expected for "ticketing_sold_tickets_paid".
  3. The data fields are updated every time you open an event. Clicking 'update' does not work if the last update was recent; this is a limitation in Yesplan.
  4. Publishing from Yesplan to Paylogic can only be done once. Later changes in Yesplan are not forwarded to Paylogic. Changes in the Paylogic event are also not sent back to Yesplan.
  5. The location is ignored to avoid creating many duplicate locations. The location of the template event is used when creating a new event.