Terms, naming and other conventions - LabelHub/labelhub.integration.documentation GitHub Wiki

Description of terms and words used in this documentation

Manufacturer

A manufacturer is the producer of labels. It is the owner of the manufacturing facilities and it is the entity who is purchasing LabelHub to use for it's customers

BrandOwner

A brandowner is the manufacturers customer. A brandowner "owns the brands which are printed on the labels".

Label

A Label is a product/item/article produced by the manufacturer for the brandowner

Die

A Die is a tool used for cutting labels on an "endless" roll of printing material

Material

Material is the substrate on which the label is printed

Lacquer / Varnish

Lacquer is the old term used in labelhub for varnish. Historical this entity has been named "lacquer", but it will be renamed to the correct term "varnish" in the future. The frontend in LabelHub already shows "Varnish" to it's users in all places instead of "Lacquer", but the integration and backend entities are still named "Lacquer" internally.

Label width/height vs. Die width/height

Labelhub distinguishes between the label width/height and the die width/height. It is important to note that the width/height of the label represents the actual size of the finished label when looking at the label in its intended/neutral/natural orientation. The natural orientation is the one used when previewing a single label inside LabelHub. The die width/height represents the dimensions of the label as they are produced. The relation between width/height on the label and the corresponding die is always the orientation on the direction/finishing on the label. The label may be produced "on the side"(=rotated 90deg or 270deg) and thereby effectivly swapping width and height on the die compared to the label.

Foreign keys and searching

It is recommended to use the same identifiers and keys as in the source ERP-system. So the BrandOwner.brandOwnerNo should be the customer-number from the ERP/MIS system. However, there is a pitfall in this: It is recommended that keys only consists of [a-z], [A-Z] and [0-9]. Avoid using special characters, especially dashes("-") or plussign("+"). In general LabelHub recommends not using any "special characters" at all. The reason for this is that LabelHub uses ElasticSearch for indexing and searching behind the scene. Some of these characters are special operators in the searching-syntax. So searching for the string "some-key" will actually translate into finding all data containing "some" but NONE where "key" also exists. This will cause searching for "some-key" not to find data which contains the string "some-key"!