MapInfo Location Intelligence Component

Transcription

1 MapInfo Location Intelligence Component version 1.0 for Business Objects ADMINISTRATION GUIDE

2 Information in this document is subject to change without notice and does not represent a commitment on the part of the vendor or its representatives. No part of this document may be reproduced or transmitted in any form or by any means, electronic or mechanical, including photocopying, without the written permission of Pitney Bowes MapInfo Corporation, One Global View, Troy, New York Pitney Bowes MapInfo Corporation. All rights reserved. MapInfo and the Pitney Bowes MapInfo logo are trademarks of Pitney Bowes MapInfo Corporation and/or its affiliates. Corporate Headquarters: Phone: Fax: Sales: Government Sales: Technical Support: Contact information for all Pitney Bowes MapInfo offices is located at: Products named herein may be trademarks of their respective manufacturers and are hereby recognized. Trademarked names are used editorially, to the benefit of the trademark owner, with no intent to infringe on the trademark. November 2007

3 Table of Contents Part 1: Getting Started Chapter 1: Getting Started With the Location Intelligence Component Overview Customizing the LIC For Your Business Needs Configuring Locale Settings Configuring the Drill Tool Using Sample Data Configuring User Groups for Mapping Reports Configuring your Application Server for Optimal Performance Setting Default JVM Heap Sizes Typographical Conventions Terminology Chapter 2: Map Displays on Dashboards Web Page Analytics Creating a Web Page Analytic Understanding the Report URL Parameters Understanding Map Display Positioning and Sizing Understanding Anti-Aliasing Sample Report URLs for Web Page Analytic Maps Optional Configurations for Map Displays Part 2: Configuring Reports and Maps Using Managed Beans. 31 Chapter 3: Data Binding and Theming Managed Beans Overview of the bifaces-config File About the Syntax Locale Managed Beans Data Binding Managed Beans External Match Managed Beans Location Intelligence Component v1.0 3

4 Table of Contents Internal Match Managed Beans Geographic External Bind Managed Beans Theming Managed Beans Ranged Theme Managed Beans Fixed Range Theme Managed Beans Individual Value Managed Beans Charting Managed Beans Pie Chart Theme Managed Beans Stacked Bar Chart Theme Managed Beans Side-by-Side Bar Chart Theme Managed Beans Zoom Distance Managed Beans Chapter 4: Customizing Data Binding and Theming Understanding Binding Creating Universes Binding Internal Data Binding External Data Additional Binding Customizations Overriding the Drill Hierarchy Defining the Zoom Range on Labels Customizing the Default Zoom Levels on Labels Customizing Generic Report Styles for Layers Understanding Custom Thematics Theme Types Applying Colors to Themes Disabling Auto-Theming on Maps Creating Ranged, Fixed Range and Individual Value Themes Creating Individual Value Themes Creating Ranged Themes Creating Fixed Range Themes Creating Themes Using Named Styles Creating Pie and Bar Chart Themes Combining Multiple Types of Themes Chapter 5: Global Map Settings and Managed Beans Overview of the mapxtreme-mapping-faces-config File Beans that Handle Basic Mapping Settings About the Syntax Map Settings Beans Chapter 6: Customizing Global Map Settings and Defaults Organizing Your Mapping Layers Setting a Custom Map Size Administration Guide 4

5 Table of Contents Customizing the Image Format Customizing the Default Theme Creating a Custom Layer Customizing the Default Legends Customizing the Selection Tools Customizing Zoom Distances on Maps Customizing the Click Tolerance on Map Tools Configuring Printers Index of Managed Beans Index Administration Guide 5

6 Table of Contents 6 Administration Guide

7 Part 1: Getting Started

8 8 Location Intelligence Component v1.0

9 Getting Started With the Location Intelligence Component 1 This part of the Location Intelligence Component Administration Guide gives an overview of the Location Intelligence Component (LIC). It also provides details on configuring the LIC and your application server for optimal performance with Business Objects. In this chapter: Overview Customizing the LIC For Your Business Needs Configuring your Application Server for Optimal Performance.13 Typographical Conventions Terminology

10 Overview Overview The Location Intelligence Component (LIC) for Business Objects provides a interface between Business Objects and MapXtreme Java. The result is a visual, geographic representation of a Business Objects report using an interactive mapping page and tools to manipulate the map. LIC uses two configuration files to present data on maps: mapxtreme-mapping-faces-config bifaces-config These two XML files both use a JSF configuration structure. The mapxtreme-mapping-faces-config file defines general mapping parameters such as map size and width, mapping tool properties and default theming. The bifaces-config file is primarily a sample file that allows you to define custom data binding and custom themes between MapInfo and Business Objects. Customizing the LIC For Your Business Needs This section includes the following information on processes that significantly improve the performance of the LIC: Configuring Locale Settings on page 10 Configuring the Drill Tool on page 11 Using Sample Data on page 11 Configuring User Groups for Mapping Reports on page 12 Configuring Locale Settings The LIC for Business Objects supports the following 8-bit languages for language and number format settings: Dutch English French German Italian Spanish Swedish Note The accompanying LIC documentation is only available in English. Business Objects locale preferences can be set in a variety of ways: Through the server s operating system Through each workstation s operating system Through the Business Objects User Preferences, where a language is specified Through the Business Objects User Preferences, where Infoview is directed to accept the browser s locale 10 Location Intelligence Component v1.0

11 Chapter 1: Getting Started With the Location Intelligence Component The LIC supports Business Objects locale settings using the localeprovider managed bean in the bifaces-config file. Locale and language settings are inherited from the InfoView Preferences. Since the setting My interface locale is automatically draws the browser s locale language and number settings (as illustrated below), the LIC automatically applies the browser s locale language and number settings to the mapping interface. While no changes are necessary for language support to be applied, your users can select a specific language on their InfoView Preferences from the list of supported locales above; just as Business Objects is updated to reflect the selected language, so also the LIC interface automatically reflects a supported language selection. Configuring the Drill Tool The LIC toolbar offers a Drill tool that functions similarly (but not identically) to Business Objects's native drilling tool. Using an external match bean in the bifaces-config file, you can override drill paths or you can set the tool to drill to specific custom reports, if desired. To custom define drilling for your users reports, configure the drillpath property and the drillreport property, found by default in the regionnamesexternalmatch managed bean. This is an optional configuration, where you can update one or both properties, as desired. For more information on configuring this bean and its properties for drilling, see the section Overriding the Drill Hierarchy on page 74. Using Sample Data The LIC CD provides a Data directory of sample data for the purpose of simulating reporting and mapping in Business Objects immediately after product installation. This Data directory contains basic data on US state, county and Zip code boundaries, as well as some city-level data. This data is meant to be used to validate the installation against the Business Objects tutorial data sample Administration Guide 11

12 Customizing the LIC For Your Business Needs configurations in the default bifaces-config file and is used by the default named layers and basemap installed in your /resources directory. The bifaces-config file also contains a sample universe called efashion, which includes basic data bindings on Store Name, City and Postal Code dimensions. Testing the reporting and mapping capabilities allows you to confirm that the installation was successful and lets you practice using the LIC tools before you begin working with real Business Objects data. Once you have tested your newly-installed product against the sample data, you can either delete the Data directory or you can retain these files for future use. You can use this sample data three ways: Familiarize yourself with creating additional named resources using Map Manager Configure a custom basemap or layers using the mapxtreme-mapping-faces-config file Configure additional bindings and themes using the bifaces-config file If you decide to continue using the sample data to test against your company s configurations, there are a variety of suggested implementations provided in this guide. For information on testing your installation against the sample data, see the Location Intelligence Component Installation Guide. Configuring User Groups for Mapping Reports By default, the LIC allows all users to view report data in a table format as well as geographically on a map. However, some companies require restrictions on this functionality, where only those users included in a defined User Group can map reports. This section explains how to configure an existing Business Objects User Group. Once the User Group is configured in the LIC, only users included in this group have access to the mapping capability; all other users are excluded. In this case, the interface offered to excluded users displays disabled Map mode and Map & Report mode buttons. You can configure multiple User Groups for mapping, if required. Note The User Group must exist in Business Objects before you can configure it for mapping. To configure an existing User Group for mapping reports: 1. Shut down your application server. 2. Open the lic.properties file in a text editor (for example, Notepad). This file is found in <domain-directory>\configs 3. Replace the default value Mapping with the name of an existing User Group, where users whom you want to provide the mapping functionality are defined: mappinggrouplist=acmemapping 4. If you want to define multiple User Groups, separate each group with a pipe character: mappinggrouplist=acmemapping AcmeAdmin 5. Save the lic.properties file and close it. 6. Restart your application server to recognize the changes. 12 Location Intelligence Component v1.0

13 Chapter 1: Getting Started With the Location Intelligence Component The LIC now offers the mapping feature only to users defined in this User Group; the mapping menu commands are disabled on an excluded user s Business Objects toolbar, as illustrated below. Configuring your Application Server for Optimal Performance Setting Default JVM Heap Sizes The Java Virtual Machine (JVM) uses multiple predefined memory spaces for various types of memory management. The main space used by the LIC is heap size. You should set the default size for this space to optimize your LIC performance. For most installations, configure your application server to use 512 MB of heap space. This section provides instructions for updating the recommended values for each of the supported application servers. For more information on setting default JVM heap sizes, visit the following web sites: For information on Tomcat application servers, visit For information on WebSphere application servers, visit For information on WebLogic application servers, visit Administration Guide 13

14 Configuring your Application Server for Optimal Performance For Tomcat application servers To increase the heap size for a Tomcat application server: 1. Open the catalina.bat file or the catalina.sh file to set the heap size, found at Tomcat/bin/catalina.bat 2. Add one of the following lines near the top of the catalina script of Tomcat that runs the LIC. For UNIX environments: CATALINA_OPTS=" -Xms512m -Xmx1024m" For Windows environments: set CATALINA_OPTS=-Xms512m -Xmx1024m 3. Restart Tomcat for the changes to take effect. For WebLogic application servers To increase the heap size for a WebLogic application server: 1. Update the heap size to Xmx512m in the startweblogic.cmd script on Windows or startweblogic.sh script on UNIX. This file is located in the following directory, where <WebLogic_home> is the directory where WebLogic is installed: <WebLogic_home>\weblogic92\<server name>\domains\wl_server\bin 2. Edit your custom domain s startup script (that is, the MEM_ARGS setting) as follows: set MEM_ARGS= -Xmx1024m 3. Restart WebLogic for the change to take effect. For WebSphere application servers 1. Start and log on to the WebSphere administrator console. The default URL is 2. Expand the Servers item on the left-hand pane and select the server hosting the LIC. 3. Scroll down the Additional Properties menu under the Application Server page and select Process Definition. 4. Scroll down the Additional Properties menu under the Process Definition page and select Java Virtual Machine. 5. On the Java Virtual Machine page, set the Maximum Heap Size property to Apply and save all changes. 7. Restart the server for the change to take effect. 14 Location Intelligence Component v1.0

15 Typographical Conventions Chapter 1: Getting Started With the Location Intelligence Component This guide uses the following typographical conventions. Text Formatting <angle brackets> Italics Courier Bold Meaning Angle brackets are used for text that acts as a placeholder for information you provide. For example, <string@string> represents an address. You should replace string@string with the actual address. Italicized formatting is used for book titles (for example, User Guide). Courier font is used for text that you type (for example, a directory path or a URL). Bold formatting to indicate an instruction (for example, clicking a button, selecting an option or pressing a key). Bold is also used to differentiate a directory from a file, in directory structure illustrations. Terminology The following table provides definitions for all abbreviations, acronyms, and definitions of common location intelligence terminology used in this guide. Term bifaces-config binding external binding external match internal match internal binding Definition XML-based configuration file where business intelligence-related settings are defined. These settings are defined via JSF managed beans. The combination of grid data and a spatial datasource to display report information on a map. Binding can be internal (that is, all data for the bind is found within a single report) or external (where the datasource for example, a TAB file is separate from the report). Defines how to perform a binding between a report and a spatial data source. Administration Guide 15

16 Terminology JavaServer Faces (JSF) label layer legend managed bean theme Term thematic display thematic mapping Definition A specification that defines an SDK/framework for building Java-based web applications. JSF is a component of the J2EE specification as of version 1.4. A text annotation of an object on a map, such as the name of a street. The basic building blocks of maps in MapInfo products. A map typically consists of several superimposed layers (for example, a layer of street data superimposed over a layer of county or ZIP code boundaries). Each layer contains uniquely specific data, and they can be viewed, hidden, and rearranged as needed depending on the desired view. Describes the different graphic styles or colors used to show data in a thematic map display, such as different colors to show different populations per State. A Java class with getters and setters by JSF to simplify configuring a web application via the faces-config.xml file. The process of shading a map according to a particular theme. The theme is usually based on a specific element of data. Thematic mapping allows visualization and trend highlighting in report data that would be less clear visually through a table, graph, or chart. The most common example of a thematic map is a weather map, where areas shaded red are hot and areas shaded blue are cool or cold. Themed data displays range from colored areas, pattern-filled areas, or various symbols. 16 Location Intelligence Component v1.0

17 Map Displays on Dashboards 2 In addition to being able to view maps in a desktop environment, your users can also view maps on a single dashboard or in a web page analytic. This chapter provides details on customizing map displays in the dashboard environment. In this chapter: Web Page Analytics Understanding the Report URL Parameters Understanding Map Display Positioning and Sizing Understanding Anti-Aliasing Sample Report URLs for Web Page Analytic Maps Optional Configurations for Map Displays

18 Web Page Analytics Web Page Analytics The Location Intelligence Component (LIC) lets you present your mapped report data in dashboard panes called Web Page Analytics. Unlike regular Business Objects dashboard map presentations, an LIC Web Page Analytic provides a map view only; the report view remains hidden. The LIC s Web Page Analytics are based on a URL. You can construct a URL to create three distinct mapping pane presentations: A basic map A map with a mapping toolbar 18 Location Intelligence Component v1.0

19 Chapter 2: Map Displays on Dashboards A legend The type of pane presentation is drawn from the appropriate JSF page. For a basic map, your URL uses the MapImage.jsf; for a map with controls you include the midashboard.jsf; legends reference the LegendImage.jsf. The next section provides details on how to create an LIC Web Page Analytic. For more details on the URL parameters, see the section Understanding the Report URL Parameters on page 23. Administration Guide 19

20 Web Page Analytics Creating a Web Page Analytic To create an LIC Web Page Analytic: 1. In Performance Management, click the My Dashboards tab. 2. Click the dashboard tab on which you want to create your new Web Page Analytic. In the illustration below, the tab Acme Sales is selected. 3. On the selected dashboard tab, click the Customize link. 20 Location Intelligence Component v1.0

21 4. In the Analytics List, browse to the option Web Page Analytic. Chapter 2: Map Displays on Dashboards 5. Drag the Web Page Analytic option onto the dashboard. 6. On the Web Page Analytic toolbar, click the Edit button. Administration Guide 21

22 Web Page Analytics 7. On the Content tab, enter the URL to the report, with any required formatting parameters, in the Enter the web page URL field. For a list of valid parameters and their uses, see the table Report URL Parameters on page Click OK. 9. Your new map appears on the dashboard. 10. Resize the image as follows: Resize the map using the URL parameters on the Content tab. Resize the Web Page Analytic pane using the Grid Size, Snap to Grid and Template tools. 11. When you are satisfied with your map, click the Apply & Close link. The map is now available to your users for viewing. 22 Location Intelligence Component v1.0

23 Understanding the Report URL Parameters Chapter 2: Map Displays on Dashboards Every Business Objects report displayed in a Web Page Analytic has a report URL. Associated maps are dependent on the parameters in the report URL. Using the report URL parameters, you can customize the map positioning, which mapping theme to use and whether to apply anti-aliasing. The table below provides a description for all valid parameters in a report URL. The sections following the table offer more details on how to use the parameters, both individually and in combinations. To view sample URLs, see the section Sample Report URLs for Web Page Analytic Maps on page 26. Report URL Parameters Parameters Description reportid mapid antialias column mapheight mapwidth The unique identifier for a Business Objects report. This parameter is required and is automatically generated by Business Objects; all other parameters are optional. To access the reportid parameter, click the report Properties link on the InfoView list of reports and view the properties this parameter is named the Document ID. The unique map identifier used to bind a report to a map and a map to a legend. Valid values are 1 and greater. The rendering quality of the map. This parameter only applies when MapXtreme is used to render map images. By default, the parameter is set to false; to activate, set the parameter to true. Identifies the column in the report against which to apply a theme on the map. Valid values are columns representing metrics and custom themes. The height of the map image in pixels. This parameter is defined in combination with the mapwidth parameter. The width of the map image in pixels. This parameter is defined in combination with the mapheight parameter. Administration Guide 23

24 Understanding the Report URL Parameters Report URL Parameters(continued) Parameters Description center position The geographic centroid for map display, defined in the format <longitude> <latitude> <coordsys> (for example, &center= epsg:4326). A shortcut parameter that combines a zoom and a center variable, defined in the format <center>@<zoom> (for example, &position = epsg:4326@ mi) Note The LIC does not currently recognize the zoom variable in this parameter. Understanding Map Display Positioning and Sizing You can impose a variety of positioning parameters on your users map displays, depending on your company s requirements. Most positioning parameters are defined as part of a paired combination. There are several possible configuration options for positioning the map display: Use the default mapheight and mapwidth Define a custom mapheight and mapwidth Define a map position parameter By default, maps present all geographic objects identified in the report. Note Once you have your map positioned and sized in the dashboard, we recommend you test how the report and map wraps in PDF. This is especially important if your users do not have report editing rights. 24 Location Intelligence Component v1.0

25 Chapter 2: Map Displays on Dashboards Understanding Anti-Aliasing Anti-aliasing is a graphics filter operation that smooths out jagged lines and label images on maps, improving their appearance on the web. The process uses graduated shading in the pixellation, rather than the stark black to white shading. For example, the map on the left does not use antialiasing. On the right is the same map, with anti-aliasing applied. Notice how the roadways and the labels are softened, making them easier to view and read, and therefore more visually appealing. Anti-aliasing is most effective when used with map images that contain many curved lines, irregular region areas and text objects. There are several benefits to anti-aliasing: Smoother fonts More rounded edges in maps Text appears more like printed type Anti-aliasing requires a slightly longer processing time, so the antialias property is set to false by default. To take advantage of anti-aliasing on your users maps, include the antialias parameter in the report URL, as described in the Report URL Parameters table. Administration Guide 25

