Cmdlet

Invoke-OfficeConversionJob

Module PSWriteOffice

Inputs

None

Outputs

OfficeIMO.Workflows.OfficeConversionBatchResult OfficeIMO.Workflows.OfficeConversionBatchItemResult OfficeIMO.Workflows.OfficeConversionJobPlan

Source

InvokeOfficeConversionJobCommand.cs:27 Edit on GitHub

Plans or runs a saved conversion job through the same runner as Studio and the CLI.

Syntax

Invoke-OfficeConversionJob [-AllowEmpty] [-ItemResults] [-Path] <String> [-Plan] [-ReportPath <String>] [-RetryFailed] [-SummaryVariable <String>] [<CommonParameters>]

Parameter set: All Parameter Sets

Description

Requires PowerShell 7.4 or newer. Plan performs no output or checkpoint writes. Execution revalidates current inputs and retains completed artifacts after a partial failure or cancellation. Password environment references are resolved only for execution; values are not written to the job or reports.

Examples

Authored help example

Inspect selected files, destinations and prerequisites before executing a saved job.

Invoke-OfficeConversionJob -Path ./monthly.officejob.json -Plan
Invoke-OfficeConversionJob -Path ./monthly.officejob.json -ItemResults -SummaryVariable summary -ErrorAction Stop

Resume a checkpoint job and retry recorded failures.

Invoke-OfficeConversionJob -Path ./monthly.officejob.json -RetryFailed -ErrorAction Stop

Parameters

-AllowEmpty SwitchParameter optional: Allow execution to select no supported inputs without reporting an error.
-ItemResults SwitchParameter optional: Stream per-file outcomes instead of only the final bounded summary.
-Path String requiredposition: 0aliases: FullName, LiteralPath: Literal saved-job JSON path. Relative paths in the job resolve against this file's folder.
-Plan SwitchParameter optional: Inspect the job without converting files or creating output/checkpoint state.
-ReportPath String optional: New run-report JSON path outside the job's source, output and checkpoint trees. Existing files are preserved.
-RetryFailed SwitchParameter optional: Retry failed checkpoint items while verifying completed artifacts.
-SummaryVariable String optional: Variable receiving the completed plan or batch summary, including when ItemResults is selected.

Common Parameters

This command supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable.

For more information, see about_CommonParameters.