--- alias: user-guide-resource-job-index description: "This documentation outlines a structured object for managing job-related materials and containers" --- # Resource Job :lock: ResourceJob.**Show** ## Overview The Resource Job is a generic object designed to manage a list of associated Materials and Containers involved in a job. It has a structured format and is divided into three key entities: * **Resource Job** - The primary entity representing the job to be performed on a **Resource**. It stores general information such as Type, Priority, and Progress, and can be linked to both **Materials** and **Containers**. * **Resource Job Material** - This entity contains detailed information about each **Material** involved in the **Resource Job**. It is embedded within the **Resource Job** and cannot be modified separately. * **Resource Job Container** - This entity holds the details of each **Container** associated with the **Resource Job**. Like the Resource Job Material, it is part of the **Resource Job** and cannot be edited independently. ## Resource Job Lifecycle The Resource Job lifecycle is represented in the diagram below. The initial states are colored in green, while the final states are colored in blue. Note that once a **Resource Job** reaches a final state, it cannot be reverted. ```mermaid graph TD Start -->|Create| A1 A1[Created] --->|Enqueue| A2[Queued] A2 ---> |Dequeue| A1 A2 --->|Start| A4[Executing] A4 --->|Requeue| A2 A4 --->|Complete| A5[Completed] A4 --->|Aborted| A6[Abort] A1 -->|Cancel| A3[Canceled] A2 --->|Cancel| A3 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_initial_state color:#000, fill:#d7e4bd, stroke:#92d050, color:#000, stroke-width:3px, font-size:100%; classDef mermaid_final_state color:#000, fill:#a7e2f2, stroke:#65CDE8, color:#000, stroke-width:3px, font-size:100%; class Title mermaid_title class Start mermaid_start class A1,A2,A4 mermaid_initial_state class A3,A5,A6,A7,A8,A9,A10,A11 mermaid_final_state ``` ## Sequence Of Steps The necessary steps for correctly using a **Resource Job** are the following: 1. Create a **Material**. 2. Create a **Container**. 3. Create a **Resource Job**. {{ generate_index() }}