System Requirements, Installation, & Working with the Code
Before contributing to OpenStreetMap using the ArcGIS Desktop environment, please read the assumptions below.
- Use of the ArcGIS Editor for OpenStreetMap assumes that you are familiar with the
OpenStreetMap site and are a member of its community. If not, then you should 1) spend some time on the
OpenStreetMap wiki page, 2)
create a user account, and 3) read the
Map Making Overview page.
- Remember that you are responsible for any licensing associated with the edits you contribute to OSM. If there is any doubt that what you are about to contribute is under a license, you should wait and confirm that you can post the edit before doing so.
- Firsthand knowledge of the area you are mapping is much valued in the OpenStreetMap community. If you know there is a contribution that you are uniquely qualified to make (for example, an edit to features in your town of residence), that is a great edit
Important: Read First!
- If you have an earlier version of ArcGIS Editor for OSM installed, you should uninstall the earlier version before installing a newer release
- If you are installing on an ArcGIS 10 environment (and not 10.1), system requirements and installation notes are available
- Instructions on this page are for 10.1 environments only.
- Note! Through the
ArcGIS for Home Use Program, users can purchase a non-commercial license for ArcGIS for Desktop that includes many extensions for US$100/yr.
Because Version 2.1 offers separate installers for Server component, Desktop component, and the Desktop component when 64 bit Background Geoprocessing is installed, the system requirements differ depending on which components are installed. See the requisite
Desktop component requirements
- ArcGIS 10.1 for Desktop. Note: ArcGIS for Desktop must be installed before the ArcGIS Editor for OpenStreetMap can be installed.
Desktop component requirements when 64 bit Background Geoprocessing is installed
- ArcGIS 10.1 for Desktop
- ArcGIS Background Geoprocessing for Desktop 10.1 sp1
- Note: ArcGIS for Desktop and the Background Geoprocessing for Desktop 10.1 sp1 must be installed before the ArcGIS Editor for OpenStreetMap Desktop Component with Background Geoprocessing can be installed.
Server component requirements
The following operating systems have been tested with the Server Component. If you find other OS that work well, please let us know.
, 32 bit systems are not supported for the Server Component with the version 2.1.
Internet Information Services (IIS)
- Windows 2003 Server SP2 64 bit (note - will not work with MS SQL Server - see known issue
- Windows 2008 Server 64-bit
- Windows 2008 R2 Server 64-bit
- Windows 7, 64-bit
IIS is required for the Server component,and you must enable the following role services:
Third Party Components
- Common HTTP Features
- Static Content
- Default Document
- HTTP Errors
- Application Development
- ASP .NET
- ISAPI Extensions
- ISAPI Filters
- Health and Diagnostics
- Basic Authentication
- Windows Authentication
The installer checks for certain third party components. If not present, a dialog will appear giving you the option to agree to their license and install them, or exit the installation.
ArcGIS for Server
- Microsoft SQL Server Compact 4.0
- Microsoft ASP.Net MVC3
- Microsoft Entity Framework
ArcSDE can be installed locally or on a different server. Note that if installed on a different server, you may need to add an entry (e.g., esri_sde 5151/tcp #ArcSDE) for the sde service in the local c:\windows\system32\drivers\etc\services file. You can update
the \\<serverName>\C$\inetpub\wwwroot\OSM\web.config file for where the SDE file is:
<add key="DatabaseConnection" value="C:\Data\OSM\Mxds\osmdevsde.sde" />
Both the windows service or the direct connect setups for ArcSDE will work.
- ArcSDE for SQL Server
- SQL Server 2005 SP2 & SP3 (32-bit)
- SQL Server 2005 SP2 & SP3 (64-bit)
- SQL Server 2008 Final - R2 (64-bit)
- SQL Server Express 2008 R2 (64 bit)
- ArcSDE for Oracle
- Oracle 11g R2 (64-bit) 220.127.116.11
- ArcSDE for Postgres
- PostgreSQL 8.4.9-1 (32-bit)
Important: If you have an earlier version of ArcGIS Editor for OSM installed, you should uninstall the earlier version before installing a newer release
When you downloaded the ArcGIS Editor for OSM version 2.1 package, the .zip file contained three subfolders with setup.exe installers:
- ArcGIS_Editor_OSM_10_1Desktop: Use this for installing the ArcGIS Editor for OSM Desktop Component, per the "Desktop Component for 10.1" instructions below.
- ArcGIS_Editor_OSM_10_1Desktop_64_BackgroundGP: Use this for installing the ArcGIS Editor for OpenStreetMap Desktop Component with Background Geoprocessing, per the "Desktop Component for 10.1 with Background Geoprocessing" instructions
- ArcGIS_Editor_OSM_10_1Server: Use this for installing the ArcGIS Editor for OSM Server Component, per the "Server Component for 10.1" instructions below.
The ArcGIS Editor for OSM Server and Desktop components operate independent from one another; this means that you don’t have to have one installed for the other to work. You can install one or both on your environment. If you have ArcGIS for Desktop 10.1 with
Background Geoprocessing installed, then you must install the ArcGIS_Editor_OSM_10_1Desktop_64_BackgroundGP
and not the ArcGIS_Editor_OSM_10_1Desktop installation for the Desktop component.
Desktop Component for 10.1
To install the ArcGIS Editor for OSM Desktop component on ArcGIS 10.1, run the setup.exe in the ArcGIS_Editor_OSM_10_1Desktop folder. Accept the license, and then choose an installation directory. Continue to click through the wizard, and then click Finish
at the end. After installation, a page will launch with instructions for how to get started with the Desktop tools. After installation of the Desktop component, three items are installed to your ArcGIS Desktop environment:
- A set of geoprocessing tools and models to download, extract, and upload vector data from and to the OpenStreetMap server.
- Customizations to the core editor environment in ArcMap to handle the OpenStreetMap tags inside the core Esri software.
- A conflict editor user interface to similar to the
Reconcile Version tool for enterprise geodatabases.
- the installer will put the OpenStreetMap Toolbox in your ArcGIS System Toolbox.
Desktop Component for 10.1 with Background Geoprocessing
The installation instructions and installed components of the ArcGIS Editor for OpenStreetMap Desktop Component with Background Geoprocessing is exactly the same as those for the ArcGIS_Editor_OSM_10_1Desktop, except that you will run the setup.exe in the
folder instead of the one in ArcGIS_Editor_OSM_10_1Desktop. See the "Desktop Component for 10.1" section above for installation instructions and installed components.
Server Component for 10.1
To install the ArcGIS Editor for OSM Server component on ArcGIS 10.1, you will need to work through the screens the installer presents carefully. The installer has many automatic checks for connections to ensure that the information you provide is adequate
for installing the server component. You may notice a delay after inputting information in the wizard screen – this occurs because the installer is doing those checks. Follow the steps below.
- Launch the installer by double-clicking the setup.exe. Begin the installation, accepting the license presented.
- Upon accepting the license, you will be notified that in addition to installing the ArcGIS Editor for OSM Server component, the installation will also install three other components – Microsoft SQL Server Compact 4.0, Microsoft ASP.Net MVC3, and Microsoft
Entity Framework – if not already present. These components have a different license than the license for the ArcGIS Editor for OSM, and so you will be prompted to accept the licenses for those components later in the installation process. Click “Yes” to acknowledge
this and proceed to the next screen.
*On the next screen, you will enter information that connects the ArcGIS Editor for OSM with your ArcGIS Server instance, as shown and described below:
- Server Name: Name of the server hosting ArcGIS Server.
- Instance URL: The URL to your ArcGIS Server instance.
- ArcGIS Server Primary Site Administrator Account: This is the username and password of the ArcGIS Server user who can access the ArcGIS Server site where your services will be created and maintained.
- Publishing User: The username and password of an ArcGIS Server user who can publish services. If this user should be the same as the ArcGIS Server Primary Site Administrator Account, check the box that indicates this.
- Click Next. The next screen shows more parameters for creating your feature service. Fill out the fields as shown and described below:
- OSM Application Admin User: username and password to a user who has access to the inetpub directory for IIS, and the local folder structure for creating/storing the generated mxd files. If this user should be the same as the ArcGIS Server Primary
Site Administrator Account, check the box that indicates this.
- Directories - Working Folder: where the template MXDs and ArcSDE geodatabase information is stored. Default is C:\Data\OSM.
- Directories - Output Folder: where the output MXD ArcGIS Server uses for the feature service is stored. Default is C:\arcgisserver\directories\arcgisoutput.
- SDE Platform: Indicate which of the three supported database platforms you are using for SDE.
- Click Next. Now you will be presented with fields to further describe the SDE connection. Fill these out as shown and described below:
- Database Server instance: servername of the machine hosting sde service (must be accessible to the machine upon which ArcGIS Editor for OSM - Server is being installed).
- Database: name of the sde database
- User Name: sde username
- Password: sde password
- Version: version of the sde database (typically 'sde.DEFAULT')
- Click Next. Now you will be presented with a file path to where the ArcGIS Editor for OSM Server files will be installed. Change this if you like, and click Next to proceed with the installation.
Important: this is not an installer you can just leave - remember that you will be prompted to accept licenses from the three Third Party Components. The installer will eventually timeout if you don't respond to prompts.
- When the installer is finished, a page will launch with instructions on how to access your new feature service creation interface and what to do next. See
ArcGIS Editor for OSM Feature Service for how to use the newly installed Feature Service interface. If you have installed the Server component and your Operating System is Windows XP or Windows Server 2003, you will need to carry out some
- Important: After the installation completes, check that the datastore was correctly created. For steps to check the datastore, see
"About registering your data with the server". If you saw an error that looked like the following during installation, then you'll need to verify the registration. Steps are also provided below.
To remedy this, you'll need to register your datastore with the ArcGIS Server instance after the installer completes. If you proceed with creating feature services with the
Create Feature Service interface
, your services will not be created successfully and contain errors.
First, open ArcCatalog and create an Administration connection to the ArcGIS Server instance where you installed the ArcGIS Editor for OSM Server Component. After creating the Administrative connection, right click on the connection and select "Server
Properties", as shown below:
When the Server Properties dialog opens, select the 'Data Store' tab. On the Data Store tab, if there is an existing connection showing in the 'Registered Databases' window, remove it. Now, assuming there is no connection is showing in the Registered
Database window, click the large Plus button to the right. You will have the option to add or import a connection file. Select 'Import', and browse to the connection file at the location where the ArcGIS Editor for OSM Server Component stores its mxd
information, e.g., C:\Data\OSM\MXDS by default. Select the file with the ".sde" suffix, as shown below.
After adding this connection, there should be a green checkmark next to the connection in the Registered Databases window. You can close the dialog, and proceed with using the installed ArcGIS Editor for OSM Server Component (no need to reinstall or restart
Working with the Code
Configuration for Visual Studio 2010
Compiling the Code
When you connect, you will see there are four solutions: ‘OSMEditor32.sln’, ‘OSMEditor64.sln’, ‘OSMEditorServer10_0.sln’, and ‘OSMEditorServer10_1.sln'. These can be compiled for the following versions of the software:
Compiling for ArcGIS 10.1 Environments
- OSMEditor32.sln - compile for the Desktop Component both for ArcGIS 10.0 and ArcGIS 10.1
- OSMEditor64.sln – compile for the 64bit classes used for the 10.1 Server component without having to deal with the web application side of it
- OSMEditorServer10_0.sln - compile for the Server Component at 10.0
- OSMEditorServer10_1.sln - compile for the Server Component at 10.1
To compile for ArcGIS 10.1 environments, you can just run the compiler without additional inputs, either from Visual Studio or from the Command Line.
Compiling for ArcGIS 10.0 Environments
To compile for ArcGIS 10.0 environments, you will need to enter in specific inputs. Below, we describe compiling through the Visual Studio UI, and compiling from a command line
- Compiling from the Visual Studio UI (ArcGIS 10.0 environments) - Enter “ARCGIS_10_0” in the Conditional compilation symbols text box in the Build window for the GeoProcessing project properties, as shown below.
Important: Do not check the project file into source control with this symbol set.
- Compiling from the Command Line (ArcGIS 10.0 environments)
When running MSBuild.exe to compile the solution, add the following parameter to the command line.