---
alias: user-guide-facility-index
description: "This documentation outlines the creation and usage of a physical location within a system"
---

# Facility

:lock: Facility.**Show**

## Overview

A **Facility** corresponds to a physical shop floor location, which can be local or remote.

The following objects are assigned specifically to a **Facility**:

* [Materials](../material/index.md)
* [Containers](../container/index.md)
* [Resources](../resource/index.md)

**Materials** can only be transferred between **Facilities** via a Ship Material transaction.

## Tying Everything Together

```mermaid
graph LR
    L1[Ship To Facility] === Main[Facility]
    Main --- A1[Material]
    Main --- A2[Protocol Instance]
    Main --- A3[Container]
    Main --- A4[Data Collection Instance]
    Main --- A5[Notification]
    A6[Area] --- Main
    A7[Step] --- A6
    A8[Resource] --- A6

classDef mermaid_title color:#000, fill:#fafafa, stroke:#fafafa, stroke-width:0x, font-size:100%, font-weight:200;
classDef mermaid_start color:#000, fill:#fafafa, stroke:#fafafa, color:#fafafa, stroke-width:0x, font-size:100%, visibility: hidden;
classDef mermaid_businessdata color:#000, fill:#65CDE8, stroke:#65CDE8, stroke-width:0px, font-size:100%;
classDef mermaid_nonbusinessdata color:#000, fill:#B7DEE8, stroke:#B7DEE8, stroke-width:0px, font-size:100%;
classDef mermaid_entity color:#000, fill:#FB9F53, stroke:#FB9F53, stroke-width:0px, font-size:100%;
classDef mermaid_entitylinked color:#000, fill:#FCD5B5, stroke:#FCD5B5, stroke-width:0px, font-size:100%;
classDef mermaid_context color:#000, fill:#B9CDE5, stroke:#B9CDE5, stroke-width:0px, font-size:100%;
classDef mermaid_optional color:#000, fill:#B7DEE8, stroke:#65CDE8, stroke-width:1px, font-size:100%, stroke-dasharray: 5 5;
class Main mermaid_entity
class A1,A2,A3,A4,A5,A6,A7,A8,A9,A10,A11,A12 mermaid_businessdata
class L1,L2,L3,L4,L5,L6 mermaid_entitylinked
class C1,C2,C3,C4,C5,C6 mermaid_context
class N1,N2,N3,N4,N5,N6 mermaid_nonbusinessdata

click Main "../../business-data/facility"
click L1 "../../business-data/facility"
click A1 "../../business-data/step"
click A2 "../../business-data/protocol/protocol-instance"
click A3 "../../business-data/container"
click A4 "../../business-data/data-collection/data-collection-instance"
click A5 "../../business-data/notification"
click A6 "../../business-data/area"
click A7 "../../business-data/step"
click A8 "../../business-data/resource"
```

## Sequence Of Steps

The necessary steps for correctly creating and using a **Facility** are:

1. Optionally, create a **Calendar** to be used as default.
2. If the Facility is remote, a [Site](../site/index.md) must be created first.
3. Create the **Facility**, optionally assign a default **Calendar**.

!!! info
	**The default Calendar will be used for all the Areas created for that Facility.**

{{ generate_index() }}