SeeClickFix Connect for Cityworks – SeeClickFix

Important Notes

The license for the third-party software's Application Programming Interface (API) utilized for this integration may require additional cost from that vendor. Please confirm your organization's API access and license with your third-party vendor.
Cityworks has released Cityworks 23, which is a significant upgrade. The new version requires a change in authentication. The SeeClickFix solution is prepared for the upgrade and can work with customers to update the integration in sync with the update the organization does with their Cityworks solution. Any organization that is updating its Cityworks system should submit a support ticket so that SeeClickFix can update the integration appropriately.

The Integration can query Cityworks for a list of public SR or WO “Templates”, to be used as request categories on SeeClickFix report forms.
- Request categories are grouped into one or more customer-defined “agencies”, each with a geographical service area. These geographies are configured using polygon shapefiles uploaded to SeeClickFix.
- There is no limit to the number of categories that can be synced with Cityworks.
This query runs on a schedule but can also be triggered on-demand using the SeeClickFix internal system.

For each request category synced with a Cityworks Service Requests (SR) template, the integration will query Cityworks for a list of Questions and Answers.
The Cityworks integration views questions synced from Cityworks as Public on SeeClickFix unless the question text contains “email”, “e-mail”, or “phone”. If any of those words are used in the question, then the question will be marked as Private. If a secondary question should be kept Private within SeeClickFix, then the automatic sync for secondary questions should be disabled. This must be completed by a SeeClickFix Admin.
Questions imported using the automatic sync process are always marked as “required” within SeeClickFix.
This query runs on a schedule, but can also be triggered on-demand using the SeeClickFix internal system.

Prior to creating a Service Request in Cityworks, The Integration can query a customer-provided ArcGIS server for an address, based on the X/Y map coordinates of the request (reverse geocode).

As requests are created on SeeClickFix, the Integration submits them to Cityworks individually (on-the-fly), as a new Service Request or Work Order.
If an issue includes an image, the Integration submits it to Cityworks as a Service Request/Work Order Attachment.

The Integration can periodically query Cityworks for new Service Requests (SR) originating in Cityworks directly. This allows SeeClickFix applications (web portal and mobile apps) to display all Cityworks SRs, not just those originating on SeeClickFix.
The importer feature requires a standard polygon without cutouts to be used for the geography of the agency. For example, a geography with state highways cutout of polygon will cause errors in the importer.

As public comments are added on SeeClickFix, the Integration submits them to Cityworks individually (on the fly), as Service Requests/Work Order comments.
If a comment includes an image, the Integration submits it to Cityworks as an SR/WO Attachment.

The Integration will periodically query Cityworks for comments added to the SR/WO and will import those intended for public consumption.
NB: this “Public” indicator is currently implemented using a comment prefix "To SCF:", pending the addition of a proper checkbox field for this purpose.

The Integration will periodically query Cityworks for changes to the SR/WO, in order to take the following actions:
- The Integration will close the issue if the Cityworks SR/WO has been closed.

SeeClickFix can import images intended for public consumption attached to the SR/WO in Cityworks.
If the attachment includes a comment with the prefix "To SCF:", the content of the comment, along with the image, will be imported to SeeClickFix and posted as a public comment on the request.