Web レイヤーの置換 (サーバーツール)

サマリー

ポータル内の Web レイヤーのコンテンツを別の Web レイヤーのコンテンツに置き換えます。

使用法

ターゲットレイヤーは、置き換えられる Web レイヤーです。更新レイヤーは、置換 Web レイヤーです。ターゲットレイヤーと更新レイヤーには、次のタイプの Web レイヤーを指定できます。
- ベクタータイルパッケージから公開されたベクタータイルレイヤー
- タイルレイヤー
- 次のいずれかのソースから公開されたシーンレイヤー
  - ArcGIS Online または ArcGIS Enterprise ポータル上でホストされるシーンレイヤーパッケージ
  - フォルダーまたはクラウドデータストア内の参照シーンキャッシュ
  ボクセルシーンレイヤーを置き換えることはできません。
ArcGIS Enterprise ポータルでベクタータイルレイヤーを置き換えるには、10.6 以降のバージョンを使用している必要があります。タイルレイヤーを置き換えるには、10.8 以降のバージョンを使用している必要があります。シーンレイヤーを置き換えるには、10.8.1 以降のバージョンを使用している必要があります。
ArcGIS Pro のアクティブなポータルは、ターゲットレイヤーおよび更新レイヤーをホストするポータルである必要があります。ターゲットレイヤーおよび更新レイヤーを所有しているアカウントを使用して、ArcGIS Pro にサインインする必要があります。
ターゲットレイヤーと更新レイヤーは同じタイプである必要があります。たとえば、ベクタータイルレイヤーをタイルレイヤーに置き換えることはできません。
ターゲットレイヤーと更新レイヤーのシーンレイヤータイプは一致する必要があります。たとえば、ビルディングシーンレイヤーを 3D オブジェクトシーンレイヤーに置き換えることはできません。
Web シーンレイヤーを置き換えるには、ターゲットレイヤーと更新レイヤーが同じソースから公開されている必要があります。たとえば、シーンレイヤーパッケージから公開された Web シーンレイヤーを、参照シーンキャッシュから公開された Web シーンレイヤーに置き換えることはできません。
参照シーンキャッシュから公開された Web シーンレイヤーを置き換えるには、ターゲットレイヤーと更新レイヤーのシーンサービスが同じサーバーおよびサーバーフォルダーに存在する必要があります。
ターゲットレイヤーが更新されると、このレイヤーのコンテンツが置き換えられます。ターゲットレイヤーのアイテム ID およびサービス URL は変更されません。
置き換えられる Web レイヤーは上書きされません。このレイヤーは、新しい名前でポータルにアーカイブされます。デフォルトでは、アーカイブレイヤー名は <layer name>archive<timestamp> です。別の名前を割り当てることができますが、その名前は、ポータル内で一意の Web レイヤー名である必要があります。
デフォルトでは、アーカイブレイヤーは更新レイヤーのアイテム ID を使用します。アーカイブレイヤーの新しいアイテム ID を指定できます。
ターゲットレイヤーのアイテム情報を更新レイヤーのアイテム情報に置き換えることができます。アイテム情報を置き換えると、概要、説明、タグ、およびサムネイル画像が置き換えられます。著作権 (帰属) や利用規約などのその他の情報は、置き換えられません。

