Set up OSM Vector Basemaps (existing user)

Follow the workflows below to update OSM Vector Basemaps in WMA for ArcGIS Data Appliance 2024.

Note:

To use OSM Vector Basemaps in the GCS format, complete the steps using the information for GCS.

To use OSM Vector Basemaps: Basic (WMA) included with the World Basic (WB) product option, complete the steps using the information for WB.

For information about what's included with OSM Vector Basemaps, see OSM Vector Basemaps content and What's new.

You'll use the following workflow to update OSM Vector Basemaps:

1. Upload the package to your ArcGIS Enterprise portal
2. Publish the new hosted tile layer (service)

   Note:

   The title of the new hosted tile layer must be different than the title of the existing hosted tile layer (for example, the name of the new layer is OSM_Vector_Basemap_DA2024_v2).

3. Replace the existing hosted tile layer (service) with the new hosted tile layer
4. Update existing tile layers (map styles)
5. Publish new tile layers (map styles)
6. Share tile layers (map styles)

Upload the package to your ArcGIS Enterprise portal

First, you need to copy the entire USB flash drive contents to your local computer if you have not already done so. Review the system requirements to confirm that you can deploy the OSM Vector Basemaps update.

1. Start ArcGIS Pro, sign in to your ArcGIS Enterprise portal, click the Options button , and click Set As Active Portal.

   

   Note:

   You must sign in and connect to your portal before you proceed. You cannot enter your portal username and password when using the Share Package tool later in these instructions. The tool obtains your credentials from ArcGIS Pro.

2. Create a project.
3. Click the Analysis tab, and click Tools in the Geoprocessing group.

   

   The Geoprocessing pane appears.

4. In the Geoprocessing pane, search for Share Package, and select the Share Package (Data Management Tools) tool from the search results.

   

5. On the Share Package dialog box, do the following:
   1. For Input Package, provide the path to the vector tile package, for example, C:\Projects\OSM_Vector_Basemaps_2024\VTPK\OSM_Vector_Basemap_DA2024_Install.vtpk.
   2. For Summary, type OSM Vector Basemap for Data Appliance 2024.
   3. For Tags, type 2024, v2.

   Caution:

   Do not change the Credits parameter value and do not check the Everybody or Within Organization check boxes for sharing.

   

6. Click Run.

   It will take approximately 30 to 120 minutes to upload the package to your portal. A Share Package Uploaded Successfully message appears in the Share Package window once the upload is complete.

7. Through your portal, confirm that the .vtpk file uploaded successfully.
   1. Open a web browser and sign in to your portal.

      The OSM_Vector_Basemap_DA2024_Install tile package is located in the root folder.

   2. Under Details, confirm that the Size value of the tile package matches the size for your vector tile package and Enterprise version in the following table and Shared with indicates that the item is not shared.

   Vector tile package .vtpk file	Enterprise version	Size
   OSM_Vector_Basemap_DA2024_Install.vtpk (WMA)	10.9.1	49,368 MB
   	11.0	51,766 MB
   	11.1 or 11.2	49,367.843 MB
   OSM_Vector_Basemap_GCS_DA2024_Install.vtpk (WGS84)	10.9.1	49,588 MB
   	11.0	51,997 MB
   	11.1 or 11.2	49,588.417 MB
   OSM_Vector_Basemap_DAWB2024_Install.vtpk (WMA)	10.9.1	6,960 MB
   	11.0	7,298 MB
   	11.1 or 11.2	6,959.575 MB

   Your item should look similar to the following when uploading OSM_Vector_Basemap_DA2024_Install.vtpk (WMA) in Enterprise 11.1 or 11.2:

   

Note:

If the size is not correct, delete the item and upload the OSM_Vector_Basemap_DA2024_Install tile package again. You may want to discuss the problem with your portal administrator.

For the OSM_Vector_Basemap_GCS_DA2024_Install tile package, if the size is not correct, delete the item and upload it again.

For the OSM_Vector_Basemap_DAWB2024_Install.vtpk tile package (WMA), if the size is not correct, delete the item and upload it again.

See the Troubleshooting OSM Vector Basemaps topic for more information.

Publish the new hosted tile layer (service)

Now you'll publish the new OSM Vector Basemaps hosted tile layer service from your portal.

1. Sign in to your ArcGIS Enterprise portal.

   Note:

   Your account must have publishing credentials.
