---
title: "Equipment Object Functions - Tag Collector"
id: "equipment-object-functions-tag-collector"
project: "MES User Manual"
url: "https://docs.sepasoft.com/articles/user-manual/equipment-object-functions-tag-collector"
updated: 2026-07-31T14:56:24Z
---

# Equipment Object Functions \- Tag Collector

**Sepasoft MES Module Suite**

###  Equipment Object Functions | Tag Collectors

The following functions are associated with the Tag Collector Complex Property (expand the table below for a list of all Tag Collector names and the proper name to use for scripting):

* [Tag Collector Property Names for Scripting](/articles/user-manual/equipment-object-functions-tag-collector/a/h4_29585772)
* [getTagPath()](/articles/user-manual/equipment-object-functions-tag-collector/a/h4__769359974)
* [hasTagPath()](/articles/user-manual/equipment-object-functions-tag-collector/a/h4__1982461690)
* [setTagPath(tagPath)](/articles/user-manual/equipment-object-functions-tag-collector/a/h4__204356029)

* * *
 ####  Tag Collector Property Names for Scripting
 The available Tag Collector Property names for use in scripting are:
 | Tag Name <br>(in MES Equipment Manager) | Tag Collector Property Name <br>(for scripting) |
| --- | --- |
| Active Recipe | Active Recipe |
| Cycle Count | Equipment Cycle Count |
| Infeed Count Scale | Equipment Infeed Count Scale |
| Infeed Units | Equipment Infeed Units |
| Mode | Equipment Mode |
| Note | Equipment Note |
| Operation UUID | Equipment Operation UUID |
| Outfeed Units | Equipment Outfeed Units |
| Package Count | Equipment Package Count |
| Product Code | Equipment Product Code |
| Rate Period | Equipment Rate Period |
| Reject Count Scale | Equipment Reject Count Scale |
| Reject Units | Equipment Reject Units |
| Shift | Equipment Shift |
| Standard Rate | Equipment Standard Rate |
| State | Equipment State |
| Work Order | Equipment Work Order |
| Recipe Enabled | Recipe Enabled |
| Recipe Scale | Recipe Scale |
 ####  getTagPath()
 **Description**
 Gets the Tag Path assigned to this Tag Collector Complex Property.
 **Syntax**
 **getTagPath()**

* Parameters

None

* Returns

String tagPath - The Tag Path assigned to this Tag Collector Complex Property.

* Scope

All
 | 1<br> 2<br> 3<br> 4<br> 5 | `#Get Tag Path for Infeed Units on Test Cell`<br> `cell_path ``=` `"New Enterprise\Site\Area\Test Line\Test Cell"`<br> `cell_obj ``=` `system.mes.loadMESObjectByEquipmentPath(cell_path)`<br> `cell_property ``=` `cell_obj.getComplexProperty(``'TagCollector'``, ``'Equipment Infeed Units'``)`<br> `print` `cell_property.getTagPath()` |
| --- | --- |
 **Output**
 [default]New Enterprise/Site/Area/Test Line/Test Cell/Units
 #### hasTagPath()
 **Description**
 Returns True if there is a Tag Path assigned to this Tag Collector Complex Property.
 **Syntax**
 **hasTagPath()**

* Parameters

None

* Returns

boolean  hasTagPath - True if there is a Tag Path assigned to this Tag Collector Complex Property.

* Scope

All
 | 1<br> 2<br> 3<br> 4<br> 5 | `#Check the existence of a Tag Path for Infeed Units on Test Cell`<br> `cell_path ``=` `"New Enterprise\Site\Area\Test Line\Test Cell"`<br> `cell_obj ``=` `system.mes.loadMESObjectByEquipmentPath(cell_path)`<br> `cell_property ``=` `cell_obj.getComplexProperty(``'TagCollector'``, ``'Equipment Infeed Units'``)`<br> `print` `cell_property.hasTagPath()` |
| --- | --- |
 **Output**
 True
 #### setTagPath(tagPath)
 **Description**
 Sets the Tag Path for this Tag Collector Complex Property.
 **Syntax**
 **setTagPath(tagPath)**

* Parameters

String tagPath - The Tag Path to set for this Tag Collector Complex Property.

* Returns

None

* Scope

All
 | 1<br> 2<br> 3<br> 4<br> 5<br> 6<br> 7 | `#Set Tag Path for Shift`<br> `shiftTagPath ``=` `"[default]New Enterprise/Site/Area/Test Line/Test Cell/Shift"`<br> `cell_path ``=` `"New Enterprise\Site\Area\Test Line\Test Cell"`<br> `cell_obj ``=` `system.mes.loadMESObjectByEquipmentPath(cell_path)`<br> `cell_property ``=` `cell_obj.getComplexProperty(``'TagCollector'``, ``'Equipment Shift'``)`<br> `cell_property.setTagPath(shiftTagPath)`<br> `system.mes.saveMESObject(cell_obj)` |
| --- | --- |
 **Output**
 The Shift property as viewed in the Tag Collectors section of 'Test Cell' (in the MES Equipment Manager component):
 
![](https://help.sepasoft.com/docs/download/attachments/39979199/image2020-11-13_16-19-43.png?version=1&amp;modificationDate=1605313185000&amp;api=v2)

This object inherits the [AbstractMESComplexProperty](/articles/user-manual/abstractmescomplexproperty) functions.

**Sepasoft MES Module Suite**