OfficeC2RClient.exe get progress state

Question

OfficeC2RClient.exe get progress state

Kevin Schweiger 41

Hello,

I would like to implement Office updates into our scheduled maintenance automation. Therefore, using OfficeC2RClient.exe and a CMD should be a convenient way to achieve this. I'm using the following parameters:

"C:\Program Files\Common Files\microsoft shared\ClickToRun\OfficeC2RClient.exe" /update user displaylevel=false forceappshutdown=true

Unfortunately, OfficeC2RClient works asynchron and delivers no state at all. It's just fire and forget. But for monitoring and reporting purposes we need to track the progress and get a final state (success, error, anything else). I've already tried a couple of different things:

Start as process in PowerShell and check if "OfficeC2RClient.exe" is running
Check logfiles in Temp directory

Both approaches are not optimal and have some downsides.

Do you have any idea, how to achieve this in the most simple and consistent way?

Eduardo Vizintin 0 Reputation points

2024-09-30T22:26:47.08+00:00

I am scripting the update of O365 and I did not find a way to get the return code of the installation as, mentioned by Kevin, it closes as soon as it is launched and launches other processes with OfficeClickToRun.exe

DIBA_ITech 20

Hi,
I managed to get notified when the installer ends, with the following script:

Function Wait-LogEvent {
    $taskComplete = $false
    $fileCount    = 0
    $jobList      = New-Object -TypeName "System.Collections.ArrayList"
    $startTime    = $(Get-Date -Format "MM/dd/yyyy HH:mm:ss")
    Write-Host "Waiting for TaskUpdate completion. Press ESC to end log monitoring..."
    While ( -Not $taskComplete ) {
        # Add one job per each new log file
        $latestFiles = Get-ChildItem -path "$env:WINDIR\Temp\${env:COMPUTERNAME}-*.log" |
                            Where-Object {$_.LastWriteTime -gt (Get-Date).AddHours(-1)}
        if ( $latestFiles.count -gt $fileCount ) {
            $latestFiles | Select -Last $( $latestFiles.count - $fileCount) | ForEach-Object {
                $lastLogFileName = $_.FullName
                $job = Start-job { Get-Content $using:lastLogFileName -Wait } # end Start-Job
                Write-Verbose "New job created to watch file: $lastLogFileName"
                $jobList.Add($job) | Out-Null
                $fileCount++
            } # end ForEach-Object
        } # end if
        # Let the jobs work for at least 2 seconds
        Start-Sleep -Seconds 2
        # Read the received new log file content
        While ($lines = Receive-Job $jobList) {
            $lines | ForEach-Object {
               # Skip logs older than log monitoring start time
               # Otherwise, verify if new line matches any pattern
               if ( $_.substring(0,19) -lt $startTime ) {
                   # Skip line
                   [void] 'noop'
               } elseif ($_ -like '*TaskUpdateFinalize::DoExecute*UpdateFinalize complete.*') {
                   # Output matching line
                   Write-host $_
                   $taskComplete = $true
                   break
               } elseif ($_ -like '*TaskUpdateDetection::Execute: Already up to date.*') {
                   # Output matching line
                   Write-host $_
                   $taskComplete = $true
                   break
               } else {
                   Write-Verbose $_
               } # end if
            } # end ForEach
        } # end While
        # Break loop if ESC key is pressed
        if ($host.ui.RawUi.KeyAvailable) {
            $key = $host.ui.RawUI.ReadKey("NoEcho,IncludeKeyUp,IncludeKeyDown")
           if ($key.VirtualKeyCode -eq 27 ) {
                Write-Host ("Stopped") -ForegroundColor Green
                $taskComplete = $true
                break
            } # end if
        } # end if
    } # end While
    Remove-Job $jobList -Force
} # end Function

Hoping that this code might be useful for someone.

Best regards,

DIBA_ITech 20

I have also collected some wildcard expressions (to be used with -like, instead of -match)
to identify key stages during the Office updates installation progress:

