PI Powershell

StartPIArchiveReprocess Class

Save PDF

TABLE OF CONTENTS

StartPIArchiveReprocess Class

Save PDF

Last UpdatedDec 15, 2025
3 minute read

PI System
Powershell Tools for the PI System 2024 R2
Developer

Starts/queues a PI Archive to be reprocessed

The Start-PIArchiveReprocess cmdlet queues/starts a PI Archive to be reprocessed.

This cmdlet is only supported on PI Data Archive 2016 or later.

The connection parameter specifies which connection to a PI Data Archive to use.

Inheritance Hierarchy

SystemObject
  InternalCommand
    Cmdlet
      PSCmdlet
        OSIsoft.PowerShellOSICmdletBase
          OSIsoft.PowerShellOSICmdletBaseWithConnection
            OSIsoft.PowerShellStartPIArchiveReprocess

Namespace: OSIsoft.PowerShell
Assembly: OSIsoft.PowerShell (in OSIsoft.PowerShell.dll) Version: 3.1.1.0 (3.1.1.466)

Syntax

[CmdletAttribute("Start", "PIArchiveReprocess", SupportsShouldProcess = true)]
public class StartPIArchiveReprocess : OSICmdletBaseWithConnection

<CmdletAttribute("Start", "PIArchiveReprocess", SupportsShouldProcess := true)>
Public Class StartPIArchiveReprocess
	Inherits OSICmdletBaseWithConnection

Dim instance As StartPIArchiveReprocess

[CmdletAttribute(L"Start", L"PIArchiveReprocess", SupportsShouldProcess = true)]
public ref class StartPIArchiveReprocess : public OSICmdletBaseWithConnection

[<CmdletAttribute("Start", "PIArchiveReprocess", SupportsShouldProcess = true)>]
type StartPIArchiveReprocess =  
    class
        inherit OSICmdletBaseWithConnection
    end

The StartPIArchiveReprocess type exposes the following members.

Constructors

	Name	Description
	StartPIArchiveReprocess

Properties

	Name	Description
	Connection	Connection to a PI Data Archive for which to start/queue an archive reprocess (Overrides OSICmdletBaseWithConnectionConnection.)
	DeleteInputArchive	Automatically delete specified archive(s) upon successful reprocessing
	Name	Name of the archive or archives to reprocess
	RegistrationState	Registration state of the reprocessed archive(s) MaintainRegistration = Maintain registration state of input archive Register = Attempt to register reprocessed archive DoNotRegister = Do not attempt to register reprocessed archive

Examples

Start-PIArchiveReprocess -Name "F:\PIArchives\piarch001.arc" -RegistrationState Register -Connection (Connect-PIDataArchive -PIDataArchiveMachineName "PISRV1")

Starts/queues the piarch001.arc archive for reprocessing on the "PISRV1" PI Data Archive. After reprocessing, the resulting archive will attempt to be registered.

Examples

Start-PIArchiveReprocess -Name "F:\PIArchives\piarch001.arc","F:\PIArchives\piarch002.arc" -RegistrationState DoNotRegister -Connection $con

Where:

$con = Connect-PIDataArchive -PIDataArchiveMachineName "PISRV1"

Queues two archives for reprocessing: "piarch001.arc" and "piarch002.arc". Following successful reprocessing, do not attempt to register reprocessed archives.

When queueing multiple archives for reprocessing, use "Get-PIArchiveReprocessQueue" to view status of queued reprocess requests. Run "Get-Help Get-PIArchiveReprocessQueue -Full" for more information.

Examples

Start-PIArchiveReprocess -Name "E:\Program Files\PI\arc\piarch001.arc" -RegistrationState MaintainRegistration -Connection $con -DeleteInputArchive

Where:

$con = Connect-PIDataArchive -PIDataArchiveMachineName "PISRV1"

Starts reprocessing "piarch001.arc" on the "PISRV1" PI Data Archive. Following successful reprocessing, maintain the registration status of input archive. If input archive was registered, attempt to register output archive. If input was not registered, do not attempt to register output archive.

Upon successful reprocessing, this example will delete the input archive. This option should be used with caution so as to not mistakenly delete archive files.

PI Powershell