Add Items To Catalog Dataset (Data Management)

Summary

Adds workspace items and layers—such as geodatabase datasets, raster layers, feature layers, mosaic layers, and other items—to an existing catalog dataset.

Usage

• This tool adds items from local or network-shared folders and workspaces. To add portal items from the active portal to a catalog dataset, use the Add Portal Items To Catalog Dataset tool.

• After the target catalog dataset is specified, you can apply filters to only add certain item types from the workspaces specified by the Input Items parameter value.

• Items added to the catalog dataset must be permitted item types. When you specify one or more workspaces with the Input Items parameter, only permitted item types from the workspaces will be added.

• If individual items (such as shapefiles, .dwg files, or feature classes) are specified for the Input Items parameter, the Input Item Types parameter value will not prevent inclusion of these items in the dataset.

• If an item already exists in the catalog dataset, it will not be added again. Any skipped items will be included in the tool messages.

• To add items to a catalog dataset created in ArcGIS Pro 3.1, the dataset must be upgraded using the Upgrade Dataset tool.

• The Input Items parameter supports map service URLs as input.

• A scene layer package cannot be individually specified as the Input Items parameter value, but it can be added to the dataset if it is in a specified folder or workspace.

• Items added to the catalog dataset must have an extent.

• To delete one or more items from a catalog dataset, open the dataset's attribute table and delete the records.

Parameters

Dialog

Label	Explanation	Data Type
Target Catalog Dataset	The catalog dataset to which the items will be added.	Catalog Layer
Input Items	The workspace items, layers, and files from which items will be added to the catalog dataset. The workspace can be a folder, file geodatabase, feature dataset, enterprise database, or a service from a server connection.	Workspace; Feature Layer; Image Service; Raster Layer; Mosaic Layer; LAS Dataset Layer; Layer File; CAD Drawing Dataset; ServerConnection; BIM File Workspace; TIN Layer
Input Item Types (Optional)	Specifies the item types that will be added to the catalog dataset from any input workspaces. All supported item types will be added by default. BIM files—BIM file workspaces will be added. BIM floor plans—BIM file floor plans will be added. CAD datasets—CAD drawings will be added. Feature classes—Feature classes will be added. Feature services—Feature services will be added. Image services—Image services will be added. LAS datasets—LAS datasets will be added. LAS files—LAS files will be added. Layer files—Layer files will be added. Map services—Map services will be added. Mosaic datasets—Mosaic datasets will be added. Raster layers—Raster datasets will be added. Scene layer packages—Scene layer packages will be added. TIN datasets—TIN datasets will be added.	String
Include subfolders (Optional)	Specifies whether the contents of folders or workspaces specified in the Input Items parameter value will be recursively searched and added to the catalog dataset. This parameter is not applicable to file or enterprise geodatabases. Checked—The contents of folders or workspaces will be recursively searched and added to the catalog dataset. This is the default. Unchecked—The contents of folders or workspaces will not be recursively searched and added to the catalog dataset.	Boolean
Footprint Type (Optional)	Specifies whether the reference item's footprint will be the full extent or a convex hull representing the smallest convex polygon for all features. Envelope—The footprint will be a rectangle covering the full extent of the reference item. This is the default. Convex hull—The footprint will be a convex hull enclosing all features from the reference item.	String

Derived Output

Label	Explanation	Data Type
Output Catalog Dataset	The updated catalog dataset.	Catalog Layer

Python

arcpy.management.AddItemsToCatalogDataset(target_catalog_dataset, input_items, {input_item_types}, {include_subfolders}, {footprint_type})

Name	Explanation	Data Type
target_catalog_dataset	The catalog dataset to which the items will be added.	Catalog Layer
input_items [input_items,...]	The workspace items, layers, and files from which items will be added to the catalog dataset. The workspace can be a folder, file geodatabase, feature dataset, enterprise database, or a service from a server connection.	Workspace; Feature Layer; Image Service; Raster Layer; Mosaic Layer; LAS Dataset Layer; Layer File; CAD Drawing Dataset; ServerConnection; BIM File Workspace; TIN Layer
input_item_types [input_item_types,...] (Optional)	Specifies the item types that will be added to the catalog dataset from any input workspaces. All supported item types will be added by default. BIM_FILE_WORKSPACE—BIM file workspaces will be added. BIM_FILE_FLOORPLAN—BIM file floor plans will be added. CAD_DRAWING—CAD drawings will be added. FEATURE_CLASS—Feature classes will be added. FEATURE_SERVICE—Feature services will be added. IMAGE_SERVICE—Image services will be added. LAS_DATASET—LAS datasets will be added. LAS_FILE—LAS files will be added. LAYER_FILE—Layer files will be added. MAP_SERVICE—Map services will be added. MOSAIC_DATASET—Mosaic datasets will be added. RASTER_DATASET—Raster datasets will be added. SCENE_LAYER_PACKAGE—Scene layer packages will be added. TIN—TIN datasets will be added.	String
include_subfolders (Optional)	Specifies whether the contents of folders or workspaces specified in the input_items parameter value will be recursively searched and added to the catalog dataset. This parameter is not applicable to file or enterprise geodatabases. INCLUDE_SUBFOLDERS—The contents of folders or workspaces will be recursively searched and added to the catalog dataset. This is the default. NOT_INCLUDE_SUBFOLDERS—The contents of folders or workspaces will not be recursively searched and added to the catalog dataset.	Boolean
footprint_type (Optional)	Specifies whether the reference item's footprint will be the full extent or a convex hull representing the smallest convex polygon for all features. ENVELOPE—The footprint will be a rectangle covering the full extent of the reference item. This is the default. CONVEX_HULL—The footprint will be a convex hull enclosing all features from the reference item.	String

Derived Output

Name	Explanation	Data Type
out_catalog_dataset	The updated catalog dataset.	Catalog Layer

Code sample

AddItemsToCatalogDataset example (Python window)

The following Python window script demonstrates how to use the AddItemsToCatalogDataset function in immediate mode.

import arcpy
arcpy.env.workspace = "C:/Dataspace/WhereMyCatalogLayerIs.gdb"
arcpy.management.AddItemsToCatalogDataset(
    "MyCatalogDataset", ["AllMyFeatures.gdb", "AllMyRasters.gdb"], 
    ["FEATURE_CLASS", "RASTER_DATASET"], "INCLUDE_SUBFOLDERS", "ENVELOPE")

Environments

Geographic Transformations, Extent

Special cases

Extent

If this environment is set to the Intersection of Inputs or Union of Inputs option, this environment will be ignored.

Licensing information

• Basic: Yes
• Standard: Yes
• Advanced: Yes