Socotra

https://docs.socotra.com
Admin
Socotra is an insurance core system that provides a platform and APIs for managing the entire...
Tokens:566,558
Snippets:4,272
Trust Score:9.7
Update:4 days ago
Show doc for...
Tokens:
Raw
### Product Configuration Default Installment Plan

Source: https://docs.socotra.com/configuration/plugins/autopay

Example of specifying a defaultInstallmentPlan in the product configuration.

```json
{
	"defaultInstallmentPlan": "Quarterly"
}
```

--------------------------------

### Install @socotra/ec-react-components

Source: https://docs.socotra.com/ui-sdk/components

Use npm to install the library into your project.

```sh
npm i @socotra/ec-react-components
```

--------------------------------

### Install @socotra/ec-react-utils

Source: https://docs.socotra.com/ui-sdk/utils

Install the package using npm. Note that it has peer dependencies on @socotra/ec-react-schemas and zod.

```sh
npm i @socotra/ec-react-utils
```

--------------------------------

### startMigrationForAccount

Source: https://docs.socotra.com/api/migration

Starts migrations for an existing account. This endpoint allows starting migrations for an account that already exists in the system.

```APIDOC
## startMigrationForAccount

### Description
Starts migrations for an existing account. This endpoint allows starting migrations for an account that already exists in the system.

### Method
POST

### Endpoint
startMigrationForAccount

### Request Body
- MigrationRequest (object) - Required - The migration request details.

### Response
#### Success Response
- MigrationResponse (object) - The migration response.

```

--------------------------------

### Install EC React packages

Source: https://docs.socotra.com/ui-sdk

Command to install the core packages required for the EC React framework.

```sh
npm i @socotra/ec-react-components @socotra/ec-react-schemas @socotra/ec-react-utils
```

--------------------------------

### Run Migration Client CLI

Source: https://docs.socotra.com/features/migration

Execute the migration client from the bin directory to view usage instructions and available configuration options.

```bash
(.venv) alice@machine1 bin % ./migrate
Usage: ./migrate <path-to-config-file>

Options:
<path-to-config-file>   Specify the location of the configuration YAML file.
help                    Show this help message.

Configuration file help:
help pipeline            Show configuration details for the Migration Pipeline.
help service-api         Show configuration details for the Service API.
help converter           Show configuration details for the Migration Request Converter.
help processor           Show configuration details for the Request Processor.
help patcher             Show configuration details for Patch Migration Failures.
help coda                Show configuration details for the Post Migration.
```

--------------------------------

### Get Migration Failures Response

Source: https://docs.socotra.com/features/migration

Example response from the Get Migration Failures endpoint detailing validation errors for an account.

```json
{
	"listCompleted": true,
	"items": [
		{
			"accountLocator": "01K04V1J98ED34S2DRDBZMCTD1",
			"accountOriginalId": "1234",
			"accountError": {
				"originalId": "1234",
				"errors": {
					"validationItems": [
						{
							"elementType": "SampleAccount",
							"errors": [
								"Non optional property 'sampleAccount.firstName' is missing"
							]
						}
					],
					"success": false
				}
			}
		}
	]
}
```

--------------------------------

### Single top-level config.json structure

Source: https://docs.socotra.com/configuration/general-topics/deployment

Example of a single top-level configuration file containing account and product definitions.

```json
{
	"accounts": {
		"ConsumerAccount": {
			// ...
		},
		"CommercialAccount": {
			// ...
		}
	},
	"products": {
		"PersonalAuto": {
			// ...
		},
		"HO3": {
			// ...
		}
	},
	"defaultCurrency": "USD"
}
```

--------------------------------

### Get Migration Summary Response

Source: https://docs.socotra.com/features/migration

Example JSON response from the Get Migration Summary endpoint indicating a successful migration.

```json
{
	"locator": "01K04P56E46KN3DDY6695M2T9P",
	"migrationState": "finished",
	"processedAccounts": 1,
	"totalAccounts": 1
}
```

--------------------------------

### Account-Level Installment Preferences JSON

Source: https://docs.socotra.com/features/billing/installment-settings

Example of setting account-level installment preferences to ensure all invoices are due on the 10th of the month.

