The Connector Pool is used when processing a transaction and contains a number of Connectors. When a pool is selected to process a transaction, each connector in that pool will be attempted according to the pool configuration.
As with all configs, the standard wrapper is used.
{
"kind": "ConnectorPool", // Must be set to "ConnectorPool"
"metadata": {
"projectId": "test-project", // Must be set to the ChargeHive Project ID you were issued with
"name": "test-pool-x", // Set this to a memorable name for the pool typically giving an indicator of the charges that will be attempted by this pool, no spaces, all lowercase
},
"specVersion": "v1", // Must be set to the correct version
"selector": {}, // May be used to apply this to a subset of charges
"spec": {
"restriction": "unrestricted", // Can be set to: "unrestricted", "noRepeat" or "lowestUsage"
"connectors": [ // Connectors contains the list of connectors in the pool
{
"connectorId": "xxxxxxxxxxxx", // Identifier for a connector
"priority": 10, // Highest priority item has the lowest integer value (0 is the highest priority)
"weighting": 0, // Weighting is used to weigh items of the same priority, secondary to priority (0-1000)
"uses": 10, // Uses is the maximum times a connector can be used in a single charge
}
]
}
}The spec entered in a Connector Pool config will determine which connectors are selected to attempt the charge through, and in what order.
The spec contains two variables;
The restriction details whether this connector pool is repeated or not. This can be set to:
"unrestricted" (no restrictions will be applied)
"noRepeat" (each time this connector pool attempts a charge, it will not select the last Connector attempted) - This ensures that different connectors are selected with each attempt of this pool.
"lowestUsage" (the pool will prioritise the connector with the lowest amount of attempts across all charges) - This ensures that all connectors get attemted a similar number of times.
"fullCycle" (a full cycle pool will ensure every connector within the pool has been attempted, before retrying) - This ensures that all connectors get attemted before retrying.
"priority" (loop through each connector in priority order, using the previous attempt as its calculation) - This ensures the order of the connectors to be attempted based on the previous attempt.
The connectors variable is a container for the list of connectors in this pool defined below.
| FieldName | Required | Definition |
|---|---|---|
| restriction | false | "unrestricted" (Default) , "noRepeat", "lowestUsage", "fullCycle" or "priority" |
| connectors | false | Non-empty list of the connectors in the pool |
The connectors variable contains a list of the connectors within this pool. You define the connectorID, priority, weighting and uses for each connector. The priority, weighting and uses determine which Connector to use first and how many times to attempt a connector.
| FieldName | Required | Definition |
|---|---|---|
| connectorId | true | Identifier for a connector, must match a previously defined connector id |
| priority | false | Highest priority item has the lowest integer value (0 is the highest priority) |
| weighting | false | Weighting is used to weigh items of the same priority, secondary to priority (0-1000) |
| uses | false | Uses is the maximum times a connector can be used in a single charge |
Here is a working example to create a connector pool called test-pool-x which contains two connectors.
{
"kind": "ConnectorPool",
"metadata": {
"projectId": "test-project",
"name": "test-pool-x"
},
"specVersion": "v1",
"selector": {},
"spec": {
"restriction": "unrestricted",
"connectors": [
{
"connectorId": "connector1",
"priority": 0,
"weighting": 0,
"uses": 10
},
{
"connectorId": "connector2",
"priority": 10,
"weighting": 0,
"uses": 10
}
]
}
}