This project sends notifications about notable events across the Nova Platform to interested parties. This service consumes events from the Activities producer and becomes aware of notable events
// To be filled.
- Clone the repository anywhere in filesystem.
- Create an
appsettings.dev.jsonfile insrc/Lykke.Snow.Notificationsdirectory. (Please refer to Configuration section.) - Add an environment variable
SettingsUrlwith value ofappsettings.dev.json - Setup firebase service account credentials (please refer to configuration section)
- Corresponding VPN (dev, test) must be activated prior to running the project.
- Run the project.
- MSSQL
- RabbitMQ broker
- Firebase Cloud Messaging.
- Mdm service
Kestrel configuration may be passed through appsettings.json, secrets or environment. All variables and value constraints are default. For instance, to set host URL the following env variable may be set:
{
"Kestrel__EndPoints__Http__Url": "http://*:5010"
}In order to communicate with Firebase servers, a private key for service account is needed. This file should be located in output directory. Please follow the steps here to get this credentials file.
After getting this file and moving it to the output directory, the CredentialsFilePath configuration should be set to point the path in output directory.
"Fcm": {
"CredentialFilePath": "/app/firebase-credentials.json"
}A localization in JSON format file should be provided in order to render notification messages in preferred language. That file can be found at the root directory. (localization.json)
The file has the following format.
{
"Attributes": {
"BUY": {
"en": "Buy",
"es": "Comprar",
"de": "Kauf"
},
"SELL": {
"en": "Sell",
"es": "Vender",
"de": "Verkauf"
}
},
"Titles": {
"AccountLocked": {
"en": "English text for notification title with {0} placeholders {1}.",
"es": "Spanish translation for notificaiton title with {0} placeholders {1}.",
"de": "German translation for notification title with {0} placeholders {1}.",
}
},
"Bodies": {
"AccountLocked": {
"en": "English text for notification body with {0} placeholders {1}.",
"es": "Spanish translation for notificaiton body with {0} placeholders {1}.",
"de": "German translation for notification body with {0} placeholders {1}.",
}
}
}There has to be corresponding object both in Titles and Bodies object for each notification type.
⚠️ Please note that matching engine is case-sensitive! That means notification type names in this file must have exact match with the notification types resides in the following file. And the languages should be put in lowercase format. (i.e.en,es,de)
All notification types can be found at here.
Starting from 34th release, localization files are loaded from Mdm service.
In order to specify the platform key for the file that's been uploaded through Mdm Service, use the LocalizationPlatformKey configuration in the following configuration section.
Localization files are cached in Notification Service for given amount of time. This period is 5 minutes as default, and can be adjusted within the same configuration section.
{
"Localization": {
"LocalizationPlatformKey": "PushNotification",
"LocalizationFileCache": {
"ExpirationPeriod": "00:01:00"
},
"TranslateAttributes": ["BUY", "SELL", "LONG", "SHORT"]
}
}Starting from 34th release, attributes are translated. (e.g. BUY, SELL, STOPLOSS, SHORT).
Please use the Attributes section in localization file to provide translation per language for individual attributes.
To make them eligible for translation, it's required to define them in TranslateAttributes section in appsettings.json. The attributes that's not defined in TranslateAttributes section won't be translated.
Proxy is optional. Being set, it will be used for all FCM outgoing requests.
{
"Proxy": {
"Address": "proxy.lykke.com",
"UserName": "user",
"Password": "password"
}
}Device configurations are cached in memory. The cache is invalidated on any change in the database. Additionally, there is an expiration time for the cache. The default value is 10 minutes but it can be changed in the configuration file.
{
"ConfigurationCache": {
"ExpirationPeriod": "00:01:00"
}
}- Mdm Service
Please specify the base url and api key for Mdm Service within the following configuration section.
{
"MdmServiceClient": {
"ServiceUrl": "",
"ApiKey": ""
}
}- RESTART_ATTEMPTS_NUMBER - number of restart attempts. If not set int.MaxValue is used.
- RESTART_ATTEMPTS_INTERVAL_MS - interval between restarts in milliseconds. If not set 10000 is used.
- SettingsUrl - defines URL of remote settings or path for local settings.
Settings schema is:
{
"APP_UID": "Integer",
"ASPNETCORE_ENVIRONMENT": "String",
"ENVIRONMENT": "String",
"NotificationService": {
"AssetServiceClient": {
"ApiKey": "String",
"ServiceUrl": "String"
},
"ConfigurationCache": {
"ExpirationPeriod": "DateTime"
},
"Cqrs": {
"ConnectionString": "String",
"EnvironmentName": "String",
"RetryDelay": "DateTime"
},
"Db": {
"ConnectionString": "String"
},
"Fcm": {},
"Localization": {
"LocalizationFileCache": {
"ExpirationPeriod": "DateTime"
},
"LocalizationPlatformKey": "String",
"TranslateAttributes": [
"String"
]
},
"MdmServiceClient": {
"ApiKey": "String",
"ServiceUrl": "String"
},
"NotificationServiceClient": {
"ApiKey": "String",
"Url": "String"
},
"Subscribers": {
"MessagePreviewSubscriber": {
"ConnectionString": "String",
"ExchangeName": "String",
"IsDurable": "Boolean",
"QueueName": "String",
"RoutingKey": "String"
}
}
},
"serilog": {
"Enrich": [
"String"
],
"minimumLevel": {
"default": "String"
},
"Properties": {
"Application": "String"
},
"Using": [
"String"
],
"writeTo": [
{
"Args": {
"configure": [
{
"Args": {
"outputTemplate": "String"
},
"Name": "String"
}
]
},
"Name": "String"
}
]
},
"TZ": "String"
}