```json
{
	"anchorMode": "dueTime",
	"anchorType": "dayOfMonth",
	"dayOfMonth": 10
}
```

--------------------------------

### POST /migration/{tenantLocator}/migrations

Source: https://docs.socotra.com/api/migration

Starts a migration for a tenant. Requires write permission and an idempotency key header.

```APIDOC
## POST /migration/{tenantLocator}/migrations

### Description
Starts a migration for a tenant.

### Method
POST

### Endpoint
/migration/{tenantLocator}/migrations

### Parameters
#### Path Parameters
- **tenantLocator** (uuid) - Required - The tenant locator.

#### Header Parameters
- **X-Idempotency-Key** (string) - Optional - Idempotency key.

#### Request Body
- **AccountMigrationRequest[]** - Required - Array of account migration requests.

### Response
#### Success Response (200)
- **OK** - Success.

```

--------------------------------

### Update Installment Timing via updateInstallments

Source: https://docs.socotra.com/features/billing/invoicing

Example request for the updateInstallments API endpoint to modify generateTime, dueTime, and autopayTime for uninvoiced installments. This request supports up to 100 installments per call, all belonging to the same account.

```json
{
	"installmentLocators": [
		"01J5R7B8K3A8WVRNE0G2W7H1ZP",
		"01J5R7B8K3A8WVRNE0G2W7H1ZQ"
	],
	"generateTime": "2026-06-15T00:00:00Z",
	"dueTime": "2026-07-01T00:00:00Z",
	"autopayTime": "2026-06-29T00:00:00Z"
}
```

--------------------------------

### Update Installments to Next Month

Source: https://docs.socotra.com/configuration/plugins/installments

Java implementation of the InstallmentsPluginResponse updateInstallments method. It moves past installments to the beginning of the next month by adjusting generate and due times. Uses DataFetcher to get the policy timezone and logs updates for each installment.

```java
// Adjusts the generate time to the beginning of the next month

@Override
public InstallmentsPluginResponse updateInstallments(CommercialAutoRequest commercialAutoRequest) {
    Map<String, InstallmentUpdate> installmentUpdates = movePastInstallmentsToNextMonth(commercialAutoRequest);
    return InstallmentsPluginResponse.builder().installmentUpdates(installmentUpdates).build();
}

private Map<String, InstallmentUpdate> movePastInstallmentsToNextMonth(CommercialAutoRequest commercialAutoRequest) {
    InstallmentsPluginContext context = commercialAutoRequest.context();
    Collection<Installment> installments = commercialAutoRequest.installments();
    InstallmentLattice installmentLattice = commercialAutoRequest.installmentLattice();

    log.info(
            "Received InstallmentsPlugin request for context: {}, installments: {} and installmentLattice: {}",
            context,
            installments,
            installmentLattice);

    DataFetcher dataFetcher = DataFetcher.getInstance();
    Policy policy = dataFetcher.getPolicy(context.policyLocator().orElseThrow());

    Instant now = Instant.now();
    ZoneId zoneId = ZoneId.of(policy.timezone());
    ZonedDateTime zonedDateTime = now.atZone(zoneId);
    ZonedDateTime nextMonthDayOne = zonedDateTime.plusMonths(1).withDayOfMonth(1).toLocalDate().atStartOfDay(zoneId);
    Instant newGenerateTime = nextMonthDayOne.toInstant();

    Map<String, InstallmentUpdate> installmentUpdates = new HashMap<>();

    for (Installment installment : installments) {
        if (installment.generateTime().isBefore(newGenerateTime)) {
            InstallmentUpdate update =
                    InstallmentUpdate.builder()
                            .generateTime(newGenerateTime)
                            .dueTime(newGenerateTime.plusMillis(Duration.between(installment.generateTime(), installment.dueTime()).toMillis()))
                            .build();

            installmentUpdates.put(installment.locator().toString(), update);

            log.info(
                    "Updated installment {} to new generate time {} and due time {}",
                    installment.locator(),
                    newGenerateTime,
                    update.dueTime());
        } else {
            log.info(
                    "Installment {} was not updated because the old generate time {} is after the new generate time {}",
                    installment.locator(),
                    installment.generateTime(),
                    newGenerateTime);
        }
    }

    log.info("Returning installment updates: {}", installmentUpdates);

    return installmentUpdates;
}
```