26 Sample Report URLs for Web Page Analytic Maps Sample Report URLs for Web Page Analytic Maps This section provides a series of sample report URLs using combinations of the parameters listed in the Report URL Parameters table. A unique mapid, mapwidth and mapheight parameters are defined for most of the samples here. The sizing parameters produce compact maps and are useful if you have more than one pane on your dashboard; for a single map, you can refine the parameter settings to suit the particular map. Typically, a base URL would include a unique mapid and sizing parameters. Default mapid This sample demonstrates a mapid that uses the reportid value, by default. /desktopmaps/jsp/mapimage.jsf?reportid=2654&mapwidth=300&mapheight=300 Defining a Unique mapid This sample demonstrates a user-defined mapid value. /desktopmaps/jsp/mapimage.jsf?reportid=2654&mapid=01&mapwidth=300 &mapheight=300 Adding a Toolbar This sample demonstrates a map bind that adds the mapping toolbar to the panel. /desktopmaps/jsp/midashboard.jsf?reportid=2654&mapid=16&mapwidth=300 &mapheight=300 Defining a Map Center This sample demonstrates a map center tied to a latitude/longitude location. /desktopmaps/jsp/mapimage.jsf?reportid=16794&mapid=3333&mapwidth=300 &mapheight=300&center= epsg:4326 Defining a Map Location This sample demonstrates a simplified version of the sample above, using the location parameter rather than the zoom and center parameters. Note The LIC does not currently recognize the zoom variable in this parameter. /desktopmaps/jsp/mapimage.jsf?reportid=16794&mapid=3332&mapwidth=300 &mapheight=300&position= epsg:4326@ mi Defining a Theme on a Column of Report Data This sample returns a map image using a default theme on the Revenue column of report data. 26 Location Intelligence Component v1.0

27 Chapter 2: Map Displays on Dashboards /desktopmaps/jsp/mapimage.jsf?reportid=2654&column=revenue&mapwidth=300 &mapheight=300 Including a Map Legend This sample returns a map in one pane and its associated legend in a second pane. You must identify the map with which the legend is associated. In addition, since legends are always associated with themed maps, you must identify the report column on which you want the theme. /desktopmaps/jsp/mapimage.jsf?reportid=2654&column=revenue&mapwidth=300 &mapheight=300 /desktopmaps/jsp/legendimage.jsf?reportid=2654&mapid=22&column=revenue &mapwidth=300&mapheight=300 Applying Anti-Aliasing This sample returns a map image with anti-aliasing applied. /desktopmaps/jsp/mapimage.jsf?reportid=26548&mapwidth=300&mapheight=300 &antialias=true Optional Configurations for Map Displays You can use several parameters to further define your map image in your report. The default theme is defined in the mapxtreme-mapping-faces-config file, while custom themes are defined in the bifaces-config file. You may also want to change the image format (the default mimetype is GIF) to see if this improves your image quality. However, this is a global change and affects all images, so you should test other images to confirm that you have not introduced a more serious problem with this change. See the section Customizing the Image Format on page 133 for more information about this configuration. Finally, you can use Map Manager to create custom styles for your map images, using the styles provided in the directory /resources/customstyles. For information on custom styles, see the Location Intelligence Component Map Manager Guide. Advanced Theme Properties In this section, tables of advanced theme properties are provided for customizing your maps. You can customize range colors, styles, distribution types, and the number and size of your theme ranges using these properties. For example, the following example defines an Equal Range theme with four ranges using a yellow to blue color scheme. /desktopmaps/jsp/mapimage.jsf?reportid=5207&mapwidth=400&mapheight=300 &begincolor=yellow&endcolor=blue&distributiontype=equalrange&numranges=4 For more information on any of these themes or their properties, see the section Theming Managed Beans on page 52. Administration Guide 27

28 Optional Configurations for Map Displays Ranged Theme Properties Property Description basestyle begincolor beginstyle distributiontype endcolor endstyle numranges The name of a style to be used as the base style for all theme ranges. The color to use for the first range. The color must be a java.awt.color constant (for example: black, blue, cyan, darkgray, gray, green, lightgray, magenta, orange, pink, red, white, or yellow). The named style you want to use for the first range. The type of distribution you want to use in your theme (Equal Count, Equal Ranges, Natural Break, Standard Deviation or Custom Ranges). The color to use for the last range. The color must be a java.awt.color constant (for example: black, blue, cyan, darkgray, gray, green, lightgray, magenta, orange, pink, red, white, or yellow). The named style you want to use for the last range. The total number of ranges to create for your custom theme. Fixed Range Theme Properties Property Description basestyle colorn The name of a style to be used as the base style for all theme ranges. The color to use for range N, where N is a 0-based number (for example: color0=blue, color1=red). The color must be a java.awt.color constant (for example: black, blue, cyan, darkgray, gray, green, lightgray, magenta, orange, pink, red, white, or yellow). rangen The upper-bound breakpoint you want to use for range N, where N is a 0-based number (for example: range0=10000, range1=20000). stylen The named style you want to use for range N, where N is a 0-based number. 28 Location Intelligence Component v1.0

29 Chapter 2: Map Displays on Dashboards Individual Value Theme Properties Property Description basestyle colorn The name of a style to be used as the base style for all theme values. The color to use for value N, where N is a 0-based number (for example: color0=blue, color1=red). The color must be a java.awt.color constant (for example: black, blue, cyan, darkgray, gray, green, lightgray, magenta, orange, pink, red, white, or yellow). stylen The named style you want to use for value N, where N is a 0- based number. valuen The specific value from the column you are creating a theme on for which you want to create a custom style, where N is a 0-based number. Legend Properties Parameter Description width height format The width in pixels for your legend image. The height in pixels for your legend image. The file format (mime-type) to use to render the legend (png, jpg, or jpeg). Administration Guide 29

30 Optional Configurations for Map Displays 30 Location Intelligence Component v1.0

31 Part 2: Configuring Reports and Maps Using Managed Beans

32 32 Location Intelligence Component v1.0

33 Data Binding and Theming Managed Beans 3 This chapter identifies all managed beans involved with data binding between the LIC and Business Objects, and all defined and sample managed beans useful for theming. The binding and theming beans are defined in the bifacesconfig file, in a prescribed order. However, this chapter provides details on these two types of beans separately, for clarity. As a result, this chapter is divided as follows: Data Binding Locale Managed Beans Data Binding Managed Beans Internal Match Managed Beans External Match Managed Beans Geographic External Bind Managed Beans Theming Theming Managed Beans Ranged Theme Managed Beans Fixed Range Theme Managed Beans Individual Value Managed Beans Charting Managed Beans Pie Chart Theme Managed Beans Stacked Bar Chart Theme Managed Beans Side-by-Side Bar Chart Theme Managed Beans

34 Overview of the bifaces-config File Overview of the bifaces-config File The bifaces-config file is a skeletal xml file. This file contains two required managed beans and a subset of sample beans on which you can build your customizations. These beans define the information needed to map Business Objects reports to geographic data. Several sample beans are included in this guide which are not defined in the bifaces-config file; you can add any of these beans to the file, in any order. We recommend you maintain a logical order, where the binding beans and the theming beans are separated but all associated elements remain together. Note This file contains paths that must match the local installation of the Location Intelligence Component (LIC). Understanding the Managed Bean Hierarchy The following illustration demonstrates the nesting of managed beans in the sample bifaces-config file, provided with the LIC. The bitool managed bean and the universes managed bean are required for data binding. The bitool bean references the universes bean, which you can build from the sample provided. From there, you can define any number of internal binding and external binding beans your company requires. Within the file, the theme beans should be organized within the associated match or binding beans, but all associated themes should remain together, for simplicity. The instances, naming conventions, and hierarchy of your managed beans will vary depending on the customization performed. - localeprovider - bitool + universes + XtremeSampleUniverse (sample) + externalmatches + countriesexternalmatch (sample) + geocontent - countriesgeoparams (sample) + regionsexternalmatch (sample) + geocontent - regionsgeoparams (sample) + postalcodesexternalmatch (sample) + geocontent - postalcodesgeoparams (sample) + efashion (sample) + externalmatches + storesexternalmatch (sample) + geocontent - storesgeoparams (sample) + citiesexternalmatch (sample) + geocontent - citiesgeoparams (sample) + regionnamesexternalmatch (sample) + geocontent - regionsgeoparams (sample) + themes 34 Location Intelligence Component v1.0

35 - salesstatetheme1 (sample) - salesstatetheme2 (sample) + salesstatetheme3 (sample) - sales1bin (sample) - sales2bin (sample) - sales3bin (sample) + internalmatches - LatLongInternalMatch (sample) Chapter 3: Data Binding and Theming Managed Beans The rest of this chapter contains information on all of the managed beans found in the bifaces-config file. Each section includes a description of a single managed bean. All associated classes, inheritance, properties and some sample code are also included for the bean. About the Syntax Use the following guidelines when customizing the bifaces-config file: All changes should be made using a proper text editor, where classes, properties and values are color-coded. Errors are much easier to spot and debug. Order of elements is set. Do not change the order unless you are reordering a list of property values. For example, the order of the value elements listed below is a matter of personal preference, not a syntax requirement. <list-entries> <value>europe</value> <value>post Codes</value> </list-entries> On the other hand, if you rearrange any of the following lines of code, the bean no longer recognizes the reordered element. <managed-bean> <managed-bean-name>latlonginternalmatch</managed-bean-name> <managed-bean-class> com.mapinfo.jsf.controls.bi.internalmatchbean </managed-bean-class> <managed-bean-scope>none</managed-bean-scope> <property-name>name</property-name> <value>locations</value> Beans and bean properties both can be either required or optional. Each section in this chapter identifies a bean s required status immediately following the bean description. If the Required status is Yes, the bean must be defined. The required status for all bean properties are identified in the tables using square brackets: if a property is named within square brackets (for example, [labelcolumn]), defining the property is optional. If no brackets are used (for example, name), the property is required when the bean is defined. Do not include the brackets when specifying optional elements. Administration Guide 35

36 Locale Managed Beans Values (<value></value>) are strings. Elements in angle brackets may be any of the types found in the table below. Value Type Description boolean const float integer string Valid values are true and false. If the bean is defined, this value must be set. Value must be all capitals, optionally separated by _ (for example, MAXSIZE, USER_ID). Any number, including zero and negative numbers. Any positive number. Common English text. Sometimes the string is a URL to a directory installed with the LIC, and sometimes the string is text displayed on the interface to users. Locale Managed Beans localeprovider Description Identifies to the LIC which locale data to implement. Locale data is defined on the user s Preferences settings. This bean should not be modified. Required Class Scope Yes com.mapinfo.jsf.bo.bolocaleprovider session 36 Location Intelligence Component v1.0

37 Chapter 3: Data Binding and Theming Managed Beans Data Binding Managed Beans For sample code and assistance in doing external and internal binds, see the next chapter, Customizing Data Binding and Theming on page 65. bitool Description Required Class Scope Sample Children The top level bean. This bean holds all necessary information for creating the bindings for all reports. Yes com.mapinfo.jsf.bo.bobitoolbean session XtremeSampleUniverse efashion Derived from the property universes. Properties [autothemefirstmetric] Themes automatically on the first metric in a report. The bitool checks for custom theming on the first metric before applying the default theme. Sample Default: true Type: boolean. [addinternallayertool] Defines the class used for an internal bind, as follows: com.mapinfo.jsf.bo.mapxtreme.bomapxtremeaddinternallayertool This property should not be modified. [addexternallayertool] Defines the class used for an external bind, as follows: com.mapinfo.jsf.bo.mapxtreme.bomapxtremeaddexternallayertool This property should not be modified. [reportstyle] Defines the default or base report style for layers created in the map. This default path is taken from the <domain-directory>/resources directory. If you need to update this parameter, refer to the Location Intelligence Component Map Manager Guide for information on named resources. Sample Default: /customstyles/bi/report Type: string Administration Guide 37

38 Data Binding Managed Beans bitool (continued) [universename] The name of the universe. This property is a placeholder only and should not be modified. Sample Default: Xtreme Sample Universe Type: string [universes] Defined by a map of universes you add to the configuration. All your universes must be identified in this property to be recognized by the LIC. For more information on creating universes, see the section Creating Universes on page 67. This property contains the keys Xtreme Sample Universe and efashion, the class com.mapinfo.jsf.controls.bi.universebean and the nested beans XtremeSampleUniverse and efashion. XtremeSampleUniverse Description Required Class Scope Parent Sample Children A sample universe, containing a list of the objects from Business Objects that identify where geographic data and details are stored. Yes. At least one universe must be defined. com.mapinfo.jsf.controls.bi.universebean none bitool countriesexternalmatch regionsexternalmatch postalcodesexternalmatch All derived from the property externalmatches LatLongInternalMatch Derived from the property internalmatches Properties internalmatches Creates a list of any internal matches that need to be configured for any of the objects that must be mapped using internal Business Objects spatial data. Internal matches are records that have embedded coordinates for locations, such as latitude and longitude. The coordinates for each record in the report, along with the primary key, must be included in the report. You cannot drill on this data. This property contains the class com.mapinfo.jsf.controls.bi.internalmatchbean and the sample nested bean LatLongInternalMatch. 38 Location Intelligence Component v1.0

39 externalmatches Chapter 3: Data Binding and Theming Managed Beans XtremeSampleUniverse (continued) Creates a list of any external matches that need to be configured for any geographic objects that need external spatial data to bind to. The geographic data comes from an external table with a common key and usually come from TAB files. The criteria used to bind the report data with the geographic data must be defined in this configuration file. The criteria used should result in a strict one-to-one relationship between the report data and the geographic data to avoid multiple (and therefore ambiguous) or no geographic objects for a corresponding Business Objects object being returned. This property contains the class com.mapinfo.jsf.controls.bi.externalmatchbean and the sample nested beans countriesexternalmatch, regionsexternalmatch and postalcodesexternalmatch. In the case where a report fits multiple match definitions, the following rules exist: First, all internal matches are considered, in the order defined. After all internal matches are considered, all external matches are considered, in the order defined. The first match encountered using the order defined above and that fits the report is used. efashion Description Required Class Scope Parent Sample Children A sample universe, containing a list of the objects from Business Objects that identify where geographic data and details are stored. Yes. At least one universe must be defined. com.mapinfo.jsf.controls.bi.universebean none bitool storesexternalmatch citiesexternalmatch regionnamesexternalmatch All derived from the property externalmatches Administration Guide 39

40 Data Binding Managed Beans efashion (continued) Properties externalmatches Creates a list of any external matches that need to be configured for any geographic objects that need external spatial data to bind to. The geographic data comes from an external table with a common key and usually come from TAB files. The criteria used to bind the report data with the geographic data must be defined in this configuration file. The criteria used should result in a strict one-to-one relationship between the report data and the geographic data to avoid multiple (and therefore ambiguous) or no geographic objects for a corresponding Business Objects object being returned. This property contains the class com.mapinfo.jsf.controls.bi.externalmatchbean and the sample nested beans storesexternalmatch, citiesexternalmatch and regionnamesexternalmatch. In the case where a report fits multiple match definitions, the following rules exist: First, all internal matches are considered, in the order defined. After all internal matches are considered, all external matches are considered, in the order defined. The first match encountered using the order defined above and that fits the report is used. External Match Managed Beans This section includes a series of sample external managed beans (countriesexternalmatch, regionsexternalmatch, postalcodesexternalmatch, storesexternalmatch, citiesexternalmatch and regionnamesexternalmatch). It also includes two sample managed beans that can be associated with any external match bean, but which are not included in the bifaces-config file by default. There two beans are regionslabelminzoom and regionslabelmaxzoom. countriesexternalmatch Description Required Class Scope Sample Parent Sample Child A sample external match, containing all the information necessary to map a Business Objects metric to an external geographic data source (in this case the World Countries object value.) No com.mapinfo.jsf.controls.bi.externalmatchbean none XtremeSampleUniverse countriesgeoparams Derived from the property geocontent. 40 Location Intelligence Component v1.0

41 Chapter 3: Data Binding and Theming Managed Beans countriesexternalmatch (continued) Properties name Defines the name for the external match. This value is also used for the name of the spatial data layer that is created in the map. Therefore, this name appears in the Layer Control pane. Sample Default: World Countries Type: string [databindcolumns] The name of the Business Objects object that binds to the geographic column in the geographic data. Sample Default: Country Type: string [geobindcolumns] Specifies the name of the bind column in the geographic table that is matched with the databind column. Sample Default: Country Type:string [geocontent] The geographic data reference for the geoparamsbean. This property calls the bean countriesgeoparams. [labelcolumn] Specifies which column from any report with the currently-defined object to use as the label column on the map. If set to true, the layer is initially auto-labelled. Sample Default:Country Type: string [labelled] This property has been deprecated. [labelstyle] The path to the named style to use for labels on the layer. Sample Default: customstyles/bi/labels/world Type: string regionsexternalmatch Description Required Class Scope A sample external match, containing all required information to map a Business Objects object to an external geographic data source. No, but if defined, at least one external match is required. com.mapinfo.jsf.controls.bi.externalmatchbean none Administration Guide 41

42 Data Binding Managed Beans regionsexternalmatch (continued) Sample Parent Sample Child XtremeSampleUniverse regionsgeoparams Derived from the property geocontent. Properties name Defines the name for the external match. This value is also used for the name of the spatial data layer that is created in the map. Therefore, this the name appears in the Layer Control pane. Sample Default: States Type: string [databindcolumns] The name of the Business Objects object that binds to the column in the geographic data. Sample Default: State Type: string [geobindcolumns] Specifies the name of the bind column in the geographic table that is matched with the databind column. Sample Default:STATE Type: string [geocontent] The geographic data reference for the geoparams key. This property calls the sample bean regionsgeoparams. [labelcolumn] Specifies which column from any report with the currently-defined object to use as the label column on the map. If set to true, the layer is initially auto-labelled. Sample Default: State Type: string [labelstyle] The path to the named style to use for labels on the layer. Sample Default: customstyles/bi/labels/regions Type: string postalcodesexternalmatch Description Required A sample external match, containing all required information to map a Business Objects object to an external geographic data source. No, but if defined, at least one external match is required. 42 Location Intelligence Component v1.0

