Online documentation - Websydian v6.0

Users Guide | Patterns Reference | WebsydianExpress | Search

 

Setting up your Plex model for CA Plex v5.0 and v5.1

Contents

Introduction

Before following the instructions in this section make sure that the Websydian pattern libraries have been installed successfully.

This section explains how to set up CA Plex local model to work with the Websydian pattern libraries. This document applies to CA Plex versions 5.0, and 5.1.

The actions described in this document must be performed the first time you use the Websydian patterns in an CA Plex model.

Add Websydian Pattern Libraries to the Group Model

The first thing to do is to add the relevant Websydian library models to the host group model of your application. This action is performed once per group model in the same way as adding any other library models to a host model.

The Websydian library models may be added during creation of a group model together with the CA Plex Pattern libraries and other library models needed by the model, or they can be added to an existing CA Plex group model.

Extract Definitions from Websydian Library Models

Once the Websydian library models have been added to the group model and a local model has been defined, the objects in the Websydian library models must be extracted to the local model.

Specify Pre-built Library and Header Files

When a local model with the relevant Websydian libraries extracted has been created, the developer is required to setup a number of pre-built C++ library files and header directories for Windows and a number of user class libraries for Java.

Depending on the language selected by the variant of WSYBASE the required files differ.

iSeries

This section applies to local models where the variant for WSYBASE has been set to DWA - iSeries or iSeries web server.

This section applies only to CA Plex versions 5.0, and 5.1. If using CA Plex 5.5 please go to this section.

The table below (table 1) indicates which pre-built C++ library files to include. It is recommended to add all of the listed library files.

  Library file Location
Mandatory websyd.lib Located in the folder <Websydian Install Folder>\development\lib\Plex5.0
Table 1: Pre-built C++ library files to include

To setup the pre-built C++ library files in the CA Plex group model follow the steps below:

  1. Open the "System Definitions" dialog located under the "Generate and Build Options".
  2. In the "32-bit C++ Build" section activate "Use pre-built libraries".
  3. Add each of the library files listed in the table above (table 1) to the "Libraries" field. Make sure to add the full path of each library file and delimiting each library file by a semicolon (;).
  4. Add the Websydian header folder "<Websydian Install Folder>\development\include" to the field Header Directories.

C++ library files are referenced by file name whereas header files are referenced by the name of the folder where they are located.

Examples

Libraries

c:\Websydian\development\lib\Plex5.0\websyd.lib

Header Directories

c:\Websydian\development\include

Windows

This section applies to local models where the variant for WSYBASE has been set to DWA - Windows or PC web server.

This section applies only to CA Plex versions 5.0, and 5.1. If using CA Plex 5.5 please go to this section.

The table below (table 1) indicates which pre-built C++ library files to include. It is recommended to add all of the listed library files.

  Library file Location
Mandatory websyd.lib Located in the folder <Websydian Install Folder>\development\lib\Plex5.0.

xxx is the version of CA Plex, e.g: 500 for CA Plex 5.0.

wsyhttpxxx.lib
wininet.lib Supplied with Visual Studio; no path required.
ws2_32.lib
When using TransacXML wsydxml11.lib Located in the folder <Websydian Install Folder>\development\lib\Plex5.0.
wsydxml11_dll.lib
Recommended obpt32.lib Supplied with Plex; located in the folder <Plex Install Folder>\Classxxx\PatternLibs where xxx is the Plex version number.
Table 1: Pre-built C++ library files to include
To setup the pre-built C++ library files in the CA Plex group model follow these steps:
  1. Open the "System Definitions" dialog located under the "Generate and Build Options".
  2. In the "32-bit C++ Build" section activate "Use pre-built libraries".
  3. Add each of the library files listed in the table above (table 1) to the "Libraries" field. Make sure to add the full path of each library file and delimit each library file by a semicolon (;).
  4. Add the Websydian header folder "<Websydian Install Folder>\development\include\VC 6.0" to the field Header Directories.

C++ library files are referenced by file name whereas header files are referenced by the name of the folder where they are located.

