Root Element <mapfexs>

In this section:

<mapfexs version="1.1">

Attribute Name

Values

Description

version

Number

Set value for the version. The default is 1.1.



x
Child Element <performance>
<performance appendidtofexprompt="false" cachedom="true" cachefilter="true"
  cachejs="true" checkesc="true" enabledebugwindow="true" filterformat="in"
  foctemp="TXT" ftm="txt" imagefiletype="png" imageredirect="true"
  mapcachedepth="4" maxfeatureitems="2000" maxlengthimageline="14000"
  spatialrelationgis="1" spatialrelationims="area_intersection"/>

Attribute Name

Values

Description

appendidtofexprompt

Boolean

 
cachedom

Boolean

Specifies that the Document Object Model of the XML definition file be held in memory until explicitly cleared with a FLUSHTABLES command.

cachefilter

Boolean

Specifies that the filter list generated by a user selection from the map be held in memory.

cachejs

Boolean

Specifies that the JavaScript created from the DOM be held in memory.

enabledebugwindow

Boolean

Enables the launch of the debug window.

filterformat

String

Specifies the filter format that is used for FOCUS.

foctemp

String

Specifies the storing format that is used for FOCUS. The default value is TXT.

ftm

String

Temporary files or Alphanumeric HOLD files name.

imagefiletype

String

Image file type only used with ArcGIS Server non-pooled and ArcIMS services. The default is png.

imageredirect

Boolean

Determines if an image redirect should be applied.

mapcachedepth

Number

Specifies the number of maps in memory. Increase this value for report to map drilldowns.

maxfeatureitems

Number

Specifies the maximum number of features that will be returned after a query.

maxlengthimageline

Number

Specifies the maximum length of an image line.

spatialrelationgis

Number

Values that denote the relationship of the query geometry to target geometry. This value ranges from 0 to 9.

spatialrelationims

Constants, String

Values that denote relationships of the query geometry to target geometry. Only use in ArcIMS.



x
Child Element <jsincludes>

Sub-child Element: <file>

<file map="true" report="true">

Attribute Name

Values

Description

map

Boolean

Reports values to be returned to the map viewer.

report

Boolean

Reports values to be returned to the report viewer.

Sub-child Element: <fexinfo>

Sub-child Element: <appinfo>

Sub-child Element: <IBIF_adhocfex>



x
Child Element <errorpage>
<errorpage page="/ibi_html/javaassist/ibi/html/esri/esri_error.htm"/>

Attribute Name

Values

Description

page

String

Value to where error pages are written.



x
Child Element <menuinfo>
<menuinfo class="clsMenuMAP" order="file"/>

Attribute Name

Values

Description

class

String

Class name used for the menu.

order

String (prompt, file)

Options for ordering menu items as they appear in the Report and Menu widgets:

  • Prompt. Uses the FEX prompt value for alphabetical sorting.
  • File. Random sorting.



x
Child Element <reportserver>

Sub-child Element: <classinfo>

Sub-sub-child Element: <default>

Sub-sub-child Element: <fixed>

Sub-child Element: <appinfo>

Sub-sub-child Element: <default>

<default IBIAPP_app="esri" IBIC_server="EDASERVE"/>

Attribute Name

Values

Description

IBIAPP_app

String

Application folder name. The default value is esri.

IBIC_server

String

Reporting Server Node. The default value is Reporting Server Node.

Sub-sub-child Element: <fixed>

Sub-child Element: <mreinfo>

Sub-sub-child Element: <default>

Sub-sub-child Element: <fixed>



x
Child Element <displayinfo>
<displayinfo mapscaledisplayunits="meters">

Attribute Name

Values

Description

mapscaledisplayunits

String (meters, feet, inches, miles)

Units of Map Display.

Sub-child Element: <layout> (used only in ArcIMS/ArcGIS Server)

<layout displayarrows="true" displayinfo="true"displayticks="true" horizontal="false" sdragable="false"numberoftoolsperrow="2" onright="false">

Attribute Name

Values

Description

displayarrows

Boolean (true)

Displays arrows on the map.

displayinfo

Boolean (true)

Shows information along the bottom.

displayticks

Boolean (true)

