Configuring HACCP Management (QMS)

QualityOne Vaults provide a management system that allows users to establish and maintain safe food production practices more efficiently using the HACCP (Hazard Analysis Critical Control Points) methodology. This allows users to ensure that food is manufactured, processed, packaged, and stored in sanitary conditions to prevent post-process contamination. Users can create HACCP plans in their Vault to define principles and procedural requirements for maintaining the HACCP system. To save time and effort, users can reuse existing HACCP plans as templates when creating new HACCP plans.

HACCP Management Objects

QualityOne uses the following objects and object types to support HACCP Management:

  • HACCP Plan (haccp_plan__v): This object represents the food safety-related procedures of a Product.
    • HACCP Plan (haccp_plan__v): This HACCP Plan object type represents the HACCP Plan for a manufacturer.
    • HACCP Plan Design (haccp_plan_design__v): This HACCP Plan object type represents the HACCP plan design template.
  • HACCP Plan Process Step (haccp_plan_process_step__v): This object represents a process step in a HACCP Plan for a specific product.
    • Process Step (process_step__v): This HACCP Plan Process Step object type represents a single step in a process.
    • Material Step (material_step__v): This HACCP Plan Process Step object type represents a step that introduces a material in a process.
    • Logistics Step (logistics_step__v): This HACCP Plan Process Step object type represents a logistics step in a process.
    • Connector (diagram_connector__v): This HACCP Plan Process Step object type represents a connector step in a process.
  • HACCP Plan Process Step Group (haccp_plan_process_step_group__v): This object represents a grouping of HACCP Plan Process Steps.
  • HACCP Plan Ingredient (haccp_plan_ingredient__v): This object represents an ingredient in a HACCP Plan for a product.
  • HACCP Plan Process Step Connection (haccp_plan_process_step_connection__v): This object represents the connection between HACCP Plan process steps by defining the input HACCP Plan process step and output HACCP Plan process step.
  • Process Hazard Analysis (process_hazard_analysis__v): This object represents the risk assessment and CCP information of a given process step in a HACCP Plan.
  • Ingredient Hazard Analysis (ingredient_hazard_analysis__v): This object represents the risk assessment and CCP information of a given ingredient in a HACCP Plan.
  • Hazard (hazard__v): This object represents a single hazard in the library of Hazards.
  • HACCP Hazard Control (haccp_hazard_control__v): This object represents control measures in a HACCP Plan.
    • CCP (ccp__v): This HACCP Hazard Control object type represents a CCP that can be reused across multiple Process Hazard Analyses in a HACCP Plan.
    • OPRP (oprp__v): This HACCP Hazard Control object type represents an OPRP that can be reused across multiple Process Hazard Analyses in a HACCP Plan.
  • CCP-Hazard Analysis (cpp_hazard_analysis__v): This object joins an Ingredient Hazard Analysis or Process Hazard Analysis in a HACCP Plan and a critical control from the library.
    • Critical Control Point (critical_control_point__v): This CCP-Hazard Analysis object type represents a hazard analysis associated with a critical control point (CCP).
    • OPRP (oprp__v): This CCP-Hazard Analysis object type represents a hazard analysis associated with an Operational Prerequisite Program (OPRP).
    • Preventive Control (preventive_control__v): This CCP-Hazard Analysis object type represents a hazard analysis associated with a preventive control.
    • Modification (modification__v): This CCP-Hazard Analysis object type represents a hazard analysis that needs modification to sufficiently control hazards.
  • PRP/CM - Hazard Analysis (prp_cm_hazard_analysis__v): This object represents a Process Hazard Analysis in a HACCP Plan and an associated critical control from the library.
    • Control Measure (control_measure__v): This CCP Library object type represents a control measure for managing hazards.
    • Prerequisite Program (prerequisite_program__v): This CCP Library object type represents a prerequisite program for managing hazards.
  • HACCP Process Modification (haccp_process_modification__v): This object represents the Modification outcome of a hazard analysis.
  • Process Step (process_step__v): This object represents a single process step in the library of all Process Steps.
    • Process Step (process_step__v): This Process Step object type represents a single step in a process.
    • Material Step (material_step__v): This Process Step object type represents a step that introduces a material in a process.
    • Logistics Step (logistics_step__v): This Process Step object type represents a logistics step in a process.
    • Connector (diagram_connector__v): This Process Step object type represents a connector step in a process.
  • Formulation (formulation__v): This object represents an ingredient in the library of all Formulations.
  • Formulation Composition (formulation_composition__v): This object represents a many-to-many self-reference to Formulation, and contains the composition that makes up a formula.
  • Process Step Connection (process_step_connection__v): This object represents the connection between an input step and an output step in a process.
  • CCP Library (cpp_library__v): This object represents a collection of established CCP.
    • CCP (ccp__v): This CCP Library object type represents a CCP.
    • Control Measure (control_measure__v): This CCP Library object type represents a control measure for managing hazards.
    • OPRP (oprp__v): This CCP Library object type represents an Operational Prerequisite Program (OPRP) for managing hazards.
    • Prerequisite Program (prerequisite_program__v): This CCP Library object type represents a prerequisite program (PRP) for managing hazards.
  • CCP-Audit (cpp_audit__v): This object represents an audit joined with a CCP.
  • Process-Process Step (process_process_step__v): This object represents the order of Process Steps included in a particular process.
  • HPPS - PHA (hpps_pha__v): This object represents the list of HACCP Plan process steps referring to a single Process Hazard Analysis.
  • Process Hazard Analysis - Hazard (pha_hazard__v): This object joins the Process Hazard Analysis and Hazard objects.
  • Ingredient Involved (hpps_hpi__v): This object represents the ingredient involved in a process step.
  • HPPSG - HPPS (hppsg_hpps__v): This object joins the HACCP Plan Process Step Group and HACCP Plan Process Step objects.
  • PHA - Subsequent Step (pha_subsequent_step__v): This object joins the HACCP Plan Process Step and Process Hazard Analysis objects.
  • PHA - HHC (pha_hhc__v): This object joins the Process Hazard Analysis and HACCP Hazard Control objects.