ラベル	説明	データタイプ
ターゲットレイヤー	置き換えられる Web レイヤー。レイヤーまたはカタログパスを指定するか、次のいずれかのアイテム ID またはサービス URL を指定します。ベクタータイルパッケージから公開されたベクタータイルレイヤータイルレイヤー次のいずれかのソースから公開されたシーンレイヤーシーンレイヤーパッケージフォルダーまたはクラウドデータストア内の参照シーンキャッシュ	Vector Tile Layer; Internet Tiled Layer; Scene Layer
アーカイブレイヤー名	アーカイブレイヤーに一意の名前。置き換えられた Web レイヤーは、ポータル内にアーカイブレイヤーとして残ります。	String
更新レイヤー	置換する Web レイヤー。レイヤーまたはカタログパスを指定するか、次のいずれかのアイテム ID またはサービス URL を指定します。ベクタータイルパッケージから公開されたベクタータイルレイヤータイルレイヤー次のいずれかのソースから公開されたシーンレイヤーシーンレイヤーパッケージフォルダーまたはクラウドデータストア内の参照シーンキャッシュ	Vector Tile Layer; Internet Tiled Layer; Scene Layer
アイテム情報の置換 (オプション)	ターゲットレイヤーのアイテム情報 (サムネイル画像、概要、説明、およびタグ) を置き換えるかどうかを指定します。いずれのオプションでも、アイテムの著作権 (帰属)、利用規約、および作成元の情報は置き換えられません。オン—ターゲットレイヤーのアイテム情報を、更新レイヤーのアイテム情報に置き換えます。オフ—レイヤーが更新されるとき、ターゲットレイヤーのアイテム情報を置き換えません。これがデフォルトです。	Boolean
アーカイブレイヤー用の新しいアイテムを作成 (オプション)	アーカイブレイヤーのアイテムを作成するかどうかを指定します。このパラメーターは、ArcGIS Online および ArcGIS Enterprise 10.8 以降のポータルでサポートされています。オン—アーカイブレイヤーのアイテム ID が作成されます。シーンレイヤーの場合、これがデフォルトです。オフ—更新レイヤーのアイテム ID がアーカイブレイヤーに使用されます。ベクタータイルレイヤーおよびタイルレイヤーの場合、これがデフォルトです。	Boolean

派生した出力

ラベル	説明	データタイプ
更新されたターゲットレイヤー	更新された Web レイヤーの URL。	String

arcpy.server.ReplaceWebLayer(target_layer, archive_layer_name, update_layer, {replace_item_info}, {create_new_item})

名前	説明	データタイプ
target_layer	置き換えられる Web レイヤー。レイヤーまたはカタログパスを指定するか、次のいずれかのアイテム ID またはサービス URL を指定します。ベクタータイルパッケージから公開されたベクタータイルレイヤータイルレイヤー次のいずれかのソースから公開されたシーンレイヤーシーンレイヤーパッケージフォルダーまたはクラウドデータストア内の参照シーンキャッシュ	Vector Tile Layer; Internet Tiled Layer; Scene Layer
archive_layer_name	アーカイブレイヤーに一意の名前。置き換えられた Web レイヤーは、ポータル内にアーカイブレイヤーとして残ります。	String
update_layer	置換する Web レイヤー。レイヤーまたはカタログパスを指定するか、次のいずれかのアイテム ID またはサービス URL を指定します。ベクタータイルパッケージから公開されたベクタータイルレイヤータイルレイヤー次のいずれかのソースから公開されたシーンレイヤーシーンレイヤーパッケージフォルダーまたはクラウドデータストア内の参照シーンキャッシュ	Vector Tile Layer; Internet Tiled Layer; Scene Layer
replace_item_info (オプション)	ターゲットレイヤーのアイテム情報 (サムネイル画像、概要、説明、およびタグ) を置き換えるかどうかを指定します。いずれのオプションでも、アイテムの著作権 (帰属)、利用規約、および作成元の情報は置き換えられません。 `REPLACE`—ターゲットレイヤーのアイテム情報を、更新レイヤーのアイテム情報に置き換えます。 `KEEP`—レイヤーが更新されるとき、ターゲットレイヤーのアイテム情報を置き換えません。これがデフォルトです。	Boolean
create_new_item (オプション)	アーカイブレイヤーのアイテムを作成するかどうかを指定します。このパラメーターは、ArcGIS Online および ArcGIS Enterprise 10.8 以降のポータルでサポートされています。 `TRUE`—アーカイブレイヤーのアイテム ID が作成されます。シーンレイヤーの場合、これがデフォルトです。 `FALSE`—更新レイヤーのアイテム ID がアーカイブレイヤーに使用されます。ベクタータイルレイヤーおよびタイルレイヤーの場合、これがデフォルトです。	Boolean

派生した出力

名前	説明	データタイプ
updated_target_layer	更新された Web レイヤーの URL。	String

コードのサンプル

ReplaceWebLayer の例 1 (スタンドアロンスクリプト)

次のスクリプトは、入力レイヤーのアイテム ID を使用して Web レイヤーを置き換えます。

import arcpy
import time