--------------------------------

### NewDisbursementForm usage example

Source: https://docs.socotra.com/ui-sdk/components/new-disbursement-form

Demonstrates how to implement the NewDisbursementForm by providing account details, a data model, and a submission handler.

```ts
import { NewDisbursementForm } from '@socotra/ec-react-components';
import { DataModel, CurrencyType } from '@socotra/ec-react-schemas';

// Example Usage
const MyDisbursementComponent = ({ dataModel }: { dataModel: DataModel }) => {
  const handleSubmit = (disbursementData) => {
    console.log('Disbursement created:', disbursementData);
    // Handle API call to create the disbursement
  };

  return (
    <NewDisbursementForm
      accountLocator="123-abc"
      accountBalance={5000}
      currency={"USD" as CurrencyType}
      dataModel={dataModel}
      handleSubmit={handleSubmit}
      submitButtonText="Create Disbursement"
    />
  );
};
```

--------------------------------

### GET /billing/{tenantLocator}/installments/quotes/statelessPreview

Source: https://docs.socotra.com/api/billing/installments

Previews installments for a stateless quote. Requires read permission.

```APIDOC
## GET /billing/{tenantLocator}/installments/quotes/statelessPreview

### Description
Previews installments for a stateless quote.

### Method
GET

### Endpoint
/billing/{tenantLocator}/installments/quotes/statelessPreview

### Parameters
#### Path Parameters
- **tenantLocator** (uuid) - Required - The tenant locator.

#### Query Parameters
- **quotePreviewRequest** (QuoteBillingPreviewRequest) - Required - The quote preview request.

### Response
#### Success Response (200)
- **InstallmentsPreview** - OK

#### Response Example
{
  "installments": [],
  "accountLocator": "",
  "queuedPolicyCharges": [],
  "durationBasis": "years",
  "settings": {},
  "persistedInstallmentLocators": []
}
```

--------------------------------

### Migration Tutorial Directory Structure

Source: https://docs.socotra.com/features/migration

The standard directory layout for the migration tutorial repository containing apps, configuration, and source data.

```text
├── apps
│   ├── coda
│   └── converter
├── config
└── source
```

--------------------------------

### GET /billing/{tenantLocator}/installments/policies/{policyLocator}/list

Source: https://docs.socotra.com/api/billing/installments

Fetches installments for a specific policy. Requires read and list permissions.

```APIDOC
## GET /billing/{tenantLocator}/installments/policies/{policyLocator}/list

### Description
Fetches installments for a specific policy.

### Method
GET

### Endpoint
/billing/{tenantLocator}/installments/policies/{policyLocator}/list

### Parameters
#### Path Parameters
- **tenantLocator** (uuid) - Required - The tenant locator.
- **policyLocator** (ulid) - Required - The policy locator.

#### Query Parameters
- **offset** (integer) - Optional - Offset for pagination.
- **count** (integer) - Optional - Number of items to return.

### Response
#### Success Response (200)
- **InstallmentListResponse** - OK

#### Response Example
{
  "listCompleted": true,
  "items": []
}
```

--------------------------------

### Tenant configuration directory structure for accounts

Source: https://docs.socotra.com/features/accounts

Example directory tree showing how account types are organized within the accounts directory.

```text
├── accounts
│   ├── BaseAccount
│   │   └── config.json
│   ├── CommercialAccount
│   │   └── config.json
│   └── ConsumerAccount
│       └── config.json
```

--------------------------------

### Define product elements in config.json

Source: https://docs.socotra.com/features/policy-management/policy-elements

Example configuration showing the definition of coverage and exposure types within the top-level config.json file.

```json
{
	"coverages": {
		"LiabilityCoverage": {},
		"ComprehensiveCoverage": {}
	},
	"exposures": {
		"Person": {},
		"PersonalVechicle": {}
	}
}
```

--------------------------------

### GET /billing/{tenantLocator}/installments/quotes/{quoteLocator}/list

