Update }bedrock.hier.leaves.sync (#197)

Update }bedrock.hier.leaves.sync.pro
fix for #147

Author: lotsaram

main/}bedrock.hier.leaves.sync.pro

@@ -4,7 +4,7 @@
 586,"}Dimensions"
 585,"}Dimensions"
 564,
-565,"v2Ro>?=^[<xzbf5>egIxAPyK?1p;]2H[@>;urjCnA4W19Bd[v9tMDub2+[Qwo}JR;yS1]>[kEqt>rAn@mv^i;@dTCYQ:Jy1bOV6=smDMzlqQof\Gi^K1j8vPu?9kj\@k!kGBS;G=JXYfmoIn7==XF[EB]zk1]TT31GpaHis@\6=Y=iH]aiMv0v:26?d`qLc5S\d21D"
+565,"c0vy=UZd]C7bY]Rn?Y<=XpnWWi\cSX;UP=a^UN=T=@k4iKow?9WtC9kUe*[QsIpzNIUZQN^UA1~t;yq_xWQ`noKz9lYQ?PY9n?O6mLIMR1C6Occ\g\M2Cq6mkuW6eZvgm,[JR1zkaVZ{IAEoIAy=]3a:S@]GOEX@0R=wk1@9KjVH7yisty3rfu0hLf^NydQL33uF_1Y="
 559,1
 928,0
 593,
@@ -25,30 +25,34 @@
 569,0
 592,0
 599,1000
-560,5
+560,6
 pLogOutput
 pStrictErrorHandling
 pDim
 pHier
 pDelim
-561,5
+pReverse
+561,6
 1
 1
 2
 2
 2
-590,5
+1
+590,6
 pLogOutput,0
 pStrictErrorHandling,0
 pDim,""
 pHier,""
 pDelim,"&"
-637,5
+pReverse,0
+637,6
 pLogOutput,"OPTIONAL: Write parameters and action summary to server message log (Boolean True = 1)"
 pStrictErrorHandling,"OPTIONAL: On encountering any error, exit with major error status by ProcessQuit after writing to the server message log (Boolean True = 1)"
 pDim,"REQUIRED: Dimension, accepts wildcards (all dimensions = *)"
 pHier,"OPTIONAL: Hierarchy, accepts wildcards (all hierarchies = *)"
 pDelim,"OPTIONAL: Delimiter character (default value if blank = '&')"
+pReverse,"OPTIONAL: If true then also add any elements from the Leaves hierarchy not existing in the specified hierarchies to those hierarchies (under a consolidation bucket 'ORPHAN LEAVES')"
 577,1
 vDimHier
 578,1
@@ -62,13 +66,12 @@ vDimHier
 582,1
 VarType=32ColType=827
 603,0
-572,162
+572,170
 #Region CallThisProcess
 # A snippet of code provided as an example how to call this process should the developer be working on a system without access to an editor with auto-complete.
 If( 1 = 0 );
