Developing and deploying ZIETrans Web applications

Types of ZIETrans applications include: Web, EJB and administrative console. This chapter includes information about ZIETrans Web applications. For information about the other types of applications, see the following chapters:

ZIETrans applications are created from ZIETrans projects using the ZIETrans Toolkit. When you create a new ZIETrans project, a set of folders is created to help you organize your ZIETrans application files. An example of a default project is shown below. The highest level folder has the same name as the name you give to your project when you create it. In that folder are other high-level folders that contain objects defined in your ZIETrans project. Some folders do not appear until you create certain objects.

Figure 2. ZIETrans Web project view
ZIETrans Web project view

Depending on how you set up your ZIETrans project, some or all of these folders appear in the ZIETrans Projects view. You can also specify which folders appear in your ZIETrans Projects view as well as hide file extensions. For more information, see Using ZIETrans preferences.

Note:
Different folders appear for different types of ZIETrans projects. For example, the directory tree for a ZIETrans EJB project has no Screen Customizations, Screen Captures or Web Content folders.

You can create subfolders within these high-level folders to help organize your project. For instance, as you create screen captures for your project, you might want to create folders under the Screen Captures folder to organize and group the captured screens. To create a folder, right-click on one of the high-level folders in the tree and click New ZIETrans > Folder. To move a file into a different folder, right-click on the file and select Move, or you can use the drag-and-drop method.

Note:
There is a limitation for subfolders. The transformation and the template files must be in subfolders of the same level. In order to use a transformation that resides at a certain level of subfolders, such as \transformations\Callup\, then the template that will be coupled with this transformation must be at the same level of subfolders, like \templates\Callup\.

ZIETrans projects can be shared in a team environment by going to the Navigator View of your ZIETrans perspective. Right-click the project and select Team > Share Project. Select the repository type from the list and click Next. Rational® SDP supports several repositories. For more information, refer to the Rational SDP documentation and search on repository.

Note:
When using a version control system with your ZIETrans projects, set the system to ignore the resourceUpdate.sts file. This file is automatically generated when testing a project within the toolkit. The file should not be under version control and can safely be ignored or deleted before placing a ZIETrans project under version control.

To exclude the file from version control, open Window -> Preferences -> Team -> Ignored Resources and click Add Pattern to add a new pattern. Enter resourceUpdate.sts and click OK. Make sure the new pattern is selected in the list of ignored patterns and click OK to save the settings.

ZIETrans Web projects, created in ZIETrans Toolkit, are extensions of Web projects in the Rational SDP workbench. For more information, click Help > Help contents from the Rational SDP menu bar, expand Developing, and select Developing Web applications.

Organizing ZIETrans Web applications

By default, all ZIETrans Web applications are stored in one enterprise archive file, such as ZIETrans_EAR8. When you export your applications and deploy them on WebSphere® Application Server, the ZIETrans .ear file contains a Web archive (.war) file with the resources to run each application, as well as one copy of the ZIETrans runtime executable code. If you prefer, you can organize your applications differently, either each in its own .ear file, or in some other combination.

Consider the effect of the following on your server when deciding how to arrange your Web applications:

Disk space
If you create each application in its own .ear file, it has its own copy of the ZIETrans runtime code. The runtime code is approximately 25 MB; multiply that by the number of applications you have to see how much disk space is consumed on your runtime system for all of your applications.
Deployment
If you redeploy a ZIETrans .ear file, you are redeploying all the applications in that .ear file, even if some of the applications are unchanged.
Logging and tracing

Logging and tracing are controlled at the level of the .ear file, not at the individual ZIETrans application level. If each ZIETrans application is in its own .ear file, you can control its log and trace settings independently of any other applications. If you have several ZIETrans applications in one .ear file, log and trace settings apply to all ZIETrans applications in the .ear file. Messages for all ZIETrans applications in the .ear file are inserted into the same log file, and trace information for all ZIETrans applications is inserted into the same trace file.

You can add an additional optional keyword, traceLogDirectory, to the runtime.properties file. This enables you to specify a particular directory for the output files. The file is located in the was_dir/installedApps/ear_name directory for a ZIETrans enterprise application.

License tracking
License tracking is also controlled at the level of the .ear file, not at the individual ZIETrans application level. If each ZIETrans application is in its own .ear file, license tracking is done independently of other applications. If you have several ZIETrans applications in one .ear file, license tracking is performed for all ZIETrans applications in the .ear file. Information about license usage is kept for all ZIETrans applications in the .ear file, and is inserted into the same license usage file.

Moving ZIETrans Web projects to a different .ear file

