---
title: "Import MiTek Sapphire Files"
canonical: "https://kb.myframeworks.com.au/space/CO/30521862/Import%20MiTek%20Sapphire%20Files"
format: markdown
---
Import MiTek Sapphire truss design files directly into a sales order or quote, automatically mapping MiTek product codes to Frameworks timber products.
> π ## Prerequisites
> π
> π Before importing a MiTek Sapphire file:
> π
> π - Customer account must exist in Frameworks system
> π - MiTek Sapphire file must be available on your computer
> π - MiTek product code mappings must be configured in MiTek Product Types maintenance
> π - Manufactured products with Process Models must be created for truss products
> π - Timber products should be set up with appropriate specifications
## Sapphire File Import Setup
MiTek Sapphire files contain product codes defined under **ProductType** in the Truss & Panel Data. These product codes must be mapped to Frameworks products before importing files successfully.
### Configure Product Linkage
To import MiTek products successfully:
1. In **Product Maintenance, **create a manufactured product with a **Manufacturing Model **(Process Model) configured.
> β
Refer toΒ the [Process Model Maintenance](https://sterlandsupport.atlassian.net/wiki/spaces/FRAM/pages/28402124)Β for more information.
2. Navigate to **System Administration > System Setup > Sales > Mitek Product Types**.
3. Add the manufactured product to the **Mitek Product Types** table.
4. Map the Frameworks Product Code to the **ProductType** code from the MiTek file.
### Truss and Panel Member Products
For Truss & Panel Member Products, the Frameworks **Product ID** must match the **System Part Code** in the MiTek Sapphire file.
Products containing Alternate Codes (configured in Product Maintenance) in the XML file will import using the Product Code, not the Alternate Code.
## File Format and Data Import
MiTek Sapphire files are XML files containing product information and optionally customer delivery details.
### Product Details Imported
If the XML file contains product details, the following information is imported:
- Product Number
- Quantity
- Unit of Measure (UOM)
- Unit Price
- Discount Percentage (Disc %)
- Usage codes
- Tally details (if a tally product)
**Product Matching Behaviour:**
- If the Product Number exists in Frameworks but there is a product mismatch, the **Resolve Product Mapping** window displays after import, accessible by clicking the **Import** icon below the **Actions** button
- Multiple imports of the same product are consolidated automatically
- If there are multiple tallies for the same product, these are also consolidated
- Products containing Alternate Codes (configured in Product Maintenance) will import using the Product Code, not the Alternate Code
### Customer Details Imported
If the XML file contains customer details, the following information is imported:
- Customer Order Number
- Deliver To
- Address
- Suburb/City
- State
- Instructions
- Contact Name
- Contact Phone
> β οΈ **Note:** The Customer Number and Date Required fields are not imported from the XML file and must be entered manually in the sales order.
---
## Import MiTek Sapphire File
1. From the **Frameworks Menu**, navigate to **Sales > Transaction Processing > Sales Orders**.
2. Click **New** to create a new sales order or search for an existing order using the **Find** button.
3. In the **Cust No.** field, enter the customer number or click the **search** icon to find the customer.
4. Click **Actions**, then **File Imports**, then **Mitek Sapphire File**.
5. Click **Choose File**, navigate to the MiTek Sapphire file on your computer, and click **Open**.
6. Click **Upload** to import the file.
7. When the **Import Status** window displays, review the import results and click **Close**.
## Result
The **Import Status** window displays:
- Number of product lines successfully imported
- Number of unresolved import lines requiring attention
MiTek product codes that match existing Frameworks products are added to the order automatically. Product codes that don't match display in the **Resolve Product Mapping** window and require resolution before the order can be processed.
If unresolved import lines exist, the **Resolve Import **icon appears next to the **Actions** button to open the **Resolve Product Mapping** window.
---
## Reimporting MiTek Sapphire Files
When reimporting a MiTek Sapphire file after changes are made, the system updates the sales order based on the new file contents. Estimates remain unchanged, but actuals are updated for modified components.
### Non-Manufactured Products
**New non-manufactured products** in the MiTek Sapphire file are added to the sales order.
**Pre-existing non-manufactured products** that are not in the new file are removed from the sales order.
Before importing, Frameworks displays a warning: "*You won't be able to reverse Order Line [line number] delete. Do you still want to proceed?*"
- Click **Yes - Perform Save** to import the file and remove any non-manufactured products
- Click **No - Don't Save** to stop the import
### Manufactured Products
**New manufactured products** in the MiTek Sapphire file are added to the sales order. Components, tasks, and costs are also added.
**Existing manufactured products** on the sales order are updated if a match is found:
- If an existing line is found, the componentry, costing, and tasks are updated
- If an existing line is not found, the line, componentry, costing, and tasks are added
**Manufactured products not in the new file:** If manufactured products exist on the sales order but are not found in the MiTek Sapphire file, Frameworks displays a warning: "*Product [product ID] is no longer listed in the job and should be reviewed.*"
- Click **Yes - Perform Save** to proceed with the import
- Click **No - Don't Save** to stop the import and review the file
> β
## Related Tasks
> β
> β
- [Create a Sales Order](https://sterlandsupport.atlassian.net/wiki/spaces/fwksproau/pages/30529072) - How to create new sales orders
> β
- [Find an Open Sales Order or Quote](https://sterlandsupport.atlassian.net/wiki/spaces/fwksproau/pages/30520258) - How to search for existing orders
> β
- [Resolve Import Issues in Sales Orders](https://sterlandsupport.atlassian.net/wiki/spaces/fwksproau/pages/459079694) - How to resolve unmatched product codes
> β
- [Process Model Maintenance](https://sterlandsupport.atlassian.net/wiki/spaces/FRAM/pages/28402124) - Configure Process Models for manufactured products
> β
- Mitek Product Types - Configure MiTek product type mappings
---
> β οΈ **System Setting - Numeric: MitekGradeFieldLength** - Mitek Import Grade Length to extract. Enter the number of characters of the Grade field in a MiTek import file to read.