Segments

Iotellect Monitoring MES Core includes the Segment Instantiable Model (users.%.models.recipeSegment), which defines segments — technological operations, processing cycles, and similar activities.
Segment instances are available from the root of the System Tree.

Variables

Variable: Segment Properties

The Segment variable (segment) defines the fundamental properties of a technological operation.

Field	Type	Description
type	String	Type of segment — production or one of the non-production types (see Work Order Types model)
description	String	Detailed description of the segment
executionTime	Long	Reference execution time for the segment
workflow	String	Workflow context of the segment, which defines the process of performing the operation directly on the equipment

Variable: Input Products

The Input Products variable (inputProducts) defines the input materials or components consumed by the segment. A segment may include multiple input products.

Field	Type	Description
selection	Boolean	Flag that defines how the input product is specified — fixed or flexible
product	String	Product context. This field is used when the input product is fixed and its use does not depend on external factors
productContextMask	String	Product context mask. This field is used for flexible configuration of the input product and allows specifying a group of similar products as input
costUsageExpression	String	The expression defines the conditional cost of each product limited by the productContextMask. The system evaluates the expression during automatic production planning and scheduling to choose the most cost-effective product among available equivalents. The expression returns a floating-point number that represents the conditional cost of using the product. Default context: the recipe that calls the expression. Parameters: {product} — product context for which the cost is calculated {quantity} — quantity of the product specified in the segment description. {measurementUnit} — measurement unit of the product quantity. {rootProductionEntity} — root production entity that defines the planning scope. {storageStatus} — list of storage cells and their contents at the scheduling moment. {commercialOrder} — commercial order data. {.:} — recipe used to produce the product within the planning scope.
quantity	Double	The quantity of the input product
measurementUnit	String	The measurement unit of the input product

Variable: Output Products

The Output Products variable (outputProducts) defines the output products of the segment.
A segment may have multiple output products, but only the first product in the list is considered the segment’s target output. All subsequent products are treated as production by-products or waste.

Field	Type	Description
selection	Boolean	The flag defines how the output product is set — fixed or flexible
product	String	The product context specifies the output product when its use remains constant and does not depend on external factors
productContextMask	String	The product context mask provides flexible configuration and allows defining a group of similar products as the output product
costUsageExpression	String	The expression defines the cost of using each product limited by the `productContextMask`. The expression returns a floating-point number. Default context: the recipe that calls the expression. Parameters: `{product}` — product context. `{quantity}` — product quantity. `{measurementUnit}` — measurement unit of the product quantity. `{rootProductionEntity}` — root production entity that defines the production planning area. `{storageStatus}` — storage cell contents. `{inputProducts}` — segment input products (non-variable `{commercialOrder}` — commercial order data
quantity	Double	The quantity of the output product
measurementUnit	String	The measurement unit of the output product

Variable: Production Entity

The Production Entity variable (productionEntity) defines the production entity on which the segment can be executed

Field	Type	Description
productionEntityContextMask	String	Context mask of the production entity
productionEntityValidityExpression	String	Expression that determines the suitability of the production entity. The expression returns a Boolean value. Default context: production entity
workloadExpression	String	Workload expression. The workload of a production object during segment execution determines whether multiple segments can run in parallel on the same production object. The system can calculate this expression during schedule planning based on the segment data (`{.:}`) and information about its defined input and output products (`{inputProducts}` and `{outputProducts}`)

Field

Type

Description

productionEntityContextMask

String

Context mask of the production entity

productionEntityValidityExpression

String

Expression that determines the suitability of the production entity. The expression returns a Boolean value.

Default context: production entity

workloadExpression

String

Workload expression. The workload of a production object during segment execution determines whether multiple segments can run in parallel on the same production object. The system can calculate this expression during schedule planning based on the segment data ({.:}) and information about its defined input and output products ({inputProducts} and {outputProducts})

Variable: Employees

The Employees variable (employees) defines the composition of the employee team required to execute the segment.

Field	Type	Description
name	String	Name of the role within the team
description	String	Description of the role
employeeContextMask	String	Context mask of employees suitable for performing the segment
employeeValidityExpression	String	Expression that determines employee suitability. The expression must return a Boolean value. Default context: employee context.
headCount	Integer	Number of employees assigned to the role `name` in the team.
workload	Double	Role workload. A value from 1 to 100 that defines how much of the employee’s capacity is used during segment execution and whether the employee can perform multiple parallel tasks

Variable: Tools

The Tools variable (tools) defines the tools required to execute the segment.

Field	Type	Description
name	String	Name of the tool role within the segment
description	String	Description of the tool
toolValidityExpression	String	Expression that determines tool suitability. The expression must return a Boolean value Default context: tool context
numberOfTools	Integer	Number of tools required

Core Functions

Function: Find Employees

The function returns the team roles of the segment along with a list of employees suitable for each role.

Function:	getAppropriateEmployees
Permissions:	Available at the Observer permission level
Input records:	1
Input format:	Field	Type	Description
Input format:	rootProductionEntity	String	Root production entity
Output records:	0...unlimited
Output format:	Field	Type	Description
	role	String	Role within the team
	appropriateUsers	Data Table	Contexts of users suitable for the role
	headCount	Integer	Number of employees assigned to the role
	workload	Double	Role workload
	description	String	Description of the role

Function: Get Appropriate Production Entities

The function returns a list of production entities suitable for executing the segment.

Function:	getAppropriateProductionEntity
Permissions:	Available at the Observer permission level
Input records:	1
Input format:	Field	Type	Description
Input format:	rootProductionEntity	String	Root production entity
Output records:	0...unlimited
Output format:	Field	Type	Description
	String	Production entity context

Function: Get Appropriate Tools

The function returns grouped tools suitable for executing the segment.

Function:	getAppropriateTools
Permissions:	Available at the Observer permission level
Input records:	1
Input format:	Field	Type	Description
Input format:	rootProductionEntity	String	Root production entity
Output records:	0...unlimited
Output format:	Field	Type	Description
	name	String	Name of the tool within the segment
	number	Integer	Number of tools required
	tools	Data Table	List of contexts of suitable tools

Function: Get Production Entity Workload

The function returns the workload of a specific production entity during execution of the segment with the specified input and output products.

Function:	getProductionEntityWorkload
Permissions:	Available at the Observer permission level
Input records:	1
Input format:	Field	Type	Description
	productionEntity	String	Production entity
	inputProducts	Data Table	Input products
	outputProducts	Data Table	Output products
Output records:	1
Output format:	Double

Function: Update Execution Time on Production Entities

The function updates the reference execution time of the segment in the Segment Execution Counter of the Iotellect Monitoring MES OEE module attached to production entities.

Function:	updateExecutionTimeOnProductionEntities
Permissions:	Available at the Observer permission level
Input records:	0
Input format:
Output records:	1
Output format:	null

Function: Update Target Output Product Quantity on Production Entities

The function updates the quantity of the segment’s target output product in the Segment Execution Counter of the Iotellect Monitoring MES OEE module attached to production entities.

Function:	updateProductionQuantityOnProductionEntities
Permissions:	Available at the Observer permission level
Input records:	0
Input format:
Output records:	1
Output format:	null

DPF_EXPORT_V5.8.8 / TIME_1770384962 / 2026-02-06 13:36:02 / STRLEN_53628 / STRLEN_HTML_38974

{VERSION}

Was this page helpful?