}bedrock.hier.consol.delete.md

#region Prolog #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.consol.delete', 'pLogOutput', pLogOutput, 'pStrictErrorHandling', pStrictErrorHandling, 'pDim', '', 'pHier', '', 'pEle', '', 'pDelim', '&' ); EndIf; #EndRegion CallThisProcess

#*Begin: Generated Statements #End: Generated Statements

################################################################################################# ##Join the bedrock TM1 community on GitHub https://github.com/cubewise-code/bedrock Ver 4.0## #################################################################################################

#Region @DOC

Description:

This process will delete a specified C-Level item or ALL consolidations in the dimension hierarchy.

Use case: Could be used during development or in production.

1/ Delete a specific or all C-Level items in a hierarchy.

Note:

Valid dimension name (pDim) is mandatory otherwise the process will abort. Control dimensions are excluded.

The hierarchy (pHier) will default to pDim if not specified, otherwise it must be valid else the process will abort.

ALL consoldidated items in hierarchy will be deleted if consolidated item (pEle) is specified as *, otherwise it needs to contain valid c-level item(s).

Caution: Target hierarchy (pHier) cannot be Leaves.

#EndRegion @DOC

##Global Variables StringGlobalVariable('sProcessReturnCode'); NumericGlobalVariable('nProcessReturnCode'); nProcessReturnCode= 0;

Constants

cThisProcName = GetProcessName(); cTimeStamp = TimSt( Now, '\Y\m\d\h\i\s' ); cRandomInt = NumberToString( INT( RAND( ) * 1000 )); cTempSub = cThisProcName |''| cTimeStamp |''| cRandomInt; cUserName = TM1User(); cMsgErrorLevel = 'ERROR'; cMsgErrorContent = 'User:%cUserName% Process:%cThisProcName% ErrorMsg:%sMessage%'; cLogInfo = 'Process:%cThisProcName% run with parameters pDim:%pDim%, pHier:%pHier%, pEle:%pEle%, pDelim:%pDelim%.';

LogOutput parameters

IF( pLogoutput = 1 ); LogOutput('INFO', Expand( cLogInfo ) );
ENDIF;

Validate Parameters

nErrors = 0;

If( Scan( ':', pDim ) > 0 & pHier @= '' ); # A hierarchy has been passed as dimension. Handle the input error by splitting dim:hier into dimension & hierarchy pHier = SubSt( pDim, Scan( ':', pDim ) + 1, Long( pDim ) ); pDim = SubSt( pDim, 1, Scan( ':', pDim ) - 1 ); EndIf;

Validate Dimension

If( Trim( pDim ) @= '' ); nErrors = 1; sMessage = 'No dimension specified.'; LogOutput( cMsgErrorLevel, Expand( cMsgErrorContent ) ); ElseIf( DimensionExists( pDim ) = 0 ); nErrors = 1; sMessage = 'Dimension: ' | pDim | ' does not exist on server.'; LogOutput( cMsgErrorLevel, Expand( cMsgErrorContent ) ); EndIf;

Validate Hierarchy

IF(pHier @= 'Leaves' ); nErrors = 1; sMessage = 'Invalid Hierarchy: ' | pDim |':'|pHier; LogOutput( cMsgErrorLevel, Expand( cMsgErrorContent ) ); EndIf;

Validate Elements

IF(pEle @= '' ); nErrors = 1; sMessage = 'Element cannot be empty. Use * for all elements'; LogOutput( cMsgErrorLevel, Expand( cMsgErrorContent ) ); EndIf;

If( Trim( pHier ) @= '' ); sHier = pDim; Else; sHier = pHier; EndIf;

If( HierarchyExists( pDim, sHier ) = 0 ); nErrors = 1; sMessage = 'The Hierarchy ' | sHier | ' does not exist.'; LogOutput( cMsgErrorLevel, Expand( cMsgErrorContent ) ); EndIf;

If blank delimiter specified then convert to default

If( pDelim @= '' ); pDelim = '&'; EndIf;

Check for errors before continuing

If( nErrors > 0 ); If( pStrictErrorHandling = 1 ); ProcessQuit; Else; ProcessBreak; EndIf; EndIf;

