Skip to main content

Getting Started with Procedures

This tutorial walks you through creating a complete procedure hierarchy for a simple example: pasteurized juice production. By the end, you will have built all four ISA-88 levels.

Prerequisites​

Before you begin, make sure you have:

  • Access to the Admin > Procedures section in OpSee
  • (Optional) Equipment classes configured, if you want to link unit procedures to specific equipment types
  • (Optional) Equipment capabilities configured, if you want to link phases to required capabilities
  • (Optional) Units of measure configured, if you want to assign units to phase parameters

Step 1 — Create Phases​

Phases are the smallest building blocks. Start by creating the individual actions your process needs.

  1. Navigate to Admin > Procedures > Phases
  2. Click the Add Phase button
  3. Fill in the form:
FieldExample valueDescription
NameSet TemperatureDisplay name for the phase
CodeHEATUnique short code (used for identification)
DescriptionHeat the tank to target temperatureOptional longer description
Duration (seconds)300Estimated duration (optional)
Required CapabilityHeatingEquipment capability needed (optional)
ActiveCheckedWhether the phase is available for use
  1. Click Create

Repeat this to create a few more phases for our example:

NameCodeDuration
Set TemperatureHEAT300s
AgitateMIX600s
HoldHOLD120s
Dose IngredientDOSE60s
DrainDRAIN180s

Add Parameters to a Phase​

Phases become powerful when you add configurable parameters. For example, the "Set Temperature" phase needs a target temperature value.

  1. In the phases list, click the settings icon (gear) on the "Set Temperature" row
  2. The Parameters dialog opens. Click Add Parameter
  3. Fill in the parameter form:
FieldExample valueDescription
NameTarget TemperatureDisplay name
Codetarget_tempUnique code within this phase
Data TypenumericOne of: numeric, text, boolean, enum
UnitdegCUnit of measure (from UOM configuration)
Default Value85Default when no recipe override is provided
Min Value20Minimum allowed value
Max Value150Maximum allowed value
RequiredCheckedWhether a value must be provided
  1. Click Create

:::tip Add parameters to each phase Add an "Agitation Speed" parameter (code: agit_speed, unit: RPM) to the Agitate phase, and a "Hold Duration" parameter (code: hold_time, unit: seconds) to the Hold phase. These parameters will later be overridden by recipes for specific products. :::

Step 2 — Create Operations​

Operations group phases into meaningful steps. An operation defines an ordered sequence of phases.

  1. Navigate to Admin > Procedures > Operations
  2. Click Add Operation
  3. Fill in the form:
FieldExample value
NameHeat and Mix
CodeHEAT_MIX
DescriptionHeat the tank and agitate until homogeneous
  1. Click Create
  1. Click the list icon on the "Heat and Mix" row to open the Manage Phases dialog
  2. Select "Set Temperature" from the dropdown and click Add
  3. Select "Agitate" and click Add
  4. Select "Hold" and click Add

The phases appear in sequence order. Use the arrow buttons to reorder them if needed. You can also toggle phases as optional using the switch.

Operation with linked phases

Create a second operation for our example:

NameCodePhases
Heat and MixHEAT_MIXSet Temperature > Agitate > Hold
Prepare IngredientsPREP_INGRDose Ingredient > Agitate

Step 3 — Create Unit Procedures​

Unit procedures group operations that run on a single equipment unit. They can optionally be linked to an equipment class.

  1. Navigate to Admin > Procedures > Unit Procedures
  2. Click Add Unit Procedure
  3. Fill in the form:
FieldExample value
NameMixing Process
CodeMIX_PROC
DescriptionComplete mixing process on the mixing tank
Equipment ClassMixing Tank (optional)
  1. Click Create
  1. Click the list icon on the "Mixing Process" row
  2. Add "Prepare Ingredients" first, then "Heat and Mix"
  3. Reorder with arrow buttons if needed

Create the unit procedures for our full example:

NameCodeEquipment ClassOperations
Mixing ProcessMIX_PROCMixing TankPrepare Ingredients > Heat and Mix
Filling ProcessFILL_PROCFiller(add filling operations)

Step 4 — Create the Batch Procedure​

The batch procedure ties everything together as the top-level process.

  1. Navigate to Admin > Procedures > Batch Procedures
  2. Click Add Batch Procedure
  3. Fill in the form:
FieldExample value
NameJuice Production
CodeJUICE_PROD
DescriptionComplete juice production process from mixing to filling
  1. Click Create
  1. Click the list icon on the "Juice Production" row
  2. Add "Mixing Process" first, then "Filling Process"
  3. Use the parallel execution toggle if unit procedures can run simultaneously on different equipment

Batch procedure with unit procedures

:::info Parallel execution The "Can Run Parallel" toggle on each unit procedure link indicates whether it can execute at the same time as other unit procedures in the batch. This is useful when different equipment units can operate independently (e.g., mixing and pasteurizing on separate tanks). :::

The Complete Hierarchy​

Here is what we built:

Next steps​

  • Add parameters to all your phases so recipes can override specific setpoints
  • Create recipes that reference this batch procedure and provide product-specific values — see Recipes
  • Link to equipment by setting equipment classes on unit procedures and capabilities on phases — see Equipment
  • Read the detailed reference pages for each level: Phases, Operations, Unit Procedures, Batch Procedures