Locations PHYSICAL Table Structure

This page contains technical detail about the physical database structure. It is not required for normal day to day operation of the Point Of Sale.

Goto: Documentation Home

Columns

FieldName	Datatype	Meta Info	Gnap	Description
location_id	long	Primary Key. Typically Positive, not zero	100/E	A unique internal id assigned to this location.
name	string		101/s
latitude	double		102
longitude	double		103
city	string:48,zerolen		104/s
location	string		105/s
address1	string:64,zerolen		106/s
address2	string:64,zerolen		107/s
address3	string:64,zerolen		108/s
address4	string:64,zerolen		109/s
address5	string:64,zerolen		110/s
address6	string:64,zerolen		111/s
comments	string		112/s
rid	long		113/E
heartbeatdt	date		114/s
zone	long		115/E
zid	long		116/E
stockinserver	bool		117/s
stocklevelserver	string:48,zerolen		118/s
stocklevelserverport	long		119/E
stockflags	long		120/E	A bitmask indicating stock operation. 1. Location cannot buy stock (as in raise purchase orders) but can receipt stock 2. Location does not maintain stock so cannot receipt stock. 4. Distributed servers can force stock levels into higher levels servers.
companyid	long		121/E
active	bool		122/s
descaddr	string:140,zerolen		155/s	Web. A descriptive address used for consumers. eg "Upstairs in Fieldpine Mall, right next to McFieldpine"
phone	string:30,zerolen		150/s	Web. Phone number of store for consumers
email	string:30,zerolen		151/s	Web. Email address of store for consumers
pricontact	string:40,zerolen		154/s	Web. Primary Contact for consumers. May be name or words and phrases such as "Manager"
intro_en	string:140,zerolen		152/s	Web. A descriptive blurb to describe the store, as might be used in a list of stores shown on a web page.
openhours	string:140,zerolen		153/s	Web. Opening hours in free form text.

Indexing

A unique primary key should exist on the location_id field.

Remarks

A value of -1 for location_id is permitted for exceptional circumstances. This is sometimes needed when integrating with external systems. The location numbered -1 should not be used for general use

A value of 0 for a location_id is tolerated but discouraged. Again this can be helpful when integrating external systems. There are some restrictions

The Fieldpine system will essentially attempt to "ignore" this row in the database. Whenever we fetch locations we will explicitly ignore location_id=0 (where possible)
It cannot be maintained via any API.
It may not be readable via any API