2. In My Content, go to the item page for the vector tile package (OSM_Vector_Basemap_DA2024_Install.vtpk) you uploaded to your portal.
3. Click Publish, change the title to OSM_Vector_Basemap_DA2024_v2, and click Publish again.

   

   Note:

   For the GCS tile package, use the OSM_Vector_Basemap_GCS_DA2024_Install.vtpk file. Change the title to OSM_Vector_Basemap_GCS_DA2024_v2 for the hosted tile layer that is published.

   For the WB tile package, use the OSM_Vector_Basemap_DAWB2024_Install.vtpk file. Change the title to OSM_Vector_Basemap_DAWB2024_v2 for the hosted tile layer that is published.

   Note:

   It will take 30 to 120 minutes to create the hosted layer, depending on your system configuration.

   The OSM_Vector_Basemap_DA2024_v2 hosted tile layer is created.

   

Replace the existing hosted tile layer (service) with the new hosted tile layer (service)

Next, you'll replace the 2023 basemap hosted tile layer (service) with the 2024 hosted tile layer (service).

1. Sign in to your ArcGIS Enterprise portal.

   Note:

   Your account must have publishing credentials.
2. In My Content, go to the item page for the OSM_Vector_Basemap_v2 vector tile service.
3. Click Replace Layer.

   

4. Click Select, and select the new hosted tile layer that you just published, for example, OSM_Vector_Basemap_DA2024_v2.

   

5. For Archive the current layer as, click the edit button and change the value to OSM_Vector_Basemap_DA2023_v2 and click Save. Then, scroll to Replace item information and click the toggle button.

   

6. Click Next.
7. On the Replace Layer summary, click Replace.
   

   Note:

   The current layer starts as DA2023. The replacement layer is DA2024. You are archiving the DA2023 hosted tile layer, and the current layer (OSM_Vector_Basemap_v2) now displays the DA2024 hosted tile layer. Replacing the tile set allows the item ID and URL paths to remain intact, so maps and apps continue to work with the current layer and display the new DA2024 basemap content.

   The Success message flashes briefly at the top of the screen.

8. To verify a successful replacement, in My Content, go to the item page for the OSM_Vector_Basemap_v2 vector tile service.

   Your item should look like the following:

   

   Note:

   The thumbnail is not replaced, but the summary is OSM Vector Basemap for Data Appliance 2024 and the Details section indicates it was created from the OSM_Vector_Basemap_DA2024_Install Vector Tile Package.

Update existing tile layers

Use the Vector Style Updater tool to update your existing layers.

1. Open the DA2024_OSM_WMA_StyleUpdater_template.csv file located in the C:\Projects\OSM_Vector_Basemaps_2024\Toolbox folder.

   Note:

   For GCS, open the DA2024_OSM_GCS_StyleUpdater_template.csv file located in the C:\Projects\OSM_Vector_Basemaps_2024\Toolbox folder.

   For WB, open the DAWB2024_OSM_WMA_StyleUpdater_template.csv file located in the C:\Projects\OSMWB_Vector_Basemaps_2024\Toolbox folder.

   1. Include the item IDs of all your existing styles in the itemid column in this table. The item ID for each style can be obtained from the portal URL for each style. Only copy and paste the series of letters and numbers after ...id=.

      

   2. Once you fill in the itemid column, save the file and rename it DA2024_OSM_WMA_StyleUpdater.csv.

      

      Note:

      These are example item IDs. Use the IDs that are unique to your items in your portal.

2. Run the Vector Style Updater tool.
   1. Start ArcGIS Pro, sign in to your ArcGIS Enterprise portal, , click the Options button , and click Set As Active Portal.
   2. Create a project.
   3. Click the View tab, click Catalog View in the Windows group, right-click Toolboxes, and click Add Toolbox.
   4. Browse to the location on your local computer where you copied the contents of the USB flash drive, click VectorStyleUpdater.tbx, and click OK.

      The VectorStyleUpdater toolbox is added to the project.

   5. Double-click Toolboxes, and double-click VectorStyleUpdater.tbx.
   6. Double-click the Vector Style Updater script.

      

   7. On the Vector Style Updater dialog box, click the Parameters tab and do the following:

      

      1. For CSV formatted file containing the item name and ids (.csv), browse to the location of the DA2024_OSM_WMA_StyleUpdater.csv file on your local computer.
      2. For Folder containing vector styles, browse to the location of the WMA Updated Styles folder on your local computer, for example, C:\Projects\OSM_Vector_Basemaps_2024\VectorBasemapStyles\WMA\WMA_ExistingUser\WMA_UpdatedStyles.

         Note:

         For the GCS tile package, browse to the location of the VectorBasemapStyles folder on your local computer, for example, C:\Projects\OSM_Vector_Basemaps_2024\VectorBasemapStyles\GCS\GCS_ExistingUser\GCS_UpdatedStyles.

         For the WB tile package, browse to the location of the VectorBasemapStyles folder on your local computer, for example, C:\Projects\OSMWB_Vector_Basemaps_2024\VectorBasemapStyles\WB_ExistingUser\WB_UpdatedStyles.

      3. For Vector Tile Service URL, provide the URL of the OSM Vector Basemap tile layer that you replaced above, for example, https://portalname.domain.com/server/rest/services/Hosted/OSM_Vector_Basemap_v2/VectorTileServer.

         Note:

         The vector tile service URL is in the URL section of the OSM_Vector_Basemap_v2 hosted tile layer item page. Click the Copy button and paste the URL in the Vector Tile Service URL parameter text box.

         

      4. For Metadata folder name, keep the default name metadata.

         Note:

         If you are using a portal with PKI authentication, expand PKI Authorization and provide values for the PKI Certificated file (.pfx) and PKI Private Password parameters.

         

         If you are using a portal with Linux LDAP authentication, expand Linux LDAP and provide values for the Sign In Username and Sign In Password parameters.

         

