---
alias: user-guide-perform-setup
description: "Configure material setup for a resource, involving steps for resource, documents, recipe, durables, and BOM data"
---

# Perform Setup

:lock: Resource.**PerformSetup**

## Overview

This operation is used to perform the required setup for a **Material**, at a particular **Resource**.

For more information, see [[user-guide-perform-line-setup]] and [[user-guide-perform-pre-setup]].

## Setup

No special set up is required other than to meet the preconditions of the transaction.

## Preconditions

* The **Resource** exists, it is Active and it is either:
    * Top-Most with the Processing Type set as Process or Line.
    * A **Resource** with the Processing Type set as Process for which the Parent **Resource** is a Top-Most **Resource** with the Processing Type set as Line and for which the **Resource** Setup Mode is different from Not Required.
* If the **Resource** Setup Mode is Not Required, you must provide a **Material** that exists, is Top-Most, is Active, and the State must be Queued or Dispatched at the **Resource**.
* If the **Resource** Setup Mode is different from Not Required and the Setup Begin and Complete Mode is Auto Begin and Complete and In Setup is `false`:
    * You must provide a Top-Most  **Material**.
* If the **Resource** Setup Mode is different from Not Required and In Setup is `true`:
    * You can provide a **Material** – if provided it must match the Current Setup **Material**.
    * The **Resource** Current Setup Type is No Changeover or Changeover.
* If the **Resource** Setup Mode is different from Not Required:
    * The Setup Begin and Complete Mode is Manual Begin And Complete, and the **Resource** In Setup must be `true`.

!!! tip
    If the Setup Mode is different from Not Required, the page and navigation within it provide a cockpit user experience (some examples are shown below), which will allow you to more easily flow between the setup entities.

!!! info
    The system automatically saves changes when you leave a cockpit tab by selecting another tab, closing the tab, or selecting Save.

    Selecting Complete Setup does not save pending changes in the current cockpit tab. Save the changes or leave the tab before completing the setup.

## Sequence Of Steps

### Step 1: Resource

This step provides basic information about the selected **Material** and **Resource**.

1. Review the information and select **Next** to continue.

![Perform Setup Step 1](images/Perform_Setup_Step1.png)

!!! note
	If the Resource has lanes configured and Is Multilane Active set to `true`, a Resource Lane section will be available, and you will have to select a valid Lane of the Resource.

If the Setup Mode is different from Not Required (see preconditions), the first tab of the **Resource** is called **Information**, and will display Setup Information and Material Information:

![Perform Setup Step 1a](images/perform_setup_step1a.png)

!!! info
    The icons used in the tabs indicate their status as follows:

    :core-static-checkoutlinecircle-lg:{ class="twemoji transparent-icon" } = Not Started

    :core-static-checkinprogress-sm:{ class="twemoji processed-icon" } = In Progress

    :core-static-checksolidcircle-sm:{ class="twemoji green-icon" } = Completed

### Step 2: Documents

!!! warning
	Only available if there are Documents associated with the Resource and State Transition Context.

This step is used to display **Documents** which are associated to the transaction context. To open a document, you need to select it.

!!! info
	Documents are configured in the Document Material Context.

![Perform Setup Step 2](images/Perform_Setup_Step2.png)

If the Setup Mode is different from Not Required (see preconditions), the **Documents** page will include all the documents that have been configured and you can freely move between them:

![Perform Setup Step 2a](images/perform_setup_step2a.png)

!!! note
    When adding a Material Context Record(s), Operation field, or a Resource Context Record(s), State Transition field, to a Document, you should only use the PerformSetupNoChangeOver option if the Resource is configured to use Different Setup Operations. Otherwise, you may not be able to view or access your Document.

### Step 3: Recipe

!!! warning
	Only available if the Resource on which the Material is being tracked in is configured to enable Recipe Management.

This step is used to visualize the Recipe along with its parameter information.

1. Review the **Recipe** and its parameters.

!!! info
	Recipes are configured in the Service Recipe Context.<br>Additionally, if the Required Service for the Material at the Resource has the property Requires Running Mode set to `true`, you must specify a valid Running Mode for the Resource. When the setup is performed for a qualification Material at the matching execution point, the list includes all Running Modes, even the ones that are otherwise unavailable because of qualifications. For more information, see [[user-guide-manage-running-modes]].

![Perform Setup Step 3](images/Perform_Setup_Step3.png)

If the Setup Mode is different from Not Required (see preconditions), the **Recipe** page will provide you with information on the recipe and its parameters, which you can access from this page:

![Perform Setup Step 3a](images/perform_setup_step3a.png)

### Step 4: Durables