Which .ear file your project files go into is determined when you create the project. After you create the project, you can move it from one .ear to another, using the following steps:

To add the project to an .ear file:

  1. Click the Navigator tab of the ZIETrans Toolkit to display the .ear files.
  2. Expand the .ear file to which you want to add the project. Expand the META-INF folder and locate the application.xml file.
  3. Start the Rational SDP application.xml editor by double-clicking the application.xml file.
  4. In the application.xml editor Design view, in the Overview group, select Application, and click Add.
  5. In the Add Item dialog, select Module and click OK.
  6. Select the project you want to add to the .ear file and click Finish.
  7. Close the Rational SDP application.xml editor.

To remove the project from an .ear file:

  1. Click the Navigator tab of the ZIETrans Toolkit to display the .ear files.
  2. Expand the .ear file from which you want to remove the project. Expand the META-INF folder and locate the application.xml file.
  3. Start the Rational SDP application.xml editor by double-clicking the application.xml file.
  4. In the application.xml editor Design view, in the Overview group, select the project you want to remove from the .ear file, and click Remove.
  5. Close the Rational SDP application.xml editor.

Backing up your ZIETrans projects

As with any software development activity, it is good practice to back up your ZIETrans projects to ensure against data loss or corruption. In addition to creating backups during your own development cycle, you should also create backups prior to installing ZIETrans maintenance. This allows you to revert to the previously installed maintenance level if necessary. To create a backup for your ZIETrans project, use the Rational SDP export archive file function. For more information, see Exporting a Web project.

To restore a ZIETrans project from a backup, use the import archive file function. For more information, see Importing a Web project.

Exporting and importing ZIETrans Web projects

Exporting a Web project

You can export your ZIETrans Web projects to save and use as backups or to move to another ZIETrans Toolkit system. To perform the export, use the following method:

Archive file

This function has multiple benefits. It allows you to export multiple projects and the associated .ear all at once. In addition, you do not have to create a project on the destination ZIETrans Toolkit before you import the archive file. To export the project as an archive file perform the following steps:

  1. From the menu bar select File > Export to open the Export wizard.
  2. Select General > Archive File and click Next.
  3. Select both the project and its associated EAR project.
  4. Specify a file name and location for the file in which to save the project.
  5. In the Options section, select the desired file format and compression options. To export the whole project, select Create directory structure for files.
  6. Click Finish.

Importing a Web project

To import a project in an archive file (or a project interchange file from an older release of Rational SDP) into ZIETrans Toolkit:

  1. From the menu bar click File > Import to open the Import wizard.
  2. Select General > Existing Projects into Workspace and click Next.
  3. Select the Select archive file option and click Browse to browse for the archive file.
  4. In the Projects section, select the project (or projects) you want to import.
  5. Click Finish.

After importing, if you get the following error:

Project 'xxxxx' is missing required source folder: 'Java Source'

The project cannot be built until build path errors are resolved

To fix this error perform these steps:

  1. Select the project in the ZIETrans Projects view.
  2. From the Rational SDP toolbar, select File > New > Other.
  3. On the "Select a wizard" page, expand General, select Folder, and click Next.
  4. Ensure that your project is selected as the parent folder.
  5. Enter Java Source as the folder name.
  6. Click Finish.

Deploying ZIETrans Web applications

The terms ZIETrans Web application, WebSphere application, and Java™ EE application can be used interchangeably to refer to a Web application created from a ZIETrans project. It is a ZIETrans Web application because it was developed in the ZIETrans Toolkit. It is a WebSphere application because it will be installed and run on WebSphere Application Server. It is a Java EE application because it conforms to the Java EE standards.

To deploy your ZIETrans Web application in a runtime environment you must:

The following sections describe how to perform each of these tasks.

Note:
ZIETrans Web applications can also be deployed to the Apache Geronimo web application server with the Tomcat web container, to the Oracle WebLogic Server, and to the IBM Bluemix Server. For information unique to developing and deploying ZIETrans web applications for these servers, see:

Enabling the ZIETrans runtime

Regardless of where you obtain the ZIETrans package (ZIETrans CD, Web, or packaged with another product), you install the same version of the ZIETrans Toolkit. This is a limited-use version that you can use to evaluate ZIETrans. To fully enable the runtimes for production in accordance with your licensed proof of entitlement, you must specify your license settings using the License Settings wizard included in the ZIETrans Toolkit. For more information see the section, Flexera Licensing integration for ZIETrans Projects, in ZIETrans Getting Started.

Exporting your project as a Java EE application

To deploy your ZIETrans Web application to a WebSphere Application Server runtime environment, you must first package it into a Java EE application. To do this, you export your project as an EAR file.

