Install a Plugin

A plugin must be installed before it can be used.

IMPORTANT: If you are installing Admin for the first time, it must be installed in Plugin Manager on the landing page. After that, the Admin plugin may be updated in the Admin app.

You can install a plugin using the Plugin Manager on the landing page after you have logged in to your Cityworks site.

  1. Log into your Cityworks site. See Log In for more information.
  2. Click Plugin Manager.

Any plugins you are assigned to will appear in the Plugins section.

  1. Extract the .cwplugin file from the zipped folder and scroll to the bottom of the page to Install Plugin.
  1. Drag the file and drop it where it says Drag & drop a file here or click the box to browse to the file.

IMPORTANT: All plugin files must be extracted from the zipped folders before they can be added. Extract the file by right-clicking the zipped file and selecting Extract All.

To grant an employee access to the app, they must be assigned a license. See Licensing for more information.

Once a plugin has been added, you can add the plugin to an employee's landing page. See Associate Employees to a Plugin for more information.

You can install a plugin using the Admin app.

PREREQUISITES:

  • This requires Cityworks 23.3 or newer.

TIP: See Add a Plugin for a quick start guide or see Install a Plugin for a help video on this subject.

  1. Open MyCityworks and log in.
  2. Download the desired plugin and navigate to Admin.
  3. From the home page, click Admin and click Plugins.

The Plugins panel lists all existing plugins.

  1. Extract the .cwplugin file from the zipped folder and either click the box at the bottom of the panel to browse to the file or drag a file and drop it where it says Drag a plugin file here (or click) to upload.

IMPORTANT: All plugin files must be extracted from the zipped folders before they can be added. Extract the file by right-clicking the zipped file and selecting Extract All.

  1. Click an existing plugin to view more details.

To grant an employee access to the app, they must be assigned a license. See Licensing for more information.

Once a plugin has been added, you can add the plugin to an employee's landing page. See Associate Employees to a Plugin for more information.

TIP:  For more information on plugins, or to view a tutorial on how to create a plugin, see Cityworks Plugin System Tutorial in the Web Services 23 Guide.