43 Chapter 3: Data Binding and Theming Managed Beans postalcodesexternalmatch (continued) Class Scope Sample Parent Sample Child com.mapinfo.jsf.controls.bi.externalmatchbean none XtremeSampleUniverse postalcodesgeoparams Derived from the property geocontent. Properties name Defines the name for the external match. This value is also used for the name of the spatial data layer that is created in the map. Therefore, this the name appears in the Layer Control pane. Sample Default: Postal Codes Type: string [databindcolumns] The name of the Business Objects object that binds to the geographic column in the geographic data. Sample Default: Postal Code Type: string [geobindcolumns] Specifies the name of the bind column in the geographic table that is matched with the databind column. Sample Default:ZIP Type: string [geocontent] The geographic data reference for the geoparams key. This property calls the sample bean postalcodesgeoparams. [labelcolumn] Specifies which column from any report with the currently-defined object to use as the label column on the map. If set to true, the layer is initially auto-labelled. Sample Default: Postal Code Type: string [labelstyle] The path to the named style to use for labels on the layer. Sample Default: customstyles/bi/labels/postal Type: string Administration Guide 43

44 Data Binding Managed Beans regionnamesexternalmatch Description Required Class Scope Sample Parent Sample Child A sample external match, containing all required information to map a Business Objects object to an external geographic data source. No, but if defined, at least one external match is required. com.mapinfo.jsf.controls.bi.externalmatchbean none efashion regionsgeoparams Derived from the property geocontent. Properties name Defines the name for the external match. This value is also used for the name of the spatial data layer that is created in the map. Therefore, this the name appears in the Layer Control pane. Sample Default: States Type: string [databindcolumns] The name of the Business Objects object that binds to the geographic column in the geographic data. Sample Default: State Type: string [geobindcolumns] Specifies the name of the bind column in the geographic table that is matched with the databind column. Sample Default:STATE_NAME Type: string [geocontent] The geographic data reference for the geoparams key. This property calls the sample bean regionsgeoparams. [labelcolumn] Specifies which column from any report with the currently-defined object to use as the label column on the map. If set to true, the layer is initially auto-labelled. Sample Default: State Type: string [labelstyle] The path to the named style to use for labels on the layer. Sample Default: customstyles/bi/labels/regions Type: string 44 Location Intelligence Component v1.0

45 Chapter 3: Data Binding and Theming Managed Beans regionnamesexternalmatch (continued) [drillpath] Sets the level in the Business Objects system hierarchy that this defined dimension should drill to if the user clicks on the map using the drill tool. If a drill path is not specified, the drill tool travels one level down into the system s drill hierarchy. Sample Default: Store name Type: string [drillreport] Defines which report to drill for values used in selecting geographic content for a bind. The drill report can be used to define a specific report to display upon drilling to the next level. This is useful for either overriding the default drill path or for providing a specificallyformatted report for the target drill level. The value specified in this property is the reportid (also known as the Document ID in InfoView), which can be obtained by viewing the report s properties. The target report must contain the same attribute as the attribute in the source report being drilled from. So, if you are drilling from State to County level and the starting report contains an attribute State, the target report must also contain State. If the target report is prompted, then the prompt must also be on State. Sample Default: Type: string [themes] Consists of a list of themes that apply to this dimension. For each entry in the map, the key is the name of the theme (which is also displayed to the user in a drop-down menu when this binding is used), and the value is a reference to one of the available ThemeBean implementations: RangedThemeBean, FixedRangeThemeBean, IndividualValueThemeBean, PieChartThemeBean, StackedBarChartThemeBean, or SideBySideBarChartThemeBean. This property contains the class com.mapinfo.jsf.controls.mapping.themebean and the sample nested beans salesstatetheme1, salesstatetheme2 and salesstatetheme3. Administration Guide 45

46 Data Binding Managed Beans citiesexternalmatch Description Required Class Scope Sample Parent Sample Child A sample external match, containing all required information to map a Business Objects object to an external geographic data source. No, but if defined, at least one external match is required. com.mapinfo.jsf.controls.bi.externalmatchbean none efashion citiesgeoparams Derived from the property geocontent. Properties name Defines the name for the external match. This value is also used for the name of the spatial data layer that is created in the map. Therefore, this the name appears in the Layer Control pane. Sample Default: Cities Type: string [databindcolumns] The name of the Business Objects object that binds to the geographic column in the geographic data. Sample Default: City Type: string [geobindcolumns] Specifies the name of the bind column in the geographic table that is matched with the databind column. Sample Default:City Type: string [geocontent] The geographic data reference for the geoparams key. This property calls the sample bean citiesgeoparams. 46 Location Intelligence Component v1.0

47 Chapter 3: Data Binding and Theming Managed Beans citiesexternalmatch (continued) [labelcolumn] Specifies which column from any report with the currently-defined object to use as the label column on the map. If set to true, the layer is initially auto-labelled. Sample Default: City Type: string [labelstyle] The path to the named style to use for labels on the layer. Sample Default: customstyles/bi/labels/regions Type: string storesexternalmatch Description Required Class Scope Sample Parent Sample Child A sample external match, containing all required information to map a Business Objects object to an external geographic data source. No, but if defined, at least one external match is required. com.mapinfo.jsf.controls.bi.externalmatchbean none efashion storesgeoparams Derived from the property geocontent. Properties name Defines the name for the external match. This value is also used for the name of the spatial data layer that is created in the map. Therefore, this the name appears in the Layer Control pane. Sample Default: Stores Type: string [databindcolumns] The name of the Business Objects object that binds to the geographic column in the geographic data. Sample Default: Store name Type: string [geobindcolumns] Specifies the name of the bind column in the geographic table that is matched with the databind column. Sample Default: Store_name Type: string Administration Guide 47

48 Data Binding Managed Beans storesexternalmatch (continued) [geocontent] The geographic data reference for the geoparams key. This property calls the sample bean storesgeoparams. [labelcolumn] Specifies which column from any report with the currently-defined object to use as the label column on the map. If set to true, the layer is initially auto-labelled. Sample Default: Store name Type: string [labelstyle] The path to the named style to use for labels on the layer. Sample Default: customstyles/bi/labels/regions Type: string Internal Match Managed Beans This section includes a single sample internal match bean: the LatLongInternalMatch managed bean. LatLongInternalMatch Description Required Class Scope Sample Parent Properties A sample internal match, containing all the information necessary to map internal latitude and longitude values. No, but if defined, at least one internal match is required. com.mapinfo.jsf.controls.bi.internalmatchbean none XtremeSampleUniverse name Defines the name for the match. This value is also used for the name of the spatial data layer that is created in the map. Therefore, this name appears in the Layer Control pane. Sample Default: Locations Type: string keycolumns Any key metric used in every report that contains a longitude and latitude value. Sample Default: IDcolumn Type: string [labelcolumn] Specifies which column from any report with the currently-defined dimension to use as the label column on the map. Sample Default: State Type: string 48 Location Intelligence Component v1.0

49 Chapter 3: Data Binding and Theming Managed Beans LatLongInternalMatch (continued) [labelstyle] The path to the named style to use for labels on the layer. Sample Default: Type: string [latitudecolumn] The column header designating the Business Objects dimension containing the latitude value for mapping the location on the map. Sample Default: Latitude Type: float [longitudecolumn] The column header designating the Business Objects dimension containing the longitude value for mapping the location on the map. Sample Default: Longitude Type: float [srsname] Tells the mapping engine what spatial referencing system the longitude and latitude values use. Sample Default: EPSG:4269 Type: string Geographic External Bind Managed Beans This section includes several sample external match beans that have been used to define specific geographies. countriesgeoparams Description Required Class Scope Sample Parent A sample geographic parameter bean, which allows binding report data to a spatial data source. You must define a bean for each spatial data source. No com.mapinfo.jsf.control.soleng.util.jsf.geoparamsbean none countriesexternalmatch Administration Guide 49

50 Data Binding Managed Beans countriesgeoparams (continued) Properties layername The name of the named layer. Sample Default: World Type: string [layerpath] The relative path from your resources directory to the geographic layer for the data bind. If you upgrade this file, refer to the Location Intelligence Component Map Manager Guide for information on named resources. Sample Default: customlayers/bi/botutorial Type: string regionsgeoparams Description Required Class Scope Sample Parents Properties A sample geographic parameter bean, which allows binding report data to a spatial data source. You must define a bean for each spatial data source. No com.mapinfo.soleng.util.jsf.geoparamsbean none regionsexternalmatch regionnamesexternalmatch layername Defines the name of the geographic layer for the data bind. Sample Default: States Type: string layerpath The relative path from your resources directory to the geographic layer for the data bind. If you decide to upgrade this file, refer to the Location Intelligence Component Map Manager Guide for information on named resources. Sample Default: customlayers/bi/botutorial Type: string postalcodesgeoparams Description Required Class A sample geographic parameter bean, which allows binding report data to a spatial data source. You must define a bean for each spatial data source. No com.mapinfo.soleng.util.jsf.geoparamsbean 50 Location Intelligence Component v1.0

51 Chapter 3: Data Binding and Theming Managed Beans postalcodesgeoparams (continued) Scope Sample Parent Properties none postalcodesexternalmatch layername Defines the name of the geographic layer for the data bind. Sample Default: ZipCodes Type: string layerpath The relative path from your resources directory to the geographic layer for the data bind. If you upgrade this file, refer to the Location Intelligence Component Map Manager Guide for information on named resources. Sample Default: customlayers/bi/botutorial Type: string storesgeoparams Description Required Class Scope Properties A sample geographic parameter bean, which allows binding report data to a spatial data source. You must define a bean for each spatial data source. No com.mapinfo.jsf.soleng.util.jsf.geoparamsbean none layername Defines the name of the geographic layer for the data bind. Sample Default: Stores Type: string layerpath The relative path from your resources directory to the geographic layer for the data bind. If you upgrade this file, refer to the Location Intelligence Component Map Manager Guide for information on named resources. Sample Default: customlayers/bi/botutorial Type: string Administration Guide 51

52 Theming Managed Beans citiesgeoparams Description Required Class Scope Sample Parent Properties A sample geographic parameter bean, which allows binding report data to a spatial data source. You must define a bean for each spatial data source. No com.mapinfo.jsf.control.soleng.util.jsf.geoparamsbean none citiesexternalmatch layername The name of the named layer. Sample Default: Cities Type: string [layerpath] The relative path from your resources directory to the geographic layer for the data bind. If you upgrade this file, refer to the Location Intelligence Component Map Manager Guide for information on named resources. Sample Default: customlayers/bi/botutorial Type: string Theming Managed Beans This section contains a variety of sample theming beans. The LIC offers Ranged themes, Fixed Range themes, and Individual Value themes. Ranged Theme Managed Beans The bifaces-config file includes two theme beans (the salesstate1theme bean and the salesstate2theme bean) as sample Ranged theme beans. The salesstate1theme bean demonstrates how to define a theme based on default solid colors; salesstate2theme bean demonstrates how to define a theme based on translucent styles. All styles identified here are provided in the customstyles directory. salesstate1theme Description Required Class A sample ranged theme bean, containing all the properties of a regular RangedThemeBean plus any child beans useful in defining a multivariate color theme. No com.mapinfo.jsf.controls.mapping.rangedthemebean 52 Location Intelligence Component v1.0

53 Chapter 3: Data Binding and Theming Managed Beans salesstate1theme (continued) Scope Sample Parent Properties none regionnamesexternalmatch Derived from the property themes. name Defines the name for the thematic. This property is displayed to the user in a drop-down menu for this pre-defined thematic on the revenue and profit external match layers. Sample Default: Theme1 Low Sales in Red Type: string attribute Defines what attribute in the report to perform the thematic analysis on. Therefore this thematic is loaded if the user creates a report on States that contains the Sales Revenue metric in it. Sample Default: Sales revenue Type: string [begincolor] Defines the color for the starting range value for this theme. The value must be a java.awt.color constant. Valid values are black, blue, cyan, gray, darkgray, lightgray, green, magenta, orange, pink, red, white or yellow. If you have defined a named style you prefer to reference, you can also use the beginstyle property instead. Sample Default: red Type: const [endcolor] The color for the ending range value for this theme. The value must be a java.awt.color constant. Valid values are black, blue, cyan, gray, darkgray, lightgray, green, magenta, orange, pink, red, white or yellow. If you have defined a named style you prefer to reference, you can also use the endstyle property instead. Sample Default: green Type: const [distributiontype] The distribution type for the theme. This value determines the methodology for grouping the attribute values into common ranges. Valid values are Equal Count, Equal Ranges, Standard Deviation, Natural Break and Custom Ranges. Sample Default: Equal Count Type: string [numranges] How many ranges into which the attribute data is grouped. Sample Default: 4 Type: float Administration Guide 53

54 Theming Managed Beans salesstate2theme Description Required Class Scope Sample Parent Properties A sample ranged theme bean, containing all the properties of a regular RangedThemeBean plus any child beans useful in defining a multivariate translucent color theme. No com.mapinfo.jsf.controls.mapping.rangedthemebean none regionnamesexternalmatch Derived from the property themes. name Defines the name for the thematic. This property is displayed to the user in a drop-down menu for this pre-defined thematic on the regionnames external match layers. Sample Default: Theme2 translucent style Type: string attribute Defines what attribute in the report to perform the thematic analysis on. Therefore this thematic is loaded if the user creates a report on States that contains the Sales Revenue metric in it. Sample Default: Sales revenue Type: string [begincolor] Defines the color for the starting range value for this theme. The value must be a java.awt.color constant. Valid values are black, blue, cyan, gray, darkgray, lightgray, green, magenta, orange, pink, red, white or yellow. If you have defined a named style you prefer to reference, you can also use the beginstyle property instead. Sample Default: LRed_opac50 Type: const [endcolor] The color for the ending range value for this theme. The value must be a java.awt.color constant. Valid values are black, blue, cyan, gray, darkgray, lightgray, green, magenta, orange, pink, red, white or yellow. If you have defined a named style you prefer to reference, you can also use the endstyle property instead. Sample Default: Purple_opac50 Type: const [distributiontype] 54 Location Intelligence Component v1.0

55 Chapter 3: Data Binding and Theming Managed Beans The distribution type for the theme. This value determines the methodology for grouping the attribute values into common ranges. Valid values are Equal Count, Equal Ranges, Standard Deviation, Natural Break and Custom Ranges. Sample Default: Equal Count Type: string [numranges] How many ranges into which the attribute data is grouped. Sample Default: 3 Type: float salesstate2theme (continued) Fixed Range Theme Managed Beans The bifaces-config file includes the salesstate3theme managed bean as a sample Fixed Range theme bean. Also included in this section are samples of the three associated sample beans, sales1bin - sales3bin. salesstate3theme Description Required Class Scope Sample Parent Sample Children Properties A sample theme bean, working in conjunction with the regionnamesexternalmatch bean to produce the multivariate shading thematic map. No com.mapinfo.jsf.controls.mapping.fixedrangethemebean none regionnamesexternalmatch sales1bin - sales3bin All derived from the property rangebins. name Defines the name for the thematic. This property is displayed to the user in a drop-down menu for this pre-defined thematic on the regionnames external match layers. Sample Default: Theme3 fixed ranges Type: string Administration Guide 55

56 Theming Managed Beans salesstate3theme (continued) attribute Defines what attribute in the report to perform the thematic analysis on. This thematic is loaded if the user creates a report on States that contains the Sales Revenue metric in it. Sample Default: Sales revenue Type: string rangebins States that attribute grouping is going to be controlled by this configuration file explicitly by the nested beans sales1bin, sales2bin and sales3bin. This differs from the other theme definitions because range bins are being defined. The other beans used the distributiontype and numranges properties to define the theme. This property defines a way to control explicitly what values go into what grouping. This property contains the class com.mapinfo.jsf.controls.mapping.themeattributebean and the nested beans sales1bin, sales2bin, and sales3bin. sales1bin Description Required Class Scope Sample Parent Properties A sample theme bean, defining the properties for a single bin for the group of bins defined for a range thematic. There are three sample sales<x>bin managed beans provided in the sample salesstatetheme3 managed bean. No com.mapinfo.jsf.controls.mapping.themeattributebean none salesstatetheme3 style Defines the style for a single bin for the theme. This style defines a transparent fill of 25%. This value is a relative path from the <domain-directory>/resources directory. If you need to update this parameter, refer to the Location Intelligence Component Map Manager Guide for information on named resources. Sample Default: customstyles/red_opac50 Type: string value Defines the upper limit of the lowest bin for the thematic. The values for these sample beans range from to Sample Default: Type: float 56 Location Intelligence Component v1.0

57 Chapter 3: Data Binding and Theming Managed Beans sales2bin Description Required Class Scope Sample Parent Properties A sample theme bean, defining the properties for a single bin for the group of bins defined for a range thematic. There are three sample sales<x>bin managed beans provided in the sample salesstatetheme3 managed bean. No com.mapinfo.jsf.controls.mapping.themeattributebean none salesstatetheme3 style Defines the style for a single bin for the theme. This style defines a transparent fill of 25%. This value is a relative path from the <domain-directory>/resources directory. If you need to update this parameter, refer to the Location Intelligence Component Map Manager Guide for information on named resources. Sample Default: customstyles/black_opac_50 Type: string value Defines the upper limit of the middle bin for the thematic. The values for these sample beans range from to Sample Default: Type: float sales3bin Description Required Class Scope Sample Parent A sample theme bean, defining the properties for a single bin for the group of bins defined for a range thematic. There are three sample sales<x>bin managed beans provided in the sample salesstatetheme3 managed bean. No com.mapinfo.jsf.controls.mapping.themeattributebean none salesstatetheme3 Administration Guide 57