To export the project, follow these steps:

  1. Highlight (single-click) the name of your project in the ZIETrans Projects view.
  2. Click the Export ZIETrans Project icon on the main tool bar, or right-click the project name and select Export Project.
    Note:

    If you have not specified your license settings, you will see a message that the runtime for this project is not enabled. Although this application can be deployed, users are restricted to two connections.

    ZIETrans Web applications can be tested in a local test environment and deployed to a runtime (non-development) environment, but in either environment, these applications support only two host connections without specifying license settings. For information about specifying license settings, see Flexera Licensing integration for ZIETrans Projects in ZIETrans Getting Started.

    If licenses have been purchased, click Enable Runtime to runtime enable your application. Otherwise, click Continue to continue the export process.

  3. In the Export window, choose an Enterprise Application project from the drop-down list or type the name of an Enterprise Application project in the EAR project field.
  4. Enter a destination location in the Destination field or click the Browse button to select the destination of the exported .ear file.
  5. If you want to export the project's source files along with the executable files, select the Export source files box. If you include the source files, another developer can extract them from your .ear file. This can make collaboration or service easier, but you must decide whether it creates a security risk.
  6. If you have exported this project to this location before, the export process asks whether you want to overwrite the existing files. This is intended to protect you from overwriting files that you might want to keep, perhaps to archive a previous version of your project. If you want to overwrite previous files without being asked for confirmation, select the Overwrite existing file box.
  7. Click Finish. The project is exported as a Java EE application, represented by an Enterprise Archive file with extension .ear, with the directory and file name you specified.

Installing your application in a runtime environment

After exporting the ZIETrans project as a Java EE application and transferring the application's .ear file to the production system, install it by launching the WebSphere administrative console and browse to the location of the .ear file. For more information about installing applications on WebSphere Application Server refer to the WebSphere Application Server library at http://www.ibm.com/software/webservers/appserv/was/library/ and select the link to the Knowledge Center for your version of WebSphere Application Server. In the contents under your WebSphere Application Server product, refer to the chapter about deploying applications.

After the application has been installed, test it by bringing up the URL in a Web browser on another system. Then you can publish the URL to your users. As an example, the URL might look like http://hostname/ZIETransappname/ where hostname is the IP host name and domain where WebSphere Application Server is installed and ZIETransappname is the name of your ZIETrans application.

Notes:
  1. For more information about installing ZIETrans applications on specific platforms, see the ZIETrans Infocenter at https://zietrans.hcldoc.com/help/index.jsp.
  2. If your ZIETrans applications are deployed on WebSphere Application Server with Java 2 security enabled, and they do not start, see Java 2 security for more information.
  3. ZIETrans supports multiple browser instances from the same workstation accessing the same ZIETrans application. However, these multiple browser instances must not share the same HTTP session id.

    The session between the browser accessing the ZIETrans application and the WebSphere Application Server is assigned an HTTP session ID. The HTTP session ID enables subsequent requests from the same browser to return to the same ZIETrans application. Subsequent requests use the same Telnet (3270 or 5250) session that exists between the ZIETrans application on the server and the host.

    Different browsers implement the HTTP session ID differently. Microsoft Internet Explorer expects all browser sessions in the same process to share the same HTTP session ID. When you launch a new browser window using the same shortcut, a new browser session starts and shares the same process and the same HTTP session ID.

    One way to open a new Internet Explorer process with a unique HTTP session ID, in Windows XP for example, if Internet Explorer is in your start list, is to select Start > Internet Explorer. Selecting Start > All Programs > Internet Explorer also starts a new Internet Explorer process with a unique HTTP session ID.

    Notes:
    1. The Ctrl-N function of Internet Explorer does not start a new process, because it opens a new window that has the same process ID and the same HTTP session ID as the window from which it originated.
    2. For Internet Explorer 8, you can use File > New Session to open a new browser with a unique session ID.
    Note:

    In Internet Explorer, you can find the HTTP session ID for a browser window by selecting View > Source from the menu bar, or right-clicking in the Internet Explorer browser window and selecting View Source to view the source tagging for the page. Scroll down to the ZIETrans Form tag in the source window. Within that Form tag, find the SESSIONID parameter, which is similar to the following:

    <INPUT TYPE="HIDDEN" NAME="SESSIONID" 
    VALUE="PIOncS1GehNWxWo_49VCBzC" />
    Note:
    When you access a ZIETrans application that only displays a default transformation of the screen and doesn't run macros when it starts, the SESSIONID has a value of "INVALID." The SESSIONID value is assigned when you send something to the host, such as pressing the Enter key, and you get a response.

    You can verify whether a new process is being started by using Task Manager in Windows. Start Task Manager, and click the 'Image Name' column heading on the Processes tab to sort the information by image name. Scroll down to see how many 'iexplore.exe' processes are in the list. Try starting some new Internet Explorer windows using the Start > Internet Explorer shortcut. If a new process is started, a new iexplore.exe process is added to the display. Otherwise, an existing process is in control of the new browser window.

  4. ZIETrans requires the application's display-name, as defined in the application's web.xml file, to match the Web application's context path used in the browser URL. If the display-name value is changed to be different than the context path of the application, you might encounter a java.lang.nullPointerException error or a javax.servlet.ServletException error when running the ZIETrans application. For example, a ZIETrans project named MyZIETransProject defaults to a display-name of MyZIETransProject. This project, when deployed as a Web application, must be reached with a URL similar to http://myServer/MyZIETransProject/ to operate properly. Changing the display-name to something other than MyZIETransProject causes the application to be inoperable.

