Nama Docs

English

العربية

English

العربية

Appearance

العربية

Refuse Serial Numbers That Are Not 15 Characters Long ​

This Groovy script is a save validation for serial numbers. If any serial number on the document's lines is not exactly 15 characters long, the save is refused, and every wrong serial is reported on its own line.

Customer-specific example

The length 15 is written into the script (twice: in the check and in the message). It suits devices whose serial is a 15-digit IMEI. For another length, change both places in the script before you paste it.

Class nameEASerialNumberLen
ScriptEASerialNumberLen.groovy
Runs onAny supply chain document with lines. Target action Validate On Save.
UsesNo parameters. Leave Parameter 1 empty.
Shipped asSource to paste. It is not built into the system.

When to use it ​

Mobile phones are sold by IMEI, which is always 15 digits. A digit dropped or added while typing creates a serial that will never match the device again, and the mistake only surfaces later, when the phone comes back for service. Refusing it at the moment of entry is much cheaper.

How it works ​

  1. It reads every line's serial numbers. A line can hold several serials separated by commas, or a range; the script expands them into single serials first.
  2. It checks each one. Every serial whose length is not 15 produces a refusal on the Serial Number cell of its line. All wrong serials are reported together, so the user sees every problem in one go.
  3. The message stands alone. The refusal is shown without the entity flow's name in front of it, so the user reads only the reason.

Lines without a serial number are not checked.

Setting it up ​

  1. Open Administration → Display Customization → Entity Flow and create a flow whose target type is the document to check (for example Sales Invoice or Stock Receipt).
  2. In the Details grid, add a line with Target Action set to Validate On Save, and paste the whole script into its Groovy Script column. Leave Class Name empty: it is filled in when you save.
  3. Leave all parameters empty, and save the flow.

Example ​

A line holds the serials SN12345678901,123456789012345. The second one is 15 characters long, the first one 13. The save is refused with:

Serial number SN12345678901 length is 13, it must be 15

After the user corrects the first serial, the document saves.

Messages you may see ​

This message has no Arabic translation, so it appears in English on Arabic screens as well.

MessageWhyWhat to do
Serial number {0} length is {1}, it must be 15The serial {0} on this line has {1} characters instead of 15.Correct the serial. If the length rule is wrong for this business, adapt the script.

The script ​

groovy
package com.namasoft.modules.supplychain.domain.utils.plugnplay.groovy

import com.namasoft.common.fieldids.AllModulesFieldIDs
import com.namasoft.common.utilities.ObjectChecker
import com.namasoft.infra.domainbase.datafields.LongTextDF
import com.namasoft.infra.domainbase.entity.base.EntityAction
import com.namasoft.infra.domainbase.util.Result
import com.namasoft.modules.supplychain.domain.details.BasicSCDocumentLine
import com.namasoft.modules.supplychain.domain.entities.BasicSCDocument
import com.namasoft.modules.supplychain.domain.primitives.SerialNumber

public class EASerialNumberLen implements EntityAction<BasicSCDocument> {
    @Override
    Result doAction(BasicSCDocument object, LongTextDF... parameters) {
        Result result = Result.createAccumulatingResult();
        for (int i = 0; i < object.getDetails().size(); i++) {
            final BasicSCDocumentLine line = object.getDetails().get(i);
            SerialNumber sn = line.fetchSerialNumber();
            if (ObjectChecker.isEmptyOrNull(sn))
                continue;
            def serials = sn.unZipSerials();
            for (final def s in serials) {
                if (s.length() != 15)
                    Result.createDetailFieldValidationFailure(AllModulesFieldIDs.SalesInvoice_details_specificDimensions_serialNumber, i, "Serial number {0} length is {1}, it must be 15", s, s.length()).addToAccumulatingResult(result);
            }
        }
        return result;
    }

    @Override
    boolean shouldNotDisplayEntityFlowNameWhenFailure() {
        return true;
    }

    @Override
    String describe() {
        return "Refuses the save when a serial number on a document line is not exactly 15 characters long. " +
                "Serial ranges on a line are expanded first, and every wrong serial is reported on its own line. Takes no parameters.";
    }

    @Override
    List<String> columnNames() {
        return Arrays.asList("Not used - leave empty");
    }
}