!!! warning
	Only available if there are Durables required for the Material at the Step.

This step provides information about the current existing **Durables**. The required **Durables** for the **Material** at that **Step** are shown in the **Durables** step of the wizard. A green check mark is shown if the durable is configured correctly.

!!! info
	Durables are configured in the Step Durables Context.

![Perform Setup Step 4](images/Perform_Setup_Step4.png)

If the Setup Mode is different from Not Required (see preconditions), the **Durables** page will provide you with all the **Durables** information you need. The required **Durables** for the **Material** at that **Step** can be selected on this page, and a green check mark is shown if the durable is configured correctly:

![Perform Setup Step 4a](images/perform_setup_step4a.png)

### Step 5: BOM

!!! warning
	Only available if there is a BOM required for the Material at the Step and only if the Material is Top Most.

This step provides information about the existing **BOMs**, displaying details such as Bin Code, Quantity, Consumable Feed, and more. Depending on the Assembly Type, **BOM** management options may vary, as explained below.

* If the Assembly Type is Explicit or Explicit Add, the **BOM** is displayed in read-only mode and cannot be modified.

* If the Assembly Type is Automatic At TrackIn, Automatic At Track Out, or Packing, you can :material-plus: or :material-trash-can: consumable Materials from the Resource Consumable Feeds. For the same Consumable Feed, all **Materials** must have the same **Product**, **Step** and Units.

* If the **BOM** AssemblyType is Automatic At Track In or Automatic At Track Out, the system will display the Delta (Required versus Current) as the last column.

* If there is a **BOM** of scope Materials associated to a **Material** that has characteristics, the system will only display **BOM Products** that also have the same characteristics defined for the selected **Material**.

!!! info
	BOMs are configured in the Step BOM Context.

![Perform Setup Step 5](images/Perform_Setup_Step5.png)

If the Setup Mode is different from Not Required (see preconditions), the **BOM** page is called **Consumables** in this context. It will allow you direct access to the **BOM**, provide information on the **Products** and **Materials** being used and their quantities:

![Perform Setup Step 5a](images/perform_setup_step5a.png)

### Step 6: Instruments

!!! warning
    Only available if a setup Data Collection exists and the setup requires instruments.

The system displays all the **Parameters** to be measured, showing which ones have at least one available instrument and which ones do not. A list of all attached instruments to the **Resource** is also displayed.

If there is no setup **Data Collection**, the **Instruments** tab is not displayed in the cockpit.

The **Instruments** tab status is evaluated from the setup **Data Collection Instance**:

* Completed - the **Data Collection Instance** is closed or all **Parameters** can be measured.
* In Progress - some **Parameters** can be measured and some cannot.
* Not Started - all **Parameters** cannot be measured.

### Step 7: Data Collection

!!! warning
	Only available if there is a Data Collection associated with the current Material Context.

This step is used to collect data from a pre-defined **Data Collection**. The **Data Collection** is always Immediate in this operation and thus, it must be entirely filled out. A **Data Collection** may be configured to send data to SPC, in which case one or more SPC Charts will appear at the end of the operation.

Additionally, if the `LinkageStatus` with the Setup **Checklist** is `Total`, the **Data Collection** instance can be fully completed within the **Checklist** context. As a result, the **Data Collection** tab will no longer appear separately in the cockpit, avoiding redundancy.

!!! info
	Data Collections are configured in the Step Data Collection Context.

![Perform Setup Step 6](images/Perform_Setup_Step6.png)

If the Setup Mode is different from Not Required (see preconditions), the **Data Collection** page will allow you to enter Sample readings at your own pace. The **Data Collection** is always Long Running when the Setup Mode is different from Not Required. This means you can keep the page open and use the **Save** button on the top ribbon every time you make changes, hence you do not need to enter readings all in one go (the image below is of a Modern **Data Collection**):

![Perform Setup Step 6a](images/perform_setup_step6a.png)

### Step 8: Checklist

!!! warning
	Only available if there is a Checklist associated with the current Material Context.

This screen is used to complete a pre-defined **Checklist** associated with the **Perform Setup** operation. The **Checklist** is Immediate and it must be filled out completely. For more information, see [[user-guide-perform-checklist]].

!!! info
	Checklists are configured in the Step Checklist Context.

![Perform Setup Step 7](images/Perform_Setup_Step7.png)

If the Setup Mode is different from Not Required (see preconditions), the Execution Mode of the **Checklist** is always Long Running. This allows you to move away from the page and come back to it as you need to. Therefore, you do not need to execute the **Checklist** all in one go:

![Perform Setup Step 7a](images/perform_setup_step7a.png)