Kanoa MES

https://kanoa-software.netlify.app
Admin
Kanoa MES is a modular Manufacturing Execution System built on Inductive Automation’s Ignition...
Tokens:95,780
Snippets:1,376
Trust Score:7.6
Update:2 months ago
Show doc for...
Tokens:
Raw
### Update Asset Group Example

Source: https://kanoa-software.netlify.app/systemFunctions/asset/updateAssetGroup

Demonstrates how to call the updateAssetGroup function with required parameters.

```javascript
assetGroupName = 'Group1'  

assetGroupId = 4  

userId = 5  

assetGroupId = system.kanoa.asset.updateAssetGroup(assetGroupName, assetGroupId, userId)  
```

--------------------------------

### Add Asset Tag UDT Instance Example

Source: https://kanoa-software.netlify.app/systemFunctions/asset/addAssetTagUDTInstance

Demonstrates how to call the function with a specific asset ID.

```python
assetId = 123  

system.kanoa.asset.addAssetTagUDTInstance(assetId)
```

--------------------------------

### Update Asset Mode Example

Source: https://kanoa-software.netlify.app/systemFunctions/asset/updateMode

Demonstrates how to define the modeInfo dictionary and call the updateMode function with a user ID.

```python
modeInfo = {  

    'modeName': 'Changeover',  

    'modeTypeId': 2,  

    'enabled': True,  

    'canSelect': True,  

    'canSchedule': False,  

    'modeColor': '#FF0000',  

    'iconPath': '/path/to/icon.png',  

    'modeId': 10  

}  

userId = 123  

updatedModeId = system.kanoa.asset.updateMode(modeInfo, userId)  
```

--------------------------------

### Configure Downtime Table Options

Source: https://kanoa-software.netlify.app/releaseNotes/v1_11

Example JSON configuration for setting up the downtime table view parameters.

```json
"options": {"sortDateAsc": true, "showDurationSecs": false, "minDurationMins": 5, ""showAllStates": false}
```

--------------------------------

### Upsert Asset Mode Links Example

Source: https://kanoa-software.netlify.app/systemFunctions/asset/upsertAssetModeLinks

Demonstrates the structure of the assetModeList and the function call to perform the bulk upsert.

```python
assetModeList = [{'assetId': 901, 'modeId': 2, 'modeCode': 1, 'autoSchedule': True}]  

userId = 5  

retVal, msg = system.kanoa.asset.upsertAssetModeLinks(assetModeList, userId)
```

--------------------------------

### Update Asset Field Example

Source: https://kanoa-software.netlify.app/systemFunctions/asset/updateAssetField

Demonstrates how to call the updateAssetField function with required parameters.

```python
assetId = 12  

field = "enabled"  

value = False  

userId = 5  

recordsModified, message = system.kanoa.asset.updateAsset(assetId, field, value, userId)  
```

--------------------------------

### Update Attribute Example

Source: https://kanoa-software.netlify.app/systemFunctions/attribute/updateAttribute

Demonstrates how to define the attribute information dictionary and call the updateAttribute function.

```python
attrInfo = {  

  'attributeId': 1,  

  'attributeName': 'some attribute name',  

  'attributeDescription': 'some description',  

  'parentId': 6,  

  'enabled': True  

}  

userId = 123  

modifiedRecords = system.kanoa.attribute.updateAttribute(attrInfo, userId)  
```

--------------------------------

### Add Asset Group Example

Source: https://kanoa-software.netlify.app/systemFunctions/asset/addAssetGroup

Demonstrates how to call the addAssetGroup function with a group name and user ID.

```javascript
groupName = 'Group1'

userId = 5

assetGroupId = system.kanoa.asset.addAssetGroup(groupName, userId)
```

--------------------------------

### Custom Script Return Value Examples

Source: https://kanoa-software.netlify.app/kanoa-quality/checkSheets

Examples of return values for custom Python scripts, requiring a tuple of the result and an error message or None.

```python
return 'Hello World', None
```

```python
'', 'An error occurred'
```

--------------------------------

### Link Asset Modes Example

Source: https://kanoa-software.netlify.app/systemFunctions/asset/linkAssetModes

Demonstrates the usage of linkAssetModes by defining the required lists and user ID before calling the function.

