update_part_list_validation_analysis_props#

Analysis.update_part_list_validation_analysis_props(project, properties_per_cca)#

Update properties for a Part List Validation analysis.

Parameters:
project: str

Name of the Sherlock project.

properties_per_cca: list[dict[str, bool | str]]

Part List Validation analysis properties for each CCA consisting of these properties:

  • cca_name: str

    Name of the CCA.

  • process_use_avl: bool

    Whether to use AVL.

  • process_use_wizard: bool

    Whether to use the wizard.

  • process_check_confirmed_properties: bool

    Whether to check confirmed properties.

  • process_check_part_numbers: bool

    Whether to check part numbers.

  • matching_mode: str

    Matching type.

  • avl_require_internal_part_number: bool

    Whether to require an internal part number.

  • avl_require_approved_description: bool

    Whether to require an approved description.

  • avl_require_approved_manufacturer: bool

    Whether to require an approved manufacturer.

Returns:
:
int

Status code of the response. 0 for success.

Return type:

int

Examples

>>> from ansys.sherlock.core.launcher import launch_sherlock
>>> sherlock = launch_sherlock()
>>> sherlock.project.import_odb_archive(
    "ODB++ Tutorial.tgz",
    True,
    True,
    True,
    True,
    project="Test",
    cca_name="Card",
)
>>> sherlock.analysis.update_part_list_validation_analysis_props(
    "Test",
    [{
        "cca_name": "Card",
        "process_use_avl": True,
        "process_use_wizard": False,
        "process_check_confirmed_properties": True,
        "process_check_part_numbers": True,
        "matching_mode": "Part",
        "avl_require_internal_part_number": True,
        "avl_require_approved_description": False,
        "avl_require_approved_manufacturer": True,
    },
    ]
)