Skip to end of metadata
Go to start of metadata

 

Description

A component to calculate finish date and time of work order type schedule entries based on the start date and time, product code, change over time, quantity and configured workday routine breaks.

Properties
NameScriptingCategoryProperty TypeDescription
ScheduleIDscheduleIDDataintThe ID of the schedule entry to read from the production gateway.
Line PathlinePathDataStringThe path to the production line.
Product CodeproductCodeMiscStringProduct Code for the current schedule entry.
Schedule TypescheduleTypeMiscInt4Schedule Type for the current schedule entry.
Start Date TimestartDateTimeMiscDateTimeStart Date Time for the current schedule entry.
Run Start Date TimerunStartDateTimeMiscDateTimeRun Start Date Time for the current schedule entry.
Change Over DurationchangeOverDurationMiscInt4Duration in minutes for the change over until this run may start.
Finish Date TimefinishDateTimeMiscDateTimeFinish Date Time for the current schedule entry.
Override the Finish Date TimefinishDateTimeOverridenMiscBooleanAllows user to override the Finish Date Time for the current schedule entry.
QuantityquantityMiscInt4Quantity for the current schedule entry.
Scripting
Scripting Functions
 addScheduleEntry
  • Description

Add a new schedule entry.

  • Parameters

String linePath - The line path of the production line that this component is associated with. This is the full path name of the line starting with the project name.

Integer workOrderID - The ID of the work order to modify. This is the ID for the "WorkOrder" database table.

Integer scheduleType - The type of schedule entry.

Options:

0 = Work Order Run

1 = Maintenance

2 = Other

Date start - The starting date and time of the schedule entry.

Integer coDuration - The duration of the changeover in minutes.

Date finish - The ending date and time of the scheduled entry.

Integer quantity - The quantity of units to produce for this schedule entry.

String userName - The name of the user who is adding this scheduled entry.

String note - An optional note to be tied to this scheduled entry.

  • Return

String message - Contains a description of any error encountered, otherwise it will be empty.

  • Scope

Client

 addScheduleEntryAndReSchedule
  • Description

This script function will add a new schedule event and re-schedule any affected events.

  • Parameters

String linePath - The line path of the production line that this component is associated with. This is the full path name of the line starting with the project name.

Integer workOrderID - The ID of the work order to modify. This is the ID for the "WorkOrder" database table.

Integer scheduleType - The type of schedule entry.

Options:

0 = Work Order Run

1 = Maintenance

2 = Other

Date start - The starting date and time of the schedule entry.

Integer coDuration - The duration of the changeover in minutes.

Date finish - The ending date and time of the scheduled entry.

Integer quantity - The quantity of units to produce for this schedule entry.

String userName - The name of the user who is adding this scheduled entry.

String note - An optional note to be tied to this scheduled entry.

  • Return

String message - Contains a description of any error encountered, otherwise it will be empty.

  • Scope

Client

 editScheduleEntry
  • Description

Edit an existing schedule entry.

  • Parameters

String linePath - The line path of the production line that this component is associated with. This is the full path name of the line starting with the project name.

Integer workOrderID - The ID of the work order to modify. This is the ID for the "WorkOrder" database table.

Integer scheduleType - The type of schedule entry.

Options:

0 = Work Order Run

1 = Maintenance

2 = Other

Date start - The starting date and time of the schedule entry.

Integer coDuration - The duration of the changeover in minutes.

Date finish - The ending date and time of the scheduled entry.

Integer quantity - The quantity of units to produce for this schedule entry.

String userName - The name of the user who is adding this scheduled entry.

String note - An optional note to be tied to this scheduled entry.

 Integer scheduleID - The ID of the schedule entry to modify. This is the ID for the "Schedule" database table.

  • Return

String message - Contains a description of any error encountered, otherwise it will be empty.

  • Scope

Client

 editScheduleEntryAndReSchedule
  • Description

Edit an existing schedule entry and re-schedule any affected events.

  • Parameters

String linePath - The line path of the production line that this component is associated with. This is the full path name of the line starting with the project name.

