action.skip

HTML 5 Web Application Properties

Use these properties to configure how you want the generated Web application to handle model connections, procedures, as well as screen and project properties. You can also customize HTML 5 web applications using project properties.

You can set these properties for HTML 5 web applications:

Procedure properties

You can create a custom output format for procedures.

By default all procedures are included in the Web application. You can exclude all procedures from the Web application, by clearing the Procedures checkbox. Selecting a table automatically selects all the procedures associated with that table. However, you must select procedures individually if you want to change their "Display" settings.

Default procedure settings

Display

  • Form - Select this option to have the procedure output display as an HTML form. Specify the display format for the output of the procedure. Choose either to:

    • Display outputs as table. A single table is generated containing columns for each of the procedure output parameters and rows for the values.
    • Display output as list. A separate table containing the procedure output parameters is generated for each value returned.

  • Screen - This option displays the screen where the the procedure ended as opposed to the procedure output. This is useful for procedures that are solely created to navigate to a location in the host application. The display for the specified screen is configured on the Screens tab.

  • Custom (legacy Web applications only) - Using this option you can take complete control of how the procedure output is handled in the Web application.

    Specify the URL of the page you want displayed when this entity is encountered. A relative URL is assumed to be relative to the root of the Web application and the page must be included with the Web application. You can do this manually or by using the Custom Content options.

If you want to return to a single format after having made changes to an individual procedure, click Reset all.

Model Features

These options are meant for testing purposes only and should not be enabled in production environments.

  • Execute SQL statement

    Select this option to have the Web application provide a user option to perform a query by typing in an SQL statement. To use this feature, the procedure must be configured as available for SQL queries.

  • ProcessString event handler

    Select this option to for users to provide a string for a Process String event handler within the Web application. This option requires that a ProcessString event handler is included in the model.

Model connection properties

When you select Model Connection Properties in the Project Properties dialog box, you can configure the settings below. These properties will vary depending on the project type you have selected.

Connect method

Select the appropriate connect method for your project:

  • Connect to model via server
  • Connect to model via domain
  • Connect to session pool via server
  • Connect to session pool via domain

Host Integrator model or session pool name

Select the model or session pool that is the basis of this Web Builder project.

Depending on the Connect method you select, these options are available:

  • Server - When connecting through the server, enter the name of the Host Integrator Server where the model is installed.

  • Management Server - When connecting via domain, enter the name of the server that is handling domain requests.

  • Domain - When connecting via domain, enter the name of the domain.

  • Obtain model data from Design Tool exported file - When creating a new project, you can use this option to select an exported XML model file. Enter the name of the file Web Builder is to use to generate the project, or click Browse to locate the XML model file.

  • Host settings - Select the host name and port number this model is using.

Screen properties

Use the Screens tab to configure how you want to handle unrecognized screens and to specify how to display recognized screens.

Unrecognized screens

If a model does not have defined entities for host application screens, specify how Host Integrator should handle these unrecognized screens.

Recognized screens (entities)

You can set up the way your web applications handle recognized screens (entities) on a global basis, or you can select individual entities and specify a a different display. You can use Reset All to return all recognized entities to the default values.

  • Form

    Web Builder generates a web application that handles the data fields differently than it handles the screen display. This is the default. The dynamic data on an entity (the defined attributes, recordsets, or operations) comes from the host application, and is updated as needed.

    The appearance of the user interface remains static and is generated into a web application that can be modified by a web designer

Common Terminal settings for both unrecognized and recognized screens (entities)

  • Enable Aid Keys

    Select this option to provide aid key functionality in your Web application. You can invoke Aid keys using either the F keys on your physical keyboard or by using the Aid key palette in your Web application. To display the Aid key palette, click Fn on the toolbar. Any host screen that is configured to display as a terminal has aid keys enabled by default. If you disable this option Enable Hotspots and Enable Light Pen Hotspots will also be disabled.

  • Enable Hotspots

    Hotspots are buttons that appear over common host commands in terminal sessions. Any host screen that is configured to display as a terminal has hotspots enabled by default. Selecting Enable Aid Keys is a prerequisite for using hotspots. See About Hotspots(/wb-hotspots/) for more information on this option.

  • Enable Light Pen Hotspots

    You can enable light pen support for all screens or individual screens configured to display as a terminal. By default, light pen support is not enabled. If you have HTML 5 web applications that were generated using past versions of Host Integrator, you must rebuild your project to enable light pen support. Selecting Enable Aid Keys is a prerequisite for using light pen hotspots. See About Hotspots for more information on this option.

