Installer Location: O:\Installations\Cityworks (Note the O drive is mapped to \\GISFS1\GIS_SHARE)
1. Install or enable Microsoft .NET 4.7.1 Framework at a minimum.
2. Install IIS 8.x from Windows Server 2012/R2 or IIS 7.5 from Windows Server 2008 R2. There
are certain universal web application components that Esri requires which are not enabled via
a typical installation. For more information, see Esri IIS Requirements for Windows Server
2008 R2, Esri IIS Requirements for Windows Server 2012, or Esri IIS Requirements for
Windows Server 2016.
In addition to the Esri IIS requirements, the .NET extensibility 4.5 and ASP .NET 4.0 (or only
ASP .NET 4.5 if using Windows Server 2012/R2) need to be added for Cityworks.
NOTE: These are the same IIS requirements that Cityworks needs if running in a distributed
environment where there is a separate application server and GIS server and perhaps a separate
3. Install the GIS services component, and if desired the Web Adaptor component of
ArcGIS 10.3, 10.3.1, 10.4, 10.4.1, 10.5, 10.5.1, or 10.6.
Starting in ArcGIS Server 10.1, Esri created applications called Web Adaptors that link the current
server of choice (IIS) to the GIS server instance. These applications are small broker components
that basically forward requests from your web server to the internal server used with ArcGIS. Esri
has created a series of basic videos to assist users in getting started with the paradigm shift:
l ArcGIS Enterprise: An Introduction
l Creating an ArcGIS Server site
l Adding a machine to an ArcGIS Server site
l Installing the ArcGIS Web Adaptor
l Installing Portal for ArcGIS
l Configuring ArcGIS Web Adaptor with Portal for ArcGIS
Note that the Esri app pools, like ArcGISWebAdaptorAppPool, still run in .NET 2.0.
Also, Cityworks is not concerned with the version of the ArcSDE software that the SDE database
utilizes as long as a direct connection can be made for the SDE connection file. Please see Esri's
ArcSDE compatibility matrices:
Section 1: Prerequisites 3
l Client and geodatabase compatibility
l SQL Server
The Web ADF Runtime is not required since the SOE service has replaced the Geodata service and
its corresponding logic. However, if you still want access to the custom symbology used for event
layers, then the Web ADF Runtime 10.1 piece needs to be installed.
NOTE: In ArcGIS Server 10.2.x, the Web ADF Runtime installation ceases to exist, though
you can copy the file structure for custom symbology from a machine running 10.1 and paste or
permission it. Or you can install only the Web ADF Runtime 10.1 piece (it can run on the same
machine as the 10.2.x software).
4. Make sure the ArcGIS .NET Extension Support feature is installed. See the instructions here.
5. Save a map or maps in ArcMap 10.3, 10.3.1, 10.4, 10.4.1, 10.5, 10.5.1, or 10.6 to update the
All map services used with Cityworks (base, raster, main, and public) may also be cached to
potentially increase performance. Azteca Systems does not recommend a tiled main map service
because it contains the operational layers, which change frequently. This means the cache has to
be rebuilt to show any changes, leading to some reasonably significant overhead.
6. Publish 10.3, 10.3.1, 10.4, 10.4.1, 10.5, 10.5.1, or 10.6 map, geocode, geometry, and, if
desired, SOE services.
The SOE service is enabled via a map service, similar to a feature service in that way. This is done
after the .soe file has been registered in ArcGIS Manager. The SOE service is used when an asset
is not present in the map and/or related objects are involved to gain access to the GIS data. The
SOE data is encrypted to provide enhanced security, as the SOE service essentially creates a
workspace to gain access to the entire geodatabase, interpolated from the first feature class that is
encountered in the map service it’s enabled with. For more information, see Knowledge Base article
10633: Install and Configure the SOE Service and Knowledge Base article 10651: Classfactory
In order to edit with the updated Esri editing tools, the Feature Access option must be enabled in the
map service and the GIS data must be stored in an ArcSDE geodatabase per Esri (see What is a
NOTE: This access only needs to be enabled for those map services you wish to modify. If
the map service contains data you do not want to modify, do not enable this option.
Further, ensure that the SDE connection in any underlying map that a map service with feature
access enabled draws from utilizes the credentials of a user that has at least Edit privileges. This
does not necessarily have to be the schema that owns the data. The user can either directly be
given Edit privileges or gain such through group membership. If not, any geometric and/or attribute
changes made via the Esri editing tools cannot be saved. This follows the Esri security model.
Cityworks 15.2.6 continues to only enable editing tools for those users in a Cityworks domain group
with Geometry editing rights, as the Attribute editing rights still allow editing only through the
Editor forms that connect via the SOE or REST services. Activity (Server Only) editing rights
4 Section 1: Prerequisites
allow users to solely edit GIS attributes within a work activity, such as an inspection, and not in the
7. Install Mozilla Firefox.
IMPORTANT: Please make sure your Firefox browser cookies are enabled in order for
Cityworks to accept your login credentials. The History setting under Tools > Options > Privacy
cannot be set to Never remember history in Firefox. In Internet Explorer, do not enable the
InPrivate Browsing option under the Tools drop-down menu. Also, ensure that an exception for
your site is made in the Pop-up Blocker to avoid suppressing certain forms.
8. Install Crystal Reports Runtime 13.0.19. Versions 13.0.16–13.0.20 are supported.
l Select either the 32-bit .msi or 64-bit .msi. The 64-bit .msi, which can be used when
running Cityworks with ArcGIS 10.3, is an available option. However, please understand
that when using the 64-bit .msi, you need to set the Enable 32-bit Applications
CityworksAppPool setting to false. The 32-bit .msi can be installed, as opposed to the
64-bit .msi, and does not require any configuration other than installation.
l Note that the Crystal Reports Runtime 13 SPXX installer will copy the
crystalreportviewers13 folder to ...\inetpub\wwwroot\aspnet_client\system_
web\2_0_50727 and ...\inetpub\wwwroot\aspnet_client\system_web\4_0_30319.
9. Install SQL Native Client or the Oracle Client software (see IT administrator) on your machine
if your database resides on another server.
The 32-bit Oracle Administrator is required because the InstantClient and/or Runtime installations
are not sufficient. Please make sure to install with the Run as administrator option (right-click the
l Oracle 10g R2 Client download
l Oracle 11g R1 Client download
l Oracle 11g R2 Client download
l Oracle 12c R1 Client download
NOTE: If you are using Oracle, we recommend that you utilize the AL32UTF8 character set,
which is the default at Oracle 12c. Please see Oracle's related documentation: About Character
Set Selection During Installation.
Section 1: Prerequisites 5
l 2005 SQL Native Client download
o Click the download button next to the sqlncli_x64.msi entry towards the top of the
page to grab the 64-bit version for Windows Server 2008, Windows 7, and Windows
l 2008 SQL Native Client download
o Click the X64 Package link under the Microsoft SQL Server 2008 Native Client to
grab the 64-bit version for Windows Server 2008 R2.
l 2012 SQL Native Client download
o Click the X64 Package link under the Microsoft SQL Server 2012 Native Client under
the Install Instructions to grab the 64-bit version for Windows Server 2008 R2 and
Windows Server 2012.
NOTE: SQL Server 2014 and 2016 install SQL Server 2012 Native Client. There is no
SQL Server 2014 or 2016 Native Client (source).
10. Azteca Systems recommends, but does not require, that you enable HTTPS protocol for your
Cityworks and ArcGIS Server sites, as it is more secure than HTTP. For more information,
see the Externalize Cityworks Server white paper on MyCityworks. As well, please be aware
that Portal for ArcGIS requires the use of HTTPS and it's also part of the default format for
ArcGIS Online. Though not necessarily required, securing GIS services with tokens or via
another Esri-approved method is generally recognized as a best practice. Please consult the
appropriate corresponding Esri documentation regarding supported security methods to
evaluate what is best for your organization.
Deployment Type (KACE/Manual): no deployment necessary, recommend users download Mozilla's Firefox browser
Services: Runs through SQL Server service for database and IIS for application
Configurations: The Cityworks database is installed on the server called GISMASTER as cityworks_prod. The application is installed on the server named Cityworksweb. The GIS services that Cityworks uses are configured from the server GISAGS.
Notes: Cityworks version upgrades that go from 14.2.1 to 15.2.6 are a much bigger deal and involve a more detailed install than updates that simply go from 15.1.2 to 15.1.3. This is documented here: O:\_CODE_RED_SYSTEM_KILLERS\Cityworks\READ ME Post_Install
Installer Location: Simply download the Mozilla Firefox browser from any web browser
Prerequisites: Install Mozilla's Firefox browser
Deployment Type (KACE/Manual): Manual