...
com.cdrator.integration.utils.rator-utils-restutils
com.cdrator.core:rator-engine-api
com.cdrator.util.rator-logging
com.cdrator.workflow.hookpoint-stats
com.cdrator.workflow.hookpoint-documentation
com.fasterxml.jackson.core:jackson-databind
com.fasterxml.jackson.core:jackson-core
org.glassfish.jersey.media:jersey-media-json-jackson
javax.ws.rs:javax.ws.rs-api
org.glassfish.jersey.core:jersey-client
org.apache.commons:commons-lang3
com.google.guava:guava
Source code for the module can be found in bitbucket: https://bitbucket.org/cdratorenghouseglobal/nw-ra-rator-insurance-no-squaretrade
Square Trade API Documentation
...
| View file | ||
|---|---|---|
|
| View file | ||
|---|---|---|
|
| View file | ||
|---|---|---|
|
Also note, that they are not 100% correct, a couple of errors have been regarding the URL’s and the multiple credentials. (see under configuration)
Implementation
The project consist of a new table and two new engines
Square Trade Order Table
The table (SQUARE_TRADE_ORDER) contains the information about the square trade order, primarily used to keep track of the current status and related dates.
...
Name
...
Description
...
ID
...
Standard rator id
...
WORKFLOW_ID
...
Id of any workflow to push
...
CODE
...
Type of order only CREATE, CHANGE and TERMINATE allowed.
...
STATUS_ID
...
Status of the order, supports 0 (new), 1 (waiting), 2 (success) and 5 (error)
...
SQUARE_TRADE_ID
...
Id of the order in square trade system, used for the inquiry call
...
CREATE_DATE
...
The date the order was created
...
LAST_CHECKED_DATE
...
The date the order was last inquired on the square trade system
...
ERROR_MESSAGE
...
Any errors received from square trade
...
engine, as it is heavily dependent generic order and custom logic in the customer project.
Square Trade Order Inquiry Engine
The engine (com.cdrator.insurance.handlerengineinquiryengine.SquareTradeOrderHandlerEngine) retrieves new square trade order entries and handles them.
EngineParameters
No specific parameters are needed.
EngineStartupCheck
Startup check implementation. No startup checks are required, so this just returns true. Exists to enable the implementation of startup checks if required.
EngineQueueLoader
Uses the broker to retrieve square trade orders where:
status id is 0 (new)
EngineHandler
The EngineHandler will:
Receive a list of square trade orders
Call specific hookpoints to retrieve the request object, based on the CODE (see below)
Send the request to Square Trade
Update the status of the square trade order to either waiting or error based on the response
Square Trade Order Inquiry Engine
The engine (com.cdrator.insurance.inquiryengine.SquareTradeOrderInquiryEngine) checks waiting square trade ordersSquareTradeOrderInquiryEngine) checks waiting SquareTradeOrderInquiry objects where the LAST_CHECKED_DATE is before sysdate + a configurable amount of seconds.
it is then inquiring about the status with Square Trade and updating its own status and the status of the generic order according to the response.
EngineParameters
One optional extra parameter exist:
Name | Description | Default value |
|---|---|---|
SECONDS_BEFORE_CHECKING | Minimum amount of seconds passed before checking an order again. | 300 |
EngineStartupCheck
Startup check implementation. No startup checks are required, so this just returns true. Exists to enable the implementation of startup checks if required.
EngineQueueLoader
Uses the broker to retrieve account payments generic orders where:
status id is 1 2 (waitingprocessing)
partner code is “SQUARE_TRADE”
more than SECONDS_BEFORE_CHECKING have passed since the record was last checked
EngineHandler
The EngineHandler will:
Receive a list of square trade generic orders
Retrieve the status of the order from square trade
If response is either success or error, update the order and if there is a workflow on it, push the workflow
Regardless of the response, update the last checked date to sysdate
Configuration
Parameters
Square trade allows for multiple set of parameters, they are configured in the parameter tree under the node INSURANCE.SQUARE_TRADE.(credentialParameterName).
Note that the credentialParameterName is optional, but advised, as squaretrade currently requires different credentials depending on the SKU.
The following parameters are used in the rator-insurance-no-squaretrade module.
Name
Hookpoint key
Description
Context
Result
INSURANCE.SQUARE_TRADE | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
NAME | EXAMPLE VALUE | MANDATORY | DESCRIPTION | |||||||
BASE_URL | api-stage4.squaretrade.com (test) | Yes | The base endpoint for the Telenor Wholesale REST API. | |||||||
CLIENT_ID | N074R341V41u38u7C10533n0u9hR19h7 | Yes | The value to use for the | |||||||
CLIENT_SECRET | 4n07h3rF4k3V41u3 | Yes | The value to use for the | USERNAME | api_F4k3V41u3 | Yes | The value to use for the | M0r3F4k3V41u3sF0r3v3r | Yes | The value to use for the |
TOKEN | No If branded USERNAME,PASSWORD,CLIENT_ID, CLIENT_SECRET parameters are used, this parameter has to be created manually. | The currently valid token for authorization. This will be automatically populated if there is only one set of credentials used. If multiple sets of credentials (USERNAME,PASSWORD,CLIENT_ID, CLIENT_SECRET) are used via branding of parameters, in combination with a set of non-branded/default credentials, this parameter has to be created beforehand, so as not to interfere with the non-branded/default one. | ||||||||
TOKEN_EXPIRY | No If branded USERNAME,PASSWORD,CLIENT_ID, CLIENT_SECRET parameters are used, this parameter has to be created manually. | The point in time at which the current token will expire. This will be automatically populated if there is only one set of credentials used. If multiple sets of credentials (USERNAME,PASSWORD,CLIENT_ID, CLIENT_SECRET) are used via branding of parameters, in combination with a set of non-branded/default credentials, this parameter has to be created beforehand, so as not to interfere with the non-branded/default one. | ||||||||
Hookpoints
Due to the amount of values that are needed in the api, but are not available in rator core, hookpoints are used to generate the requests:
MERCHANT_ID | RATOR | Yes | Despite being sent as part of the payload for a new insurance request, merchant id is part of the credentials, as a merchant id is linked to a specific client id and secret. |
Tables
One new table needs to be added to handle the inquiry status:
SQUARE_TRADE_ |
|---|
ORDER_ |
|---|
Used for creating insurances
A square trade order with key SQUARE_TRADE_ORDER
A com.cdrator.insurance.message.request.CreateInsuranceRequest with key SQUARE_TRADE_REQUEST
Change
SQUARE_TRADE_CHANGE_REQUEST
Used for changing between types of insurances
A square trade order with key SQUARE_TRADE_ORDER
A com.cdrator.insurance.message.request.ChangeInsuranceRequest with key SQUARE_TRADE_REQUEST
Terminate
SQUARE_TRADE_TERMINATE_REQUEST
Used for terminating an insurance
A square trade order with key SQUARE_TRADE_ORDER
INQUIRY | |
|---|---|
NAME | DESCRIPTION |
ID | Standard rator id. |
STATUS_ID | The status of the inquiring, can be 0 (waiting), 1 (success) and 5 (error) |
GENERIC_ORDER_ID | The id of the generic order this was created from. |
SQUARE_TRADE_ID | The instance id sent to Square Trade. |
CREATE_DATE | The date this object was created. |
LAST_CHECKED_DATE | The last time this has been inquired. |
ERROR_MESSAGE | Any error message returned from Square Trade. |
CREDENTIAL_PARAMETER_NAME | The parameter node to find the credentials under. |
Implementation in customer project.
Due to how much of the required data that is not stored in rator core, the entire process of creating request, filling out the required data and sending the request, has to done in the customer project.
Logging
Logging of the connection is done in the CLIENT_LOG table with the client name SQUARE_TRADE and either the inquiry or generic order id.
Examples of the exact payloads can be seen in the attached documentation.