PowerCds

2.0.0.51

Functions/Audit/Get-CdsAuditHistory.ps1

                                <#

    .SYNOPSIS

    Retrieve audit for given record.

#>

function Get-CdsAuditHistory {

    [CmdletBinding()]

    param

    (        

        [Parameter(Mandatory = $false, ValueFromPipeline)]

        [Microsoft.Xrm.Tooling.Connector.CrmServiceClient]

        $CdsClient = $Global:CdsClient,

        [Parameter(Mandatory = $true, ValueFromPipeline)]

        [Microsoft.Xrm.Sdk.EntityReference]

        $RecordReference,

        [Parameter(Mandatory = $false)]

        [String[]]

        $AttributeFilter

    )

    begin {   

        $StopWatch = [System.Diagnostics.Stopwatch]::StartNew(); 

        Trace-CdsFunction -Name $MyInvocation.MyCommand.Name -Stage Start -Parameters ($MyInvocation.MyCommand.Parameters); 

    }    

    process {

        $auditLogs = @();

        $retrieveRecordChangeHistoryRequest = New-Object -TypeName Microsoft.Crm.Sdk.Messages.RetrieveRecordChangeHistoryRequest;

        $retrieveRecordChangeHistoryRequest.Target = $RecordReference;

        $retrieveRecordChangeHistoryReponse = Protect-CdsCommand -ScriptBlock { $CdsClient.Execute($retrieveRecordChangeHistoryRequest) };

        foreach ($auditDetail in $retrieveRecordChangeHistoryReponse.AuditDetailCollection.AuditDetails) {

            $attributes = @();

            $auditDetail.NewValue.Attributes | ForEach-Object { $attributes += $_.Key; };

            $auditDetail.OldValue.Attributes | ForEach-Object { if (-not $attributes.Contains($_.Key)) { $attributes += $_.Key; } };

            foreach ($attributeName in $attributes) {

                if($null -eq $attributeName)

                {

                    # Weird case : sometimes $attributes collection contains only 1 $null value                    

                    continue;

                }

                if($AttributeFilter -and ($AttributeFilter.Contains($attributeName) -eq $false))

                {

                    continue;

                }

                $auditRecord = $auditDetail.AuditRecord;

                $hash = @{};

                $hash["Object"] = $auditRecord.FormattedValues["objecttypecode"];

                $hash["Id"] = $auditRecord["objectid"].Id;

                $hash["Key"] = $RecordReference.Id;

                $hash["AttributeName"] = $attributeName;

                $hash["CreatedOn"] = $auditRecord.FormattedValues["createdon"];

                $hash["User"] = $auditRecord["userid"].Name;

                $hash["Operation"] = $auditRecord.FormattedValues["operation"];

                $hash["Action"] = $auditRecord.FormattedValues["action"];

                $hash["OldValue"] = $auditDetail.OldValue.Record | Get-CdsAttributeValue -Name $attributeName -FormattedValue

                $hash["NewValue"] = $auditDetail.NewValue.Record | Get-CdsAttributeValue -Name $attributeName -FormattedValue;

                $auditLog = New-Object PsObject -Property $hash;

                $auditLogs += $auditLog;

            }

        }

        $auditLogs;

    }

    end {

        $StopWatch.Stop();

        Trace-CdsFunction -Name $MyInvocation.MyCommand.Name -Stage Stop -StopWatch $StopWatch;

    }    

}

Export-ModuleMember -Function Get-CdsAuditHistory -Alias *;