LogiKal C# API V3

Introduction #

The API V3 is an interface that provides access to a wide range of functionalities of LogiKal.

Project management, building windows, creating orders and many more functionalities are available.

It can be used to integrate these processes into your own software.

The API V3 has been officially released with version 3.0.2.4. All existing interface functions in this version will no longer be changed or removed.

The API V3 will be improved in the future in terms of new features and even due to extensive testing, errors/bugs might still appear. Therefore updates will be released. Future API V3 versions will always be backward compatible to the version 3.0.2.4. To be able to use new features or bug fixes it will be necessary to perform an additional compilation. The current API V3 will not face any breaking changes.

Overview #

Topology #

The Ofcas.Lk.Api.Service provides the connection to LogiKal. The Ofcas.Lk.Api.Service is used by the assemblies Ofcas.Lk.Api.Core and Ofcas.Lk.Api.Ui.

The Ofcas.Lk.Api.Service is part of LogiKal and is installed within the installation of LogiKal.

The Ofcas.Lk.Api.Service does not have to be started manually. The assembly Ofcas.Lk.Api.Ui and Ofcas.Lk.Api.Core starts the Ofcas.Lk.Api.Service automatically.

User Interfaces #

For remote control of Logikal the following interfaces are available:

• Ofcas.Lk.Api.Core: access without user interfaces
• Ofcas.Lk.Api.Ui: access with LogiKal user interfaces, e.g. input masks

Introduction to the hierarchical class structure #

LogiKal bases its project management on the following hierarchy scheme.

Elements (ElevationInstance) are children of elevations (Elevation), elevations of phases (Phase), phases of projects (Project), projects of project centers (ProjectCenter, directories) and project centers of the login scope.

System requirements #

• LogiKal: 12.0 or higher
• OS LocalMachine: Windows 7 or higher