TeamcenterKnowledge

Engineering BOM Management ─ Deployment and Administration

cb0_scope_color_appearances_to_items

Creates or updates color scoping relationships between parts and color appearances, restricting the available colors for specific parts based on supplier or sourcing constraints.

Purpose

The cb0_scope_color_appearances_to_items utility creates Cb0ScopedColor relations between Item objects and Clr0Appearance objects. This ensures that when users assign color codes in the color BOM, they can select only the colors that are applicable to a specific part.

Syntax

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

Arguments

  • -u=<username> — Specifies the Teamcenter username. This user must have Teamcenter administration privileges.

    Note: If Security Services single sign-on (SSO) is enabled for your server, the -u and -p arguments are authenticated externally through SSO rather than being authenticated against the Teamcenter database. If you do not supply these arguments, the utility attempts to join an existing SSO session. If no session is found, you are prompted to enter a user ID and password.

  • -p=<password> — Specifies the Teamcenter password. Mutually exclusive with -pf.

  • -pf=<password_file> — Specifies the password file. The file must be a single-line ASCII file containing the password in clear text. Mutually exclusive with -p.

  • -g=<group> — Specifies the Teamcenter user group associated with the user. If used without a value, the user's default group is assumed.

  • -input_file=<absolute_file_path> — Specifies the absolute file path to the CSV file containing the Item and Color Appearance data. Required.

  • -output_log=<log_file> — Specifies the absolute file path for the output log file. Optional.

  • -h — Displays help for this utility.

Input file format

The input 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 Clr0Appearance.
  • Appearance Color Code — Conditional. The clr0VisualAppCode of the Clr0Appearance.

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

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,

Examples

Set up color scoping with an explicit password:

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

Set up color scoping with a password file and output log:

cb0_scope_color_appearances_to_items -u=tc_admin_user -pf=C:\passwords\tc_password.txt -g=admin_group -input_file=C:\color_scoping\color_mapping.csv -output_log=C:\color_scoping\color_scoping.log

Environment

The environment is set up as specified in Setting up a Teamcenter command-line environment.

Restrictions

None.

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