Skip to main content

system.kanoa.quality.config.updateCheckField

Requires kanoaQDS license

Description

Updates a check item field value.

Syntax

updateCheckField(field, value, chkItemId, userId)

Parameters:
  • field (str): Name of column to change, e.g., 'chkItemId', 'chkItemGroupId', 'chkShtId', 'dataTypeId', 'engUnitId', 'chkItemName', 'chkItemTypeId', 'chkItemTriggerId', 'measCount', 'instructions', 'pickListId', 'pickListValues', 'calculation', 'required', 'enabled', 'dynamic', 'sortOrder', 'format', 'attributeId'
  • value (pyObject): Value to store
  • chkItemId (int): ID of the check item
  • userId (int): User ID

  • Returns:
  • modifiedRecords (int): Number of records modified during the update.
  • Code Examples

    # Usage example
    field_name = 'chkItemName'
    new_value = 'New Check Name'
    chk_item_id = 3
    user_id = 123
    modified_records = system.kanoa.quality.config.updateCheckField(field=field_name, value=new_value, chkItemId=chk_item_id, userId=user_id)

    if modified_records is not None:
    print(f"Successfully updated {modified_records} records")
    else:
    print("Update failed.")