Install the Host Application

This section includes the steps necessary to install a new Cityworks site.This install guide should only be used for new databases. If you are installing a 23.x site using an existing database, use the update guide.

PREREQUISITES: Before installing or updating Cityworks, the Microsoft server monitoring package called System Center must be deactivated.

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.

NOTE: The Port field is the port the installer runs on the local computer during the installation process. Once the installation is done, the port is no longer in use. The default is 5000, however a different port can be entered. The port cannot conflict with any other process on the machine that may be using the same port as the installer.

The host installer opens in a web browser.

IMPORTANT: A command line prompt window runs in the background and must finish running before the web app can open. Trying to launch the host installer before the command line finishes causes an error in the browser. Refreshing the browser or closing and reopening the web app should resolve the error.

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 an existing database.

5. Select New Installation and click Next.

6. Select a Website under which the site is installed.
7. Give the site an Alias.

8. Click Next.

9. Select HTTPS or HTTP for the Scheme.
10. Enter the Host Name.
11. Enter the Port if desired.
12. The Path is automatically populated with the Alias.

13. Click Next.

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

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

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

NOTE: If the Alias includes any underscores, the first underscore displays as removed in the Install Directory filepath. This is merely a display issue with the underlying Microsoft label control and does not affect the installation process. The installer runs correctly and the site is named as stated in the Alias and is installed in the correct filepath.

You are asked if you want to proceed.

19. Click Continue.

After a few minutes, a message confirms if it was installed 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 DatabaseManager folders.

20. Click Close.
21. 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. If you are installing Cityworks 23.x for the first time, a key file needs to be generated.

22. Click Create New Key File.

23. On the Create Encryption Key File panel, enter the password in the Password and Confirm Password fields. The password must be at least eight characters long.

TIP: If you are creating a new key file, you can enter whatever password you want as long as it's eight characters or longer.

24. Click Save Key.

IMPORTANT: Once the key file is created, copy the key file and back it up in a secure location. If a server is destroyed and only one copy of the key file exists on that server, the encrypted data is lost. The password must also be retained. If the password is lost, the encrypted data cannot be accessed.

25. Download the newly created key by clicking Download Key.

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

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

29. Select either SQL Server or Oracle for the Cityworks database.

The Connection String ID is automatically populated.

30. Enter the Server instance that the database resides on.
31. Enter the Database name.
32. Enter the user you want Cityworks to utilize in the User field.

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.

NOTE: If desired, the CWDB_USER, or your own user mapped to the CWDB_USER_ROLE, can be used instead of the azteca user. The CWDB_USER runs the application and all the plugins, but has less permissions than the azteca user. After entering the user and password here, map the CWDB_USER_ROLE to the user and enter azteca as the Default Schema.

33. Enter the Password.

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

36. Select the connection string and click Activate.

Starting in 23.2 and newer, Database Schema Manager replaces Database Manager.

37. 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 database was successfully updated. If not, the log shows where any issues were encountered.

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

39. Click Close.
40. Click Return to return to the Cityworks Host Configuration page to continue setting up the site.

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

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

43. Enter an Email, First Name, Last Name, and Password.
44. Click Save.

45. Click Return.

Update tasks can be run from the host installer. Any that need to be run appear in the Tasks section.

46. Click the edit icon next to Update Tasks.
47. Click Run Next Task.

A confirmation message appears.

48. Click Close.

49. Click Run Next Task until all of the tasks have been run.

50. Click Return.

The host is now configured. Next the core app needs to be configured. See Configure the Core Application for more information.