Objectives
Synchronize S-360 Invalidated or Cancelled tickets with TIXNGO tickets.
Nominal behavior of the function
How does the function collect & process cancelled/invalidated tickets?
The function will only process tickets matching the following criteria:
- Tickets status in S-360 is CANCELLED or INVALIDATED
- Tickets have been previously injected into TIXNGO.
- Tickets are matching function schedule filters (shipment mode, …)
- Tickets have not been already processed by any other TIXNGO Push Cancelled function.
- If tickets have been already processed by another TIXNGO Push Cancelled function, tickets will be re-processed seamlessly if their respective invalidation reasons have been updated.
How does the function synchronize the cancelled/invalidated tickets into TIXNGO?
- If cancelled/invalidated tickets are successfully synced with TIXNGO, tickets won’t be processed again by the function
NOTE: Already synced tickets can be processed again by the function,- if the function is configured to send all tickets since a specific date by using the "Date from" parameter
- if the function is configured to force a specific list of tickets by using the "Force Ticket Tax Numbers" parameter
- If cancelled/invalidated tickets are successfully synced with TIXNGO, tickets will be processed again by the function only if their invalidation reason has been updated.
- If there is an error preventing all tickets to be synced with TIXNGO properly (TIXNGO or TIXNGO interface errors), tickets will be processed again during the upcoming executions.
NOTE: An error indicating the origin of the failure will be present in the function execution logs. - If most of the tickets are successfully synced but a few encounter errors, the successfully synced tickets won’t be processed again. The function will continue to show an error until a corrective action is performed: either by actively skipping the problematic tickets OR by fixing the issue.
NOTE: An error indicating the origin of the failure will be present in the function execution logs.
How to create the Push Cancelled/Invalidated function?
If the TIXNGO interface has not been created or configured, please refer to S-360 to TIXNGO interface > 0. Initial setup of the interface
Once the basic configuration is completed, go the Schedules screen and click New button.
Select the function you want, in this case "Push cancelled and invalidated tickets" to add and Click Next.
How to configure the Push Cancelled/Invalidated function?
Field | Mandatory | Description | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Internal name | Yes | Name for this function | |||||||||
Launch | Yes | Either Manual or Automatic In case Automatic is selected, it's necessary to configure Frequency, Start, End | |||||||||
Frequency | Yes* | Mandatory only if Automatic schedule
| |||||||||
Batch Size | Yes | 1 000 | |||||||||
Shipment modes | Yes | List of shipment modes used by the tickets to be sent to TIXNGO (ie the function will only push tickets using the shipments modes from the list). | |||||||||
Date from | No | If the date is specified (format DD/MM/YY hh:mm), the function will send to TIXNGO all controlled tickets as if the last successful execution of the function was at the given date. USE WITH CAUTION Not suitable for day-2-day operations with an Automatic schedule | |||||||||
Force Ticket Tax Numbers | No | List of Ticket Numbers aka Tax numbers (comma separated) to be sent to TIXNGO (ie the function will only push the ones from the list). USE WITH CAUTION Not suitable for day-2-day operations with an Automatic schedule | |||||||||
Skip Ticket Tax Numbers | No | List of Ticket Numbers aka Tax numbers (comma separated) to NOT be sent to TIXNGO (ie the function will ignore them) USE WITH CAUTION Not suitable for day-2-day operations with an Automatic schedule | |||||||||
Notify spectator | No | Do not use it if you don't understand clearly the usage, it may trigger thousands of unwanted notifications on remote cell phones. | |||||||||
File to upload | No | Will parse the attached file and send the list of tickets to TIXNGO USE WITH CAUTION Not suitable for day-2-day operations with an Automatic schedule |
Ticket visibility rule
S-360 is pushing cancelled and invalidated tickets using an TIXnGI Api parameter called showDeletedTicket which defines its visibility.
The visibility for deleted tickets is following the rules:
- if the cancellation cause is in the list of overrideVisibilityFlagForInvalidationReasons (default value: empty), the the visibility is true. (showDeletedTicket =true)
- Else, if the checkbox "Notify spectator" is checked, the the visibility is set to true. (showDeletedTicket =true)
- Else default visbility is used. Default: false (showDeletedTicket =false), Can be altered using custom parameter: visibilityFlagDefaultValue.