LightWave Client SOAPAM Compatibility Documentation

This Appendix describes the SOAPam Client Compatibility feature in LightWave Client.

Note: The SOAPam Client Compatibility feature is licensed separately from the base LightWave Client license. To acquire a license for this feature, please contact your NuWave account representative.

Introduction

LightWave Client SOAPAM Compatibility allows SOAPAM Client applications to use LightWave Client, without changing the SOAPam Client application. Using Client SOAPAM Compatibility, however, requires modification to operation procedures and configurations. These changes are documented elsewhere.

Startup

A LightWave Client process is created in the same manner as a SOAPAMCP process: either as a stand-alone process (with the --standalone option) started from a TACL prompt, or as a Pathway server process started by PATHMON.

Configuration

Whether running stand-alone or in a Pathway serverclass, the mechanisms used to configure LightWave Client are similar to those used to configure SOAPAM Client: command-line options, PARAMs, and configuration files. However, there are some differences.

API Definitions Instead of CDFs

LightWave Client is driven by an API definition. The LWC startup option --api specifies a filename that contains the API definition. The SOAPAMCP startup option -cdf is analogous.

Base URL Instead of Location

One key difference between the LightWave Client --base-url option and the SOAPAMCP -location option is that the --base-url option does not include the operational path. That value is specified in the API.

For example:

LightWave Client

SOAPAMCP

Another difference between the LWC --base-url option and the SOAPAMCP -location option is that the --base-url option is required because the LightWave Client API definition does not contain URLs as the SOAPAMCP CDF does.

Diagnostic Logs Instead of Message Dumps

LightWave Client Diagnostic Logs are analogous to SOAPAM Message Dumps. The content is different to reflect the differences between a RESTful API call and a SOAP/XML web service invocation.

Operationally, diagnostic logs are separate files for each API call, and they are always EDIT-type files. The option to write all diagnostic log entries to a single file is not available in LWC.
Additionally, diagnostic log filters are specified via the --diag-log option instead of separate options (typically contained in an options file).

Log File

LightWave Client logging is configured with the single --log option, whether values are provided on the command-line or in a configuration file.

Converting Credentials Files

SOAPAMCP credentials files created with the makecf utility are not valid for LightWave Client. Credentials files must be recreated with the LightWave Client LWCOM utility’s CREATE CREDENTIALS command.

CREATE CREDENTIALS <file-name> [ ! ]
[ , CREDENTIALS <credentials-string> ]
[ , FROM-FILE <file-name> ]
[ , TARGET <file-name> ]
<file-name> [ ! ]
File to contain the stored credentials. Append ! to the name to overwrite an existing file with the same name.
CREDENTIALS <credentials-string>
The credentials to be encoded, e.g. <username>':'<password>.
FROM-FILE <file-name>
A file containing unencoded credentials to be encoded.
TARGET <file-name>
The file name to be encoded with the stored credentials. If not specified, it will be the same name as the output file name.

Converting CDFs

The LightWave Client command interpreter (LWCCOM) has been enhanced to convert SOAPAMCP CDFs to LWC APIs and to Data Definition Language (DDL) source files.

CDF to API

run lwccom convert cdf <cdf-filename>, format api, file <api-filename> [ ! ]

Where:

CDF to DDL

Convert a CDF to a DDL source file with the following LWCCOM command:

run lwccom convert cdf <cdf-filename>, format ddl, file <ddl-filename> [ ! ]

Where:

NOTE: The LWCCOM convert CDF to DDL and export API to DDL commands generate two different versions of application structures in the DDL source. The convert CDF to DDL command generates DDL source in a format suitable for exchanging messages with LightWave Client running in SOAPam Compatibility mode. The export API to DDL generates DDL source for use with LightWave Client running in “native” mode.

Command-line Option Cross References

Note: A full description of the options in these tables is beyond the scope of this document. Please see relevant product documentation for details.

SOAPAMCP to LightWave Client

The following table identifies SOAPAM Client command-line options and their LightWave Client equivalents. If the command is unavailable or not applicable, N/A appears in the column.

LightWave Client to SOAPAMCP

The following table identifies LightWave Client command-line options and their SOAPAM Client equivalents. If the command is unavailable or not applicable, N/A appears in the column.