3. Click Run.

   It can take up to a minute to update each existing style in your portal using the Vector Style Updater tool.

   The VectorStyleUpdater toolbox displays a successful update message when complete.

   Note:

   If there are warnings, rerun the VectorStyleUpdated toolbox until you receive a successful update message.

The 10 vector tile layers (map styles) are updated in your assigned ArcGIS Enterprise account. You can view the 10 items in My Content.

Publish new tile layers (map styles)

You'll publish the new map styles next.

The VectorStylePublisher geoprocessing toolbox can be run in ArcGIS Pro. This toolbox publishes new private map items in your portal for one new vector tile layer.

1. In the ArcGIS Pro project you created to update the existing styles, select the View tab, select Catalog View in the Windows group, right-click Toolboxes, and select Add Toolbox.

   

2. Browse to the location on your local computer where you copied the contents of the USB flash drive, select VectorStylePublisher.tbx, and select OK.

   

   The VectorStylePublisher toolbox is added to the project.

3. Double-click Toolboxes, and double-click VectorStylePublisher.tbx.

   

4. Double-click the Vector Style Publisher script.

   

5. On the Vector Style Publisher dialog box, select the Parameters tab and provide the following:
   1. For Folder containing vector styles, browse to the location of the WMA New Styles folder on your local computer, for example, C:\Projects\OSM_Vector_Basemaps_2024\VectorBasemapStyles\WMA\WMA_ExistingUser\WMA_NewStyles.

      Note:

      For the GCS tile package, browse to the location of the VectorBasemapStyles folder on your local computer, for example, C:\Projects\OSM_Vector_Basemaps_2024\VectorBasemapStyles\GCS\GCS_ExistingUser\GCS_NewStyles.

      For the WB tile package, browse to the location of the VectorBasemapStyles folder on your local computer, for example, C:\Projects\OSMWB_Vector_Basemaps_2024\VectorBasemapStyles\WB_ExistingUser\WB_NewStyles.

   2. For Vector Tile Service URL, provide the URL of the OSM Vector Basemap tile layer, for example, https://portalname.domain.com/arcgis/rest/services/Hosted/OSM_Vector_Basemap_v2/VectorTileServer.

      Note:

      The vector tile service URL is in the URL section of the OSM_Vector_Basemap_v2 hosted tile layer item page. Click the Copy button and paste the URL in the Vector Tile Service URL parameter text box.

   3. For Metadata folder name, keep the default name metadata.

      

      Note:

      If you are using a portal with PKI authentication, expand PKI Authorization and provide values for the PKI_Certificated_file_(.pfx) and PKI Private Password parameters.

      

      If you are using a portal with Linux LDAP authentication, expand Linux LDAP and provide values for the Sign In Username and Sign In Password parameters.

      

   4. Click Run.

The two new vector tile layers (map styles) are created in your assigned ArcGIS Enterprise portal account. You can view the items in My Content. Sixteen items are listed: 12 vector tile layers (2 new plus 10 existing), both 2023 and 2024 .vtpk files, and the active and archived hosted tile layers.

Share tile layers (map styles)

The items initially created are private unless you made them public through the Publisher toolbox dialog box or by selecting the map items in your portal and changing the sharing settings.

Note:

Delete protection for all items is applied on publishing the tile layers. To change the protection setting, open the item and click the Settings tab. Under Delete Protection, uncheck Prevent this item from being accidentally deleted and click Save.

Once you set up the OSM Vector Basemaps update, you can do the following:

• Use OSM Vector Basemaps
• Customize OSM Vector Basemap styles
• Localize OSM Vector Basemap styles