Click or drag to resize

Batch Class

An object representing a production directive to the factory floor. Most commonly, Batch objects are used to represent work orders (also known as production orders, manufacturing orders, etc.). In some environments, a single ERP work order is split into several smaller "batches". In this situation, a FactoryLogix Batch represents the indiviudal batches and are many to one with ERP work orders. In other environments where ERP batches are not used, a FactoryLogix Batch is one to one with ERP work orders. FactoryLogix Batches may also represent other types of factory directives, such as directive to receive, inspect, and process raw materials into the factory (represented by a Goods Receipt Note or GRN).
Inheritance Hierarchy
SystemObject
  FactoryLogix.xTend.DataObjectsBatch

Namespace:  FactoryLogix.xTend.DataObjects
Assembly:  FactoryLogix.xTend.DataObjects (in FactoryLogix.xTend.DataObjects.dll) Version: 8.245.0.0 (8.245.0.0)
Syntax
Copy
public class Batch

The Batch type exposes the following members.

Constructors
  NameDescription
Public methodBatch
Initializes a new instance of the Batch class
Top
Properties
  NameDescription
Public propertyActivationDate
An optional Date to automatically activate the Batch for production. Setting this to NULL indicates that the Batch will be activated manually.
Public propertyAssemblyConfigurationOptionId
For configure to order (CTO) production batches, the 128-bit unique identifier of the Configuration Option associated with this batch.
Public propertyAssemblyId
The 128=bit identifier of the assembly type InternalPart associated to the Process that is associated to this Batch when then the batch is a production type.
Public propertyAssemblyName
The string-based name of the assembly type InternalPart associated to the Process that is associated to this Batch when then the batch is a production type.
Public propertyAssemblyVariantId
For configure to order (CTO) production batches, the 128-bit unique identifier of the InternalPart variant associated with this batch.
Public propertyBarcodeTemplate
The name of the FactoryLogix barcode template that will be used to validate production unit barcodes (unit UID's) during initialization. For panelized PCB (printed circuit board) type assemblies, this will be the template used to validate the image (circuit) barcode. This is an optional field, and may be blank.
Public propertyBatchFileItems
A List to return the BatchFileItems saved to the batch
Public propertyBatchType
An enumerated value indicated the type of kind of this batch.
Public propertyContractNumber
An optional contract number.
Public propertyCreatedDate
The date/time when this batch was created in the system.
Public propertyCustomerName
The string-based name of the Customer associated to this batch.
Public propertyDeliveryNote
An optional delivery note
Public propertyDeliveryNoteDate
An optional delivery note date
Public propertyDeliveryNoteLineItem
An optional delivery note line item
Public propertyDescription
A human-friendly summary of the nature of this batch.
Public propertyEffectiveOptionCodes
For configure to order (CTO) production batches, a list of the product option codes associated with this batch.
Public propertyEndingSerialNumber
Used for production batches where units will be assigned unique serial numbers (UID's), and those ID's will conform to a sequential range. In this case, this property represents the last serial number of the batch. This is an optional field, and may be blank.
Public propertyFulfillmentDate
An optional Date to get or set the date the batch is expected to finish production. Setting this to NULL indicates that the Batch will be activated manually.
Public propertyId
A unique identifier for this particular batch (corresponds to the primary key in the FactoryLogix database)
Public propertyIsPanelized
A boolean value indicating whether or not the assembly associated with this batch is a panelized printed circuit board (PCB).
Public propertyLot
The lot code assigned to this batch.
Public propertyName
The human-friendly name that operators use to identify this batch within the factory. For receiving type processes, this will be the goods receipt note number (GRN). For production processes, this typically lines up with the production order number from the factory's ERP system. This property must be populated with a unique value when creating new receiving type batches.
Public propertyOptionCodes
For configure to order (CTO) production batches, a list of the product option codes associated with this batch.
Public propertyPanelBarcodeTemplate
For panelized PCB (printed circuit board) type assemblies, the name of the FactoryLogix barcode template that will be used to validate the "panel" barcode (panel UID) during initialization. This is an optional field, and may be blank.
Public propertyPlanningStatus
The current state of the batch with regards to production planning (materials planning and/or scheduling).
Public propertyPriority
The priority of the batch as compared to other batches.
Public propertyPriorityCategoryID
A unique identifier for this particular PriorityCategory (corresponds to the primary key in the PriorityCategories table)
Public propertyProcessId
The 128-bit identifier of the Process associated to this batch. When creating new batches, this property is required and must be populated with a valid Process Id of a processthat corresponds with the type of this Batch.
Public propertyProcessName
The string-based name of the Process associated to this batch.
Public propertyQuantity
The quantity of production units to be built in association with this batch (for production type batches).
Public propertyQuantityVerificationMode
An enumerated value indicating how quantities should be managed for this batch. FactoryLogix can optionally prevent operators from initializing too many production units into a batch.
Public propertyReceivingPartId
For receiving type batches (BatchType == BatchType.Receiving), the 128-bit unique identifier of the InternalPart associated with the batch. When creating new batches, this property must contain a valid InternalPart Id corresponding to the internal part number of the part being received.
Public propertyReceivingPartNumber
For receiving type batches (BatchType == BatchType.Receiving), the internal part number of the part being received.
Public propertyReceivingPartRevision
For receiving type batches (BatchType == BatchType.Receiving), the internal part revision of the part being received.
Public propertyReceivingVendorId
For receiving type batches (BatchType == BatchType.Receiving), the 128-bit unique identifier of the Vendor associated with the batch.
Public propertyResponsibleUsers
A list of the users or user groups that have been assigned as having primary responsibility over this batch.
Public propertySequence
An optional sequence
Public propertyStartingSerialNumber
Used for production batches where units will be assigned unique serial numbers (UID's), and those ID's will conform to a sequential range. In this case, this property represents the first serial number of the batch. This is an optional field, and may be blank.
Public propertyStatus
The current status of the batch.
Public propertyUnitOfIssue
The name or abbreviation of the Unit that Quantity is measured in. The string value of this property must align with one of the pre-configured unit names assigned to this attribute via the unit of measure property in the FactoryLogix configuration.
Public propertyWorkOrderId
The Id of WorkOrder with which this batch is associated.
Public propertyWorkOrderNumber
The Work Order Number for this batch, if it is associated with a work order.
Top
See Also