Changes necessary in the runtime environment

Configuring class loader policy

When you deploy your ZIETrans Web applications, or when running the applications in the local test environment, the WAR class loader policy must be configured on a per Java EE application basis for either of the following situations:

ZIETrans automatically configures the class loader policy for these applications.

Configuring ZIETrans applications in a clustered environment

If you deploy ZIETrans Web applications in a vertically clustered environment, each application server instance will create its own files for logging, tracing, and license tracking. This is accomplished by decorating the names of the output files with the fully qualified name of the application server instance. For example, the default pattern for the logging file is messages.txt, but the actual file name will be something like messages_myCell_myNode_myAppServerInstance_1.txt.

By default, all of the server instances read the same runtime.properties file for their settings. To properly control runtime settings you must configure each instance to have its own runtime properties file. This enables you to control tracing for each instance independently, and prevents runtime settings from changing spontaneously.

Follow these steps to configure each of your vertically clustered ZIETrans application instances to have its own runtime.properties file:

  1. Make a copy of the runtime.properties file for each application server instance in the vertical cluster.
    1. Locate the runtime.properties file for your ZIETrans application. This file should reside in the installedApps\app_name.ear directory under the directory where you installed WebSphere Application Server.
    2. For each instance, make a copy of the runtime.properties file, with a unique name, in the same directory. For example, you might name the files Clone1runtime.properties, Clone2runtime.properties, and so on. You can use any valid file name, but the name should help the administrator identify the application server instance with which this file is associated.
    3. At this point, for n server instances you have n unique runtime properties files.
    4. If you have more than one ZIETrans .ear file in your vertically clustered environment, repeat this step in each .ear file directory.
  2. Add a new configuration setting to identify the runtime.properties file that is used by each instance. For example, for WebSphere Application Server V6.x:
    1. Select Application Servers in the Servers item in the left navigation pane of the WebSphere Application Server administrative console.
    2. Select the server instance from the list of application servers.
    3. Select Java and Process Management from the Configuration tab for the server.
    4. Select Process Definition > Java Virtual Machine > Custom Properties.
    5. In the Custom Properties window, click New.
    6. In the Name field, enter zietrans.runtime.properties.
    7. In the Value field, enter the name of the properties file that you created for this server, for example, Clone2runtime.properties. Do not specify directory names or slashes in this value.
    8. The Description field does not require a value.
    9. Click Apply.
    10. Repeat this procedure for each server instance.

After adding the new custom property and ensuring that each server instance has its own, uniquely named, copy of the runtime.properties file, you must restart each application to begin using the new files.

The ZIETrans administrative console can be used to control the settings of the cluster members. Use the Getting Started folder in the Navigation panel of the Administration Web page to select the Management Scope. After you have chosen the cluster, choosing to view the Trace Settings will prompt you for the particular cluster member you want to control.

Note:
There are special considerations for the use of clustering and user lists. For more information, see Clustering and user lists

Configuring ZIETrans applications to use a proxy server

If users access your ZIETrans application through a proxy server, you must configure both the proxy server and a context parameter in the ZIETrans application.

To configure the proxy server:

  1. On the proxy server, locate the httpd.conf file.
  2. Using a text editor such as Notepad, add the following two lines to the file:
    ProxyPass /application_name/ http://yyyy:port/application_name/
    ProxyPassReverse /application_name/ http://yyyy:port/application_name/

Where application_name is the name of your ZIETrans application, yyyy is the fully-qualified IP address of the application server where the ZIETrans application is installed, and port is the port number.