Integer workOrderID - The ID of the work order to modify. This is the ID for the "WorkOrder" database table.

Integer scheduleType - The type of schedule entry.

Options:

0 = Work Order Run

1 = Maintenance

2 = Other

Date start - The starting date and time of the schedule entry.

Integer coDuration - The duration of the changeover in minutes.

Date finish - The ending date and time of the scheduled entry.

Integer quantity - The quantity of units to produce for this schedule entry.

String userName - The name of the user who is adding this scheduled entry.

String note - An optional note to be tied to this scheduled entry.

 Integer scheduleID - The ID of the schedule entry to modify. This is the ID for the "Schedule" database table.

  • Return

String message - Contains a description of any error encountered, otherwise it will be empty.

  • Scope

Client

 deleteScheduleEntry
  • Description

Delete an existing schedule entry.

  • Parameters

String linePath - The line path of the production line that this component is associated with. This is the full path name of the line starting with the project name.

Integer scheduleID - The ID of the schedule entry to modify. This is the ID for the "Schedule" database table.

  • Return

String message - Contains a description of any error encountered, otherwise it will be empty.

  • Scope

Client

 deleteScheduleEntryAndReSchedule
  • Description

Delete an existing schedule entry and re-schedule any affected events.

  • Parameters

String linePath - The line path of the production line that this component is associated with. This is the full path name of the line starting with the project name.

Integer scheduleID - The ID of the schedule entry to modify. This is the ID for the "Schedule" database table.

  • Return

String message - Contains a description of any error encountered, otherwise it will be empty.

  • Scope

Client

Extension Functions

This component does not have extension functions associated with it. 

Event Handlers
 mouse
 mouseClicked

This event signifies a mouse click on the source component. A mouse click the combination of a mouse press and a mouse release, both of which must have occurred over the source component. Note that this event fires after the pressed and released events have fired.

PropertyDescription
sourceThe component that fired this event.
buttonThe code for the button that caused this event to fire.
clickCountThe number of mouse clicks associated with this event.
xThe x-coordinate (with respect to the source component) of this mouse event.
yThe y-coordinate (with respect to the source component) of this mouse event.
popupTriggerReturns True (1) if this mouse event is a popup trigger. What constitutes a popup trigger is operating system dependent, which is why this abstraction exists.
altDownTrue (1) if the Alt key was held down during this event, false (0) otherwise.
controlDownTrue (1) if the Ctrl key was held down during this event, false (0) otherwise.
shiftDownTrue (1) if the Shift key was held down during this event, false (0) otherwise.
 mouseEntered

This event fires when the mouse enters the space over the source component.

PropertyDescription
sourceThe component that fired this event.
buttonThe code for the button that caused this event to fire.
clickCountThe number of mouse clicks associated with this event.
xThe x-coordinate (with respect to the source component) of this mouse event.
yThe y-coordinate (with respect to the source component) of this mouse event.
popupTriggerReturns True (1) if this mouse event is a popup trigger. What constitutes a popup trigger is operating system dependent, which is why this abstraction exists.
altDownTrue (1) if the Alt key was held down during this event, false (0) otherwise.
controlDownTrue (1) if the Ctrl key was held down during this event, false (0) otherwise.
shiftDownTrue (1) if the Shift key was held down during this event, false (0) otherwise.
 mouseExited

This event fires when the mouse leaves the space over the source component.

PropertyDescription
sourceThe component that fired this event.
buttonThe code for the button that caused this event to fire.
clickCountThe number of mouse clicks associated with this event.
xThe x-coordinate (with respect to the source component) of this mouse event.
yThe y-coordinate (with respect to the source component) of this mouse event.
popupTriggerReturns True (1) if this mouse event is a popup trigger. What constitutes a popup trigger is operating system dependent, which is why this abstraction exists.
altDownTrue (1) if the Alt key was held down during this event, false (0) otherwise.
controlDownTrue (1) if the Ctrl key was held down during this event, false (0) otherwise.
shiftDownTrue (1) if the Shift key was held down during this event, false (0) otherwise.
 mousePressed

This event fires when a mouse button is pressed down on the source component.

