Seeding configurations

Basics

The table ServiceTenantConfiguration contains configuration per service in the form of a string with JSON. The configurations database is multi-tenant, meaning it can contain configuration for many tenants.

Start by declaring the tenant:

DECLARE @Organization NVARCHAR(255) = 'acme'
DECLARE @Environment NVARCHAR(255) = '$(Environment)'

Variables

Configuration is very similiar across environments, so working with variables in the sql script is a way to reduce the number of files needed in the repository. In these examples we use the Azure Devops syntax for variables, $(VariableName).

Automation

One way to use continous integration for the seeding is like in this guide: Continuous integration for database seeding

Table ServiceTenantConfiguration

The main table to care about is ServiceTenantConfiguration, which contains configuration for each service:

INSERT INTO ServiceTenantConfiguration(Organization, Environment, Service, Configuration)
VALUES (@Organization, @Environment, '<service name>', '{
    <json>
}')

You can use this table for both Nexus services and your own services.

Configure Nexus services

Fundamentals

INSERT INTO ServiceTenantConfiguration(Organization, Environment, Service, Configuration)
VALUES (@Organization, @Environment, 'fundamentals', '{
    "AuthenticationConnectionString": "$(AuthenticationConnectionString)",
    "LoggerConnectionString": "$(StorageConnectionString)",
    "QueueName": "$(LoggerQueueName)"
}')

Async Caller < version 1.4

INSERT INTO ServiceTenantConfiguration(Organization, Environment, Service, Configuration)
VALUES (@Organization, @Environment, 'asynccaller', '{
    "SchemaVersion": 0,
    "ConnectionString": "$(StorageConnectionString)",
    "QueueName": "$(AsyncCallerQueueName)",
    "DefaultDeadlineTimeSpanInSeconds": 3600
}')

Read more here: Async Caller Setup prior to version 1.4.

Async Caller ≥ version 1.4

(This feature is planned for version 1.4.0 of Nexus Async Caller, see Release plan.)

INSERT INTO ServiceTenantConfiguration(Organization, Environment, Service, Configuration)
VALUES (@Organization, @Environment, 'asynccaller', '{
    "SchemaVersion": 1,
    "ConnectionString": "$(StorageConnectionString)",
    "DefaultDeadlineTimeSpanInSeconds": 3600,
    
    "Authentication": {
        "Methods": [
            {
                "Id": "nexus",
                "AuthorizationType": "JwtFromUrl",
                "PostUrl": "https://...fundamentals.../api/v2/Organizations/$(organization)}/Environments/$(environment)/Tokens",
                "PostBody": "{ ''ClientId'': ''async-manager'', ''ClientSecret'': ''heimlichkeit'' }",
                "ResponseTokenJsonPath": "AccessToken"
            }
        ],
       "Originators": [
           {
               "Name": "businessevents",
               "AuthenticationMethod": "nexus",
               "TokenUrl": "https://...businessevents.../api/v2/Organizations/$(organization)}/Environments/$(environment)/Tokens/Refresh"
           }
       ]
    }
}')

Read more here: Async Caller Setup version 1.4 and onwards.

Business Events

INSERT INTO ServiceTenantConfiguration(Organization, Environment, Service, Configuration)
VALUES (@Organization, @Environment, 'businessevents', '{
    "ConnectionString": "$(BusinessEventsConnectionString)",
    "VerifyPublications": true,
    "PublicationIdAtCallback": "$(PublicationIdAtCallback)",
    "Clients": [
        {
            "Name": "client-a",
            "Authentication": "standard-authentication"
        },
        {
            "Name": "client-b",
            "Authentication": "client-b-authentication",
            "RequestHeaders": { 
                "header-a": "value-a"
            }
        },
        {
            "Name": "client-c",
            "RequestHeaders": { 
                "Authorization": "some-custom-auth-mechanism"
            }
        }     
    ],
    "Authentications": [
        {
            "Id": "standard-authentication",
            "AuthorizationType": "JwtFromUrl",
            "PostUrl": "' + @IntegrationTestsUrl + '/api/v1/' + @Organization + '/' + @Environment + '/Authentication/Tokens",
            "PostBody": "{ ''ClientId'': ''acme-api'', ''ClientSecret'': ''$(AcmeClientPassword)'' }",
            "ResponseTokenJsonPath": "AccessToken"
        },
        {
            "Id": "client-b-authentication",
            "AuthorizationType": "Basic",
            "Username": "$(BEBasicAuthUsername)",
            "Password": "$(BEBasicAuthPassword"
        }
    }
}')

Value translator

INSERT INTO ServiceTenantConfiguration(Organization, Environment, Service, Configuration)
VALUES (@Organization, @Environment, 'keytranslator', '{
    "ConnectionString": "$(KeyTranslatorConnectionString)"
}')

Data Sync engine (Match)

INSERT INTO ServiceTenantConfiguration(Organization, Environment, Service, Configuration)
VALUES (@Organization, @Environment, 'match', '{
    "ConnectionString": "$(MatchConnectionString)",
    "QueueName": "$(AsyncCallerQueueName)",
    "DefaultDeadlineTimeSpanInSeconds": 3600
}')

Async Manager

INSERT INTO ServiceTenantConfiguration(Organization, Environment, Service, Configuration)
VALUES (@Organization, @Environment, 'asyncmanager', '{
    "AzureStorageConnectionString": "$(StorageConnectionString)",
    "DatabaseConnectionString": "$(AsyncManagerConnectionString)",
    "PendingQueueName": "pending-request-queue",
    "QueueNamePrefix": "am-request-queue",
    "PriorityLevels": 1, -- You should probably have at least 3 levels
    "DefaultRequestLifetimeInMinutes": 10080,
    "AzureStoragePendingContainerName": "pending-request",
    "AzureStorageRequestContainerName": "request-payload",
    "AzureStorageResponseContainerName": "response-payload",
    "ExponentialBackOffFactorInMinutes": 5.0,
    "BackOffFirstTimeInSeconds": 15.0,
    "PostponeTimeTriggerInMinutes": 60,
    "TimeBetweenRequestCompletedAndPurgeInDays": 30,
    "PurgeReadBatchSize": 10000,
    "PurgeCommitBatchSize": 500,
    "SaveRequestPayloadInDb": false, -- true is more convenient but less secure
    "SaveResponsePayloadInDb": false, -- true is more convenient but less secure
    "SavePayloadsInDb": false, -- true is more convenient but less secure
    "SavePayloadsInStorage": true,
    "EnqueueBatchSize": 100,
    "LimitForEnqueueInsteadOfSleepInSeconds": 300.0,
    "LimboTimeLimitInSeconds": 600.0,
    "LimitForDeletingCompletedActiveRequestRecordsInDays": 1.0,
    "TimeLimitForGetResponseInSeconds": 1.0,
    
    "Authentication": {
        "TokenUrl": "https://api.acme.com/Tokens/Refresh",
        "Method": {
            "AuthorizationType": "JwtFromUrl",
            "PostUrl": "https://api.acme.com/Tokens",
            "PostBody": "{ ''ClientId'': ''async-manager'', ''ClientSecret'': ''heimlichkeit'' }",
            "ResponseTokenJsonPath": "Content.AccessToken"
       }
    }
}')

Default values are shown in the SQL script above.