Configuring API support

BlueZone supports DDE and HLLAPI to allow external applications, such as GUI interfaces, scripting engines, and input automation programs, to input data to and extract data from IBM host screens. The primary interface is through the DDE server. The BlueZone implementation of HLLAPI communicates with BlueZone through this DDE interface and is EHLLAPI/WHLLAPI compliant.

1. Click Options → API.
2. In the Dynamic Data Exchange DDE) section, enter the following information:
   1. Select the Enable DDE Interface check box to allow the BlueZone session to function as a DDE Server.
      DDE client applications can communicate with DDE servers to exchange data. This option must be enabled in order for BlueZone to communicate with HLLAPI client applications.

      The Server / Service Name field displays the server/service name as BlueZone.

      The Topic Name field displays the session’s DDE topic name. The topic name can be changed by configuring the HLLAPI Short Name Session Identifier.

   2. Select the Enable Network DDE Initialization check box to enable DDE client applications to communicate with BlueZone over a Local Area Network (LAN). BlueZone will modify the registry settings and invoke netdde.exe.
      Note: Only use this option when the HLLAPI application is on a computer separate from the computer that BlueZone is running on.

      The DDE Share field displays the DDE share name that NETDDE uses to establish a DDE connection over the Local Area Network (LAN).

3. In the High Level Language API (HLLAPI) section, select the necessary check boxes:
   • Auto-Assign HLLAPI Names: Select to have BlueZone automatically associate the Short Name Identifier to a session number, for example, A for S1, B for S2, and so on. When this check box is selected, you cannot edit the Short Name Session Identifier and Session Long Name fields.
   • Auto-Launch the BlueZone DOS HLLAPI Redirector: Select to have BlueZone run/close the BlueZone DOS HLLAPI Redirector program each time that the BlueZone DDE Server initializes/deinitializes.
   • Allow Multiple Simultaneous Connections: Select to allow multiple simultaneous connections.
4. Click the Trace tab:
   1. Select the necessary check boxes:

      • Trace DDE Interface: Select to trace the DDE conversation transactions.

      • Trace HLLAPI Interface: Select to trace the HLLAPI function calls and return values.

      • Trace RUI Interface: Select to trace the RUI conversation transactions.

   2. In the Trace File field, type a file name for the API trace. By default, the traces are saved in the \Traces folder in the working directory. Click Browse to select a different location.
      Important: This field must contain a valid path or the trace feature will not work.
   3. Click Start Trace to start the API trace.
   4. Click Stop Trace to stop the API trace.
5. Click OK.