Show Navigation | Hide Navigation

You are here:
Geoprocessing tool reference > Schematics toolbox > Tools

Update Diagrams (Schematics)
Release 9.3 Last modified December 23, 2008	Print all topics in : "Tools"

Related Topics

Updates schematic diagrams stored in a schematic dataset or schematic folder. All diagrams or a subset of diagrams (for example, diagrams related to a specific diagram type, or diagrams that have not been updated for a particular number of days) can be updated. Only diagrams based on the Custom Query Based and Standard builder diagrams can be updated using this geoprocessing tool. Diagrams based on the Network Dataset and XML builders that require specific input data cannot be udpated using this tool. For diagrams based on the Standard builder, the update operates either from the initial feature set used to generate the specified schematic diagram or from the updated trace result based on the trace parameters that were persisted in the schematic database if the diagram was generated from a highlighted trace.

NOTE: If a diagram based on the XML or Network Dataset builder is detected during the execution, an error displays and the process is stopped.

Usage tips

If the Diagram Type parameter is specified, only the diagrams of that type will be updated.
If the Number of days without update parameter is specified, only the diagrams for which the last update date verifies the criteria will be updated.
By default, when the specified Input Schematic Container is a schematic folder, the update process operates recursively on all diagrams contained in that schematic folder and its subfolders. If you want the diagrams contained in the subfolders to not be updated, set 0 for the recursive parameter.
No environment settings affect this tool.

Command line syntax
An overview of the Command Line window
UpdateDiagrams_schematics <in_container> {MERGE_NODES | NO_MERGE_NODES | KEEP_MANUAL_ MODIF | NO_KEEP_MANUAL_MODIF} {RECURSIVE | NO_RECURSIVE} {diagram_type} {last_update_criteria}

Parameter	Explanation	Data Type
<in_container>	The schematic dataset or schematic folder in which the diagrams will be selected. This container must already exist.	Schematic Diagram \| Schematic Folder
{MERGE_NODES \| NO_MERGE_NODES \| KEEP_MANUAL_ MODIF \| NO_KEEP_MANUAL_MODIF}	The schematic builder update options. Update options are optional. They depend on the builder related to the diagram type that implements the treated schematic diagram. - Diagrams based on the Network Dataset builder can use MERGE_NODES or NO_MERGE_NODES. For a diagram based on the Network Dataset builder, the NO_MERGE_NODES option is the one used by default for the update when the Builder Options parameter is not specified. MERGE_NODES — Use this option so network element junctions that are taken several times along the resultant route of a route analysis are represented by a single schematic node in the updated schematic diagram. This option also allows you to merge midspanjunction elements when they are at the same position in the case of a Service Area analysis. NO_MERGE_NODES — Use this option so no node is merged in the updated diagram. This is the default option. - Diagrams based on the Standard Builder can use KEEP_MANUAL_ MODIF or NO_KEEP_MANUAL_ MODIF. The update operates either from the initial feature set used to generate the specified schematic diagram or from the updated trace result based on the trace parameters that were persisted in the schematic database if the diagram was generated from a highlighted trace. Then, two options can be used to specify whether the schematic elements that have been manually removed or reduced from the diagram since its generation (using the Remove Schematic Elements or Reduce Nodes commands), and whose removal or reduction has been saved, must stay undisplayed or not after the update. KEEP_MANUAL_MODIF — Use this option if you want the manually removed or reduced schematic elements to stay undisplayed after the update. This is used as the default option for the update when no builder option is specified. NO_KEEP_MANUAL_MODIF — Use this option if you want those removed or reduced schematic elements to be restored after the update.	String
{RECURSIVE \| NO_RECURSIVE}	Search recursively in subfolders. The default is Recursive.	Boolean
{diagram_type}	The type of schematic diagram to update.	String
{last_update_criteria}	The number of days between diagram updates. The default is zero, meaning all diagrams will be updated daily.	Long

Data types for geoprocessing tool parameters

Command line example

#Sample 1: Updating all diagrams contained in a schematic dataset.
workspace C:\ArcGIS\ArcTutor\Schematics\Schematics\ElecDemo.gdb
UpdateDiagrams_schematics 'ElecDemo'

#Sample 2: Updating all diagrams implemented by the GeoSchematic diagram type.
workspace C:\ArcGIS\ArcTutor\Schematics\Schematics\ElecDemo.gdb
UpdateDiagrams_schematics 'ElecDemo' # RECURSIVE 'GeoSchematic'