Shows zoom tick marks and icons.

horizontal

Boolean (false)

Shows the toolbar vertically and/or horizontally.

sdragable

Boolean (false)

Places the toolbar adjacent to map and allows the user to position the toolbar by dragging the mouse.

numberofroolsperrow

Number

Values. 1, 2.

onright

Boolean (false)

Toolbar position on the left or right of the map image.

Sub-child Element: <maptitle>

<maptitle>Crime Demo</maptitle>

Sub-child Element: <pagetitle>

<pagetitle>Powered By WebFOCUS</pagetitle>

Sub-child Element: <flexmapsettings>

<flexmapsettings>
  <logoVisible type="boolean">false</logoVisible>
  <panArrowsVisible type="boolean">false</panArrowsVisible>
  <zoomSliderVisible type="boolean">false</zoomSliderVisible>
  <scaleBarVisible type="boolean">false</scaleBarVisible>
</flexmapsettings>

Sub-child Element: <logoVisible>

Attribute Name

Values

Description

type

Boolean (false)

Displays a logo on the map.

Sub-child Element: <panArrowsVisible>

Attribute Name

Values

Description

type

Boolean (false)

Displays pan arrows on the map.

Sub-child Element: <zoomSliderVisible>

Attribute Name

Values

Description

type

Boolean (false)

Displays zoom slider on the map.

Sub-child Element: <scaleBarVisible>

Attribute Name

Values

Description

type

Boolean (false)

Displays pan scale bar on the map.

Sub-child Element: <tool>

<tool display="true" index="0" type="clear vmr"/>

Attribute Name

Values

Description

display

Boolean (true)

Visible/Invisible.

index

Number

Index number of the tool, 0 based.

type

String (clear vmr, report fex, units, map fex, pan, identify, selection type, legend, print, layers, zoom out, zoom in)

Tool name to be displayed.

Tools List <type>:

0 - Erase
1 - Report Fex
2 - Set Units
3 - Map Fex
4 - Pan Map
5 - Identify Fex
6 - Selection Type
7 - Legend
8 - Print
9 - Layers
10 - Zoom out
11 - Zoom in

Sub-child Element: <defaultsymbols>

<defaultsymbols mapimagenortharrowid="" mapimagescaleid="" mapnortharrowid=""
mapscaleid="" northarrowid="" scaleid="scale0" selectmapnortharrowid="" selectmapscaleid=""/>

Sub-child Element: <symbol>

<symbol class="com.esri.aims.mtier.model.map.layer.renderer.symbol.SimpleLineSymbol"
  id="selectMapLine" setAntialiasing="false" setColor="255,0,0" setLineType="solid"
  setOverlap="true" setWidth="2" shape="line"/>

Attribute Name

Values

Description

class

Appendix List

Lists the classes that are used to symbolize features in the map.

id

String

Name of the symbol.

Refer to Individual Symbols for Additional Attributes.

Sub-child Element: <displaygroups>

<group id="group0" prompt="Basic Group"/>

Attribute Name

Values

Description

id

groupnn

Unique ID of the group. 0 based index.

prompt

String

Name of the group that will appear in the menu.

Sub-child Element: <colors>

Sub-sub-child Element: <colormap>

<colormap id="colormap0" prompt="Precinct Numbers" type="table">

Attribute Name

Values

Description

id

colormapnn

Unique ID of the colormap. 0 based index.

prompt

String

Name of the colormap.

type

String (table, gradient)

Type of colormap.

Sub-sub-sub-child Element: <color>

<color id="colorentry0" key="0" value="0,0,0"/>

Attribute Name

Values

Description

id

colorentrynn

Unique ID of the colorentry. 0 based index.

key

Name

Name of the key to be used.

value

Hexadecimal values, RGB values, names, use color swatch

The ArcGIS API for Fex requires hexadecimal values.



x
Child Element <windows>

Sub-child Element: <reportwindow>

<reportwindow height="-1" left="-1" name="reportWindowESRI" top="-1" width="-1"/>

Attribute Name

Values

Description

height

Number

Specifies the height of the report window.

left

Number

Specifies the relative position of the report window left.

name

String

Specifies the name of the report window.

