CompareConfigurations

Title  Asset Package Configuration Report

Description

Generates a collection of Excel Workbooks/Sheets to review the various Asset Package configuration options.

Usage

          
Multiple configurations can be selected to compare the results.

License

Basic

Toolset

Asset Package

Syntax

CompareConfigurations (asset_package, folder, mode, {single_configuration}, {multiple_configurations}, {rename}, {alias})

Parameter Explanation Data Type
asset_package Dialog Reference

The asset package with configuration tables.

DEWorkspace
folder Dialog Reference

The location to save the output. A unique folder starting with Configuration will be generated in this location for each run of the tool.

DEFolder
mode Dialog Reference

The method to generate the report and adjust the UI of this tool.

  • Single - The configuration options are present into a list with checkboxes. Uncheck the configurations to remove those values associated with them.
  • Multiple - The configuration options must be defined in a list of list. The list must include the configurations to include (checked).
  • All - All combinations of the configurations will be included. This is a powerset, so there may be a large number of combinations
  • Include Single - A combination will be created for every configuration where only one configuration is selected for each.
  • Exclude Single - A combination will be created for every configuration where all except one configuration is selected for each.

GPString
single_configuration (Optional) Dialog Reference

Select the configuration options you want to apply to your report. The D_Configurations table must be present in your asset package.

GPString
multiple_configurations (Optional) Dialog Reference

To compare multiple configurations, you must input a list of list. A list of all configurations is predefined. To create new set of configurations, copy and paste the list and remove the item that you want to 'uncheck'. Repeat this process for each combination of configurations you want to compare.

GPString
rename (Optional) Dialog Reference

Select the rename option you want to apply to your report. The D_Rename table must be present in your asset package.

GPString
alias (Optional) Dialog Reference

The label to identify the selected configuration(s). By default, it is the name of each configuration.

GPString

Code Samples

CompareConfigurations example 1 (Python window)

Creates a configuration report for all configurations in the asset package.

import arcpy

arcpy.udms.CompareConfigurations("D:/data/network.gdb", "D:/data/report", "ALL")

CompareConfigurations example 2 (stand-alone script)

Creates a configuration report for the selected configurations in the asset package.

import os

import arcpy

workspace = "D:/data/network.gdb"

output = arcpy.udms.CompareConfigurations(
    asset_package=workspace,
    folder=os.path.join(os.path.dirname(workspace), "Configurations"),
    mode="SINGLE",
    single_configuration=["Ground", "Distribution Stations"],
    multiple_configurations=None,
    rename="Spanish",
)

print(output[0])