58 Theming Managed Beans sales3bin (continued) Properties style Defines the style for a single bin for the theme. This style defines a transparent fill of 25%. This value is a relative path from the <domain-directory>/resources directory. If you need to update this parameter, refer to the Location Intelligence Component Map Manager Guide for information on named resources. Sample Default: customstyles/lgray_opac_50 Type: string value Defines the upper limit of the highest bin for the thematic. The values for these sample beans range from to Sample Default: Type: float Individual Value Managed Beans The sample beans in this section can be used to identify custom theme shading for your users maps. While none of these beans is included in the bifaces-config file, they are included here to demonstrate how to differentiate the definition of a series of individual value beans from that of a Ranged theme or a Fixed Range theme. For instructions on defining custom shade attributes for your users standard maps, see Understanding Custom Thematics on page 80. sampleindividualvaluetheme Description Required Class Sample Children Properties A sample theme attribute bean, which defines the properties for thematically shading an attribute based on one or more specific values of the attribute as opposed to grouping them together by values, like a ranged theme. This would be used instead of a RangedThemeBean. No com.mapinfo.jsf.controls.mapping.themeattributebean gradea - graded All derived from the property IndividualValues. name The name of the sample theme. This name appears in the Theme Control drop-down list. If you do not specify a name, the default value is not used and you receive a Null Pointer error. Sample Default: Grades Type: string 58 Location Intelligence Component v1.0

59 attribute Chapter 3: Data Binding and Theming Managed Beans sampleindividualvaluetheme (continued) Defines which attribute in the report to perform the thematic analysis on. Sample Default: Average Grade Type: string IndividualValues Defines the properties to use for each individual value theme. This property contains the grade<x> nested beans. grade A Description Class Sample Parent Properties A sample layer bean, which defines the properties for thematically shading an attribute. There are four sample grade managed beans (grade A, grade B, grade C and grade D) provided with the LIC, to demonstrate the potential of thematic shading. Configure as many or as few shading grades for your company as required. Use the four grade <x> beans provided for reference. com.mapinfo.jsf.controls.mapping.layerbean sampleindividualvaluetheme value Specifies the value to look for in the Business Objects attribute. Sets all values of A to the style listed in the color property. Sample Default: A Type: string [color] The color of the theme. This value can be any standard Java color name. Sample Default: blue Type: const [style] Defines the style of the thematic. This value is a relative path from the <domaindirectory>/resources directory. Sample Default: Type: string Administration Guide 59

60 Charting Managed Beans Charting Managed Beans The sample beans in this section can be used to create custom pie and bar chart themes for your users maps. The section Common Charting Bean Properties identifies properties common to all pie and bar charts. Subsequent sections identify any properties specific to the named bean. For instructions on designing charting themes for your users maps, see Creating Pie and Bar Chart Themes on page 100. Common Charting Bean Properties Properties attributes List of report attributes to chart (a single pie chart or bar chart is created for each attribute identified). Type: list [colors] List of colors to use in the chart, one for each wedge or bar. If neither colors or styles are defined, a default set of fill colors is computed, starting with red, green and blue. Type: list [graduated] If set to true, this property sets the size of each chart (per map feature). Sample Default: true Type: boolean [graduationmethod] Scales the theme of the charts relative to the sum of their contents. Valid values are const, log, or sqrt. Sample Default: sqrt Type: string [graduationsize] Size in pixels of charts with a sum of value. Sample Default: 50 Type: float [graduationvalue] Sum at which charts have a size of size. Sample Default: computed Type: double [maxsize] The maximum size of charts in pixels. Sample Default: 50 Type: float 60 Location Intelligence Component v1.0

61 [offsetx] Chapter 3: Data Binding and Theming Managed Beans The X-axis offset value in pixels from a feature s centroid or position. Sample Default: none Type: float [offsety] The Y-axis offset value in pixels from a feature s centroid or position. Sample Default: none Type: float [position] The position of the chart on the map in relation to the feature. Valid values are bottom, center, left, lowerleft, lowerright, right, top, upperleft and upperright. Sample Default: center Type: string [styles] List of named styles to use, one for each wedge or bar. If neither colors or styles are defined, a default set of fill colors is computed, starting with red, green, blue, etc. Type: list Common Charting Bean Properties(continued) Pie Chart Theme Managed Beans Only those properties unique to the PieChartTheme bean are included below. For a list of properties common to all charting beans, see the section Common Charting Bean Properties on page 60. PieChartTheme Description Class Properties A sample charting bean, which defines data using pie charts on a map. com.mapinfo.jsf.controls.mapping.piechartthemebean name The name of the theme. This name appears in the list on the Layer Control pane. Type: string [drawnclockwise] If set to true, pie wedges are read clockwise from startangle to counter-clockwise. Type: boolean Administration Guide 61

62 Charting Managed Beans PieChartTheme (continued) [fullpies] If set to true, full pies are drawn; if set to false, half pies are drawn. Type: boolean [startangle] Angle at which to start drawing full pies. This property is only define when the other two optional properties are set to true. Type: float Stacked Bar Chart Theme Managed Beans Only those properties unique to the StackedBarChartTheme bean are included below. For a list of properties common to all charting beans, see the section Common Charting Bean Properties on page 60. StackedBarChartTheme Description Class Properties A sample charting bean, which defines data using stacked bar charts on a map. com.mapinfo.jsf.controls.mapping.stackedbarchartthemebean name The name of the stacked bar theme. This name appears in the list on the Layer Control pane. Type: string [width] The width in pixels of drawn bar charts. Type: float Side-by-Side Bar Chart Theme Managed Beans Only those properties unique to the SideBySideBarChartTheme bean are included below. For a list of properties common to all charting beans, see the section Common Charting Bean Properties on page 60. SideBySideBarChartTheme Description Class Sample Parent A sample charting bean, which defines data using side-by-side bar charts on a map. com.mapinfo.jsf.controls.mapping.sidebysidebarchartthemebean StackedBarChartTheme 62 Location Intelligence Component v1.0

63 Chapter 3: Data Binding and Theming Managed Beans SideBySideBarChartTheme (continued) Properties name The name of the side-by-side bar theme. This name appears in the list on the Layer Control pane. Type: string [eachbarindependentlyscaled] If set to true, each bar in the chart is scaled to a corresponding metric; if set to false, each bar in the chart is scaled based on all metrics. Type: boolean Zoom Distance Managed Beans The beans in this section do not appear as samples in the bifaces-config file. However, they are legitimate managed beans and can be used to specify zoom distances for layer labels on your maps. regionslabelminzoom Description A distance bean, Identifying the minimum zoom distance at which labels appear on a user s map. If defined, labels appear on the map within the defined zoom range. For example, the countrylabelminzoom might provide labels for all countries appearing on a continent; this bean would specify the minimum zoom at which those labels would appear. Required Class Scope Parent Properties No com.mapinfo.jsf.unit.distancebean none Any external match managed bean. value The minimum zoom range for a given object. Type: float unitabbreviation The unit in which the minimum zoom range is labelled, in short form. Valid values include mi, km, m, yd and ft. Type: string Administration Guide 63

64 Zoom Distance Managed Beans regionlabelsmaxzoom Description A distance bean, identifying the maximum zoom distance at which labels appear on a user s map. If defined, labels appear on the map within the defined zoom range. For example, the countrylabelmaxzoom might provide labels for all countries appearing on a continent; this bean would specify the maximum zoom at which those labels would appear. Required Class Scope Parent Properties No com.mapinfo.jsf.unit.distancebean none Any external match managed bean. value The maximum zoom range for a given state. Type: float unitabbreviation The unit in which the maximum zoom range is labelled, in short form. Valid values include mi, km, m, yd and ft. Type: string 64 Location Intelligence Component v1.0

65 Customizing Data Binding and Theming 4 The bifaces-config file is provided as a skeleton file, to assist you in defining matches (that is, data binding) and in defining themes. This file includes many sample configurations on which you can build your binding and theming customizations. Furthermore, there are several sample configurations provided in this chapter which do not currently exist in the bifaces-config file but which you can add to the file. All these customizations can optimize how your Location Intelligence Component (LIC) displays report data geographically. If you decide to customize the bifaces-config file, we strongly recommend you save a copy of the original file somewhere on your system. Saved originals allow you to do two things: Base new customizations on the original sample code Work backwards to debug any new changes Since you can configure two separate types of beans with the bifaces-config file, this chapter is divided into the following two sections: Data Binding: Understanding Binding Creating Universes Binding Internal Data Binding External Data Theming: Understanding Custom Thematics Creating Ranged, Fixed Range and Individual Value Themes...88 Creating Pie and Bar Chart Themes Combining Multiple Types of Themes

66 Understanding Binding Understanding Binding All MapInfo software displays report data geographically, on a map. This is accomplished with a method called data binding. Data binding lets you use data from a report and combine it with a spatial datasource (for example, TAB files) to display the information on a map. For example, you might plot revenue based on location to visually identify areas of high sales volume. To a database administrator, binding means doing a database join. You can do internal binds and external binds. Internal binds join two data types, both from within a single report. External binds join the data from a report to a TAB file or another spatial datasource. For example, an internal bind automatically uses a report s latitude and longitude column. This is considered an internal bind because all context is contained within a single report and because the LIC understands plotting latitude and longitude coordinates onto a map directly, so no external database join is required. With an external bind, on the other hand, you might have a report containing the column State and a TAB file containing the states map, where the data is headed by the column STATE_NAME. Here you are joining two columns from separate sources, one a non-spatial database and the other a geographically-aware context. This chapter provides suggestions for internal and external data bindings. The LIC offers a variety of sample managed beans to assist you in defining your company s customization requirements. For more information on the managed bean properties defined in the bifaces-config file, see Chapter 3. The value specified for any of these binding properties is the column header in the report. Typically, the column header value is identical to the object value. However, report designers occasionally override the value to provide a more meaningful value, or in the interest of space. For example, a Latitude column contain the heading value LAT. In this case, the following binding is required for the LatLongInternalMatch bean: <managed-bean> <managed-bean-name>latlonginternalmatch</managed-bean-name> <managed-bean-class>com.mapinfo.jsf.controls.bi.internalmatchbean</ managed-bean-class> <managed-bean-scope>none</managed-bean-scope> <property-name>latitudecolumn</property-name> <value>lat</value> <managed-bean> 66 Location Intelligence Component v1.0

67 Chapter 4: Customizing Data Binding and Theming Creating Universes Within the bitool managed bean resides the property universes. The universes property identifies all defined Business Objects universes. A universe identifies all report data that you want displayed on LIC maps. You must have at least one universe defined to map reports. For example, the following sample code for the bitool bean includes two defined nested beans, the default efashion and the custom AcmeUniverse. Each UniverseBean corresponds to a universe used in Business Objects for report mapping. <property-name>universes</property-name> <map-entries> <value-class>com.mapinfo.jsf.controls.bi.universebean</value-class> <map-entry> <key>efashion</key> <value>#{efashion}</value> </map-entry> <map-entry> <key>acme Universe</key> <value>#{acmeinc}</value> </map-entry> </map-entries> </managed-bean> Later in the code, the nested beans are defined individually. Each bean contains a list of specific attributes from a Business Objects report defining the limits for mapping to geographic data, along with details about where and how the geographic data is stored, so it can be accessed. The following sample code demonstrates how the AcmeUniverse managed bean s attributes would be defined. <managed-bean> <managed-bean-name>acmeuniverse</managed-bean-name> <managed-bean-class> com.mapinfo.jsf.controls.bi.universebean </managed-bean-class> <managed-bean-scope>none</managed-bean-scope> <property-name>universename</property-name> <value>acmeinc</value> <property-name>internalmatches</property-name> <list-entries> <value-class>com.mapinfo.jsf.controls.bi.internalmatchbean</valueclass> <value>#{latlonginternalmatch}</value> </list-entries> Administration Guide 67

68 Binding Internal Data <property-name>externalmatches</property-name> <list-entries> <value-class>com.mapinfo.jsf.controls.bi.externalmatchbean</valueclass> <value>#{storeexternalmatch}</value> <value>#{citiesexternalmatch}</value> </list-entries> </managed-bean> Binding Internal Data Internal binds identify location information from within a single report. You can customize an internal bind using the internalmatchbean and its associated sample bean, LatLongInternalMatch. These beans, referenced in a universe bean, contain all the necessary information for mapping latitude and longitude values to a report. This section provides details on customizing an internal data bind. These instructions assume you have a report that includes latitude and longitude values. To configure a custom internal data bind: 1. Open the bifaces-config file in a text editor. 2. Scroll to the LatLongInternalMatch managed bean (see sample code below). 3. Copy and paste the entire bean code beneath the existing code. 4. For <managed-bean-name>, replace the bean name LatLongInternalMatch with a new, descriptive name for your new layer (for instance, campsitesinternalmatch). Note You must leave the managed bean class and scope properties intact. 5. Update the following properties of the managed bean: a. For name, replace the default Locations with the name of your new data layer. This name appears on the Layer Control pane, as the naming convention for the layer. b. For longitudecolumn, latitudecolumn and keycolumns, replace the default Longitude, Latitude and IDcolumn values with the values from the referenced report. c. Update the label properties as required. Note These properties are not mandatory; you can leave them undefined, use the default values, or customize them. For information on customizing these label properties, see the table LatLongInternalMatch on page 48. d. Leave the srsname property as is. If your data binding uses a different value from the default, contact your MapInfo representative. 6. Scroll to the efashion managed bean. 7. For the property internalmatches, copy and paste the following line in the list of property entries: <value>#{latlonginternalmatch}</value> 68 Location Intelligence Component v1.0

69 Chapter 4: Customizing Data Binding and Theming 8. Replace LatLongInternalMatch with your new <managed-bean-name>, as identified above. You should now have a list similar to this sample list: <list-entries> <value>#{latlonginternalmatch}</value> <value>#{campsitesinternalmatch}</value> </list-entries> 9. Save and close the file. 10. Restart your application server so your system can recognize your changes. The sample LatLongInternalMatch managed bean is defined as follows, by default: <managed-bean> <managed-bean-name>latlonginternalmatch</managed-bean-name> <managed-bean-class> com.mapinfo.jsf.controls.bi.internalmatchbean </managed-bean-class> <managed-bean-scope>none</managed-bean-scope> <property-name>name</property-name> <value>location</value> <property-name>longitudecolumn</property-name> <value>longitude</value> <property-name>latitudecolumn</property-name> <value>latitude</value> <property-name>keycolumns</property-name> <value>idcolumn</value> <property-name>srsname</property-name> <value>epsg:4269</value> </managed-bean> Administration Guide 69

70 Binding External Data The sample efashion managed bean is defined (internal match binding only) as follows, by default: <managed-bean> <managed-bean-name>efashion</managed-bean-name> <managed-bean-class> com.mapinfo.jsf.controls.bi.universebean </managed-bean-class> <managed-bean-scope>none</managed-bean-scope> <property-name>internalmatches</property-name> <list-entries> <value-class>com.mapinfo.jsf.controls.bi.universebean</valueclass> <value>#{latlonginternalmatch}</value> </list-entries> </managed-bean> Binding External Data External binds join the data from a report to a separate named layer spatial datasource. You can customize an external bind using any of the sample beans included on the bifaces-config file. These beans contain all the necessary information for mapping values to a report. This section uses the postalcodesexternalmatch bean to demonstrate external data binds. Two datasources are included in our example. Note This bean does not, by default, include a theme. If you want to include a theme with your external bind, you can use the sample regionnamesexternalmatch bean, which does include a themes property. These instructions assume you have a report with a multicolumn bind. To configure a custom external data bind: 1. Open the bifaces-config file in a text editor. 2. Scroll to the postalcodesgeoparams managed bean (see sample code below). 3. Copy and paste the entire bean code twice beneath the existing code. 4. For <managed-bean-name>, replace the default postalcodesgeoparams with names that identify your two named layers. In our example, the first instance is renamed windgeoparams; the second instance is renamed solargeoparams. 5. For layername, replace the default ZipCodes with the actual names of your named layers. In our example, the first instance layername is Turbines; the second instance layername is SolarPanels. 6. For layerpath, replace the default customlayers/bi/botutorial with the path to your named layers. 7. Scroll to the postalcodesexternalmatch managed bean (see sample code below). 70 Location Intelligence Component v1.0

71 8. Copy and paste the entire bean code beneath the existing code. Chapter 4: Customizing Data Binding and Theming 9. For <managed-bean-name>, replace the bean name postalcodesexternalmatch with a new, descriptive name for your layer data (for instance, energyexternalmatch). Note You must leave the managed bean class and scope properties intact. 10. Update the following properties of the managed bean: a. For name, replace the default Postal Codes with the name of your new data layer (for example, Energy Types). This name appears on the Layer Control pane, as the naming convention for the layer. b. For databindcolumns and geobindcolumns, replace the default Postal Code and ZIP values with as many columns of data you want to include on the basemap or layer from the referenced report. For example, if you want to include two columns of data, you would have four list-entry values, referencing each column. <list-entries> <value>wind</value> <value>solar</value> </list-entries> and <list-entries> <value>turbines</value> <value>panels</value> </list-entries> 11. For geocontent, replace the default postalcodesgeoparams bean with the values that identify your datasources. In our example, we have two databindcolumns so we need to identify our two datasources, windgeoparams and solargeoparams, as follows: <property-name>geocontent</property-name> <value>turbinesgeoparams</value> <value>panelsgeoparams</value> 12. Scroll to the efashion managed bean. 13. Replace postalcodesexternalmatch with your new <managed-bean-name>, as identified above. You should now have a list similar to this sample list: <list-entries> <value>#{energyexternalmatch}</value> </list-entries> 14. Save and close the file. 15. Restart your application server so your system can recognize your changes. Administration Guide 71

