The Label management system is designed to create, add and manage labels attached to specific resources, where each of them requires a specific type of information. The goal is to add another layer of categorization in the system, much like а "tagging system". This way all system information can be sorted out by specific labels through QueryBuilder.
It is important to first clarify how a "label" is structured in Billia. It consists of a Component, a Resource and a relational API Component-to-Resource.
Components are set in the system, resources can be attached to them, and finally an Administrator can choose specific labels from a drop-down menu on the location of a certain resource.
Note: The "label" is the end result of the API's process. The system, though, recognizes it as the term "component".
Term | Definition |
---|---|
Resource | - Refers to a location in the system, e.g. Users (account), Orders (section), etc. |
Component | - Refers to the label itself, whole term is "label component". |
Column | Definition |
---|---|
Key | - Identifies the component as a key-value entity. No back-end modification or inclusion of the key is required. |
Name | - Sets the description name for the component, which will be visible by Administrators. This "name" doesn't have to be the same as the key. |
Resource | - Defines the system location where the component could be visualized. Resources are attached upfront to components. One component can have as many resources attached to it as the system can support. Various resources are colorized differently. Each resource can be quickly removed from a component by clicking on its "x". |
Type | - Defines the type of the component itself, i.e. what type of information it will require. These include: "integer" - a number, "string" - a text, "yes-no" - to confirm or deny, and "range" - to set a from-to range of numbers. |
Note: Resources and component types are hard-coded into the system. Such cannot be additionally added from within the Billia Management Panel.
Control button | Definition | Detail |
---|---|---|
![]() | Add resource to component | - Click here to choose a new resource from a dropdown menu to add to the respective component. |
Edit Label component | - Edit the component setup, including additional JSON data. | |
Delete Label component | - Delete that component. | |
Add new | - Create a new component. |
This option will allow the Administrator to choose a new resource from a dropdown menu to add to the respective label component.
Additionally, the slider button "Unique" refers to making the use of the component for that resource either one-time or multi-time. In certain business cases one resource (system location) could be tagged with one and the same component (label) more than once. So it is important to specify whether that resource could display a component once (Unique) or multiple times.
Creating a new component happens easily and doesn't require any additional backend modifications in order for it to work.
Field | Definition |
---|---|
Key | - Set the key title for the component label you will be creating. No writing restrictions are present. |
Name | - Set the name for the component label, which will be publicly visible in the Management Panel. |
Description | - Set a description for the component label, not obligatory. |
Type | - Choose the component's type and style of the information it will eventually require. Includes: "integer" - a number, "string" - a text, "yes-no" - to confirm or deny, and "range" - to set a from-to range of numbers. |
Allowed values | - Set a Value and a Name for needed values, which are a part of the label component. Once the label is selected to be attached in the specific system location, the values would be available to choose from as part of that label. E.g. - in the Users section, under a specific User, add a label titled "Account Manager". That label already has pre-created values representing different Account managers. |