Connectors and APIs

Reflection ZFE has a collection of APIs and libraries that help you develop efficient client/server and Web applications that integrate host data into various development environments.

Related Topics

Using the Reflection ZFE SDK

Use server side events to supply procedural Java code that can extend and improve the presentation of host data. To help you create server side events, Reflection ZFE has an SDK and samples that are available to provide you with a starting point.

Examples and documentation

You can view the Reflection ZFE SDK.

To access the SDK for direct viewing and to import to your IDE:

  1. Navigate to <install-dir>\Micro Focus\ReflectionZFE\sessionserver\sdk\java.

  2. In the SDK directory, access:

    • \javadoc. This directory contains JavaDoc files for direct viewing.

    • \samples - This directory contains Java sources for direct viewing.

    • \zfe-sdk.jar - The JAR file contains the Java classes to import into your IDE.

    • \zfe-sdk-javadoc.jar - The JAR file contains JavaDoc files to import into your IDE.

Using the Reflection ZFE Connector for Windows

Reflection ZFE Connector for Windows is a separate installation which you can find on the Micro Focus download site. Using the Reflection ZFE Connector for Windows, you can interact with ZFE host sessions in your .NET application or within Visual Basic for Applications. Here are a few things to keep in mind as you prepare to install:

  • Two install platforms are available: a 32-bit version and a 64-bit version. Depending on which one you install, the default base install path will be C:\Program Files (x86)\Micro Focus\ReflectionZFE\Connector for Windows or C:\Program Files\Micro Focus\ReflectionZFE\Connector for Windows.

  • The installation platform you choose also determines the solution platform in which you can develop. For example: If you have installed the 32-bit version of Microsoft Office® and want to use Visual Basic for Applications with the connector, then you must install the 32-bit version of the Reflection ZFE Connector for Windows.

  • .NET 4.5.2 is required.

Examples and connector documentation

You can find the Reflection ZFE Connector for Windows API documentation here.

You can find documentation which you can reference from your IDE and samples here:

  1. Navigate to the install directory. In a default install, either C:\Program Files (x86)\Micro Focus\ReflectionZFE\Connector for Windows or C:\Program Files\Micro Focus\ReflectionZFE\Connector for Windows depending on your platform.

  2. In the Connector for Windows directory you will find:

    • MicroFocus.ZFE.Connector.dll - a .NET Framework assembly to reference in your C# or .NET project.

    • MicroFocus.ZFE.Connector.tlb - a Type Library to use in your COM or Visual Basic for Applications project.

    • \help - this directory contains information which will aid in using the connector.

    • \samples - this directory contains the code samples that provide a starting point for developing your own applications.

Using the connector with Microsoft Visual Studio

If you are using Microsoft Visual Studio to develop applications, keep these things in mind:

  • When using Microsoft Visual Studio with Reflection ZFE Connector for Windows, make sure your solution platform is set to either x86 or x64, depending on your installation. Because of the native components used within the Reflection ZFE Connector for Windows SDK, the Any CPU platform is not supported. Use the Configuration Manager for your Visual Studio Solution to create a platform for x86 or x64.

  • When adding a reference to the Reflection ZFE Connector for Windows library, Visual Studio may set the Copy Local reference property to True. This should be set to False so that the library and its dependencies are executed from the SDK install directory.