WSYAPIWS - The Web Service Group Model

• Overview
• Licensing
• Adding WSYAPIWS to your group model
• Plex configuration
• More information

Overview

In the previous versions, all the API's, abstract functions, fields etc. that was relevant for WebsydianExpress was present in the WSYAPI group model.

With the introduction of web services in WebsydianExpress version 3.0, an additional group model has been introduced. This group model is named WSYAPIWS, and has been introduced due to the need for support of XML-handling in certain abstract functions.

The XML-handling is performed by using the TransacXML pattern libraries (WSYDOM, WSYXML, and WSYSOAP). The special thing about these libraries is that they are priced separately from the basic Websydian web developer patterns used by WSYAPI. More specifically, WSYDOM has a separate license that means that if you add the WSYDOM library to your local model, you will have to pay for an additional license for the TransacXML patterns.

If you want to use the TransacXML libraries in WebsydianExpress, you must add the WSYAPIWS library to your group model. In this model we have placed the API's, abstract functions, fields etc. that needs to have access to the TransacXML patterns to work.

The WSYAPIWS model inherits from the WSYAPI model.

It is probably important to note that it is not all the web service related APIs and abstract functions are placed in the WSYAPIWS model. Functions that makes no use of the TransacXML patterns are placed in the WSYAPI model so that as many customers as possible can use them (for example the Abstract.FileServiceHandler function that you can inherit from to make a service handler that handles files without using the TransacXML patterns).

The WSYAPIWS model is delivered as part of the normal Websydian distribution, just as the WSYAPI model is.

Licensing

The WSYDOM library, which is used by the WSYAPIWS model is a licensed model. To use this library, you must buy a TransacXML development license.

If you do not have such a license, you should not add WSYAPIWS to your group model.

If you want to test the functionality in the WSYAPIWS model, you can get a test license by contacting Websydian Support.

As it can be a problem to remove a library model from a group model, you should not add WSYAPIWS to your production model if you are using a test license, create a separate test model instead.

Adding WSYAPIWS to your model

WSYAPIWS is added to your model as any other Plex group model.

If you are creating a new model and you want to use the objects from WSYAPIWS and WSYAPI in this model, you can just add WSYAPIWS. As WSYAPIWS inherits from WSYAPI, you will be prompted for the locations of all relevant group models.

When you add WSYAPIWS to your model, you will be prompted for a license for WSYDOM, just as the addition of WSYAPI leads to a prompt for a WSYBASE license.

If you have bought the TransacXML product, or if you would like a trial version of TransacXML, contact Websydian Support to obtain the license.

Please note that if you just want to evaluate the TransacXML product, it is recommended that you create a special model for this purpose.

If you add WSYAPIWS (and thereby WSYDOM) to your model and create objects based on the licensed model, you might have problems removing the group models if you find that you do not want to use TransacXML after all.

Plex configuration

When you add WSYAPIWS to your group model you get four additional models you have to specify the configuration for.

The setup must follow the setup of the WSYBASE model as follows:

WSYBASE: DWA-Windows

WSYBASE: DWA-Java

WSYBASE: DWA-iSeries

TransacXML is not available in the iSeries variant.

More information

General Information about TransacXML

Plex Development: Setting up your model