Skip to main content

Sequence Gap Configuration

The TXR Gap Checker uses a grace period to decide when a missing transaction link should be reported as a sequence gap. By default, all business units use a 5 minute grace period.

For background on how gaps are detected, see Sequence Gap.

Configuration kind​

Kindtxr.sequence-gap-grace-period.v1
Max depthbusiness-units/*
Default{ "gapGracePeriodMinutes": 5 }

Value schema​

{
  "gapGracePeriodMinutes": 120
}
FieldTypeDescription
gapGracePeriodMinutesintegerMinutes to wait after a transaction is stored before reporting a gap for that business unit. Minimum 1, maximum 1440 (24 hours).

When no override is set for a business unit and nothing is configured higher in the hierarchy, the default of 5 minutes applies.

CCC API examples​

Replace <IAM_TOKEN>, <TARGET_PATH>, and other placeholders with your values. <TARGET_PATH> can be tenants/self or business-units/<BUSINESS_UNIT_ID>.

Set grace period (PUT)​

Permission required: ccc.configuration.update

curl --location --request PUT 'https://ccc-api.retailsvc.com/api/v1/config/txr.sequence-gap-grace-period.v1/values/<TARGET_PATH>' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer <IAM_TOKEN>' \
--data-raw '{
  "value": {
    "gapGracePeriodMinutes": 120
  }
}'

For this kind, PUT and PATCH are equivalent in practice because the value currently has a single property (gapGracePeriodMinutes). To avoid confusion, this guide shows only PUT.

Get configured grace period​

Permission required: ccc.configuration.get

curl --location 'https://ccc-api.retailsvc.com/api/v1/config/txr.sequence-gap-grace-period.v1/values/<TARGET_PATH>' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer <IAM_TOKEN>'

Remove business unit override​

Deleting the configuration on a business-unit target removes that local override. After that, the business unit will receive the inherited value from the nearest configured parent target (for example tenants/self). If no parent value exists, it falls back to the kind default (5 minutes).

Permission required: ccc.configuration.delete

curl --location --request DELETE 'https://ccc-api.retailsvc.com/api/v1/config/txr.sequence-gap-grace-period.v1/values/business-units/<BUSINESS_UNIT_ID>' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer <IAM_TOKEN>'