Source: https://docs.socotra.com/api/billing/installments

Fetches installments for a specific quote. Requires read and list permissions.

```APIDOC
## GET /billing/{tenantLocator}/installments/quotes/{quoteLocator}/list

### Description
Fetches installments for a specific quote.

### Method
GET

### Endpoint
/billing/{tenantLocator}/installments/quotes/{quoteLocator}/list

### Parameters
#### Path Parameters
- **tenantLocator** (uuid) - Required - The tenant locator.
- **quoteLocator** (ulid) - Required - The quote locator.

#### Query Parameters
- **offset** (integer) - Optional - Offset for pagination.
- **count** (integer) - Optional - Number of items to return.

### Response
#### Success Response (200)
- **InstallmentListResponse** - OK

#### Response Example
{
  "listCompleted": true,
  "items": []
}
```

--------------------------------

### GET /billing/{tenantLocator}/settings/{locator} — fetchInstallmentLatticeSettings

Source: https://docs.socotra.com/api/billing/installment-lattices

Fetches the settings for an installment lattice. Requires read permission.

```APIDOC
## GET /billing/{tenantLocator}/settings/{locator}

### Description
Fetches the settings for an installment lattice.

### Method
GET

### Endpoint
/billing/{tenantLocator}/settings/{locator}

### Parameters
#### Path Parameters
- **tenantLocator** (uuid) - Required - The tenant locator.
- **locator** (ulid) - Required - The locator of the settings.

### Response
#### Success Response (200)
- **SettingsResponse** - OK

#### Response Example
{
  "locator": "ulid",
  "installmentSettings": {
    "cadence": "none",
    "anchorMode": "generateDay",
    "generateLeadDays": 0,
    "dueLeadDays": 0,
    "installmentWeights": [0],
    "maxInstallmentsPerTerm": 0,
    "anchorType": "none",
    "dayOfMonth": 0,
    "dayOfWeek": "monday",
    "weekOfMonth": "none",
    "anchorTime": "datetime",
    "autopayLeadDays": 0
  }
}
```

--------------------------------

### Define Coverage Terms in Configuration

Source: https://docs.socotra.com/features/policy-management/coverage-terms

Example showing how to define coverage terms using options, a specific value type, or no associated value within the tenant configuration.

```json
// ... ,
"coverageTerms": {
    "LiabilityLimit": {
      // defining an "options" coverage term
      "type": "limit",
      "displayName": "Liability Limit",
      "options": {
        "PAL100_000" : {
          "displayName" : "$100,000"
        },
        "PAL250_000" : {
          "displayName" : "$250,000"
        },
      // ...,
      }
    },
    "ComputedLimit": {
      // defining a "value" coverage term
      "type": "limit",
      "displayName": "Computed Limit",
      "value": {
        "type": "int",
        "min": 1000,
        "max": 5000
      }
    },
    "SpecialDeductible": {
      // defining a coverage term with no associated value
      "type": "deductible",
      "displayName": "Special Deductible"
    }
}
```

--------------------------------

### GET /billing/{tenantLocator}/jobs/installments/transactions/{locator}/list

Source: https://docs.socotra.com/api/configuration-and-development/jobs

Fetches installment job data for transactions. Requires read and list permissions.

```APIDOC
## GET /billing/{tenantLocator}/jobs/installments/transactions/{locator}/list

### Description
Fetches installment job data for transactions.

### Method
GET

### Endpoint
/billing/{tenantLocator}/jobs/installments/transactions/{locator}/list

### Parameters
#### Path Parameters
- **tenantLocator** (uuid) - Required - The tenant locator.
- **locator** (ulid) - Required - The transaction locator.

#### Query Parameters
- **offset** (integer) - Optional - Offset for pagination.
- **count** (integer) - Optional - Number of items to return.

### Response
#### Success Response (200)
InstallmentJobDataListResponse - OK
```

--------------------------------

### POST /migration/{tenantLocator}/migrations/accounts/{accountLocator}

Source: https://docs.socotra.com/api/migration

Starts a migration for a specific account. Requires write permission and an idempotency key header.

