Prerequisites

You can use your existing license key to install this new site. If you do not already have a license key, please contact Customer Support or your implementation manager for assistance. Please have the license key before you proceed.

  1. Install or enable Microsoft .NET Framework 4.8 for the application server.
  2. Install IIS 10.x for Windows Server 2016, 2019, or 2022. There are certain universal web application components that Esri requires, which are not enabled via a typical installation. For more information, see Manually enable IIS and required components in the Esri documentation.

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 or 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 database server.

  1. Install the GIS services component, and if desired the Web Adaptor component of ArcGIS for the version of ArcGIS that you are using. See the ArcGIS compatibility matrix for the list of Esri ArcGIS versions that this version is compatible with.

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. See ArcGIS Enterprise: An Introduction for more information.

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:

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).

  1. Make sure the ArcGIS .NET Extension Support feature is installed. See the instructions here.
  2. Save a map or maps in ArcMap to update the map(s). See the ArcGIS compatibility matrix for the list of Esri ArcGIS versions that this version is compatible with.

NOTE: The ClientAccessPolicy and CrossDomain XML files are no longer required since the Silverlight map viewer has been discontinued.

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.

  1. Publish map, geocode, geometry, and, if desired, SOE services. See the ArcGIS compatibility matrix for the list of Esri ArcGIS versions that this version is compatible with.

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 Error Message.

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 feature service?).

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.

Editing tools are enabled for users who belong to a domain group with Geometry editing rights. Attribute editing rights still allow editing only through the editor forms that connect via the SOE or REST services.

  1. 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.

  1. Install Crystal Reports Runtime. Versions 13.0.26 and newer are supported. Click here to download Crystal Reports. If the version of Crystal Reports you need is not found on that page, see Crystal Reports: Downloading SAP Crystal Reports Runtime 2013 Software Service Patches.
  • Select either the 32-bit .msi or 64-bit .msi. If you use the 64-bit .msi, you need to set the Enable 32-bit Applications CityworksAppPool setting to false. The 32-bit .msi does not require any configuration other than installation.
  • Note that the Crystal Reports Runtime 13 SPXX installer copies the crystalreportviewers13 folder to ...\inetpub\wwwroot\aspnet_client\system_web\2_0_50727 and ...\inetpub\wwwroot\aspnet_client\system_web\4_0_30319.
  • Note that the Cityworks installer checks the version of Crystal Reports Runtime and modifies the web.config file accordingly. This check occurs when installing or updating a site. If you have a previous version of Crystal Reports Runtime and you update to SP21 or newer, you need to update your Cityworks site in order for it to work. This update can be to the same version of Cityworks (e.g., 15.3 to 15.3).
  • Note that the Crystal Reports standard Cityworks reports for SQL Server and Oracle are no longer included with the Cityworks installer. If you are installing a new site and want to use these reports, you need to place them under ...\inetpub\wwwroot\site_name\WebSite\Reports\Crystal. For customized standard reports, be sure to update them using a full version of Crystal Reports to reference the updated database structure.

NOTE: For information on TLS 1.0, see Crystal Reports Requires OLE Database Connection for Server AMS/PLL.

  1. Install SQL Native Client software (see your IT administrator) on your machine if your database resides on another server and if you are running SQL 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).

BEST PRACTICE: 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. Public Access 3.0 and newer require HTTPS protocol. For more information, see the Externalize Cityworks 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.

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.