To configure the context parameter in the ZIETrans application:

  1. Edit the web.xml file of the ZIETrans application (located in the Web Content\WEB-INF folder in the Navigator view).
  2. Add the following context parameter:
    <context-param>
      <param-name>com.ibm.hats.proxyURL</param-name>
      <param-value>http://myproxyserver.com:port/application_name</param-value>
    </context-param>

Where myproxyserver.com is the url of the proxy server, port is the port number, and application_name is the name of your ZIETrans application.

Developing ZIETrans applications for the Apache Geronimo Server

You can develop, test, and deploy ZIETrans web applications targeted for the Apache Geronimo web application server with the Tomcat web container. For detailed information about Apache Geronimo, including documentation and downloads, see the Welcome to Apache Geronimo site at http://geronimo.apache.org .

Installing and configuring for Geronimo servers

This section describes a summary of how to install Apache Geronimo and configure Rational Software Delivery Platform (Rational SDP) to enable creating ZIETrans web applications targeted for Apache Geronimo servers:

Download and install the Apache Geronimo server with the Tomcat web container:

  1. Download Apache Geronimo from the Download site at http://geronimo.apache.org/downloads.html.
  2. Install the server by extracting the .zip or .tar files.
  3. Run the server from a command line window by changing the directory to geronimo_home/bin and entering the command: geronimo run.

The Geronimo Eclipse Plugin (GEP) provides integration between Eclipse, its Web Tools Platform (WTP) project, and Geronimo that enables you to utilize WTP features to develop, test, and deploy applications for the Apache Geronimo server using Rational SDP.

Install the Geronimo Eclipse Plugin (GEP):

  1. Follow the instructions on the Installing Geronimo Eclipse Plugin site at https://cwiki.apache.org/GMOxDOC22/installing-geronimo-eclipse-plugin.html.
  2. GEP v2.2 includes server adapters for v1.1.x, v2.0.x, v2.1.x, and v2.2 Apache Geronimo servers.

Configure Geronimo as a target server in Rational SDP for ZIETrans web applications:

  1. On the Rational SDP menu bar, click Window > Preferences.
  2. In the left panel, expand Server.
  3. Click Runtime Environments.
  4. In the Server Runtime Environments panel, click Add.
  5. In the New Server Runtime Environment dialog, expand the Apache folder.
  6. Select the appropriate version of the Apache Geronimo server.
  7. Optional. Select the Create a new local server box to create a new Geronimo server on your workspace Servers tab. Doing this step enables you to test your Geronimo application within the Rational SDP local test environment using the Run on Server, Debug on Server, and Profile on Server functions.
  8. Click Next to go to the panel where you point to your local Geronimo server. In the Application server installation Directory field enter the root folder where you extracted the Geronimo server files. For example, if you extracted your Geronimo server zip to a folder named C:\geronimo-tomcat6-javaee5-2.1.7, enter this value in the installation directory field.
  9. Click Finish.
  10. Click OK to close the Preferences panel.

After following these steps, you can create ZIETrans applications within Rational SDP targeted for Apache Geronimo servers.

Considerations and limitations for Geronimo servers

There are some different considerations between developing, testing, and running ZIETrans web applications on Apache Geronimo server versus WebSphere Application Server. For example, only one ZIETrans web application is supported per .ear file running on an Apache Geronimo server.

Developing ZIETrans applications for Oracle WebLogic Server

You can develop, test, and deploy ZIETrans web applications targeted for the Oracle WebLogic Server. For detailed information about Oracle WebLogic Server, including documentation and downloads, see the Oracle web site at http://www.oracle.com/technetwork/middleware/weblogic/overview/index.html .

Installing and configuring for WebLogic servers

This section describes a summary of how to install Oracle WebLogic Server and configure Rational Software Delivery Platform (Rational SDP) to enable creating ZIETrans web applications targeted for Oracle WebLogic Server:

Download and install the Oracle WebLogic Server using download links and instructions on the Oracle site at http://www.oracle.com/technetwork/middleware/weblogic/downloads/index.html.

Install the Oracle WebLogic Server tools in RAD versions that are earlier than 9.0:

  1. On the Rational SDP menu bar, click Help > Install New Software.
  2. Click Runtime Environments.
  3. In the Server Runtime Environments panel, click Add.
  4. Click Download additional server adapters.
  5. Select Oracle WebLogic Server Tools from the list and click Next.
  6. Accept the terms of the licensing agreement and click Finish.
  7. When prompted to restart after the installation completes, click OK.
  8. After the installation completes, when prompted to restart now, click Yes.

