Configuring FOCEXECs

In this section:

How to:

WebFOCUS reporting procedures (FOCEXECs) are used to integrate between WebFOCUS and ArcGIS Server. There are three types of FOCEXECs that may be defined to the WebFOCUS GIS Adapter using the ESRI Configuration Utility:

Many of the properties are common across all three types of FOCEXECs.

The bindings between FOCEXECs and ArcGIS Server are defined by inbound layers and/or outbound layers.

The following list describes the inbound layers and outbound layers that define the bindings between FOCEXECs and ArcGIS Server.


Top of page

x
Procedure: How to Configure a Report FOCEXEC

To configure a Report FOCEXEC:

  1. Click the Focexecs tab located at the top of the ESRI Configuration Utility.

  2. Click Add focexec in the left pane.

    The Create New Fex dialog opens, as shown in the following image.

  3. Click Browse to the right of the Fex file path field.

    The Open dialog is displayed.

    The default path that is provided is the application folder on the WebFOCUS Reporting Server that you selected from the Browse Path dialog when you opened the ESRI Configuration Utility to create a new XML definition file.

  4. Select an available Report FOCEXEC (for example, cntyrptf.fex) from your application directory and click Open.

    You are returned to the Create New Fex dialog opens, as shown in the following image.

    Notice that the path to the Report FOCEXEC (for example, cntyrptf.fex) is now added to the Fex file path field.

  5. Enter a unique value for the Report FOCEXEC in the Prompt field (for example, Liability ranking).

    The Prompt value that you provide is used to identify the Report FOCEXEC in the WebFOCUS Report component of the WebFOCUS GIS Viewer for Flex.

  6. Select Report in the Binding type area and click OK.

    The Report FOCEXEC (for example, Liability ranking) is added to the FOCEXECs pane in the ESRI Configuration Utility, as shown in the following image.

    The Properties tab lists the available configuration properties for the Report FOCEXEC. The following table lists and describes these properties.

    Property

    Description

    Prompt

    The Prompt value that you specified in the Create New Fex dialog.

    Location

    The path to the selected Report FOCEXEC on the server.

    Type

    The type of FOCEXEC (Report, Map, or Identify), as indicated by the selection made from the Binding type list in the Create New Fex dialog.

    Default Fex

    Designates this Report FOCEXEC to be the report that is launched when no other is specified. The default value is No.

    Draw Select Map

    Changes the map view after the user makes a selection. The WebFOCUS GIS Viewer for Flex displays a map image with the selections of the user changed according to the symbol chosen for the inbound layer.

    No Menu

    Removes this procedure from the menu of the WebFOCUS GIS Viewer for Flex.

    Window Name

    Displays the report output in a new window. This option can be used for all report output formats that are not HTML, such as PDF and Excel.

    Display Group

    Assigns the Report FOCEXEC to a display group. This is reflected in the menu for reports. The menu hierarchy displays as Layer-Display Group-Prompt.

    Buffer Fixed

    Determines whether the buffer distances are preset or can be changed from the user interface.

    Buffer Type

    The type of buffer to perform around the graphic or around selected features. Available values from the drop-down list include feature, sketch, disabled, and normal.

    Buffer Symbol

    Allows you to select a Buffer symbol style from the drop-down list to be used by your Report FOCEXEC.

    Buffer Units

    The unit of measure used for buffering.

    Buffer Distance

    The distance values used for buffering. This can be a list of comma-separated values.



x
Procedure: How to Configure a Map FOCEXEC

