Summary
This tool is used to build a configuration file containing the parameter values required by the Import and Publish Incidents tool.
Parameter
Parameter | Explanation | Data Type |
Configuration file name | Provide a name for the configuration file created by running this tool. This configuration (.cfg) file will be saved to the same directory as the script being run by this tool, although once created, the configuration file can be moved to another location if preferred. This configuration file can be used as input to the Import and Publish Incidents tool. |
String |
Incident spreadsheet | Provide a CSV or Microsoft Excel worksheet containing the incident data to be mapped. Each incident must be detailed on one line of the spreadsheet, and have fields with the following information:
|
Table |
Incident feature class | Point feature class to which the spreadsheet incidents will be appended by the Import and Publish Incidents tool. The incident identifier and location fields must use the same field names in the spreadsheet and the feature class. Any other attributes in matching fields will be also be copied from the spreadsheet to the feature class. Values in fields that do not exist in both the spreadsheet and this feature class will not be copied. |
Feature Class |
Reports directory | Directory to store reports generated by the Import and Publish Incidents tool. This tool generates a series of reports documenting its progress, errors, and data warnings:
|
Folder |
Incident identifiers | Field containing the identifier for each incident. This field name must be the same (case-sensitive) in both the spreadsheet and point feature class chosen above. | Field |
Delete duplicates | When enabled, the Import and Publish incidents tool will verify that the incident identifier for the row in the spreadsheet does not already exist in the feature class before appending an incident from the spreadsheet to the feature class. If the feature class already contains the incident identifier, the tool will compare the values in the Incident Report Date field, then the values in the provided location fields. If the spreadsheet 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 spreadsheet. If the spreadsheet contains the more recent record or if the dates match and the location changed, the feature will be deleted from the feature class and the spreadsheet values will be used to generate a new feature in the new location. If the spreadsheet date is older than the date in the feature class, that record in the spreadsheet will not be processed further. |
Boolean |
Incident report date | Date field containing the date the incident occurred or was reported. When testing for duplicate records in the spreadsheet and feature class, this field is used to determine which record is the most recent. This field name must be the same (case-sensitive) in both the spreadsheet and point feature class chosen above. If the input spreadsheet is a CSV file, the tool must know the format of dates in this field. By default this value is defined as mm/dd/yyyy hh:mm where month, day, hours, and minutes are all zero-padded, for example 04/21/2014 16:03. The expected format can be modified by changing the value of the timestamp variable near the top of the import_publish_incidents.py script. This field is required if Delete duplicates is enabled and not available if Delete duplicates is disabled. |
Field |
Summary field (optional) | Field containing values by which the incidents 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 spreadsheet with the number of incidents on each of those dates. |
Field |
Location type | Incident locations can be determined two ways:
|
String |
Publish service (optional) | Choose the method to publish the incident service or leave blank to not publish a service:
|
String |
Address field (optional) | Field containing, at minimum, the street addresses of the incidents to be mapped, for example 123 Main St. This field can also contain the full address of the incident, 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. This parameter is required if the Location type is "ADDRESSES" and is disabled if the Location type is "COORDINATES". |
Field |
City field (optional) | Field containing the name of the city in which the incident is located. This information may also be included in the Address Field. This parameter is disabled if the Location type is "COORDINATES". |
Field |
State field (optional) | Field containing the name of the state or province in which the incident is located. This information may also be included in the Address Field. This parameter is disabled if the Location type is "COORDINATES". |
Field |
ZIP field (optional) | Field containing the ZIP or postal code in which the incident is located. This information may also be included in the Address Field. This parameter is disabled if the Location type is "COORDINATES". |
Field |
Address locator (optional) | Locator or geolocation service used to create point features from address information. To use a locator or geocode service that requires authentication, such as the World Geocode Service, establish a Server Connection to the service with saved credentials and use this connection for this parameter. This parameter is required if the Location type is "ADDRESSES" and is disabled if the Location type is "COORDINATES". |
Address Locator |
Longitude (optional) | Field containing the longitude of the incidents. This parameter is required if the Location type is "COORDINATES" and is disabled if the Location type is "ADDRESSES". |
Field |
Latitude (optional) | Field containing the latitude of the incidents. This parameter is required if the Location type is "COORDINATES" and is disabled if the Location type is "ADDRESSES". |
Field |
Coordinate system of spreadsheet (optional) | Choose the coordinate system of the values in the latitude and longitude fields. This parameter is required if the location type is "COORDINATES" and is disabled if the Location type is "ADDRESSES". |
Coordinate System |
Ignore incidents with longitude and latitude 0 (optional) | Enable to ignore incidents with coordinate values 0,0. These incidents will be written to the report of incidents that could not be appended to the feature class. This parameter is disabled if the Location type is "ADDRESSES". |
Boolean |
Transformation (optional) | Transformation to use when converting between the spatial reference system (SRS) of the values in the spreadsheet and the SRS of the feature class. Converting between SRS that use different datums requires a transformation. By default, the Import and Publish Incidents tool converts between the SRS of the spreadsheet locations and the feature class using the first transformation option. Alternatively, a different transformation may be specified here. |
String |
Map document (optional) | Map document used to publish the incident data as a service. This parameter is only accessible after choosing a Publish service method. |
ArcMap Document |
Service name (optional) | Name of a service that exists in the ArcGIS Online organization or on an ArcGIS Server. This parameter is only accessible after choosing a Publish service method. |
String |
Server connection (optional) | Full path to the server connection file. This parameter is only accessible when the Publish service method is ARCGIS_SERVER. |
ServerConnection |
Server folder (optional) | If the service is stored in a folder on the server, specify the folder name. This parameter is only accessible when the Publish service method is ARCGIS_SERVER. |
String |
Username (optional) | Provide the username of an account with permissions to overwrite this service. This parameter is only accessible when the Publish service method is ARCGIS_ONLINE. |
String |
Password (Optional) | Provide the password for the username provided above. This parameter is only accessible when the Publish service method is ARCGIS_ONLINE. |
String |
Share with everyone Public (Optional) | Enable to share this service with Everyone, including everyone in the organization and the public. This will override any sharing permissions on the existing service. This parameter is only accessible when the Publish service method is ARCGIS_ONLINE. |
Boolean |
Share with your organization (Optional) | Enable to share this service with all other members of your organization. This will override any sharing permissions on the existing service. This parameter is only accessible when the Publish service method is ARCGIS_ONLINE. |
Boolean |
Share with these groups (Optional) | Provide a comma-separated list of group IDs with which this service should be shared. This will override any sharing permissions on the existing service. Group ID values can be found using the Group ID Finder. This parameter is only accessible when the Publish service method is ARCGIS_ONLINE. |
Multiple Value |
Tags (Optional) | Provide tags for the service. This will override any tags on the existing service or in the map document. This parameter is only accessible when the Publish service method is ARCGIS_ONLINE. |
String |
Description (Optional) | Provide a description for the service. This will override any description on the existing service. This parameter is only accessible when the Publish service method is ARCGIS_ONLINE. |
String |
Maximum number of records to display | Modify the maximum number of records from this service that will be displayed at one time. Increasing this value may negatively affect the performance of this service in web maps and applications. This parameter is only accessible when the Publish service method is ARCGIS_ONLINE. |
Long |