Install the Oracle WebLogic Server tools in RAD 9.0:

  1. On the Rational SDP menu bar, click Window > Preferences.
  2. In the upper right panel, clickAvailable Software Sites.
  3. Click Add.
  4. Enter the following information to add the required repository:

    Name: Oracle Enterprise Pack for Eclipse Repository

    Location: http://download.oracle.com/otn_software/oepe/12.1.2/juno/repository

  5. Click OK.
  6. Enable the following additional repositories in the Available Software Sites list, or add them if you do not have them:

    Name: Eclipse Juno repository

    Location: http://download.eclipse.org/releases/juno

    Name: Eclipse Web Tools Platform Repository

    Location: http://download.eclipse.org/webtools/updates/

  7. Click OK to close the Preference window.
  8. Select the Contact all update sites during install to find required software check box.
  9. Select Work With > Oracle Enterprise Pack for Eclipse Repository.
  10. Expand the results and select the Oracle WebLogic Server Tools check box.
  11. Click Next.
  12. Follow the instructions in the wizard to complete the installation.

Install the Oracle WebLogic Server tools in RAD 9.7:

  1. On the Rational SDP menu bar, click Help > Eclipse Marketplace.
  2. In the Find textbox, search for WebLogic.
  3. Install the Oracle WebLogic Server Tools.
  4. Click Confirm on the Confirm Selected Features panel.
  5. Read and accept the terms of the licensing agreement and click Finish.
  6. After the installation completes, click Yes when you are asked if to restart.

Configure WebLogic as a target server in Rational SDP for ZIETrans web applications:

  1. On the Rational SDP menu bar, click Window > Preferences.
  2. In the left panel, expand Server.
  3. Click Runtime Environments.
  4. In the Server Runtime Environments panel, click Add.
  5. In the New Server Runtime Environment dialog, expand the Oracle folder.
  6. Select the appropriate version of the Oracle WebLogic Server.
  7. Optional. Select the Create a new local server box to create a new WebLogic server on your workspace Servers tab. Doing this step enables you to test your WebLogic application within the Rational SDP local test environment using the Run on Server, Debug on Server, and Profile on Server functions.
    Note:
    If you perform this step, you must modify the default Publishing mode so that your projects will deploy correctly when using the Run on Server, Debug on Server, and Profile on Server functions.
    1. Find the instance of the WebLogic Server that was created in the Servers view.
    2. Right-click on the WebLogic Server and click Properties.
    3. In the left panel, expand WebLogic.
    4. Click Publishing.
    5. In the Publishing mode section, click Publish as an exploded archive.
    6. Click OK to close the Properties panel.
  8. Click Next to go to the panel where you point to your local WebLogic server. In the WebLogic home field enter the root folder where you installed the WebLogic server. For example, if your WebLogic installation uses the root folder named C:\Oracle\Middleware, enter C:\Oracle\Middleware\wlserver_12.1 in the WebLogic home field. If you installed the JDK that was included with the WebLogic server installer then the JAVA home field should be filled in automatically with a value such as C:\Oracle\Middleware\jdk160_29. If you did not install the included JDK then you must enter into the JAVA home field the appropriate location of the JAVA runtime being used.
  9. Click Finish.
  10. Click OK to close the Preferences panel.

After following these steps, you can create ZIETrans applications within Rational SDP targeted for Oracle WebLogic Server.

Considerations and limitations for WebLogic servers

There are some different considerations between developing, testing, and running ZIETrans web applications on Oracle WebLogic Server versus WebSphere Application Server. For example, only one ZIETrans web application is supported per .ear file running on an Oracle WebLogic Server.

Developing ZIETrans applications for IBM Bluemix Server

You can develop, test, and deploy ZIETrans web applications targeted for the IBM Bluemix Server. For detailed information about IBM Bluemix Server, including documentation, see the Bluemix web site at http://www.ibm.com/cloud-computing/bluemix/.

Configuring Rational SDP for IBM Bluemix server

This section describes how to configure Rational Software Delivery Platform (Rational SDP) to enable creating ZIETrans web applications targeted for IBM Bluemix server.

Configure IBM Bluemix server as a target server in Rational SDP for ZIETrans web applications:

  1. On the Rational SDP menu bar, click Window > Preferences.
  2. In the left panel, expand Server.
  3. Click Runtime Environments.
  4. In the Server Runtime Environments panel, click Add.
  5. In the New Server Runtime Environment dialog, expand the IBM folder.
  6. Select IBM Bluemix Runtime.
  7. Optional: Select the Create a new local server box to create a new Bluemix server on your workspace Servers tab. Doing this step enables you to test your Bluemix application within the Rational SDP local test environment using the Run on Server, Debug on Server, and Profile on Server functions.
  8. Click Next to go to the panel where you enter your Bluemix account details. Enter your Bluemix account email address and password and validate the account.
  9. Click Next to go to the panel where you get Organizations and Spaces. Select the space you want.
  10. Click Finish, and then click OK to close the Preferences panel.

