Configure Record Import (Addresses)

Summary

This tool is used to build a configuration file for table containing street addresses, and the parameter values required by the Import Records tool.

Usage

  • This tool should be run to overwrite or create a new configuration file (.ini) any time there has been an update to the Source Table schema.
  • This tool expects a feature class or web layer exists where records from Source Table will be imported.
  • If the configuration file from this tool references the ArcGIS World Geocoding Routing Service in the Address Locator parameter the tool will consume credits when it is run in the Import Record tool. The credit consumption rate is the same as the Geocode Addresses tool. For more information, see Geocode Addresses in the System tool chart.

Syntax

ConfigRecordImportAddress_recordimport (Config_File_Name, Source_Table, Target_Features, {Portal_URL}, {Username}, {Password}, Log_File_Directory, {Summary_Field}, Record_ID, Record_Date_Field, Delete_Duplicates, Street_Address_Field, {City_Field}, {State_Field}, {ZIP_Field}, Address_Locator, Source_to_Target_Field_Mapping_Option, {Field_Match}, {Timestamp_Format})

Parameter

Parameter Explanation Data Type
Configuration Filename

Provide a name and location for the configuration file created by running this tool.

This configuration (.ini) file will be saved to the location you define, once created, the configuration file can be moved to another location if preferred. This configuration file can be used as input to the Import Records tool.

String
Source Table Provide a table (comma-separated values (.csv), Microsoft Excel spreadsheet (.xls)) containing the records to be mapped. Each record must be detailed on one line of the table and contain fields with the following information: record identifier, record date, and location information, such as street address in one or more fields. Table
Target Features

Existing point feature class from a web layer or feature class or web layer where records from Source Table will be imported.

Feature Class or Feature Layer
Portal URL (optional)

This optional parameter defines the organization name or portal URL and is only accessible when Target Features is a web layer.

The full URL should be included to the ArcGIS Online organization or ArcGIS Enterprise portal at which your Target Features web layer is hosted.

For example, https://organizationname.maps.arcgis.com/ or http://organizationname.maps.arcgis.com/.

If using a hosted feature layer in ArcGIS Online, then you can enter https://www.arcgis.com rather than your organization short name, if desired.

String
Username (optional)

The username of a user with necessary privileges to edit the Target Features.

Usernames are case sensitive.

This parameter is only accessible when the Target Features is using a web layer.

String
Password (Optional)

The password of a user with necessary privileges to edit the Target Features.

Usernames are case sensitive.

This parameter is only accessible when the Target Features is using a web layer.

String
Log File Directory

Directory to store log files generated by the Configure Record Import (Addresses) tool.

This tool generates a series of reports documenting its progress, errors, and data warnings:

  • A log file showing the progress of the tool, any errors or warnings, and optionally a summary of the data processed.
  • A spreadsheet of records that could not be geocoded (address data only).
  • A spreadsheet of records that could not be appended to the Target Features.
Folder
Summary Field (optional)

Field containing values from Source Table by which the records can be summarized. This summary is provided in the log file.

For example, if the report date field is provided, the log file will contain a list of the report dates found in the Source Table with the number of records on each of those dates.

Field
Record Identifiers Field containing the identifier for each incident. Field
Record Date Field

Date field from Source Table containing the date the record occurred or was reported. When testing for duplicate records in the Source Table and Target Features this field is used to determine which record is the most recent.

Date Field
Delete Duplicates

When enabled, the Import Records tool will verify that the record in the Source Table does not already exist in the Target Features before appending a record from the Source Table to the Target Features.

If the Target Features already contains a record with the same record identifier, the tool will compare the values in the Record Date field, then the values in the provided location fields.

If the Source Table contains the more recent record or if the dates match and the location has not changed, the tool will update the features attributes using the values from the Source Table.

If the Source Table contains the more recent record or if the dates match and the location changed, the feature will be deleted from the Target Features and the Source Table values will be used to generate a new feature in the new location.

If the Source Table date is older than the date in the feature class or web layer, that record in the Source Table will not be processed further.

Boolean
Street Address Field

Field containing, at minimum, the street addresses of the records to be mapped, for example, 123 Main St.

This field can also contain the full address of the record, for example, 123 Main St, Naperville, IL.

If city, state, and ZIP information is not included in this field, it is strongly recommended that fields with this information be provided in the City Field, State Field, and ZIP Field parameters.

Field
City Field (optional)

Field containing the name of the city in which the record is located. This information may also be included in the Street Address Field.

This information may also be included in the Street Address Field.

Field
State Field (optional)

Field containing the name of the state or province in which the record is located. This information may also be included in the Street Address Field.

Field
ZIP Field (optional)

Field containing the ZIP or postal code in which the record is located. This information may also be included in the Address Field.

Field
Address Locator

Locator or geolocation service used to create point features from address information.

Using the ArcGIS World Geocoding Service consumes credits and requires authentication, from your ArcGIS Online organization when it is run in the Import Records tool.

Credit consumption is the same as the Geocode Addresses tool. For more information, see Geocode Addresses in the System tool chart.

Using your own locator or geocoding service requires further configuration.

Address Locator or Geocoding Service
Schema Mapping Type

This parameter allows you to choose Source Table Schema Matches Target or Use Field Mapping depending on whether or not the schema of the Source Table matches the Target Features to be appended.

Choose Source Table Schema Matches Target if the field names and types in the Source Table and Target Features are identical.

Choose Use Field Mapping if the field names in the Source Table do not match the field names in the Target Features.

String
Field Match (optional)

This parameter controls how the attribute information in Source Table fields is transferred to the Target Features feature class or web layer. This parameter can only be used if the Field Mapping is specified.

Source Field reflects attributes from the Source Target and Target Field reflects attributes from Target Features.

In the Source Field column, choose fields from the Source Table that contain information to preserve in the Target Features.

In the Target Field column, choose fields from the Target Features that correspond with the field in the Source Table.

Source and target information for the fields specified in the Record Identifier Field, Record Date Field, Street Address Field parameters are required. If you added values for the source and target information for the fields in Summary Field, City Field, State Field, and Zip Field parameters, then those fields are also required.

Field Mapping
Timestamp Format (optional)

This parameter controls dates that are formatted as strings in the Source Table. If your Source Table formats date values are strings, then use this parameter to define the original date format. For more information, see Python strftime.

For example, the format %m/%d/%Y %H:%M would assume the string date field is formatted as 05/18/2016 14:53.

String

Licensing information

  • ArcGIS Desktop Basic: Yes
  • ArcGIS Desktop Standard: Yes
  • ArcGIS Desktop Advanced: Yes
Top