W
Shuwaki Worxpace

Worxpace documentation

Run the work.
Know the system.

Practical guidance for installing Worxpace, making sales, managing stock, controlling access and keeping offline devices synchronized.

Desktop Windows 10+Current line 2.7Architecture Offline-first
01

Getting started

Install Worxpace on Windows.

Worxpace 2.7 is a Windows desktop application that keeps its operational data locally and synchronizes with the server in the background when a connection is available.

  1. 1

    Check the computer

    Use a 64-bit computer running Windows 10 or later. The current installer requires the Microsoft .NET 8 Desktop Runtime.

  2. 2

    Install the runtime

    If Windows reports that the required framework is missing, install the .NET 8 Desktop Runtime for Windows x64, then reopen the Worxpace installer.

  3. 3

    Install Worxpace

    Download the latest installer from the Releases page. Close any running copy of Worxpace, run the installer, and follow the Windows prompts.

  4. 4

    Keep site configuration outside the install folder

    Installation defaults are replaced during upgrades. Site-specific settings belong in %ProgramData%\Worxpace Offline\appsettings.json. The installation’s generated device identity is stored separately in %ProgramData%\Worxpace Offline\device.json.

02

First workspace

Prepare the business before the first sale.

A usable workspace needs a company, at least one location, users, cash accounts and inventory. Complete these in that order so later records have the correct ownership.

1

Company information

Open Settings → Company Information. Enter the trading name, contact information and receipt details. These values identify the business on printed transactions.

2

Business locations

Open Settings → Business Locations. Create every branch or operational site that will own stock and transactions.

3

Cash accounts

Open Control Panel → Cash Accounts. Create the cash or bank accounts used for receipts, payments and transfers.

4

People and access

Open Control Panel → Users & Security. Assign roles and at least one permitted business location to each user.

03

Point of sale

Complete a cash or credit sale.

  1. 1

    Start the sale

    From the dashboard, open Point of Sale and choose New sale. Worxpace uses your signed-in user, selected location and current activity session automatically.

  2. 2

    Select the customer

    Choose a customer before completing the invoice. Search accepts the customer’s name, phone number or email address. The customer is required because payments and outstanding balances belong to their account.

  3. 3

    Add products or services

    Search by product name, barcode, batch number or product group. Select an item, confirm quantity and selling price, and add it to the cart. Expiry and available quantity are shown for stock-tracked products; services do not reduce inventory.

  4. 4

    Review invoice details

    Confirm the transaction date, due date, discount, other charges and note. VAT is calculated from each item’s VAT setting and rate.

  5. 5

    Record payment

    Select a cash account and enter the amount received. A fully paid invoice is recorded as paid. A zero or partial payment leaves the remaining amount on the customer’s account.

  6. 6

    Finish and issue the receipt

    Choose Complete sale. After the transaction is saved, the completion page can print the receipt or save it as a PDF.

04

Inventory

Create products and control batches.

Worxpace separates the shared product definition from physical inventory batches. The product holds identity and ordering rules; each batch holds quantities, dates, costs and prices for a location.

Create the product

  • Open Inventory → Products and choose the new-product action.
  • Enter the name, barcode, product group and unit of sale.
  • Configure reorder and tax settings that apply to the product.
  • Add at least one opening batch before saving a stock-tracked product.

Describe each batch

  • Enter the batch number when the supplier or manufacturer provides one.
  • Record opening quantity, unit cost and selling price.
  • Add manufacture and expiry dates for dated inventory.
  • Use separate batches when dates, costs, prices or quantities differ.
05

Stocktaking

Reconcile physical stock with Worxpace.

  1. 1

    Create a stocktake document

    Open Inventory → Stock Taking and start a new count for the current business location.

  2. 2

    Enter physical quantities

    Count the stock actually present and record the quantity against the matching item or batch. Keep separate batches separate during the count.

  3. 3

    Review discrepancies

    Compare counted quantity with the system balance. Investigate large differences before posting corrections.

  4. 4

    Complete the document

    Posting the stocktake creates the inventory corrections required to align system balances with the accepted physical count.

06

Users & security

Give people the access their work requires.

Only Admin and Super users can open the Users & Security workspace in the browser application.

SalesCreate and manage sales activity
CashierReceive payments and move money
InventoryManage products, stock and inventory activity
OperationsUse broader operational workflows
AdminManage workspace configuration and users
SuperProduct-wide elevated administration

Every active user needs at least one role and one assigned location. Leaving either list empty produces an incomplete account that cannot operate normally. To change a browser passcode, enter and confirm the new value; leave both fields blank to keep the existing passcode.

07

Offline-first synchronization

Keep working when the connection does not.

The Windows application records supported changes locally first. An upload worker sends queued changes to the server, while a feed worker downloads changes made elsewhere for the same company.

Device

Work locally

Sales and other supported records are saved to the installation’s local data store.

Outbox

Upload changes

Pending local changes are sent when the configured server can be reached and authorization succeeds.

Feed

Receive changes

The device advances its feed cursor as company records are downloaded and applied locally.

Preparing a fresh device

A new installation cannot download historical company data until an administrator has queued it. In the browser application, sign in as Admin or Super, open Workspace → Sync, and run Server backfill. Backfill queues existing records into the download feed; rerunning it is safe because already queued records are skipped.

08

Updates

Move to a newer release safely.

  1. 1

    Read the release notes

    Check compatibility, runtime requirements and upgrade guidance on the Releases page.

  2. 2

    Finish pending work

    Allow queued synchronization to complete where possible, close other Worxpace windows and create a database backup.

  3. 3

    Run the installer

    Install the new version over the existing application. Site settings under ProgramData are kept separately from installation defaults.

  4. 4

    Verify the workspace

    Sign in, confirm the selected company and location, review sync status, and test a normal read-only workflow before entering new transactions.

09

Troubleshooting

Useful first checks.

Sign-in succeeds but no location is available

An Admin or Super user must assign at least one active business location to the account in Users & Security. Sign out and sign in again after the assignment changes.

A product does not appear in a new sale

Confirm that the product has an active inventory batch at the current location and a positive available quantity. Search by name, barcode, batch number and group to rule out a naming mismatch.

A fresh device downloads no company records

Open the browser Sync workspace as Admin or Super and run Server backfill for the company. Wait for all steps to complete, then refresh or restart synchronization on the device.

Synchronization remains pending

Confirm the server base URL in the ProgramData configuration, check connectivity, verify the signed-in user remains authorized, and inspect the upload/download status shown on the desktop dashboard.

An update will not start

Close every running Worxpace process, verify Windows 10 or later, and install the required .NET 8 Desktop Runtime. If upgrading from an older database line, complete the documented schema reconciliation first.

Connection lost. Reconnecting… Your work is kept while we retry.

Could not reach the server. Reloading…