Configuration Overview

Configuring your Vault to use HACCP Management involves the following steps:

Configuring Objects

You must activate the HACCP Plan and HACCP Plan Design object types on the HACCP Plan object in order to run the Create HACCP Plan from Design and Create HACCP Plan Design from Design actions.

To use the HACCP Flow Diagram and perform hazard analysis, you must also activate object types for the following objects:

  • HACCP Plan Process Step
  • Process Step
  • CCP-Hazard Analysis
  • CCP Library
  • PRP/CM - Hazard Analysis
  • HACCP Hazard Control

To create HACCP Plan Process Steps from the HACCP Flow Diagram and run the Create HACCP Plan Design from Design and Create HACCP Plan from Design actions, you must enable the System manages field value (read-only) checkbox on the Name (name__v) field on the following objects:

  • CCP-Hazard Analysis
  • HACCP Plan Ingredient
  • HACCP Plan Process Step
  • Process Hazard Analysis
  • Ingredient Hazard Analysis
  • PRP/CM - Hazard Analysis
  • HACCP Hazard Control

Configuring Hazard Analysis

To perform hazard analysis using the HACCP Flow Diagram, you must ensure the following fields on the Process Hazard Analysis object are activated:

  • Significant Hazard
  • Potential Hazard Identified
  • Hazard Classification
  • Hazard Classification Group
  • Origin & Nature of the hazards
  • Risk Category
  • CCP
  • PRP
  • OPRP
  • Control Measure
  • Subsequent Step
  • Modification
  • Hazard Analysis Complete

You can define rules for showing and hiding each outcome section of a hazard analysis on the HACCP Flow Diagram. To configure, add a business rule to the following fields on the Process Hazard Analysis object:

  • CCP
  • PRP
  • OPRP
  • Control Measure
  • Subsequent Step
  • Modification

Configuring Picklists

You must configure the following picklists for categorizing and filtering hazards as part of the hazard analysis process:

  • Hazard Classification Group: Users can select from multiple values to classify a hazard on a Process Hazard Analysis and Hazard record.
  • Hazard Classification: Users can select from a list of pre-defined values determined by their selection for Hazard Classification Group to further classify a hazard.
  • Origin & Nature of the hazards: Users can select from multiple values to describe hazards in a Process Hazard Analysis record.

