--- title: "Device Maintenance" canonical: "https://kb.myframeworks.com.au/space/FRAM/28396262/Device%20Maintenance" format: markdown --- # Overview The** Device Maintenance** option allows you to create and maintain every terminal and POS device attached to the system for the purpose of sales reporting, POS reconciliation and enquiries.** **Refer to the following processes for further information. # Accessing Device Maintenance To access **Device Maintenance**, perform the following: 1. Click the **Frameworks Menu** and navigate to **System Administration > Printers & Devices** > **Device Maintenance **in the** **navigation tree. > ℹ️ **Tip:** For faster access you can click on the Hamburger menu and type **Device Maintenance **or add Device Maintenance to **[My Shortcuts](https://sterlandsupport.atlassian.net/wiki/spaces/fwksproau/pages/30530584)** if accessed regularly. # Searching for Devices To search for specific Devices, from the **Device Maintenance **tab, perform the following: 1. Search for the Device by the **Branch **or** Device From **and** To fields, **then click **Find**. 2. The results of the search will show in the **Device Maintenance** section of the screen. # Adding a New Device To add a new device, from the **Device Maintenance **tab, perform the following: 1. Click **Add**. 2. Use your **Tab** key to move through the fields and add relevant device information.
For more information about the Device Maintenance fields, click here. **Device ID** Enter the code that refers to this device. Each device or terminal has its own Device ID which is usually determined by your IT department. > ℹ️ A Device ID with Till 999 cannot be used due to issues with this number. A warning message *"Cannot use reserved Till 999" *is displayed forcing you to select another till number. --- **Device Description** Enter the description of the device to help you to identify it. For example, Main Till. --- **Till ID** Enter the Till ID. Each till should have a number attached and this number is used to analyze sales by till. Till numbers need to be unique to a branch. --- **Branch Code** Enter the branch code for the physical location for this device. This field defaults to branch number 1 but may be overridden if required. --- **Pos Type** Entera valid POS device type. The POS device type is required so that the system knows how to execute certain functions such as printing dockets and opening the cash drawer. For example, you may have a till which is a PC or an ASCII terminal. Valid device types are PC, ASCII, IPC, TERM and 4684. --- **Pos Printer** Enter the Printer ID for this device. This field is used to identify the type of printer attached to this device. Valid responses are Star, Nuvu, Oki, IBM, and Epson. --- **Printer Address** Enter the name for the printer that this device is to print its POS dockets to. --- **Suppress Dup. POS Cash** Enable the checkbox if you do not want one docket to print for cash sales. Leave disabled if you want to print two copies, one after the other. > ℹ️ This only applies to star dockets. --- **Suppress Dup. POS Account** Enable the checkbox if you do not want one docket to print for account sales. Leave disabled if you want to print two copies, one after the other. > ℹ️ This only applies to star dockets. --- **Suppress Dup. Cash Refund** Enable the checkbox if you do not want one docket to print for cash refunds. Leave disabled if you want to print two copies, one after the other. > ℹ️ This only applies to star dockets. --- **Customized Docket** Enable the checkbox if this device is going to print customized POS stationery. Untick if you are using the ProStix standard star docket. --- **Shared Printing** Enable the checkbox if this device is sharing a printer and needs to print the docket completely at the end of POS sale. Disable the checkbox if you can print the sale docket line by line. --- **PDE Device** Enable the checkbox if you are using a PDE at POS to enter products into a sale. Disable the checkbox if you are not using a PDE at POS. --- **Scanner Input** Enable the checkbox if you are using a scanner to read barcodes at POS. Disable the checkbox if you are entering the product codes manually. Also check the scanner device and ensure the device is set to "*Tab*" to the next line after each barcode scan, rather than "*Enter*". > ℹ️ Activating this option by enabling it defaults the **Quantity** of anything scanned/entered to **1**, however you are able to override the quantity. --- **Retail Entry** Enable the checkbox if you want the pre-sale screen at POS to not display (the screen where you enter discount group/customer group etc). Disable the checkbox if you want this screen to display. --- **Cash Sale Output Type** **(Frameworks** Select the document output type for cash sales. Valid responses here are Docket or Invoice. --- **# Copies Cash Sale (Frameworks)** Select the number of copies for cash sales. --- **Cash Refund Output Type (Frameworks)** Select the document output type for cash refunds. Valid responses here are Docket or Invoice. --- **# Copies Cash Refund (Frameworks** Select the number of copies for cash refunds. --- **Account Sale Output Type** **(Frameworks)** Select the document output type for Account Sales. Valid responses here are Docket or Invoice --- **# Copies Account Sale (Frameworks** Select the number of copies for Account Sales. --- **Credit Note Output Type (Frameworks)** Select the document output type for Credit Notes. Valid responses here are Docket or Invoice. --- **# Copies Credit Note (Frameworks)** Select the number of copies for Credit Notes. --- **Print Account Receipts** Enable the checkbox if you want to print Account Receipts. This will also set the default value of the flag as it appears on the tendering of account payments based on the device maintenance setting. --- **W/Station ID** Not required --- **Sigpad Type** If using Signature Pads at POS for this Device, enter the Signature Pad type. The valid response is epadink. --- **Sigpad Port** If using Signature Pads, enter the Signature Pad TCP Port Number. The valid response is 3333. --- **Cash Drawer Type** Enter the name of the cash drawer. For example, CD128. --- **Cash Drawer Address** Enter the address of the customer display unit. For example, LPT4, /dev/lp4. --- **Eftpos Supplier** Enter the name of your Integrated Eftpos supplier. For example, Ingenico, Provenco. --- **Cut Paper Code** Enter the name of the escape code to be sent to your printer (if paper cut is available) to cut the paper when the POS docket is finished. You can find this field in ProStix under System Administration, System Set-Up, Define Devices, press F3 for valid responses: ![image-20240911-085456.png](media://ae57f051-4436-465e-bc75-7af1353969cd) --- **Stock Location** Type in the default stock location for this device. ---
> ℹ️ If updating multiple devices, you can export all devices from Frameworks into Excel, then make your changes and reimport them back into Frameworks. Refer to [Advanced Grid Features](https://sterlandsupport.atlassian.net/wiki/spaces/fwksproau/pages/30509842) for further information. 3. Once all the required fields are updated click **Save**. 4. Repeat **steps 2** and **3 **to add multiple devices. # Maintaining a Device To make changes to a **Device**, from the **Device Maintenance **tab**,** perform the following: 1. **Search **for the Device. 2. **Click** on the relevant device information fields to make any changes. 3. Once all the changes are made click **Save**. To delete a **Device**, from the **Device Maintenance **tab**,** perform the following: 1. **Search **for the Device. 2. Highlight the appropriate device, by clicking on any of the devices fields. 3. Click **Remove**. # Import Device Definitions via .csv Users can also bulk add a range of device ID's and definitions via a .csv import utility. To import devices perform the following: 1. From the **Device Maintenance Dashboard** select from the **Actions** button and the **Import** option. 2. You will be prompted with the following **Import Criteria** options: 3. Enable **Download Template Only (No Data)** and click **Download Template** to extract a .csv template (deviceImport.csv) format which can be used to populate and import device data. > ℹ️ Leave disabled to export the current device ID settings if you wish to modify existing records. 4. Add/update the required device definitions and save the .csv file ready for importing. 5. Click **Upload CSV**, choose the file created in step 4 and click the** Upload** button. 6. Confirm the processing options. - **Override existing records: Disabled by default.** Leave disabled to append to the existing definitions. Enable the checkbox to replace the current device definitions with the contents of the csv. - **Report Only**: **Enabled by default**. Enable the checkbox to produce a report only of the device ID changes to be made without processing the changes themselves. > ⚠️ **Override existing records** must be disabled in order to **only **produce a report without making the changes in the system. 7. On the **Output** page, under the **Generated Reports** section, click on the **deviceImport.html** link to review the import. 8. An information box will pop up advising that the task has been submitted. 9. Click on **OK**. 10. Click **Submit** to run the import program. > ℹ️ If the** Report Only** processing option was enabled and there were no errors in the generated report repeat steps 5 - 10 and disabled **Report Only**. If there were any error in the generate report, resolve the errors before importing. 11. Click on the **Close **button in the bottom right to complete the task.