72 Binding External Data The sample windgeoparams and solargeoparams managed beans provided above are defined as follows: <managed-bean> <managed-bean-name>windgeoparams</managed-bean-name> <managed-bean-class>com.mapinfo.soleng.util.jsf.geoparamsbean</managedbean-class> <managed-bean-scope>none</managed-bean-scope> <property-name>layername</property-name> <value>turbines</value> <property-name>layerpath</property-name> <value>customlayers/bi/acme</value> </managed-bean> <managed-bean> <managed-bean-name>solargeoparams</managed-bean-name> <managed-bean-class>com.mapinfo.soleng.util.jsf.geoparamsbean</managedbean-class> <managed-bean-scope>none</managed-bean-scope> <property-name>layername</property-name> <value>solarpanels</value> <property-name>layerpath</property-name> <value>customlayers/bi/acme</value> </managed-bean> The sample postalcodesexternalmatch managed bean provided above is defined as follows: <managed-bean> <managed-bean-name>energyexternalmatch</managed-bean-name> <managed-bean-class> com.mapinfo.jsf.controls.bi.externalmatchbean </managed-bean-class> <managed-bean-scope>none</managed-bean-scope> <property-name>name</property-name> <value>energy Types</value> 72 Location Intelligence Component v1.0

73 <property-name>databindcolumns</property-name> <list-entries> <value>wind</value> <value>solar</value> </list-entries> <property-name>geobindcolumns</property-name> <list-entries> <value>turbines</value> <value>panels</value> </list-entries> <property-name>geocontent</property-name> <value>windgeoparams</value> <value>solargeoparams</value> <property-name>labelcolumn</property-name> <value>postal Code</value> <property-name>labelstyle</property-name> <value>customstyles/bi/labels/postal</value> </managed-bean> Chapter 4: Customizing Data Binding and Theming The sample efashion managed bean (external binds only) provided above is defined as follows: <managed-bean> <managed-bean-name>efashion</managed-bean-name> <managed-bean-class>com.mapinfo.jsf.controls.bi.universebean</managedbean-class> <managed-bean-scope>none</managed-bean-scope> <property-name>externalmatches</property-name> <list-entries> <value-class>com.mapinfo.jsf.controls.bi.externalmatchbean</ value-class> <value>#{energyexternalmatch}</value> </list-entries> Administration Guide 73

74 Additional Binding Customizations Additional Binding Customizations This section includes the following instructions on customizations you might want to make on internallyor externally-matched data: Overriding the Drill Hierarchy, below Defining the Zoom Range on Labels on page 77 Customizing the Default Zoom Levels on Labels on page 79 Customizing Generic Report Styles for Layers on page 80 Overriding the Drill Hierarchy When your users are viewing a map based on external bind data, there are two Drill tools available to them the native Drill tool provided by Business Objects and the LIC Drill tool, accessible on the Mapping toolbar. The LIC Drill tool drills down into the next level specified in the drill structure, if a next level exists. While the LIC Drill tool does not support drilling up or across in the drill hierarchy, the Business Objects Drill tool can drill both up and down, and across a hierarchy. You can customize a specific drilling hierarchy for a map so that, when your users activate the LIC Drill tool, their drill hierarchy is predefined. There are two ways to override the drill hierarchy: By targeting a layer within the current report (drillpath property) By targeting a secondary report (drillreport property) This section provides details on both these options. The drillpath parameter identifies a specific target level in the hierarchy; you can bypass levels in the drilling and direct your users focus on the most meaningful data. The drillreport parameter identifies a report other than the one specified earlier in the ExternalMatch bean; drillreport causes the LIC to drill through the main report into the secondary one for specific data. The drillpath property and the drillreport property appear in the sample regionnamesexternalmatch bean by default, but you can insert either of these properties into any ExternalMatch bean. To illustrate how these parameters work, consider the two sample reports below, using the reports Sales by State and All Metrics by Postcode. These instructions assume you have already created a custom external match bean for a report within this bean. For information on binding external data, see the section Binding External Data on page Location Intelligence Component v1.0

75 Chapter 4: Customizing Data Binding and Theming Sales by State All Metrics by Postcode Customizing Drills to Target a Layer When you customize the drill path, you set the tool to skip levels or to drill to a level other than the default identified by the default Business Objects hierarchy. To customize drilling to target a layer: 1. Open the bifaces-config file in a text editor. 2. Scroll to your external match bean that identifies the related binding. 3. Add the drillpath property (and all associated code) to your external match bean. 4. For drillpath, replace the default Store name with the name of the layer to which you want users to drill, for the report specified in the bean. 5. Save and close the file. 6. Restart your application server so your system can recognize your changes. In the example below, the sample regionnamesexternalmatch bean identifies the mapped report Sales by State. The resulting drill would expose Quantities figures in Connecticut and Massachusetts. The Sales data would be bypassed. <managed-bean> <managed-bean-name>regionnamesexternalmatch</managed-bean-name> <managed-bean-class> com.mapinfo.jsf.controls.bi.externalmatchbean </managed-bean-class> <managed-bean-scope>none</managed-bean-scope> <property-name>name</property-name> <value>states</value> Administration Guide 75

76 Additional Binding Customizations <property-name>databindcolumns</property-name> <list-entries> <value>state</value> </list-entries> <property-name>drillpath</property-name> <value>quantities</value> </managed-bean> Customizing Drills to Target a Secondary Report When you customize the drillreport property, the tool drills through the current report to the secondary report specified by the property. In this way, specific data becomes available to the user viewing the map. Note For this parameter to be successful, both reports must contain one identical column. To customize drilling to target a secondary report: 1. Open the bifaces-config file in a text editor. 2. Scroll to your external match bean that identifies the related binding. 3. Add the drillreport property (and all associated code) to your external match bean. 4. For drillreport, replace the default with the reportid associated with the report to which you want users to drill. Note To access the reportid parameter, click the report Properties link on the InfoView list of reports and view the properties this parameter is named the Document ID. 5. Save and close the file. 6. Restart your application server so your system can recognize your changes. In the example below, the sample regionnamesexternalmatch bean identifies the mapped report Sales by State; the drillreport property identifies the secondary report All Metrics by Postcode (reportid 22876). The resulting drill would expose zip codes in Connecticut and Massachusetts, bypassing the Sales and Quantity data on the first report. Users could continue to drill into data to view the Sales and Expenses data on the secondary report. <managed-bean> <managed-bean-name>regionnamesexternalmatch</managed-bean-name> <managed-bean-class> com.mapinfo.jsf.controls.bi.externalmatchbean </managed-bean-class> <managed-bean-scope>none</managed-bean-scope> <property-name>name</property-name> <value>states</value> 76 Location Intelligence Component v1.0

77 <property-name>databindcolumns</property-name> <list-entries> <value>state</value> </list-entries> <property-name>drillreport</property-name> <value>22876</value> </managed-bean> Chapter 4: Customizing Data Binding and Theming Defining the Zoom Range on Labels You can include labels for any column of report data in a custom layer. To further refine the usefulness of your layer labels, you can also define a zoom range. In this case, the labels are only visible on the map when users zoom within the set range; otherwise, the labels are not displayed. This prevents unnecessary clutter on the map and overlapping labels, both of which contribute to a less appealing presentation. To define zoom ranges on layer labels, use the two sample beans regionslabelminzoom bean and regionslabelmaxzoom bean, provided below. While these two beans are not included in the bifacesconfig file by default, they are included in this guide as samples for your use. To define the zoom range on layer labels: 1. Open the bifaces-config file in a text editor. 2. Copy the sample regionslabelminzoom managed bean code provided below and paste it into your bifaces-config file. 3. For the property managed-bean-name, replace the default regionslabelminzoom with the name of your new instance of the bean. For example, <managed-bean-name>countieslabelminzoom</managed-bean-name> 4. Copy the sample regionslabelmaxzoom managed bean provided below and paste it into your bifaces-config file. 5. For the property managed-bean-name, replace the default regionslabelmaxzoom with the name of your new instance of the bean. For example, <managed-bean-name>countieslabelmaxzoom</managed-bean-name> 6. Scroll to your custom internal match or external match instance with which you want to associate these labels. For example, if you are creating county label zoom instances, your match instance is also probably named countyinternalmatch or countyexternalmatch, depending on your requirements. 7. For the property-name labelminzoom, add a value line that identifies your new labelminzoom instance, as created above. For example, <property-name>labelminzoom</property-name> <value>#{countieslabelminzoom}</value> Administration Guide 77

78 Additional Binding Customizations 8. For the property-name labelmaxzoom, add a value line that identifies your new labelmaxzoom instance, as created above. For example, <property-name>labelmaxzoom</property-name> <value>#{countieslabelmaxzoom}</value> 9. Define your custom label zoom values and distance units, as required. 10. Save and close the file. 11. Restart your application server so your system can recognize your changes The sample regionslabelminzoom bean and the sample regionslabelmaxzoom bean are defined as follows, by default. <managed-bean> <managed-bean-name>regionslabelminzoom</managed-bean-name> <managed-bean-class> com.mapinfo.jsf.unit.distancebean </managed-bean-class> <managed-bean-scope>none</managed-bean-scope> <property-name>value</property-name> <value>500</value> </managed-bean> <property-name>unitabbreviation</property-name> <value>mi</value> </managed-bean> <managed-bean> <managed-bean-name>regionslabelmaxzoom</managed-bean-name> <managed-bean-class> com.mapinfo.jsf.unit.distancebean </managed-bean-class> <managed-bean-scope>none</managed-bean-scope> <property-name>value</property-name> <value>5000</value> </managed-bean> <property-name>unitabbreviation</property-name> <value>mi</value> </managed-bean> 78 Location Intelligence Component v1.0

79 Customizing the Default Zoom Levels on Labels Chapter 4: Customizing Data Binding and Theming Many layers include labelled data, which by default is set to appear on maps only within a given zoom range. For instance, the names of the continents would only appear on a map when the entire globe is displayed; these names would not appear when only one continent is displayed at close range. You can customize the zoom levels on these labels using the two sample managed beans, regionslabelminzoom and regionslabelmaxzoom. While these two beans are not provided in the bifaces-config file by default, they are provided in full as samples on page 78. The zoom levels for the identified layer changes according to your customizations. If you have other customized layers, and you want to customize the zoom levels for those layers, you should create instances of these two sample beans and associate them with each of the customized layers required. For information on creating custom instances of the sample LabelMinZoom and LabelMaxZoom managed beans, see the section Defining the Zoom Range on Labels on page 77. These instructions assume you have already created a custom instance for each of these beans and now want to customize the default standard zoom unit. To customize the standard label zoom unit for a layer: 1. Open the bifaces-config file in a text editor. 2. Scroll to your custom <x>labelminzoom managed bean code. 3. For the property value, replace the default 500 with the desired value. 4. Scroll to your custom <x>labelmaxzoom managed bean. 5. For the property value, replace the default 5000 with the desired value. 6. Save and close the file. Restart your application server so your system can recognize your changes. The zoom value settings for the sample regionslabelminzoom bean and the sample regionslabelmaxzoom bean are included below. These beans are not provided in the bifaces-config file by default; they are included here as samples. <managed-bean> <managed-bean-name>regionslabelminzoom</managed-bean-name> <managed-bean-class> com.mapinfo.jsf.unit.distancebean </managed-bean-class> <managed-bean-scope>none</managed-bean-scope> <property-name>value</property-name> <value>500</value> </managed-bean> <managed-bean> <managed-bean-name>regionslabelmaxzoom</managed-bean-name> <managed-bean-class> com.mapinfo.jsf.unit.distancebean </managed-bean-class> <managed-bean-scope>none</managed-bean-scope> Administration Guide 79

80 Understanding Custom Thematics <property-name>value</property-name> <value>5000</value> </managed-bean> Customizing Generic Report Styles for Layers The BI tool is customized using the bitool managed bean. This managed bean must be defined; otherwise, the BI tool does not function. The bitool managed bean is the top-level bean; it contains all necessary information for creating both internal and external data bindings for all reports. The addinternallayertool property and the addexternallayertool properties define which classes are used for internal and external binds. You should not need to modify these properties; however, they must be defined. The reportstyle property identifies the default or base report style for your map layers. This value is relative path from the <domain.dir>/resources/customstyles directory specified in the installation. Should your company want to implement custom styles, you can either add them to this directory, or you can repoint this URL to an alternate directory where your custom styles are located. If you make changes to this bean, you must restart your application server so your system can recognize your changes. By default, the reportstyle property is defined as follows: <property-name>reportstyle</property-name> <value>customstyles/bi/report</value> Understanding Custom Thematics In addition to the default thematics, the LIC also provides several custom thematic options that you can use to personalize your mapping presentations. The bifaces-config file hierarchy illustrated below demonstrates how default theming is nested using the sample bean themes. This bean allows you to define custom thematics. Custom thematics are tied to a specified data binding and a metric. In the bifaces-config file, custom thematics are defined in a hierarchical manner. - bitool + universes + efashion + externalmatches + citiesexternalmatch + geocontent - citiesgeoparams + themes 80 Location Intelligence Component v1.0

81 Chapter 4: Customizing Data Binding and Theming This section uses the sample report Cities (found in the customlayers/bi/botutorial directory) and all associated sample managed beans, to demonstrate how custom thematics are tied to bindings and how they can be defined in the LIC. The sample salesstatetheme1 bean (color style properties only) is included to demonstrate custom thematics specifically. The bitool identifies the universe (efashion) <managed-bean> <managed-bean-name>bitool</managed-bean-name> <managed-bean-class>com.mapinfo.jsf.bo.bobitoolbean</managed-bean-class> <managed-bean-scope>session</managed-bean-scope> <property-name>universename</property-name> <value>efashion</value> <property-name>universes</property-name> <map-entries> <value-class>com.mapinfo.jsf.controls.bi.universebean</value-class> <map-entry> <key>efashion</key> <value>#{efashion}</value> </map-entry> </map-entries> </managed-bean> A universe (efashion) identifies the targeted report (Cities) to the bitool bean <managed-bean> <managed-bean-name>efashion</managed-bean-name> <managed-bean-class>com.mapinfo.jsf.controls.bi.universebean</managedbean-class> <managed-bean-scope>none</managed-bean-scope> <property-name>externalmatches</property-name> <list-entries> <value-class>com.mapinfo.jsf.controls.bi.externalmatchbean</valueclass> <value>#{citiesexternalmatch}</value> </list-entries> </managed-bean> Administration Guide 81

82 Understanding Custom Thematics An external match (citiesexternalmatch) identifies the report s key column or columns (City) and the geographic data source (citiesgeoparams) <managed-bean> <managed-bean-name>citiesexternalmatch</managed-bean-name> <managed-bean-class>com.mapinfo.jsf.controls.bi.externalmatchbean</ managed-bean-class> <managed-bean-scope>none</managed-bean-scope> <property-name>name</property-name> <value>cities</value> <property-name>databindcolumns</property-name> <list-entries> <value>city</value> </list-entries> <property-name>geobindcolumns</property-name> <list-entries> <value>city</value> </list-entries> <property-name>geocontent</property-name> <value>#{citiesgeoparams}</value> </managed-bean> A geographic parameter (citiesgeoparams) identifies the key layer (City), the report s location and the custom thematic bean <managed-bean> <managed-bean-name>citiesgeoparams</managed-bean-name> <managed-bean-class>com.mapinfo.soleng.util.jsf.geoparamsbean</managedbean-class> <managed-bean-scope>none</managed-bean-scope> <property-name>layername</property-name> <value>cities</value> <property-name>layerpath</property-name> <value>customlayers/bi/botutorial</value> 82 Location Intelligence Component v1.0

83 Chapter 4: Customizing Data Binding and Theming <property-name>themes</property-name> <property-class>com.mapinfo.jsf.controls.mapping.themes</propertyclass> <list-entries> <value-class>com.mapinfo.jsf.controls.mapping.themebean</valueclass> <value>#{salesstatetheme1}</value> </list-entries> </managed-bean> A theme (salesstatetheme1) identifies your personalized thematic styles <managed-bean> <managed-bean-name>salesstatetheme1</managed-bean-name> <managed-bean-class>com.mapinfo.jsf.controls.mapping.rangedthemebean</ managed-bean-class> <managed-bean-scope>none</managed-bean-scope> <property-name>name</property-name> <value>theme1 Low Sales in Red</value> <property-name>attribute</property-name> <value>sales revenue</value> <property-name>begincolor</property-name> <value>red</value> <property-name>endcolor</property-name> <value>green</value> </managed-bean> Administration Guide 83

84 Understanding Custom Thematics The Cities report provides the following tabled data, which can be viewed using InfoView: The customized theming (identified in the code above as applied to this report on a map) is illustrated below: Theme Types There are several types of themes available with the LIC: Ranged themes Fixed Range themes Individual Value themes Charting themes 84 Location Intelligence Component v1.0

85 Chapter 4: Customizing Data Binding and Theming Ranged Themes A ranged theme shades features of a map based on the value of one of the feature's metrics. This type of theme operates on a specific column, where the value of this attribute is selected from all the features in the layer, thus creating a range of values. The range is partitioned and features are allocated to a band based on the value of the given attribute for that feature. For example, a map might display countries and their capitals showing the density of potential customers for a particular product shaded with graduated coloring the greater the potential, the darker (or lighter) the shade. Fixed Range Themes A fixed range theme shades features of a map based on the value of one of the feature s metrics, partitioning the range using fixed values. The boundary values specify the exact, absolute values that each thematic band spans. Using the example above, you may only be interested in the higher potential figures, so the theming might be limited to those capitals whose population density and therefore potential for sales is greatest. Individual Value Themes Individual value themes highlight individualized data from a particular column of your report. For example, an individual value theme might identify region features based on the values in the territories column. Territories with type values of southwest could be shaded red, while values of southeast could be shaded blue. You can identify both numerical and text values in individual values maps. As a numerical example, a soft drink distributor maintains a table of the supermarkets that buy soft drinks from him by postal code in Washington D.C. Each supermarket sells the distributor's brand of soft drink for a different price. If the distributor shades the postal code boundaries by price, using individual values, all stores that sell the soft drink for 49 cents are shaded one color, all stores that sell the soft drink for 51 cents are shaded another color, and so on. Each unique value is assigned its own color. The distributor is able to see the price distribution among the supermarkets and can determine where he should increase his sales volume, based on the price. If you are shading your points, lines, or boundaries using textual data, you can shade only by individual values. Textual data can be either numeric or non-numeric. Examples of non-numeric data include name, type of cuisine served, or brand of automobile sold. Dates are considered numeric data and can be used in both ranged and individual values maps. A textual data example might be the results of a consumer survey, where the question What is your favorite Sunday afternoon activity?" returns the following responses: 1. Sleeping 2. Watching TV 3. Taking a drive 4. Reading 5. Playing or watching sports. Administration Guide 85

