CORE-POS/IS4C Master Documentation ToC

Rudimentary ToC to /IS4C/documentation
and links to some other resources
as of: November 3, 2014

You are here: Documentation Top

| Fannie/Backend | IS4C (lane) | IT |

All links open in new tabs

doxy
PHP class-level documentation
- Fannie/Backend
- PoS/Lane
Fannie/Backend
Configuration and Development. See IT below for installation and maintenance.
You should be familiar with the IT materials before developing.
Much of the following is also at the Techhub wiki: Fannie 4 Developers
- Developer Menu
  - Coding Standards & Style Guide
  - Installation
    - Pre-requisites
    - Installing Fannie
      - Where to put it
      - .../install/index.php: The installation/configuration page
  - Dive In
    - New Developers should start with the Plugin docs; Developers who have code but a significantly different version of Fannie may want to start with the Porting docs.
  - Plugin Developer
    - Defining a Plugin
    - Creating a Page
    - Database Best Practices
  - Porting from other versions of Fannie
  - CORE Project Developer
    - Framework Requirements/Theory
      - [On rules]
      - One configuration file
      - Database Best Practices
    - Authentication System
      - [The current situation]
      - Authenticating users
      - Permissions
      - Groups
      - Tying it all together
      - Installation
      - Drawbacks and/or Gotchas
      - auth classes - List of scripts that require specific authorizations if authentication is enabled.
        Apparently doesn't exist, or if it does, this isn't it.
      - Auth Module API Documentation
        
        Requirements
        
        API
        
        Usage
      - Andy's Fannie Authentication Module README
        
        Disabling Authentication
        
        Installation / Setup
    - Using Bootstrap with Fannie
    - Scheduled Tasks (cron jobs)
    - Creating Tables and Views
      - [It is done in install/index.php]
    - Altering Tables and Views
      - [Using the install/updates directory
    - Auto-Generated Fannie Database Documentation
      - Links to per-table Help
      - core_op
      - core_trans
- Fannie End-user (Administrator) Menu
  - Data Loading
    - Members
    - Employees
    - Tenders
    - Tax Rates
  - Departments
    - Departments
    - Super Departments
    - Sub Departments
  - House Coupons
    - Introduction
      - Introduction
      - Setup
      - Terms and options
    - Explanation of terms and options
      - Simple ones
      - Required Purchases
      - Discount Types
  - Members
    - Membership Types
    - Membership-related Settings
    - Importing Existing Memberships
    - Brief Detour: Equity Tracking
    - Back to Importing Data
  - Product and Price Management
    - How do I add an item to POS?
    - That's tedious. How do I import a bunch of items?
    - How do I add two items with the same UPC?
    - How do I change an item's price?
    - How do I find an item without the UPC?
    - Why isn't my item the same price at all lanes?
    - Why does the item I entered say "not found" at the lanes
    - Why does an item ring up with "w/ volume adjust" messages?
    - How do I put an item on sale?
    - How do I take an item off sale?
    - Why does an item show a message about not being for sale?
    - Why is the lane saying "place item on scale"?
    - Why isn't the lane weighing an item?
    - How do I enter variable-weight, pre-stickered items such as from a Hobart deli scale?
    - How do I put a variable-weight, pre-stickered item on sale?
    - How do I ensure an item is not discounted?
    - How do I require the cashier to enter a quantity for an item?
    - How do I pull price updates from a spreadsheet my vendor sent?
  - Advanced Pricing
    - Complex pricing options not available through the user interface
  - Sale Batches
    - Batch Types
    - Creating Sales Batches (Batches for Sales)
    - Price Change Batches
    - Likecodes
    - Add limit
    - The Cut option
    - Specialty Batch Tools
      - Co+op Deals, i.e. Flyer Prices
      - Vendor Pricing
  - Specialty Batch Tools
  - Vendors
    - Importing vendor catalogs
    - Associating vendor items with internal products
    - Adding vendor items as products to sell via POS
    - Mass updating retail prices from vendor info
  - User Authentication
IS4C i.e. the lane or actual Point of Sale
- Developer Menu
  - Coding Standards & Style Guide
  - Installation
  - Module API
  - Framework
    - Install-anywhere
    - Modular Parsing
    - Classes for UI
    - Modular Paycards
    - Hardware Flexibility
    - Database Best Practices
  - Dive In - another ToC to this list
  - Integrate Paycards: Credit, Debit, Gift, etc.
    - Primer: Credit Cards
    - Primer: Gift Cards
    - BasicCCModule Class
    - What's Going to Go Wrong?
  - How Pages are Generated; HowTo New Page
    - How a page is generated: class BasicPage
    - Variant (child) classes: InputPage, NoInputPage, PaycardProcessPage
  - How PoS Input is Processed (Parsed); HowTo New Input
  - Scanner/Scale Drivers
    - Class ScaleDriverWrapper and its methods
  - The NewMagellan scanner/scale driver
    - How it works
  - Install scanner/scale under the NewMagellan driver
  - GS1 Barcodes
    - Scale Drivers
    - Data Storage
  - Modular Handling of UPC's
    - Special UPC's: membership cards, coupons, etc.
    - Discount Types: e.g. for all, members, staff
    - Price Methods: group sales
  - Internationalization with gettext
    - In PHP
    - Creating and managing language files
  - Plugin System
    - Putting a collection of related POS modules in a self-contained, distributable package
  - PoS keyboard commands
    Calls the doc() methods of keyboard command handlers.
  - Auto-Generated IS4C Database Documentation
    - Links to per-table Help
    - opdata
    - translog
- IS4C End-user Menu i.e. Front-end or Cashier
  Much of the following is also at the Techhub wiki: Point of Sale 4 Users
IT
Installation and maintenance. See above for configuration and development.
Also see the left column of the Maintenance and Reporting System
Also see Fannie Installation and Configuration
- Database Administrator
  - Backups
    - Backup Basics
    - Configuration
    - Restoring a Backup
  - Diagram of core_op database (PDF)
  - Diagram of core_trans database (PDF)
  - Data flow between lane and fannie/backend
    - Lane to Server Data: dtransactions and alog
    - Server to Lane Data: products, custdata, etc.
    - Lane to Server to Lane Data: suspend and resume
  - Creating New Reports (ad hoc reporting)
  - Diagram of core_op database, April 2010 (PDF)
  - Automated Maintenance Jobs (cron)
    - Generally see the Maintenance and Reporting System: Scheduled Tasks
    - The Transaction Shuffle - Transfer of transaction data
    - Batches - How Sale Prices and Price Changes are implemented
      Also see the Maintenance and Reporting System: Sales Batches
    - Equity Tracking
    - Table Copies - Shortcut technique for data restoration
- Hardware
  - Lane machine (computer)
  - Backend server machine(s)
  - Label-printing scales (Deli/Bulk/Prepack/Etc)
  - Shelf tags (label stock)
- Security
  - Firewall(s)
  - Front End Authentication
  - Back End Authentication
  - Protecting Configuration Files
MultiStore
Packaging
Reference Code/Wedge
This is not documentation but rather the whole code base of the Wedge Co-op IS4C release upon which Core POS was based.

Other resources

Core POS at the NCGA TechHub Forum
Especially the Fannie and Lane installation threads
The Techhub wiki: Fannie 4 Developers
Much of the same content as the Fannie Developer above, but also some newer installation material from the Techhub Forum
The Techhub wiki: Point of Sale 4 Users
CORE-POS/IS4C Issues at github
At The Wedge IS4C website