Skip to main content

system.kanoa.lot.getRouteSteps

Requires kanoaOPS license

Description

Retrieves route step records filtered by the specified parameters.

Syntax

getRouteSteps(paramsDict)

Parameters:

– paramsDict (dictionary): Dictionary containing route step filters.

Returns:

– routeStepData (pyDataset): Dataset containing route step records that match the provided filters.

Behavior

The function queries mes.vwRouteStep to return step-level information associated with one or more routes.

– Supports filtering by route, operation, step number, and enablement status.
– Returns all related metadata such as item associations, operation details, and audit fields.
– Results are ordered by routeId and stepNum.

Dictionary

ParameterTypeRequiredNotes
routeIdintNoFilter by route ID
routeNamestringNoFilter by route name (supports LIKE search)
routeStepIdintNoFilter by route step ID
lotOperationIdintNoFilter by associated lot operation ID
lotOperationNamestringNoFilter by lot operation name (supports LIKE search)
stepNumintNoFilter by step number within the route
enabledboolNoFilter by enabled state of the step
itemIdintNoFilter by associated item ID
itemNamestringNoFilter by associated item name (supports LIKE search)

Code Examples

# Get all steps for a specific route
paramsDict = {"routeId": 101}
routeStepData = system.kanoa.lot.getRouteSteps(paramsDict=paramsDict)

# Get enabled steps for a specific operation
paramsDict = {"lotOperationName": "%Assembly%", "enabled": True}
routeStepData = system.kanoa.lot.getRouteSteps(paramsDict=paramsDict)

# Get route steps by item name
paramsDict = {"itemName": "%Widget%"}
routeStepData = system.kanoa.lot.getRouteSteps(paramsDict=paramsDict)

# Get a specific step by ID
paramsDict = {"routeStepId": 5001}
routeStepData = system.kanoa.lot.getRouteSteps(paramsDict=paramsDict)