--- title: "On-Premise - Frameworks System Requirements" canonical: "https://kb.myframeworks.com.au/space/FRAM/28390266/On-Premise%20-%20Frameworks%20System%20Requirements" format: markdown --- # Overview The following are minimum and recommended system requirements for Frameworks. Whilst the program will operate on the minimums listed, **we strongly suggest you meet or exceed the recommended requirements** to ensure the performance of your system is suitable for your business's operations. Please note that any environment or operating system not explicitly mentioned here should be considered not supported. The requirements for memory and processors are indicative only and more RAM or disk space may be required when running DMSi Frameworks products in conjunction with other software. Please consult a qualified network technician to ensure that your network is adequately sized and tuned for the number of users and applications used by your business. > ⚠️ **Security**: Frameworks has a comprehensive security system to ensure users access only what is mandated by company policy. Security systems control access to data, menu function and program function. DMSi consultants can assist in the setup or review of your system security to ensure it meets your company policies. --- # Frameworks System Architecture Diagram Below is the Frameworks System Architecture Diagram. The system requirements for each component will be displayed within this document. ## Core Components: - **Core Application Layer: **Windows/Linux Frameworks Application Server and Database - **Reporting Infrastructure: **Frameworks Reporting Server (handles Email & Query) - **DMZ Infrastructure: **Apache Web Server, Firewall, and Windows/Linux Web Server - **Client Access Points: **Mobile devices, Trade Portal, POS terminals & Back Office Users, Signature Pads, and Printing - **Local Printing:** Provided by the QZ Tray windows application. - **Payment Integration: **Local EFTPOS Device and EFTPOS Provider - **External Integration: **External Systems (cloud-based integrations, including Hosted - Frameworks Reporting) - **Communication Protocols: **HTTPS (SSL/TSL) - primary secure communication ![image-20251128-070131.png](media://c55a1403-47c3-4347-b160-b32f809f9657) ![image-20251202-030059.png](media://a1345071-5538-4171-a950-c22534f19e1b) --- # Linux Server Requirements Frameworks allows multiple users to run the application concurrently on different computers while accessing the same database. The data is located on a dedicated **Linux Physical Server** or **Virtual Machine**. Scaling server resources to match your site requirements is crucial for reliable and efficient operation of Frameworks. ## Hardware Specifications | | **1-5 users** | **5-25 users** | **25-75 users** | **75-200 users*** | | --- | --- | --- | --- | --- | | **Processor** | Intel Xeon E5 2.1GHz or better (4 Cores) | Intel Xeon E5 2.1GHz or better (8 Cores) | Intel Xeon E5 2.1GHz or better (12 Cores) | Intel Xeon E5 2.1GHz or better (12-24 Cores) | | **RAM** | 8GB | 8-16GB | 32GB | 64-128GB | | **Disk I/O** | 20MB/s | 20-40MB/s | 40MB/s | 200MB/s | | **Disk Storage** | 100GB | 150GB | 250GB | 500GB | | **Network** | 1Gbps TCP/IP network | 1Gbps TCP/IP network | 1Gbps TCP/IP network | 1Gbps TCP/IP network | > ℹ️ - Large Site/Multi-Site Installations: For large site or multi-site installations, engage a professional IT consultant to scale your server, implement appropriate redundancy and disaster recovery planning, and assess other IT infrastructure that may affect Frameworks performance. > ℹ️ > ℹ️ ** Disk I/O: Disk I/O is critical for optimal Frameworks performance. You can achieve the listed speeds through various technologies such as SATA, SAS or SSD in RAID-10. DMSi discourages the use of RAID-5 in any implementations. Refer to [Storage Craft RAID Performance](https://blog.storagecraft.com/raid-performance) for more information. ## Implementation Notes - **Virtualisation:** In the past, this would have been a dedicated "bare metal" stand-alone server. Today, it's nearly always virtualised—a "VM" running on a Hypervisor, typically on Microsoft Windows Server with Hyper-V, or sometimes on a VMware server. - **Hosting Options:** You can host this server on an on-premise (onsite) server or in a remote data centre or "the cloud", which has network connectivity requirements. - **Remote Access:** DMSi requires direct SSH remote access into the Linux server to install, configure and support the Frameworks application software. This includes appropriate firewall lockdown restrictions to our set of public IPs and access to the Frameworks application. - **Backup Requirements:** You need to manage a reliable backup regime with offsite copies. Refer to [https://sterlandsupport.atlassian.net/wiki/spaces/FRAM/pages/28396186](https://sterlandsupport.atlassian.net/wiki/spaces/FRAM/pages/28396186) for more information. - **Linux Support:** If Linux support is not part of your internal IT expertise, we work closely with an external provider who can assist with the Linux installation and ongoing support for the new Linux VM. --- # Windows Server Requirements Frameworks uses several Windows services to provide printing and reporting functionality, as well as web services. Typically, these services run on a virtual Windows server running on the same Hypervisor host as the Linux VM server. You require a separate dedicated Windows VM to keep the DMSi installed Windows components segregated from other applications and to allow maintenance tasks without impacting other applications. ## Hardware Specifications | | **Small** | **Medium** | **Large** | | --- | --- | --- | --- | | **Processor** | Intel Xeon E5 2.1GHz or better (4 Cores) | Intel Xeon E5 2.1GHz or better (8 Cores) | Intel Xeon E5 2.1GHz or better (12 Cores) | | **RAM** | 8GB | 8GB | 16GB | | **Disk I/O******** | 20MB/s | 20-40MB/s | 40MB/s | | **Disk Storage** | 50GB | 100GB | 150GB | | **Network** | 1Gbps TCP/IP network | > ℹ️ **** Disk I/O:** Disk I/O is critical for optimal Frameworks performance. You can achieve the listed speeds through various technologies such as SATA, SAS or SSD in RAID-10. DMSi discourages the use of RAID-5 in any implementations. Refer to [Storage Craft RAID Performance](https://blog.storagecraft.com/raid-performance) for more information. ## DMSi Installed Software The DMSi team installs the following software on this machine: - **Apache Web Service:** Supports the Frameworks Web Service. - **Frameworks Reporting:** Includes Firebird database and query report repository. ## Additional Components (Optional) Additional components which may need to be installed include: - **Frameworks Forms:** Used to build customised stationary templates for Frameworks Reporting - **Linkly EFT Service:** Provides the gateway to and from the bank when Integrated EFTPOS is purchased. - **Mitre 10 Clyx POS Manager:** For Mitre 10 sites. - **Phocas File Transfer Utility:** For sites that purchase Phocas. ## Local IT Requirements > ⚠️ **Important:** This Windows environment must be managed and maintained by your local IT resources. DMSi does not provide operating system and print queue maintenance and support. Your local IT must install the following components: - **TeamViewer:** For remote access. - **Local Mail Gateway:** For email queuing, delivery, and SMTP routing. --- # Trade Portal Web Server Option DMSi provides an optional Trade Portal component that allows your customers to log on and check prices, invoices and statements, place orders, and more. This requires an externally hosted publicly accessible Windows/Linux Apache server. DMSi has partnered with web24, a well-known hosting company, to provide a cost-effective Windows server for this purpose. ## Web24 Hosting Plans Refer to [web24](https://www.web24.com.au/) for additional information about hosting services and pricing. Most customer start with the **Windows VM 4GB** or **Linux VM 2GB** option. | | **Windows VM** | **Linux VM** | | --- | --- | --- | | **CPU** | 4 vCPU Cores | 2 vCPU Cores | | **Memory** | 4GB RAM | 2GB RAM | | **Storage** | 50GB SSD Storage* | 25GB SSD Storage* | | **Traffic** | 2000GB Traffic (Monthly) | 1000GB Traffic (Monthly) | | **IPs** | 1 IPv4 Address | 1 IPv4 Address | | **Operating System** | Windows Server 2022 x64 STD | AlmaLinux 9 | > ℹ️ *The available disk space may be less than advertised and is subject to change based on the size of the operating system and other installed software. --- # Terminal Server Option A Microsoft Terminal Server is not required for a Frameworks deployment. However, some clients choose this platform to centrally manage and deploy desktop environments to their users. Configure terminal server hardware according to Microsoft's best practices. ## Hardware Specifications | ** ** | **Minimum** | **Recommended** | | --- | --- | --- | | **Processor** | Xeon processor(s)
Maximum 4 users per Core | Xeon processor(s)
Maximum 2 users per Core | | **RAM** | Base of 16GB plus 1GB per user | Base of 32GB plus 2GB per user | | **Disk** | 200GB free | 400GB free | ## Terminal Server Operating System | **Recommended**
**and Supported**
** ** | - Windows Server 2025 (Recommended) - Windows Server 2022 - Windows Server 2019 - All with Remote Desktop Services and latest Service Pack | | --- | --- | | **Not Supported** | Operating systems not mentioned above are not supported. | > ✅ Refer to [Microsoft Lifecycle Policy](https://learn.microsoft.com/en-us/lifecycle/) for consistent and predictable guidelines about the availability of support throughout the life of Microsoft products. ## Implementation Recommendations - **Redundancy:** If you are using a terminal server in your environment, deploy multiple servers per 20 users. This provides redundancy and eases ongoing support. - **Workstation Requirements:** Contact your local IT resources for workstation requirements when using a terminal server, as they may differ from our standalone workstation requirements. --- # Workstation Requirements These are the recommendations for PC desktop hardware when Frameworks runs locally on each desktop. > ⚠️ These are not workstation requirements when a Terminal Server is used. ## Hardware Specifications | ** ** | **Minimum** | **Recommended** | | --- | --- | --- | | **Processor** | Intel Core i5 10th Generation (12MB Cache, 6 Core, 12 Thread, up to 4.3GHz) | Intel Core i5 14th Generation or later (20MB Cache, 10 Core, 16 Thread, up to 4.7GHz) | | AMD Ryzen 5 3600 (32MB Cache, 6-core, 12-thread, up to 4.2Ghz) | AMD Ryzen 5 7600 or later (32MB Cache, 6-core, 12-thread, up to 5.1Ghz) | | **RAM** | 8GB | 16GB+ | | **Disk*** | SSD (SATA or NVMe) with a minimum of 20GB Free Space | SSD (SATA or NVMe) with a minimum of 50GB Free Space | | **Network** | 1Gbps TCP/IP network | | **Display** | 1366 x 768 | 1920 x 1080 | > ℹ️ - *Actual disk size required is dependent on your corporate application installation needs.* ## Workstation Operating System (OS) | Recommended and Supported | Windows 11 Professional 24H2 or later | | --- | --- | | Not supported | Operating systems not mentioned above are not supported. | | Web Browser | The 3 common browsers are supported:
- Google Chrome - Microsoft Edge - Mozilla Firefox | > ℹ️ It is recommended to maintain latest operating system and browser updates as provided by the vendor. > ✅ Refer to [Sterland's Browser and Technology Platform Support Policy](https://sterlandsupport.atlassian.net/wiki/spaces/FRAM/pages/28390282) for additional information. ## Implementation Notes - **Browser-Based Application:** Frameworks runs in the browser. You need to deploy desktop access icons to all devices. DMSi can assist with this deployment. - **Performance Considerations:** Frameworks runs in the Chrome browser and makes heavy use of JavaScript. PCs under the recommended specifications will have sluggish performance. - **EFTPOS Integration:** Frameworks EFTPOS has been integrated using: - Windcave EFTPOS (for Australia and New Zealand) - Linkly PC-EFTPOS suite (Australia) - Skyzer Nitro-EFT (New Zealand) Terminal pin pads and bank connectivity are provided and installed by your bank. DMSi will add the Linkly DosToActiveX polling utility, providing the Frameworks integration. > ✅ Refer to [Linkly](https://linkly.com.au/) for more information about Linkly. > ✅ > ✅ Refer to [Skyzer](http://www.skyzer.co.nz/) for more information about Skyzer. ## DMSi Recommendations - **Server and PC Sizing:** Install enough processing power, RAM and hard disk space in your server or PC to cater for all applications and services that are running. These requirements may vary depending on the number of users on the system, applications running and level of usage. Consult your network technician for more details. - **Multi-Site Connectivity:** For multi-site implementations, ensure that site to site connectivity is high speed and reliable. The number one cause of multi-site rollout failures is poor planning or unreliability of inter-site connections. - **Backup Capability:** Ensure that you have an offline backup capability that is used regularly, daily at a minimum. - **Microsoft Lifecycle Policy:** DMSi follows Microsoft's product lifecycles. If Microsoft has discontinued support, so has DMSi. > ✅ Refer to [Microsoft Lifecycle Policy](https://learn.microsoft.com/en-us/lifecycle/) for consistent and predictable guidelines about the availability of support throughout the life of Microsoft products. --- # Mobile Device Requirements ## Prerequisites for Frameworks Mobile The prerequisites for implementing the Frameworks Mobile Version are: - Minimum Frameworks version 5.11 - Configuration is required to allow access to Frameworks from outside your network, as typically mobile phones do not have a VPN connection to the company network when not onsite connected to the company Wi-Fi - If not on Wi-Fi, users require either VPN or DMZ security access > ❌ **Important:** Before allowing access to Frameworks from outside your network, we strongly recommend that you review your users' password policy and enforce stronger passwords. Refer to [Additional Password validation options](https://sterlandsupport.atlassian.net/wiki/spaces/FRAM/pages/28405096) for more information. > ❌ > ❌ Technical Services needs to set up an Apache web server with a pass-through to the Frameworks server before external access can be achieved. ## Device Minimum Requirements | Devices | Type | OS | Browser | Screen Size* | Display** | RAM*** | Storage (Flash / Expansion) | Frameworks URL Parameters | | --- | --- | --- | --- | --- | --- | --- | --- | --- | | Smartphone | Android | Android 8+ | Chrome | 5" | 1280 x 720 | 2 GB | 16 GB Flash / 128 GB Expansion | **N/A** | | Smartphone | iPhone | iOS 8+ | Chrome | 5.5" | 1280 x 720 | 3 GB | 64 GB Flash / NA | **N/A** | | Handheld with scanner | Android | Android 8+ | Chrome | 5 - 7" | 1280 x 720 | 2 GB | 16 GB Flash / 128 GB Expansion | **N/A** | | Handheld with scanner
(with Physical Keypad) | Android | Android 8+ | Chrome | 4" | 800 x 400 | 2 GB | 16 GB Flash / 128 GB Expansion | **N/A** | | Tablet | Android | Android 8+ | Chrome | 10" | 1920 x 1200 | 2 GB + | 32 GB Flash / 128 GB Expansion | **[See Modifying the URL](https://sterlandsupport.atlassian.net/wiki/spaces/FRAM/pages/28410724/Mobile+Device+Configurations#%5BinlineExtension%5DModifying-the-URL)** | | Tablet | iPad | iOS 8+ | Chrome | 10.2" | 2160 x 1620 | 2 GB + | 32 GB Flash / NA | **[See Modifying the URL](https://sterlandsupport.atlassian.net/wiki/spaces/FRAM/pages/28410724/Mobile+Device+Configurations#%5BinlineExtension%5DModifying-the-URL)** | | Tablet | Windows | Windows 11 | MS Edge | 10" | 1920 x 1200 | 4 GB | 32 GB storage | **[See Modifying the URL](https://sterlandsupport.atlassian.net/wiki/spaces/FRAM/pages/28410724/Mobile+Device+Configurations#%5BinlineExtension%5DModifying-the-URL)** | | Chromebook | Chrome | Chrome OS | Chrome | 10" | 1920 x 1080 | 8 GB | 128 GB storage | **[See Modifying the URL](https://sterlandsupport.atlassian.net/wiki/spaces/FRAM/pages/28410724/Mobile+Device+Configurations#%5BinlineExtension%5DModifying-the-URL)** | | Hybrid Notebook | Windows | Windows 11 | MS Edge | 10" | 1920 x 1280 | 8 GB | 128 GB storage | **[See Modifying the URL](https://sterlandsupport.atlassian.net/wiki/spaces/FRAM/pages/28410724/Mobile+Device+Configurations#%5BinlineExtension%5DModifying-the-URL)** | | Hybrid Notebook | Surface Go | Windows 11 | MS Edge | 10" | 1920 x 1280 | 8 GB | 128 GB storage | **[See Modifying the URL](https://sterlandsupport.atlassian.net/wiki/spaces/FRAM/pages/28410724/Mobile+Device+Configurations#%5BinlineExtension%5DModifying-the-URL)** | - **Screen Size:** The screen size will differ from device to device. This is only a generic size guide. ** **Display Resolution:** Minimum/Recommend display resolutions are hard to define as there are many factors that can affect these including Scaling and Zoom. The following are some common display resolutions that in most cases will be suitable for displaying Frameworks - **HD: **1280 x 720 and is commonly known as 720p resolution. - **FHD or “Full HD”: **1920 x 1080 and is commonly known as 1080p resolution. - **WUXGA+**: 1920 x 1200 is a little step up from the most common resolution of 1080p. - **QHD or Quad HD**: 2560 x 1440 is commonly known as 1440p resolution, and it is typically seen on gaming monitors and on high-end smartphones. 1440p is four times the resolution of 720p HD or “HD ready.” To make things even more confusing, many premium smartphones feature a so-called 2960×1440 Quad HD+ resolution, which still fits into 1440p. *** **RAM: **Not all devices will have information relevant to their RAM.  **** **Storage:** The storage amounts displayed here are related to the total amount of storage available on a device and not the minimum amount of storage required to run Frameworks on a device. Flash storage if the amount of storage on the device and expansion storage is the maximum amount the device can add additionally. Expansion storage is not always required. ## Peripheral Considerations Where possible, to help you better and more easily navigate the Frameworks screen we do recommend using one or more of the following: - Stylus Pen - Bluetooth Keyboard - Bluetooth Mouse ## Browse Recommendations The following 2 browsers allow for the most customisation, when required and are available on most devices. - Google Chrome (desktop and mobile) - Microsoft Edge > ✅ Refer to [Mobile Device Configurations](https://kb.myframeworks.com.au/space/FRAM/28410724) for information about modifying the URL. --- # Printers Frameworks operates with most standard A4 laser printers that your operating system supports. ## Recommended Printer Types **Label printing**: We recommend the Zebra range of label printers. **POS docket printing**: We recommend Epson, Star or Citizen docket printers. You must connect your cash drawer via a docket printer. ## Printing Methods On-premise Frameworks installations use **QZ Tray** for printing. QZ Tray allows you to print using your local printers. Each user needs to install QZ Tray on their PC. > ⚠️ **Important**: DMSi does not manage the setup or support of printing and print queues. You and your IT support team are responsible for understanding how printing works and troubleshooting printing issues locally. > ✅ Refer to [https://sterlandsupport.atlassian.net/wiki/spaces/FRAM/pages/28378436](https://sterlandsupport.atlassian.net/wiki/spaces/FRAM/pages/28378436) for setup instructions. > ✅ > ✅ Refer to [Recommended Label Printers and Standard Labels](https://sterlandsupport.atlassian.net/wiki/spaces/FRAM/pages/28390286) for label printer specifications. --- # Network Connectivity ## Local Area Network (LAN) Ensure you have a stable LAN with adequate latency and bandwidth. **Network Hardware:** For local area networks, we recommend investing in Gigabit switches. **Cabling:** Cabling will significantly impact the reliability and speed of your software. Ensure that the cable specification (UTP Cat 5, UTP Cat5e, UTP Cat6, Fiber) is the appropriate type for the networking hardware installed. ## Wireless Networks Frameworks Mobile requires a Wi-Fi network for connectivity of mobile devices to the network, with sufficient antenna range. PDA devices must be able to connect to the IIS web service. ## Wide Area Network (WAN) To support multi-branch or multi-site environments, a business-grade network between the sites is required. We recommend a fully managed private network. --- # Additional Peripherals  ## Docket Printers Docket printers are typically connected to your POS terminals, allowing you to print receipts or dockets to customers with proof of purchase. Frameworks allows you to connect and use a range of docket printer brands. > ⚠️ **Note:** Logo printing on dockets is not set up in Frameworks. You must configure this directly on the docket printer, provided the printer allows this functionality. Refer to the printer's manual for more information and instructions. ## Cash Drawers Cash drawers generally interface off the back of docket printers and are triggered to open when a specific control code is sent to the printer. Like printers, there are several brands, such as PosiFlex. You must test the cash drawer by printing its drawer open control code from the operating system command prompt. ## Bar Code Scanners A bar code scanner connects either as a keyboard wedge between the keyboard or more commonly via USB. They send their output as a keystroke entry. As a result, their operation is transparent to Frameworks. Bar code scanners generally need configuring so that they append a carriage return. This is generally done by scanning a set of configuration bar codes found in the bar code manual. ## Signature Pads Point of Sale has the ability to integrate with electronic signature pads for the capture of account customer signatures as proof of purchase. This eliminates the filing and retrieval of signed dockets whenever a customer requires proof of pickup. When prompted, POS operators can enter a customer's name and capture their signature on a signature pad. > ✅ Refer to [Signature Pad Installation and Configuration](https://sterlandsupport.atlassian.net/wiki/spaces/FRAM/pages/28378432) for more information ## Integrated EFTPOS Frameworks leverages integrated EFTPOS by establishing a direct connection between the Frameworks software and the payment processing system, enabling real-time communication and transaction processing. This integration eliminates the need for manual entry or reconciliation of payment data, streamlining the payment process, reducing errors, and enhancing overall operational efficiency. You can accept various payment methods, such as credit cards or mobile payments, directly through the Frameworks interface, providing a secure and convenient payment experience for customers. ### Available Payment Processing Systems **Windcave**: Windcave uses APIs to push data directly to a web service. This results in a more direct and efficient method of data transfer without the need to transfer files across your network or install additional software. > ✅ Refer to [Windcave EFTPOS - Payment Processing System](https://sterlandsupport.atlassian.net/wiki/spaces/FRAM/pages/28396456) for more information about Windcave. **Linkly:** Linkly requires the following components to be installed on each workstation required to be connected to a pin pad: 1. **Linkly Client Software:** The client software manages communication to and from the pin pad and to and from the bank via a local gateway. 2. **DosToActiveX Software:** The DosToActiveX software monitors a specified location for requests which it forwards to the Linkly client software. 3. **QZ Tray (Optional):** Handles the writing of request files from the browser (Frameworks) to a specified location on the local machine. > ✅ Refer to [Configure Linkly EFTPOS](https://sterlandsupport.atlassian.net/wiki/spaces/FRAM/pages/28409048) for more information about Linkly configuration. --- # Additional Information > ✅ Refer to [Disaster Recovery for Frameworks](https://kb.myframeworks.com.au/space/FRAM/431259757/Disaster+Recovery+for+Frameworks) for additional information about backup options