```javascript
assetIdList = [100,101,102]  

modeList = [1,3,4]  

modeCodeList = [2,8,12]  

userId = 5  

system.kanoa.asset.linkAssetModes(assetIdList, modeList, userId, modeCodeList)
```

--------------------------------

### Link Asset States Example

Source: https://kanoa-software.netlify.app/systemFunctions/asset/linkAssetStates

Demonstrates how to call the function with lists of asset IDs, state IDs, state codes, and a user ID.

```python
assetIdList = [1,2,3]  

stateIdList = [101]  

stateCodeList = [3]  

userId = 5  

retVal = system.kanoa.asset.linkAssetStates(assetIdList, stateIdList, userId, stateCodeList)  
```

--------------------------------

### Upsert Asset State Links Example

Source: https://kanoa-software.netlify.app/systemFunctions/asset/upsertAssetStateLinks

Demonstrates the required structure for the assetStateList and the function call to perform the bulk upsert.

```python
assetStateList = [{'assetId': 901, 'stateId': 2, 'stateCode': 1}]  

userId = 5  

retVal, msg = system.kanoa.asset.upsertAssetStateLinks(assetStateList, userId)  
```

--------------------------------

### Delete Asset Example

Source: https://kanoa-software.netlify.app/systemFunctions/asset/deleteAssets

Demonstrates the basic usage of the deleteAssets function by providing an asset ID and user ID.

```python
assetId = 123  

userId = 456  

retVal, message = system.kanoa.asset.deleteAssets(assetId, userId)
```

--------------------------------

### Add Asset Type Example

Source: https://kanoa-software.netlify.app/systemFunctions/asset/addAssetType

Demonstrates the structure of the assetTypeInfo dictionary and the function call to add a new asset type.

```python
assetTypeInfo = {  

    'assetTypeName': 'Region',  

    'parentId': 1,  

    'enabled': True,  

    'iconPath': None  

}  

userId = 5  

assetTypeId, msg = system.kanoa.asset.addAssetType(assetTypeInfo, userId)
```

--------------------------------

### Update State Category Example

Source: https://kanoa-software.netlify.app/systemFunctions/asset/updateStateCategory

Demonstrates how to define the stateCategoryInfo dictionary and call the update function with a user ID.

```python
stateCategoryInfo={'stateCategoryId': 18, 'parentId': 4, 'stateCategoryName': 'Parts', 'enabled': True}

userId = 5

retVal, message = system.kanoa.asset.updateStateCategory(stateCategoryInfo, userId)
```

--------------------------------

### Update Asset Type Example

Source: https://kanoa-software.netlify.app/systemFunctions/asset/updateAssetType

Demonstrates the structure of the assetTypeInfo dictionary and the function call to update an asset type.

```python
assetTypeInfo = {  

    'assetTypeId': 456,  

    'assetTypeName': 'Region',  

    'parentId': 1,  

    'enabled': True,  

    'mobile': True,  

    'iconPath': 'material/insert_emoticon'  

}  

userId = 456  

recordsModified = system.kanoa.asset.updateAssetType(assetTypeInfo, userId)
```

--------------------------------

### Delete Asset Type Example

Source: https://kanoa-software.netlify.app/systemFunctions/asset/deleteAssetType

Demonstrates the basic usage of the deleteAssetType function with assetTypeId and userId parameters.

```text
assetTypeId = 123  

userId = 456  

success, message = system.kanoa.asset.deleteAssetType(assetTypeId, userId)  
```

--------------------------------

### Update an Asset Example

Source: https://kanoa-software.netlify.app/systemFunctions/asset/updateAsset

Demonstrates retrieving a user ID and asset type ID before updating an asset's properties.

```python
userId = system.kanoa.security.getIDPUserId({'userName': 'SYSTEM'})  

assetTypeId = system.kanoa.utilities.getFieldValue('assetTypeId', system.kanoa.asset.getAssetTypes({'assetTypeName': 'enterprise'}))  

assetInfo = {  

    'assetId': 45,  

    'assetName': 'New Enterprise',  

    'parentId': None,  

    'assetTypeId': 1,  

    'assetGroupId': None,  

    'oeeEnabled': False,  

    'processTypeId': None,  

    'sortOrder': 1,  

    'enabled': True,  

    'timeZone': None  

}  

retVal, msg = system.kanoa.asset.updateAsset(assetInfo, userId)  

print retVal, msg  

>>> 1, None
```

