Skip To Content

Set up OSM Vector Basemaps (existing user)

These steps are for updating your OSM Vector Basemaps in WMA.

Note:

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

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 your new hosted tile layer must be different than the title of your existing hosted tile layer (for example, DA71).

  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, and select Set As Active Portal.

    Set As Active Portal

    Note:

    You must sign in and connect to your portal before you proceed. You cannot enter your portal user name 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. Select the Analysis tab, and select Tools in the Geoprocessing group.

    Analysis tab with Tools option

    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.

    Geoprocessing pane with Share Package search results

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

    Caution:

    Do not change the Credits parameter value and do not check the boxes to share with Everybody or Within Organization.

    Share Package dialog box

  6. Select Run.

    It will take approximately 30–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_DA72_Install tile package is located in the root folder.

    2. Under Details, confirm that the Size value of the tile package is 33,311 MB and Shared with indicates that the item is not shared.

    Your item should look like the following: OSM Vector Basemap WMA 7.2 tile layer item

  8. Note:

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

    For the OSM_Vector_Basemap_GCS_DA72_Install tile package, if the size is not 33,116 MB, 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_DA72_Install.vtpk) you uploaded to your portal.
  3. Click Publish, change the title to OSM_Vector_Basemap_DA72_v2, and click Publish again.

    Publish dialog box for .vtpk map item

    Note:

    For the GCS tile package, use the OSM_Vector_Basemap_GCS_DA72_Install.vtpk file. Change the title to OSM_Vector_Basemap_GCS_DA72_v2 for the hosted tile layer that gets published.

    Note:

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

    The OSM_Vector_Basemap_DA72_v2 hosted tile layer is created.

    Item list showing OSM Vector Basemap hosted tile layer

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

Next, you'll replace the 7.1 basemap hosted tile layer (service) with the 7.2 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.

    Tile layer item with Replace Layer button

  4. Click Select layer and select the newly published OSM_Vector_Basemap_DA72_v2 layer.

    Replacement Layer with Select layer circled

  5. For Archive this layer as, click the edit button and change the value to OSM_Vector_Basemap_DA71_v2.

    Archive current layer with edit button circled

  6. Click Save.
  7. If you're using an ArcGIS Enterprise 10.7.1 or later portal, check the Replace item information check box.

    Replacement options

    Note:

    Diagram of current layer, replacement layer, and archived layer

    The image above shows the Replace Layer function. For ArcGIS Data Appliance: OpenStreetMap Vector Basemaps 7.2, the current layer starts as DA7.1. The replacement layer is DA7.2. You are archiving the DA7.1 hosted tile layer, and the current layer (OSM_Vector_Basemaps_v2) now displays the DA7.2 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 DA7.2 basemap content.

  8. Click Replace.

    In a few minutes, the Success message appears.

    Replace Layer Success message

  9. Click Close.

Update existing tile layers

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

  1. Open the DA72_OSM_WMA_StyleUpdater_template.csv file located in the C:\Projects\OSM_Vector_Basemaps_7.2\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=.

      Portal URL with Item ID number

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

      StyleUpdater template with itemid, title, and foldername columns

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

      Vector Style Updater script

    7. In the Vector Style Updater dialog box, select the Parameters tab and provide the following:

      Vector Style Updater dialog box

      1. For CSV formatted file containing the item name and ids (.csv), browse to the location of the DA72_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_7.2\VectorBasemapStyles\WMA\WMA_ExistingUser\WMA_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/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 into the Vector Tile Service URL parameter text box.

        Esri Vector Basemap hosted tile layer with Copy button highlighted

      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.

        PKI Authorization

        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.

        Linux LDAP authorization

  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.

The five vector tile layers (map styles) are updated in your assigned ArcGIS Enterprise account. You can view the five 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 four new vector tile layers.

  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.

    View tab with Catalog View showing Toolboxes options

  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.

    Add Toolbox pane with VectorStylePublisher.tbx selected on local computer

    The VectorStylePublisher toolbox is added to the project.

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

    Catalog tab with VectorStylePublisher.tbx

  4. Double-click the Vector Style Publisher script.

    Catalog tab with Vector Style Publisher script selected

  5. In 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_7.2\VectorBasemapStyles\WMA\WMA_ExistingUser\WMA_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 into the Vector Tile Service URL parameter text box.

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

      Parameters tab of the Vector Style Publisher dialog box

      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.

      PKI Authorization

      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.

      Linux LDAP authorization

    4. Click Run.

The four new vector tile layers (map styles) are created in your assigned ArcGIS Enterprise portal account. You can view the items in My Content. Thirteen items are listed: nine vector tile layers (four new plus five existing), both 7.1 and 7.2 .vtpk files, and the active and archived hosted tile layers.

Share tile layers (map styles)

The items created are private unless you check the Share vector style web layers publicly check box to make them public.

Vector Style Publisher dialog box with Share vector style web layers publicly box checked

Alternatively, you can select the map items in your portal and change the sharing settings.

Map item sharing in the geoprocessing tool

Note:

Delete protection for all items is applied upon 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.

Settings tab with Delete Protection box checked

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