Examples

Libraries

c:\Websydian\development\lib\Plex5.0\websyd.lib;
c:\Websydian\development\lib\Plex5.0\wsydxml11.lib;
c:\Websydian\development\lib\Plex5.0\wsydxml11_dll.lib;
c:\Websydian\development\lib\Plex5.0\wsyhttp400.lib;
wininet.lib;ws2_32.lib;c:\plex\plex 5.0\class500\patternlibs\obpt32.lib

Header Directories

c:\Websydian\development\include

Java

When using DWA for Java (variant for WSYBASE set to DWA - Java), a number of JAR files should be specified as user classes; see table below (table 2).

  JAR file Location
Mandatory WsydDwa21.jar Located in the folder <Websydian Install Folder>\development\jars.
WsydUtil.jar
When using TransacXML WsydXml11.jar Located in the folder <Websydian Install Folder>\development\jars.
Recommended Obptjava.jar Supplied with Plex; <Plex Install Folder>\Classxxx\PatternLibs where xxx is the Plex version.
Table 2: Which JAR files to include

When building Java applications it is recommended to use CA Plex 5.5SP1 or later.

To setup the user classes in the CA Plex model follow these steps:

  1. Open the "System Properties" dialog located under the "Generate and Build Options".
  2. Select the "Java Build" section.
  3. Add each of the JAR-files listed in the table above (table 2) to the "User classes" input field. Make sure to add the full path of each JAR-file and delimit each JAR-file by a semicolon (;).
  4. Make sure that the input field "Nmake directory" refers to the directory where the Nmake application is located.
  5. Make sure that the input field "Compiler" refers to the java compiler (javac.exe). Default location is in the bin directory of the Java SDK.

When generating functions with a long scoped name CA Plex can generate names for Java classes that exceeds the maximum length for files that can be handled by the Windows file system. To avoid this please check the check box "Use field implementation names in source" in the Double Byte Build section.

Example

The JAR-file list to insert in the 'User classes' field could look similar to the example below:

c:\Websydian\development\jars\WsydDwa21.jar;
c:\Websydian\development\jars\WsydUtil.jar;
c:\Websydian\development\jars\WsydXml11.jar;
C:\Plex\Plex5.0\Class500\PatternLibs\Obptjava.jar

Model Configuration for the Websydian Library Models

In the model configuration for the host group model the Websydian WSYBASE library must have its variant set according to the chosen target platform:

VariantDescription
PC web server Windows CGI interface (CWA Windows): The target Websydian application is Windows EXE and DLL files running on a Windows platform.
iSeries web server iSeries CWA: The target Websydian application consists of programs running on iSeries.
DWA - Windows Code will be generated for the DWA interface on a Windows platform.
DWA - Java Code will be generated for the DWA interface on a Java platform.
DWA - iSeries Code will be generated for the DWA interface on an iSeries platform.
Variants for the WSYBASE group model

The variant of WsyHttp, SDString, and WsyDom should be set according to the language of the variant of WsyBase.

The version/level for each of the Websydian group models should be set to the newest.

If the iSeries platform is the target for the Websydian application, the version for WsyBase should be set to v.6.0 RPG.

The table below shows the newest version/level to use for each of the Websydian group models:

Group Model Version Level
WsyBase v.6.0 v.6.0
WsyVal v.6.0 v.6.0
WsyInteg v.6.0 v.6.0
WsySess v.6.0 v.6.0
WsyUser v.6.0 v.6.0
WsyUtil v.6.0 v.6.0
WsyAudit v.6.0 v.6.0
WsyPres v.6.0 v.6.0
WsyWap v.6.0 v.6.0
WapUtil v.6.0 v.6.0
WsyPortal v.6.0 v.6.0
WsyDom v.6.0 v.6.0
WsyXml v.6.0 v.6.0
WsySoap v.6.0 v.6.0
WsyShop v.6.0 v.6.0
WsyHttp v.6.0 v.6.0
WsyStruc v.6.0 v.6.0
SDString v.6.0 v.6.0

