Click or drag to resize

0 Installation and Release Maintenance

This chapter will describe the necessary steps to start using the Process Data Analyzer API or update to a newer version of the Process Data Analyzer API.

Initial API Installation

To use the Process Data Analyzer API, on installation, check the Process Data Analyzer API component.

PDA Installer Component Feature Selection
Feature Selection

This will install or add to your installation the following folders and files in your Process Data Analyzer root installation folder:

  • API folder

    • Library folder

      • CSharpClient folder containing a PDA API ClientLib NuGet package and the ClientLib DLLs for .NET Standard 2.0.

      • Protos folder containing the .proto protobuf files for API generation and pre-generated .NET Standard 2.0 DLLs of the proto interface.

    • SampleCode folder

      • SampleApplications folder containing a Visual Studio 2022 solution with sample applications using the PDA API.

      • Tutorials folder containing a Visual Studio 2022 solution with tutorial applications using the PDA API.

  • Bin folder, which is created on API only installation or extended by the ProcessDataAnalyer.Service.exe and its dependencies in case both the GUI and API are installed.

Installing or removing the Process Data Analyzer API will not change any configurations made to the PDA. Already saved configurations of the PDA API will persist through updates and uninstallations as they are seen as "user created" and thus remain untouched.

API Installation Update

Installing a newer version of the Process Data Analyzer API will update the following files:

  • API

    • Library

      • CSharpClient: Both ClientLib DLLs as well as the ClientLib NuGet package.

      • Protos: .proto protobuf files with their API definitions and pre-generated DLLs.

    • SampleCode: Additional sample applications or tutorials might be added.

  • Bin: ProcessDataAnalyer.Service.exe and its dependencies.

If you have applications using the Process Data Analyzer API, make sure you update their references and rebuild the application.