Open Charge Map (OCM) System

The OCM Import Worker uses an intelligent, API-driven scheduling system to process data providers. The scheduling logic follows these rules:

1. Cycle Execution: Every ImportRunFrequencyMinutes, the worker fetches the DataProvider list from the OCM API.
2. Filtering: It filters providers based on the EnabledImports configuration and identifies those due for import (where DateLastImported is NULL or older than the IMPORT_DUE_THRESHOLD_HOURS, which defaults to 24 hours).
3. Failure Exclusion: Providers that have failed an import within the last 24 hours are excluded from the current cycle.
4. Priority Queue: Providers are processed in order of oldest to newest DateLastImported. The provider with the oldest timestamp has the highest priority.
5. Wait Behavior: If no providers meet the criteria, the worker logs the status and waits for the next cycle without performing unnecessary imports.

Use this approach only if the provider requires custom processing logic. This involves creating a new class that inherits from ImportProvider_OCPI.

Steps:

1. Add DataProvider definition in database.
2. Add/get operator id for the target network.
3. Store credential in keyvault.
4. Implement the OCPI import provider in OCM.Import.Common.Providers.OCPI.
5. Add import provider to OCM.Import.Worker:
   • Update appsettings.json under EnabledImports.
   • Add the provider to OCM.Import.Common.ImportManager.

Implementation Details:

• Download and verify the OCPI feed manually to check credentials and data format.
• Add a test with a copy of the JSON feed in OCM.API.Tests - ImportTests to ensure data consistency.
• Ensure the provider maps to its own network operator and any other relevant operators via GetOperatorMappings().

using System.Collections.Generic;

namespace OCM.Import.Providers.OCPI
{
    public class ImportProvider_MyProvider : ImportProvider_OCPI, IImportProvider
    {
        public ImportProvider_MyProvider() : base()
        {
            ProviderName = "myprovider";
            OutputNamePrefix = "myprovider";

            IsAutoRefreshed = true;
            IsProductionReady = true;

            CredentialKey = "OCPI-MYPROVIDER"; // or null if no auth needed

            DefaultOperatorID = 1234;

            Init(dataProviderId: 99, "https://api.example.com/ocpi/2.2/locations");
        }

        public override Dictionary<string, int> GetOperatorMappings()
        {
            return new Dictionary<string, int>()
            {
                { "My Operator", 1234 }
            };
        }
    }
}

The following test plan outlines the critical user journeys required to validate the Open Charge Map application functionality:

Search and Discovery

1. Search Near Me: Verify that selecting 'Search Near Me' displays search progress and correctly renders search results.
2. POI Details: Selecting a search result must display the Point of Interest (POI) details.
3. Map Integration: Returning to the Map view via the Menu Icon must render markers for all current search results. Selecting a marker must display the POI details.
4. Data Refresh: After adding comments or photos, refreshing search results must ensure new content appears in the POI details.

User Authentication and Contributions

1. Authentication Flow: Attempting to 'Add Comment' should prompt a Sign In. Completing the Sign In from the main menu should return the user to the app in a 'Signed in' state.
2. Commenting: Once signed in, navigate to POI details, select 'Add Comment', enter details, and verify submission.
3. Photo Uploads: Navigate to POI details, select 'Add Photo', enter details, and verify submission.

Location and Profile Management

1. Location Management: Verify the ability to edit an existing location and add a new location.
2. Favorites: Verify the ability to add and remove a favorite location.

You can build the OCM Import Worker image using either standard Docker commands from the repository root or via Docker Compose.

Using Docker: Run the build command from the ocm-system root directory. You can specify a build configuration (e.g., Release) or perform a clean build using --no-cache.

Using Docker Compose: Navigate to the Import/OCM.Import.Worker directory and run docker-compose build.

# Build using Docker from repository root
docker build -f Import/OCM.Import.Worker/Dockerfile -t ocm-import-worker:latest .

# Build using Docker Compose
cd Import/OCM.Import.Worker
docker-compose build

# Build with specific configuration
docker build \
  -f Import/OCM.Import.Worker/Dockerfile \
  --build-arg BUILD_CONFIGURATION=Release \
  -t ocm-import-worker:v1.0.0 \
  .

# Build with no cache (clean build)
docker build --no-cache \
  -f Import/OCM.Import.Worker/Dockerfile \
  -t ocm-import-worker:latest \
  .