Configure Address Matching Provider

Configure address matching provider

Configuring workspace as an address matching provider example

<provider class="com.supermap.services.providers.UGCAddressMatchProvider" enabled="true" name="addressmatch-BeijingAddress"> <config class="com.supermap.services.providers.UGCAddressMatchProviderSetting"> <dictionaryPath>./WEB-INF/config/addressMatchDictionary.dct</dictionaryPath> <isTraditional>true</isTraditional> <workspacePath>E:/supermap/data/BeijingAddress/BeijingAddress.smwu</workspacePath> <indexDir>E:/supermap/data/BeijingAddress/index</indexDir> <datasourceName>BeijingAddress</datasourceName> <datasetNames>company</datasetNames> <updateIndex>false</updateIndex> <geoDecodingRadius>500</geoDecodingRadius> <searchFields>NAME,ADDRESS,county,city</searchFields> <indexEpsgCode>3857</indexEpsgCode> <binDistance>-1.0</binDistance> <maxReturn>10</maxReturn> <filterFields>city,county,ADDRESS</filterFields> <hour>3</hour> <minute>0</minute> <dayOfWeek>1</dayOfWeek> </config> </provider>

Example of configuring address index as address matching provider

    <provider class="com.supermap.services.providers.UGCAddressMatchProvider" enabled="true" name="addressMatch-index">
      <config class="com.supermap.services.providers.UGCAddressMatchProviderSetting">
        <isMultiInstance>false</isMultiInstance>  
        <dictionaryPath>./WEB-INF/config/addressMatchDictionary.dct</dictionaryPath>  
        <indexDir>E:\supermap_packages\data\BeijingAddress-new\BeijingAddress\index</indexDir>  
        <poolSize>4</poolSize>  
        <geoDecodingRadius>500.0</geoDecodingRadius>  
        <indexEpsgCode>0</indexEpsgCode>  
        <binDistance>-1.0</binDistance>  
        <maxReturn>-1</maxReturn>  
        <updateIndex>false</updateIndex>  
        <hour>3</hour>  
        <minute>0</minute>
      </config>
    </provider>

The class in <provider> identifies the implementation class of the UGC service provider，the class in <config> identifies the configuration class corresponding to the UGC service provider, which is UGCAaddressMatchLayoutSetting, the content in <config> is the configuration item corresponding to UGCAaddressMatchExtendedSetting:

< dictionaryPath >: Address dictionary path. Please refer to the parameter description of service providers configuration for details.

< workspacePath >: The path of the workspace used by the service provider. If there is a password in the workspace, assuming the password is supermap, write it as:

<workspacePath>server=../samples/data/World/World.sxwu;password=supermap</workspacePath>

In addition, the workspace path supports reading from environment variables and the system config file. It can be written as:

<workspacePath>server=${datapath1}/World.sxwu;password=supermap</workspacePath>

For detailed instructions, please refer to: Preset Local Workspace Path

< indexdir >：index directory. When publishing a workspace as an address matching service, this parameter is used to specify the directory of the generated address index. When publishing a service, the system will establish an index based on the content of the specified fields in the dataset that participates in address matching, and at the same time segment them. This process is based on the input dictionary. You can also enter an existing index directory here for publishing address matching services. Note that you need to select the address dictionary based on the expected matching font. For Simplified Chinese, please choose a Simplified Address Matching Dictionary, such as addressMatchDictionary.DCT; For traditional Chinese, please select a traditional Chinese address matching dictionary, such as addressMatchDictionaryTraditionalChinese.dct.

< datasourcename >：Datasource name use for address match.

< isTraditional >: Whether to generate traditional index. Only matching generation is supported when using traditional address matching dictionary.

< updateIndex >: whether to update index regularly. Defaults to false when set to When true, the three parameters < hour >, < minute >, < dayOfWeek > or < hour >, < minute >, < updateIndexDate > need to be set at the same time.

< poolSize >: The thread pool size. The recommended setting is the same as the number of CPU cores.

< geoDecodingRadius >: Query range. After setting, the user will get the results within the specified radius. It is valid when using reverse address matching. The unit is consistent with the projection system unit of the index. If the search radius is not set, the default value of -1 is used, indicating that the entire layer range is queried. The search radius defaults to 0.01 degrees in degrees and 500 meters in meters.

< searchFields >: The name of the search field, which is the field that participates in the address match.

< indexEpsgCode >: Specifies the index projection.

< maxReturn >： The max return count of results.

< filterFields >: Set the group field, for example, "province, city, county". When the user uses the address matching function, the query area will be limited according to the set fields.

< updateIndex >: Automatically update index if negative. The default is false.

< hour >: The number of hours for update index regularly. The parameter is valid when < update Index > is true.

< minute >: The number of minutes for update index regularly. The parameter is valid when < updateIndex > is true.

< dayOfWeek >: The number of weeks between updates. For example, it is updated every Wednesday and Friday, and the parameter value is set to "3,5". The parameter is valid when < update Index > is true.

< updateIndexDate >: Specifies the update date. For example, it is updated on March 5, 2017, and the parameter value is set to "2017-03-05". The parameter is valid when < updateIndex > is true.

< binDistance >: The distance between the grids when the index was created. -1 indicates the default value: when the coordinate system of the data set is a geographic coordinate system, the default value is 0.01 degree; when the coordinate system is a projection coordinate system, the default value is 1000 meters.

Note: 1. When using the address match service, it is recommended that the projection of all data sets be consistent.

2. Currently, only Chinese is supported for matching, not English.

Configure ArcGIS REST address matching provider

Configure an ArcGIS REST address matching provider as follows:

<provider class="com.supermap.services.providers.ArcGISRestGeocodeProvider" enabled="true" name="addressmatch-arcgisGeocode"> <config class="com.supermap.services.providers.ArcGISRestGeocodeProviderSetting"> <restServiceRootURL>https://arcserver.ispeco.com/server/rest/services/World/GeocodeServer</restServiceRootURL> </config> </provider>

The class in <provider> identifies the implementation class of ArcGIS REST address matching provider, the class in <config> identifies the configuration class corresponding to the ArcGIS REST address matching service provider, namely ArcGISRestGeocodeProviderSetting, the content in <config> is the corresponding configuration item:

< restServiceRootURL >: The address of the ArcGIS REST address matching service, pointing to the root resource path of the service.

< token >, < httpReferer >: When security mechanisms are enabled, accessing protected services requires providing a Token. If the token used is applied for through HTTP referee, the corresponding <httpReferer> needs to be set.

Note: The completion date of this documentation is 2026-03-26. If the previous documentation (including electronic documentation and printed documentation) does not conform to this documentation, please refer to this documentation. If updated, the updated documentation will prevail.