Configure the Hazard Classification Group or both the Hazard Classification Group and Hazard Classification picklists with values applicable to your organization’s business needs, or use the values provided in Configuring Material Verification Checklists.

If you configure both picklists, you must also configure a picklist dependency on the Hazard Classification Group picklist to make values available to select for the Hazard Classification field.

Configuring Object Layouts

HACCP Management provides a default object layout for the HACCP Plan object to allow users to create, analyze, and review food safety-related procedures. You can customize object layouts or create custom object layouts from Admin > Configuration > Objects > HACCP Plan > Layouts.

  • For the CCP-Hazard Analysis (ccp_hazard_analysis__v) object:
    • Detail Form Section: Include the HACCP Plan field so Vault can populate the HACCP Plan value from the Ingredient Hazard Analysis or Process Hazard Analysis specified in the CCP-Hazard Analysis record.
    • Related Object Section: Insert the CCP-Hazard Analysis (ccp_hazard_analysis__v) object to create a list of critical controls.
  • For the HACCP Plan (haccp_plan__v) object:
    • Related Object Section: Insert the HACCP Plan Process Step, HACCP Plan Process Ingredient, and HACCP Plan Process Step Group objects.
  • For the HACCP Plan Process Step (haccp_plan_process_step__v) object:
    • Detail Form Section: Add the Hazard Analysis Complete field.
    • Related Object Section: Insert the HACCP Plan Process Step Group (haccp_plan_process_step_group__v) object to display a list of groups associated with the process step.
  • For the HACCP Plan Process Step Group (haccp_plan_process_step_group__v) object:
    • Detail Form Section: Add the Hazard Analysis Complete field.
  • For the Hazard (hazard__v) object:
    • Detail Form Section: Add the Hazard Classification Group field. If your configuration uses the Hazard Classification field, you must also add it.
  • For the Process Hazard Analysis (process_hazard_analysis__v) object:
    • Detail Form Section: Add the Hazard Classification Group, Significant Hazard, and HACCP Plan Process Step Group fields. If your configuration uses the Hazard Classification field, you must also add it.

HACCP Management Lifecycles

HACCP Management includes the HACCP Plan Lifecycle object lifecycle, which your organization can use and customize to suit your specific needs.

HACCP Management Workflow

The HACCP Plan Lifecycle includes standard object workflows which your organization can use and customize to suit your specific needs.

Configuring HACCP Management Object Actions

The HACCP Plan object lifecycle contains the following standard actions:

  • Create HACCP Plan Design from Design: Copies the hierarchy of a HACCP Plan Design and its related records into a new set of records. The Source HACCP Plan field in the new HACCP Plan record will contain the ID of the copied HACCP Plan.
  • Create HACCP Plan from Design: Offers the same functionality as the Create HACCP Plan Design from Design action except HACCP Plan is the target object type rather than HACCP Plan Design.
  • HACCP Flow Diagram actions: Support the functionality of HACCP Flow Diagrams, enabling users to launch, lock, and unlock diagrams directly from a specific HACCP Plan.

Configuring the Create HACCP Plan from Design & Create HACCP Plan Design from Design Actions

Depending on your business needs, add these actions as a record action on the HACCP Plan object to:

  • Add these actions as user actions on any HACCP Plan Lifecycle state
  • Add these actions as entry actions on any HACCP Plan Lifecycle state

When users run the Create HACCP Plan Design from Design or Create HACCP Plan from Design actions, the Source HACCP Plan field in the new HACCP Plan record will contain the ID of the copied HACCP Plan Design. Vault does not copy:

  • System-managed fields.
  • Inactive object types.
  • Inactive object fields.
  • Any fields with the Do not copy this field in Copy Record checkbox selected.

Configuring HACCP Flow Diagram Actions

The following actions support the HACCP Flow Diagram:

  • Launch Process Flow Diagram: Allows users to launch the HACCP Flow Diagram for a HACCP Plan record.
  • Lock HACCP Flow Diagram and Unlock HACCP Flow Diagram: Prevents users from editing the HACCP Flow Diagram and unlocks the diagram so users can make updates.