#Sample 3: Updating diagrams contained in a schematic dataset that have not been updated for 7 days.
workspace C:\ArcGIS\ArcTutor\Schematics\Schematics\ElecDemo.gdb
UpdateDiagrams_schematics 'ElecDemo' # RECURSIVE # 7

Scripting syntax
About getting started with writing geoprocessing scripts
UpdateDiagrams_schematics (in_container, builder_options, recursive, diagram_type, last_update_criteria)

Parameter	Explanation	Data Type
in_container (Required)	The schematic dataset or schematic folder in which the diagrams will be selected. This container must already exist.	Schematic Diagram \| Schematic Folder
builder_options (Optional)	The schematic builder update options. Update options are optional. They depend on the builder related to the diagram type that implements the treated schematic diagram. - Diagrams based on the Network Dataset builder can use MERGE_NODES or NO_MERGE_NODES. For a diagram based on the Network Dataset builder, the NO_MERGE_NODES option is the one used by default for the update when the Builder Options parameter is not specified. MERGE_NODES — Use this option so network element junctions that are taken several times along the resultant route of a route analysis are represented by a single schematic node in the updated schematic diagram. This option also allows you to merge midspanjunction elements when they are at the same position in the case of a Service Area analysis. NO_MERGE_NODES — Use this option so no node is merged in the updated diagram. This is the default option. - Diagrams based on the Standard Builder can use KEEP_MANUAL_ MODIF or NO_KEEP_MANUAL_ MODIF. The update operates either from the initial feature set used to generate the specified schematic diagram or from the updated trace result based on the trace parameters that were persisted in the schematic database if the diagram was generated from a highlighted trace. Then, two options can be used to specify whether the schematic elements that have been manually removed or reduced from the diagram since its generation (using the Remove Schematic Elements or Reduce Nodes commands), and whose removal or reduction has been saved, must stay undisplayed or not after the update. KEEP_MANUAL_MODIF — Use this option if you want the manually removed or reduced schematic elements to stay undisplayed after the update. This is used as the default option for the update when no builder option is specified. NO_KEEP_MANUAL_MODIF — Use this option if you want those removed or reduced schematic elements to be restored after the update.	String
recursive (Optional)	Search recursively in subfolders. The default is Recursive.	Boolean
diagram_type (Optional)	The type of schematic diagram to update.	String
last_update_criteria (Optional)	The number of days between diagram updates. The default is zero, meaning all diagrams will be updated daily.	Long

Data types for geoprocessing tool parameters

Script example

# Create the Geoprocessor object and set the environment
import arcgisscripting
msgNoLicenseAvailable = "Schematics license required"
gp = arcgisscripting.create()
try:
    if gp.CheckExtension("Schematics") == "Available":
       gp.CheckOutExtension("Schematics")
    else:
       raise "LicenseError"
except "LicenseError":
    print msgNoLicenseAvailable
gp.OverWriteOutput = 1


###Sample 1: Updating all diagrams contained in a particular schematic folder###

# Local variables
workspace = "C:\ArcGIS\ArcTutor\Schematics\Schematics\ElecDemo.gdb"

# Set the current workspace
gp.workspace = workspace

#Process: UpdateDiagrams on the specified Feeders schematic folder
gp.UpdateDiagrams_schematics("ElecDemo\Feeders")



###Sample 2: Updating all diagrams implemented by the GeoSchematic diagram type###
# Local variables
workspace = "C:\ArcGIS\ArcTutor\Schematics\Schematics\ElecDemo.gdb"

# Set the current workspace
gp.workspace = workspace

#Process: UpdateDiagrams on the specified GeoSchematic diagram type
gp.UpdateDiagrams_schematics("ElecDemo", "#", "RECURSIVE", "GeoSchematic")


###Sample 3: Updating diagrams contained in a schematic folder that have not been updated for 7 days###
# Local variables
workspace = "C:\ArcGIS\ArcTutor\Schematics\Schematics\ElecDemo.gdb"

# Set the current workspace
gp.workspace = workspace

#Process: UpdateDiagrams on a specified Inside Plants schematic folder for diagrams that have not been updated for 7 days only
gp.UpdateDiagrams_schematics("ElecDemo\Inside Plant", "#", "RECURSIVE", "#", "7")

Update Diagrams (Schematics)

Command line example

Script example