Update Cityworks

Existing Cityworks 23.x sites can be updated using the installer, using the New Installation option. Even though it is called New Installation, during the process on an existing site, the 23.x site is overwritten with the newer version.

IMPORTANT: Back up your site files in case the upgrade process fails, or other unforeseen errors occur.

PREREQUISITES: Before installing or updating Cityworks, the Microsoft server monitoring package called System Center must be deactivated. If you are upgrading from 15.8.1 or older to 23.x, the latest 15.8.x Database Manager and Data Migration Tool must be run before a 23.x site is implemented to ensure your database is up-to-date and all data has been migrated correctly. See the Data Migration Tool 15.8 Guide for more information. If you are upgrading from 23.x to 23.2, the latest Database Manager must be run before a 23.2 site is implemented to ensure your database is up-to-date. See Run Database Manager for more information. Review Reset Password before starting the install process. 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.

1. Navigate to where the Cityworks installer is located.
2. Right-click the installer and select Run as Administrator to launch the installer.

The installer automatically checks to make sure all the prerequisites are installed. If an application is missing, the installer displays a message instructing you to install the needed prerequisites.

If all prerequisites are properly installed, two green check marks appear.

3. Click Next.

4. Click Launch Host Installer.

The host installer opens in a web browser.

The installer includes the following functions:

• New Installation: This option is used when first creating a Cityworks site or to update an existing database.
• Configure An Existing Installation: This option is used to edit any settings previously configured for the host application or core app.

4. Select New Installation and click Next.

5. Select a Website under which the site is installed.
6. Enter the Alias of the existing site.

7. Click Next.

A message appears to let you know an IIS application already exists for the website and alias.

8. Click Yes to overwrite the existing website and alias.

9. Select HTTPS or HTTP for the Scheme.
10. Enter the Host Name.
11. Enter the Port if desired.

The Path is automatically populated with the Alias.

12. Click Next.

13. The Application Path is automatically populated, but can be changed by clicking Browse.

14. Select Install Into IIS Alias Folder if desired.
15. Select Use Default Data Path or clear the check box and browse to a new location.
16. Click Next.

A message appears explaining that the data folder is overwritten during the update process.

17. Click Yes.

A message appears explaining that the application folders are overwritten during the update process.

18. Click Yes.

19. Verify that the site information is correct in the Review section and click Next.

You are asked if you want to proceed.

20. Click Continue.

After a few minutes, a message confirms if it was updated successfully or not.

NOTE: At this point, the site folders have been created under the alias and site location specified in the installer. These include the WebSite, cw-site, cw-site-data, DataMigrationManager, PluginManagerCli, and DatabaseSchemaManager folders.

IMPORTANT: The docx folder must be manually created or moved to the wwwroot folder when upgrading to 23.x.

21. Click Close.

Starting in 23.2 and newer, a host application must be configured first.

22. On the Cityworks Host Configuration page, click the edit icon next to Encryption Key to configure the key file.

Key files encrypt data to provide greater security.

23. Click Import Key File.

24. On the Import Encryption Key File panel, enter the Password.
25. Click the Drop here field on the panel to browse to the file or drag and drop the file to upload it.

26. Click Save Key.

27. Click Return to return to the Cityworks Host Configuration page to continue setting up the site.

28. Click the edit icon next to Database.
29. Click the add icon to add a connection string.

For existing Cityworks databases, this is where you enter your existing database.

30. Select either SQL Server or Oracle for the Cityworks database.
31. Enter the Server instance that the database resides on.
32. Enter the existing Database name.
33. Enter the User.

IMPORTANT: If you are an Oracle user, a CWHOST user must be manually added and assigned permissions. This user should be used for the host User and Password fields. See Upgrade to Cityworks 23.2 and Newer in Oracle for more information.

34. Enter the Password.

35. Click Test to see if the connection string is valid.
36. Click Add.

Here is an example of an Oracle Connection String:

37. Select the connection string and click Activate.

A message appears saying it was activated successfully.

38. Next, click DB Schema Manager and click Update Database on the Database Schema Manager panel.

This creates and updates the host database.

IMPORTANT:  The red Database is not up-to-date message might not appear under certain circumstances. Even if it does not appear, you still need to complete the steps to update the database.

Once it's successfully completed, users receive a message indicating that the host database was successfully updated. If not, the log shows where any issues were encountered.

39. Click Verify Database to identify any additional schema changes that need to be made. If there are any errors in the log after verifying the database, you can fix them by running the SQL scripts provided at the bottom of the log.
40. Click Close.
41. Click Return.

A Host Admin User needs to be created to manage the host.

42. Click the edit icon next to Host Admin Users.
43. Click the add icon.

44. Enter a Email, First Name, Last Name, and Password.
45. Click Save.

46. Click Return.

The host is now configured. Next the core app can be configured. See Update the Core Application for more information.