```APIDOC
## POST /migration/{tenantLocator}/migrations/accounts/{accountLocator}

### Description
Starts a migration for a specific account.

### Method
POST

### Endpoint
/migration/{tenantLocator}/migrations/accounts/{accountLocator}

### Parameters
#### Path Parameters
- **tenantLocator** (uuid) - Required - The tenant locator.
- **accountLocator** (ulid) - Required - The account locator.

#### Header Parameters
- **X-Idempotency-Key** (string) - Optional - Idempotency key.

#### Request Body
- **MigrationRequest** - Required - Migration request.

### Response
#### Success Response (200)
- **OK** - Success.

```

--------------------------------

### GET /billing/{tenantLocator}/installments/transactions/{transactionLocator}/list

Source: https://docs.socotra.com/api/billing/installments

Fetches installments for a specific policy transaction. Requires read and list permissions.

```APIDOC
## GET /billing/{tenantLocator}/installments/transactions/{transactionLocator}/list

### Description
Fetches installments for a specific policy transaction.

### Method
GET

### Endpoint
/billing/{tenantLocator}/installments/transactions/{transactionLocator}/list

### Parameters
#### Path Parameters
- **tenantLocator** (uuid) - Required - The tenant locator.
- **transactionLocator** (ulid) - Required - The transaction locator.

#### Query Parameters
- **offset** (integer) - Optional - Offset for pagination.
- **count** (integer) - Optional - Number of items to return.

### Response
#### Success Response (200)
- **InstallmentListResponse** - OK

#### Response Example
{
  "listCompleted": true,
  "items": []
}
```

--------------------------------

### Configure invoicingPlans with consolidateInvoicesOnCancellation

Source: https://docs.socotra.com/features/billing/invoicing

Example configuration showing three distinct invoicing plans with different consolidation strategies for cancellation transactions.

```json
{
	"invoicingPlans": {
		"ConsolidateAll": {
			"displayName": "Consolidate all uninvoiced installments on cancellation",
			"consolidateInvoicesOnCancellation": "all"
		},
		"NoConsolidation": {
			"displayName": "No invoice consolidation on cancellation",
			"consolidateInvoicesOnCancellation": "none"
		},
		"ConsolidateFuture": {
			"displayName": "Consolidate future uninvoiced installments only",
			"consolidateInvoicesOnCancellation": "future"
		}
	}
}
```

--------------------------------

### GET /billing/{tenantLocator}/installmentLattices/quotes/{quoteLocator} — fetchLatestInstallmentLatticeByQuoteLocator

Source: https://docs.socotra.com/api/billing/installment-lattices

Fetches the latest installment lattice for a given quote. Requires read permission.

```APIDOC
## GET /billing/{tenantLocator}/installmentLattices/quotes/{quoteLocator}

### Description
Fetches the latest installment lattice for a given quote.

### Method
GET

### Endpoint
/billing/{tenantLocator}/installmentLattices/quotes/{quoteLocator}

### Parameters
#### Path Parameters
- **tenantLocator** (uuid) - Required - The tenant locator.
- **quoteLocator** (ulid) - Required - The quote locator.

### Response
#### Success Response (200)
- **InstallmentLatticeResponse** - OK

#### Response Example
{
  "locator": "ulid",
  "settingsLocator": "ulid",
  "createdAt": "datetime",
  "createdBy": "uuid",
  "accountLocator": "ulid",
  "termStartTime": "datetime",
  "termEndTime": "datetime",
  "termLocator": "ulid",
  "quoteLocator": "ulid",
  "policyLocator": "ulid",
  "currency": "string",
  "timezone": "string",
  "basedOnLocator": "ulid",
  "effectiveTime": "datetime",
  "frames": [
    {
      "installmentStartTime": "datetime",
      "installmentEndTime": "datetime",
      "coverageStartTime": "datetime",
      "coverageEndTime": "datetime",
      "installmentDuration": 0,
      "normalizedWeight": 0,
      "coverageDuration": 0,
      "generateTime": "datetime",
      "dueTime": "datetime",
      "autopayTime": "datetime"
    }
  ],
  "reversalLattice": false
}
```

--------------------------------

### Basic Velocity Template Example

