Configuring Windows-based Sessions to Report to the Reflection Metering Server
Technical Note 2393
Last Reviewed 21-Nov-2013
Reflection for the Web 2014 (All Editions)
Reflection for the Web 2011 (All Editions)
Reflection Security Gateway 2014
Reflection Security Gateway 2011
Reflection Administrator 2011
Reflection for the Web 2008 (All Editions)
Reflection for IBM 2011
Reflection for IBM version 14.x
Reflection for UNIX and OpenVMS 2011
Reflection for UNIX and OpenVMS version 14.x
Reflection for HP with NS/VT version 14.x
Reflection X 2011
Reflection Suite for X 2011
Reflection X version 14.x
Reflection Suite for X version 14.x
EXTRA! X-treme version 9.3 or higher
INFOConnect version 9.2 or higher
This technical note describes how to configure Attachmate Windows-based sessions to report to the Reflection metering server, a web-based tool that is included in Reflection for the Web, Reflection Administrator, and Reflection Security Gateway.
Note the following:
- The term "Attachmate Windows-based products" refers to native Windows products, such as EXTRA! X-treme, INFOConnect, and Reflection, including Reflection for UNIX and OpenVMS, Reflection for IBM, and Reflection X.
- Web-based management is available to Reflection customers who have obtained the Reflection Administrator add-on component or Reflection Security Gateway for use with their Attachmate Windows-based products, or who have installed and configured Reflection for the Web with the appropriate licensing.
- If you are licensed for Reflection for the Web, you have the server components necessary to centrally manage Attachmate Windows-based sessions; however, you must still obtain the appropriate licensing to use the servers for web-based management of Attachmate Windows-based products. Licensing is provided by purchasing the Reflection Administrator add-on product.
If you do not have Reflection for the Web, you can obtain a copy of Reflection Administrator for web-based management of Attachmate Windows-based terminal emulation sessions. This gives you both the required Reflection servers, and a license to use the servers to manage Windows-based sessions.
- Attachmate Windows-based sessions are available only from Windows workstations that have the supporting Attachmate Windows-based emulation client software installed.
- Beginning Fall 2013, Reflection Security Gateway replaces Reflection Administrator.
Which Products and Versions Can Be Metered?
You can use the Reflection metering server to audit, control access to, and report the usage of the following Attachmate Windows-based products and versions. Note: Reflection FTP Client is not metered.
|Product and Version
|Reflection Standard Suite 2011 *
|Reflection for UNIX and OpenVMS 2011 *
|Reflection for UNIX and OpenVMS 14.x
|Reflection for HP with NS/VT 14.x
|Reflection for IBM 2011 *
|Reflection for IBM 14.x
|Reflection X 2011
|Reflection Suite for X 2011
|Reflection X 14.x
|Reflection FTP Client 14.x
* To meter the Reflection 2011 products, note the following:
- Reflection 2011 products require Reflection Administrator 2011 for metering support.
- Beginning with Reflection for the Web 2008 R3, the login/links list supports Reflection 2011 connections.
** Host connection tracking is not available for Reflection X 14.1 (Legacy Reflection X), and Reflection FTP Client applications included in Reflection X 2011 and Reflection Suite for X 2011. Metering is not available for Reflection X Advantage.
To meter Attachmate Windows-based sessions, you must:
Install and Configure the Metering Server
For information about installing and configuring the metering server, and viewing metering reports, see Technical Note 2189, Reflection for the Web Usage Metering Explained.
Once the metering server has been installed and configured, return to this technical note and proceed with Configuring Workstations to Report to the Metering Server.
Configuring Workstations to Report to the Metering Server
To configure Attachmate Windows-based products to report to the metering server, you can use the Attachmate Customization Tool, Attachmate Custom Installation Wizard, or Group Policy settings.
- For Reflection and INFOConnect, use the Attachmate Customization Tool to create a customized Reflection installation that includes metering configuration information. Use this tool to create custom transforms that can be used to enable metering when Reflection is deployed.
Note: The Attachmate Customization Tool can only configure settings at the time of installation; it cannot be used to update the URL after your customized installation is complete. (If you use Group Policies at your site, you will probably prefer to use that approach to configuring metering, as described below. Group Policy settings are easily updated, but can not be used to configure the Meter As property.)
- For EXTRA! X-treme, use the Attachmate Custom Installation Wizard. To enable usage metering in EXTRA! X-treme 9.3 or higher, follow the instructions in the EXTRA! Help Update at http://docs.attachmate.com/extra/xtreme/9.3/help/en/index.htm. Refer to the following section: Installation and System Requirements > Preparing the Installation > Customize the EXTRA! X-treme Installation.
- Use Group Policy settings to configure metering information, excluding the Meter As property. This technique is convenient if you use Active Directory or if you already have a Windows-based Reflection client installation base, as group policies can be used to modify existing installations, and can be easily updated.
Note: If you want to set the Meter As property to specify the products you are licensed for, you must use the Customization Tool. All other settings can be configured using Group Policies.
Reflection and INFOConnect - Using the Attachmate Customization Tool
You can use the Attachmate Customization Tool (Reflection 2011 or INFOConnect) or the Reflection Customization Manager (Reflection 14.x) to create a customized installation that automatically configures Reflection or INFOConnect workstations for metering.
In Reflection for the Web/Reflection Administrator Version 2011
- Run the Attachmate Customization Tool from the command line or create a shortcut point to it.
To access the Attachmate Customization Tool, you must have already set up an Administrative Installation. For more information about creating an administrative installation, see the "Perform an Administrative Installation" topic in the product guide for Reflection 2011: http://docs.attachmate.com/reflection/2011/r1/help/en/user-html/admin_install_image_pr.htm.
From the Command Line: At the command prompt or the Start menu Run command, enter the following command to open the Attachmate Customization Tool:
- Right-click the Setup.exe file and choose Create Shortcut.
- Right-click the shortcut and choose Properties.
- In the Target field, add /admin to the end of the target line (after the last quote mark):
For example: "C:\<path-to-setup>\setup.exe" /admin
Note: For Reflection 14.x, replace setup.exe with radmin.exe.
- Rename the shortcut as desired.
- Double-click the shortcut to run the Attachmate Customization Tool.
- In the Select Customization dialog box, choose to "Create a new Setup customization file" or "Open an existing Setup file or Companion installer," and then click OK.
- In the left pane, select "Licensing and session metering."
- Select "I accept the terms of the Software License Agreement."
- Entering a VPA number to identify the metered product is optional. The VPA number is necessary for monitoring Attachmate products that have different license pools under different VPA numbers. If you omit this value, the metering server uses a default value of zero for the VPA number.
- In the Meter As drop-down menu, select the product name.
- In the Metering URL field, enter the URL of your metering server.
http://[host name]:[port number]/[metering server context name]/meter.do
Note: If you used the default port, you can omit the colon and port number.
- Select "Require metering" only if you want to prevent users from launching Attachmate products when the metering server is not available. (Enabling this setting can be useful when you are creating a trial installation and want to test to see if the metering server is running and available.)
- Click File > Save As, name the transform file (*.mst), and then click Save.
- Test your customized installation. Because the metering web server URL that you specify becomes a permanent part of the Attachmate product installation, you should always test your customized Attachmate product installation carefully on a test workstation to ensure that the server is successfully monitoring Attachmate product activity on that workstation.
Reminder: The Attachmate Customization Tool can configure settings only at the time of installation; it cannot be used to update the URL after your customized installation is complete. (If you use Group Policies at your site, you may prefer to use that approach, since Group Policy settings are easily updated.)
- For information about how to deploy the transform while installing your Attachmate product, see the product's documentation.
Use Group Policy Settings
An alternative way to configure metering is to use Group Policy support. This technique is convenient if you use Active Directory and for existing Attachmate Web-based installations.
Note: If you want to set the Meter As property to specify the products you are licensed for, you must use the Attachmate Customization Tool. All other settings can be configured using Group Policies.
To configure Group Policies to meter Attachmate products, follow the instructions in the version-specific references: