Uses of Package
com.sgs.common.database

Packages that use com.sgs.common.database

Package	Description
com.sgapi.services	This package provides endpoints for integrating data with the SG V5 System Imports are handled within the IntegrationImport class Exports are handled within the IntegrationExport class
com.sgs.common.database	This package is responsible for holding all of the objects that can be persisted in the SG V5 System.

Classes in com.sgs.common.database used by com.sgapi.services

Class	Description
Address	This class represents a mailing, invoice or delivery address for association with a client
Allergen	This class represents an Allergen for alerts in the system.
AllergenLink	Represents the link between an Allergen and a Commodity For example, PineNuts contains the Nut Allergen.
Answer	This class represents a possible Answer to a Question
BulkPlatform	This class represents Bulk Platforms which interact with the SG System
Client	This class represents any Client registered in the system.
Commodity	This class represents a commodity.
CommodityGroup	Represents a group of commodities.
CommodityGroupLink	This class represents the link between a Commodity and a CommodityGroup
Container	This class represents a container in the system A container can be used to hold stock, perform tares and other useful functions See Container.ContainerType for a list of different types of container that can be used
ContainerLink	This class represents the link between Container and StockLocation This identifies how much of each lot number resides on each pallet/container
CustomField	This class represents a custom field in the system.
CustomFieldLink	CustomFieldLink links a CustomField to a Commodity.
Formula	This class represents a Formula or Recipe in a system This is the header element of a set of instructions for processing at a terminal
FormulaStep	This class represents a step of a formula A step can be several different actions, see FormulaStep.FormulaStepType
Hazard	This class represents hazards that may be prompted for during system operation
HazardLink	This class represents the link between Hazards and Commodities This identifies which Commodities need to prompt for which Hazards
Job	This class represents a work order header
LabelFormatSet	This class represents a Label Format Set A Label format set is a header for a group of labels The set must declare what printer format type the labels linked to it are formatted in
LabelFormatSetLink	This class presents the link between LabelFormatSets and the label data This is where a label is defined with a set, type and the label data itself
LabelFormatType	This class represents Label Format Types A label format type instructs the system what kind of label exists in the LabelFormatSetLink table (stock, batch, packaging, etc)
LabelPrinterType	This class defines a label printer type (make/model/format) This provides additional support to some label format languages such as intermec and zebra See PrinterType for a list of supported printer types.
Location	This class represents a location Locations can be either Stock or Production dependent on Location.LocationType and can be categorized beyond that with Location.category Locations can be physical racks, groups of locations, areas or just a logical grouping of terminals See how locations and terminals are linked with TerminalLocation
OrderInformation	This class represents OrderInformation which can be used when raising PurchaseOrder and SalesOrder It acts as a holster for additional information
PreBatch	This class represents a placeholder for Batches When a job is scheduled with 20 batches, 20 PreBatches are created as place holders for the work to be done This allows the SG system to have custom settings on a per batch level
PurchaseOrder	This class represents a Purchase Order which can be raised for incoming good receipt
PurchaseOrderLine	This class represents a line of a purchase order
QALink	This class represents the link between Question and the events by which they appear
Reason	This class represents a reason which can be selected by an operator for certain events.
SalesOrder	This class represents a sales order
SalesOrderLine	This class represents Sales Order Lines The lines make up the contents of a sales order
SalesOrderLineCustomField	This class represents a custom field for a sales order line Custom fields can be used to add additional data to labels
SalesOrderLineCustomFieldLink	This class links SalesOrderLineCustomField to a SalesOrderLine and provides a place to hold the custom field data
Site	This class represents Sites which serve as umbrella location groups
SiteSupplier	This class represents the link between Suppliers and Sites Suppliers can be limited to only appear at particular sites
SiteSupplierCommodity	This class provides the link between SiteSupplier and Commodity This has the effect of marking particular SiteSuppliers as providing certain commodities The link is many-to-many If you are not using Sites then you can simply use SupplierCommodity for this function
Stock	This class represents a Stock header object.
StockAssignment	This class represents a reservation of a quantity of a particular stock item for a particular job.
StockLocation	This class represents inventory in a location It provides a location and a quantity from the Stock header record
SupplierCommodity	This class represents the link between Suppliers and Commodities By creating links between Suppliers and Commodities, we can reduce the list of goods that appear for receipt when a particular supplier is selected when raising a PurchaseOrder
SupplierCommodityContainer	This class takes SupplierCommodity to the next level by linking a SupplierCommodity to a container This can be used to state that Supplier X provides good Y in container C.
SystemLog	This class is the main location for logging transactions in the system Most actions performed in the system outside of Sales and QA will be logged here
Terminal	This class represents a terminal in the SG V5 System A terminal can be any instance of the SG V5 Software.
TerminalLocation	This class represents the link between Terminals and Locations Terminals can have visible locations, both stock and production If no links exist for a given terminal it is assumed to see all locations.
Transfer	This class details a Transfer order between locations or facilities Transfers can be used to schedule stock movements
TransferLine	This class is responsible for forming the detail of a Transfer order This informs the system which commodity needs to be moved
UnitCommodity	This class represents the relationship between commodities and units.
User	This class represents an operator of the system They must be setup for users to gain access to the system Rights can be assigned on a per user basis
WeightUnit	This class stores the units by which measurements are taken in the SG v5 System Inventory is stored in a base stocking unit set by Commodity.units.\ Formula Steps, Purchase Order Lines, SPC Runs, Sales Order Lines and many more aspects of the system are allowed to select their own WeightUnits to reference the quantity fields of each respective object Conversions can be performed to change values between these units via WeightUnit.conversionRate or on a commodity specific basis through UnitCommodity

Classes in com.sgs.common.database used by com.sgs.common.database

Class	Description
Address	This class represents a mailing, invoice or delivery address for association with a client
Allergen	This class represents an Allergen for alerts in the system.
AnalyticalWorkCard	Represents an analytical work card, used for documenting analytical tests and quality control for regulatory and internal standards.
AnalyticalWorkCardSchedule	Represents a job schedule for an Analytical Work Card.
AnalyticalWorkCardTest	Encapsulates the details of a specific test within an Analytical Work Card.
AnalyticalWorkCardTestDetail	Stores detailed parameters and thresholds for an Analytical Work Card test.
AnalyticalWorkCardTestGroup	Groups related tests within an Analytical Work Card.
Answer.Severity
ApprovalProcess	Represents an instance of an approval process.
ApprovalStage	Defines an individual stage within an approval process.
ApprovalTemplate	Defines an approval template outlining the steps and expected completion times for approval processes.
Asset	Represents a physical asset in the system.
AssetGroup	Represents a group or category of assets.
AssetMaintenance	Represents a maintenance record for an asset.
AssetPlan	Defines a scheduled plan for asset maintenance or management.
AssetType	Categorises assets by type.
Bag	This class represents a container used during the batching process The purpose of this class is currently for internal use only
Batch	This class represents a Batch.
BatchConsumption	This class represents inventory consumption in the batching process.
BulkDispense	This class represents bulk dispense fulfillments and is for internal purposes only
BulkPlatform	This class represents Bulk Platforms which interact with the SG System
Checks	This class represents Checks which interact with the SG System
Checks.Status
ChecksAnswer	This class represents a possible Answer to a Question
ChecksAnswer.Severity
ChecksAnswer.SeverityColor
ChecksLog.Status
ChecksQuestion	This class represents a question which can be asked through a QALink Questions can also be links or image capture events
ChecksQuestion.Type	The target that is compared to the checks response.
ChecksTemplates	This class represents ChecksTemplates which allow the user to create templates for a list of Checks.
ChecksTemplates.Frequency
ChecksTemplates.RecurDays
ChecksTemplates.ScheduleType
ChecksTemplates.Status
ChecksTemplatesGroup	This class represents an ChecksTemplatesGroup for creating template groups in the system.
ChecksTemplatesGroupEventLink.ChecksTemplateGroupEventType
Client	This class represents any Client registered in the system.
Commodity	This class represents a commodity.
Commodity.CommodityType	The different types that a commodity can be.
Commodity.DenominationType	How this good should be sold at a sales order level
Commodity.ExpiryMethod	The style by which expiry can be calculated.
Commodity.UnitDisplayMode	The display mode for PO/SO in Control Center.
CommodityGroup	Represents a group of commodities.
CommonIngredientStep	This class represents a Common Ingredient Step.
Container	This class represents a container in the system A container can be used to hold stock, perform tares and other useful functions See Container.ContainerType for a list of different types of container that can be used
Container.ContainerType	The different types of containers that are used in the system.
ContainerLink	This class represents the link between Container and StockLocation This identifies how much of each lot number resides on each pallet/container
CorrectiveActions.CorrectiveActionsStatus
Currency	This class represents a monetary currency For use in PurchaseOrder and SalesOrder
CustomerGroup	This class represents a group of customers This helps with grouping customers into their parent ownership group for labeling and packaging purposes
CustomerGroupCommodity	This class represents the link between customer groups and commodities.
CustomField	This class represents a custom field in the system.
CycleCountRun	This class represents a Cycle Count Run.
CycleCountRun.CycleCountRunStatus	The status of the cycle run
DeviationDetails	This class represents the link between customer groups and commodities.
DeviationDetails.DeviationDetailsStatus
DeviationDetails.Method
DeviationDetails.Severity
Document	Represents a document in the system.
DocumentType	Defines the type or category of a document.
DocumentVersion	Represents a specific version of a document.
Formula	This class represents a Formula or Recipe in a system This is the header element of a set of instructions for processing at a terminal
Formula.ExpiryMode	The expiry calculation method for the formula Fixed is based on the Commodity.defExpiryDays Dynamic is based on the earliest expiry of the added ingredients
Formula.FormulaType	Formula Type.
Formula.LossType
Formula.OperationalMode	The operational mode of a batch formula Continuous allows for a batch to be executed X number of times, increasing consumption and production Master batch infers that all work on that job goes into a single batch
Formula.ProduceAs
Formula.ProductionStyle	The method in which production is derived Calculated takes the total weight Input takes a keyed input at batch end Weigh prompts for the total weight on the scale at the batch end
Formula.ProductOperationalMode	Product job operational types Multi-lot allows for the assignment of a variety of stock for a single commodity rather than just one box/item FIFO assumptions are made on stock so accuracy is less but also it means that operators don't constantly need to change out packaging lot codes/pallets once a run starts Multi-lot key entry performs the same as multi-lot but has a key entry panel rather than a weigh panel.
Formula.SignOffMode	How the Formula is signed off.
Formula.TareMode	The tare mode, pertains to product formulas only Calculated adds all the packaging item weights up Prompt asks the operator to weigh the container Preset takes the preset key value set by the tare value Key Entered works like prompt but without the use of a scale
FormulaStep	This class represents a step of a formula A step can be several different actions, see FormulaStep.FormulaStepType
FormulaStep.FormulaStepType	The type of a formula step.
FormulaStep.LossType	The type of loss the step will experience.
Hazard	This class represents hazards that may be prompted for during system operation
HibernateObject	Represents a base database object in the SGSystem Used for mapping with Hibernate
Hold	This class represents a Hold order on a container link Holds can be raised against containerlinks which prevent them from being used/sold
Job	This class represents a work order header
Job.JobStatus	The status of a Job or JobLine.
JobLine	This class represents a portion of a Job that is to be completed at a location.
JobSalesOrderLink	This class represents the link between a Job and a SalesOrderLine This allows the system to schedule jobs for particular sales orders and allocate them in advance
LabelFormatSet	This class represents a Label Format Set A Label format set is a header for a group of labels The set must declare what printer format type the labels linked to it are formatted in
LabelFormatType	This class represents Label Format Types A label format type instructs the system what kind of label exists in the LabelFormatSetLink table (stock, batch, packaging, etc)
LabelPrinterType	This class defines a label printer type (make/model/format) This provides additional support to some label format languages such as intermec and zebra See PrinterType for a list of supported printer types.
Location	This class represents a location Locations can be either Stock or Production dependent on Location.LocationType and can be categorized beyond that with Location.category Locations can be physical racks, groups of locations, areas or just a logical grouping of terminals See how locations and terminals are linked with TerminalLocation
Location.LocationCategory	The category of a stock location.
Location.LocationType	The type of location.
LocationGroup	This class represents LocationGroup which allows the user to create a location group and assign locations to that group.
LotContainer	This class defines a sub-division of a StockLocation The best example of this would be if inventory is received as LOT 123 but it is received in 5 different bottles, all with different weights, we would use LotContainers to track these stock sub-divisions This differs from Container in that containers may have multiple different lots contained within them, whereas LotContainers pertain to only one lot
Notification.NotificationType	The type of notification 0 = Message 1 = Info 2 = Alert 3 = Warning 4 = Danger
OptionalGroup	This class represents optional groups Optional groups represent groups of formula steps which may or may not be executed A formula can contain optional groups which in turn provide routines
OrderInformation	This class represents OrderInformation which can be used when raising PurchaseOrder and SalesOrder It acts as a holster for additional information
Pack	This class represents a serialized pack from production This class allows for each pack of a produced item to have it's own unique serial number This allows each individual pack to be traced on it's own
Policy	Represents a policy entity that defines guidelines and procedures within the organisation.
PreBatch	This class represents a placeholder for Batches When a job is scheduled with 20 batches, 20 PreBatches are created as place holders for the work to be done This allows the SG system to have custom settings on a per batch level
PreBatch.BatchStatus	The status a batch
PreventiveActions.PreventiveActionsStatus
PurchaseOrder	This class represents a Purchase Order which can be raised for incoming good receipt
PurchaseOrder.PurchaseOrderStatus	The status of the Purchase Order
PurchaseOrderLine	This class represents a line of a purchase order
QAGroup	This class represents a question which can be asked through a QALink Questions can also be links or image capture events
QALink	This class represents the link between Question and the events by which they appear
QALink.QAEventType	The event/point in operation at which this question should be asked
QALink.SignOffMode	How the Event is signed off.
QALog	This class represents the log of a QA event.
Question	This class represents a question which can be asked through a QALink Questions can also be links or image capture events
Question.CustomResponseType
Question.QAType	The type of question to be asked.
Reason	This class represents a reason which can be selected by an operator for certain events.
Reason.ReasonType	The place where the reason should be prompted for
RegulatoryStandard	Represents a regulatory standard in the Pharma and Life Sciences industry.
RootCauseAnalysis	This class represents the link between customer groups and commodities.
RootCauseAnalysis.RCAMethod
RootCauseAnalysis.RCAStatus
SalesLog	This class represents actions which have occurred during shipping When items are picked/shipped, a log is generated here
SalesOrder	This class represents a sales order
SalesOrder.SalesOrderStatus	SalesOrderStatus refers to the status of a sales order at a given time
SalesOrderLine	This class represents Sales Order Lines The lines make up the contents of a sales order
SalesOrderLineCustomField	This class represents a custom field for a sales order line Custom fields can be used to add additional data to labels
Site	This class represents Sites which serve as umbrella location groups
SiteSupplier	This class represents the link between Suppliers and Sites Suppliers can be limited to only appear at particular sites
SOPHeader	Represents a header for Standard Operating Procedures (SOP).
SPCCommodity	This class provides a wrapper to encapsulate a commodity or formula with additional information for use in an SPCRun
SPCRun	This class represents an SPC Run.
SPCRun.SPCRunResult	The result of the SPCRun
SPCRun.SPCRunStatus	The status of the SPC run
Stock	This class represents a Stock header object.
StockAssignment	This class represents a reservation of a quantity of a particular stock item for a particular job.
StockLocation	This class represents inventory in a location It provides a location and a quantity from the Stock header record
SuperBatch	This class represents a Batch.
SupplierCommodity	This class represents the link between Suppliers and Commodities By creating links between Suppliers and Commodities, we can reduce the list of goods that appear for receipt when a particular supplier is selected when raising a PurchaseOrder
SystemLog	This class is the main location for logging transactions in the system Most actions performed in the system outside of Sales and QA will be logged here
Tax	A class representing a tax code
Terminal	This class represents a terminal in the SG V5 System A terminal can be any instance of the SG V5 Software.
Test	Encapsulates information about a test.
TestStage	Defines a stage in the testing process.
TestType	Categorizes tests by type.
Trailer	This class represents Trailers which can be used for shipping and receiving goods This particular class forms part of the Trailer Management module, used for tracking and inspecting trailers
Transfer	This class details a Transfer order between locations or facilities Transfers can be used to schedule stock movements
Transfer.TransferStatus	The current status of the transfer through the process
TransferLine	This class is responsible for forming the detail of a Transfer order This informs the system which commodity needs to be moved
User	This class represents an operator of the system They must be setup for users to gain access to the system Rights can be assigned on a per user basis
User.Role
User.SupervisorLevel	The supervisor level of the operator.
User.SystemPrivileges	The various options/privileges that can be set per user
UserGroup	Represents a group of users.
WavePick	Used to represent a wave picking order.
WavePick.WavePickStatus	The current situation of the wave pick.
WeighPrintInfo	This class represents WeighPrintInfo which allows the user to be able to enter custom info, weigh a particular item and print a label.
WeightUnit	This class stores the units by which measurements are taken in the SG v5 System Inventory is stored in a base stocking unit set by Commodity.units.\ Formula Steps, Purchase Order Lines, SPC Runs, Sales Order Lines and many more aspects of the system are allowed to select their own WeightUnits to reference the quantity fields of each respective object Conversions can be performed to change values between these units via WeightUnit.conversionRate or on a commodity specific basis through UnitCommodity