--------------------------------

### Forced Asset Deletion Example

Source: https://kanoa-software.netlify.app/systemFunctions/asset/deleteAssetsWithForce

Demonstrates how to call the deleteAssetsWithForce function with an asset ID and user ID to remove an asset and its dependencies.

```sql
assetId = 123  

userId = 456  

success, message = system.kanoa.asset.deleteAssetsWithForce(assetId, userId)
```

--------------------------------

### Update Attribute Asset Link Example

Source: https://kanoa-software.netlify.app/systemFunctions/attribute/updateAttributeAssetLink

Demonstrates how to define the attribute asset information dictionary and call the update function.

```python
attrAssetInfo = {  

  'attributeAssetLinkId': 67,  

  'attributeId': 3,  

  'assetId': 5,  

  'sourceTagPath': '[Kanoa]Kanoa Box Co/Box Plant/Packaging/Box Line 1/QDS/Compressor1/hoa',  

  'scaleFactor': 1.0,  

  'ignoreZeroValues': True,  

  'enabled': True  

}  

userId = 123  

modifiedRecords, msg = system.kanoa.attribute.updateAttributeAssetLink(attrAssetInfo, userId)
```

--------------------------------

### Initialize an asset counter

Source: https://kanoa-software.netlify.app/systemFunctions/asset/addCounter

Example showing the initialization of a counter named 'caps' of type 'infeed' for asset ID 18.

```python
assetId = 18  

counterName = 'caps'  

counterTypeName = 'infeed'  

userId = 123  

counterId = system.kanoa.asset.addCounter(assetId, counterName, counterTypeName, userId)  
```

--------------------------------

### Get OLE Metrics

Source: https://kanoa-software.netlify.app/kanoa-ops/ole-pole-analysis

Computes OLE/POLE performance metrics based on raw seconds and production counts.

```sql
mes.fnGetOLEMetrics(@scheduledSecs INT, @loggedInSecs INT, @productiveSecs INT, @infeedCount FLOAT, @outfeedCount FLOAT, @wasteCount FLOAT, @packageCount FLOAT, @standardRate FLOAT, @period VARCHAR(50)) RETURNS TABLE
```

--------------------------------

### Add Attribute Asset Link Example

Source: https://kanoa-software.netlify.app/systemFunctions/attribute/addAttributeAssetLink

Demonstrates the structure of the attrAssetInfo dictionary and the function call to create a new attribute asset link.

```python
attrAssetInfo = {  

  'attributeId': 3,  

  'assetId': 5,  

  'sourceTagPath': '[Kanoa]Kanoa Box Co/Box Plant/Packaging/Box Line 1/QDS/Compressor1/hoa',  

  'scaleFactor': 1.0,  

  'ignoreZeroValues': True,  

  'enabled': True  

}  

userId = 123  

attributeAssetLinkId, msg = system.kanoa.attribute.addAttributeAssetLink(attrAssetInfo, userId)
```

--------------------------------

### Link Attribute to Asset Example

Source: https://kanoa-software.netlify.app/systemFunctions/attribute/setAttributeAssetLinkFromTag

Demonstrates how to define the required parameters and call the function to retrieve an attribute asset link ID.

```python
assetId = 901  

attributeName = 'British Bangers'  

tagPath = '[Kanoa]Kanoa Box Co/Box Plant/Packaging/Box Line 1/Bacon'  

attributeAssetLinkId = system.kanoa.attribute.addAttributeAssetLink(assetId, attributeName, tagPath)
```

--------------------------------

### Define _ProductionDay attribute value

Source: https://kanoa-software.netlify.app/configuration/attributes

Example of the dictionary structure used to define start and end times for the _ProductionDay reserved attribute.

```python
{'startTime': 0700, 'endTime': 1700}
```

--------------------------------

### Delete an attribute example

Source: https://kanoa-software.netlify.app/systemFunctions/attribute/deleteAttribute

Demonstrates the basic usage of the deleteAttribute function with required parameters.

```text
attributeId = 1  

userId = 123  

success, message = system.kanoa.attribute.deleteAttribute(attributeId, userId)  
```