top

Number

Specifies the relative position of the report window top.

width

Number

Specifies the width of the report window.

Sub-child Element: <legendwindow>

<legendwindow height="-1" left="-1" name="legendWindowESRI" top="-1" width="-1"/>

Attribute Name

Values

Description

height

Number

Specifies the height of the legend window. Not available in Flex.

left

Number

Specifies the relative position of the legend window. Not available in Flex.

name

String

Not available in Flex.

top

Number

Specifies the relative position of the legend window. Not available in Flex.

width

Number

Not available in Flex.

Sub-child Element: <mapwindow>

<mapwindow fadedelay="50" fadefactor="20" height="-1" left="-1"  name="mapWindowESRI" top="-1" url="" width="-1"/>

Attribute Name

Values

Description

height

Number

Specifies the height of the map window.

left

Number

Specifies the relative position of the map window left.

name

String

Specifies the unique name of the map window.

top

Number

Specifies the relative position of the map window top.

url

String

/ibi_apps/esri/
flexmapviewer/FlexMapViewer.jsp

This value is used for the mapviewer built with ArcGIS API for Flex.

width

Number

Specifies the width of the map window.

Sub-child Element: <bufferwindow>

<bufferwindow height="-1" left="-1" name="bufferWindowESRI" top="-1" width="-1"/>

Attribute Name

Values

Description

height

Number

Not available in Flex.

left

Number

Not available in Flex.

name

String

Reference to the buffer window.

top

Number

Not available in Flex.

width

Number

Not available in Flex.



x
Child Element <callback>
<callback identify="" map="" mapinit="" postxmlparse="" report=""  reportinit="" rollovercallback=""/>

Attribute Name

Values

Description

identify

Boolean

Procedure type is Identify.

map

Boolean

Procedure type is Map.

mapinit

String

Function to call before Map is initialized.

report
 

Procedure type is Report.

reportinit

String

Function to call before Report is initialized.

rollovercallback

String

Function to call before Rollover is initialized.



x
Child Element <mapservice>
<mapservice IBIESRI_Encryption="true"
  IBIESRI_domain="localhost" IBIESRI_pass="0049fb825aa7976f7faa642cf4c6e82ede" 
  IBIESRI_user="arcgis" host="localhost" id="mapservice0" port="5300"
  protocol="TCP" servertype="ARCGIS" service="CRIMED">
<mapservice id="mapservice0" servertype="REST" 
  url=http://ibigisdev.ibi.com:8399/arcgis/rest/services/FLEA/MapServer
  label="Lea Map" type="tiled" visible="true" alpha="1"
  icon="com/esri/solutions/flexviewer/assets/images/icons/i_shuttle.png">
<mapservice id="mapservice1geo" servertype="REST" type="geometry"
  url="http://ibigisdev.ibi.com:8399/arcgis/rest/services/Geometry/GeometryServer" />

Attribute Name

Values

Description

IBIESRI_domain

String

Server Name.

IBIESRI_pass

String

Used for ArcGIS servertype.

IBIESRI_user

String

Used for ArcGIS servertype. The default is arcgis.

host

String

The name of the server where the application resides.

id

Unique service ID

Mapservice unique ID, 0 index based.

port

Number

Used for ArcGIS servertype. The default is 5300.

protocol

String

Used for ArcGIS servertype. The default is TCP.

servertype

String (ARCGIS, ARCIMS, WEBFOCUS, REST)

Mapservice server type.

service

String

List of all the service names hosted in IBIESRI_domain.

type

String (tiled, dynamic, geometry, geoprocess)

Used only for REST Mapservices.

alpha

Number

Controls the transparency. Values can range from 0 (full transparency) to 1 (no transparency, full visibility).

icon

String

Reference to an icon (.png, bmp, and so on).

Sub-child Element: <defaultextent>

<defaultextent maxx="5823888.370505974" maxy="2169983.287258233" minx="5752309.304089934" miny="2117961.342813789"/>

Attribute Name

Values

Description

maxx

Number, Double

Maximum Longitude values of the envelope viewed in the map.

maxy

Number, Double

Maximum Latitude values of the envelope viewed in the map.

minx

