Stevan/sanctions-search
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: finish README.md

Browse Source
This commit is contained in:
Stevan Freeborn
2024-09-05 15:30:43 -05:00
parent 657679a597
commit 79764a484f
1 changed files with 50 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+50 -3
View File
@@ -1,7 +1,5 @@
# Sanctions Search
⚠️ **Under Construction** ⚠️
SanctionsSearch is an automated solution to perform sanctions search in Onspring against the Office of Foreign Assets Control (OFAC) SDN list. The app runs as a worker service that hosts two separate worker processes. The first worker process is responsible for fetching the latest SDN list from the OFAC website and updating a local database with the latest information. The second worker process is responsible for performing sanctions search against the local database using search criteria provided by Onspring and returning the search results to Onspring.
## Technologies
@@ -20,7 +18,26 @@ SanctionsSearch is an automated solution to perform sanctions search in Onspring
## Onspring Configuration
TODO: Add Onspring configuration instructions.
This app is only useful if you have access to an Onspring instance and have configured the necessary apps and fields to work with it. In Onspring you should have two apps, one for Search Request and one for Search Result. The Search Request app acts as a queue for search requests that need to be processed. The Search Result app stores individual search results for each search request. The search results will be related back to the search request that generated them using a reference field.
The Search Request app should have the following fields:
- Name (Text)
- Status (Single Select List)
- It should have the following values:
- A value indicating the request is awaiting processing.
- A value indicating the request is processing.
- A value indicating the request was processed successfully.
- A value indicating the request was processed with an error.
- Error (Text)
The Search Result app should have the following fields:
- Search Request (Reference)
- Name (Text)
- Address (Text)
- Type (Single Select List)
- Programs (Multi Select List)
## SanctionsSearch Configuration
@@ -29,19 +46,33 @@ The app handles configuration using environment variables or a `.env` file if ru
- `OnspringOptions__ApiKey`
- The API key for the Onspring API. Note this key needs to have all the necessary permissions to create, read, and update records in the Search Request and Search Result apps.
- `OnspringOptions__SearchRequestOptions__AppId`
- The app ID for the Search Request app in Onspring.
- `OnspringOptions__SearchRequestOptions__NameFieldId`
- The field ID for the Name field in the Search Request app in Onspring.
- `OnspringOptions__SearchRequestOptions__StatusFieldId`
- The field ID for the Status field in the Search Request app in Onspring.
- `OnspringOptions__SearchRequestOptions__AwaitingProcessingStatusId`
- The list value ID for the awaiting processing value for the Status field in the Search Request app in Onspring.
- `OnspringOptions__SearchRequestOptions__ProcessingStatusId`
- The list value ID for the processing value for the Status field in the Search Request app in Onspring.
- `OnspringOptions__SearchRequestOptions__ProcessedSuccessStatusId`
- The list value ID for the processed success value for the Status field in the Search Request app in Onspring.
- `OnspringOptions__SearchRequestOptions__ProcessedErrorStatusId`
- The list value ID for the processed error value for the Status field in the Search Request app in Onspring.
- `OnspringOptions__SearchRequestOptions__ErrorFieldId`
- The field ID for the Error field in the Search Request app in Onspring.
- `OnspringOptions__SearchResultOptions__AppId`
- The app ID for the Search Result app in Onspring.
- `OnspringOptions__SearchResultOptions__SearchRequestFieldId`
- The field ID for the Search Request field in the Search Result app in Onspring.
- `OnspringOptions__SearchResultOptions__NameFieldId`
- The field ID for the Name field in the Search Result app in Onspring.
- `OnspringOptions__SearchResultOptions__AddressFieldId`
- The field ID for the Address field in the Search Result app in Onspring.
- `OnspringOptions__SearchResultOptions__TypeFieldId`
- The field ID for the Type field in the Search Result app in Onspring.
- `OnspringOptions__SearchResultOptions__ProgramsFieldId`
- The field ID for the Programs field in the Search Result app in Onspring.
> [!NOTE]
> You can find a sample `.env` file [here](./src/SanctionsSearch.Worker/example.env) and a sample `appsettings.json` file [here](./src/SanctionsSearch.Worker/appsettings.Example.json) that provide a list of all the configuration options.
@@ -109,3 +140,19 @@ WantedBy=multi-user.target
#### Executable
Note you can also just run the app as an executable after publishing it for your platform using one of the commands above.
## OFAC Data
The app uses the OFAC SDN list as the source of sanctions data. The app will download the latest SDN list from the OFAC website and update a local SQLite database with the latest information. The app will then use this local database to perform sanctions search against the data. If you are running the app with Docker and want to persist the local database you will need to mount a volume to the `Data` directory in the container.
```sh
docker run -d --name sanctions-search --env-file .env -v /path/to/data:/app/Data sanctions-search
```
## Logging
The app uses Serilog for logging. By default, the app logs to the console and to a file in the `Logs` directory. If you are running the app with Docker and want to persist the logs you will need to mount a volume to the `Logs` directory in the container.
```sh
docker run -d --name sanctions-search --env-file .env -v /path/to/logs:/app/Logs sanctions-search
```