XML for the IBM® Big Match Search interface sample

This topic assumes that you have created a copy of the ui_config.xml file. If you chose to install the sample data, the ui_config.xml was created and configured automatically.

configuration

The root element for the ui_config.xml file.

hbase_rest_server

Ensure that a hbase_rest_server element appears as a child of the root <configuration> element. You can specify more than one hbase_rest_server element in the file, but only the first element is read when the interface runs. Specifying more than one hbase_rest_server element might be helpful as you are doing development for the interface. In that case, you can change the designated server by changing the instance of the element that appears first in the file.

hostName

Set the hostName attribute to the host name of the HBase REST Server you want the interface to access. You can provide either a host name or an IP address.

port

Set the port attribute to the number of the port where the HBase REST Server is running.

table

Include a table element as a child in the <hbase_rest_server> element for each HBase table that you have enabled for Big Match.

name

Set the name attribute to the name of the HBase table that you have enabled for Big Match or to the social media table.

field

Include a field element as a child in the table element for each column in the HBase table that you want to display in the interface. The table must be enabled for Big Match.

displayName

Set the displayName attribute to the text you want to display as both the column title in the results table and the title of the Search field in the search criteria area.

hBaseName

Set the hBaseName attribute to the name of the column in the HBase table to which this field maps.

columnWidth

Set the columnWidth attribute to a number of pixels (for example, 80px) to use as the column width for this field in the results table.

defaultSearchValue

Set the defaultSearchValue attribute to a string that you want to appear by default in the search criteria entry area for this field. This setting is useful for demonstrations and testing. This attribute does not apply to tables related to social media.

displayAsSearchField

Set the displayAsSearchField attribute to a boolean value that indicates whether to include this field in the search criteria area of the interface. If the displayAsSearchField attribute is omitted, it defaults to true. If set to false, the field is omitted from the search criteria but is displayed in the results table. This attribute does not apply to tables related to social media.

dataType

Set the dataType attribute to one of the following: java.lang.String, java.lang.Short, java.lang.Integer, or java.lang.Long. The dataType attribute applies only to "additional fields". Additional fields are fields that correspond to columns in the HBase table that were not specified when the table was enabled for Big Match. If the dataType attribute is omitted, it defaults to java.lang.String. Note that the attribute is ignored if it is set for fields that correspond to columns that were specified when the HBase table was enabled for Big Match.