Number, Double

Minimum Longitude values of the envelope viewed in the map.

miny

Number, Double

Minimum Latitude values of the envelope viewed in the map.

Sub-child Element: <defaultmapdisplay>

<defaultmapdisplay setBackground="255,255,255"/>

Attribute Name

Values

Description

setBackground

Hexadecimal, RGB, name color values, use color swatch

Background color.

Sub-child Element: <mapdisplay>

<mapdisplay id="maptransbackground" setBackground="255,255,255" setTransColor="255,255,255"/>

Attribute Name

Values

Description

id

String

Unique ID.

setBackground

Hexadecimal, RGB, name color values, use color swatch

Background color.

setTransColor

Hexadecimal, RGB, name color values, use color swatch

Transparency color.

Sub-child Element: <defaultlegenddisplay>

<defaultlegenddisplay setAutoExtend="true"setBackground="255,255,255" setCanSplit="false" setFont="Verdana"
setLayerFontSize="10"  setTitleFontSize="12" setValueFontSize="8"
setWidth="180"/>

Sub-child Element: <defaultextentwidth>

Sub-child Element: <defaultsymbols>

Sub-child Element: <layer>

Feature Layers:

<layer allowselect="false" layerid="0" name="Incidents" sampledata="true" shape="point" visible="false"/>

Synthetic Layers:

<layer allowselect="true" coordinate_system=""
  defaultvisibility="true" disabled="false" factor="1.0"
  layerid="syntheticlayer0"  maximumscale="1.7976931348623157E308"
  minimumscale="0" name="State Plane Coordinates (Orange)" polyendpointsymbolid=""
  polypointsymbolid="" polystartpointsymbolid="" sampledata="false" shape="point"
  symbolid="drawMapPoint" synthetic="true" transformation="" transformation_direction=""
  xoffset="0.0" yoffset="0.0">

Attribute Name

Values

Description

visible

Boolean

Use to control only the visibility of individual map layers. This is only available of dynamic map service layers.

allowselect

Boolean

 
coordinate_system

String

Refers to a list of Coordinate System, blank if using the same coordinate system as the map, used with synthetic layers.

defaultvisibility

Boolean

Visible or Invisible, used with synthetic layers.

disabled

Boolean

Causes the synthetic layer definition to be ignored by WebFOCUS.

layerid

Number

Layer ID, derived from the mapservice. 0 index based.

maximumscale

Number

The maximum scale at which the layer is rendered, used with synthetic layers.

minimumscale

Number

The minimum scale at which the layer is rendered, used with synthetic layers.

name

String

Name used to identify the layer.

polyendpointsymbolid

String

Refers to a SimpleMarkerSymbol to draw polygon ends.

polypointsymbolid

String

Refers to a SimpleMarkerSymbol to draw polygon centroids.

sampledata

Boolean

Allows to see sample data before selecting attributes.

shape

String

Type of layer, values - point, line, polygon. Mapservice based.

symbolid

String

Refers to a symbol defined in the configuration, used with synthetic layers.

transformation

String

Transformation necessary to project a layer, used with synthetic layers.

transformation_direction

String (forward, reverse)

Used with synthetic layers.

xoffset

Number, Double

X Shift to draw map features, used with synthetic layers.

yoffset

Number, Double

Y Shift to draw map features, used with synthetic layers.

Used only with Synthetic Layers

Sub-sub-child Element: <drawfex>

Sub-sub-child Element: <fexinfo>

Sub-sub-sub-child Element: <appinfo>

Sub-sub-child Element: <selectfex>

Sub-sub-child Element: <fexinfo>

Sub-sub-sub-child Element: <appinfo>

Attribute Name

Values

Description

IBIAPP_app

String

Select an application from the list for the selected reporting server. Usually refers to the current application.

IBIF_ex

String (value selected)

This should refer to a procedure in the IBIAPP_app folder. User selects a procedure from a drop-down list.



x
Child Element <fex>
<fex defaultFex="true" displaygroup=""drawselectmap="true" esrinotn="true" height="" id="fex0"legenddetail="true" limitlayers="true" nomenu="true" northarrowid="arrow0" prompt="FEXPROMPT_BOX" promptastitle="true" scaleid="scale0" type="report" width="" windowname="WINDOWNAME_BOX"zoomfeatures="true">