86 Understanding Custom Thematics You want to shade each consumer point with the response for the favorite Sunday activity. The Sunday field of your dataset contains the number that corresponds to the consumer's favorite activity. However, the numbers in this column do not represent quantitative values. Playing or watching sports is not greater than Watching TV, even though 5 > 2. When numbers are used as names instead of values, you would shade your objects by individual values. The numbers are only used to reference the pastimes so a color can be assigned to it. Charting Themes Charting themes illustrate statistics in standard pie and bar chart formats. The LIC offers a shaded pie chart theme, a stacked bar chart theme and a side-by-side bar chart theme. The illustrations below show the same statistics in each of the three chart formats. These charts also can be layered on top of other theme types. Applying Colors to Themes You can apply a variety of colors to your themes. Valid colors for LIC themes are listed in the table below. Bolded items use non-standard RGB values. These non-standard colors were redefined to a more pastel appearance. You can define the colors using the color name or as an RGB color (for example, #RRGGBB). Color Name LIC RGB CSS RGB black # # blue #66CCFF #0000FF brown # #A52A2A cyan #00FFFF #00FFFF darkgray # #A9A9A9 gray # # green #66CC66 # Location Intelligence Component v1.0

87 Chapter 4: Customizing Data Binding and Theming lightbrown #C89600 n/a lightgray #C0C0C0 #D3D3D3 magenta #FF00FF #FF00FF orange #FFCC66 #FFA500 pink #FF9E9E #FFC0CB purple # # red #FF3333 #FF0000 white #FFFFFF #FFFFFF yellow #FFFFA0 #FFFF00 Disabling Auto-Theming on Maps The bitool managed bean automatically applies a default theme to all your users maps. Themes are drawn from the first metric in the mapped report, unless you have disabled the auto-theme property. If no custom theme is applicable to this report, the bitool bean applies the default theme. If you would like to apply custom theme styles to all your maps, or if you prefer to not use the auto-theme option at all, you can disable the auto-theming property. To disable auto-theming: 1. Open the bifaces-config file in a text editor. 2. Scroll to the bitool managed bean (see the sample code below. Only the applicable code is included here). 3. In the autothemefirstmetric property, set the associated value to false. 4. Save and close the file. 5. Restart your application server so your system can recognize your changes. The bitool managed bean (autothemefirstmetric property) should now appear as follows: <property-name>autothemefirstmetric</property-name> <value>false</value> Administration Guide 87

88 Creating Ranged, Fixed Range and Individual Value Themes Creating Ranged, Fixed Range and Individual Value Themes You can define any of the types of themes identified in the previous section. Create a custom theme using the internalmatch and externalmatch managed beans. This section provides information on creating a new individual value theme, a new ranged theme and a new fixed range theme. For information on configuring the existing default themes, see the section Customizing the Default Theme on page 134. All sample code provided in this section uses color values for theming. Should you have named styles you would prefer to use, this section ends with a topic on replacing the color values in the previous sample code with named styles. Creating Individual Value Themes In this section sample code is provided for a mapped report based on an individual value theme. In our sample report illustrated below, the fourth column is headed Sales Category, this being our individual value. 88 Location Intelligence Component v1.0

89 Chapter 4: Customizing Data Binding and Theming On the map, any values (Sales Category) of 1 are shaded in blue, while any values of 2 are shaded in red. You can define as many values as you need. The instructions included here assume you are creating a theme for an external match binding. If you are creating a theme for an internal match theme, the instructions are identical. Use the LatLongInternalMatch managed bean for this purpose. To create an individual value theme: 1. Open the bifaces-config file in a text editor. 2. Copy the sample highsales code below and paste it into the file. 3. Create a managed bean instance for each column in the report that you want to target, as follows: a. For managed-bean-name, replace the default highsales with the name of your new bean instance, one for each instance you want to define. (In the samples provided below, there are two instances: highsales and lowsales). b. For the property value, replace the default 1 and enter the value on the report you want to identify for mapping, once for each instance you want to define. c. For the property color, replace the default blue with the color you want use to represent that value on the map, once for each instance you want to define. 4. Copy the sample IndividualSalesCatTheme sample code below and paste it into the file. 5. Create a managed bean instance based on this sample code to reference the above instances, as follows: a. For managed-bean-name, replace the default IndividualSalesCatTheme with the name of your new bean instance. b. For the attribute property, replace the default Sales Category with the column heading as it appears on the report, whose values you want to map. c. For the name property, replace the default Individual Value Theme value with the name you want to appear in your users Theme Control pane for the new theme. d. For individualvalues, add a line for each column you want to target from the report to the map (for example, the sample columns targeted are the bean instances created above, highsales and lowsales). Administration Guide 89

90 Creating Ranged, Fixed Range and Individual Value Themes 6. Scroll to the regionnamesexternalmatch bean. 7. For the themes property, replace the default value with the name of your new theme, as follows: <value>#{individualsalescattheme}</value> 8. Configure any other external match bean properties, as required. For information on configuring external match beans, see the topic Binding External Data on page Save and close the file. 10. Restart your application server so your system can recognize your changes. The highsales sample instance and the lowsales sample instance are defined as follows: <managed-bean> <managed-bean-name>highsales</managed-bean-name> <managed-bean-class> com.mapinfo.jsf.controls.mapping.themeattributebean </managed-bean-class> <managed-bean-scope>none</managed-bean-scope> <property-name>value</property-name> <value>1</value> <property-name>color</property-name> <value>blue</value> </managed-bean> <managed-bean> <managed-bean-name>lowsales</managed-bean-name> <managed-bean-class> com.mapinfo.jsf.controls.mapping.themeattributebean </managed-bean-class> <managed-bean-scope>none</managed-bean-scope> <property-name>value</property-name> <value>2</value> <property-name>color</property-name> <value>red</value> </managed-bean> 90 Location Intelligence Component v1.0

91 The sample IndividualSalesCatTheme instance code is defined as follows: Chapter 4: Customizing Data Binding and Theming <managed-bean> <managed-bean-name>individualsalescattheme</managed-bean-name> <managed-bean-class> com.mapinfo.jsf.controls.mapping.individualvaluethemebean </managed-bean-class> <managed-bean-scope>none</managed-bean-scope> <property-name>attribute</property-name> <value>sales Category</value> <property-name>name</property-name> <value>individual Value Theme</value> <property-name>individualvalues</property-name> <list-entries> <value-class> com.mapinfo.jsf.controls.mapping.themeattributebean </value-class> <value>#{highsales}</value> <value>#{lowsales}</value> </list-entries> The regionnamesexternalmatch (list-entries only) is defined as follows, for our example: <property-name>themes</property-name> <property-class> com.mapinfo.jsf.controls.mapping.themes </property-class> <list-entries> <value-class> com.mapinfo.jsf.controls.mapping.themebean </value-class> <value>#{individualsalescattheme}</value> </list-entries> Creating Ranged Themes You can create a ranged theme for your users maps. Ranged themes draw on the value of an attribute from a table column, where all features from the map layer are allocated to a band based on the value of the given attribute for that feature. The sample code used here generates a ranged theme of Canadian population for the year 2003, using a blue to yellow color band. The data is divided into four equal count ranges. Administration Guide 91

92 Creating Ranged, Fixed Range and Individual Value Themes To create a ranged theme: 1. Open the bifaces-config file. 2. Copy the sample canadapietheme code, below, and paste it into the file. 3. For managed-bean-name, replace the default populationthemecanada with the name of your new ranged theme bean instance. 4. Leave the class and scope as is. 5. For the name property, replace the default Ranged Population with the name of your new ranged theme. This name appears to your users in the Theme Control pane. 6. Define all other properties for the bean as desired. 7. Scroll to the regionnamesexternalmatch bean to define your theme. 8. For the themes property, add a line to the list identifying your new ranged theme bean instance, as follows: <list-entries> <value-class>com.mapinfo.jsf.controls.mapping.themebean</valueclass> <value>#{populationthemecanada}</value> </list-entries> 9. Save and close the file. 10. Restart your application server so your system can recognize your changes. The sample populationthemecanada ranged theme bean instance is defined as follows: <managed-bean> <managed-bean-name>populationthemecanada</managed-bean-name> <managed-bean-class> com.mapinfo.jsf.controls.mapping.rangedthemebean </managed-bean-class> <managed-bean-scope>none</managed-bean-scope> <property-name>name</property-name> <value>ranged Population</value> <property-name>attribute</property-name> <value>pop 2003</value> <property-name>begincolor</property-name> <value>blue</value> <property-name>endcolor</property-name> 92 Location Intelligence Component v1.0

93 Chapter 4: Customizing Data Binding and Theming <value>yellow</value> <property-name>distributiontype</property-name> <value>equal Count</value> <property-name>numranges</property-name> <value>4</value> </managed-bean> The sample regionnamesexternalmatch managed bean (themes property only) is defined as follows, for our example: <property-name>themes</property-name> <property-class>com.mapinfo.jsf.controls.mapping.themes</propertyclass> <list-entries> <value-class>com.mapinfo.jsf.controls.mapping.themebean</valueclass> <value>#{rangedsalestheme}</value> </list-entries> Creating Fixed Range Themes The sample code used here generates a fixed range theme of sales across the country; three sales values are targeted. To create a fixed range theme: 1. Open the bifaces-conf file. 2. Copy the sample FixedRangeSalesTheme code below and paste it into the file. 3. For managed-bean-name, replace the default FixedRangeSalesTheme with the name of your new fixed ranged theme bean instance. 4. Leave the class and scope as is. 5. For the name property, replace the default Fixed Range Sales with the name of your new fixed ranged theme. This name appears to your users in the Theme Control pane. 6. For the attribute property, replace the default Sales with the name of the report column on which you want to define your fixed range theme. 7. For the rangebins property, replace the list entries values with a list of bean instances defining the fixed ranges you want to appear on your users maps. These instances will be created next. 8. Copy the sample sales1bin code below and paste it into the file, making as many copies of it as you have boundary values for your thematic band. Administration Guide 93

94 Creating Ranged, Fixed Range and Individual Value Themes 9. For each managed-bean-name, replace the default sales1bin with the name of each of your boundary values. 10. For the color property, enter a series of valid color values (one value for each sales<x>bin instance) to visually define the sales statistics on your map. 11. For each value property, replace the default with the exact value in the table you want to target for each boundary value. 12. Scroll to the <name>externalmatch bean where you want to define your theme. 13. For the themes property, add a line to the list identifying your new ranged theme bean instance, as follows: <list-entries> <value-class>com.mapinfo.jsf.controls.mapping.themebean</valueclass> <value>#{fixedrangesalestheme}</value> </list-entries> 14. Save and close the file. 15. Restart your application server so your system can recognize your changes. The sample FixedRangeSalesTheme fixed range theme bean instance is defined as follows, for our example: <managed-bean> <managed-bean-name>fixedrangesalestheme</managed-bean-name> <managed-bean-class> com.mapinfo.jsf.controls.mapping.fixedrangethemebean </managed-bean-class> <managed-bean-scope>none</managed-bean-scope> <property-name>name</property-name> <value>fixed Range Sales</value> <property-name>attribute</property-name> <value>sales</value> <property-name>rangebins</property-name> <list-entries> <value-class>com.mapinfo.jsf.controls.mapping.themeattributebean</ value-class> <value>#{sales1bin}</value> <value>#{sales2bin}</value> <value>#{sales3bin}</value> </list-entries> </managed-bean> 94 Location Intelligence Component v1.0

95 Chapter 4: Customizing Data Binding and Theming The sample sales1bin managed bean (representative of the three identified in the FixedRangeSalesTheme bean, above) is defined as follows, for our example: <managed-bean> <managed-bean-name>sales1bin</managed-bean-name> <managed-bean-class> com.mapinfo.jsf.controls.mapping.themeattributebean </managed-bean-class> <managed-bean-scope>none</managed-bean-scope> <property-name>color</property-name> <value>red</value> <property-name>value</property-name> <value> </value> </managed-bean> The sample <name>externalmatch managed bean (themes property only) is defined as follows, for our example: <property-name>themes</property-name> <property-class>com.mapinfo.jsf.controls.mapping.themes</propertyclass> <list-entries> <value-class>com.mapinfo.jsf.controls.mapping.themebean</valueclass> <value>#{fixedrangesalestheme}</value> </list-entries> Creating Themes Using Named Styles Themes are generated using either a color value or a named style. Color values can be identified using any of three valid values (the name, the RGB value or the Hex value). Brush named styles can include fill colors and translucencies, which display identically to a color value on a map. Named styles are based on either a pen (as in ), a brush ( ) or a symbol style ( ). If you have a named style you prefer to use for an individual value theme, a ranged theme or a fixed range theme, you can replace the color value with your named style to create a more customized effect on your maps. This section provides details on how to use named styles with themes. Note For simplicity, the sample code in this section identifies only the properties of the sample code that pertain to a theme s visual presentation. For full sample code configuration, refer to the associated theme topic, above. For more information on named styles, see the Location Intelligence Component Map Manager Guide. Administration Guide 95

96 Creating Ranged, Fixed Range and Individual Value Themes Individual Value Themes and Named Styles There are a variety of ways you can implement named styles with individual value themes. For instance, you can target a column in a table and identify the different values in that column each with their own brush style. While there are other possible configurations, this section provides details on using a brush named style, as an example. Brush Named Styles You can identify a single brush pattern in your individual value theme, or you can identify multiple patterns, as illustrated in the individual value theme topic above, where two color values (that is, blue and red) were defined. The resulting map would display the data as patterns rather than colors. In this topic, the sample code uses the sample brush patterns AcmeDashed and AcmeHatched. To create an individual value theme using a brush named style: 1. Save the named styles AcmeDashed and AcmeHatched in your /resources/customstyles/ directory, so the LIC can find it. 2. Define your new theme as indicated in the topic Creating Individual Value Themes on page 88. You must define a managed bean instance for each column of data you want mapped (as in the sales<x>bin sample beans), a theme bean based on the salesstatetheme<x> instances, and a theme bean based on the regionnamesexternalmatch instance, as outlined in the topic above. 3. In the sales1bin managed bean, replace the property-name color with style, to indicate that you are referencing a named style. 4. Replace the value blue with the filepath to your named style. In our sample code below, the path to the named style AcmeDashed is inserted. 5. In the sales2bin managed bean, replace the property-name color with style, to indicate that you are referencing a named style. 6. Replace the value red with the filepath to your named style. In our sample code below, the path to the named style AcmeHatched is inserted. 7. Save and close the file. 8. Restart your application server so your system can recognize your changes. The sales1bin sample instance and the sales2bin sample instance are defined as follows: <managed-bean> <managed-bean-name>sales1bin</managed-bean-name> <managed-bean-class> com.mapinfo.jsf.controls.mapping.themeattributebean </managed-bean-class> <managed-bean-scope>none</managed-bean-scope> <property-name>style</property-name> <value>customstyles/acmestyles/acmedashed</value> 96 Location Intelligence Component v1.0

97 <property-name>value</property-name> <value>1</value> </managed-bean> Chapter 4: Customizing Data Binding and Theming <managed-bean> <managed-bean-name>sales2bin</managed-bean-name> <managed-bean-class> com.mapinfo.jsf.controls.mapping.themeattributebean </managed-bean-class> <managed-bean-scope>none</managed-bean-scope> <property-name>style</property-name> <value>customstyles/acmestyles/acmehatched</value> <property-name>value</property-name> <value>2</value> </managed-bean> Ranged Themes and Named Styles When you identify a range of color values or styles, the LIC extrapolates any intermediate colors or styles not explicitly stated in the bean properties. For example, in the sample code on page 92 the colors blue and yellow are stated, but there are four values required for the range, so the LIC automatically adds red and orange to the theming range (that is, blue red orange yellow), since that is the standard color progression. As a result, you are only required to have a pair of named styles for a ranged theme in order to create a full range. Since the LIC extrapolates style data, your beginstyle and endstyle must be of the same style type. For example, you cannot combine a brush pattern with a translucent style, or a symbol with a pattern. Symbols and patterns do not have a natural progression and therefore cannot be combined as a ranged theme unless the range number is two; the styles in this case are not required to be related. Note You can use multiple patterns and symbols in an individual value theme. Administration Guide 97

98 Creating Ranged, Fixed Range and Individual Value Themes The following table illustrates valid and invalid combinations. Valid Combinations and Invalid Combinations and and and and and and and and and and and The sample code used below generates a ranged theme of Canadian population for the year 2003 and the data is divided into four equal count ranges, as per the ranged theme topic above. However, instead of a solid fill color band the code applies a translucent color band based on two translucent color named styles. For information on creating translucent named styles, see the Location Intelligence Component Map Manager Guide. In this topic, the sample code uses the brush patterns AcmeOpac100 and AcmeOpac25 ; the LIC automatically extrapolates a shade for AcmeOpac75 and AcmeOpac50 from these two styles. To create an ranged theme using a translucent named style: 1. Save the named styles AcmeOpac100 and AcmeOpac25 in your /resources/customstyles/ directory, so the LIC can find them. 2. Define your new theme as indicated in the topic Creating Ranged Themes on page 91. You must define a managed bean instance (as in the populationthemecanada sample bean) and a theme bean based on the <name>externalmatch instance, as outlined in the topic above. 3. In the populationthemecanada managed bean, replace the property-name begincolor with beginstyle, to indicate that you are referencing a named style rather than a color value. 4. Replace the value blue with the filepath to your named style. In our sample code below, the path to the named style AcmeOpac100 is inserted. 5. In the populationthemecanada managed bean, replace the property-name endcolor with endstyle, to indicate that you are referencing a named style rather than a color value. 6. Replace the value yellow with the filepath to your named style. In our sample code below, the path to the named style AcmeOpac25 is inserted. 7. Save and close the file. 8. Restart your application server so your system can recognize your changes. 98 Location Intelligence Component v1.0

