Note: Depending on your Vault’s creation date and which features are currently enabled and configured, some of the steps described in this article may be unavailable or already complete in your Vault.
) icon and deactivate the _Material_ field in the _Details_ section.
* For the _HACCP Plan Process Step_ (`haccp_plan_process_step__v`) object:
* **Detail Form Section**: Add the _Hazard Analysis Complete_ and _Hazard Analysis Complete Reason_ fields.
* **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_ and _Hazard Analysis Complete Reason_ fields.
* 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 following fields:
* _HACCP Plan Process Step Group_
* _Hazard Analysis Complete_
* _Hazard Analysis Complete Reason_
* _Hazard Analysis Type_
* _Hazard Classification Group_
* _Significant Hazard_
* Add the _Hazard Classification_ field, if relevant to your configuration
* If your organization uses a HARPC system, add the following fields:
* _Is Preventive Control required?_
* _Preventive Control Justification_
* _Type of Preventive Control_
* For the _Process Hazard Analysis - Hazard_ (`pha_hazard__v`) object:
* **Detail Form Section**: Add the _Brief Description_ field.
## HACCP Plan Lifecycle {#lifecycles}
HACCP includes the _HACCP Plan Lifecycle_ object lifecycle
, which your organization can use and customize
to suit your specific needs.
## HACCP Workflows {#workflows}
The _HACCP Plan Lifecycle_ includes standard object workflows
which your organization can use and customize
to suit your specific needs.
## Configuring HACCP Object Actions {#actions}
The _HACCP Plan_ object lifecycle contains the following standard actions:
* **[Create HACCP Plan Design from Design][2]**: 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][2]**: 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][4]**: 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 {#haccp-from-design}
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 Plan Copy Objects {#copy-objects}
All standard transactional HACCP objects
are included in HACCP deep copy actions. To include additional objects in the copy, see Configuring HACCP Plan Translation
.
### Configuring HACCP Flow Diagram Actions {#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 {#diagram}
You can configure some fields and subsections that display within the _Hazard Analyses_ section of the _Information_ panel when users perform hazard analysis from the HACCP Flow Diagram. You cannot create new sections.
### Hiding Subsections {#hide}
To hide the _Hazard Assessment_ and _Categorization of Control Measures_ subsections:
1. Navigate to **Admin > Configuration > HACCP Setup > HACCP Flow Diagram Information Panel Sections**.
2. Select the **Hazard Assessment Subsection** or **Categorization of Control Measures Subsection** record.
3. From the **All Actions** menu of the subsection record, select **Edit**.
4. Set the _Hide Section_ field to **Yes**.
5. Click **Save**.
### Configuring Fields {#fields}
To configure fields to display in the _Potential Hazard Description_ and _Hazard Assessment_ subsections:
1. Navigate to **Admin > Configuration > HACCP Setup > HACCP Flow Diagram Information Panel Sections**.
2. Select the **Potential Hazard Subsection** or **Hazard Assessment Subsection** record. Field configuration is not available for other *Hazard Analysis* subsections.
3. Under _HACCP Flow Diagram Info Panel Section Fields_, click **Create**.
4. Enter a **Name** for the section field record. This value does not display anywhere outside the Admin area and is for configuration tracking purposes only.
5. Optional: Enter a **Label** and **Description**.
6. In the **Object** field, select **Process Hazard Analysis**.
7. Enter a **Field** that exists on the _Process Hazard Analysis_ object. This value must be in the following format: `Field.[field_name__v]`, for instance, `Field.ccp__v`.
8. Enter a **Display Order**.
9. Click **Save**.
To map fields that display in the _Hazard Assessment_ subsection:
1. Under _HACCP Flow Diagram Info Panel Section Field Mappings_, select the field mapping you wish to configure. You cannot create new field mappings.
2. From the **All Actions** menu, select **Edit**.
3. Optional: Update the **Label** and **Description**.
4. Enter a **Field** on the _Process Hazard Analysis_ object from which to map the value. This value must be in the following format: `Field.[field_name__v]`, for instance, `Field.severity__v`.
5. Click **Save**.
## Configuring HACCP Document Generation {#haccp-docs}
To configure HACCP Document Generation, do the following:
* Activate the _HACCP Plan Reports_ document type.
* Create a _HACCP Template_ document template. For more information about creating a document template and configuring Merge Fields, see Managing Document Templates
, Using Merge Fields for Microsoft Word & Excel
and Configuring Merge Fields for Microsoft Word & Excel
.
* Configure the appropriate lifecycles
and workflows
for the _HACCP Plan Report_ document types
.
## Limitations {#Limitations}
HACCP has the following limitation:
* 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 {#user-permission}
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:
* To create and copy _HACCP Plans_:
* _Create_, _Edit_, and _Delete_ permissions for the _HACCP Plan_ object and all relevant _HACCP Plan_ object types.
* _Create_, _Edit_, and _Delete_ permissions for all _HACCP Plan_ related objects included in the [HACCP copy actions][13].
* _Create_, _Edit_, and _Delete_ permissions for all HACCP reference objects
.
* _Execute_ permission on the _HACCP Plan_ object for the following object actions:
* _Create HACCP Plan Design from Design_
* _Create HACCP Plan from Design_
* To view a HACCP Flow Diagram and its associated hazard analysis information, users must have the following permissions:
* _View_ permission for the _Process Flow Diagram_ (via **Admin > Users & Groups > Permission Sets > [permission set] > Pages > All Pages > Process Flow Diagram**).
* _Execute_ permission on the _HACCP Plan_ object for the following object actions:
* _Launch Process Flow Diagram_
* _Lock HACCP Flow Diagram_
* _Unlock HACCP Flow Diagram_
* _Read_ permission on the following objects or, to modify a HACCP Flow Diagram, _Create_, _Edit_, and _Delete_ permissions on the following objects:
* _CCP-Hazard Analysis_
* _HACCP Hazard Control_
* _HACCP Plan Ingredient_
* _HACCP Plan Process Step_: All object types
* _HACCP Plan Process Step Connection_: If object types are enabled for this object, users must have permission for the _Base HACCP Plan Process Step Connection_ (`base__v`) object type
* _HACCP Plan Process Step Group_
* _HACCP Plan Process Step Position_
* _HACCP Process Modification_
* _Hazard_
* _HPPSC Position_
* _Ingredient Hazard Analysis_
* _Ingredient Involved_
* _HPPS - HPPSG_
* _HPPS - PHA_
* _PHA - HHC_
* _PHA - Subsequent Steps_
* _Process Hazard Analysis_
* _Process Hazard Analysis - Hazard_
* _PRP/CM - Hazard Analysis_
* 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.
## Related Permissions {#permissions}
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. |