To configure a Map FOCEXEC:

  1. Click the Focexecs tab located at the top of the ESRI Configuration Utility.

  2. Click Add focexec in the left pane.

    The Create New Fex dialog opens, as shown in the following image.

  3. Click Browse to the right of the Fex file path field.

    The Open dialog is displayed.

    The default path that is provided is the application folder on the WebFOCUS Reporting Server that you selected from the Browse Path dialog when you opened the ESRI Configuration Utility to create a new XML definition file.

  4. Select an available Map FOCEXEC (for example, cntymapf.fex) from your application directory and click Open.

    You are returned to the Create New Fex dialog opens, as shown in the following image.

    Notice that the path to the Map FOCEXEC (for example, cntymapf.fex) is now added to the Fex file path field.

  5. Enter a unique value for the Map FOCEXEC in the Prompt field (for example, County liability map).

    The Prompt value that you provide is used to identify the Map FOCEXEC in the WebFOCUS Map component of the WebFOCUS GIS Viewer for Flex.

  6. Select Map in the Binding type area and click OK.

    The Map FOCEXEC (for example, County liability map) is added to the FOCEXECs pane in the ESRI Configuration Utility, as shown in the following image.

    The Properties tab lists the available configuration properties for the Map FOCEXEC. The following table lists and describes these properties.

    Property

    Description

    Prompt

    The Prompt value that you specified in the Create New Fex dialog.

    Location

    The path to the selected Map FOCEXEC on the server.

    Type

    The type of FOCEXEC (Report, Map, or Identify), as indicated by the selection made from the Binding type list in the Create New Fex dialog.

    Default Fex

    Designates this Map FOCEXEC to be the report that is launched when no other is specified. The default value is No.

    Limit Layers

    Displays layers that are only listed within the Outbound area.

    No Menu

    Removes this procedure from the menu of the WebFOCUS GIS Viewer for Flex.

    Zoom

    Zooms into the area that was selected in the WebFOCUS GIS Viewer for Flex.

    Window Name

    Displays the map output in a new window.

    Display Group

    Assigns the Map FOCEXEC to a display group.

    Buffer Fixed

    Determines whether the buffer distances are preset or can be changed from the user interface.

    Buffer Type

    The type of buffer to perform around the graphic or around selected features. Available values from the drop-down list include feature, sketch, disabled, and normal.

    Buffer Symbol

    Allows you to select a Buffer symbol style from the drop-down list to be used by your Report FOCEXEC.

    Buffer Units

    The unit of measure used for buffering.

    Buffer Distance

    The distance values used for buffering. This can be a list of comma-separated values.



x
Procedure: How to Configure an Identify FOCEXEC

To configure an Identify FOCEXEC:

  1. Click the Focexecs tab located at the top of the ESRI Configuration Utility.

  2. Click Add focexec in the left pane.

    The Create New Fex dialog opens, as shown in the following image.

  3. Click Browse to the right of the Fex file path field.

    The Open dialog is displayed.

    The default path that is provided is the application folder on the WebFOCUS Reporting Server that you selected from the Browse Path dialog when you opened the ESRI Configuration Utility to create a new XML definition file.

  4. Select an available Identify FOCEXEC (for example, itest1f.fex) from your application directory and click Open.

    You are returned to the Create New Fex dialog opens, as shown in the following image.

    Notice that the path to the Identify FOCEXEC (for example, itest1f.fex) is now added to the Fex file path field.

  5. Enter a unique value for the Identify FOCEXEC in the Prompt field (for example, Identify County).

    The Prompt value that you provide is used to identify this FOCEXEC in the WebFOCUS Identify component of the WebFOCUS GIS Viewer for Flex.

  6. Select Identify in the Binding type area and click OK.

    The Identify FOCEXEC (for example, Identify County) is added to the FOCEXECs pane in the ESRI Configuration Utility, as shown in the following image.

    The Properties tab lists the available configuration properties for the Identify FOCEXEC. The following table lists and describes these properties.

    Property

    Description

    Prompt

    The Prompt value that you specified in the Create New Fex dialog.

    Location

    The path to the selected Identify FOCEXEC on the server.

    Type

    The type of FOCEXEC (Report, Map, or Identify), as indicated by the selection made from the Binding type list in the Create New Fex dialog.

    Default Fex

    Designates this Identify FOCEXEC to be the report that is launched when no other is specified. The default value is No.

    No Menu

    Removes this procedure from the menu of the WebFOCUS GIS Viewer for Flex.

    Window Name

    Displays the report output in a new window.

    Display Group

    Assigns the Identify FOCEXEC to a display group.

    Buffer Symbol

    Allows you to select a Buffer symbol style from the drop-down list to be used by your Identify FOCEXEC.