After following these steps, you can create ZIETrans applications within Rational SDP targeted for IBM Bluemix Server.

Considerations and limitations for IBM Bluemix Server

There are some different considerations between developing, testing, and running ZIETrans web applications on IBM Bluemix Server versus WebSphere Application Server.

Log file location in Bluemix server:

/home/vcap/app/wlp/usr/servers/defaultServer/apps/myapp.ear/logs/

Basically, you can observe the path of trace file in the Bluemix server console (ZIETrans studio console) as given below:

SystemOut  O HAT0002
The message log file is:
/home/vcap/app/wlp/usr/servers/defaultServer/apps/
      myapp.ear/logs/messages_XXXXXXXX_XX.txt

To view log files using Bluemix website:

To view log files using Rational SDP Remote Systems View:

Notes:
  1. While adding Bluemix Runtime in Rational SDP, you might see the following error:

    java.lang.ClassNotFoundException:
    Cannot find the specified class com.ibm.websphere.ssl.protocol.SSLSocketFactory

    The workaround for the SSLSocketFactory error message is to look for the com.ibm.ws.ast.st.core.prefs file available in x:\workspace\.metadata\.plugins\org.eclipse.core.runtime\.settings, where x:\workspace is the directory of your workspace, and replace isUseIBMSSLSocketFactory=true value with 'false'. Then, restart the workbench.

  2. Exceptions in Bluemix console while deploying ZIETrans ear in Bluemix Server:
    FFDC1015I: An FFDC Incident has been created:
    "com.ibm.wsspi.adaptable.module.UnableToAdaptException:
    com.ibm.ws.javaee.ddmodel.DDParser$ParseException:
    CWWKC2262E: The server is unable to process the 7 version and the
    http://xmlns.jcp.org/xml/ns/javaee namespace in the /META-INF/application.xml
    deployment descriptor on line 2.
    com.ibm.ws.app.manager.ear.internal.EARDeployedAppInfoFactoryImpl 132"
    at ffdc_15.09.11_05.03.09.0.lo ..... 
    By Default ZIETrans applications are created using J2EE 7 version for Bluemix server, so you can set the following environment variable in your ZIETrans Bluemix application in order to include a major subset of the Java EE 7 feature set. You can then add or remove additional features as needed. While deploying ZIETrans application in Bluemix server you can configure this environment variable.
    name: JBP_CONFIG_LIBERTY
    value: app_archive: {features: [ webProfile-7.0, cdi-1.2, jaxrs-2.0, 
    jpa-2.1, websocket-1.1, servlet-3.1, jsp-2.3, ejbLite-3.2 ]} 

.

Developing ZIETrans applications for Web Sphere Application Server Liberty Porfile

You can create ZIETrans applications within Rational SDP targeted for WebSphere Application Server Liberty Profile by following the steps below:

  1. On the Rational SDP menu bar, click Window > Preferences.
  2. In the left panel, expand Server.
  3. Click Runtime Environments.
  4. In the Server Runtime Environments panel, click Add.
  5. In the New Server Runtime Environment dialog, expand the IBM folder.
  6. Select WebSphere Application Server Liberty Profile.
  7. Optional: You can test your Liberty Profile application within the Rational SDP local test environment using the Run on Server, Debug on Server, and Profile on Server functions. Select the Create a new local server box to create a new Liberty Profile server on your workspace Servers tab.
  8. Click Next to go to the panel where you point to your local Liberty Profile server. Click the Choose an existing installation radio button and enter the location where you have WebSphere Application Server Liberty Profile installed in the Path field.
    Note:
    If you do not have installed a Liberty Profile server installed, you can install one directly from the New Server Runtime Environment dialog box. The steps are listed below.
    1. Click the Install from an archive or repository radio button.
    2. Click Next to go to the Install Runtime Environment panel.
    3. Enter a path such as C:\Liberty in the Enter the destination path field.
    4. Click the Download and install a new runtime environment from ibm.com radio button and select IBM WebSphere Liberty Repository in the drop down menu.
    5. Select one of the WAS Liberty servers listed that include the runtime features, such as WAS Liberty V8.5.5.7 Runtime, and click Next.
    6. Choose any additional bundles you want on the Install Additional Content panel and click Next.
    7. Accept the terms of the licensing agreement and click Finish.
  9. Click Finish.
  10. Click OK to close the Preferences panel.

Considerations and limitations for WebSphere Application Server Liberty Profile

