Skip to main content

Custom fields

Custom (user-defined) fields let you add your own text fields to the standard LogiFlow entities without involving developers. This is convenient when the business needs to store something specific: "contract number", "seal number", "customs code of the cargo".

Which entities can have fields added​

Custom fields are supported for exactly four entity types:

Entity typeValue in the systemWhat it is
ShipmentshipmentLogistics shipment of cargo
RequestrequestTransportation request
BillbillFinancial document — a bill
PaymentpaymentFinancial document — a payment
There are no other entities

Custom fields cannot be added to counterparties, clients, services, articles or "operations" in a general sense. Only the four types above are available. Bill (bill) and payment (payment) are financial documents.

Where they are configured​

Section Settings → Users and system → Custom fields.

Custom fields can be created, modified and deleted by the administrator and the head (roles admin and boss), as well as by the platform administrator. The manager and the warehouse see the field values in forms but do not change the configuration itself.

The client is not shown custom fields at all — neither in a request, nor in a financial document, nor on a phone. This is deliberate: the fields are meant for internal bookkeeping and their content is not intended for the customer. If the client does need to see something, use the standard request fields or the comment.

Creating a field​

  1. Click New field.
  2. Fill in:
    • Entity type — shipment, request, bill or payment.
    • Name — how the field is called in the interface. Up to 100 characters, HTML tags are not allowed.
    • Field key — a short identifier. It is used as the variable name in print templates. Requirements:
      • Latin letters, digits and underscores only;
      • must start with a Latin letter;
      • length from 2 to 50 characters;
      • reserved words cannot be used (for example, id, class, value, name, type, script).
    • Maximum length — the limit on the length of the entered value. By default 255 characters (the interface allows up to 1000).
    • Order — a number for sorting fields (the lower it is, the higher the field). In the interface fields can also be dragged with the mouse.
    • Active — clear the checkbox to temporarily hide the field from users without deleting it.
  3. Save.

The field immediately appears in the create/edit forms of the corresponding entity.

Value storage is text only

All custom field values are stored as text. The system has no concept of a "field type" (number/date/boolean flag) at the storage level and does no type checking. If a number or a date is needed, users enter them as text. The only restriction applied is the length one (the "Maximum length" field).

Key uniqueness​

The triple company + field key + entity type must be unique. That is, within one company you cannot create two fields with the same key for the same entity. At the same time, the same key can be used for different entities — for example, contract_number separately for a request and separately for a bill.

Editing​

You can change the name, the field key, the maximum length, the order and the active flag. Changes apply to all existing records immediately.

Be careful when renaming a key

The field key is used as the variable name in print templates. If you change the key, the variable in already configured templates will stop being substituted — update the templates.

Deactivation and deletion​

  • Deactivation — clear the "Active" checkbox. The field is hidden from users, but the values are preserved. A safe way to "turn off" a field without losing data.
  • Deletion — irreversible, together with all saved values. Before deleting, export the data if it may be needed.

Use cases​

Requests (request):

  • "Contract number", "Sender's TIN", "Special conditions".

Shipments (shipment):

  • "Seal number", "Temperature mode", "ADR class" (for dangerous goods).

Bills and payments (bill, payment):

  • "Payment order number", "Accrual period", "Basis".

Use in print templates​

Custom field values are available as variables in print templates. Since templates are Excel files, variables are written in cells in the {{...}} format.

Custom fields are available under the prefix:

  • custom — for shipments and requests;
  • custom_fields — for financial documents (bill/payment).

Examples:

{{custom.items[0].name}}    — the name of the first custom field
{{custom.items[0].value}}   — the value of the first custom field
{{custom.table}}            — a dynamic table of all custom fields (Name, Value)
{{custom.table:name,value}} — a table with explicitly specified columns
The full list of variables

The print template editor has a "Variables help" button — it shows all available variables for the selected entity, including custom fields. Use it so that you do not have to guess names.

Limitations​

  • You should not create too many fields for a single entity — forms become inconvenient. If there are many fields, consider what can be merged.
  • All values are text: there are no "this is a number / this is a date" checks, only a length restriction.
  • Custom fields are not exported to external systems automatically. If you use integrations, agree on transferring the fields with technical support.

What's next​