# Set local variables
targetLayerID = "42994b1a3e63425aa02bcfa1200683ae"
archiveLayerName = "ReplaceWebLayerExample_archive_" + time.strftime("%Y%m%d")
updateLayerID = "9e1d80c874e040fc88ad06b0cfa01381"
replaceItemInfo = "REPLACE"
createNewItem = "TRUE"

# Run Replace Web Layer
arcpy.server.ReplaceWebLayer(targetLayerID, archiveLayerName, updateLayerID,
                             replaceItemInfo, createNewItem)

print("Successfully replaced web layer.")

ReplaceWebLayer の例 2 (スタンドアロンスクリプト)

次のスクリプトは、入力レイヤーのサービス URL を使用して、ArcGIS Enterprise で Web レイヤーを置き換えます。

import arcpy
import time

# Set local variables
targetLayer = "https://organization.example.com/webadaptorname/rest/services/Hosted/targetServiceName/VectorTileServer"
archiveLayerName = "targetServiceName_archive_" + time.strftime("%Y%m%d")
updateLayer = "https://organization.example.com/webadaptorname/rest/services/Hosted/updateServiceName/VectorTileServer"

# Run Replace Web Layer
arcpy.server.ReplaceWebLayer(targetLayer, archiveLayerName, updateLayer)

print("Successfully replaced web layer.")

ReplaceWebLayer の例 3 (スタンドアロンスクリプト)

次のスクリプトは、ベクタータイルレイヤーを公開して置き換えます。

このスクリプトは、マップの CreateVectorTilePackage 関数を呼び出して、ベクタータイルパッケージを作成します。次に、SharePackage 関数がベクタータイルパッケージを ArcGIS Online または ArcGIS Enterprise にアップロードし、ベクタータイルレイヤーとして公開します。最後に、ReplaceWebLayer 関数がアイテム ID を使用して、ポータルにある既存の Web レイヤーのコンテンツを、新しい Web レイヤーのコンテンツに置き換えます。置き換えられたベクタータイルレイヤーが新しい名前でポータルにアーカイブされます。ポータル情報は、SignInToPortal 関数から取得されます。

import arcpy
import os
import json

# Sign in to portal
arcpy.SignInToPortal("https://www.arcgis.com", "MyUserName", "MyPassword")

# Reference map to publish
aprx = arcpy.mp.ArcGISProject(r"C:\Project\World.aprx")
m = aprx.listMaps('World')[0]

# Set output file names
outdir = r"C:\Project\Output"
service_name = "VectorTileLayerExample"
package_filename = service_name + ".vtpk"
package_output_filename = os.path.join(outdir, package_filename)

# Create vector tile package
arcpy.management.CreateVectorTilePackage(m, package_output_filename, "ONLINE")

# Upload and publish vector tile package
result = arcpy.management.SharePackage(package_output_filename, publish_web_layer=True)

print("Finish uploading and publishing package")

# Get the item ID or service URL of the vector tile layer
jobresult = result[1]
result = json.loads(jobresult)

# Publish results JSON response example: {"publishStatus":"<status>","publishMessage":"<message>",
# "publishResult":{"type":"Vector Tile Service","serviceurl":"<service_url>","size":1913146,"jobId":"<ID>","serviceItemId":"<ItemID>"}}
itemID = str(result.get('publishResult', {}).get('serviceItemId'))

print("Start Replacing")

# Set local variables for Replace Web Layer workflow
# target_layer/update_layer can be item ID or service URL; example below uses item ID
target_layer = "808ecf02f39441d69f245c0cb261134b"
archive_layer_name = "ReplaceWebLayerExample_archive"
update_layer = itemID
replace_item_info = "REPLACE"
create_new_item = "TRUE"

# Run Replace Web Layer
arcpy.server.ReplaceWebLayer(target_layer, archive_layer_name, update_layer,
                             replace_item_info, create_new_item)

print("Finished Replacing")

環境

現在のワークスペース

ライセンス情報

Basic: はい
Standard: はい
Advanced: はい

Web レイヤーの置換 (サーバー ツール)

サマリー

使用法

パラメーター

派生した出力

環境

ライセンス情報

関連トピック

Web レイヤーの置換 (サーバーツール)