This technical note describes how to use templates in Reflection for the Web 2011 and 2008 to custom web page with an embedded dynamic session, and to create a custom login/links list page.
Topics included in this technical note:
Reflection for the Web 2011 and 2008 R2 include an /rweb/templates folder with instructions on how to use templates (templates.txt). You can use the sample templates as a starting point for creating your own template.
Locate the templates folder:
The /rweb/templates/samples folder contains the following sample templates:
Review the sample templates, along with the comments, to see how you can include different features in your own template.
The following JSP code displays a simple custom page with an embedded Reflection for the Web session:
When creating your custom JSP page, consider the following points:
<%@ taglib uri="/WEB-INF/rweb.tld" prefix="rweb" %>
This line is required to generate the session's applet tag.
This tag inserts a Reflection applet tag as defined by the session record stored on the server. The tag is output as either the APPLET or OBJECT/EMBED element, based on the Applet tag option you selected on the General Settings page of the Administrative WebStation (Administrative WebStation > Tools > Settings > General tab). OBJECT/EMBED tag is the default option.
<rweb:param name="param_name" value="param_value"/>
For example, to embed a session that gets all of its attributes and parameters from the server's session record, but overrides the "hostURL" parameter, your custom page could include this element:
Uninstalling or upgrading Reflection for the Web may remove or overwrite the sample templates. If you use any of the samples as a starting template for your own page, copy and paste the template to a new file with a unique name, rather than using the sample as supplied.
Make a backup copy of all your template files, should you need them after upgrading.
To embed a dynamic Reflection session in a custom template page:
If you leave this field empty, the Reflection session is embedded in a simple HTML page that has a heading with the session's name. Also, if the specified template is not present, the default embedded page is used.
To use one of the sample templates, specify the template name as "samples/<templatename>.jsp".
You have created your custom session and can now make it available to your users.
If your template does not load as expected, try these troubleshooting ideas:
Check the location and the file name of the expected template.
To determine if there is a JSP error, review the trace.log file stored in the ReflectionData/log folder.
To create a custom login page, begin with the sample file, customloginpage.jsp, which you can modify. Then, edit your customized page to incorporate the elements that generate the Reflection applet tags.
The sample code includes these features:
Note: In Windows 7, the administrator needs permission to paste a file into the templates folder (because it is a subfolder under Program Files).
In the Custom login page field, enter the name of your renamed custom template .jsp file.
You should see the custom login page. After you log in, you will see the same customizations in the links list page.
Note: If your custom login page fails to compile, you will not be able to access the Administrative WebStation to fix the problem. To resolve the issue, rename or remove the custom login .jsp page. By renaming or removing the custom page, Reflection for the Web cannot find it and will use the default login page.
Note: In Windows 7, if you open the template file in Notepad to edit it, you may get an access denied error when you try to save it in that folder. As a workaround, copy the file to another location such as the desktop. Edit and save the file (using Notepad or another text editor), and then copy the file back to the templates folder.
The files may be overwritten the next time you upgrade Reflection for the Web, and you would need to copy them to the correct location after the upgrade.
Two additional template samples are presented in this section: Terminal and Printer JSP and Two Dynamic Sessions JSP. Review the code and the comments in the samples for potential use in your custom template.
The JSP code in this example shows how to embed a dynamic terminal session and a static printer session on the same page.
To use this template,
The IBM 3270 terminal session will be dynamically generated and inserted on the page where the <rweb:applet userequest="true"/> tag appears.
The IBM 3270 printer session is defined statically on the template page, as shown in the following sample code.
<%-- The taglib directive is required to use the rweb:applet tag below .--%>
<%-- The rweb:applet tag embeds the dynamic session on the page. The userequest="true" attribute says that all applet configuration information should come from the session record defined on the Reflection management server. Since each session record contains just a single Reflection session, only one of the applets (IBM 3270 terminal) can be generated dynamically from the server data. The other applet (IBM 3270 printer) is defined statically.
The single line below with userequest="true" is the simplest possible form of the rweb:applet tag. --%>
<%-- There is only one Reflection session per session record, so unless multiple sessions of exactly the same type are desired, any additional sessions must either be defined statically or start with the dynamic session and override attributes and parameters (as is done in the next sample).
Here, an IBM 3270 printer session is defined completely using the rweb:applet tag. You can also do this using the standard applet tag, but the custom rweb:applet tag generates the actual applet tag as either the APPLET or OBJECT/EMBED elements, depending on the setting in the Administrative WebStation's General Settings tab. Note that the syntax of the rweb:applet tag is a more strict XML-like syntax that requires a closing "/>" on each line. Also, parameter lines must start with "rweb:param" rather than just "param". --%>
The JSP code in this example shows how to embed two dynamic terminal sessions, each to a different host.
To use this template:
The IBM 3270 terminal session will be dynamically generated and inserted on the page where the <rweb:applet userequest="true"/> tags appear.
<%-- The taglib directive is required to use the rweb:applet tag below. --%>
<%-- The name of the dynamic session is set in the HTTP request attribute called "pagetitle". That value is used here to title the HTML page. --%>
<%-- The rweb:applet tag embeds the dynamic session on the page. The userequest="true" attribute says that all applet configuration information should come from the session record defined on the Reflection management server. Since each session record contains just a single Reflection session, both of the rweb:applet tags here create the same terminal session. However, the preconfigured session data can be overridden by adding standard applet attributes and parameters. If the rweb:applet tag contains any attribute or parameter overrides, the overrides are used instead of the data from the session record. Here, the preconfigured host is overridden in each session by specifying a different "hostURL" parameter. And, so that unique user preferences can be saved for each session, the "prefsName" parameter is overridden with a value that is different for each of the two sessions. All other attributes and parameters get their values from the management server's session record. --%>