Work with Lists

OcxBatch is a non-GUI control that relies on an ActiveX container programming and scripting interface to make use of its capabilities. Most of the functional areas are based on presenting data in a list. You interact with these lists by displaying them in a GUI control or simply extracting data.

The lists typically have methods to perform the following tasks:

• Querying the number of items in the list

• Querying a preformatted list item based on a given index

• Querying individual fields of a list item based on a given index

• Setting the selected item in the list

The lists also typically have events for the following notifications:

• When the entire list has possibly become invalid.

• When to add an item

• When to change an item

• When to delete an item

• When to select an item

• When a list is busy being updated

You do not need all these methods and events when you work with a particular list. The necessary methods and events depend on the application requirements.

The most important aspect of working with the OcxBatch lists is that the control has complete command over them. The only authority you have is to tell the OcxBatch control to select a particular item in the list. Even then, the control fires an event back to the container to tell it to select the item in the list. Batch Manager automatically populates most of the lists, either automatically or after setting the appropriate focus.

Some of the lists are inter-related. That is, selecting an item in one (parent) list causes the views in other (child) lists to update. The container program responds to the events called by the lists of the control and instructs the control which item to select. Programs do not usually have to be concerned about any of the list inter-relationships.

The lists controlled by OcxBatch are:

• Batch Scheduling Schedule List (ScheduleSched)
  This list contains all batches in Batch Scheduler. This list is populated automatically.

• Batch Scheduling Recipe List (ScheduleRecipe)
  This list contains all recipes approved for production or approved for test in the Batch Scheduler. This list is populated when the ScheduleUpdateRecipeList method is run.

• Batch Scheduling Formula List (ScheduleFormula)
  This list contains all available formulas in the Batch Scheduler. This list is populated when ScheduleUpdateFormulaList method is run. It is also populated (or cleared) when a new Recipe is selected from the ScheduleRecipe list. The formula <default> will always be available.

• Batch Scheduling Train List (ScheduleTrain)
  This list contains all trains in the Batch Scheduler. This list is populated when the ScheduleUpdateTrainList method is run.

• Batch Scheduling Recipe State List (ScheduleState)
  This list contains all recipe states in the Batch Scheduler. This list is populated when the ScheduleUpdateStateList method is run.

• Batch Scheduling Recipe Type List (ScheduleType)
  This list contains all recipe types in the Batch Scheduler. This list is populated when the ScheduleUpdateTypeList method is run.

• Batch Execution Schedule List (BatchSched)
  This list contains all active batches in the Batch Display. This list is populated automatically. By default, all the available batches are displayed in this list. An application can also obtain a unit-centric view by providing the Batch Manager with a list of units. This is done with the BatchSetFocus method.

• Phase Execution Phase List (PhasePhase)
  This list contains all active phases for a batch or unit in the Batch Display. This list is populated when the RecipeSetCLBFocus method or the RecipeSetUnitFocus method is run.

• Phase Execution Parameter List (PhaseParam)
  This list contains all parameters for an active phase in the Batch Display. This list is populated when a phase is selected in the Phase Execution Phase List. This is a child list to the Phase Execution Phase List.

• Phase Execution Interlock List (PhaseIlock)
  This list contains all phase interlocks in the Batch Display. This list is populated when a phase is selected in the Phase Execution Phase List. This is a child list to the Phase Execution Phase List.

• Answer Questions Question List (QuestionQuest)
  This list contains all active questions in the Batch Display. This list is populated when the RecipeSetCLBFocus method or the RecipeSetUnitFocus method is run.

• Equipment Selection Instance List (SelectInst)
  This list contains all process instances that require manual unit selection in the Batch Display. This list is populated when the RecipeSetCLBFocus method or the RecipeSetUnitFocus method is run.

• Equipment Selection Equipment List (SelectEquip)
  This list contains all units available for manual unit selection for a specific process instance in the Batch Display. This list is populated when an equipment instance is selected in the Equipment Selection Instance List. This is a child list to the Equipment Selection Instance List.

• Equipment Allocation Equipment List (EquipmentEquip)
  This list contains all equipment available for manual allocation in the Batch Display. This list is populated when the EquipmentSetCLBFocus method or the EquipmentSetUnitFocus method is run.

• Equipment Allocation Instance List (EquipmentInst)
  This list contains all process and transfer instances available for manual allocation in the Batch Display. This list is populated when an equipment item is selected in the Equipment Allocation Equipment List. This is a child list to the Equipment Allocation Equipment List.

• Equipment Allocation Queue List (AllocQueue)
  This list contains all active batches waiting for a unit or connection in the allocation queue. This list is populated when the EquipmentSetCLBFocus method or the EquipmentSetUnitFocus method is run.

• Display Batch Messages Message List (MessageMsg)
  This list contains all batch messages in the Batch Display. This list is populated when the MessageSetCLBFocus method or the MessageSetUnitFocus method is run.

• Edit Phase Phase List (EditPhasePhase)
  This list contains all recipe phases available for editing in the Batch Display. This list is populated when the EditPhaseSetCLBFocus method is run. There is no unit-centric view of this list.

• Edit Phase Parameter List (EditPhaseParam)
  This list contains all recipe phase parameters available for editing in the Batch Display. This list is populated when a phase is selected in the Edit Phase Phase List. This is a child list to the Edit Phase Phase List.

• View Transition Transition List (ViewTransitionTrans)
  This list contains all active transition logic expressions in the Batch Display. This list is populated when the ViewTransitionSetCLBFocus method is run. There is no unit-centric view of this list.

• View Transition Tag List (ViewTransitionTag)
  This list contains the tags that are used in an active transition logic expression in the Batch Display. This list is populated when an active transition is selected in the View Transition Transition List. This is a child list to the View Transition Transition List.

• Display Errors Error List (ErrorErr)
  This list contains all batch error messages in the Batch Display. This list is populated automatically by Batch Manager.