Attribute Name

Values

Description

defaultFex

Boolean

Designates the procedure (map, report) to be launched when no other is specified.

displaygroup

Selection of created group(s)

Assigns the procedure to a display group. This is reflected in the menu for reports.

drawselectmap

Boolean

Changes the map view after the user makes a selection.

esrinotn

Boolean

Suppresses the display of the Select Map image (thumbnail) on the first page of the report output.

height

Integer

The value is not controlled from the GUI but could be set in the XML file to size the map.

id

fexnnn

Unique value assigned to identify the FEX (map, report, identify).

legenddetail

Boolean

Displays a legend detail in the map when selected.

limitlayers

Boolean

Displays layers that are only listed within the Outbound area.

nomenu

Boolean

Removes this procedure from the menu of the Map View Manager.

northarrowid

Selection of predefined NA

Displays the North arrow symbol on the generated map.

prompt

String

Provided string value will be used to identify this procedure in the list of available procedures in the Map View.

promptastitle

Boolean

Displays a title on the map. This option is selected by default.

scaleid

Selection of predefined scales

Displays a scale on the generated map.

type

report, map, identify

Three types of the FOCEXEC procedures.

width

Integer

The value is not controlled from the GUI but could be set in the XML file to size the map.

windowname

String

Displays the report output in a new window with specified string value.

zoomfeatures

Boolean

Zooms into the area that was selected in the Map View Manager.

buffersymbolid

String

Refers to a symbol defined, should be the type of SimpleFillSymbol.

Sub-sub-child Element: <fexinfo>

Sub-sub-sub-child Element: <appinfo>

<appinfo IBIAPP_app="XMLFILES" IBIF_ex="exersize2"/>

Attribute Name

Values

Description

IBIAPP_app

String

Select an application from the list for the selected reporting server. Usually refers to the current application.

IBIF_ex

String (value selected)

This should refer to a procedure in the IBIAPP_app folder. User selects a procedure from a drop-down list.

Sub-child Element: <sendselectmap>

<sendselectmap imagefiletype="png" sendheight="100" sendimage="false"
  sendlegend="false" sendlegendfilename="ESRIIMGSLG" sendmapfilename="ESRIIMGSEL"
  sendwidth="200"/>

Attribute Name

Values

Description

imagefiletype

String

The default is png.

sendheight

Number

The height of the image to be rendered.

sendimage

Boolean

Option box control. Select true or false.

sendlegend

Boolean

Option box control. Select true or false.

sendlegendfilename

String

Value set by the app to send the name of a file containing legend.

sendmapfilename

String

Value set by the app to send the name of a file containing map.

sendwidth

Number

The width of the image to be rendered.

Sub-child Element: <sendmapmap>

<sendmapmap fexid="" imagefiletype="png" sendheight="100" sendimage="false"
 	sendlegend="false" sendlegendfilename="ESRIIMGMLG" sendmapfilename="ESRIIMGMAP" sendwidth="200"/>

Attribute Name

Values

Description

fexid

fexnnn

Unique value assigned to identify the fex (map, report, identify).

imagefiletype

png, gif, jpeg

File type of image to be rendered.

sendheight

Number

Height of the image to be rendered.

sendimage

Boolean

Image to be sent. The default is false.

sendlegend

Boolean

Legend to be displayed. The default is false.

sendlegendfilename

String

Legend file Name.

sendmapfilename

String

Image file Name.

sendwidth

Number

Width of the image to be rendered.

Sub-child Element: <mapinfo>

<mapinfo mapservice="mapservice0">

Attribute Name

Values

Description

mapservice

String

Select an attribute from the list for the selected ArcGIS Server.

Sub-sub-child Element: <inbound>

Sub-sub-sub-child Element: <layer>

<inbound>
		<layer attributename="BEATNUM" bufferunits="" distance=""	esri_precision="0"
    esri_quote="" esri_size="2" esri_type="5" filename="WHERED"
    focusfieldformat="I6" focuswhereformat="file" layerid="2"
    selectiontype="respectall" symbolid="selectMapPolygon"/>
