ess

EMBC ESS Back-end Services

Back-end service to provide data and business logic to ESS portals

Features

• gRPC service to send and receive data from Dynamics
• business logic layer and mappings
• active background tasks to populate cache and perform timed actions
• connect to external services

flowchart TB

    classDef manager fill:#ffff00,stroke:#333,stroke-width:4px,color:#000
    classDef engine fill:#ffc000,stroke:#333,stroke-width:4px,color:#000
    classDef ra fill:#c0c0c0,stroke:#333,stroke-width:4px,color:#000
    classDef resource fill:#00ffff,stroke:#333,stroke-width:4px,color:#000
    classDef layer fill:#fff,color:#000

    subgraph Resources[Resources]
        direction TB
        Dynamics[(Dynamics)]
        CAS([CAS AP])
    end    

    subgraph RAs[Resource Access]
        direction TB
        EvacuationsResource([Evacuations Resource])
        EvacueesResource([Evacuees Resource])
        SuppliersResource([Suppliers Resource])
        SupportsResource([Supports Resource])
        TeamsResource([Teams Resource])
        TasksResource([Tasks Resource])
        PaymentsResource([Payments Resource])
        ReportsResource([Reports Resource])
        PrintResource([Print Resource])
        MetadataResource([Metadata Resource])    
    end
            
    subgraph Engines[Engines]
        direction TB
        SearchEngine([Search Engine])
        SupportingEngine([Supporting Engine])
    end
    
    subgraph Managers[Managers]
        direction TB
        EventsManager([Events Manager])
        TeamsManager([Teams Manager])
        AdminManager([Admin Manager])
        ReportsManager([Reports Manager])
    end

    Engines-->RAs
    Managers-->Engines & RAs
    RAs-->Resources

    class Dynamics,CAS resource
    class EvacuationsResource,EvacueesResource,SuppliersResource,SupportsResource,TeamsResource,TasksResource,PaymentsResource,PaymentsResource,ReportsResource,PrintResource,MetadataResource ra
    class SearchEngine,SupportingEngine engine
    class EventsManager,TeamsManager,AdminManager,ReportsManager manager
    class RAs,Engines,Managers,Resources layer
   

Loading

Project status

Dynamics OData code generation

Prerequisites

• OData Connected Services extension for VS2022
• Access to ERA Dynamics instance

Steps to update Dynamics Connected Service

1. Open ess/src/API/EMBC.ESS.sln in VS2022
2. run EMBC.Tests.Integration.ESS.DynamicsBaseTests.GetSecurityToken integration test
3. copy the Authorization header from the test output log (e.g. Authorization: Bearer abcdefg...)
4. right-click Connected Services/Dynamics folder and select Update OData Connected Service
5. paste the Authorization header into Custom Header and click next (do not check 'save custom headers')
6. if authentication is successful, the next screen will show the list of entities in Dynamics
7. Finish the update wizard to complete the generated code refresh
8. compile and run the integration tests suite to verify Dynamics integration functionality is not broken

Steps to run locally

1. Configure the following secrets in EMBC.ESS.Host's secerts.json:

{
    "notifications": {
        "email": {
            "smtpServer": "[smtp server]"
        }
    },
    "messaging": {
        "authorizationEnabled": "true",
        "oauth": {
            "metadataAddress": "[oauth server metadata]",
            "clientId": "[client id]",
            "clientSecret": "[client secret]",
            "scope": "ess-backend"
        }
    },
    "backgroundTask": {
        "enabled": "true"
    },
    "cas": {
        "baseUrl": "[CAS endpoint url]",
        "clientId": "[CAS client id]",
        "clientSecret": "[CAS client secret]"
    },
    "Spatial": {
        "geocoderApiKey": "[Geocoder API key]"
    },

    "Dynamics:ADFS:OAuth2TokenEndpoint": "[ADFS STS url]",
    "Dynamics:ADFS:ResourceName": "[resource name]",
    "Dynamics:ADFS:ClientId": "[ADFS client id]",
    "Dynamics:ADFS:ClientSecret": "[ADFS client sercert]",
    "Dynamics:ADFS:serviceAccountDomain": "[service account domain name]",
    "Dynamics:ADFS:serviceAccountName": "[service account name]",
    "Dynamics:ADFS:serviceAccountPassword": "[service account password]",
    "Dynamics:DynamicsApiEndpoint": "[Dynamics actual base url (proxied)]",
    "Dynamics:DynamicsApiBaseUri": "[Dynamics base url for entity names]"

}

2. run EMBC.ESS.Host

Steps to run the integration tests

The solution has an extensive test suite. To run, configure EMBC.ESS.Host with the secrets and execute using Visual Studio or dotnet test.

The integration tests fixture will setup all required data automatically, but occasionally a full reset of the data is required. Use cleanup.sql to reset the development environment.

Dynamics DEV environments have a nightly cleanup script that will remove any test related data.

NOTE: The integration tests are not executed during CI/CD pipeline builds, it is important to run them locally while connected to the BCGOV network, and to keep them up-to-date and green