...
Supported parameters (13.05.2024)
| Custom parameters | Type | Purpose |
|---|---|---|
| Interface Global Parameters | ||
| killRatio | ||
| S-360 Technical | This parameter is technical, for advanced configuration. To avoid blocking the execution of the interface | |
| doContinueInCaseOfSyncError | S-360 Technical | doContinueInCaseOfSyncError=true required for “Receive ticket status from TIXnGO” interface functionality, prevents same error tickets being considered by the interface multiple times. |
| stickToTheHour | S-360 Technical | Advanced configuration. Default value: true. |
| maxLengthDumpedCallsInKbs | S-360 Technical | Use for troubleshooting ONLY. In order to save the payloads exchanged between S-360 & TIXNGO, you can use maxLengthDumpedCallsInKbs=5000 |
| ticketIterationSize | TIXNGO Performances | Integer. Default value : 50. Number of tickets pushed to TIXNGO in one call. |
| Ticket Injection | ||
| dumpTnPRvariables=true | S-360 Technical | To generate tnPRVariables file ticket detail after injecting ticket into TnG. To check the variable and its value as well |
| enforceMandatoryParameters | S-360 Business | The interface fails with a proper error message before calling TixNGo if the mandatory parameters of the tickets to inject are not present. Default value : true. Do not change if you don't know what you are doing. |
| dumpDataModifiedByTemplate | S-360 Technical | Default value: false. Set it to true to log the values modified by the template associated to the export. |
The parameter is spelled with "Spectatir" (typo included) not "Spectator" as you may expect.resetInjectionInvalidationReasons| overlaySpectatorDetailsWithLastOwner | S-360 Technical | Default value: true. Set it to false to skip the rule: But, IF the tickets has been reprinted, it will be assigned to its last known holder, as retrieved from TIXnGO |
resetInjectionInvalidationReasons | S-360 Business | This custom parameter is used for the Tickets external printing |
to allow injecting mobile tickets to the latest ticket holder contact or cultural contact based on the invalidation reason, i.e., reseating Example: After injecting ticket into TnG for contact A (cultural contact) then contact A open mobile app and transfer the ticket to contact B (latest mobile owner). On the STX side, the operator reprinted that ticket with invalidation reason THEFT and reinject it into TnG, this ticket will reinject back to contact A. If there is no invalidation reason here, the new ticket will be reinjected back to contact B Note: All the cancellation reasons are those which appear on the list of values in the BO [Institution > Initialisation > List of values > Ticket (Cancellation cause)]. With validation reason Theft , rESEATING will work too because the invalidation causes will be modified in order to remove the spaces and to be all set in upper cases
|
resetInjectionInvalidationReasons=ITA_WRONG_DATA this is required for ticket reprint functionality. With this setup if mobile ticket is reprinted with invalidation reason “WRONG DATA” ticket will be injected to the current cultural contact and not to the latest owner. | ||||||||||||||
sendMultilingualAsJsonObject updateJSONInsteadOfObject | S-360 Business | Use sendMultilingualAsJsonObject=true to inject tickets to TIXNGO from S360 or by CSV with multilingual support
| ||||||||||||
injectOptimSplitQueries | It is an optimization to reduce the time of selecting tickets to process in ticket injection. by default is true. to desactivate; injectOptimSplitQueries=false | |||||||||||||
| Retrieve ticket status | ||||||||||||||
| TIXNGO_LIFECYCLE_MODE | TIXNGO Business | |||||||||||||
| Jira Legacy | ||||||
|---|---|---|---|---|---|---|
|
| ||
| additionalDiffParameters | TIXNGO Technical | Advanced configuration. Use for troubleshooting ONLY. String. Multi-value parameters allowing to customize results returned by TIXNGO diff end-point |
using the lifecycle mode |
. |
|
Use for troubleshooting ONLY. Not fit for day-to-day operations. → By setting up a date, TIXNGO will return only the tickets matching the updatedDate criteria.
Use for troubleshooting ONLY. Not fit for day-to-day operations. → By setting up a date, TIXNGO will return only the tickets matching the updatedDate criteria. For more information please refer to the US TIX2-3167 | ||
| batchSplitSize | TIXNGO Performances | To support larger batch sizes, split them into smaller calls to blockchain to retrieve smaller batches, one after the other inside the same execution. The default split size is 1000 Example: Batch size in the Retrieve tickets status from TIXnGO = 5000, batchSplitSize = 1000. It will split 5000 to 5 calls in the same execution with 1000 per call |
This custom parameter is used for the Tickets external printing/ Push cancelled and validate tickets/ Push controlled tickets. To support larger batch sizes, split them into smaller calls to blockchain to send smaller batches, one after the other inside the same execution. The default split size is 50
Note: The TIXnGO side supported only 50 tickets/times, so that should be kept as default.
overrideVisibilityFlagForInvalidationReasons
| enableTicketDistributionToCulturalContact | S-360 Business | Default value: false. When true, for a successfully transferred ticket, will create a cultural contact and change the CC of this ticket by this newly created contact (ie "Distribute the ticket") while introducing a new row into the Distribution history. For other "PENDING" statuses, will create a contact based on what is already returned by TIXNGO and update it later when the transfer is either completed or cancelled/interrupted. |
| Push Cancelled | ||
|---|---|---|
| excludeResaleTickets overrideVisibilityFlagForInvalidationReasons | S-360 Business | Both custom parameters are used for putting blockchain tickets into the resale platform and specified for Push cancelled and validate ticket batch. The purpose of those parameters is to update the invalidation reason to TnG after putting the ticket on the resale platform or tickets is resold. Example: |
DEPRECATED excludeResaleTickets=true, overrideVisibilityFlagForInvalidationReason=RESALE_PENDING, RESOLD. by default. After putting the ticket on the resale platform, the old ticket is invalidated and the validation reason will be updated into TnG side by the Push cancelled and validate ticket with invalidation set at overrideVisibilityFlagForInvalidationReason For more information, please refer to the US STX-110559. For more information regarding visibility rule, please refer to the section "Ticket visibility rule" in https://confluence.secutix.com/x/tAxWCg |
| cancelledBucketSize |
| TIXNGO Performances | Integer. Default value : |
50. Number of tickets pushed to TIXNGO in one call. | ||
| Push Controlled | ||
| doPatchWhenPushingControlledTickets | ||
| TIXNGO Performances |
|
false |
, the |
function is using POST method which has better performances. | ||
| controlledBucketSize | TIXNGO Performances | Integer. Default value : 50. Number of tickets pushed to TIXNGO in one call. |