Eriksson Beam API
Search Results for

    Show / Hide Table of Contents

    Troubleshooting

    This section helps you diagnose and resolve common issues with the Eriksson Beam API.

    Quick Diagnosis

    Symptom Likely Cause Solution
    "Eriksson Beam not running" Process not started or 10-min timeout Connection Issues
    Connection timeout Idle timeout exceeded Connection Issues
    License error Invalid/expired key Connection Issues
    Data loss after push Created BeamDesign directly Data Issues
    Push validation failed Invalid property values Data Issues
    Package not found NuGet source not configured Installation

    Troubleshooting Guides

    • Connection Issues - Can't connect to Eriksson Beam
    • Data Issues - Problems with pull/push operations
    • FAQ - Frequently asked questions

    General Troubleshooting Steps

    1. Check Eriksson Beam is Running

    The API requires Eriksson Beam desktop application to be running:

    var instances = await ErikssonBeamFinder.GetSupportedErikssonBeamInstances();
    Console.WriteLine($"Found {instances.Length} Eriksson Beam instance(s)");
    

    2. Verify API License Key

    Ensure your API license key is correctly configured:

    var licenseKey = Environment.GetEnvironmentVariable("ERIKSSON_LICENSE_KEY");
    if (string.IsNullOrEmpty(licenseKey))
    {
        Console.WriteLine("License key not found in environment variable");
    }
    

    3. Enable Logging

    Add diagnostic logging to identify issues:

    using Microsoft.Extensions.Logging;
    
    var loggerFactory = LoggerFactory.Create(builder =>
    {
        builder.AddConsole().SetMinimumLevel(LogLevel.Debug);
    });
    var logger = loggerFactory.CreateLogger<Program>();
    
    var launcher = await ErikssonBeamLauncher.LaunchErikssonBeam(args, logger);
    

    4. Check Error Details

    When catching exceptions, log full details:

    catch (ServerErrorException ex)
    {
        Console.WriteLine($"Response Code: {ex.Response.ResponseCode}");
        Console.WriteLine($"Error Message: {ex.Response.ErrorMessage}");
    }
    catch (Exception ex)
    {
        Console.WriteLine($"Exception Type: {ex.GetType().Name}");
        Console.WriteLine($"Message: {ex.Message}");
        Console.WriteLine($"Stack Trace: {ex.StackTrace}");
    }
    

    Getting Help

    If you can't resolve an issue:

    1. Check the documentation - Review relevant sections
    2. Enable verbose logging - Capture diagnostic information
    3. Note the exact error - Record exception type, message, and response codes
    4. Contact support - Reach out to Eriksson Software with details

    See Also

    • Connection Issues - Connection troubleshooting
    • Data Issues - Data operation problems
    • FAQ - Common questions
    • Error Handling Guide - Exception reference
    • Edit this page
    In this article
    Back to top Generated by DocFX