Source: https://docs.socotra.com/features/documents/dynamic-documents

A simple Velocity template demonstrating how to reference product name data.

```text
Summary for Product $data.productName

Lorem ipsum...
```

--------------------------------

### GET /billing/{tenantLocator}/installmentLattices/policies/{policyLocator}/list — fetchInstallmentLatticesByPolicyLocator

Source: https://docs.socotra.com/api/billing/installment-lattices

Fetches a list of installment lattices for a given policy. Requires read and list permissions.

```APIDOC
## GET /billing/{tenantLocator}/installmentLattices/policies/{policyLocator}/list

### Description
Fetches a list of installment lattices for a given policy.

### Method
GET

### Endpoint
/billing/{tenantLocator}/installmentLattices/policies/{policyLocator}/list

### Parameters
#### Path Parameters
- **tenantLocator** (uuid) - Required - The tenant locator.
- **policyLocator** (ulid) - Required - The policy locator.

#### Query Parameters
- **offset** (integer) - Optional - The offset for pagination.
- **count** (integer) - Optional - The number of items to return.

### Response
#### Success Response (200)
- **InstallmentLatticeListResponse** - OK

#### Response Example
{
  "listCompleted": true,
  "items": [
    {
      "locator": "ulid",
      "settingsLocator": "ulid",
      "createdAt": "datetime",
      "createdBy": "uuid",
      "accountLocator": "ulid",
      "termStartTime": "datetime",
      "termEndTime": "datetime",
      "termLocator": "ulid",
      "quoteLocator": "ulid",
      "policyLocator": "ulid",
      "currency": "string",
      "timezone": "string",
      "basedOnLocator": "ulid",
      "effectiveTime": "datetime",
      "frames": [
        {
          "installmentStartTime": "datetime",
          "installmentEndTime": "datetime",
          "coverageStartTime": "datetime",
          "coverageEndTime": "datetime",
          "installmentDuration": 0,
          "normalizedWeight": 0,
          "coverageDuration": 0,
          "generateTime": "datetime",
          "dueTime": "datetime",
          "autopayTime": "datetime"
        }
      ],
      "reversalLattice": false
    }
  ]
}
```

--------------------------------

### Initialize Python Virtual Environment

Source: https://docs.socotra.com/features/migration

Commands to create and activate a virtual environment for the converter application.

```bash
python3 -m venv .venv     # create a virtual environment
source .venv/bin/activate # activate the environment
```

--------------------------------

### Configuring charges in JSON

Source: https://docs.socotra.com/features/billing/flat-charges

Example configuration showing both normal charges and flat charges with different invoicing behaviors.

```json
"charges": {
    "Premium": {
        "category": "premium"
    },
    "ServiceFee": {
        "category": "fee",
        "handling": "flat",
        "invoicing": "immediate"
    },
    "AdminFee": {
        "category": "fee",
        "handling": "flat",
        "invoicing": "next",
        "transactionBundlingEnabled": true
    }
}
```

--------------------------------

### Billing frame structure

Source: https://docs.socotra.com/getting-started/trigger-billing-pay-and-invoices

An example of a single billing frame object containing installment and coverage period definitions, along with timing for invoice generation and due dates.

```json
// The JSON has been annotated with comments
// for documentation purposes.

// If you intend to use this JSON for any reason,
// remove the comments.
"frames": [
    {
        // When the installment period begins.
        "installmentStartTime": "2024-01-01T00:00:00Z",

        // When the installment period ends.
        "installmentEndTime": "2024-01-31T05:00:00Z",

        // When the coverage period begins.
        "coverageStartTime": "2024-01-01T00:00:00Z",

        // When the coverage period ends.
        "coverageEndTime": "2024-03-06T06:32:44Z",

        // The weight of the frame in comparison to other frames.
        "normalizedWeight": 0.181818181818,

        // The duration of the coverage in the time unit used by the quote.
        // In this case, ~2.17 months
        "coverageDuration": 2.170088112306,

        // The date and time the billing system will generate an invoice.
        "generateTime": "2023-12-17T05:00:00Z",

        // What the due date of the invoice should be when generated.
        "dueTime": "2024-01-01T04:59:59.999Z",

        // The duration of the installment period.
        "installmentDuration": 0.974462365591
    },
```