sEles = pEle; nDelimiterIndex = 1; While( nDelimiterIndex <> 0 );

nDelimiterIndex = Scan( pDelim, sEles );
If( nDelimiterIndex = 0 );
    sEle = sEles;
Else;
    sEle = Trim( SubSt( sEles, 1, nDelimiterIndex - 1 ) );
    sEles = Trim( Subst( sEles, nDelimiterIndex + Long(pDelim), Long( sEles ) ) );
EndIf;

# Check if a wildcard has been used to specify the Element name.
# If it hasn't then just delete the Element if it exists
If( sEle @= '*' );
    nElementIndex = Dimsiz(pDim|':'|sHier);
    While( nElementIndex >= 1 );
        sEle = ElementName( pDim, sHier, nElementIndex );
        sElType = ElementType( pDim, sHier, sEle );
        If( sElType @= 'C' );
            HierarchyElementDelete( pDim, sHier,sEle );
        EndIf;
        nElementIndex = nElementIndex - 1;
    End;
ElseIf( Scan( '*', sEle ) = 0);
    If( HierarchyElementExists( pDim,sHier, sEle ) = 1 );
        sElType = ElementType( pDim, sHier, sEle ); 
        If( sElType @='C' );
            HierarchyElementDelete( pDim, sHier,sEle );
        EndIf;
    Else;
        nErrors = 1;
        sMessage = 'The Hierarchy ' | sHier | ' does not have element ' | sEle;
        LogOutput( cMsgErrorLevel, Expand( cMsgErrorContent ) );
    EndIf;
Else;
    # Wildcard search string
    sEle    = '"'|sEle|'"';
    sProc   = '}bedrock.hier.sub.create.bymdx';
    sMdx    = '{TM1FILTERBYPATTERN( {TM1SUBSETALL([ ' |pDim|':'|sHier |' ])},'| sEle| ')}';
    ExecuteProcess('}bedrock.hier.sub.create.bymdx',
      'pLogOutput', pLogOutput,
      'pStrictErrorHandling', pStrictErrorHandling,
    	'pDim', pDim,
    	'pHier', sHier,
    	'pSub', cTempSub,
    	'pMDXExpr', sMdx,
    	'pConvertToStatic', 1,
    	'pTemp', 1
    );
    nCount = HierarchySubsetGetSize(pDim, sHier, cTempSub);
    While( nCount >= 1 );
        sElement = HierarchySubsetGetElementName(pDim, sHier, cTempSub, nCount);
        sElType = ElementType( pDim, sHier, sElement );
        If( sElType @= 'C' );
            HierarchyElementDelete( pDim, sHier,sElement );
        EndIf;  
        nCount = nCount - 1;
    End;
EndIf;

End;

End Prolog

#endregion #region Metadata

#*Begin: Generated Statements #End: Generated Statements

#endregion #region Data

#*Begin: Generated Statements #End: Generated Statements #endregion #region Epilog

#*Begin: Generated Statements #End: Generated Statements

################################################################################################# ##Join the bedrock TM1 community on GitHub https://github.com/cubewise-code/bedrock Ver 4.0## #################################################################################################

Return code & final error message handling

If( nErrors > 0 ); sMessage = 'the process incurred at least 1 error. Please see above lines in this file for more details.'; nProcessReturnCode = 0; LogOutput( cMsgErrorLevel, Expand( cMsgErrorContent ) ); sProcessReturnCode = Expand( '%sProcessReturnCode% Process:%cThisProcName% completed with errors. Check tm1server.log for details.' ); If( pStrictErrorHandling = 1 ); ProcessQuit; EndIf; Else; sProcessAction = Expand( 'Process:%cThisProcName% successfully deleted the appropriate consolidated elements in hierarchy %pDim%:%pHier%.' ); sProcessReturnCode = Expand( '%sProcessReturnCode% %sProcessAction%' ); nProcessReturnCode = 1; If( pLogoutput = 1 ); LogOutput('INFO', Expand( sProcessAction ) );
EndIf; EndIf;

End Epilog

#endregion