Appendix 1: Important Considerations for Updating Cityworks

This appendix contains additional steps you may need to consider when updating from a version of Cityworks that is in its maintenance phase. See the Cityworks Product Support Policy on MyCityworks/Trimble Unity for more information.

  • The AllFields document has been updated with new codes, so you will need to update your print templates to use the new codes when upgrading to 15.5 or newer.
  • A new numeric ID field (WORKORDERSID) was added to the WORKORDER table in the database at 15.5. This new WORKORDERSID is used to link activities in the ACTIVITYLINK table, as well as work order comments. Please see WORKORDERSID Field Schema Change in 15.5.X and How it Affects the WORKORDERCOMMENT Field on MyCityworks/Trimble Unity for more information.
  • Work activity links have been updated and users must run the Activity Link migration in the Data Migration Tool when upgrading to 15.4 or newer. Work activity links are used to associate related work activities (service requests, work orders, inspections, and PLL cases). See Activity Links Migration for more information.
  • If you are using webhooks, you must run a webhook migration when upgrading to 15.4 or newer. See Webhook Migration for more information.
  • This version requires Microsoft .NET Framework 4.7.2. This requirement applies to both the Cityworks application server and the GIS server.
  • See the Cityworks 15.8 System Specifications.
  • If you have work order saved searches that use Current User for the Task Assigned To field, you will need to run the saved search migration when upgrading to 15.3 or newer. See Validation in the Designer for 15.8 Guide for more information.
  • If you are using PLL, all PLL users must be added to a default organization prior to upgrading to 15.3 or newer.
  • If you are using PLL for business licensing, you need to run a script when updating from 2015 or older. Contact Customer Support to obtain the script.
  • The Crystal Reports standard Cityworks reports for SQL Server and Oracle are no longer included with the Cityworks installer. If you utilize the standard reports without customization and are upgrading to 15.2.4 or newer, you will want to replace the existing reports with the ones that can be downloaded here: Standard Reports. If you are installing a new site and want to use these reports, you will 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.
  • In 15.2, the CaseId search result field was replaced with ChildCaseId and ParentCaseId search result fields for PLL searches. If you have existing PLL saved searches that use CaseId, you will need to update them using the Validation tool in Designer. See Validation in the Designer for 15.8 Guide for more information.
  • The Cityworks 15.1 and 15.1.2 releases included updates to the comments migration in the Data Migration Tool. If you are upgrading from a version prior to 15.1.2, you must run the Data Migration tool to migrate existing comments. See Comment Migration for more information.
  • The Cityworks 15.1 release included changes to employee names and IDs. If you are upgrading from a version prior to 15.1, you must run the Data Migration tool to migrate employee records to the new format. For more information, see EmployeeSid Migration.
  • Saved searches have been updated and users must migrate their existing saved searches to the new format. If you have not previously completed this migration, you will need to do it when updating to this release. For more information, including versions that this applies to, see Knowledge Base article 12702: Migrate Saved Searches to Cityworks 2014 SP6 or 2015—Platform 4.0 SP1 and Newer.
  • The azteca user is the recommended user for making all connections to the Cityworks database. It is recommended that you change the connection string credentials to the azteca user before upgrading to this version. See the install or update guide above for more information.
  • The Cityworks 2015—Platform 4.0 release introduced a significant change to GIS services. If you are upgrading from a version prior to 2015, you will need to migrate your existing GIS services to the new model. This is done by opening Designer and navigating to GIS > Services, where you will be prompted to perform the migration. If you do not do the migration, your maps will not work. See Migrate GIS Services in the Designer for 15.8 Guide for more information on the migration.
  • The Cityworks 2015—Platform 4.0 release introduced enhancements to make tokens for API calls more secure. Business partners and third-party integrators must ensure that all parts of the API calls are encoded prior to upgrading to Cityworks 2015—Platform 4.0 and beyond.
  • As of Server PLL 2014 SP2, there is an updated method for generating system IDs for Server PLL tables. The system IDs (CA_OBJECT_ID, CA_TASK_ID, etc.) are now stored and drawn from the PWSYSID table in the database, similar to AMS. Customizations not utilizing the PLL API may be impacted by this change. Account for this prior to upgrading to 2014 SP3 and beyond. This only affects organizations with external customizations or integrations.
  • If you are upgrading from a version prior to 2014, see Knowledge Base article 11674: Upgrade Existing Cityworks Databases to 2014 for more information on the new DB Manager.

IMPORTANT: It is essential that the Cityworks software and database version releases match. Before upgrading your software to a new version, take some time to review the Cityworks 15.8 System Specifications to make sure your system is compliant.