Skip to main content

system.kanoa.quality.config.getChecks

Requires kanoaQDS license

Description

Returns the check items for the given parameters.

Syntax

getChecks(paramsDict)

Parameters:
  • paramsDict (dict): Dictionary of filter options.

  • Returns:
  • checkData (pyDataset): Dataset containing check items.
  • Dictionary

    ParameterTypeRequiredNotes
    chkShtIdintNo
    chkItemIdintNo
    chkItemNamestringNo
    chkItemTypeIdintNo
    chkItemTypeNamestringNo
    chkNamestringNo
    chkItemGroupIdintNo
    chkItemGroupNamestringNo
    dataTypeIdintNo
    dataTypeNamestringNo
    isNumericboolNo
    enabledboolNo
    dynamicboolNoIf true, this check item will only be taken if a specification is found for it
    persistenceboolNoDetermines if the last value taken for this check item carries over to the next check

    Code Examples

    # Usage example
    >paramsDict = {'chkShtId': 1, 'chkItemId': 6, 'chkItemTypeName': 'Calculator', 'chkName': 'check 1', 'groupId': 4, 'dataTypeName': 'float', 'isNumeric': True, 'enabled': True, 'dynamic': True}
    >checkData = system.kanoa.quality.config.getChecks(paramsDict)
    >for row in checkData:
    print("Check Item ID: {row['chkItemId']}, Check Name: {row['chkItemName']}, Group ID: {row['chkItemGroupId']}")