-    ExecuteProcess( '}bedrock.hier.leaves.sync', 'pLogOutput', pLogOutput,
-      'pStrictErrorHandling', pStrictErrorHandling,
-	    'pDim', '', 'pHier', '', 'pDelim', '&'
+    ExecuteProcess( '}bedrock.hier.leaves.sync', 'pLogOutput', pLogOutput, 'pStrictErrorHandling', pStrictErrorHandling,
+	    'pDim', '', 'pHier', '', 'pDelim', '&', 'pReverse', 0
 	);
 EndIf;
 #EndRegion CallThisProcess
@@ -117,19 +120,20 @@ cDimDimensions    = '}Dimensions';
 cCharAny          = '?';
 cStringAny        = '*';
 cHierLeaves       = 'Leaves';
-cSubMissing       = 'Missing';
+cRollupOrphan     = 'ORPHAN LEAVES';
 
 ### LogOutput parameters
 IF( pLogoutput >= 1 );
   LogOutput('INFO', Expand( cLogInfo ) );   
 ENDIF;
 
 ### Validate Parameters
-nErrors = 0;
-nDims = 0;
-nDimsChanged = 0;
-nElems = 0;
-sDimPrev = '';
+sDimPrev          = '';
+nErrors           = 0;
+nDims             = 0;
+nDimsChanged      = 0;
+nElems            = 0;
+nLeaves           = 0;
 
 If( Scan( '*', pDim ) = 0 & Scan( '?', pDim ) = 0 & Scan( pDelim, pDim ) = 0 & Scan( ':', pDim ) > 0 & pHier @= '' );
   # A hierarchy has been passed as dimension. Handle the input error by splitting dim:hier into dimension & hierarchy
@@ -149,6 +153,11 @@ If( Trim( pDim ) @= '' );
   LogOutput( cMsgErrorLevel, Expand( cMsgErrorContent ) );
 EndIf;
 
+### Validate reverse sync option
+If( pReverse <> 1 );
+  pReverse = 0;
+EndIf;
+
 ### If errors occurred terminate process with a major error status ###
 If( nErrors <> 0 );
   If( pStrictErrorHandling = 1 ); 
@@ -172,7 +181,7 @@ Else;
     EndIf;
     sSearchDim = TRIM( SUBST( sDimTokenizer, 1, nPos - 1 ) );
     If( sMDX @= '' );
-      sMDX = Expand( '{TM1FILTERBYPATTERN( {TM1SUBSETALL([%cDimDimensions%])}, "%sSearchDim%" )}' );
+      sMDX = Expand( '{TM1FILTERBYPATTERN( {TM1SUBSETALL([%cDimDimensions%])}, "%sSearchDim%*" )}' );
     Else;
       sMDX = Expand( '%sMDX% + {TM1FILTERBYPATTERN( {TM1SUBSETALL([%cDimDimensions%])}, "%sSearchDim%" )}' );
     EndIf;
@@ -189,7 +198,7 @@ If ( TRIM( pHier ) @= cAll );
 Else;
   sHierTokenizer = TRIM( pHier );
   If( sHierTokenizer @= '' );
-    # we need only same named hierarchies - that means to exclude elements that have : in their names
+    # if pHier blank then we need only same named hierarchies - that means to exclude elements that have : in their names
     sMDX = Expand( '{FILTER( %sMDX1%, INSTR([%cDimDimensions%].CurrentMember.Name, '':'' ) = 0 )}' );
   Else;
     sMDX = '';
@@ -212,6 +221,7 @@ Else;
   EndIf;
 EndIf;
 
+sMDX = Expand(' {EXCEPT( %sMDX%, {TM1FILTERBYPATTERN( {TM1SUBSETALL([%cDimDimensions%])}, "*:Leaves" )} )}');
 sMDXF = Expand( '{ORDER( %sMDX%, [%cDimDimensions%].CurrentMember.Name, ASC )}' );
 
 ### Create dimension:hierarchy subset
@@ -225,58 +235,95 @@ DatasourceNameForServer = cDimDimensions;
 DatasourceNameForClient = cDimDimensions;
 DataSourceType = 'SUBSET';
 DatasourceDimensionSubset = cTempSub;
-573,47
+
+### END PROLOG
+573,80
+
 #****Begin: Generated Statements***
 #****End: Generated Statements****
 
-nDelimHier = SCAN( ':', vDimHier );
+# Get dimension & hierarchy from vDimHier
+nDelimHier  = SCAN( ':', vDimHier );
 If ( nDelimHier <> 0 );
-  sDim = SUBST( vDimHier, 1, nDelimHier - 1);
-  sHier = SUBST( vDimHier, nDelimHier + 1, LONG( vDimHier ) - nDelimHier );
+    sDim    = SUBST( vDimHier, 1, nDelimHier - 1);
+    sHier   = SUBST( vDimHier, nDelimHier + 1, LONG( vDimHier ) - nDelimHier );
 Else;
-  sDim = vDimHier;
-  sHier = vDimHier;
+    sDim    = vDimHier;
+    sHier   = vDimHier;
 EndIf;
 
-If ( sHier @= cHierLeaves );
-  ItemSkip;
+If ( sHier  @= cHierLeaves );
+    ItemSkip;
 EndIf;
 
-# Summary information printout
-If ( sDimPrev @<> sDim );
-  If ( sDimPrev @<> '' & nElems <> 0 );
-    sElems = NumberToString( nElems );
-    If ( pLogOutput <> 0 );
-      LogOutput( cMsgInfoLevel, Expand( 'Added [%sElems%] elements into [%cHierLeaves%] hierarchy of [%sDimPrev%] dimension.' ) );
-    EndIf;
-    nDimsChanged = nDimsChanged + 1;
-  EndIf;
-  nDims = nDims + 1;
-  nElems = 0;
-  sDimPrev = sDim;
+# Set check counters
+If( sDim @<> sDimPrev );
+    nDims   = nDims + 1;
 EndIf;
+nElems      = 0;
+nLeaves     = 0;
 
+# Add leaves in hierarchy but (somehow) not in Leaves hierarchy to Leaves
 nElem = 1;
 nMaxElem = ElementCount( sDim, sHier );
 While ( nElem <= nMaxElem );
-  sElem = ElementName( sDim, sHier, nElem );
-  If ( ElementLevel( sDim, sHier, sElem ) = 0 & HierarchyExists( sDim, cHierLeaves ) <> 0 );
-    If ( ElementIndex( sDim, cHierLeaves, sElem ) = 0 );
-      sType = ElementType( sDim, sHier, sElem );
-      HierarchyElementInsert( sDim, cHierLeaves, '', sElem, sType );
-      nElems = nElems + 1;
-      If ( pLogOutput > 1 );
-        LogOutput( cMsgInfoLevel, Expand( 'Adding element [%sElem%] of [%sType%] type into [%cHierLeaves%], element was found in hierarchy [%sHier%].' ) );
-      EndIf;
+    sElem = ElementName( sDim, sHier, nElem );
+    If ( ElementLevel( sDim, sHier, sElem ) = 0 & HierarchyExists( sDim, cHierLeaves ) = 1 );
+        If ( ElementIndex( sDim, cHierLeaves, sElem ) = 0 & ElementType( sDim, sHier, sElem ) @= 'N' );
+            HierarchyElementInsert( sDim, cHierLeaves, '', sElem, 'N' );
+            nElems = nElems + 1;
+            If ( pLogOutput <> 0 );
+                LogOutput( cMsgInfoLevel, Expand( 'Adding element [%sElem%] of [%sType%] type into [%cHierLeaves%], element was found in hierarchy [%sHier%].' ) );
+            EndIf;
+        EndIf;
     EndIf;
-  EndIf;
-  nElem = nElem + 1;
+    nElem = nElem + 1;
 End;
 
-574,2
+# Add leaves not existing in hierarchy to the 'ORPHAN LEAVES' consolidation
+If( pReverse = 1 & HierarchyExists( sDim, cHierLeaves ) = 1 );
+    nLeaf = 1;
+    nMaxLeaves = ElementCount( sDim, cHierLeaves );
+    While ( nLeaf <= nMaxLeaves );
+        sLeaf = ElementName( sDim, cHierLeaves, nLeaf );
+        If ( ElementIndex( sDim, sHier, sLeaf ) = 0 );
+            HierarchyElementInsert( sDim, sHier, '', cRollupOrphan, 'C' );
+            HierarchyElementInsert( sDim, sHier, '', sLeaf, 'N' );
+            HierarchyElementComponentAdd( sDim, sHier, cRollupOrphan, sLeaf, 1 );
+            nLeaves = nLeaves + 1;
+            If ( pLogOutput <> 0 );
+                LogOutput( cMsgInfoLevel, Expand( 'Adding leaf [%sLeaf%] into hierarchy [%sHier%].' ) );
+            EndIf;
+        EndIf;
+        nLeaf = nLeaf + 1;
+    End;
+EndIf;
+
+# Summary information printout
+If( nElems  > 0 );
+    sElems  = NumberToString( nElems );
+    If ( pLogOutput <> 0 );
+        LogOutput( cMsgInfoLevel, Expand( 'Added [%sElems%] elements from hierarchy [%sHier%] into [%cHierLeaves%] hierarchy of [%sDim%] dimension.' ) );
+    EndIf;
+EndIf;
+If( nLeaves > 0 );
+    sLeaves = NumberToString( nLeaves );
+    If ( pLogOutput <> 0 );
+        LogOutput( cMsgInfoLevel, Expand( 'Added [%sLeaves%] leaves into hierarchy [%sHier%] of [%sDim%] dimension.' ) );
+    EndIf;
+EndIf;
+If( sDim @<> sDimPrev & (nElems + nLeaves) > 0 );
+    nDimsChanged = nDimsChanged + 1;
+EndIf;
+sDimPrev    = sDim;
+
+### END METADATA
+574,4
+
 #****Begin: Generated Statements***
 #****End: Generated Statements****
-575,38
+
+575,37
 #****Begin: Generated Statements***
 #****End: Generated Statements****
 
@@ -299,8 +346,8 @@ EndIf;
 If ( nDims <> 0 );
   sDims = NumberToString( nDims );
   sDimsChanged = NumberToString( nDimsChanged );
-  If ( nDimsChanged <> 0 );
-    sProcessAction = Expand( 'Modified [%sDimsChanged%] dimensions out of [%sDims%] matching.' );
+  If ( nDimsChanged > 0 );
+    sProcessAction = Expand( 'Modified [%sDimsChanged%] dimensions out of [%sDims%] matching the filter.' );
   Else;
     sProcessAction = Expand( 'Scanned [%sDims%] dimensions, all are ok.' );
   EndIf;
@@ -313,8 +360,7 @@ If( pLogoutput <> 0 );
     LogOutput( cMsgInfoLevel, Expand( sProcessAction ) );   
 EndIf;
 
-
-
+### END EPILOG
 576,
 930,0
 638,1