Template parameters¶
Generated from the architecture model
This page is rendered from model/**/*.yaml by tools/docs_model during mkdocs build. Edit the YAML, not this page; hand-written design lives on the linked service, platform and plane pages.
Every ConnectSoft dotnet new template declares its parameters in .template.config/template.json; the Factory's generation recipe (ADR-0027) passes a value for each of them when it instantiates a template, and the module blueprint carries the result in template.switches. This page is generated from the snapshots under model/template-parameters/, one per template, written read-only from the template repositories by python -I tools/docs_model inventory-templates and validated so that every parameter has a Factory binding.
| Templates with a snapshot | 40 |
| Parameters (all templates) | 1423 |
| Distinct parameter names | 158 |
| Computed and generated symbols | 1659 and 200 |
Shared bindings (_shared.yaml) |
26 |
| Templates inheriting the base template's bindings | 13 |
Binding sources¶
| Source | Meaning | The reference names |
|---|---|---|
blueprint |
The value is read from a field of a person- or agent-authored blueprint | <blueprint id>.<field path> from blueprints |
recipe |
GenerationRecipeService decides it from the model (ports, names, derived choices) | the service and the decision |
adr |
Fixed by an accepted decision; the recipe never asks | the ADR |
environment |
Comes from the target environment at delivery (registry, backends, sinks, addresses) | the owning service and the environment fact |
registry |
Comes from the template registry (template version, artifact kind) | the service and the fact |
operator |
Set by a platform operator | the role |
fixed |
One value for every Factory instantiation, with the reason in the note | — |
unbound |
Left at the template default; the note says why the Factory never sets it | — |
Where a template's parameter has no binding of its own, the binding of the template it inherits from applies (the base family inherits from connectsoft-base), and after that the shared binding of that parameter name. The pages of the templates show the resolved binding per parameter with its origin.
Templates¶
| Template | Short name | Parameters | Computed | Generated | Inherits | Page |
|---|---|---|---|---|---|---|
connectsoft-ai-agent |
connectsoft-ai-agent |
86 | 113 | 11 | connectsoft-base | ConnectSoft.AI.SoftwareFactory.AgentTemplate |
connectsoft-aiskills-library |
connectsoft-aiskills-library |
8 | 0 | 1 | — | ConnectSoft.AISkillsLibraryTemplate |
connectsoft-api-library |
connectsoft-api-library |
7 | 6 | 5 | — | ConnectSoft.ApiLibraryTemplate |
connectsoft-apigateway |
connectsoft-apigateway |
89 | 115 | 12 | connectsoft-base | ConnectSoft.ApiGatewayTemplate |
connectsoft-authorization-server |
connectsoft-authorization-server |
85 | 113 | 12 | connectsoft-base | ConnectSoft.AuthorizationServerTemplate |
connectsoft-base |
connectsoft-base |
86 | 113 | 11 | — | ConnectSoft.BaseTemplate |
connectsoft-blazor-component-library |
connectsoft-blazor-component-library |
6 | 0 | 5 | — | ConnectSoft.Blazor.ComponentLibraryTemplate |
connectsoft-blazor-ecs-shell |
connectsoft-blazor-ecs-shell |
10 | 3 | 0 | — | ConnectSoft.Blazor.ECS.ShellTemplate |
connectsoft-blazor-mfe-aichat |
connectsoft-blazor-mfe-aichat |
4 | 3 | 2 | — | ConnectSoft.Blazor.Mfe.AIChatTemplate |
connectsoft-blazor-mfe-auth-admin |
connectsoft-blazor-mfe-auth-admin |
5 | 3 | 3 | — | ConnectSoft.Blazor.Mfe.AuthorizationServer.AdminTemplate |
connectsoft-blazor-mfe-ecs-admin |
connectsoft-blazor-mfe-ecs-admin |
10 | 3 | 0 | — | ConnectSoft.Blazor.Mfe.ECS.AdminTemplate |
connectsoft-blazor-mfe-ecs-monitoring |
connectsoft-blazor-mfe-ecs-monitoring |
10 | 3 | 0 | — | ConnectSoft.Blazor.Mfe.ECS.MonitoringTemplate |
connectsoft-blazor-mfe-ecs-selfservice |
connectsoft-blazor-mfe-ecs-selfservice |
10 | 3 | 0 | — | ConnectSoft.Blazor.Mfe.ECS.SelfServiceTemplate |
connectsoft-blazor-mfe-identity-admin |
connectsoft-blazor-mfe-identity-admin |
10 | 4 | 0 | — | ConnectSoft.Blazor.Mfe.Identity.AdminTemplate |
connectsoft-blazor-mfe-identity-selfservice |
connectsoft-blazor-mfe-identity-selfservice |
10 | 4 | 0 | — | ConnectSoft.Blazor.Mfe.Identity.SelfServiceTemplate |
connectsoft-blazor-mfe-logistics |
connectsoft-blazor-mfe-logistics |
10 | 3 | 0 | — | ConnectSoft.Blazor.Mfe.Logistics.Template |
connectsoft-blazor-mfe-saas-billing-admin |
connectsoft-blazor-mfe-saas-billing-admin |
10 | 3 | 0 | — | ConnectSoft.Blazor.Mfe.Saas.Billing.AdminTemplate |
connectsoft-blazor-mfe-saas-entitlements-admin |
connectsoft-blazor-mfe-saas-entitlements-admin |
10 | 3 | 0 | — | ConnectSoft.Blazor.Mfe.Saas.Entitlements.AdminTemplate |
connectsoft-blazor-mfe-saas-metering-admin |
connectsoft-blazor-mfe-saas-metering-admin |
10 | 3 | 0 | — | ConnectSoft.Blazor.Mfe.Saas.Metering.AdminTemplate |
connectsoft-blazor-mfe-saas-productscatalog-admin |
connectsoft-blazor-mfe-saas-productscatalog-admin |
10 | 3 | 0 | — | ConnectSoft.Blazor.Mfe.Saas.ProductsCatalog.AdminTemplate |
connectsoft-blazor-mfe-saas-tenants-admin |
connectsoft-blazor-mfe-saas-tenants-admin |
10 | 3 | 0 | — | ConnectSoft.Blazor.Mfe.Saas.Tenants.AdminTemplate |
connectsoft-blazor-mfe |
connectsoft-blazor-mfe |
11 | 3 | 1 | — | ConnectSoft.Blazor.MicrofrontendLibraryTemplate |
connectsoft-blazor-saas-shell |
connectsoft-blazor-saas-shell |
10 | 3 | 0 | — | ConnectSoft.Blazor.Saas.ShellTemplate |
connectsoft-blazor-shell |
connectsoft-blazor-shell |
3 | 0 | 1 | — | ConnectSoft.Blazor.ShellTemplate |
connectsoft-blazor-uikit |
cs-blazor-comp-lib |
9 | 0 | 0 | — | ConnectSoft.Blazor.UIKit |
connectsoft-documentation |
connectsoft-documentation |
4 | 0 | 4 | — | ConnectSoft.DocumentationTemplate |
connectsoft-healthchecks-aggregator |
connectsoft-healthchecks-aggregator |
89 | 119 | 14 | connectsoft-base | ConnectSoft.HealthChecksAggregatorTemplate |
connectsoft-identity |
connectsoft-identity |
85 | 113 | 12 | connectsoft-base | ConnectSoft.IdentityTemplate |
connectsoft-library |
connectsoft-library |
7 | 0 | 5 | — | ConnectSoft.LibraryTemplate |
connectsoft-marketing-site |
connectsoft-marketing-site |
9 | 4 | 0 | — | ConnectSoft.MarketingSiteTemplate |
connectsoft-maui-base |
connectsoft-maui-base |
14 | 0 | 0 | — | ConnectSoft.MauiBaseTemplate |
connectsoft-microservice |
connectsoft-microservice |
86 | 113 | 11 | connectsoft-base | ConnectSoft.MicroserviceTemplate |
connectsoft-microsoft-bot-framework |
connectsoft-microsoft-bot-framework |
85 | 113 | 12 | connectsoft-base | ConnectSoft.MicrosoftBotFrameworkTemplate |
connectsoft-saas-billing |
connectsoft-saas-billing |
85 | 113 | 12 | connectsoft-base | ConnectSoft.Saas.BillingTemplate |
connectsoft-saas-entitlements |
connectsoft-saas-entitlements |
85 | 113 | 12 | connectsoft-base | ConnectSoft.Saas.EntitlementsTemplate |
connectsoft-saas-metering |
connectsoft-saas-metering |
85 | 113 | 12 | connectsoft-base | ConnectSoft.Saas.MeteringTemplate |
connectsoft-saas-productscatalog |
connectsoft-saas-productscatalog |
85 | 113 | 12 | connectsoft-base | ConnectSoft.Saas.ProductsCatalogTemplate |
connectsoft-saas-tenants |
connectsoft-saas-tenants |
85 | 113 | 12 | connectsoft-base | ConnectSoft.Saas.TenantsTemplate |
connectsoft-worker |
connectsoft-worker |
89 | 122 | 18 | connectsoft-base | ConnectSoft.WorkerTemplate |
serviceagent |
serviceagent |
1 | 0 | 0 | — | ConnectSoft.Templates.ServiceAgent |
Parameters by capability¶
One row per parameter name; the Templates column counts the templates that expose it, the Template default column lists the defaults the templates ship (with how many templates share each), and the Factory value column lists the resolved bindings (one line per distinct binding, with the templates it applies to when they differ).
Hosting¶
| Parameter | Templates | Type | Template default | Factory value | Source |
|---|---|---|---|---|---|
ArtifactKind |
14 | choice |
template (1); solution (13) |
solution | fixed The Factory materializes solutions; the template artifact mode is for template authors (ADR-0027). |
Framework |
38 | choice |
net10.0 (37); net9.0 (1) |
net10.0 | ADR-0001 The only choice the base family offers; the backend baseline. |
buildDefinitionNumber |
19 | string |
"" (18); 1.0.0 (1) |
the repository's pipeline definition number | environment: PipelineExecutionService: build definition created for the repository (pipeline blueprint definitionPath) Written after the pipeline exists; empty on the first scaffold. |
HttpPort |
14 | integer |
"" |
the service's http port from model/services | recipe: GenerationRecipeService: port allocation from the service's deployment ports Launch settings only; the container port comes from the deployment profile (ADR-0017). |
HttpsPort |
14 | integer |
"" |
the service's https port from model/services | recipe: GenerationRecipeService: port allocation from the service's deployment ports Launch settings only. |
Docker |
14 | bool |
true |
true | ADR-0017 Every service and product module ships as a container image. |
DockerRegistryServiceConnection |
14 | string |
3d54a89a-9be3-4d16-bccd-c543ce0bb887 |
the environment's registry service connection | environment: RuntimeEnvironmentService: container registry connection of the target environment Never the template default; the connection id is environment state, not a secret value. |
DockerContainerRegistry |
14 | string |
connectsofttestregistry.azurecr.io |
the environment's registry login server | environment: RuntimeEnvironmentService: container registry login server of the target environment |
targetFrameworks |
1 (connectsoft-aiskills-library) |
string |
net8.0;net9.0;net10.0 |
net8.0;net9.0;net10.0 for shared libraries, net10.0 for Factory-only packages | blueprint backend-library.packages[].targets FEAT-183 makes this the one target-framework parameter of both library templates. |
SkipRestore |
1 (connectsoft-aiskills-library) |
bool |
false |
true | fixed The sandbox restores from the Factory feed in its own step with the pinned package versions. |
ApiServiceName |
1 (connectsoft-api-library) |
string |
ExchangeRate |
the owning service's name without the Service suffix (for example RunControl) | blueprint backend-api-library.owningService |
ApiServiceDescription |
1 (connectsoft-api-library) |
string |
Exchange rate |
the owning service's summary | blueprint backend-api-library.owningService |
skipRestore |
21 | bool |
false |
true | fixed The sandbox restores from the Factory feed in its own step with the pinned package versions. |
includeSampleContent |
1 (connectsoft-blazor-component-library) |
bool |
true |
false | fixed Samples are the template author's. |
includeTests |
19 | bool |
true |
true | ADR-0021 Generated code without tests cannot pass the quality gates. |
includeGallery |
1 (connectsoft-blazor-component-library) |
bool |
true |
false | fixed The component gallery is a template-author aid; the Studio and product shells are the consumers. |
includeSamples |
14 | bool |
true |
false | fixed Samples are the template author's; generated products carry their own screens and modules. |
includeDocs |
13 | bool |
true |
false | fixed Documentation comes from the documentation template of the product (FEAT-181, FEAT-182), not from the UI template's pages. |
ShellPort |
1 (connectsoft-blazor-mfe) |
integer |
7000 |
the shell's https port | recipe: GenerationRecipeService: port allocation from the shell's deployment ports |
EnableHttps |
1 (connectsoft-blazor-mfe) |
bool |
true |
true | fixed TLS everywhere, including local shells. |
UseLocalDb |
1 (connectsoft-blazor-mfe) |
bool |
true |
false | fixed Microfrontends hold no database; data comes through the BFF (StudioBffService) or the product gateway. |
IncludeSampleData |
1 (connectsoft-blazor-mfe) |
bool |
true |
false | fixed Sample data is replaced by the product's own seed (blueprint database). |
Company |
1 (connectsoft-blazor-uikit) |
string |
ConnectSoft |
ConnectSoft | fixed The UI kit is a Factory-owned package; products consume it and do not scaffold their own kit. |
LibraryName |
1 (connectsoft-blazor-uikit) |
string |
UIKit |
UIKit | fixed The package name products depend on. |
CompanyName |
1 (connectsoft-marketing-site) |
text |
ConnectSoft |
the tenant's organization name from the vision | blueprint vision.metadata |
ProjectName |
1 (connectsoft-marketing-site) |
text |
MarketingSite |
the product name | blueprint vision.metadata |
includeInfra |
1 (connectsoft-marketing-site) |
bool |
true |
false | fixed Infrastructure comes from the infrastructure blueprint and Pulumi (ADR-0004), not from the template's Bicep files. |
ServiceName |
1 (connectsoft-maui-base) |
string |
"" |
the product name | blueprint mobile.metadata |
RootNamespace |
1 (connectsoft-maui-base) |
string |
"" |
the product's root namespace (empty defaults to ServiceName) | blueprint mobile.metadata |
AppId |
1 (connectsoft-maui-base) |
string |
com.connectsoft.mauiapp |
com. |
blueprint mobile.metadata |
includetest |
1 (serviceagent) |
bool |
true |
template default | unbound The ServiceAgent item template (2021) is a stub with no files; not instantiated by the Factory. |
Domain sample¶
| Parameter | Templates | Type | Template default | Factory value | Source |
|---|---|---|---|---|---|
AggregateRootName |
14 | string |
FactoryAgentAggregateRoot (1); BaseAggregateRoot (12); MicroserviceAggregateRoot (1) |
the first aggregate root of the service (model/services aggregates) | blueprint service.aggregates[].rootEntity One root per scaffold; further aggregates are generated into the solution by the recipe. |
AggregateRootObjectId |
14 | string |
ObjectId |
the identity field of the first aggregate root | blueprint service.aggregates[].identity |
FeatureAName |
14 | string |
FeatureA |
the first feature of the service blueprint | blueprint service.features[].name |
FeatureADescription |
14 | string |
FeatureADescription |
the first feature's description from the vision feature it realizes | blueprint service.features[].name |
FeatureAUseCaseAName |
14 | string |
FeatureAUseCaseA |
the first command or query of the first feature | blueprint service.apis[].operation |
FeatureAUseCaseADescription |
14 | string |
FeatureAUseCaseA's description |
the operation summary | blueprint service.apis[].operation |
FeatureAUseCaseBName |
14 | string |
FeatureAUseCaseB |
the second operation of the first feature | blueprint service.apis[].operation |
FeatureAUseCaseBDescription |
14 | string |
FeatureAUseCaseB's description |
the operation summary | blueprint service.apis[].operation |
FeatureBName |
14 | string |
FeatureB |
the second feature of the service blueprint; the sample is removed when the blueprint has one feature | blueprint service.features[].name |
FeatureBDescription |
14 | string |
FeatureBDescription |
the second feature's description | blueprint service.features[].name |
FeatureBUseCaseAName |
14 | string |
FeatureBUseCaseA |
the first operation of the second feature | blueprint service.apis[].operation |
FeatureBUseCaseADescription |
14 | string |
FeatureBUseCaseA's description |
the operation summary | blueprint service.apis[].operation |
FeatureBUseCaseBName |
14 | string |
FeatureBUseCaseB |
the second operation of the second feature | blueprint service.apis[].operation |
FeatureBUseCaseBDescription |
14 | string |
FeatureBUseCaseB's description |
the operation summary | blueprint service.apis[].operation |
ActorAName |
14 | string |
BankAccountActor |
the aggregate root that is modelled as a grain (for example RunActor) | blueprint service.aggregates[].rootEntity |
ActorADescription |
14 | string |
Bank account actor |
the aggregate summary | blueprint service.aggregates[].rootEntity |
ActorAOperationAName |
14 | string |
Withdraw |
the first command of that aggregate | blueprint service.apis[].operation |
ActorAOperationADescription |
14 | string |
Withdraw the given amount from the bank account |
the operation summary | blueprint service.apis[].operation |
Observability¶
| Parameter | Templates | Type | Template default | Factory value | Source |
|---|---|---|---|---|---|
Logging |
14 | choice |
Serilog |
Serilog | fixed The observability libraries the Factory extends are the Serilog ones (cmp-observability, FEAT-175); Log4Net is not used. |
UseApplicationInsights |
14 | bool |
false |
false | fixed Telemetry leaves through the OpenTelemetry collector (ADR-0018); Application Insights is one exporter of the collector, not an SDK in the service. |
OpenTelemetry |
14 | bool |
true |
true | ADR-0018 |
ObservabilityStack |
14 | choice |
OtelCollector |
OtelCollector | ADR-0018 Direct export is for local runs only. |
ObservabilityBackend |
14 | choice |
PrometheusGrafana |
the environment's backend (AzureMonitor in the hosted estate) | environment: RuntimeEnvironmentService: observability backend of the target environment Choice applies only with OtelCollector. |
ResourceMonitoring |
14 | bool |
true |
true | ADR-0018 |
HealthCheck |
14 | bool |
true |
true | ADR-0018 Liveness and readiness probes are part of the NFR baseline; the readiness bundle rides on them (ADR-0014). |
HealthCheckPath |
14 | string |
/health |
/health | ADR-0018 |
HealthCheckPublisher |
14 | choice |
Seq |
Seq for local, ApplicationInsights where Azure Monitor is the backend | environment: RuntimeEnvironmentService: health publisher of the target environment |
HealthCheckUI |
14 | bool |
true |
false | fixed The fleet health aggregator owns the health UI (FEAT-173, cmp-healthchecks); a per-service UI is not generated. |
HealthCheckUIPath |
14 | string |
health-ui |
template default | unbound Only read when HealthCheckUI is true, which the Factory never sets. |
HealthCheckUIStorageProvider |
14 | choice |
InMemory (13); SqlServer (1) |
template default | unbound Only read when HealthCheckUI is true, which the Factory never sets. |
useLogging |
1 (connectsoft-aiskills-library) |
bool |
true |
true | ADR-0018 |
useMetrics |
1 (connectsoft-aiskills-library) |
bool |
true |
true | ADR-0018 On the Factory meter conventions (FEAT-175). |
UseMetrics |
2 (connectsoft-api-library, connectsoft-library) |
bool |
true |
true | ADR-0018 On the Factory meter conventions (FEAT-175). |
ApiAnalytics |
1 (connectsoft-apigateway) |
bool |
true |
true | ADR-0018 Business-event meter on top of the HTTP metrics; inactive without OpenTelemetry. |
UseObservability |
14 | bool |
true |
true | ADR-0018 |
UseLogging |
1 (connectsoft-library) |
bool |
true |
true | ADR-0018 |
UseActivitySource |
1 (connectsoft-library) |
bool |
false |
true | ADR-0018 Activity source per package on the Factory naming (FEAT-183); the template default is false. |
Configuration¶
| Parameter | Templates | Type | Template default | Factory value | Source |
|---|---|---|---|---|---|
DistributedCache |
14 | choice |
None (13); Redis (1) |
Redis when the service has a cache or lease store in model/stores.yaml, else None | blueprint module.persistence.storeClass Store class decides; a Redis store exists for leases and read models. |
FeatureFlags |
14 | bool |
true |
true | fixed Flags are read through the Config Platform (cmp-config-platform, develop); the Microsoft.FeatureManagement surface stays. |
FeatureFlagsProvider |
14 | choice |
AppSettings |
AppSettings until the Config Platform provider exists; AzureAppConfiguration in the hosted estate | recipe: GenerationRecipeService: flag provider until the Config Platform ships Revisit when cmp-config-platform is delivered. |
AdditionalConfigurationProvider |
14 | choice |
None |
AzureAppConfiguration in the hosted estate, None locally | environment: RuntimeEnvironmentService: configuration provider of the target environment |
useOptions |
1 (connectsoft-aiskills-library) |
bool |
true |
true when the library blueprint declares options sections | blueprint backend-library.publicSurface.optionsSections |
UseValidatedOptions |
13 | bool |
true |
true | fixed Options validated at startup (ADR-0018 fail-fast); every Factory shell keeps it. |
UseOptions |
1 (connectsoft-library) |
bool |
true |
true when the library blueprint declares options sections | blueprint backend-library.publicSurface.optionsSections |
Audit compliance¶
| Parameter | Templates | Type | Template default | Factory value | Source |
|---|---|---|---|---|---|
UseAuditNet |
14 | bool |
true (13); false (1) |
true | ADR-0019 Audit evidence through the Audit.NET integration with the Factory evidence record (FEAT-176). |
Persistence¶
| Parameter | Templates | Type | Template default | Factory value | Source |
|---|---|---|---|---|---|
PersistenceModelType |
14 | choice |
NHibernate (11); None (3) |
NHibernate for relational stores (ADR-0006), MongoDb for document stores, None for stateless gateways | blueprint module.persistence.storeClass The store profile in model/stores.yaml names the engine. |
ObjectMappingType |
14 | choice |
ConnectSoft |
ConnectSoft | fixed The house object mapper; AutoMapper is not crossed into its licensed major. |
NHibernateDialectType |
14 | choice |
SqlServer |
SqlServer for azure-sql stores, PostgreSQL where the store profile says so | blueprint module.persistence.storeClass |
DapperDialectType |
3 | choice |
SqlServer |
template default | unbound Dapper is not a Factory persistence choice; only the base and microservice templates still offer it. |
NHibernateSecondLevelCacheType |
14 | choice |
None |
None | fixed No second-level cache; read models are served from their own stores. |
DatabaseName |
14 | string |
MicroserviceDatabase |
the store id of model/stores.yaml in Pascal case (for example AgentRegistrySql) | recipe: GenerationRecipeService: database name from the service's store id |
Migrations |
14 | bool |
true (11); false (3) |
true | ADR-0006 Schema is owned by the service and applied by migrations; no shared migration runner. |
UseOfflineSupport |
1 (connectsoft-maui-base) |
bool |
true |
true when any screen declares read-cache or queue-writes | blueprint mobile.screens[].offline |
Actors¶
| Parameter | Templates | Type | Template default | Factory value | Source |
|---|---|---|---|---|---|
ActorModelType |
14 | choice |
Orleans (11); None (3) |
Orleans for every stateful service and agent host; None for gateways | ADR-0024 The durable execution substrate. |
OrleansGrainPersistence |
14 | choice |
AdoNet |
AdoNet | ADR-0024 Grain state and journals in the service's relational store. |
Service model¶
| Parameter | Templates | Type | Template default | Factory value | Source |
|---|---|---|---|---|---|
ServiceModelType |
14 | choice |
Grpc (12); RestApi (1); None (1) |
Grpc for services whose endpoints are internal gRPC, RestApi where the service publishes REST through its gateway | blueprint service.apis[].kind model/services separates apis.rest and apis.grpc; a service with both gets RestApi and the gRPC project added by the recipe. |
SignalRBackplane |
14 | choice |
None |
None | fixed Only the Studio realtime gateway uses SignalR and takes Redis there (StudioRealtimeGatewayService). |
CORS |
14 | bool |
true |
false | fixed Browsers reach services only through a gateway, which owns CORS (ADR-0028 gateways). |
Swagger |
14 | bool |
true |
true | fixed The OpenAPI document is the source of the generated clients (FEAT-180) and the documentation API reference (FEAT-181). |
Scalar |
14 | bool |
true |
true | fixed Interactive API documentation beside the OpenAPI document. |
RateLimiting |
14 | bool |
true |
false | fixed Rate limiting is applied at the platform gateway per rate-limit class; services keep request timeouts. |
UseQueryModel |
14 | bool |
true |
true when the service has list queries | blueprint service.apis[].kind Filter, sort and paging conventions for list endpoints. |
RequestTimeout |
14 | bool |
true |
true | ADR-0018 |
Compression |
14 | bool |
true |
true | fixed Response compression stays on; the gateway does not re-compress. |
UseServiceDiscovery |
1 (connectsoft-api-library) |
bool |
false |
true for in-cluster clients of Factory services, false for clients published to users (they take a base address) | blueprint backend-api-library.contract.ref |
ApiVersioning |
1 (connectsoft-apigateway) |
bool |
true |
true | fixed Platform gateways version routes by URL path. |
RequestResponseTransformation |
1 (connectsoft-apigateway) |
bool |
true |
true where a route rewrites paths or headers, else false | blueprint api-gateway.routes[].path |
UseApiIntegration |
1 (connectsoft-maui-base) |
bool |
true |
true | fixed Every mobile app talks to its product gateway through a generated client (backend-api-library). |
ApiBaseUrl |
1 (connectsoft-maui-base) |
string |
https://localhost:5001 |
the environment's gateway address; the localhost default only for the Development overlay | environment: RuntimeEnvironmentService: public address of the product gateway in the target environment |
Identity¶
| Parameter | Templates | Type | Template default | Factory value | Source |
|---|---|---|---|---|---|
UseIdentityPlatform |
14 | bool |
true |
true | ADR-0015 The trusted scope chain (FEAT-089) rides on the Identity Platform integration. |
AuthenticationType |
1 (connectsoft-api-library) |
choice |
None |
OAuth today; the JWT bearer layout with workload-token acquisition once FEAT-180 adds it | fixed Clients of the three Factory gateways present a workload token (FEAT-162 token contract). |
Authentication |
1 (connectsoft-apigateway) |
bool |
true |
true | blueprint api-gateway.auth.tokenValidation JWT bearer validation against the sole issuer (canonical ADR-0101) for every gateway. |
UseSecurity |
13 | bool |
true |
true | fixed Web security headers, rate limiting and request timeouts in the shell; the shell owns frontend auth (ADR-0101). |
ProbeAuth |
1 (connectsoft-healthchecks-aggregator) |
choice |
None |
ConfigHeaders | fixed Probe auth profiles hold references to the secret broker, never values (SecretBrokerService). |
UseAuthentication |
1 (connectsoft-maui-base) |
bool |
true |
true when a capability goes via identity | blueprint mobile.capabilities[].via |
UseBiometricAuth |
1 (connectsoft-maui-base) |
bool |
true |
true when a biometric capability is listed | blueprint mobile.capabilities[].name |
AuthenticationProvider |
1 (connectsoft-maui-base) |
choice |
AzureAd |
Oidc | ADR-0008 The sole issuer is the OpenIddict authorization server; Azure AD is not the product's issuer. |
Messaging¶
| Parameter | Templates | Type | Template default | Factory value | Source |
|---|---|---|---|---|---|
MessagingModelType |
14 | choice |
None (5); MassTransit (9) |
None for Factory services until the Orleans messaging profile joins the choices (FEAT-157); MassTransit for product modules on a bus transport | ADR-0012 The Factory's own transport is the Orleans outbox and inbox; the template offers only NServiceBus and MassTransit today. |
NServiceBusEndpointName |
14 | string |
SampleEndpoint |
template default | unbound NServiceBus is not a Factory transport (ADR-0012). |
NServiceBusPersistence |
14 | choice |
SQL |
template default | unbound NServiceBus is not a Factory transport (ADR-0012). |
NServiceBusTransport |
14 | choice |
SqlServer |
template default | unbound NServiceBus is not a Factory transport (ADR-0012). |
NServiceBusDatabaseName |
14 | string |
NserviceBusMicroserviceDatabase |
template default | unbound NServiceBus is not a Factory transport (ADR-0012). |
MassTransitPersistence |
14 | choice |
NHibernate (13); MongoDB (1) |
NHibernate (sagas in the module's relational store) when MassTransit is selected | blueprint module.persistence.storeClass |
MassTransitTransport |
14 | choice |
RabbitMQ |
AzureServiceBus for product modules; RabbitMQ for local runs | ADR-0003 Transport profile of the product (ADR-0012). |
Scheduling¶
| Parameter | Templates | Type | Template default | Factory value | Source |
|---|---|---|---|---|---|
SchedulerModelType |
14 | choice |
None (7); HangFire (7) |
None | ADR-0024 Timers and reminders come from Orleans; Hangfire and Quartz are not generated. |
Ai¶
| Parameter | Templates | Type | Template default | Factory value | Source |
|---|---|---|---|---|---|
EnableMicrosoftExtensionsAI |
14 | bool |
true (4); false (10) |
true for agent hosts (agent-microservice blueprint), false for every other service | blueprint agent-microservice.framework |
EnableMicrosoftExtensionsAIEvaluation |
14 | bool |
false |
false | fixed Evaluation runs in the quality gates (ADR-0021), not inside the generated service. |
MicrosoftExtensionsAIServiceProvider |
14 | choice |
OpenAI |
AzureOpenAI as the compile-time provider; model access goes through the Factory's model router at run time (FEAT-15x factory access, ModelRouterService) | fixed The template needs one provider package; the router replaces the direct client. |
MicrosoftExtensionsAIEmbeddingProvider |
14 | choice |
None |
None | fixed Embeddings are produced through the model router, not a direct provider. |
UseVectorStore |
14 | bool |
false |
true for the knowledge services (VectorMemoryService, KnowledgeIngestionService, ContextBuilderService), false elsewhere | blueprint agent-microservice.framework |
VectorStoreProviderType |
14 | choice |
InMemory |
Qdrant | ADR-0005 Vector store profiles in ADR-0013; InMemory for tests. |
UseMCP |
14 | bool |
false |
true for agent hosts and tool services; false elsewhere | ADR-0022 |
UseMicrosoftAgentFramework |
14 | bool |
true (4); false (10) |
true for agent hosts (agent-microservice blueprint), false elsewhere | ADR-0002 |
EnableMicrosoftAgentFrameworkWorkflows |
14 | bool |
false |
false | fixed Workflow execution is the Factory's own engine on Orleans (ADR-0024), not Agent Framework Workflows. |
EnableSemanticKernelAzureAISearchConnector |
14 | bool |
false |
false | ADR-0002 Semantic Kernel connectors are not used. |
EnableSemanticKernelSqlServerConnector |
14 | bool |
false |
false | ADR-0002 Semantic Kernel connectors are not used. |
EnableVectorIngestion |
14 | bool |
false |
true for KnowledgeIngestionService only | fixed Ingestion is one service's job (BC knowledge); other services receive citations from ContextBuilderService. |
IngestionChunkerType |
14 | choice |
Token |
Markdown for KnowledgeIngestionService | fixed Repository and documentation content is Markdown-heavy; Token chunking for code is a knowledge-source setting, not a template switch. |
UseVectorIngestionHost |
14 | bool |
false |
false | fixed Ingestion runs as Orleans work (ADR-0024), not a hosted service. |
UseAgentFrameworkRag |
14 | bool |
false |
false | fixed Retrieval is assembled by ContextBuilderService with scope and citations, not by a template-wired TextSearchProvider. |
UseAgentSkills |
14 | bool |
false |
false | fixed Skills come from published releases (AgentRegistryService, FEAT-184 packages), not from SKILL.md samples in the host. |
Library¶
| Parameter | Templates | Type | Template default | Factory value | Source |
|---|---|---|---|---|---|
useDI |
1 (connectsoft-aiskills-library) |
bool |
true |
true | fixed Every Factory library registers through an AddX extension. |
UseDI |
1 (connectsoft-library) |
bool |
true |
true | fixed Every Factory library registers through an AddX extension (blueprint backend-library publicSurface.registrationApi). |
Ui¶
| Parameter | Templates | Type | Template default | Factory value | Source |
|---|---|---|---|---|---|
uiKitAdapter |
16 | choice |
Flowbite |
Tokens for the Factory Studio and generated products (FEAT-168 UI kit tokens); Flowbite or DaisyUI only when the frontend blueprint names them | blueprint frontend.shell.theme The shell theme names the adapter. |
UseLocalization |
14 | bool |
true |
true when the frontend blueprint lists more than one locale, else false | blueprint frontend.locales |
theme |
1 (connectsoft-blazor-mfe) |
choice |
Light |
Light; the user's preference is a shell setting at run time | blueprint frontend.shell.theme |
density |
1 (connectsoft-blazor-mfe) |
choice |
Default |
Default | blueprint frontend.shell.theme |
enableRTL |
1 (connectsoft-blazor-mfe) |
bool |
false |
true when the frontend blueprint lists an RTL locale (Hebrew in the reference consumer), else false | blueprint frontend.rtlLocales |
UseAdapters |
1 (connectsoft-blazor-uikit) |
bool |
true |
true | fixed The Tailwind adapter carries the tokens. |
UseTailwind |
1 (connectsoft-blazor-uikit) |
bool |
true |
true | fixed Tokens are expressed through the Tailwind adapter (FEAT-168). |
UseDaisyUI |
1 (connectsoft-blazor-uikit) |
bool |
true |
false | fixed Not used by the Studio compositions. |
UseFlowbite |
1 (connectsoft-blazor-uikit) |
bool |
true |
false | fixed Not used by the Studio compositions. |
DefaultLanguage |
1 (connectsoft-marketing-site) |
choice |
en |
the first locale of the localization blueprint (en or he) | blueprint localization.metadata |
Documentation¶
| Parameter | Templates | Type | Template default | Factory value | Source |
|---|---|---|---|---|---|
siteTitle |
1 (connectsoft-documentation) |
string |
ConnectSoft Docs |
the product or service name from the blueprint metadata | blueprint documentation.metadata |
siteDescription |
1 (connectsoft-documentation) |
string |
Comprehensive documentation for the ConnectSoft Docs |
the blueprint description | blueprint documentation.metadata |
repoUrl |
1 (connectsoft-documentation) |
string |
https://dev.azure.com/dmitrykhaymov/ConnectSoft/_git/ConnectSoft.Documentation |
the repository created for the service or product | environment: ProjectService: repository URL of the project's repository Project bootstrap creates the repository before the site is scaffolded. |
Mobile¶
| Parameter | Templates | Type | Template default | Factory value | Source |
|---|---|---|---|---|---|
UsePushNotifications |
1 (connectsoft-maui-base) |
bool |
true |
true when a push capability is listed | blueprint mobile.capabilities[].name |
Marketing¶
| Parameter | Templates | Type | Template default | Factory value | Source |
|---|---|---|---|---|---|
EnableAnalytics |
1 (connectsoft-marketing-site) |
choice |
true |
true only when the integration blueprint names an analytics connector; otherwise false | blueprint integration.metadata Analytics without a connector is dead configuration. |
EnableCookieConsent |
1 (connectsoft-marketing-site) |
choice |
true |
true | fixed Consent on by default; the most privacy-preserving option. |
PagePack |
1 (connectsoft-marketing-site) |
choice |
full |
standard; growth or full when the vision names those pages | blueprint vision.metadata My default; the owner may prefer minimal for first products. |
Worker¶
| Parameter | Templates | Type | Template default | Factory value | Source |
|---|---|---|---|---|---|
Trigger |
1 (connectsoft-worker) |
choice |
Bus |
Timer today; the Orleans trigger profile once FEAT-171 adds it | ADR-0012 Bus means MassTransit or NServiceBus, which are not the Factory transport. |
EnableAdmin |
1 (connectsoft-worker) |
bool |
false |
true | fixed /ops and /api/admin/* behind WorkerOps as a Factory operator role (FEAT-171). |
Idempotency |
1 (connectsoft-worker) |
choice |
None |
Sql | fixed ProcessedMessages in the worker's own relational store; Redis only for leases. |
FailureSinks |
1 (connectsoft-worker) |
choice |
Logs |
Logs+EventGrid; failed work also leaves as Factory events (FEAT-171) | environment: RuntimeEnvironmentService: failure sinks of the target environment |
Health¶
| Parameter | Templates | Type | Template default | Factory value | Source |
|---|---|---|---|---|---|
Discovery |
1 (connectsoft-healthchecks-aggregator) |
choice |
Static |
ServiceDiscovery; targets come from the environment inventory (FEAT-173) | recipe: GenerationRecipeService: fleet discovery mode Static URLs are for a single fixed estate. |
EnableRegistry |
1 (connectsoft-healthchecks-aggregator) |
bool |
false |
true | fixed The ops-only target registry under HealthAggregatorOps is the Factory's registry of fleet targets (FEAT-173). |
AlertSinks |
1 (connectsoft-healthchecks-aggregator) |
choice |
Webhooks |
Webhooks+EventGrid; incidents also leave as Factory events (FEAT-173) | environment: RuntimeEnvironmentService: incident sinks of the target environment |
How a value reaches the generated code¶
flowchart LR
BP["Blueprints<br/>(service, module, frontend, library ...)"] --> GR["GenerationRecipeService<br/>resolves every parameter"]
ADR["Accepted ADRs<br/>(fixed values)"] --> GR
ENV["RuntimeEnvironmentService<br/>PipelineExecutionService"] --> GR
TR["TemplateRegistryService<br/>template version, symbol catalog"] --> GR
GR --> SW["module.template.switches<br/>(recorded in the module blueprint)"]
SW --> DN["dotnet new <short name> --param value ...<br/>in the sandbox"]
DN --> CS["Computed symbols decide the code paths<br/>and the files the sources keep"]
CS --> OUT["Generated solution, built and tested<br/>(quality gates, ADR-0021)"]