When using Debug on server to test your application, a display issue might occur on the terminal window. You might receive the following error message:

ERROR HPS5018 An unexpected exception has occurred.
  Frame unable to display: java.awt.HeadlessException.

If this error occurs in the console, you can fix this problem by following these steps.

  1. In the ZIETrans Projects view, open the Servers tab.
  2. Right-click on the WebSphere Application Server Liberty Profile server listed and click on New > Server Environment File > jvm.options.
  3. Add the value to the file:
    -Djava.awt.headless=false
  4. Save and close the jvm.options file.
  5. Restart the server to activate the changes.

Developing ZIETrans applications for the JBoss EAP Server

You can develop, test, and deploy ZIETrans web applications targeted for the JBoss Enterprise application server. For detailed information about Jboss EAP, including documentation and downloads, see the Red Hat JBoss Enterprise Application Platform Overview site at https://developers.redhat.com/products/eap/overview .

Installing and configuring JBoss EAP

Configure JBoss EAP as a target server in Rational SDP for ZIETrans web applications:

  1. On the Rational SDP menu bar, click Window > Preferences.
  2. In the left panel, expand Server.
  3. Click Runtime Environments.
  4. In the Server Runtime Environments panel, click Add.
  5. In the New Server Runtime Environment dialog, expand the Red Hat JBoss Middleware folder for JBoss EAP.
  6. Select the appropriate version of the JBoss Enterprise Application server.
  7. Optional. Select the Create a new local server box to create a JBoss server on your workspace Servers tab. Doing this step enables you to test your JBoss application within the Rational SDP local test environment using the Run on Server, Debug on Server, and Profile on Server functions.
  8. Click Next to go to the panel where you point to your local JBoss server. In the Application server installation Directory field enter the root folder where JBoss server is installed. For example, if JBoss server is installed in a folder named C:\EAP-7.1.0, enter this value in the installation directory field.
  9. Click Finish.
  10. Click OK to close the Preferences panel.

After following these steps, you can create ZIETrans applications within Rational SDP targeted for JBoss servers.

Considerations and limitations for JBoss servers

There are some different considerations between developing, testing, and running ZIETrans web applications on JBoss server versus WebSphere Application Server. For example, only one ZIETrans web application is supported per .ear file running on a JBoss server.

Developing ZIETrans applications for mobile devices

You can develop ZIETrans Web applications that can be accessed by mobile devices such as cellular phones, data collection terminals, and personal digital assistants (PDAs). The process is the same as developing any ZIETrans Web application with some considerations due to the capabilities of the mobile device and its Web browser, for example screen size and interaction limitations.

To create a project for your application for mobile devices, launch the Create a Project wizard using one of the following actions:

In the Create a Project wizard, on the ZIETrans Project panel:

  1. Enter a name for the mobile device project.
  2. Optionally, enter a description.
  3. Accept the default location.
  4. Select Web to indicate this is a Web project.
    Note:
    If the Web deployment option is disabled, this indicates that no server runtimes are defined. To define server runtimes, go to Window > Preferences > Server > Installed Runtimes and add at least one runtime definition.
  5. For the Target server field, select one of the supported WebSphere Application Servers.
  6. For the Enterprise application project field, enter the name of the EAR project to use for testing in the local test environment.
  7. Select Optimize options for mobile devices.
    Note:
    If you are developing a ZIETrans application for an iPad device, do not select this option. For more information see Considerations and limitations for iPad devices.
  8. Click Next and continue creating your project as normal.

Considerations and limitations for mobile devices

When you create a ZIETrans project and select Optimize options for mobile devices, ZIETrans initializes the project with options that work best for mobile devices. Some options, for example, printing, keyboard, asynchronous update, and other options, are not supported and therefore disabled. Keep in mind the following considerations and limitations as you develop your application for mobile devices.

In addition to options that ZIETrans automatically disables, the following functions are not supported and should not be implemented in ZIETrans applications for mobile devices:

Considerations and limitations for iPad devices

Your ZIETrans application may appear or behave differently on iPad devices compared to other mobile devices because of differences such as screen size and web browser. Because the iPad device includes a large screen relative to some other mobile devices, it works better with applications that are not created with options optimized for mobile devices. When creating a ZIETrans web project for an iPad device, do not select the Optimize options for mobile devices option.

Considerations and limitations for Android devices

Your ZIETrans application may appear or behave differently on Android devices compared to other mobile devices because of differences such as screen size and web browser. If the screen size of your Android device is small, you might consider creating a ZIETrans mobile project rather than a ZIETrans web project for use with your device. This might provide a better user experience for a smaller screen. For more information, see Developing ZIETrans applications for mobile devices.