99 Chapter 4: Customizing Data Binding and Theming The properties associated with named styles in the populationthemecanada sample instance are defined as follows: <property-name>beginstyle</property-name> <value>customstyles/acmestyles/acmeopac100</value> <property-name>endstyle</property-name> <value>customstyles/acmestyles/acmeopac25</value> Fixed Range Themes and Named Styles Fixed range themes use specific values for each range, so if you are using named styles a named style must exist in your customstyles directory for each range identified. In this topic, the sample code uses the color named style AcmeBrown, AcmeOrange, and AcmeYellow. To create an fixed range theme using a series of color named styles: 1. Save the named styles AcmeBrown, AcmeOrange and AcmeYellow in your /resources/ customstyles/ directory, so the LIC can find them. 2. Define your new theme as indicated in the topic Creating Fixed Range Themes on page 93. You must define a managed bean instance (as in the FixedRangeSalesTheme sample bean), a bean instance for each of the ranges required based on the sales<x>bin instance and a theme bean based on the <name>externalmatch instance, as outlined in the topic above. 3. In the sales1bin managed bean, replace the property-name color with style, to indicate that you are referencing a named style rather than a color value. 4. Replace the value red with the filepath to your named style. In our sample code below, the path to the named style AcmeOrange is inserted. 5. In the sales2bin managed bean, replace the property-name color with style. 6. Replace the color value with the filepath to your named style (in our sample case, AcmeOrange). 7. In the sales3bin managed bean, replace the property-name color with style. 8. Replace the color value with the filepath to your named style (in our sample case, AcmeBrown). 9. Save and close the file. Restart your application server so your system can recognize your changes. Administration Guide 99

100 Creating Pie and Bar Chart Themes The sample sales1bin sample instance is defined below. <managed-bean> <managed-bean-name>sales1bin</managed-bean-name> <managed-bean-class> com.mapinfo.jsf.controls.mapping.themeattributebean </managed-bean-class> <managed-bean-scope>none</managed-bean-scope> <property-name>style</property-name> <value>customstyles/colors/acmeorange</value> <property-name>value</property-name> <value> </value> </managed-bean> Creating Pie and Bar Chart Themes You can implement charting themes into your company s theming at any time. Charting themes are implemented by defining a unique theme managed bean for the pie or bar chart and then referencing this theme bean in a related internalmatch or externalmatch bean (depending on the type of bind required). You can add pie and bar charts to your map theming using the PieChartThemeBean bean, the StackBarChartThemeBean and the SideBySideBarChartThemeBean. For example, you might want to shade a locale by Profits and then produce a pie chart on top of each locale demonstrating the ratio of Sales to Expenses. This would result in three themed items on a single report of data a layer of shading, topped by a series of pie or bar charts indicating ratios. All pie and bar chart themes use common properties; these common properties are defined in the table Common Charting Bean Properties on page 60. Since the bifaces-config file does not include sample pie and bar chart theming code, this section provides sample code for possible customizations you can make to the existing beans. All samples given here reference a related match bean, assuming that you have already created your own unique external or internal match bean, as required. These instructions further assume that you are referencing this match bean in your company s defined universe managed bean. 100 Location Intelligence Component v1.0

101 Chapter 4: Customizing Data Binding and Theming Creating a Pie Chart Theme You can display columns of report data on a map layer using pie charts. With pie charts, you must identify the metrics to be charted and the size, shape and positioning of the pies. To create a pie chart theme: 1. Open the bifaces-config file. 2. Copy the sample code for the countypietheme bean instance, provided below. 3. For managed-bean-name, replace the default countypietheme name with the name of your custom pie chart theme. 4. For the property name, replace the default Counties Pie Chart with the name of your new theme. This name appears in your users Theme Control pane. 5. For the property attributes, enter a series of list-entries values to identify the metrics you want to illustrate in your pie charts. For example, <list-entries> <value>cost</value> <value>profit</value> <value>revenue</value> </list-entries> 6. Customize other properties of interest to you, as defined in the table Common Charting Bean Properties on page In the related match bean, for themes reference the new pie chart theme bean as follows: <property-name>themes</property-name> <property-class>com.mapinfo.jsf.controls.mapping.themes</propertyclass> <list-entries> <value-class>com.mapinfo.jsf.controls.mapping.themebean</valueclass> <value>#{countypietheme}</value> </list-entries> 8. Save and close the file. 9. Restart your application server so your system can recognize your changes. The following sample code defines a pie chart for a report that includes the metrics Cost, Profit and Revenue at County level. It includes half pies of a 30-pixel fixed size (not graduated), positioned to the bottom with wedges drawn clockwise. <managed-bean> <managed-bean-name>countypietheme</managed-bean-name> <managed-bean-class> com.mapinfo.jsf.controls.mapping.piechartthemebean </managed-bean-class> <managed-bean-scope>none</managed-bean-scope> Administration Guide 101

102 Creating Pie and Bar Chart Themes <property-name>name</property-name> <value>counties Pie Chart</value> <property-name>attributes</property-name> <list-entries> <value>cost</value> <value>profit</value> <value>revenue</value> </list-entries> <property-name>maxsize</property-name> <value>30</value> <property-name>graduated</property-name> <value>false</value> <property-name>position</property-name> <value>bottom</value> <property-name>fullpies</property-name> <value>false</value> <property-name>drawnclockwise</property-name> <value>true</value> </managed-bean> Your related ExternalMatch managed bean (themes property only) would be defined as follows: <managed-bean> <managed-bean-name>countyexternalmatch</managed-bean-name> <managed-bean-class>com.mapinfo.jsf.controls.bi.externalmatchbean</ managed-bean-class> <managed-bean-scope>none</managed-bean-scope> <property-name>themes</property-name> <property-class>com.mapinfo.jsf.controls.mapping.themes</propertyclass> <list-entries> 102 Location Intelligence Component v1.0

103 Chapter 4: Customizing Data Binding and Theming <value-class>com.mapinfo.jsf.controls.mapping.themebean</valueclass> <value>#{countypietheme}</value> </list-entries> </managed-bean> Creating a Stacked Bar Chart Theme You can also display columns of report data on a map layer using bar charts. Bar charts can be defined as stacked bar charts or as side-by-side bar charts, depending on which bean class you associated it against. As with pie charts, you must identify the metrics to be charted and the size, shape and positioning of the bars. To create a stacked bar chart theme: 1. Open the bifaces-config file. 2. Copy the sample code for the countystackedbartheme bean instance, provided below. 3. For managed-bean-name, replace the default countystackedbartheme name with the name of your custom stacked bar chart theme. 4. For the property name, replace the default Counties Stacked Bar Chart with the name of your new theme. This name appears in your users Theme Control pane. 5. For the property attributes, enter a series of list-entries values to identify the metrics you want to illustrate in your bar charts. For example, <list-entries> <value>cost</value> <value>profit</value> <value>revenue</value> </list-entries> 6. Customize other properties of interest to you, as defined in the table Common Charting Bean Properties on page In the related match bean, for themes reference the new pie chart theme bean as follows: <property-name>themes</property-name> <property-class>com.mapinfo.jsf.controls.mapping.themes</propertyclass> <list-entries> <value-class>com.mapinfo.jsf.controls.mapping.themebean</valueclass> <value>#{countystackedbartheme}</value> </list-entries> 8. Save and close the file. 9. Restart your application server so your system can recognize your changes Administration Guide 103

104 Creating Pie and Bar Chart Themes The following sample code defines a stacked bar chart on the Cost, Profit and Revenue metrics. It includes a customized bar width of 30 pixels. <managed-bean> <managed-bean-name>countystackedbartheme</managed-bean-name> <managed-bean-class> com.mapinfo.jsf.controls.mapping.stackedbarchartthemebean </managed-bean-class> <managed-bean-scope>none</managed-bean-scope> <property-name>name</property-name> <value>counties Stacked Bar Chart</value> <property-name>attributes</property-name> <list-entries> <value>cost</value> <value>profit</value> <value>revenue</value> </list-entries> <property-name>width</property-name> <value>30</value> </managed-bean> Your related ExternalMatch managed bean (themes property only) would be defined as follows: <managed-bean> <managed-bean-name>countyexternalmatch</managed-bean-name> <managed-bean-class>com.mapinfo.jsf.controls.bi.externalmatchbean</ managed-bean-class> <managed-bean-scope>none</managed-bean-scope> <property-name>themes</property-name> <property-class>com.mapinfo.jsf.controls.mapping.themes</propertyclass> <list-entries> <value-class>com.mapinfo.jsf.controls.mapping.themebean</valueclass> <value>#{countystackedbartheme}</value> </list-entries> </managed-bean> 104 Location Intelligence Component v1.0

105 Creating a Side-by-Side Bar Chart Theme Chapter 4: Customizing Data Binding and Theming You can display columns of report data on a map layer using bar charts. Bar charts can be defined as stacked bar charts or as side-by-side bar charts, depending on which bean class you associated it against. You must identify the metrics to be charted and the size, shape and positioning of the bars. To create a side-by-side bar chart theme: 1. Open the bifaces-config file. 2. Copy the sample code for the countysidebysidebartheme bean instance, provided below. 3. For managed-bean-name, replace the default countysidebysidebartheme name with the name of your custom side-by-side bar chart theme. 4. For the property name, replace the default Counties Side By Side Bar Chart with the name of your new theme. This name appears in your users Theme Control pane. 5. For the property attributes, enter a series of list-entries values to identify the metrics you want to illustrate in your bar charts. For example, <list-entries> <value>cost</value> <value>profit</value> <value>revenue</value> </list-entries> 6. Customize other properties of interest to you, as defined in the table Common Charting Bean Properties on page In the related match bean, for themes reference the new pie chart theme bean as follows: <property-name>themes</property-name> <property-class>com.mapinfo.jsf.controls.mapping.themes</propertyclass> <list-entries> <value-class>com.mapinfo.jsf.controls.mapping.themebean</valueclass> <value>#{countysidebysidebartheme}</value> </list-entries> 8. Save and close the file. 9. Restart your application server so your system can recognize your changes. The following sample code defines a side-by-side bar chart on the Cost, Profit and Revenue metrics. It includes a customized bar width of 30 pixels and independent scaling. <managed-bean> <managed-bean-name>countysidebysidebartheme</managed-bean-name> <managed-bean-class> com.mapinfo.jsf.controls.mapping.sidebysidebarchartthemebean </managed-bean-class> <managed-bean-scope>none</managed-bean-scope> Administration Guide 105

106 Creating Pie and Bar Chart Themes <property-name>name</property-name> <value>counties Side-by-Side Bar Chart</value> <property-name>attributes</property-name> <list-entries> <value>cost</value> <value>profit</value> <value>revenue</value> </list-entries> <property-name>width</property-name> <value>30</value> <property-name>eachbarindependentlyscaled</property-name> <value>true</value> </managed-bean> Your related ExternalMatch managed bean (themes property only) would be defined as follows: <managed-bean> <managed-bean-name>countyexternalmatch</managed-bean-name> <managed-bean-class>com.mapinfo.jsf.controls.bi.externalmatchbean</ managed-bean-class> <managed-bean-scope>none</managed-bean-scope> <property-name>themes</property-name> <property-class>com.mapinfo.jsf.controls.mapping.themes</propertyclass> <list-entries> <value-class>com.mapinfo.jsf.controls.mapping.themebean</valueclass> <value>#{countysidebysidebartheme}</value> </list-entries> </managed-bean> 106 Location Intelligence Component v1.0

107 Combining Multiple Types of Themes You can combine themes at any time in two ways: Chapter 4: Customizing Data Binding and Theming Adding lists of themes through a match bean instance Implementing one theme inside another theme definition (also known as chaining) This section provides details on both these options. Adding Lists of Themes Through a Match Bean Instance Charting themes are defined and then referenced by either an internalmatch bean or an externalmatch bean. This section provides details on implementing a charting theme. To add a list of themes to a layer: 1. Create a custom internal or external match bean instance, using one of the sample implementations given either in the section Creating Universes on page 67 or in the section Binding External Data on page 70 (for example, countiesexternalmatchbean). 2. Create a series of different types of themes using any of the samples given in the section Creating Ranged, Fixed Range and Individual Value Themes on page 88 (for example, countiessidebysidebarcharttheme and postcodesrangetheme). 3. Open the bifaces-config file in a text editor. 4. Scroll to your new match bean instance, created in step For themes, create a list of key/value pairs, one pair for each theme you want to reference: a. For each theme, create a key value, using your new theme name created in step 2. This name appears on your users Theme Control pane. b. For each key create a value entry, which references the new ThemeBean. The sample code for two themes (Side-By-Side Bar Charts and Post Codes Range theme) appears below: 6. Save and close the file. 7. Restart your application server so your system can recognize your changes. The sample countiesexternalmatch managed bean (themes property only) is defined as follows: <property-name>themes</property-name> <property-class>com.mapinfo.jsf.controls.mapping.themes</propertyclass> <list-entries> <value-class>com.mapinfo.jsf.controls.mapping.themebean</valueclass> <value>#{countiessidebysidebarcharttheme}</value> <value>#{postcodesrangetheme}</value> </list-entries> Administration Guide 107

108 Combining Multiple Types of Themes Chaining Themes You can combine multiple themes by defining one inside another, an implementation called chaining. This section provides a sample implementation for chaining two themes: a pie chart theme and a ranged theme. Notice that the States Pie Theme, illustrated in the lefthand implementation, is a single theme a single legend appears in the Theme Control pane. The Ranged Population, illustrated in the righthand implementation, is a chained theme two legends appear in the Theme Control pane. To chain themes: 1. Open your bifaces-config file in a text editor. 2. Create multiple themes. For our example, we have created two themes: statespietheme, based on the pie chart theming implementation, and populationthemestates, based on the ranged theming implementation. Sample code for the pie chart theme implementation (statespietheme) which chains a second theme (populationthemestates) using the themes property: <managed-bean> <managed-bean-name>statespietheme</managed-bean-name> <managed-bean-class> com.mapinfo.jsf.controls.mapping.piechartthemebean </managed-bean-class> <managed-bean-scope>none</managed-bean-scope> <property-name>name</property-name> <value>states Pie Chart</value> <property-name>attributes</property-name> <list-entries> <value>sales</value> <value>expenses</value> 108 Location Intelligence Component v1.0

109 Chapter 4: Customizing Data Binding and Theming </list-entries> <property-name>theme</property-name> <value>#{populationthemestates}</value> <property-name>colors</property-name> <list-entries> <value>red</value> <value>green</value> </list-entries> <property-name>styles</property-name> <list-entries> <value>\customstyles\colors\transparentblue</value> <value>\customstyles\colors\transparentred</value> </list-entries> <property-name>graduated</property-name> <value>true</value> <property-name>graduationmethod</property-name> <value>sqrt</value> <property-name>graduationsize</property-name> <value>10</value> <property-name>graduationvalue</property-name> <value>35000</value> <property-name>maxsize</property-name> <value>50</value> <property-name>offsetx</property-name> <value>0</value> Administration Guide 109

110 Combining Multiple Types of Themes <property-name>offsety</property-name> <value>0</value> <property-name>position</property-name> <value>lowerleft</value> <property-name>drawnclockwise</property-name> <value>true</value> <property-name>fullpies</property-name> <value>true</value> <property-name>startangle</property-name> <value>180</value> </managed-bean> Sample code for the ranged theming implementation, which was chained into the previous theme (statespietheme): <managed-bean> <managed-bean-name>populationthemestates</managed-bean-name> <managed-bean-class> com.mapinfo.jsf.controls.mapping.rangedthemebean </managed-bean-class> <managed-bean-scope>none</managed-bean-scope> <property-name>name</property-name> <value>ranged Population</value> <property-name>attribute</property-name> <value>pop 1990</value> <property-name>begincolor</property-name> <value>blue</value> <property-name>endcolor</property-name> 110 Location Intelligence Component v1.0

111 Chapter 4: Customizing Data Binding and Theming <value>yellow</value> <property-name>distributiontype</property-name> <value>equal Count</value> <property-name>numranges</property-name> <value>4</value> </managed-bean> Administration Guide 111

112 Combining Multiple Types of Themes 112 Location Intelligence Component v1.0

113 Global Map Settings and Managed Beans 5 This chapter identifies all managed beans that handle map look and feel for your entire user base. Changes take place in one place the mapxtrememapping-faces-config file and are applied globally. Overview of the mapxtreme-mapping-faces-config File Beans that Handle Basic Mapping Settings

114 Overview of the mapxtreme-mapping-faces-config File Overview of the mapxtreme-mapping-faces-config File The mapxtreme-mapping-faces-config file contains managed beans that define how your users maps are presented. MapXtreme-specific information, including Map Manager tools, layer control setup, default thematic and legend settings, are also configured in this file. Also included in this file are a few sample managed beans, to assist you in customizing the LIC to your company s requirements. Understanding the Managed Bean Hierarchy The following illustration demonstrates the nesting of managed beans in the mapxtreme-mapping-facesconfig file. - MapToolSet + map + minzoomlimit (sample) + maxzoomlimit (sample) + defaulttheme + defaultlegend + toolbeans - drilltoolbean - infotoolbean + printtoolbean + papersizes - papersizes1-3 (samples) + selectiontoolbean + bufferedlinedistances - bufferedlinedistance1-5 (samples) + layers + MyLayers + layers - stateslayer (sample) - layergroupstree Beans that Handle Basic Mapping Settings This section contains tabled information on all of the managed beans found in the mapxtreme-mappingfaces-config file. Each table includes a description of a single managed bean. All associated classes, inheritance, properties and sample code are also included for the bean. For sample code and assistance in configuring these managed beans, see the next chapter, Customizing Global Map Settings and Defaults on page Location Intelligence Component v1.0