Additional settings

  • Hide - Select this option to hide screens. Type in the text that is displayed with this terminal screen.

  • Error - Rather than display a screen, display an error message. You can configure the following:

    • Message to display - Type in the text that is displayed with this terminal screen.
    • Disconnect from the host - Select this option if you want the web application to disconnect from the host when the unrecognized screen is encountered.

HTML 5 project properties

You can generate an HTML 5 Web application, using project properties to determine what type of information to display. You can set default properties for each type of project, or set properties for specific individual projects.

Property Description
Include source code in archive (.jar) file Web Builder includes the source files with the compiled classes in the .jar file. By default, the source files are not included.
Generate javadoc documentation Web Builder generates JavaDoc documentation of the methods in your generated code. By default, these files are not included. The JavaDoc documentation is generated using the descriptions from the Procedure Editor; therefore, make sure the procedure descriptions are as complete as possible. See the Tables Overview for more information.
Java package name Create unique package names. This option is only available for individual projects.
Method timeout How long to wait for a method to complete before timing out. The default is 30 seconds
Locale The locale (or language) that the generated Java Beans use to communicate with the Host Integrator Server. Change this setting only if you provide locale-specific resources or files for the Host Integrator Server. The default uses the current operating system locale.
Require username and password Specifies whether generated Web applications use Host Integrator security to connect to the host. If you select this option, users are prompted for a valid user ID and password when a project attempts to connect to the host. Selecting this option does not override the security requirements for the application. An application that requires no security credentials will allow a user to continue without providing password information. Conversely, an application requiring security credentials will include a password prompt even if this option is not selected. Use this option, for example, when you generate a Web application using a server that does not have security enabled, but will be exporting that generated application to a system that does have security enabled.
Require encrypted connection to the VHI server This option uses a secure connection between the Web server and the Verastream Host Integrator session server. This option forces a secure connection even if the server setting is not set to require a secure channel. It is selected by default. This setting does not affect the client (browser) connection to the Web server, which is handled using the correct HTTPS port. Host Integrator session server HTTPS/HTTP connection settings for Web services are configured in the Administrative Console. See the online help topic, Setting Web Services Session Server Properties.

Customizing HTML 5 web applications

Use the Customization tab on the Project Properties dialog box to import custom content for your generated Web application. You can specify a directory location containing customized content which you can use for layouts and other display elements. For example, you can import custom pages, images,and additional support libraries.

Custom Content

Use this feature to import custom content and resources into your Web application. For example, you can import custom pages, images,and additional support libraries.

How does importing custom content work?

When a directory is specified, the contents of the specified directory is overlaid on top of the generated Web application before it is deployed. Files in the directory itself end up in the base of the Web application directory. Since all subdirectories are copied as well, a directory structure matching that of the Web application can be created, and you can import files into any area of the generated Web application. Existing files are overwritten with files from the custom content directory. The Web application automatically provides the same parameters to the custom page as it does to the generated page.

You can modify the generated Web application and utilize elements provided in the custom content to expand the Web application's functionality. When you rebuild the project, modifications are preserved and the custom content is included in the generated application.

To import custom content

  1. Create a directory in which to place your custom content. This is the source from which you will copy your custom content.
  2. In Web Builder, click Options >Customization >Custom Content. Specify the directory that you just created.
  3. Place a file, a collection of files, or an entire directory structure inside the source directory you created in step 1.
  4. Rebuild your project.

When the project rebuilds, the contents of the source directory is added to and deployed with your Web application. Each time you rebuild, the overlay directory is inserted into the built Web application.