Update powerJobs Processor to current version

Summary of changes that need to be done when updating powerJobs Processor from v17 or newer to the latest version

When updating to the current version execute all the steps after your current version to the end. For example when updating from v19.0.7 to current version start with instructions for 21.0.12.

When updating powerJobs Processor to a newer version make sure to transfer only the scripts, modules and configuration file that were customized. The sample jobs and the modules that are delivered with powerJobs Processor should not be transferred. Instead, the files from the new version should be used

When using external APIs like the Inventor or Vault API you have to verify if an update to a newer version might break your custom code.

powerJobs Processor also installs and updates powerVault. powerVault changes described in this article also apply.

Updating to 16.1.28

If you are on powerJobs older than 16.1.25 refer to the article "Update powerJobs from earlier versions to 16.1"

Updating to 18.0.11

The Add-Log commandlet has been replaced by Write-Host. Write-Host is a generic PowerShell cmdlet which doesn't require maintenance from us. The log window will display messages you pass to Write-Host

#Replace cmdlet
Add-Log
Add-Log -Message

#With
Write-Host
Write-Host -Object

Updating to 19.0.7

The return value of Open-Document, Export-Document, and Close-Document has been changed. Instead of a simple text message it now contains a complex Error object. You have to check how the actual result objects are called in your script before you replace them.

If .ErrorMessage is used it needs to be replaced by .Error.Message.

#Replace cmdlet
$openResult = Open-Document ...
$openResult.ErrorMessage

#With
$openResult = Open-Document ...
$openResult.Error.Message

#Replace cmdlet
$exportResult = Export-Document ...
$exportResult.ErrorMessage

#With
$exportResult = Export-Document ...
$exportResult.Error.Message

#Replace cmdlet
$closeResult = Close-Document ...
$closeResult.ErrorMessage

#With
$closeResult = Close-Document ...
$closeResult.Error.Message

Updating to 21.0.12

The $powerJobs object has been removed

# Replace 
$powerJobs.Applications 

# with 
$Host.Applications

The environment variable POWERJOBS_DLL has been renamed to POWERJOBS_PROCESSORDIR

# Replace
$env:POWERJOBS_DLL

# with
$env:POWERJOBS_PROCESSORDIR

Changes to licensing

There were changes made to the licensing so you need to reactivate your license. If you are updating from v19 or earlier the license key changes. On your license certificate you can find a V20 key.

Changes to job register

There were changes to the way jobs are registered so you have to start powerJobs.exe at least one time after the update

Updating to 22.0.22

$changeOrder has been changed to powerVault object

The $changeOrder variable now contains a powerVault change order object instead of a Vault change order object

# Replace
$changeOrder.EntityIterationId 

# With
$changeOrder.Id

# Replace
$changeOrder.Number

# With
$changeOrder._Number

Changes to custom applications

If you are using custom applications you need to make changes to your custom app. Details in Changelog.

powerJobs.Common.dll needs to be re-referenced from GAC
coolorange.GenerateEngine needs to be removed from your project
Namespace coolOrange.GenerateEngine needs to be replaced by powerJobs.Common.Application

Updating to 23.0.8

The function Test-ApplicationSupportsDocument was removed

The function "Test-ApplicationSupportsDocument" was removed from the module "coolOrange.Applications.psm1". This function provided information if a specific application supports opening a document.

# Replace
if (Test-ApplicationSupportsDocument -Application 'Inventor' -Document 'C:\Vault\Inventor\Pad Lock.dwg') {
    Write-Host "This is an Inventor DWG file"
}

# With
$file = Get-VaultFile -File 'C:\Vault\Inventor\Pad Lock.dwg'
if ($file._Provider -eq "Inventor DWG") {
    Write-Host "This is an Inventor DWG file"
}

Updating to 26.0.1

Generally, no breaking changes are expected with upgrades from previous versions with powerJobs functionality.

However, if you are using Vault 2026 and customized your jobs there might be breaking changes due to the change to PowerShell 7

In that case, you’ll need to adjust these customization scripts to ensure compatibility with PowerShell 7

For more details, Microsoft provides information on missing cmdlets and other potential differences between Windows PowerShell and PowerShell 7.4.

Most functions in System.IO now have a (ReadOnlySpan<Char>) constructor in addition to the (string) constructor. This might cause issues when passing in anything else then a string.