--- alias: user-guide-material-history-new-design tags: - reports description: "This report generates a customizable history of material data, allowing users to filter and view related information from various operational" --- # Material History (New Design) The **Material History (New Design)** report is an enhanced version of the [[user-guide-material-history-report]]. While the standard report provides a fixed set of information about any Material stored in the Operational Data Store (ODS), the new design allows users to customize which data is displayed. !!! warning If you are using Enterprise Data Platform (EDP), some sections will not be displayed. |Section|Available| |----|----| |Services| :material-check:{ style="color: #4DB6AC" }| |Data Collection| :material-check:{ style="color: #4DB6AC" } | | Checklists| :material-close:{ style="color: #EF5350" }| |Hold & Releases | :material-check:{ style="color: #4DB6AC" } | | Losses & Bonus| :material-check:{ style="color: #4DB6AC" } | | Assemble/Compose/Combine/Dispense| :material-close:{ style="color: #EF5350" }| | Protocol| :material-close:{ style="color: #EF5350" }| | Recipes|:material-close:{ style="color: #EF5350" } | | Defects| :material-check:{ style="color: #4DB6AC" } | |Attributes | :material-check:{ style="color: #4DB6AC" }| | Ship and Unship| :material-check:{ style="color: #4DB6AC" } | | Container Tracking| :material-close:{ style="color: #EF5350" }| |Production Orders | :material-check:{ style="color: #4DB6AC" } | |Attachments |:material-close:{ style="color: #EF5350" } | | Labels & Lot Travelers| :material-close:{ style="color: #EF5350" } | | Durables| :material-check:{ style="color: #4DB6AC" } | You can access this report from the **Business Intelligence** menu, as shown below. ![Material History New Design](../images/material_history_report_new_design.png) ## Filters The following filters are available: * **Material** – enter the exact name of the desired Material. * **Enterprise** – select one or more Enterprises. * **Site** – select one or more Sites. * **Facility** – select one or more Facilities. * **Area** – select one or more Areas. * **Step** – select one or more Steps. * **Begin Date** – enable the option to specify a start date using the calendar picker. * **End Date** – enable the option to specify an end date using the calendar picker. ## Report Options You can further refine the report by selecting one or more of the following sections to include: * **Services** – displays all Services associated with the Material. * **Data Collection** – displays all Data Collection instances linked to the Material. * **Checklists** – displays all the instances that were open for the Material, as well as the items of the Checklist Instance. * **Hold & Releases** – displays all Hold and Ship operations performed for the Material, as well as any recorded Losses. * **Losses & Bonus** – displays all recorded losses and bonuses for the Material. * **Assemble/Compose/Combine/Dispense** - displays all assembly and combination operations associated to the Material. * **Protocol** - displays all protocol instances that have been opened and are associated with the Material. * **Recipes** - displays all recipes associated with the Material. * **Defects** – displays all Defects recorded for the Material. * **Attributes** – lists the attributes of the selected Material. * **Ship and Unship** – lists all Ship and Unship records associated with the **Material**. * **Container Tracking** – displays all the operations related to the Container. * **Production Orders** – displays all Production Orders associated with the Material. * **Attachments** - displays all Attachments associated with the Material. * **Labels & Lot Travelers** – lists the printable documents of the selected Material. * **Durables** – displays all Durables associated with the Material. ![Example of the new material history report](../images/material_history_new_design_stimulsoft.png) !!! info For more information on how to customize this report, see [[tutorials-stimulsoft-report]]. ## Report Sections ### :mes-entitytypes-service-sm: Services Data Source: [[dataplatform-dataset-materialservices]] in DWH (ODS). This section displays all Services associated with the **Material**. ![Screenshot showing a list of services for a Material in the Material History Report.](../images/services_section.png) For every operation you are provided with: * Name of the service * User information * Date and time of the service * Name of the operation * Name of the Entity * Date and time of the operation ### :mes-entitytypes-datacollection-sm: Data Collection Data Source: [[dataplatform-dataset-datacollectioninstances]] and [[dataplatform-dataset-datacollectionreadings]] in DWH (ODS). This section displays all the Data Collection Instances associated with the **Material**. ![Screenshot showing a list of Data Collection instances for a Material in the Material History Report.](../images/collected_data_material_history.png) For every operation you are provided with: * Data Collection Instance * Material * Resource * Data Collection * Closed Date * Execution Mode * Sample * Parameter * Reading * Value * Instrument ### :mes-entitytypes-checklist-sm: Checklists Data Source: [[dataplatform-dataset-materialchecklists]], [[dataplatform-dataset-materialchecklistitems]], [[dataplatform-dataset-materialchecklistiteminstanceparameters]], [[dataplatform-dataset-materialchecklistitemdatacollectionpoints]], [[dataplatform-dataset-materialchecklistinstancebomitems]] and [[dataplatform-dataset-materialchecklistbomitemmaterials]] in DWH (ODS). The Checklists section displays all the instances that were open for the Material in their current state, and the items of the Checklist Instance and what was executed in each. ![Screenshot showing a checklist instance of a Material in the Material History Report.](../images/material_history_checklist_01.png) The section above provides the following details for each Checklist Instance: * Instance name * Data Collection Instance * System/Universal State * Checklist * Data Collection * Date Started * Standard Duration * Duration * Date Ended And the following for the Item: * Type of task and its state (example: (Manual Task) Completed) * User that performed the checklist item with date and time * Standard Duration * Signature of the user * Parameter * Value The following section provides information on the type of task and its state (example: (Manual Task) Completed): ![Screenshot showing a checklist instance of a Material in the Material History Report.](../images/checklist_section_02.png) * Data Collection Instance * Sample * Parameter * Reading * Value * Instrument * BOM Products * BOM Product * List of Material(s) and associated Quantity ### In-Process Verification Data Sources: [[dataplatform-dataset-maintenanceorderresourceoperations]], [[dataplatform-dataset-maintenanceorderchecklists]], [[dataplatform-dataset-maintenanceorderdatacollections]], [[dataplatform-dataset-maintenanceorderparts]], [[dataplatform-dataset-maintenanceorderpersonnel]] and [[dataplatform-dataset-maintenanceordercomments]] in DWH (ODS). This section displays all the operations integrated in each **In-process verification** instance. ![Screenshot showing details about an In-Process Verification in the Material History Report.](../images/material_history_ipv.png) Firstly, the following details about the **In-process verification** instance are displayed: * Instance Name * Resource associated with the verification * Created on date and time * Maintenance Plan associated For the associated **Maintenance Activity Order**, the following details are displayed: * Activity name * Expected Duration for maintenance * Current State of activity * Schedule State for the activity to start * Begin Date and Time * End Date and Time * Effective End Date and Time * Schedule Date and Time * Created On Date and Time * Cost for the maintenance ![Screenshot showing details about an In-Process Verification MAO in the Material History Report.](../images/material_history_ipv_mao.png) For every **Operation**, you are provided with: * Operation Name * Comments * User that performed the Operation * Date and Time of the Operation ![Screenshot showing details about Operations in the In-Process Verification in the Material History Report.](../images/material_history_ipv_operations.png) The **Checklists** section displays all the instances that were open with the type of task and its state * Type of task and its state (example: (Manual Task) Completed) * User that performed the checklist item with Date and Time * Standard Duration * Duration of the Checklist * A table with: * Parameter * Type * Value ![Screenshot showing details about Operations in the In-Process Verification in the Material History Report.](../images/material_history_ipv_checklist.png) For the associated **Data Collection**, you are provided with: * Data Collection Instance name * Completed On Date and Time * Data Collection entity * Limit Set * Type of collection ![Screenshot showing details about Data Collections in the In-Process Verification in the Material History Report.](../images/material_history_ipv_datacollection.png) For the associated **Parts**, you are provided with the following table: * Product * Date and Time * Optional * Planned Quantity * Current * Cost * Material * Quantity * Information Name * Information Value ![Screenshot showing details about Parts in the In-Process Verification in the Material History Report.](../images/material_history_ipv_parts.png) For the associated **Personnel**, the following details are displayed in a table: * Date * Employee * Certification the personnel might have * Type of activity performed * Exclusive * Begin Date and Time * End Date and Time * Duration * Cost of labor ![Screenshot showing details about Personnel in the In-Process Verification in the Material History Report.](../images/material_history_ipv_personnel.png) Finally, there is a **Comments** section with its content and the User with the Date and Time. ![Screenshot showing details about Comments in the In-Process Verification in the Material History Report.](../images/material_history_ipv_comments.png) ### :mes-static-hold-sm: Hold & Release Data Source: [[dataplatform-ioteventdefinition-dataset-holdrelease]] in CDM. This section displays all the Hold and Release operations performed for the **Material**. ![Screenshot showing a Hold and Release instances of a Material in the Material History Report.](../images/hold_releases_section.png) For every operation you are provided with: * Name of the operationn- Hold or Release * User information * Date and time of the operation * Name of the Material * Hold Reason * Comments ### :mes-static-record-sm: Loss & Bonus Data Source: [[dataplatform-dataset-materiallossbonus]] in DWH (ODS). This section displays all the Loss and Bonus operations performed for the **Material**. ![Screenshot showing a complex track out map with user information and loss/bonus details.](../images/loss_bonus_section.png) For every operation you are provided with: * Name of the operation * User information * Date and time of the operation * Original quantity * Final quantity * Type - Loss or Bonus * Reason for the loss or bonus * Quantity lost or gained ### Assemble/Compose/Combine/Dispense Data Source: [[dataplatform-dataset-materialassemble]] in DWH (ODS). This section describes all processes involving the selected **Material**, including assemble, compose, combine, and dispense. For every operation you are provided with: === "Assemble" * Action * User * Date and time * BOM/Assembly Type/Quantity * Material * Product * Step * Consumed Quantity * Information Name/Value === "Compose" * Action * User * Date and time * Material * Quantity * Product * Step * Consumed Quantity * Final Quantity === "Combine" * Action * User * Date and time * Material * Quantity * Product * Step * Consumed Quantity * Final Quantity === "Dispense" * Action * User * Date and time * BOM/Assembly Type/Quantity * Material * Product * Step * Instrument/Calibration Date * Weighting Mode/Tare ![Screenshot showing all Processes involving the Material in the Material History Report.](../images/assemble_section.png) ### :mes-entitytypes-protocol-sm: Protocols Data Source: [[dataplatform-dataset-materialprotocols]] in DWH (ODS). The Protocols section displays all protocol instances that have been opened and are associated with the selected **Material**. ![Screenshot showing all Protocol instances associated with a Material in the Material History Report](../images/protocols_section.png) The section above provides the following information: * Instance * Protocol * Universal State * System State * Opened By * Opened On * Current State ### :mes-entitytypes-recipe-sm: Recipes Data Source: [[dataplatform-dataset-materialtopmostrecipeinstances]], [[dataplatform-dataset-materialrecipeinstanceparameters]], and [[dataplatform-dataset-materialrecipeinstances]] in DWH (ODS). This section displays all Recipes associated with the **Material**. ![Screenshot showing a list of Recipes for a Material in the Material History Report.](../images/material_history_recipes.png) For every Recipe or Sub-Recipe you are provided with: * Instance * Recipe name (or Parent Recipe if detailing a Sub-Recipe) * User details with date and time of the service * Resource used in the recipe * Resource Recipe name Followed by a table regarding recipe parameters, with the following details: * Parameter name * Type * Value ### :mes-entitytypes-reason-sm: Defects Data Source: [[dataplatform-dataset-materialdefectsstate]] in CDM. This section displays all the Defects recorded for the **Material**. ![Screenshot showing the Material's defects in the Material History Report](../images/defects_section.png) For each defect you are provided with the following details: * User who opened the defect with date and time * User who closed the defect * Close date and time * State of the defect * Part Number * Reference * Pin Number * Location * Repair Action * Replacement Material * Sub Material ### :mes-entitytypes-material-sm: Attributes Data Source: [[dataplatform-dataset-materialattributes]] in DWH (ODS). This section lists all the Attributes of the selected **Material**. ![Screenshot showing all the Attributes of the Material in the Material History Report](../images/attributes_section.png) For every operation you are provided with: * Attribute of the Material * User information * Date and time of the operation * Value of the Material attribute ### :mes-static-ship-sm: Ship & Unship Data Source: [[dataplatform-ioteventdefinition-dataset-shipunship]] in CDM. This section displays all Ship and Unship records associated with the selected **Material**. ![Screenshot showing all Ship and Unship records associated with the Material in the Material History Report](../images/ship_and_unship.png) For every record you are provided with: * User responsible for the operation with the date and time * Material * Operation * Facility * Shipping Label * Product * Primary Quantity * Secondary Quantity ### :mes-entitytypes-container-sm: Container Tracking Data Source: [[dataplatform-dataset-materialcontainertracking]] in DWH (ODS). The Container Tracking section displays the history of all Container operations done with the **Material**. ![Screenshot showing all Container operations done with the Material in the Material History Report](../images/container_tracking_section.png) The information is shown in reverse chronological order, so the first row will display the most recent operation. The section above provides the following: * Date and time of the operation * Type of operation * Container involved in the operation * Material position in the container ### :mes-entitytypes-productionorder-sm: Production Orders Data Source: [[dataplatform-dataset-materialproductionorderchanges]] in CDM. This section displays all Production Orders associated with the **Material**. ![Screenshot showing all Production Orders associated with the Material in the Material History Report.](../images/production_orders_section.png) For every operation you are provided with: * Date and time of the operation * Information regarding the old (previous) production order * Information regarding the new order ### :core-static-attach-sm: Attachments Data Source: [[dataplatform-dataset-materialattachments]] in DWH (ODS). This section displays all the Attachments associated with the **Material**. ![Screenshot showing all the Attachments associated with the Material in the Material History Report](../images/attachments_section.png) The section above provides the following information: * Attachment * Operation * User * Date and time of the operation ### :mes-entitytypes-printabledocument-sm: Labels & Lot Travelers Data Source: [[dataplatform-dataset-materiallabelsandlottravelers]] and [[dataplatform-dataset-materiallabelsandlottravelerscontexts]] in DWH (ODS). This section displays all Printable Documents associated with the **Material**. ![Screenshot showing a list of services with an input field labeled "Name of the service".](../images/material_history_labels.png) For every document you are provided with: * Name of the document * Printer used * User that performed the operation with the date and time * Scope of the document - Label, Lot Traveler or Weigh And Dispense Label * If available, the Context field includes information about the operation, such as: * Step * Flow * Flow Path * Logical Flow Path ### :mes-entitytypes-durable-sm: Durables Data Source: [[dataplatform-dataset-materialtools]] in DWH (ODS). This section displays all the Durables associated with the **Material**. ![Screenshot showing a collection of durables.](../images/material_history_durables.png) For every operation you are provided with: * Operation where the Durable was used * User that performed the operation with the date and time * Durable Type * Durable * Position ??? question "How to display the Durables section?" Ensure the following conditions are met: * The Material is associated with a BOM of scope Durables. * The entity types `DurablesBOMInstance` and `DurablesBOMInstanceItem` have History Enabled. * The durables are properly configured in the Resource using Manage Resource Durables.