BriefElementComputed
BriefElementComputed contains computed data for individual brief elements including dimensions, CAD integration, production details, decoration summary, and finishing data. This entity stores the calculated values based on the BriefElement specifications and is used for manufacturing process planning.
Main Purpose
Section titled “Main Purpose”- Store computed dimensions (flat pack surface, CAD measurements)
- Integrate with CAD systems for design files
- Summarize decoration and printing requirements
- Calculate finishing specifications
- Provide production data (quantities, outsourcing, overhead)
- Support manufacturing process calculations
Key Properties
Section titled “Key Properties”Identification
Section titled “Identification”| Property | Type | Description |
|---|---|---|
id | UUID | Unique identifier |
position | number | Element position (0-indexed) - Matches the BriefElement position |
product_id | UUID | Product reference |
briefComputedId | UUID | Parent BriefComputed ID |
Important: The
positionproperty matches the corresponding BriefElement position. Use this to link BriefElement with its computed data:briefComputed.briefElements[position]corresponds tobrief.briefElements[position].
Computed Dimensions
Section titled “Computed Dimensions”| Property | Type | Description |
|---|---|---|
flat_pack_surface_height | number | Printed material height (mm) |
flat_pack_surface_width | number | Printed material width + glued flap (mm) |
cad_one_up_height | number | CAD computed one-up height (mm) |
cad_one_up_width | number | CAD computed one-up width (mm) |
total_rule_length | number | Digital cutting rule length (mm) |
knock_down_width | number | Flat-packed width (mm) |
knock_down_length | number | Flat-packed length (mm) |
CAD Integration
Section titled “CAD Integration”| Property | Type | Description |
|---|---|---|
cad_design_layer_key | string | Impact one-up ID or S2 design ID |
cad_project_key | string | Impact project ID |
cad_one_up_enabled | boolean | One-up CAD available |
cad_layout_enabled | boolean | Layout CAD available |
cad_standard_payload | any | CAD system payload |
Decoration Summary
Section titled “Decoration Summary”| Property | Type | Description |
|---|---|---|
references_count | number | Number of decoration variants (1-12) |
recto_color_count | number | Recto total colors |
recto_ink_percentage | number | Recto ink coverage % |
verso_color_count | number | Verso total colors |
verso_ink_percentage | number | Verso ink coverage % |
Production Data
Section titled “Production Data”| Property | Type | Description |
|---|---|---|
quantity | number | Total production quantity |
quantity_per_decoration | DecorationCount[] | Quantities per variant |
outsourcing_amount | number | Outsourced work amount (€) |
overhead_tooling | number | Tooling overhead % |
overhead_production | number | Production overhead % |
overhead_delivery | number | Delivery overhead % |
Main Relationships
Section titled “Main Relationships”| Relationship | Entity | Type | Description |
|---|---|---|---|
briefComputed | BriefComputed | Many-to-One | Parent BriefComputed |
Schema Types
Section titled “Schema Types”DieCut:
{ machineId: string; // Machine UUID layoutType: string; // Layout configuration upsPerSheet: number; // Units per sheet sheetsRequired: number; // Total sheets needed}BasicVarnish:
{ code: string; // Varnish code value: number; // Application value/coverage}Use Cases
Section titled “Use Cases”- Material Calculation: Use computed dimensions to calculate material requirements
- CAD File Integration: Access CAD keys for design file retrieval
- Production Planning: Use quantity and overhead data for scheduling
- Cost Calculation: Apply overhead percentages to production costs
- Manufacturing Process: Reference decoration and finishing data for process setup
Material Requirements Calculation Example
Section titled “Material Requirements Calculation Example”const surfaceArea = elementComputed.flat_pack_surface_height * elementComputed.flat_pack_surface_width / 1000000; // mm² to m²
const sheets = totalQuantity / blanksPerSheet;const materialWeight = surfaceArea * grammage * sheets;Linking BriefElement with BriefElementComputed
Section titled “Linking BriefElement with BriefElementComputed”The position property is the key to linking a BriefElement with its corresponding BriefElementComputed:
// Example: Linking BriefElement with BriefElementComputedconst brief = await GET('/briefs/:id/details');
// Access a BriefElementconst element = brief.briefElements[0]; // BriefElement at position 0console.log(element.position); // 0
// Access the corresponding BriefElementComputed using the same positionconst computed = brief.briefComputed.briefElements[element.position];// OR directly:const computed = brief.briefComputed.briefElements[0];
// Now you have both:// - element: Contains the client request (dimensions, materials, decoration)// - computed: Contains the computed results (CAD data, formulas, calculated dimensions)Position-based Retrieval
Section titled “Position-based Retrieval”Brief ├── briefElements[] │ ├── [0] - BriefElement (position: 0) │ ├── [1] - BriefElement (position: 1) │ └── [2] - BriefElement (position: 2) │ └── briefComputed └── briefElements[] ├── [0] - BriefElementComputed (position: 0) ← Matches BriefElement[0] ├── [1] - BriefElementComputed (position: 1) ← Matches BriefElement[1] └── [2] - BriefElementComputed (position: 2) ← Matches BriefElement[2]Accessing Data
Section titled “Accessing Data”BriefElementComputed data is nested within BriefComputed:
GET /briefs/:id/detailsReturns brief with briefComputed.briefElements array containing BriefElementComputed objects.
See Also
Section titled “See Also”- BriefElement - Original element specification
- BriefComputed - Parent computed entity
- Brief Integration Guide - Complete integration documentation