If the iSeries platform is the target for the Websydian application, the version for WsyBase should be set to v.6.0 RPG.

Generate and Build Library Objects

Most Websydian library models include a number of objects that are used directly by other pattern objects. These objects must be generated and built. In Websydian, these objects are included in an appropriately named subject area, e.g. AuditObjectsToGenAndBuild.

The following library models include objects that must be generated and built.

Library   Further information
WsyBase - Please refer to the Generate And Build Considerations document in the WsyBase section for details on which WsyBase subject areas should be generated and build.
WsyDom DOMObjectsToGenerateAndBuild Generate this if using TransacXML.
WsyXml XMLObjectsToGenerateAndBuild Generate this if using TransacXML (Requires WsyDom to be generated prior).
SchemaObjectsToGenerateAndBuild Generate if using the CreateSchema or CreateWSDL functions in TransacXML.
WsySoap SOAPObjectsToGenerateAndBuild Generate this if using TransacXML Web Services.
WSDLObjectsToGenerateAndBuild Generate if using the CreateWSDL function in TransacXML.
WsyHttp HTTPClientObjects Only generate and build this subject area if variant is set to Java. The Windows objects are supplied in a lib file (WsyHttpxxx.lib).

For CA Plex 5.5 and later this subject area should be generated in both the Windows and Java variants.

SDString SDStringObjsToGenerateAndBuild Generate this if using Windows or Java.
WsySess SessionObjectsToGenAndBuild Generate this if using the Session pattern.
WsyInteg IntegObjectsToGenerateAndBuild Generate this if using the Integrity pattern.
WsyUser UserObjectsToGenerateAndBuild Generate this if using the User pattern.
WsyUtil UtilObjectsToGenerateAndBuild Generate this if using the Utility patterns.
WsyAudit AuditObjectsToGenAndBuild Generate this if using the Audit pattern.
WsyWap WapObjectsToGenerateAndBuild Generate this if using the Websydian WAP patterns.

Runtime objects

When deploying a Websydian application, either for testing or production, various Websydian runtime objects are required for the application to run properly.

The runtime objects are located in the folder <Websydian Install Folder>\Deployment. Please consult the section that is relevant for your deployment environment.

All folder references in this section are relative to the Websydian Install Folder.

iSeries

The table below shows the objects that must be restored when deploying a Websydian application on an iSeries.

Folder File Description
Deployment\iSeries WSYD600.savf Contains the library WSYD600.
WSYD600ptf.savf Contains the library WSYD600PTF for future PTFs.
Deployment\iSeries\IFSObjects N/A Contains a folder structure that must be restored to the IFS if using DWA.

For more detailed instructions on how to install the Websydian iSeries runtime objects please refer to this document.

Windows

The table below shows the DLLs that must be deployed with a Websydian application on the Windows platform.

The DLLs can either be deployed in the same folder as the application DLLs or in a folder specified in the system path.

Folder File Description
Deployment\Dwa\dlls\PlexX.X WsydDwa21.dll Websydian DWA runtime. Required when the variant for WSYBASE is set to DWA - Windows.
Deployment\Xml\dlls\PlexX.X WsydXml11.dll Websydian XML runtime. Required when using TransacXML.

Java

The table below shows the jar files that must be specified in the classpath when launching a Websydian Java application. For more details on setting up the classpath please refer to this section.

Usage Folder File Description
DWA Deployment\Dwa\jars WsydDwa21.jar Java DWA runtime.
XML processing Deployment\Xml\jars WsydXml11.jar Websydian Java XML runtime including the Apache Xerces Java parser and the Apache Xalan XSLT processor.
WsydUtil.jar
xalan.jar
xercesImpl.jar
xml-apis.jar
Web service Deployment\Xml\jars commons-httpclient.jar HTTP client used when creating a web service client (SoapGenerator).
jsse.jar Used by the HTTP client for SSL communication. Do not include these jar files if using Java 1.4 or later.
jnet.jar
jcert.jar