Deploying with ApplinX


Deploying an ApplinX Application

When placing the ApplinX application on the target server for the first time, it is necessary to export both the application configuration and the entities. Once the ApplinX application has been created on the target server, it is only necessary to export the entities.

Note:
When there are changes in the configuration, you may need to delete the ApplinX application and import it again or manually make the configuration changes on the target server.

Start of instruction setTo deploy the ApplinX application

  1. Export the ApplinX application's configuration and entities (refer to Exporting an Application Configuration or Entities). A GXAR file is created in the defined target folder.

  2. Import the exported file to the target ApplinX server (refer to Importing an Application Configuration or Entities).

    Note:
    In the production environment it is possible to use the export file as a read only repository.

  3. Confirm that the option to trace files is disabled (refer to Application Properties>Host Tab Parameters>Record section). It is recommended not to produce trace files when in production, as this can affect performance.

  4. Edit and configure the log settings (refer to Server Properties>Log). It is recommended to set the Log Level field to Warning.

  5. When relevant, follow the steps detailed in Deploying an ApplinX Web Application.

Deploying ApplinX Server as a WAR File (Java Web Archive)

graphics/j2eeServerOnly.png

Start of instruction setTo deploy the ApplinX Server as a WAR File (Java Web Archive)

  1. Right-click on the relevant application and choose Deployment Manager for J2EE.... The Deployment Manager wizard is displayed.

    graphics/deployw1.png

  2. Ensure that the ApplinX server option is selected.

  3. Click Next. The Select ApplinX Applications screen is displayed.

    graphics/deployw2.png

  4. Select the Web applications to deploy.

  5. Select the Export Software AG's proprietary Web Services component (WS-Stack) when using Web services, and WS-Stack has not already been installed.

  6. Click Next. The Select Package Parameters screen is displayed.

    graphics/deployw3.png

  7. From the list of Application Servers select the server to which you are going to deploy ApplinX server.

  8. Enter the WAR file name, the destination folder where the output file will be placed and the JDK folder (ensure that the JAVA_HOME parameter points to the JDK installation folder).

  9. Click Next. The Configure ApplinX Server on Target Machine screen is displayed.

    graphics/deployw4.png

  10. In this screen, configure the ApplinX server parameters to be used on the target machine: the ports, and the license file.

Deploying an ApplinX Web Application (JSP) as a WAR File (Java Web Archive)

graphics/j2eeWebAppOnly.png

Start of instruction setTo deploy the Web application:

  1. Right-click on the relevant application and choose Deployment Manager for J2EE.... The Deployment Manager wizard is displayed.

    graphics/deployw1JSP.png

  2. Ensure that the ApplinX for JSP Web application option is selected.

  3. Click Next. The Select ApplinX Application screen is displayed.

    graphics/deployw2JSP.png

  4. Select whether to deploy a new application or HTML emulation, or a project from within the workbench, or a project from a different location.

  5. Select Include source files to include the Java files as well as the compiled classes. Click Next. The Select Package Parameters screen is displayed.

    graphics/deployw3.png

  6. From the list of Application Servers, select the server to which you are going to deploy ApplinX server.

    Enter the WAR file name, the destination folder where the output file will be placed and the JDK folder (ensure that the JAVA_HOME parameter points to the JDK installation folder).

    Note:
    When selecting WebLogic, you need to manually extract the content of the generated ZIP archive file.

  7. Click Next. The Select Target ApplinX Server screen is displayed.

    graphics/deployw4JSP.png

  8. In this screen, enter the ApplinX server and the port with which the Web application will connect. Also enter the ApplinX application name.

  9. Click Finish.

  10. In the console area, it is possible to see whether the process succeeded or failed. The WAR file created should be placed in your Web server directory.

Start of instruction setConsider changing the following for production use

  1. Change the framework logging according to your needs either by accessing the "Framework Configuration Editor" or in config/gx_logConfig.xml file. For example:

    <category additivity="false" name="com.sabratec">
              <level value=" ERROR"/> <!-- Sets the log to Errors only -->
               <appender-ref ref="FRAMEWORK_LOG"/>
    </category>
    
    

    Possible values are:

    • INFO - Normal

    • WARN - Warnings

    • ERROR - Errors only

    • DEBUG - Debug

  2. Disable the Performance monitor either by accessing the "Framework Configuration Editor" or in config/gx_appConfig.xml file set the WritePerformanceLog to false (this is the default configuration).

  3. Disable the Javascript log using the config/gx_clientConfig.xml by setting LogLevel to 0 and ShowLogConsole to false (this is the default configuration).

  4. Remove "Framework Configuration Editor" link from index page: delete the folder z_admin and remove the link to "configuration editor" from the index page.

Deploying an ApplinX Web Application (JSP) together with ApplinX Server as a WAR File (Java Web Archive)

This deployment type is typically used when the server and application are to be deployed to the same machine under a Java Application Server. This kind of configuration as the ApplinX server and the Web application share the same memory. Refer to supported application servers within Recommended Software.