--------------------------------

### Importing an asset configuration

Source: https://kanoa-software.netlify.app/systemFunctions/asset/importAsset

Demonstrates importing asset data using an export dictionary and specifying creation flags for modes, states, and items.

```python
exportAssetInfo = system.kanoa.asset.exportAssets(901)  

userId = 55  

createModes = 'True'  

createStates = 'True'  

createItems = 'False'  

status = system.kanoa.asset.importAsset(exportAssetInfo, userId, createModes, createStates, createItems)  
```

--------------------------------

### Update Asset State Field Example

Source: https://kanoa-software.netlify.app/systemFunctions/asset/updateStateField

Demonstrates updating the stateName field for a specific state ID.

```python
stateId = 45  

field = 'stateName'  

value = 'Really Blocked'  

userId = 5  

modifiedRecords = system.kanoa.asset.updateStateField(stateId, field, value, userId)  
```

--------------------------------

### Unlink state from asset example

Source: https://kanoa-software.netlify.app/systemFunctions/asset/unlinkAssetState

Demonstrates how to call the function with a specific stateAssetLinkId and capture the return values.

```python
stateAssetLinkId = 123  

retVal, msg = system.kanoa.asset.unlinkAssetState(stateAssetLinkId)
```

--------------------------------

### Add a Procedure Step

Source: https://kanoa-software.netlify.app/systemFunctions/cmms/addProcedureStep

Demonstrates how to construct the procedure step configuration dictionary and call the addProcedureStep function.

```python
userId = system.kanoa.security.getIDPUserId({'userName': 'SYSTEM'})  

  

stepConfig = {  

					'dataTypeId': '5',   

					'engUnitId': None,   

					'specInfo': {  

									'specType': 'setPoint',   

									'setPoint': {'operator': '>', 'value': 10},   

									'range': {'max': None, 'min': None},   

									'regex': {'value': ''},   

									'tolerance': {'tgt': None, 'lsl': None, 'usl': None, 'lel': None, 'lcl': None, 'ldl': None, 'udl': None, 'uel': None, 'ucl': None}  

								},   

								'pickListInfo': {  

													'pickListId': 8,   

													'pickListValues': {  

																	'Fraction': {'max': None, 'increment': None, 'min': None},   

																	'Text': {'WARNING': [], 'PASS': [], 'FAIL': [], 'NEUTRAL': [], 'multiSelect': False},   

																	'Time': None,   

																	'Number': {'max': None, 'increment': None, 'min': None},   

																	'Tree': '',   

																	'Barcode Scanner': {'script': None},   

																	'Boolean': {'TRUE': ['Yes'], 'FALSE': ['No']  

																}  

													}  

								}  

				}  

  

procedureStepInfo = {  

                        "procedureId": 12,  

                        "stepName": "Inspect belt tension",  

                        "stepDescription": "Visually inspect the conveyor belt for proper tension and signs of wear.",  

                        "stepConfig": system.util.jsonEncode(stepConfig),  

                        "sortOrder": 1,  

                        "estimatedMinutes": 5,  

                        "required": True,  

                        "enabled": True  

                   }  

  

procedureStepId, message = system.kanoa.cmms.addProcedureStep(procedureStepInfo, userId)  

print procedureStepId, message
```

--------------------------------

### Copy an asset using system.kanoa.asset.copyAsset

Source: https://kanoa-software.netlify.app/systemFunctions/asset/copyAsset

Demonstrates how to invoke the copyAsset function with an asset ID and user ID to generate a new asset.

```python
assetId = 123

userId = 456

newAssetId, msg = system.kanoa.asset.copyAsset(assetId, userId)
```

--------------------------------

### Retrieve attribute events

Source: https://kanoa-software.netlify.app/systemFunctions/attribute/getAttributeEvents

Example usage of the getAttributeEvents function with a dictionary containing an attribute ID and end date.

```python
paramsDict = {'attributeId': 5, 'endDate': None}  

data = system.kanoa.attribute.getAttributeEvents(paramsDict)
```

--------------------------------

### Update Asset Mode Field Example

Source: https://kanoa-software.netlify.app/systemFunctions/asset/updateAssetModeField

Demonstrates updating the 'enabled' field for a specific asset mode link.