</inbound>

Sub-sub-child Element: <outbound>

Sub-sub-sub-child Element: <layer>

<outbound>
  <layer attributename="REPORTID" calloutsymbolid="" colname="CRIMEID" color="COLOR#"
    colortable="" esri_precision="0" esri_quote=" ' "	esri_size="8" esri_type="12"
    focusfieldformat="A8" image="IMAGEDIS" labelfield="" layerid="0"
    othersymbolid ="" rollover="true" shape="SHAPE#" size="SIZE#" symbolid="drawMapPoint"
    text="OUTBOUNDTEXT_BOX" textpolysymbolid="" textsymbolid="" title="TITLEDIS"/>
</outbound>

Layer Attributes (inbound/outbound):

Attribute Name

Values

Description

attributename

Value selected from the drop-down list

IBI$BUFFER,
IBI$BUFFERINDEX

Select an attribute from the list for the selected layer, using IBI$BUFFER.

IBI$BUFFERINDEX indicates the buffering capabilities of an inbound layer. Can only be used in an inbound layer.

calloutsymbolid

calloutsymbol

Symbol used when adding label information to a point layer. The source of the information displayed will be a map layer attribute.

colname

String

The column name from the WebFOCUS data source that contains values that match the map layer attribute.

color

String

Default value is the column name of the output of the map FOCEXEC. Valid parameters for all three shapes: point, line and polygon.

colortable

Value selected from the predefined drop-down list

GIS adapter determines how many unique colors are needed depending on the result set of the map report. The adapter spreads the color values evenly across the answer set.

esri_precision

Integer

Precision for the format of the attribute field selected.

esri_quote

String

ArcGIS Server symbol used for quotation.

esri_size

Integer

The length of the attribute field selected.

esri_type

Integer

The format of the attribute field selected.

focusfieldformat

String

Format depends on the incoming data from the selected attribute field of the layer.

image

Path to the image file

Custom image to represent the symbol.

labelfield

Input for layer fields

 
layerid

Integer

Value depends on the selected layer during the definition of outbound layer.

othersymbolid

Value selected from the predefined drop-down list

To symbolize any additional features on the map that are not specified in the XML stream

rollover

Boolean

Enables mouse over support for a map layer. Only supported for point layers.

shape

String

Default value is the column name of the output of the map FOCEXEC. Valid parameter for only one shape: point.

size

String

Default value is the column name of the output of the map FOCEXEC. Valid parameter for two shapes: point and line.

symbolid

Value selected from the drop-down list

Symbol that will be used to render the map.

text

String

Input the field name from the WebFOCUS XML output. Used for mouse over support for point layers.

textpolysymbolid

Value selected from the predefined drop-down list

Value has to be selected from the drop-down list. The symbol is predefined and used for adding label information to a point layer. The source of the information displayed will be the XML output from a Map procedure.

textsymbolid

Value selected from the predefined drop-down list

Value has to be selected from the drop-down list. The symbol is predefined and used for adding label information to a point layer. The source of the information displayed will be the XML output from a Map procedure.

title

String

The value is used to create the layer legend that can be viewed from the Viewer.

mapservice

String

Used for REST mapservices, to mix different mapservices

bufferSymbols 

String (list populated using SimplePolygonFillSymbol)

Symbols used to draw buffers.

griddisplayfields

String

Used to display fields in the WebFOCUS dataview widget. The default is colname.



x
Child Element <livemaps>
<livemaps>
  <mapservice label="LatestVisibleSatellite" 
   type="wms" visible="true"alpha="0.6">http://egisws01.nos.noaa.gov/
     wmsconnector/com.esri.wms.Esrimap/census2000mapping?request=
     getcapabilities&service=WMS&version=1.1.1</mapservice>
</livemaps>

Sub-child Element: <mapservice>

Attribute Name

Values

Description

label

String

User provided ID to distinguish the mapservice.

type

String

The type of mapservice to be used. The default is wms.

visible

Boolean

Visibility of the service.

alpha

Number

Controls the transparency. Values can range from 0 (full transparency) to 1 (no transparency, full visibility).


WebFOCUS