--------------------------------

### Java: Using ResourceSelector to get a table and lookup a rating factor

Source: https://docs.socotra.com/configuration/resources/versioned-resource-selection

Shows how to obtain a ResourceSelector from a segment locator, fetch a table by static name or via a static property, and perform a lookup. The protocol for multiple terms is still being determined, so this is a provisional example.

```java
// Get the selector...
var theSelector = ResourceSelector.fromSegmentLocator(theSegment.locator);

// and use it to get a table...
var myTable = theSelector.getTable("my_table_static_name");

// or if we can have resource instances defined statically in the development context
// we could do it this way:
var myTable = theSelector.tables
                         .myTableStaticName;

// either way, we can then do lookups:
var someRatingFactor = 100.0 * myTable.lookup("my_key");
```

--------------------------------

### Migration process logs

Source: https://docs.socotra.com/features/migration

Example logs showing a migration process that failed and subsequently triggered the RequestsPatcher.

```bash
2025-07-16 10:20:21.793 [pool-2-thread-1] INFO  c.s.m.c.s.p.RequestsProcessor - Processing file: converted-data.json
2025-07-16 10:20:22.398 [pool-2-thread-1] INFO  c.s.m.c.s.p.RequestsProcessor - Migration[01K09SQ7BBJGFZRXHYYZVSAR66] started for file converted-data.json
2025-07-16 10:20:22.493 [pool-2-thread-1] INFO  c.s.m.c.s.p.RequestsProcessor - Migration[01K09SQ7BBJGFZRXHYYZVSAR66] in progress totalAccounts=1 processedAccounts=1
2025-07-16 10:20:27.592 [pool-2-thread-1] INFO  c.s.m.c.s.p.RequestsProcessor - Migration[01K09SQ7BBJGFZRXHYYZVSAR66] completed with state: failed
2025-07-16 10:20:27.596 [main] INFO  c.s.m.c.s.p.RequestsProcessor - All tasks completed
2025-07-16 10:20:27.597 [main] INFO  c.s.m.c.s.p.RequestsProcessor - Processed 1 files
2025-07-16 10:20:27.597 [main] INFO  c.s.m.c.s.pipeline.MigrationPipeline - Executing step RequestsPatcher
2025-07-16 10:20:27.606 [main] INFO  c.s.m.c.s.patcher.RequestsPatcher - Processing failed migration 01K09SQ7BBJGFZRXHYYZVSAR66 with request file converted-data.json
2025-07-16 10:20:27.751 [main] INFO  c.s.m.c.s.patcher.RequestsPatcher - Saving patch failures for 01K09SQ7BBJGFZRXHYYZVSAR66/01K09SQ7H0M7QCZ1Q02DQ45G10
2025-07-16 10:20:27.763 [main] INFO  c.s.m.c.s.patcher.RequestsPatcher - Saving patch request for 01K09SQ7BBJGFZRXHYYZVSAR66/01K09SQ7H0M7QCZ1Q02DQ45G10
```

--------------------------------

### createTenant

Source: https://docs.socotra.com/configuration/general-topics/configuration-sdk

Creates a deployable config from your socotra-config directory contents and plugin sources, then deploys it to a brand-new tenant, writing the new tenant locator into the socotra-config-developer section in build.gradle.kts. Will fail if there is already a tenantLocator.set statement in socotra-config-developer.

```APIDOC
## createTenant

### Description
Creates a deployable config from your socotra-config directory contents and plugin sources, then deploys it to a brand-new tenant, writing the new tenant locator into the socotra-config-developer section in build.gradle.kts. Will fail if there is already a tenantLocator.set statement in socotra-config-developer.

### Method
Gradle Task

### Task
createTenant

### Usage
Run via Gradle: `./gradlew createTenant`

```

--------------------------------

### Install @socotra/ec-react-schemas

Source: https://docs.socotra.com/ui-sdk/schemas

Install the package along with its peer dependency, zod.

```sh
npm i @socotra/ec-react-schemas zod
```
Tokens:
Raw