```python
modeAssetLinkId = 123  

field = 'enabled'  

value = False  

userId = 456  

recordsModified, message = system.kanoa.asset.updateAssetModeField(modeAssetLinkId, field, value, userId)
```

--------------------------------

### Add or Update Asset Attribute

Source: https://kanoa-software.netlify.app/systemFunctions/asset/addAssetAttribute

Example usage of the addAssetAttribute function to set an attribute value for a specific asset.

```javascript
assetId = 123  

attrName = 'Attribute1'  

attrValue = 'Value1'  

userId = 456  

assetAttributeId, message = system.kanoa.asset.addAssetAttribute(assetId, attrName, attrValue, userId)  
```

--------------------------------

### Retrieve Asset States with Filters

Source: https://kanoa-software.netlify.app/systemFunctions/asset/getAssetStates

Demonstrates how to define a parameter dictionary and call the getAssetStates function to filter results.

```python
paramsDict = {'enabled': True, 'assetId': 1}  

assetStates = system.kanoa.asset.getAssetStates(stateParams)  
```

--------------------------------

### Custom Script Parameter Dictionary

Source: https://kanoa-software.netlify.app/kanoa-quality/checkSheets

Example structure of the paramsDict dictionary passed to custom Python calculation scripts.

```python
{'values': {'QR Scan': ['PIC3012017182#2237918#24011503']}
```

--------------------------------

### Define a Calendar Event Object

Source: https://kanoa-software.netlify.app/components/kanoa/calendar

Example structure for an event object used within the events array property.

```json
{

  "id": "1",

  "title": "Production Run A",

  "start": "2026-06-23T09:00:00",

  "end": "2026-06-23T11:00:00",

  "color": "#d40000",

  "contrastColor": "#ffffff"

}
```

--------------------------------

### Export Asset Configuration

Source: https://kanoa-software.netlify.app/systemFunctions/asset/exportAsset

Demonstrates how to export configuration details for a specific asset using its ID.

```text
assetId = 5  

assetExportInfo = system.kanoa.asset.exportAsset(assetId)  
```

--------------------------------

### Get Standard Rate and Period

Source: https://kanoa-software.netlify.app/kanoa-ops/ole-pole-analysis

Resolves the standard rate and period basis for an asset as of a specific point in time.

```sql
mes.fnGetStandardRateAndPeriod(@assetId INT, @asOf DATETIME)  

RETURNS TABLE (standardRate FLOAT, period VARCHAR(25))
```

--------------------------------

### Calculate OLE and POLE Metrics

Source: https://kanoa-software.netlify.app/kanoa-ops/ole-pole-analysis

Formulas for calculating availability, performance, quality, and the final OLE/POLE metrics.

```text
oleAvailability  = loggedInSecs / scheduledSecs

poleAvailability = productiveSecs / scheduledSecs

performance = rate achieved vs. standard rate, while productive

quality = yield after waste


ole  = oleAvailability  * performance * quality

pole = poleAvailability * performance * quality
```

--------------------------------

### Get Operator Attribution Share

Source: https://kanoa-software.netlify.app/kanoa-ops/ole-pole-analysis

Calculates the time-weighted share of an asset's output attributable to a specific user.

```sql
mes.fnGetOperatorAttributionShare(@userId INT, @assetId INT, @rangeStart DATETIME, @rangeEnd DATETIME, @attributionMode VARCHAR(20)) RETURNS FLOAT
```

--------------------------------

### Get Operator Productive Seconds

Source: https://kanoa-software.netlify.app/kanoa-ops/ole-pole-analysis

Calculates seconds a user was logged into an asset while the asset was in a specific run state.

```sql
mes.fnGetOperatorProductiveSeconds(@userId INT, @assetId INT, @rangeStart DATETIME, @rangeEnd DATETIME, @runStateTypeId INT) RETURNS INT
```

--------------------------------

### Get Operator Session Seconds

Source: https://kanoa-software.netlify.app/kanoa-ops/ole-pole-analysis

Calculates total seconds a user was logged into an asset within a specified range.

```sql
mes.fnGetOperatorSessionSeconds(@userId INT, @assetId INT, @rangeStart DATETIME, @rangeEnd DATETIME) RETURNS INT
```
Tokens:
Raw