graphics/j2eeBoth.png

Start of instruction setTo deploy both the ApplinX server and JSP Web application

  1. Right-click on the relevant application and choose Deployment Manager for J2EE.... The Deployment Manager wizard is displayed.

    graphics/deployw1a.png

  2. Ensure that the Both - ApplinX server and JSP Web application option is selected.

  3. Click Next. The Select ApplinX Application screen is displayed.

    graphics/deployw2a.png

  4. Select the ApplinX application to deploy. Click Next. The Select ApplinX Web Application screen is displayed.

    graphics/deployw2JSP.png

  5. Select whether to deploy a new application or HTML emulation, or a project from within the workbench, or a project from a different location.

  6. Select Include source files to include the Java files as well as the compiled classes. Click Next. The Select Package Parameters screen is displayed.

    graphics/deployw3.png

  7. From the list of Application Servers select the server to which you are going to deploy ApplinX server.

    Enter the WAR file name, the destination folder where the output file will be placed and the JDK folder (ensure that the JAVA_HOME parameter points to the JDK installation folder).

    Note:
    When selecting WebLogic, you need to manually extract the content of the generated ZIP archive file.

  8. Click Next. The Configure ApplinX Server on Target Machine screen is displayed.

    graphics/deployw4.png

  9. In this screen, configure the ApplinX server parameters to be used on the target machine: the ports, and the license file.

  10. Click Finish.

  11. In the console area, it is possible to see whether the process succeeded or failed. The WAR file created should be deployed to your Java Application Server.

Start of instruction setConsider changing the following for production use

  1. Change the framework logging according to your needs either by accessing the "Framework Configuration Editor" or in config/gx_logConfig.xml file. For example:

    <category additivity="false" name="com.sabratec">
              <level value=" ERROR"/> <!-- Sets the log to Errors only -->
               <appender-ref ref="FRAMEWORK_LOG"/>
    </category>
    
    

    Possible values are:

    • INFO - Normal

    • WARN - Warnings

    • ERROR - Errors only

    • DEBUG - Debug

  2. Disable the Performance monitor either by accessing the "Framework Configuration Editor" or in config/gx_appConfig.xml file set the WritePerformanceLog to false (this is the default configuration).

  3. Disable the Javascript log using the config/gx_clientConfig.xml by setting LogLevel to 0 and ShowLogConsole to false (this is the default configuration).

  4. Remove "Framework Configuration Editor" link from index page: delete the folder z_admin and remove the link to "configuration editor" from the index page.

Note:
When connecting to an external application server (any server that is not Tomcat), the changes performed in the Designer will not be saved.

Deploying an ApplinX Web Application (.NET)

Note:
ApplinX framework supports .NET clustering in a Web farm environment.

Start of instruction setTo deploy the Web application

  1. Copy the entire Web application into a temporary working folder.

  2. In the config/gx_logConfig.xml file edit the Logger settings according to your needs (enable/disable the log, target path and log level). For example:

    <logger name="com.sabratec">
              <level value="INFO"/> <!"sets the log to normal mode
              <appender-ref ref="FRAMEWORK_LOG"/>
    </logger>
    

    When you do not require the performance log, ensure that the last two category nodes in the XML file are commented.

  3. Change the definition of designMode in config/gx_appConfig.xml to "false".

  4. Change the definition of the serverURL and applicationName in config/gx_appConfig.xml to the target server.

  5. Copy the updated folder to the relevant Web server.

  6. Map this folder as a virtual directory under the server.

Deploying and Running an ApplinX Application on IIS

Note:
See Software Requirements for supported versions.

The following pre-installation steps are only required the first time.

  1. Download and install the Microsoft Visual J# 2.0 Redistributable Package, Second Edition (X64). You can find it under http://www.microsoft.com/en-us/download/confirmation.aspx?id=15468.

  2. Open the Windows Add/Remove Programs on Windows 7 or the Server roles on the Windows Server and select the web server (IIS) component and add to the server the following components:

    1. Security:

      Basic Authentication
      Client Certificate Mapping Authentication
      Digest Authentication
      IP security
      Request Filtering
      IIS Client Certificate Mapping Authentication
      URL Authorization
      Windows Authentication

    2. Application Development Features (Web-App-Development Component)

      .NET Extensibility
      ASP
      ASP.NET
      CGI
      ISAPI Extensions
      ISAPI Filters
      Server Side Includes

    3. Common HTTP Features (Web-Common-Http Component)

      Static Content
      Default Document
      Directory Browsing
      HTTP Errors

  3. From Windows Add/Remove Features, also add the Microsoft .NET Framework. See Software Requirements for supported versions.

After deploying the ApplinX application on the IIS server using the ApplinX Web manager, perform the following steps:

  1. Open the IIS Manager

  2. Under Site > Default Web Site, convert the virtual directory created by the ApplinX Web Manager to Application.

  3. Change the Application pool to Classic .NET AppPool.

  4. Add to the default documents section the index.aspx page.

  5. On the security page, add write-permission to IIS users.