Help

Synchronize Metadata

Summary

Automatically updates an ArcGIS item's metadata with the current properties of the item.

For example, if the metadata describes the item as having one projection but the item's projection has changed since the last automatic update, the old projection information in the metadata will be replaced with the new projection information.

Usage

  • By default, metadata is automatically updated when anyone who has write access to the ArcGIS item views its metadata. Metadata can also be synchronized by running this tool. The option to turn off synchronization when you view metadata doesn't affect how this tool operates.

  • If someone edits an ArcGIS item's data or changes its properties and does not view the metadata, the properties recorded in the metadata are out of date with the actual properties of the item. If you were to use or publish the item's metadata in this state without first running this tool the information in the metadata would not be current.

    The Export Metadata, Export Metadata Multiple, Validate Metadata, and Validate Metadata Multiple tools all update the metadata automatically before performing other operations. The Import Metadata and Upgrade Metadata tools automatically update the metadata after performing other operations.

    If your organization's metadata workflow incorporates other operations or tools that don't synchronize the metadata you may want to write a Python script that would run this tool as needed. For example, if you use a utility that publishes metadata for all items in a geodatabase to a metadata catalog nightly, ideally you would synchronize the metadata content nightly before publishing to ensure the published information is always current.

  • XML files do not support metadata synchronization. If you try to synchronize a stand-alone metadata XML file, the tool will complete successfully but the XML file will remain unchanged.

  • The Source Metadata parameter has a complex data type. If you use this tool in a model, create a variable for the Source Metadata parameter in ModelBuilder by right-clicking the tool and choosing Make Variable > From Parameter > Source Metadata.

  • When using this tool in ModelBuilder, the Output Metadata parameter is derived from the Source Metadata parameter.

  • If you do not have write access to the ArcGIS item or its metadata or the stand-alone metadata XML file that you are trying to modify, this tool will complete successfully, but the item's original metadata will remain unchanged.

Syntax

SynchronizeMetadata_conversion (source, synctype)
ParameterExplanationData Type
source

The item whose metadata will be synchronized.

Data Element; Layer
synctype

The type of synchronization that will take place.

  • ALWAYS —Properties of the source item are always added to or updated in its metadata. Metadata will be created if it doesn't already exist. This is the deault.
  • ACCESSED —Properties of the source item are added to or updated in its metadata when it is accessed. Metadata will be created if it doesn't already exist.
  • CREATED —Metadata will be created and properties of the source item will be added to it if the item doesn't already have metadata.
  • NOT_CREATED —Properties of the source item are added to or updated in existing metadata.
  • OVERWRITE —The same as "ALWAYS" except all information that can be recorded automatically in the metadata will be recorded. Any properties typed in by a person will be replaced with the item's actual properties.
  • SELECTIVE —The same as "OVERWRITE" except the title and the content type will not be overwritten with default values for the item. Used when metadata is upgraded to the ArcGIS 10.x metadata format.
String

Code sample

Synchronize an ArcGIS item's metadata

Metadata for an ArcGIS item is updated to contain the current properties of the item only if the item already has metadata; new metadata won't be created.

import arcpy
from arcpy import env
env.workspace = "C:/data/data.gdb"
arcpy.SynchronizeMetadata_conversion("vegetation", "NOT_CREATED")

Environments

Licensing information

  • ArcGIS for Desktop Basic: Yes
  • ArcGIS for Desktop Standard: Yes
  • ArcGIS for Desktop Advanced: Yes

Related topics