Upgrade Scene Layer (Data Management)

Summary

Upgrades a scene layer package to the current I3S version in SLPK format or output to i3sREST format for use in ArcGIS Enterprise.

Usage

  • Version 1.4 and later scene layer packages can be converted to the latest I3S version. You can find the I3S version for a scene layer on the Source tab of the layer properties.

  • Point cloud scene layers are not currently supported.

  • Use the Texture Optimization parameter to add or remove textures in the output scene layer package.

  • Warnings encountered during the upgrade process may be reported to the tool messages or the output log file. Warnings do not affect display of the scene layer package but may indicate noncompliance with the I3S specification.

  • Use the Target Cloud Connection parameter to output scene layer content to an object store located in the cloud such as Amazon S3, Azure Blob storage, Alibaba OSS, or Google Cloud. This content can be published as a scene service and the location you choose must be registered as a user-managed data store in ArcGIS Enterprise.

  • This tool does not fix scene layer packages that have missing or incorrect required properties from the I3S specification. Errors are written to the Output Log File parameter value.

  • Use the Time Zone environment together with the Date Format parameter to properly encode date fields in the output scene layer package. For more information about enabling time on scene layers, see Time-enabled scene layers.

Parameters

LabelExplanationData Type
Input Dataset

The input scene layer package.

File
Output Folder

The location where the output scene layer package will be created or the cloud connection file (.acs) to output to i3sREST format.

Folder
Output Name

The name of the output scene layer.

String
Output Log File
(Optional)

The output log file that will summarize the results of the evaluation.

File
Texture Optimization
(Optional)

Specifies the textures that will be optimized according to the target platform where the scene layer package is used.

Caution:

Optimizations that include KTX2 may take significant time to process. For fastest results, use the Desktop or None options.

  • AllAll texture formats will be optimized including JPEG, DXT, and KTX2 for use in desktop, web, and mobile platforms.
  • DesktopWindows, Linux, and Mac supported textures will be optimized including JPEG and DXT for use in ArcGIS AllSource clients on Windows and ArcGIS Maps SDKs desktop clients on Windows, Linux, and Mac. This is the default.
  • MobileAndroid and iOS supported textures will be optimized including JPEG and KTX2 for use in ArcGIS Maps SDKs mobile applications.
  • NoneJPEG textures will be optimized for use in desktop and web platforms.
String
Date Format
(Optional)

The format of the date values in the scene layers date fields. This parameter is hidden if no date fields are encountered.

String

arcpy.management.UpgradeSceneLayer(in_dataset, out_folder_path, out_name, {out_log}, {texture_optimization}, {date_format})
NameExplanationData Type
in_dataset

The input scene layer package.

File
out_folder_path

The location where the output scene layer package will be created or the cloud connection file (.acs) to output to i3sREST format.

Folder
out_name

The name of the output scene layer.

String
out_log
(Optional)

The output log file that will summarize the results of the evaluation.

File
texture_optimization
(Optional)

Specifies the textures that will be optimized according to the target platform where the scene layer package is used.

Caution:

Optimizations that include KTX2 may take significant time to process. For fastest results, use the DESKTOP or NONE options.

  • ALLAll texture formats will be optimized including JPEG, DXT, and KTX2 for use in desktop, web, and mobile platforms.
  • DESKTOPWindows, Linux, and Mac supported textures will be optimized including JPEG and DXT for use in ArcGIS AllSource clients on Windows and ArcGIS Maps SDKs desktop clients on Windows, Linux, and Mac. This is the default.
  • MOBILEAndroid and iOS supported textures will be optimized including JPEG and KTX2 for use in ArcGIS Maps SDKs mobile applications.
  • NONEJPEG textures will be optimized for use in desktop and web platforms.
String
date_format
(Optional)

The format of the date values in the scene layers date fields. This parameter is hidden if no date fields are encountered.

String

Code sample

UpgradeSceneLayer example 1 (Python window)

The following Python window script demonstrates how to use the UpgradeSceneLayer function to upgrade scene layer packages to an object store that can be used in ArcGIS Enterprise publishing workflows.

import arcpy
arcpy.management.UpgradeSceneLayer(r"C:\temp\buildings.slpk, 
                                   r"C:\CloudConnections\AWS.acs", 
                                   "buildings_upgraded", 
                                   r"C:\temp\extracted\out.json", "DESKTOP")
UpgradeSceneLayer example 2 (Python window)

The following Python window script demonstrates how to use the UpgradeSceneLayer function to upgrade scene layer packages.

import arcpy
arcpy.management.UpgradeSceneLayer(r"C:\temp\buildings.slpk, r"C:\packages", 
                                   "buildings_upgraded",  
                                   r"C:\temp\extracted\out.json", "NONE")

Environments