Allow year in any portal type's ID format string

* Added KeyError trap on GenerateUniqueId to provide more detail

* Allow year in all portal types in ID Server config

* Included a test for batch id with a year in it in IDServer

Conflicts:
	bika/lims/docs/IDServer.rst
	bika/lims/idserver.py

Author: mikejmets

bika/lims/idserver.py

@@ -94,11 +94,13 @@ def getConfigByPortalType(config_map, portal_type):
         variables_map = {
             'sampleId': context.getSample().getId(),
             'sample': context.getSample(),
+            'year': DateTime().strftime("%Y")[2:],
         }
     elif portal_type == "SamplePartition":
         variables_map = {
             'sampleId': context.aq_parent.getId(),
             'sample': context.aq_parent,
+            'year': DateTime().strftime("%Y")[2:],
         }
     elif portal_type == "Sample" and parent:
         config = getConfigByPortalType(
@@ -107,6 +109,7 @@ def getConfigByPortalType(config_map, portal_type):
         variables_map = {
             'sampleId': context.getId(),
             'sample': context,
+            'year': DateTime().strftime("%Y")[2:],
         }
     elif portal_type == "Sample":
         sampleDate = None
@@ -128,7 +131,9 @@ def getConfigByPortalType(config_map, portal_type):
                 'sequence_type': 'generated',
                 'prefix': '%s' % portal_type.lower(),
             }
-        variables_map = {}
+        variables_map = {
+            'year': DateTime().strftime("%Y")[2:],
+            }
 
     # Actual id construction starts here
     form = config['form']
@@ -137,15 +142,20 @@ def getConfigByPortalType(config_map, portal_type):
             context=variables_map[config['context']],
             config=config)
     elif config['sequence_type'] == 'generated':
-        if config.get('split_length', None) == 0:
-            prefix_config = '-'.join(form.split('-')[:-1])
-            prefix = prefix_config.format(**variables_map)
-        elif config.get('split_length', 0) > 0:
-            prefix_config = '-'.join(form.split('-')[:config['split_length']])
-            prefix = prefix_config.format(**variables_map)
-        else:
-            prefix = config['prefix']
-        new_seq = number_generator(key=prefix)
+        try:
+            if config.get('split_length', None) == 0:
+                prefix_config = '-'.join(form.split('-')[:-1])
+                prefix = prefix_config.format(**variables_map)
+            elif config.get('split_length', 0) > 0:
+                prefix_config = '-'.join(form.split('-')[:config['split_length']])
+                prefix = prefix_config.format(**variables_map)
+            else:
+                prefix = config['prefix']
+            new_seq = number_generator(key=prefix)
+        except KeyError, e:
+            msg = "KeyError in GenerateUniqueId on %s: %s" % (
+                    str(config), e)
+            raise RuntimeError(msg)
     variables_map['seq'] = new_seq + 1
     result = form.format(**variables_map)
     return result

bika/lims/tests/doctests/IDServer.rst

@@ -51,6 +51,7 @@ Functional Helpers:
 Variables:
 
     >>> date_now = timestamp()
+    >>> year = date_now.split('-')[0][2:]
     >>> sample_date = DateTime(2017, 1, 31)
     >>> portal = self.portal
     >>> request = self.request
@@ -140,6 +141,12 @@ Set up `ID Server` configuration:
     ...            'portal_type': 'SamplePartition',
     ...            'sequence_type': 'counter',
     ...            'value': ''},
+    ...           {'form': 'B{year}-{seq:04d}',
+    ...            'portal_type': 'Batch',
+    ...            'prefix': 'batch',
+    ...            'sequence_type': 'generated',
+    ...            'split_length': 1,
+    ...            'value': ''},
     ...          ]
 
     >>> bika_setup.setIDFormatting(values)
@@ -191,6 +198,12 @@ Create a third `AnalysisRequest` with existing sample:
     >>> ar
     <...water17-0002-R2>
 
+Create a forth `Batch`::
+    >>> batches = self.portal.batches
+    >>> batch = api.create(batches, "Batch", ClientID="RB")
+    >>> batch.getId() == "B{}-0001".format(year)
+    True
+
 Change ID formats and create new `AnalysisRequest`:
 
     >>> values = [{'form': '{clientId}-{sampleDate:%Y%m%d}-{sampleType}-{seq:04d}',