115 Chapter 5: Global Map Settings and Managed Beans About the Syntax Use the following guidelines when customizing the mapxtreme-mapping-faces-config file: All changes should be made using a proper text editor, where classes, properties and values are color-coded. Errors are much easier to spot and debug. Order of elements is set. Do not change the order unless you are reordering a list of property values. For example, the order of the value elements listed below is a matter of personal preference, not a syntax requirement. <list-entries> <value>europe</value> <value>post Codes</value> </list-entries> On the other hand, if you rearrange any of the following lines of code, the bean no longer recognizes the reordered element. <managed-bean> <managed-bean-name>mylayers</managed-bean-name> <managed-bean-class> com.mapinfo.jsf.controls.mapping.layergroupbean </managed-bean-class> <managed-bean-scope>none</managed-bean-scope> <property-name>friendlyname</property-name> <value>my Layers</value> </managed-bean> Beans and bean properties both can be either required or optional. Each table in this chapter identifies a bean s required status immediately following the bean description. If the Required status is Yes, the bean must be defined. The required status for all bean properties are identified in the tables using square brackets: if a property is named within square brackets (for example, [labelcolumn]), defining the property is optional. If no brackets are used (for example, name), the property is required when the bean is defined. Do not enter the brackets when specifying optional elements. Values (<value></value>) are strings. Elements in angle brackets may be any of the types found in the table below. Value Type Description boolean const float Valid values are true and false. If the bean is defined, this value must be set. Value must be all capitals, optionally separated by _ (for example, MAXSIZE, USER_ID). Any number, including zero and negative numbers. Administration Guide 115

116 Beans that Handle Basic Mapping Settings Value Type Description integer string Any positive number. Common English text. Sometimes the string is a URL to a directory installed with the LIC, and sometimes the string is text displayed on the interface to users. Map Settings Beans MapToolSet Description Required Class Scope Properties Defines all LIC tools, including both external-facing tools provided on the Mapping toolbar and internal tools used by the LIC exclusively. Yes com.mapinfo.jsf.controls.mapping.maptoolsetbean application tools The following tools are identified as a key in the XML file and currently appear on the Mapping toolbar: deselect, drill, info, pan, print, removelayer, selectatpoint, selectinboundary, selectinbufferedline, selectinradius, submitselection, theme, zoomin, zoomto, zoomout. Note The following tools are also defined as keys in the bean: addlineannotation, addnamedmap, addpointannotation, recenter, bounds, rendermap, reset, resizemap and ruler. The LIC uses these tools to execute internal tasks (for example, load data and redraw maps) when the tools on the Mapping toolbar are triggered. map Description Required Class Scope Children Defines the default map properties and URLs for the local installation. Most of the properties in this bean are defined at installation time and do not require configuring. Yes com.mapinfo.jsf.mapxtreme.mapping.mapxtrememapbean session minzoomlimit Derived from the property minzoomlimit 116 Location Intelligence Component v1.0

117 Chapter 5: Global Map Settings and Managed Beans map (continued) maxzoomlimit Derived from the property maxzoomlimit defaulttheme Derived from the property defaulttheme defaultlegend Derived from the property defaultlegend drilltoolbean Derived from the property toolbeans infotoolbean Derived from the property toolbeans printtoolbean Derived from the property toolbeans selectiontoolbean Derived from the property toolbeans mylayers Derived from the property layers Properties defaultmap Identifies which named map is used as the basemap. The value is a relative path from your resources directory (under the domain directory you specified at install time). Default: custommaps/states mapxtremeservleturl Defines the URL to the MapXtreme servlet in the bimxtj481 directory. This value is set when you install the product. Default: <application-server-url>/bimxtj481/mapxtreme namedresourcesurl Defines the URL to the named resources directory. This value is set when you install the product. Default: <application-server-url>/<domain-directory>/resources imagespath This property has been deprecated. Administration Guide 117

118 Beans that Handle Basic Mapping Settings imagesurl Defines the URL to the directory defined above for referencing the map and legend images from the main mapping page. This value is set when you install the product. Default: <application-server-url>/domain/images mimetype map (continued) The mime type for images created by the LIC. The supported mime types are image/ gif, image/jpg, image/jpeg and image/png. Note If your users are printing maps, the only valid format is gif. Default: image/gif Type: string antialias The rendering quality of the map. This parameter only applies when MapXtreme is used to render map images. Default: false imagewidth Defines the width in pixels of the map in the LIC. Default: 720 imageheight Defines the height in pixels of the map in the LIC. Default: 600 minzoomlimit The minimum size at which a user can view a map. This property contains the nested bean minzoomlimit. maxzoomlimit The maximum size at which a user can view a map. This property contains the nested bean maxzoomlimit. defaulttheme Defines the type of theme used in the Theme Control window for report metric columns. This property contains the nested bean defaulttheme. defaultlegend Defines the default settings for the legend (currently, the image type generated). This property contains the nested bean defaultlegend. 118 Location Intelligence Component v1.0

119 Chapter 5: Global Map Settings and Managed Beans map (continued) toolbeans This property contains the class com.mapinfo.jsf.controls.mapping.maptoolbean and the nested beans drilltoolbean, infotoolbean, printtoolbean and selectiontoolbean. Valid values: print, selection, drill layers Layers in a map can be grouped for the purpose of organizing your layers for your Layer Control pane. This property lists all the groups you want to display in the Layer Control pane. There can be 1 to n number of groups. This property contains the class com.mapinfo.jsf.controls.mapping.layers and the nested bean mylayers. All layers outside the mylayers option are drawn from the value class com.mapinfo.jsf.controls.mapping.maplayerbean. Note Generated maps are created from three things: your basemap, the layer you matched, and any additional layers identified here. More commonly, these layers would be defined as part of the basemap. minzoomlimit Description Required Class Scope Parent Properties The minimum zoom limit users can apply to any map in the Map view. Yes com.mapinfo.jsf.unit.distancebean none map value The minimum value allowed for zooming. Default: 0.1 unitabbreviation The unit in which the zoom limit is labelled, in short form. Valid values include mi, km, m, yd and ft. Default: mi Type: string Administration Guide 119

120 Beans that Handle Basic Mapping Settings maxzoomlimit Description Required Class Scope Parent Properties The maximum zoom limit users can apply to any map in the Map view. Yes com.mapinfo.jsf.unit.distancebean none map value The maximum value allowed for zooming. Default: unitabbreviation The unit in which the zoom limit is labelled, in short form. Valid values include mi, km, m, yd and ft. Default: mi Type: string defaulttheme Description Required Class Scope Parent Represents the default thematic representation when a Business Objects metric column for a geographic attribute has not been defined in the bifaces-config file. Yes (Default theme behavior must be defined) com.mapinfo.jsf.controls.mapping.rangedthemebean none map 120 Location Intelligence Component v1.0

121 Chapter 5: Global Map Settings and Managed Beans defaulttheme (continued) Properties [begincolor] Defines the color for the starting range value for the default theme or undefined range thematics. If you are defining the color using color values, you must identify a java.awt.color constant. Valid values are black, blue, cyan, gray, darkgray, lightgray, green, magenta, orange, pink, red, white or yellow. You can also use a named style instead of a color value. If you have defined a named style you prefer to reference (for instance, to allow layer transparency), use the beginstyle property instead. For more information on using named styles, see the section For information on defining named styles, see the Map Manager Guide. Default: white Type: const [endcolor] Defines the color for the ending range value for the default theme or undefined range thematics. The value must be a java.awt.color constant. Valid values are black, blue, cyan, gray, darkgray, lightgray, green, magenta, orange, pink, red, white or yellow. If you have defined a named style you prefer to reference, you can also use the endstyle property instead. Default: red Type: const [distributiontype] Defines the distribution type for the theme. This value determines the methodology for grouping the attribute values into common ranges. Valid types are Equal Count, Equal Ranges, Standard Deviation, Natural Breaks and Custom Ranges. These values are defined in the resource bundle file messages.properties. This file is stored in the mifaces.jar file. Default: Equal Count Type: string [numranges] Defines how many ranges to create for the default thematic. Default: 4 Type: integer defaultlegend Description Required Class Represents the default legend properties for any undefined thematics or any defined thematics that want to use the default legend settings. Yes com.mapinfo.jsf.controls.mapping.legendbean Administration Guide 121

122 Beans that Handle Basic Mapping Settings defaultlegend (continued) Scope Parent Properties none map format Defines how the mime-type is to be used when rendering legend images. The supported formats are image/jpg, image/jpeg, image/gif and image/png. Note If your users are printing maps, only the format gif is valid. Default: image/gif Type: string drilltoolbean Description Required Class Scope Parent Properties Controls drilling capabilities for LIC maps. No com.mapinfo.jsf.controls.bi.drillmaptoolbean none map clicktolerance Defines the tolerance (size of the search area) used by the drilling tool on the map. The size of the point is set in pixels and has a default value of 3, which defines a 3 by 3 pixel box centered on the point clicked. Default: 3 Type: float infotoolbean Description Required Class Scope Controls the behavior of the Info Tool. Yes com.mapinfo.jsf.controls.mapping.infomaptoolbean none 122 Location Intelligence Component v1.0

123 Chapter 5: Global Map Settings and Managed Beans infotoolbean (continued) Parent Properties map clicktolerance Defines the tolerance (size of the search area) used by the Info Tool on the map. This point corresponds to the point at which a user clicks on the map when using the Info Tool. The size of the point is set in pixels, and has a default value of 5, which defines a 5 by 5 pixel box centered on the point clicked. This value can be modified as necessary to adjust the click tolerance. Default: 5 Type: float printtoolbean Description Required Class Scope Parent Sample Children Properties Controls all printing capabilities for LIC maps. Yes com.mapinfo.jsf.controls.mapping.printmaptoolbean none map papersize1 - papersize3 All derived from the property papersizes. papersizes List of all paper size options available for printing map images through the LIC. This property contains the class com.mapinfo.jsf.controls.mapping.papersizebean and the following list of paper size options: 8 x 11, 9 x 14, 11 x 17. These options reference the nested beans papersize1, papersize2 and papersize3. Default: Derived from the property papersize. papersize The default size identified in papersizes, above. This property contains the nested bean papersize1. Default: #{papersize1} Type: float dpi The DPI setting for printing map images. Default: 96 Type: integer Administration Guide 123

124 Beans that Handle Basic Mapping Settings There are three sample papersize managed beans identified in the printtoolbean managed bean, to demonstrate its potential. However, only the sample managed bean papersize1 is provided here for simplicity. papersize1 Description Required Class Scope Parent Properties A sample paper size bean, which defines the default paper size for printing map images through the LIC. There are three sample paper size beans included with the LIC (papersize1 - papersize3), one for each of the three default North American paper sizes. You can define as many or as few paper sizes as required by your company. Use the three sample papersize<x> beans provided for reference. Yes com.mapinfo.jsf.controls.mapping.papersizebean none printtoolbean widthinches The width (in inches) of the default paper size for printing map images. Default: 11 Type: float heightinches The height (in inches) of the default paper size for printing map images. Default: 8 Type: float selectiontoolbean Description Required Class Scope Parent Sample Children Controls the behavior of the Region Select tool. This tool uses the geographic boundary that is selected when the user clicks on the map to select the objects in the BI layer. Standard geographies are typically used but a custom boundary, like sales territory can be used as well. Yes com.mapinfo.jsf.controls.mapping.selectionmaptoolbean none map bufferedlinedistance1 - bufferedlinedistance5 All derived from the property bufferedlinedistances. You can define as many or as few buffered line distances as required by your company. 124 Location Intelligence Component v1.0

125 Chapter 5: Global Map Settings and Managed Beans selectiontoolbean (continued) Properties style Defines the style given to the highlighted buffer line used by the Select Within Buffered Line tool. This default path is taken from the <domain-directory>/ resources directory. Default: customstyles/selection Type: string [bufferedlinedistances] The defined buffered line distance options made available to your users. There are five sample buffered line distance options provided with the LIC. This property contains the class com.mapinfo.jsf.unit.distancebean and the nested beans bufferedlinedistance1, bufferedlinedistance2, bufferedlinedistance3, bufferedlinedistance4 and bufferedlinedistance5. [bufferedlinedistance] The buffered distance value, referenced in the managed bean bufferedlinedistance<x>. Each of the sample beans provided is associated with a default value, from 1 to 5 (in miles). Default: #{bufferedlinedistance1} [selectinboundarylayernames] Lists the map entries for the layer names users can select. The layers named here must already be defined in your users basemap. Default: States, US Zips Type: string [selectatpointclicktolerance] Defines the size of the point used by the Select at Point Tool on the map. The size of the point is set in pixels, and has a default value of 5, which defines a 5 by 5 pixel box centered on the point clicked. This value can be modified as necessary to adjust the click tolerance. Default: 5 Type: float Administration Guide 125

126 Beans that Handle Basic Mapping Settings There are five sample bufferedlinedistance managed beans identified in the selectiontoolbean managed bean, to demonstrate its potential. However, only the sample managed bean bufferedlinedistance1 is provided here for simplicity. bufferedlinedistance1 Description Required Class Scope Parent Properties A sample distance bean, which defines the width of the highlighted buffer line used by the Select Within a Buffered Line tool. You can define as many or as few buffered line distances as required by your company. Use the five sample bufferedlinedistance<x> beans provided for reference. Yes com.mapinfo.jsf.unit.distancebean none selectiontoolbean value The buffered distance allowed for the Select Within Buffered Line tool. The sample values provided for the five bufferedlinedistance<x> beans range from 1 to 5 miles. Type: float unitabbreviation The unit in which the buffered distance is labelled, in short form. Valid values include mi, km, m, yd and ft. Default: mi Type: string mylayers Description Required Class Scope Parent Sample Child Exposes frequently-used map layers or layers of particular interest on the Layer Control pane; mylayers groups these frequently-used layers for easier access. Yes com.mapinfo.jsf.controls.mapping.layergroupbean none map stateslayer Derived from the property layers. 126 Location Intelligence Component v1.0

127 mylayers (continued) Chapter 5: Global Map Settings and Managed Beans Properties name The name for the user s layer data. Default: States Type: string [friendlyname] The name for the user s personal layer group management directory. Default: My Layers Type: string layers Layers in your basemap can be grouped for the purpose of organizing your layers for your layer control. This property lists all the groups you want to have for your layer control. There can be 1 to n number of groups. This property contains the class com.mapinfo.jsf.controls.mapping.layers and the nested bean mylayers. All layers are drawn from the value class com.mapinfo.jsf.controls.mapping.maplayerbean. stateslayer Description Required Class Scope Parent Properties A sample layer bean. Yes com.mapinfo.jsf.controls.mapping.featurelayerbeanimpl none mylayers name The name for the user s layer of states data. Sample Default: States Type: string [friendlyname] The name that gets displayed in the layer control. If this property is not included the name property above is used. Sample Default: U.S.A. Type: string Administration Guide 127

128 Beans that Handle Basic Mapping Settings layergroupstree Description Required Class Scope Parent Properties Defines a group of layers. All layers in this group are put into one tree level in the Layer Control window. If you do not define this group one is created automatically and all the layers in the basemap are added to this default group. If you only want a select number of base layers in this group, you must define this managed bean. Yes com.mapinfo.jsf.controls.mapping.layergroupstreebean session map No default 128 Location Intelligence Component v1.0

129 Customizing Global Map Settings and Defaults 6 This chapter provides details on how to customize map look and feel for your entire user base. Changes take place in one place the mapxtreme-mappingfaces-config file and are applied globally. If you decide to customize the mapxtreme-mapping-faces-config file, we strongly recommend you save a copy of the original file somewhere on your system. Saved originals allow you to do two things: Base new customizations on the original sample code Work backwards to debug any new changes In this chapter: Organizing Your Mapping Layers Customizing the Default Theme Customizing the Default Legends Customizing the Selection Tools Configuring Printers

130 Organizing Your Mapping Layers Organizing Your Mapping Layers A map displays the spatial relationship between map features. These features may be town boundaries, roads, or customer sites. Similar features, (for example, all customer sites), are presented as a layer of spatial information. Multiple layers allow different types of features to be viewed in a single map. The LIC mapping system involves resting data layers on a basemap. The basemap is defined in the map managed bean. Each data layer is defined as its own managed bean and referenced in the MapLayerBean managed bean. The LIC uses Map Manager to define content and style of maps in a Map Definition File (MDF). MDFs are XML files containing all of the configurations required to display the map (for example, which layers should be visible for a particular zoom-level and whether to display features using colors, symbols, or patterns.) You can use the default basemap provided or you can create a custom basemap. A sample map layer, stateslayer, is included with the LIC. You can use this default data layer, you can delete it and replace it with a custom layer, or you can add any number of custom layers to the default. For information on custom layers, see the section Creating a Custom Layer on page 136. You can also customize the friendly name (My Layers) that is presented to users in their Layer Control pane. This section describes how to create a new, custom basemap based on the default layer and how to customize the name (My Layers) presented in the Layer Control pane. For information on using the Map Manager, see the Location Intelligence Component Map Manager Guide. Creating a Custom Basemap You can create a customized basemap for your company, which appears in your users Layer Control window as a basemap of their map grouping. To create a custom basemap: 1. Create a new basemap using Map Manager and save the MDF in your \resources\custommaps directory. 2. Open the mapxtreme-mapping-faces-config file in a text editor. 3. Scroll to the map managed bean (see the sample code below). 4. For defaultmap, replace the States value with the name of your newly-created MDF. 5. Save and close the file. 6. Restart your application server so your system can recognize your changes. 130 Location Intelligence Component v1.0

131 Chapter 6: Customizing Global Map Settings and Defaults The map managed bean (defaultmap property only) is defined as follows, by default. <managed-bean> <managed-bean-name>map</managed-bean-name> <managed-bean-class> com.mapinfo.jsf.mapxtreme.mapping.mapxtrememapbean </managed-bean-class> <managed-bean-scope>session</managed-bean-scope> <property-name>defaultmap</property-name> <value>custommaps/states</value> </managed-bean> Customizing the My Layers Name The My Layers name displays in your users Layer Control pane, heading a list of available favorite layers. Your company may prefer to use a custom title for this name. To customize the My Layers name: 1. Open the mapxtreme-mapping-faces-config file in a text editor. 2. Scroll to the mylayers managed bean (see the sample code below). 3. For friendlyname, replace the My Layers value with your custom name (for instance, Acme Layers). 4. Save and close the file. 5. Restart your application server so your system can recognize your changes. The new name now appears in your users Layer Control pane. Administration Guide 131