VbzCart/docs/tables/event vc ord hold: Difference between revisions

From Woozle Writes Code
< VbzCart‎ | docs‎ | tables
Jump to navigation Jump to search
imported>Woozle
m (Woozle moved page VbzCart/tables/ord change to VbzCart/tables/event vc ord change: adapting for EventPlex)
imported>Woozle
(a little post-move tidying; redesign yet to be done)
Line 1: Line 1:
==About==
==About==
'''Purpose''': for tracking events (usually or always manually-invoked) which change the status of an order
* '''Purpose''': EventPlex extension for tracking events (usually or always manually-invoked) which change the status of an order
===backstory===
* '''Related''': {{l/vbzcart/table|ord_change_type}}
I apparently designed this and its "types" table ({{vbzcart|table|ord_change_type}}) sometime in 2008, but didn't document them; a note on the {{vbzcart|table|ord_change_type}} page dated 2008-12-27 says "Are we actually using this, or is it part of the future online ordering system redesign?"
 
As of 2009-07, though, it has become clear that a general order log seems necessary for the following reasons:
* To replace the {{vbzcart|table|ord_pull}} table
* To make it unnecessary to track user details inside other order-related records
* To keep an automatic record of all changes made to an order and any significant processing events
 
The system implemented here of defining event types which may or may not block certain things seems compatible with this goal, and we mainly just needed to add fields for user-tracking.
==History==
==History==
* '''2008-12-27''' Extracted from main "tables" page, but no documentation yet
* '''2008-12-27''' Extracted from main "tables" page, but no documentation yet
* '''2009-07-12'''
* '''{{l/sub|2009}}''' Summary: Added '''isActive''' but then replaced it with '''do*''' fields
** Preliminary documentation
* '''2017-06-01''' Renamed from {{l/vbzcart/table|ord_change}} to {{l/vbzcart/table|event_vc_ord_change}}; redesigning as EventPlex extension. Will need to import {{l/vbzcart/table|ord_pull}} data, if possible.
** Added '''isActive''' field (was in {{vbzcart|table|ord_change_type}}, didn't belong there)
** Added '''VbzUser''' and '''Machine''' fields
** Renamed to singular form
* '''2009-10-18'''
** Replaced '''isActive''' field with '''do*''' fields
** Added '''SysUser''', for consistency with other event log tables
** Renamed from '''ord_event''' to '''ord_change'''; using '''{{vbzcart|table|ord_event}}''' for stateless/internal events
==Fields==
==Fields==
* <s>'''isActive''' represents</s> The '''do*''' tristate-flag fields represent the state of the order after this event, as determined by taking the order's previous flags and applying the event type's flags. This provides a record of the order's actual state over time, negating the need to follow the event history from the beginning in order to find the order's state at any given time.
* The '''do*''' tristate-flag fields (formerly '''isActive''') represent the state of the order after this event, as determined by taking the order's previous flags and applying the event type's flags. This provides a record of the order's actual state over time, negating the need to follow the event history from the beginning in order to find the order's state at any given time.
* '''ID_Type''' -> {{l/vbzcart/table|ord_change_type}}.ID
* '''VbzUser''' is the user's wiki username, and only applies to events initiated through the wiki user interface
* '''VbzUser''' is the user's wiki username, and only applies to events initiated through the wiki user interface
* '''Machine''' hasn't been rigorously defined yet; it just needs to be some way we can tell what computer was being used (and it does not need to be authenticated; authentication records should be kept elsewhere). Ideally, it should be netname@[ip address], but various coding environments may not support both of those.
* '''Machine''' hasn't been rigorously defined yet; it just needs to be some way we can tell what computer was being used (and it does not need to be authenticated; authentication records should be kept elsewhere). Ideally, it should be netname@[ip address], but various coding environments may not support both of those.
==SQL==
==SQL==
<mysql>CREATE TABLE `ord_change` (
<mysql>CREATE TABLE `event_vc_ord_change` (
   `ID`            INT        NOT NULL AUTO_INCREMENT,
   `ID`            INT        NOT NULL AUTO_INCREMENT,
   `ID_Ord`        INT        NOT NULL COMMENT "core_orders.ID",
   `ID_Ord`        INT        NOT NULL COMMENT "core_orders.ID",

Revision as of 10:49, 1 June 2017

About

  • Purpose: EventPlex extension for tracking events (usually or always manually-invoked) which change the status of an order
  • Related: Template:L/vbzcart/table

History

Fields

  • The do* tristate-flag fields (formerly isActive) represent the state of the order after this event, as determined by taking the order's previous flags and applying the event type's flags. This provides a record of the order's actual state over time, negating the need to follow the event history from the beginning in order to find the order's state at any given time.
  • ID_Type -> Template:L/vbzcart/table.ID
  • VbzUser is the user's wiki username, and only applies to events initiated through the wiki user interface
  • Machine hasn't been rigorously defined yet; it just needs to be some way we can tell what computer was being used (and it does not need to be authenticated; authentication records should be kept elsewhere). Ideally, it should be netname@[ip address], but various coding environments may not support both of those.

SQL

<mysql>CREATE TABLE `event_vc_ord_change` ( 

 `ID`             INT        NOT NULL AUTO_INCREMENT,
 `ID_Ord`         INT        NOT NULL COMMENT "core_orders.ID",
 `ID_Type`        INT        NOT NULL COMMENT "ord_event_type.ID",
 `doHoldRstk` TINYINT(1) DEFAULT NULL COMMENT "TRUE = do not base restock request items on this order",
 `doHoldChrg` TINYINT(1) DEFAULT NULL COMMENT "TRUE = do not charge bank card for this order",
 `doContact`  TINYINT(1) DEFAULT NULL COMMENT "TRUE = customer needs to be contacted about this order",
 `doExamine`  TINYINT(1) DEFAULT NULL COMMENT "TRUE = this order needs further examination",
 `WhenDone`  DATETIME                 COMMENT "when the event happened",
 `VbzUser`   VARCHAR(127)             COMMENT "VbzCart username of whoever initiated the event, if available",
 `SysUser`   VARCHAR(127)             COMMENT "who logged into the operating system, if available",
 `Machine`   VARCHAR(63)              COMMENT "network name or IP address of client",
 `Notes`     VARCHAR(255)             COMMENT "human-entered notes, if needed",
 PRIMARY KEY(`ID`)

) ENGINE = MYISAM;</mysql>

Retrieved from "https://wooz.dev/mw/index.php?title=VbzCart/docs/tables/event_vc_ord_hold&oldid=5890"