Skip to content

Wait-RSJob - customizable progress bar #209

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
jeffchulg wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Wait-RSJob - customizable progress bar #209

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e56fba2
Update Wait-RSJob - add flexible title
jeffchulg Aug 31, 2020
6ef49c7
Update wait-rsjob - add documentation
jeffchulg Aug 31, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 34 additions & 3 deletions PoshRSJob/Public/Wait-RSJob.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,14 @@ Function Wait-RSJob {

.PARAMETER ShowProgress
Displays a progress bar

.PARAMETER ProgressBarTitle
When ShowProgress is set to $True, defines the title of the displayed Progress Bar.
Default Value: "RSJobs Tracker"

.PARAMETER ProgressBarMessage
When ShowProgress is set to $True, defines the message of the displayed Progress Bar.
Default Value: "Remaining Jobs"

.NOTES
Name: Wait-RSJob
Expand Down Expand Up @@ -81,12 +89,35 @@ Function Wait-RSJob {
[ValidateSet('NotStarted','Running','Completed','Failed','Stopping','Stopped','Disconnected')]
[string[]]$State,
[int]$Timeout,
[switch]$ShowProgress
[Boolean]$ShowProgress = $false,

[parameter(ParameterSetName='Batch')]
[parameter(ParameterSetName='Name')]
[parameter(ParameterSetName='Id')]
[parameter(ParameterSetName='InstanceID')]
[parameter(ParameterSetName='All')]
[String]$ProgressBarTitle = "RSJobs Tracker",


[parameter(ParameterSetName='Batch')]
[parameter(ParameterSetName='Name')]
[parameter(ParameterSetName='Id')]
[parameter(ParameterSetName='InstanceID')]
[parameter(ParameterSetName='All')]
[String]$ProgressBarMessage = "Remaining Jobs"
)
Begin {
If ($PSBoundParameters['Debug']) {
$DebugPreference = 'Continue'
}

if([String]::isNullOrEmpty($ProgressBarTitle)) {
$ProgressBarTitle = "RSJobs Tracker"
}
if([String]::isNullOrEmpty($ProgressBarMessage)) {
$ProgressBarMessage = "Remaining Jobs"
}

$List = New-Object System.Collections.ArrayList
}
Process {
Expand Down Expand Up @@ -132,14 +163,14 @@ Function Wait-RSJob {
Write-Debug "Total: ($Totaljobs)"
Write-Debug "Status: $($Completed/$TotalJobs)"
If ($ShowProgress) {
Write-Progress -Activity "RSJobs Tracker" -Status ("Remaining Jobs: {0}" -f $Waitjobs.Count) -PercentComplete (($Completed/$TotalJobs)*100)
Write-Progress -Activity $ProgressBarTitle -Status ("${ProgressBarMessage}: {0}" -f $Waitjobs.Count) -PercentComplete (($Completed/$TotalJobs)*100)
}
if($Timeout -and (New-Timespan $Date).TotalSeconds -ge $Timeout){
break
}
}
If ($ShowProgress) {
Write-Progress -Activity "RSJobs Tracker" -Completed
Write-Progress -Activity $ProgressBarTitle -Completed
}
}
}