To make these actions available to users on a HACCP Plan, first add them as record actions on the HACCP Plan object. You can then add these actions to the relevant HACCP Plan lifecycle states as user actions or entry actions.

Configuring the HACCP Flow Diagram

To perform hazard analysis using the Information panel on the HACCP Flow Diagram, you must configure source fields for the information displayed in the Hazard Assessment section of the Information panel. You can also configure up to three (3) fields to display in the Potential Hazard Description section of the Information panel.

To configure fields:

  1. Navigate to Admin > Configuration > User Interface > Pages > Process Flow Diagram > Side Panel Configuration.
  2. Click Edit.
  3. Select up to three (3) Hazard Analysis Fields to display in the Potential Hazard Description section.
  4. Select a field for Severity.
  5. Select a field for Likelihood. Select a field for Local likelihood.
  6. Click Save.

Configuring HACCP Document Generation

To configure HACCP Document Generation, do the following:

Limitations

HACCP Management has the following limitation:

  • The configuration of object references visible to users on the HACCP Flow Diagram cannot include tokens in the VQL criteria for dynamic reference constraint.
  • The Create HACCP Plan Design from Design and Create HACCP Plan from Design actions do not copy values stored in Attachment fields.

Configuring User Permissions

You must ensure users have the appropriate read and create permissions to access the appropriate objects and object fields in addition to the permissions outlined below:

  • For the HACCP Plan object:
    • Create, Edit, and Delete permission.
    • For the HACCP Plan object fields: if a field needs to be unique, you must enable the field to be required as well. To do so, select the Values must be unique setting and the User must always enter a value (required) setting.
  • For users to view a HACCP Flow Diagram and its associated hazard analysis information, they must have Read permission on the following objects; to modify a HACCP Flow Diagram, users must have Create, Edit, and Delete permissions on the following objects:
    • HACCP Plan Process Step
    • HACCP Plan Process Step Connection
    • HACCP Plan Ingredient
    • HACCP Plan Process Step Group
    • HACCP Plan Process Step Position
    • HPPSC Position
    • Process Hazard Analysis
    • Ingredient Hazard Analysis
    • Hazard
    • CCP-Hazard Analysis
    • Ingredient Involved
    • HPPS - PHA
    • Process Hazard Analysis - Hazard
    • HPPS - HPPSG
    • PRP/CM - Hazard Analysis
    • PHA - Subsequent Steps
    • HACCP Hazard Control
    • PHA - HHC
    • HACCP Process Modification
  • For the Create HACCP Plan Design from Design or Create HACCP Plan from Design actions: Create permissions for both the target object type and the target object.
  • To run the Generate HACCP Plan Report action, users must have the following permissions:
    • Create permission for the HACCP Plan Reports document type.
    • Create permission for the following HACCP Plan Reports document subtypes:
      • Generated HACCP Documents
      • HACCP Templates
    • Create permission for the following document classifications of the Generated HACCP Documents document subtype:
      • HACCP Flow Diagrams
      • HACCP Plan Binders
      • HACCP Plan Reports
    • Create permission for the HACCP Plan Data Documents document classification of the HACCP Templates document subtype.
    • Create permission for the HACCP Plan Binder binder.

You can complete all the steps in this article with the standard System Administrator or Vault Owner security profile. If your Vault uses custom security profiles, your profile must grant the following permissions:

Type Permission Controls
Security Profile Admin: Configuration: Document Fields: Create, Edit Ability to create and modify document fields.
Security Profile Admin: Configuration: Document Lifecycles: Edit Ability to modify document lifecycles.
Security Profile Admin: Configuration: Document Types: Edit Ability to modify document types.
Security Profile Admin: Configuration: Object Lifecycles: Create, Edit Ability to create and modify object lifecycles.
Security Profile Admin: Configuration: Object Workflows: Create, Edit Ability to create and modify object workflows.
Security Profile Admin: Configuration: Objects: Create, Edit Ability to create and modify Vault objects.
Security Profile Admin: Configuration: Templates: Create, Edit Ability to create and modify document or binder templates.