Getting Started

ABSTRACT

In this article we will guide you through:

Getting all the resources needed for development
Setting up your development environment
Running an app in debug mode

Prerequisites

Software

You need software to create software. Before you start, download and install:

SCIA Engineer

See the system requirements.
.NET Framework 4.8 developer pack

Can be downloaded from official Microsoft website or installed directly using winget:
```
winget install Microsoft.DotNet.Framework.DeveloperPack_4.8
```

IDE

Since SCIA Open API is a C# interface, use any IDE suitable for handling .NET projects. In this article, we will cover setup with:

Visual Studio
VS Code

Can be downloaded from official Microsoft website or installed directly using winget:

winget install Microsoft.VisualStudio.2022.Community

Opt for this option, if you are about to handle complex, large-scale C# applications with advanced UI.

Can be downloaded from official Microsoft website or installed directly using winget:

winget install Microsoft.VisualStudioCode

This is a more lightweight, but not as powerful option. Opt for it for simple console applications.

You will also need C# extensions, but these will be installed automatically, when you proceed with the next step.

If you have git installed, clone the repository with an example showcasing the usage of Open API

git clone https://github.com/scia-garage/open-api-adm-dotnet.git
cd open-api-adm-dotnet

Check out the repo at the tag corresponding with your SCIA version

git checkout tags/25.0

Note

Ensure SCIA Engineer is installed at the default location:

if exist "C:\Program Files\SCIA\Engineer25.0" (echo OK) else (echo Not found)

If this is not the case, you have to adapt the DLL paths in OpenAPIAndADMDemo.csproj!

Visual Studio
VS Code

Open the solution file open_api_adm_dotnet.sln

Go to File -> Open Folder and open the open-api-adm-dotnet folder. Alternatively, in the CLI run:

code .

Wait a couple of seconds for the pop-up about installing extensions recommended for this project to pop up or open the Extensions tab (CTRL+E) and type @recommended in the search field and install all recommended extensions

Build the project:

dotnet build open_api_adm_dotnet.sln

And run it:

dotnet run --project OpenAPIAndADMDemo

If you set up your project correctly, a console should pop up and shortly after also SCIA Engineer. Follow the instructions in the console window. If you encountered a problem, refer to the troubleshooting section below.

Debugging

Visual Studio
VS Code

Set a breakpoint anywhere in the code
Press F5

Troubleshooting

Start timeout

When after starting the example you see the following error:

2025-01-23 12:34:56.7890|ERROR|SCIA.OpenAPI.AdmToAdmServiceWrapper|Server start timeout. SCIA Engineer Application must be terminated manually!

It means, that SCIA Engineer didn't start within a timeout. Do following:

Close the console
After some time, SCIA Engineer will eventually start. Close it as well.
Restart the project

Table of Contents