Configuration
This page covers settings shared by the integration regardless of the selected maintenance-system provider. Provider-specific connection and data-model settings are documented under Providers.
Integration settings
Configure these values under MaintenanceSystemIntegration:
| Setting | Validation and default | Purpose |
|---|---|---|
Provider |
Required | Selects the maintenance-system provider. |
Otb:BaseUri |
Required absolute URI | OT Backup API base URI. |
Otb:ApiKey |
Required | OT Backup API key. |
Otb:TimeoutSeconds |
Default 100 |
OT Backup HTTP timeout in seconds. |
SynchronizationIntervalMinutes |
Positive; default 60 |
Delay between synchronization runs. |
AlertIntervalMinutes |
Positive; default 1 |
Delay between alert runs. |
AlertEventBatchSize |
Positive; default 10 |
Maximum alerts claimed per run. |
AdoptOtbEquipmentByName |
Default false |
Enables exact-name adoption when ExternalId is not matched. |
SynchronizationSafety:RequireNonEmptySource |
Default true |
Skips cleanup when a successful source read is empty. |
FieldMappings |
Default empty array | Mappings applied during synchronization. |
OT Backup UI links
Links from maintenance-system records back to the OT Backup UI use the shared
CommonConfig:ServerConfig settings. These settings are not part of
MaintenanceSystemIntegration.
| Setting | Purpose |
|---|---|
UiAddress |
Host name used in OT Backup UI links. |
UiPortHttps |
HTTPS port used in OT Backup UI links. |
For example:
{
"CommonConfig": {
"ServerConfig": {
"UiAddress": "otbackup.example",
"UiPortHttps": 443
}
}
}
Generated links use HTTPS. Provider features that support links, such as the
Maximo {JobDetailsUri} template token, use these shared values rather than a
provider-specific URI setting.
Example
Put environment-specific values and secrets in a protected override file.
{
"MaintenanceSystemIntegration": {
"Provider": "<provider>",
"SynchronizationIntervalMinutes": 60,
"AlertIntervalMinutes": 1,
"AlertEventBatchSize": 10,
"AdoptOtbEquipmentByName": false,
"SynchronizationSafety": {
"RequireNonEmptySource": true
},
"Otb": {
"BaseUri": "https://otbackup.example/api/",
"ApiKey": "<OT Backup API key>",
"TimeoutSeconds": 100
},
"Providers": {
"<provider>": {}
},
"FieldMappings": []
}
}