x
Configuring Inbound Layers

How to:

Inbound layer definitions are used to identify which attribute is extracted from a map layer when a user draws a selected area on the map.



x
Procedure: How to Configure an Inbound Layer

To configure an inbound layer:

  1. Select an available FOCEXEC for which you want to configure an inbound layer and then click the Inbound Layers tab located in the FOCEXECs configuration area of the ESRI Configuration Utility.

  2. Click Add inbound layer in the right pane.

    The Create a new inbound layer dialog opens, as shown in the following image.

    You must first configure a connection to an available ArcGIS Server.

  3. Click Add.

    The REST Service Connection Information dialog opens, as shown in the following image.

    The Use proxy to access REST service check box provides you with the option to enable or disable usage of the proxy.jsp file to navigate to a REST endpoint when adding a new map service. This option is enabled by default.

    If the Use proxy to access REST service check box is selected, then the proxy.jsp file on the application server must be changed to add the URL to the map server. If the Use proxy to access REST service check box is not selected, and the application server and the map server are not on the same machine, then requests to the map server will fail and an error message indicating a network error is generated. This is the result of a default setting in web browsers, which prevents cross-domain Ajax calls. This setting can be changed in the security settings section of your web browser configuration.

    Note: If you are using Microsoft Internet Explorer Version 10 and the Use proxy to access REST service check box is not selected, the following dialog box is displayed.

    If you click Yes, then Microsoft Internet Explorer allows you to access the map service without the proxy.jsp. If you click No, an error message indicating Access is denied is displayed.

    If you are using Google Chrome and the Use proxy to access REST service check box is not selected, an error message indicating A network error is displayed. If you are using Mozilla Firefox 24 and the Use proxy to access REST service check box is not selected, an error message indicating Failure is displayed. As a workaround, you must select the Use proxy to access REST service check box and edit the proxy.jsp to add a REST endpoint to your proxy list.

    To edit the proxy.jsp file, navigate to the following directory:

    <WF_HOME>\webapps\webfocus\tools\esri_config\proxy.jsp

    Add your REST endpoint, as indicated by the following example:

    String[] serverUrls = {
      //"<url>[,<token>]"
      //For ex. (secured server): "http://myserver.mycompany.com/arcgis/rest/services,ayn2C2iPvqjeqWoXwV
            6rjmr43kyo23mhIPnXz2CEiMA6rVu0xR0St8gKsd0olv8a"
      //For ex. (non-secured server): "http://sampleserver1.arcgisonline.com/arcgis/rest/services"
      "http://informat-65f86f:8399/arcgis/rest/services",
      "http://ibigisdev.ibi.com:8399/arcgis/rest/services",
      "http://ibigis10.ibi.com:8399/arcgis/rest/services",
      "http://tsssvz01:8399/arcgis/rest/services", 
      "http://sampleserver1.arcgisonline.com/arcgis/rest/services",
      "http://sampleserver2.arcgisonline.com/arcgis/rest/services" //NOTE - no comma after the last item
    };
  4. Specify a host name for ArcGIS in the Host field followed by the port, instance, and URL in the corresponding fields. Consult your ArcGIS administrator for the correct values to use.

    Note: As a best practice, do not include an ending forward slash (/) character when specifying an ArcGIS Server URL in the proxy.jsp file. If a forward slash character is specified, then you must ensure that the value entered in the Instance field of the REST Service Connection Information dialog also contains a forward slash at the end.

  5. Click OK.

    You are returned to the Create a new inbound layer dialog.

  6. Expand an available Map Server node and then select the layer (for example, Counties) that will be used to select the map features.
  7. Click Next.

    The Select Attributes dialog opens, which is populated with all of the attribute names from the layer that was selected.

  8. Select the attribute(s) that you want to be used as a unique identifier to link the map service layers with FOCEXEC columns.

    You can modify the Format, Size, and Quote value columns according to your requirements.

    The Format column reflects the FOCEXEC format to be used for conversion. Valid FOCUS formats are used with a length (for example, A30, D10.2).

    The Size column reflects the length of the map service layer field.

    The Quote column reflects the type of quote to use for querying the map service layer field. Use single quotes for shape file layers and double quotes for SDE layers.

  9. Click Next when you have finished making your attribute selections.

    The following dialog opens, which allows you to select the report column for selecting values from a FOCUS database.

  10. Choose the filter type (File, String Amper, or Numeric Amper) from the Focus filter format drop-down list.

    The available choices allow you to pass a sequential file of values, a string of alphanumeric values enclosed in single quotes and separated by "OR", or a string of numeric values separated by "OR".

    The value that you provide in the File name field is used to name the filter variable or file that the adapter passes to WebFOCUS.

  11. Click Finish.

    The inbound layer definition is listed in the Inbound Layers tab of the FOCEXECs configuration area, as shown in the following image.

    The Properties table lists the available configuration properties for the inbound layer definition. The following table lists and describes these properties.

    Property

    Description

    Location

    The location of the map layer.

    Attribute Names

    The selected attribute(s) for the inbound layer definition.

    Symbol

    Allows you to select an available symbol definition from the drop-down list that will be used to render the map illustrating which features have been selected.

    Callout Symbol

    Allows you to select a callout symbol style from the drop-down list to be used by your FOCEXEC.

    Buffer Symbol

    Allows you to select a buffer symbol style from the drop-down list to be used by your FOCEXEC.

    Focus Filter Format

    The current filter type that is being used by the inbound layer definition (File, String Amper, or Numeric Amper).

    Filter File Name

    The filter variable or file for the inbound layer definition.



