TeamcenterKnowledge

Engineering BOM Management ─ Deployment and Administration

Set up color scoping for parts

You can restrict the available colors for specific parts by setting up color scoping. This ensures that only colors that are applicable to a part, based on supplier or sourcing constraints, are available for selection when users assign color codes in the color BOM.

Prerequisites

  • You must have Teamcenter administration privileges.
  • You must have access to the parts for which you want to set up color scoping.
  • Color appearances must already exist in the system.

Procedure

  1. Create a CSV file that maps items to their applicable color appearances.

    The CSV file must contain the following columns:

    • Item ID (Required): The item_id of the Item.
    • Item Type (Required): The object_type of the Item, for example, Part or Design.
    • Color Appearance Name (Conditional): The object_name of the color appearance.
    • Appearance Color Code (Conditional): The color code of the color appearance.

    Note: For each row, at least one entry for Color Appearance Name or Appearance Color Code must be provided.

  2. Save the CSV file with the item and color appearance mappings.

    Example CSV content:

    Item ID,Item Type,Color Appearance Name,Appearance Color Code
    Part-001,Part,Midnight Blue,MB001
    Part-002,Part,,FG001
    ComponentPart-X,Design,Pearl White,
    
  3. Open a Teamcenter command prompt and navigate to the Teamcenter bin directory.

    You can run the utility from the Teamcenter server or from a client machine with access to the Teamcenter root and data directories.

  4. Run the cb0_scope_color_appearances_to_items utility with the required arguments.

    Syntax:

    cb0_scope_color_appearances_to_items -u=<username> [-p=<password> | -pf=<password_file>] -g=<group> -input_file=<absolute_file_path>
    

    Example:

    cb0_scope_color_appearances_to_items -u=tc_admin_user -p=tc_admin_password -g=admin_group -input_file=C:\color_scoping\color_mapping.csv
    
  5. Review the output log file to verify that the color scoping has been successfully applied.

    Optionally, to specify a custom location for the output log file, use the -output_log argument:

    cb0_scope_color_appearances_to_items -u=tc_admin_user -p=tc_admin_password -g=admin_group -input_file=C:\color_scoping\color_mapping.csv -output_log=C:\color_scoping\color_scoping.log
    

Results

The color scoping is now configured for the specified parts. When users assign color codes in the color BOM, they will see only the colors that are scoped for each part. If both theme-level color scoping and part-level color scoping are configured, users can select only the colors that are common to both the color theme and the part's color specifications.

What to do next

Inform users that color scoping has been configured so they are aware of the available color options when working with the color BOM.

Source: https://docs.sw.siemens.com/en-US/doc/282219420/PL20251212545240207.ebom_admin/hea9467552395397 · retrieved 2026-07-11