Skip to main content

Configuring the Community Map of Canada in Cityworks

Enhance your Cityworks experience by adding the Community Map of Canada as a basemap. In this blog post, we’ll guide you through the straightforward steps to create and configure a web map using Portal for ArcGIS. This integration ensures your Cityworks basemaps feature accurate, authoritative data while remaining visually engaging. Let’s get mapping!

Did you know that you can easily access the Community Map of Canada basemaps within Cityworks? By utilizing a web map created in either ArcGIS Enterprise or ArcGIS Online, you can seamlessly bring these basemaps into your Cityworks platform. This blog post will guide you through the process, ensuring that your basemaps are both accurate and authoritative. We'll break down the steps into two main sections: adding the Community Map of Canada Vector Basemaps to a web map and then integrating the web map in Cityworks.

Section 1: Add the Community Map of Canada Vector Basemaps to a web map

This section follows this blog post, which outlines the steps to add the Community Map of Canada Vector Basemaps to a new basemap in Map Viewer.

  1. Sign into Portal for ArcGIS and ensure that you have privileges to share content with your organization

  2. Click the “Content” tab and then “+New Item”

  3. Select URL and enter the REST URL for the basemap of your choice. Pasting the URL should automatically indicate the type as an ArcGIS Server web service. The list of URLs can be found in this blog post.Add a new item to your portal by pasting the REST URL for a specific Canadian vector basemap into the URL field when creating a new item in Portal for ArcGIS.

  4. Enter the title, tags and description for the tile layerPrompts to create a Title, select a folder, enter tags and write a summary for the new item in Portal for ArcGIS.

  5. Repeat steps 2–4 for each of the REST URLs in the basemap style of your choiceEach of the four tile layers created for the Canada Topographic Basemap shown in “My content”.

  6. We can now update the Vector Basemap Styles. Go to the Community Map of Canada JSON Files page to access the JSON files that will be used to update the layers that create the Community Map of Canada.

    1. Click the Content tab

    2. Find the items listed as “Code sample”

    3. There will likely be two files needed—the main style file and a complementary one with the word “Background” in the name. Both files will be necessary to download. For each file needed, click the three dots on the item and choose Download.Community Map of Canada JSON Files page showing the Canada Topographic and Canada Topographic Background code samples.

  7. Unzip the downloaded files

  8. For each tile layer created in Portal, open the Item Details page and click “Edit in Vector Tile Style Editor”

  9. Click “Save” on the left black bar of the Vector Tile Style Editor to reset the backend URL to your organization instead of the ArcGIS Online URL"Style saved successfully” notification in the ArcGIS Vector Tile Style Editor.

  10. Return to the Item Details page and click “Update” to update the style file. Choose the related JSON file you previously downloaded.Selecting the downloaded JSON file from File Explorer when updating the tile layer.

  11. Repeat steps 8–10 for all the Community Map Vector Basemap tile layers. Note that the Canada Hillshade and World Hillshade layers do not require updated styles.

  12. Navigate to Map Viewer in Portal for ArcGIS and select “Basemap” on the left dark toolbar. Rename the current basemap and add the vector tile layers you created earlier.The newly created tile layers for the Canada Topographic Basemap displayed in “My Content” to be added into the basemap in Map Viewer.

  13. Reorder the layers to reflect the same order as outlined in the blog post and remove the reference layer and any other non-related base layersThe four tile layers for the Canada Topographic Basemap are shown in order from top to bottom: Canada Topographic, Canada Hillshade, World Topographic Canadian Style and World Hillshade.

  14. Save the web map

Section 2: Integrate the web map into Cityworks

In this section, you will take the web map you created in Portal for ArcGIS and add it to Cityworks.

  1. Log into Cityworks

  2. Click the Designer tab, then select “Services” from the GIS options

  3. Click “Add” from the Service Resources tab to open the New GIS Service Resource dialogue

    1. Name the item

    2. Select “Web Map” from the Service Type drop-down menu

    3. Enter the web map IDPopup to configure a new GIS service resource in Cityworks, including the name of the service and the web map ID, with “Web Map” selected as the service type.

  4. Once added, select “Web Map” on the Service Resources tab and add the correct sharing URL: https://<hostname>/<portal>/sharing/content/itemsPopup to configure the resource details for the web map service added in Cityworks.
  5. Next, in the Service Definitions tab, the Cityworks administrator can choose to create a new service definition or update an existing one. Steps for creating a new service definition (which services are to be used in Cityworks for a specific group of users) are below.

    1. Click Add

    2. Enter a name for the new service definitionNew service definition name popup showing “Community Map of Canada Service Definition” as the typed name.

  6. Select the newly created service definition

    1. Click “Add” in Map Services and select the web map created for this workflow

    2. Under Geocode Services, click “Add” and select the geocode service used in the Cityworks environment

    3. Under Geometry Services, click “Add” and select the geometry service used in the Cityworks environment

    4. Under Employees, click “Add” and select which Cityworks users will see the Community Map of Canada basemaps. Add the Cityworks administrator to the Employees panel for testing. Note that you could also use the Domains or Groups panel.Service Definitions tab in Cityworks showing the configurations for Map, Geocode and Geometry Services as well as which employees will be able to view the added basemap.

  7. Cityworks users added in the Employees section from the previous step should now be able to view the Community Map of Canada basemaps in their Cityworks map.

  8. If required, each Cityworks user can set their own initial extent for the Cityworks Map.  Otherwise, the Cityworks map will use the extent specified on the service and/or web map itself.

    1. Zoom to the desired extent

    2. In the map, open the Bookmarks tool in the top menu bar.  If it is not there, click the Tools drop-down and check the box next to “Bookmarks”.  Once enabled, you can select it from the top menu bar.

    3. On the Bookmarks tool panel, click “Set initial extent”

    4. The map will automatically zoom to this extent each time this user launches the map moving forward.The result that shows the Canada Topographic Basemap in Cityworks.

By following these simple steps, your selected Community Map of Canada basemaps can be seamlessly integrated into Cityworks. Cityworks users will be able to benefit from highly accurate basemap sources from authoritative Canadian contributors. With these basemaps now in place, your organization can enjoy the benefits of precise, high-quality geographic data at your fingertips.

Note: This workflow is replicable with other basemap styles. A great resource to browse is the Community Map of Canada Custom Basemap Gallery, which includes fun and practical basemap styles to enhance your Cityworks operations. You can also create your custom basemaps using the Vector Tile Style Editor.

About the Author

Valerie Caden-Baptiste is an Associate GIS Analyst at Esri Canada, supporting the Community Map of Canada team. Valerie is passionate about leveraging the potential of GIS to understand the world and solve problems effectively, with a particular interest in using GIS to strengthen communities. She holds a Bachelor of Applied Technology in GIS from the Southern Alberta Institute of Technology and a BA in Policy Studies from Mount Royal University. Outside of her professional pursuits, Valerie enjoys camping, exploring new places and continuously learning new things.

Profile Photo of Valerie Caden-Baptiste