x
Configuring Outbound Layers

How to:

Outbound layer definitions are used to identify which layer of the map will be rendered by the WebFOCUS GIS Adapter. The information is used to associate the data source column that WebFOCUS accesses with the map layer attribute that ArcGIS Server uses to uniquely identify features.



x
Procedure: How to Configure an Outbound Layer

To configure an outbound layer:

  1. Select an available FOCEXEC for which you want to configure an outbound layer and then click the Outbound Layers tab located in the FOCEXECs configuration area of the ESRI Configuration Utility.

  2. Click Add Outbound layer in the right pane.

    The Create a new outbound layer dialog opens, as shown in the following image.

    You must first configure a connection to an available ArcGIS Server.

  3. Click Add.

    The REST Service Connection Information dialog opens, as shown in the following image.

    The Use proxy to access REST service check box provides you with the option to enable or disable usage of the proxy.jsp file to navigate to a REST endpoint when adding a new map service. This option is enabled by default.

    If the Use proxy to access REST service check box is selected, then the proxy.jsp file on the application server must be changed to add the URL to the map server. If the Use proxy to access REST service check box is not selected, and the application server and the map server are not on the same machine, then requests to the map server will fail and an error message indicating a network error is generated. This is the result of a default setting in web browsers, which prevents cross-domain Ajax calls. This setting can be changed in the security settings section of your web browser configuration.

    Note: If you are using Microsoft Internet Explorer Version 10 and the Use proxy to access REST service check box is not selected, the following dialog box is displayed.

    If you click Yes, then Microsoft Internet Explorer allows you to access the map service without the proxy.jsp. If you click No, an error message indicating Access is denied is displayed.

    If you are using Google Chrome and the Use proxy to access REST service check box is not selected, an error message indicating A network error is displayed. If you are using Mozilla Firefox 24 and the Use proxy to access REST service check box is not selected, an error message indicating Failure is displayed. As a workaround, you must select the Use proxy to access REST service check box and edit the proxy.jsp to add a REST endpoint to your proxy list.

    To edit the proxy.jsp file, navigate to the following directory:

    <WF_HOME>\webapps\webfocus\tools\esri_config\proxy.jsp

    Add your REST endpoint, as indicated by the following example:

    String[] serverUrls = {
      //"<url>[,<token>]"
      //For ex. (secured server): "http://myserver.mycompany.com/arcgis/rest/services,ayn2C2iPvqjeqWoXwV
            6rjmr43kyo23mhIPnXz2CEiMA6rVu0xR0St8gKsd0olv8a"
      //For ex. (non-secured server): "http://sampleserver1.arcgisonline.com/arcgis/rest/services"
      "http://informat-65f86f:8399/arcgis/rest/services",
      "http://ibigisdev.ibi.com:8399/arcgis/rest/services",
      "http://ibigis10.ibi.com:8399/arcgis/rest/services",
      "http://tsssvz01:8399/arcgis/rest/services", 
      "http://sampleserver1.arcgisonline.com/arcgis/rest/services",
      "http://sampleserver2.arcgisonline.com/arcgis/rest/services" //NOTE - no comma after the last item
    };
  4. Specify a host name for ArcGIS in the Host field followed by the port, instance, and URL in the corresponding fields. Consult your ArcGIS administrator for the correct values to use.

    Note: As a best practice, do not include an ending forward slash (/) character when specifying an ArcGIS Server URL in the proxy.jsp file. If a forward slash character is specified, then you must ensure that the value entered in the Instance field of the REST Service Connection Information dialog also contains a forward slash at the end.

  5. Click OK.

    You are returned to the Create a new outbound layer dialog.

  6. Expand an available Map Server node and then select the layer (for example, Counties) that will be used to select the map features.
  7. Click Next.

    The Select Attributes dialog opens, which is populated with all of the attribute names from the layer that was selected.

  8. Select the attribute(s) that you want to be used as a unique identifier to link the map service layers with FOCEXEC columns.

    You can modify the Format, Size, and Quote value columns according to your requirements.

    The Format column reflects the FOCEXEC format to be used for conversion. Valid FOCUS formats are used with a length (for example, A30, D10.2).

    The Size column reflects the length of the map service layer field.

    The Quote column reflects the type of quote to use for querying the map service layer field. Use single quotes for shape file layers and double quotes for SDE layers.

  9. Click Next when you have finished making your attribute selections.

    The following dialog opens, which allows you to specify a FOCEXEC column name to be used for binding.

  10. Specify a FOCEXEC column name and click Finish.

    The new outbound layer definition is listed in the Outbound Layers tab of the FOCEXECs configuration area, as shown in the following image.

    The Properties table lists the available configuration properties for the outbound layer definition. The following table lists and describes these properties.

    Property

    Description

    Location

    The location of the map layer.

    Attribute Names

    The selected attribute(s) for the outbound layer definition.

    Symbol

    Allows you to select an available symbol definition from the drop-down list that will be used to render the map illustrating which features have been selected.

    Callout Symbol

    Allows you to select a callout symbol style from the drop-down list to be used by your FOCEXEC.

    Fex Column Name

    The specified FOCEXEC column name to be used for binding.

    Image

    Refers to a FOCUS Report Column to use for the IMAGE field. This image field can be used to symbolize point features.

    Label Field

    Refers to a FOCUS Report Column to use for labeling features on an outbound layer.

    Rollover

    Enables or disables rollover (mouse over) support for the outbound layer. The default value is No.

    Color

    These fields contain the default field names that may be present in the XML output the WebFOCUS GIS Adapter will process. The actual field names are present in the FOCEXEC. Refer to the DEFINE or COMPUTE lines for the specific names.

    Shape

    Size

    Text

    Title

    Other Symbol

    Allows you to select an additional symbol from the drop-down list.

    Text Symbol

    Allows you to select an available text symbol from the drop-down list.

    Polygon Text Symbol

    Allows you to select an available polygon text symbol from the drop-down list.

    Grid Display Info Field

    Refers to a list of FOCUS Report Column(s) to be displayed in the Data View widget.

    Color Table

    Allows you to specify a color table to be used by the outbound layer.


WebFOCUS