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. Security updates have been implemented at 23, therefore Forms Authentication users must reset their password when they log in to Cityworks 23.x for the first time. In your 15.8.x site, users must have a valid email defined on the Employees page in order to reset their password and email settings must be set up correctly in Preferences. See Reset Password in the Cityworks 23.4 Update Guide for more information.

NOTE: If running Single Sign-On, the password change is not applicable. However, be aware of any Forms API users, as their Cityworks username and password are used for authentication. An admin user can log into Admin or use the host admin to update those passwords.

  1. Install the ASP.NET 7 core hosting bundle and .NET Desktop Runtime x64.
  2. Install IIS 10.x for Windows Server 2016, 2019, or 2022. The Request Filtering and the uploadReadAheadSize settings need to be set to a number that is bigger than the largest file you need to upload.
  3. Install versions 18, 19, 20, 21, or 22 of SQL Server Management Studio on the Cityworks application server to get the latest SQL Server drivers.
  1. Create or save a map or maps in an ArcGIS Pro project to update the map(s). Ensure ArcGIS Online and/or ArcGIS Enterprise 10.9.1 or 11.x is being utilized. Support for ArcGIS Enterprise 11.4 was added in Cityworks 23.11, while Cityworks 23.12 and forward are compatible up to ArcGIS Enterprise 11.5 currently. See the ArcGIS compatibility matrix for the list of Esri ArcGIS versions that this version is compatible with. ArcGIS Enterprise 11 and above requires publication of GIS services exclusively from ArcGIS Pro to take advantage of newer functionality.

All map services used with Cityworks may also be cached to potentially increase performance. Cityworks does not recommend a tiled main map service if it contains the operational layers, because they change frequently. This means the cache has to be rebuilt to show any changes, leading to some reasonably significant overhead.

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

In order to edit with the updated Esri editing tools, the Feature Access option must be enabled in the map service (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 data connection in any underlying map that a map service with feature access enabled draws from utilizes the credentials of a user type 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 network and/or attribute changes made via the Esri editing tools cannot be saved. This follows the Esri security model.

The Esri editing tools in the Cityworks map viewer are enabled for users who belong to a domain group with Geometry editing rights.

  1. Install a supported browser. See the Cityworks 23.x System Specifications on MyCityworks for more information. Please make sure your browser cookies are enabled in order for Cityworks to accept your login credentials.
  2. Cityworks 23 does not support an impersonate user. If you have used an impersonate user to access attachments in a Network-Attached Storage (NAS), Storage Area Network (SAN), or file server, you need to configure another means of network access to the Cityworks application. See How to Access Network Attachments Without ASP.NET Impersonation on MyCityworks for more information.
  3. A CWHOST User and CWDB_USER must be created manually for Oracle clients.
  4. Carefully review the Upgrading from 15.8.x or Earlier to Newer 23.x for important step-by-step instructions on how to upgrade to 23.x.

BEST PRACTICE: Cityworks recommends, but does not require, that you enable HTTPS protocol for your Cityworks and ArcGIS Enterprise sites, as it is more secure than HTTP and matches industry standards. Public Access for production use requires HTTPS protocol. For more information, see the Externalize Cityworks white paper on MyCityworks. Per security best practices, Esri recommends that you enforce HTTPS communication for both Portal for ArcGIS and the web server hosting ArcGIS Web Adaptor. Though not necessarily required, securing GIS services with tokens or via another Esri-approved method (for example, SAML) 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.

Other Considerations

  • Application Pool Naming: The Platform (Plugins) site runs under its own application pool using the naming convention Cityworks_<site_name>_AppPool.
  • Integrations: Ensure that all integrations are migrated to be API-driven, making them sustainable in a hosted environment and not reliant on updating backend database logic to match changes in the core app and plugins. When leveraging Cityworks (via Boomi or otherwise), ensure you utilize the latest authentication header formatting and stay informed about any new or updated methods. Please note that accessing the API documentation requires logging into the Platform (Plugins) site and then using a URL similar to https://<server_alias>/<site_alias>/apidocs in Cityworks 23.x. See the Web Service 23 Guide for more information.