PropertyDescription
sourceThe component that fired this event.
buttonThe code for the button that caused this event to fire.
clickCountThe number of mouse clicks associated with this event.
xThe x-coordinate (with respect to the source component) of this mouse event.
yThe y-coordinate (with respect to the source component) of this mouse event.
popupTriggerReturns True (1) if this mouse event is a popup trigger. What constitutes a popup trigger is operating system dependent, which is why this abstraction exists.
altDownTrue (1) if the Alt key was held down during this event, false (0) otherwise.
controlDownTrue (1) if the Ctrl key was held down during this event, false (0) otherwise.
shiftDownTrue (1) if the Shift key was held down during this event, false (0) otherwise.
 mouseReleased

This event fires when a mouse button is released, if that mouse button's press happened over this component.

PropertyDescription
sourceThe component that fired this event.
buttonThe code for the button that caused this event to fire.
clickCountThe number of mouse clicks associated with this event.
xThe x-coordinate (with respect to the source component) of this mouse event.
yThe y-coordinate (with respect to the source component) of this mouse event.
popupTriggerReturns True (1) if this mouse event is a popup trigger. What constitutes a popup trigger is operating system dependent, which is why this abstraction exists.
altDownTrue (1) if the Alt key was held down during this event, false (0) otherwise.
controlDownTrue (1) if the Ctrl key was held down during this event, false (0) otherwise.
shiftDownTrue (1) if the Shift key was held down during this event, false (0) otherwise.
 mouseMotion
 mouseDragged

Fires when the mouse moves over a component after a button has been pushed.

 

PropertyDescription
sourceThe component that fired this event.
buttonThe code for the button that caused this event to fire.
clickCountThe number of mouse clicks associated with this event.
xThe x-coordinate (with respect to the source component) of this mouse event.
yThe y-coordinate (with respect to the source component) of this mouse event.
popupTriggerReturns True (1) if this mouse event is a popup trigger. What constitutes a popup trigger is operating system dependent, which is why this abstraction exists.
altDownTrue (1) if the Alt key was held down during this event, false (0) otherwise.
controlDownTrue (1) if the Ctrl key was held down during this event, false (0) otherwise.
shiftDownTrue (1) if the Shift key was held down during this event, false (0) otherwise.
 mouseMoved

Fires when the mouse moves over a component, but no buttons are pushed.

PropertyDescription
sourceThe component that fired this event.
buttonThe code for the button that caused this event to fire.
clickCountThe number of mouse clicks associated with this event.
xThe x-coordinate (with respect to the source component) of this mouse event.
yThe y-coordinate (with respect to the source component) of this mouse event.
popupTriggerReturns True (1) if this mouse event is a popup trigger. What constitutes a popup trigger is operating system dependent, which is why this abstraction exists.
altDownTrue (1) if the Alt key was held down during this event, false (0) otherwise.
controlDownTrue (1) if the Ctrl key was held down during this event, false (0) otherwise.
shiftDownTrue (1) if the Shift key was held down during this event, false (0) otherwise.
 propertyChange
 propertyChange

Fires whenever a bindable property of the source component changes. This works for standard and custom (dynamic) properties.

PropertyDescription
sourceThe component that fired this event.
newValueThe new value that this property changed to.
oldValueThe value that this property was before it changed. Note that not all components include an accurate oldValue in their events.
propertyNameThe name of the property that changed. NOTE: remember to always filter out these events for the property that you are looking for! Components often have many properties that change.
Customizers

This component does not have any custom properties.

Examples

 

An invisible component that provides adding, editing and deleting schedule entries. The term invisible component means that the control appears during design time, but is not visible during runtime. Scheduled entries are stored in the "Schedule" database table and this control handles all SQL statements, duplicate checking, etc.

Alternatively, schedule entries can be added directly into the "Schedule" database table directly, bypassing the OEE Downtime and Scheduling Module. This method supports integration to ERP or other software systems.

The properties are provided so that after the Schedule ID property is set, selection components can be bound to them to display their current values. The methods are provided to perform adding, editing and deleting of schedule entries.