Include the Current Features in a Report

A common use for reporting in web maps is for the user to select some features on the map or in search results, and then run a report on the selected features. A report that operates on the currently selected features is called a layer report.

Layer reports take ArcGIS feature IDs as inputs. When an end user runs a layer report from a host application, Geocortex Reporting gets the feature IDs for the currently selected features and queries the service for records with a matching ID. The result is a report that includes data for just those features in the current selection set.

When you preview a report that takes feature IDs as input, there is no selection set for the report to use as input. In this case, the Preview prompts you to enter the feature IDs to use as inputs. You can configure default values so you don't have to re-enter the feature IDs every time you preview the report.

Similarly, if you use Geocortex workflows to run layer reports, you will have to supply the feature IDs for the report to operate on. In this case, you configure the workflow that runs the report to pass the feature IDs to the report. For more information, see Run Reports from Geocortex Workflows.

In ArcGIS, feature IDs are stored in a field of type esriFieldTypeOID. Often the field is called OBJECTID, but the name of the field can vary from service to service.

To configure a report to take inputs, you place a parameterized condition on the query. The main steps to do this are as follows:

  1. Add the report parameter.

    The report parameter must be a MultiValue parameter of type Number (32 bit integer) called FeatureIds.

  2. Add a parameterized filter condition to the query:

    1. Add a filter condition to the query that has the following form:

      Layer.Feature-ID-field   is any of   Query-parameter

      where:

      • Layer is the name of the layer being queried.

      • Feature-ID-field is the name of the field that contains the feature ID, for example, OBJECTID.

      • Query-parameter is the name of the query parameter that you will create.

      For example:

      easements.OBJECTID   is any of   idsFromClient

    2. Bind the FeatureIds report parameter to the query parameter.

The procedure below provides instructions for configuring an existing report to take feature IDs as inputs. To try it yourself, follow the tutorial in Create Reports.

To create a new report that operates on the current selection set, use the Layer Report Wizard. The Layer Report Wizard creates the report parameter and parameterized filter condition for you.

Configure an Existing Report to Take Feature IDs as Inputs

To configure an existing report to take inputs:

This procedure shows you how to adapt an existing report to take inputs. It assumes that the report is already created.

Step 1: Add the report parameter

  1. Click Fields to open the Field List.

  2. Click Parameters to show the management buttons.

  3. Click Add parameter .

    A new parameter is added.

  4. Click Edit to edit the parameter.

  5. Configure the parameter's properties:

    1. In the Name box, type the following name for the parameter: FeatureIds

      The report parameter must be called FeatureIds. This is the name that the client application looks for when the report runs.

    2. Select the MultiValue checkbox.

      Multi-value parameters take one or more values as inputs.

    3. Select Number (32 bit integer) from the Type drop-down list.

      Esri feature IDs are 32-bit integers.

    4. If you want to add default values, click Value to show the plus sign, click the plus sign, and enter a feature ID that you want to use as a default value. Repeat this step for each default value that you want to configure.

      Default values are helpful while you are designing a report, because you can preview the report as many times as you want without having to enter feature IDs every time.

      Report parameter with one default feature ID, configured to take multiple feature IDs

Step 2: Add a parameterized filter condition to the query

  1. In the Field List, expand the data source.

  2. Click the table to show the management buttons.

  3. Click Edit Query to open the SQL Data Source Wizard.

  4. Click Run Query Builder.

  5. Add the filter condition to the query:

    1. In the Query Properties panel, click the icon in the Filter box to open the Filter Editor.

    2. Add a condition using the desired mode:

      • Default Mode:

        1. Click the plus icon beside the And operator and select Add condition.

          New condition, ready to be configured

        2. Click the blue box, expand the layer, and select the feature ID field. It is usually named some variation of OBJECTID.

        3. Click the green box and select Is any of.

        4. Create a query parameter:

          1. Click the arrow in the gray Enter a value box and select Parameter.

            The box turns yellow and says Create new parameter.

          2. Click the yellow box and select Create new parameter.

          3. Type a name for the parameter, for example, idsFromClient.

        5. Click away from the condition.

          The filter expression looks similar to this in the default mode:

          Filter condition for feature ID inputs

        6. Select the Advanced Mode checkbox to show the filter expression.

          The expression should look similar to this:

          If the query parameter, idsFromClient, is missing, type it in.

      • Advanced Mode:

        1. Select the Advanced Mode checkbox to show the input area.

        2. Type a filter expression similar to the following:

          [layer.OBJECTID] In(?idsFromClient)

          where:

          • layer is the name of the layer being queried.

          • OBJECTID is the name of the field that contains the feature ID.

          • idsFromClient is the name of the query parameter that you created.

    3. Click Save.

      The filter expression appears in the Filter box in the Query Properties panel.

      Configured query filter

      Do not attempt to preview the results yet. The filter expression includes a query parameter that does not yet have a value, so the query will fail.

  6. Click OK to close the Query Builder.

  7. Click Next.

  8. Bind the FeatureIds report parameter to the query parameter:

    1. Expand the idsFromClient query parameter.

    2. Set Type to Expression.

    3. Click the icon in the Value box to open the Expression Editor.

    4. Expand Parameters.

      These are the report parameters.

    5. Double-click the FeatureIds parameter, shown at in the screen capture.

      The Expression Editor will build the expression and display it, shown at . The expression is [Parameters.FeatureIds].

      Expression that accesses the FeatureIds report parameter

    6. Click Save.

      FeatureIds report parameter bound to idsFromClient query parameter

  9. Click Finish to close the SQL Data Source Wizard.

  10. Press Ctrl+S to save the report.

  11. To test the report inputs, click Preview , enter the desired feature IDs, and then click OK.

    To preview a report, your browser must allow pop-ups from apps.geocortex.com (cloud Reporting) or from your domain (on-premises Reporting).

© 2019 Latitude Geographics Group Ltd. All Rights Reserved.

Documentation Version 5.2