$InstallStages = @{
1 = "*::QueueUpdate*C2RClientVer*Triggering an update";
2 = "*TaskFactory::TryLoadScenario - Start loading UPDATE scenario*";
3 = "*TaskUpdateDetection::Execute: Package update available to download for major version*";
4 = "*TaskUpdateClientDownload::DoExecute: Starting update client download task*";
5 = "*C2R::Worker::TaskExecutionThreadProc*UPDATEDOWNLOAD*TASKSTATE_COMPLETED*";	
6 = "*TaskUpdateApply::DoExecute*UPDATEAPPLY*Proceeding with update apply*";
7 = "*C2R::TaskUpdateApply::ShutdownService*UPDATEAPPLY*Stopping the service*";
8 = "*C2R::TaskUpdateApply::ShutdownService*UPDATEAPPLY*Service stopped*";
9 = "*C2R::TaskUpdateApply::ApplyClient*UPDATEAPPLY*Applying files from*";
10 = "*TaskUpdateApply::DoExecute*UPDATEAPPLY*Package Update Complete*";
11 = "*C2R::Worker::TaskExecutionThreadProc*UPDATEAPPLY*TASKSTATE_COMPLETED*";
12 = "*ActivityStarted*Office.ClickToRun.EnsureScheduledTaskIsCreated*";
13 = "*ActivityEnded*Office.ClickToRun.EnsureScheduledTaskIsCreated*";
14 = "*TaskUpdateFinalize::ReportInstalledProducts*UPDATEFINALIZE*";
15 = "*TaskUpdateFinalize::DoExecute*UPDATEFINALIZE*UpdateFinalize complete*"; 
}

In case one would want to implement a verbose version of the script above.

Your answer

Eduardo Vizintin 0 Reputation points

2024-09-30T22:26:47.08+00:00

I am scripting the update of O365 and I did not find a way to get the return code of the installation as, mentioned by Kevin, it closes as soon as it is launched and launches other processes with OfficeClickToRun.exe
DIBA_ITech 20 Reputation points

2024-12-13T12:34:46.8666667+00:00

I have also collected some wildcard expressions (to be used with -like, instead of -match)
to identify key stages during the Office updates installation progress:

$InstallStages = @{ 1 = "*::QueueUpdate*C2RClientVer*Triggering an update"; 2 = "*TaskFactory::TryLoadScenario - Start loading UPDATE scenario*"; 3 = "*TaskUpdateDetection::Execute: Package update available to download for major version*"; 4 = "*TaskUpdateClientDownload::DoExecute: Starting update client download task*"; 5 = "*C2R::Worker::TaskExecutionThreadProc*UPDATEDOWNLOAD*TASKSTATE_COMPLETED*"; 6 = "*TaskUpdateApply::DoExecute*UPDATEAPPLY*Proceeding with update apply*"; 7 = "*C2R::TaskUpdateApply::ShutdownService*UPDATEAPPLY*Stopping the service*"; 8 = "*C2R::TaskUpdateApply::ShutdownService*UPDATEAPPLY*Service stopped*"; 9 = "*C2R::TaskUpdateApply::ApplyClient*UPDATEAPPLY*Applying files from*"; 10 = "*TaskUpdateApply::DoExecute*UPDATEAPPLY*Package Update Complete*"; 11 = "*C2R::Worker::TaskExecutionThreadProc*UPDATEAPPLY*TASKSTATE_COMPLETED*"; 12 = "*ActivityStarted*Office.ClickToRun.EnsureScheduledTaskIsCreated*"; 13 = "*ActivityEnded*Office.ClickToRun.EnsureScheduledTaskIsCreated*"; 14 = "*TaskUpdateFinalize::ReportInstalledProducts*UPDATEFINALIZE*"; 15 = "*TaskUpdateFinalize::DoExecute*UPDATEFINALIZE*UpdateFinalize complete*"; }

In case one would want to implement a verbose version of the script above.

Share via

OfficeC2RClient.exe get progress state

Your answer