PI Powershell

StartPIAFLinkBatchDatabaseAnalysis Class

Save PDF

StartPIAFLinkBatchDatabaseAnalysis Class

Save PDF

Last UpdatedDec 15, 2025
3 minute read

Starts an analysis of the PI Batch Database for Batch Database to Event Frames Migration

The Start-PIAFLinkBatchDatabaseAnalysis cmdlet starts the analysis of the PI Batch Database by the AF Link Subsystem. This information obtained from the analysis is used to address potential issues when preparing to perform a migration from PI Batch Database to Event Frames.

An XML report is generated with the detailed results of the analysis. Use the Get-PIAFLinkBatchDatabaseAnalysisStatus cmdlet to get an overview of the analysis, as well as retrieve the path to the analysis XML report. Use "Get-Help Get-AFLinkBatchDatabaseAnalysisStatus -Full" for more information.

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

Inheritance Hierarchy

SystemObject
  InternalCommand
    Cmdlet
      PSCmdlet
        OSIsoft.PowerShellOSICmdletBase
          OSIsoft.PowerShellStartPIAFLinkBatchDatabaseAnalysis

Namespace: OSIsoft.PowerShell
Assembly: OSIsoft.PowerShell (in OSIsoft.PowerShell.dll) Version: 2.2.3.0 (2.2.3.952)

Syntax

[CmdletAttribute("Start", "PIAFLinkBatchDatabaseAnalysis", SupportsShouldProcess = true)]
public class StartPIAFLinkBatchDatabaseAnalysis : OSICmdletBase

<CmdletAttribute("Start", "PIAFLinkBatchDatabaseAnalysis", SupportsShouldProcess := true)>
Public Class StartPIAFLinkBatchDatabaseAnalysis
	Inherits OSICmdletBase

Dim instance As StartPIAFLinkBatchDatabaseAnalysis

[CmdletAttribute(L"Start", L"PIAFLinkBatchDatabaseAnalysis", SupportsShouldProcess = true)]
public ref class StartPIAFLinkBatchDatabaseAnalysis : public OSICmdletBase

[<CmdletAttribute("Start", "PIAFLinkBatchDatabaseAnalysis", SupportsShouldProcess = true)>]
type StartPIAFLinkBatchDatabaseAnalysis =  
    class
        inherit OSICmdletBase
    end

The StartPIAFLinkBatchDatabaseAnalysis type exposes the following members.

Constructors

	Name	Description
	StartPIAFLinkBatchDatabaseAnalysis

Properties

	Name	Description
	Connection	Connection to a PI Data Archive to use

Examples

Start-PIAFLinkBatchDatabaseAnalysis -Connection $con

Where:

$con = Connect-PIDataArchive -PIDataArchiveMachineName "PISRV1"

Starts the PI Batch Database analysis by the PI AF Link Subsystem. The results of this analysis is used to address any issues found when preparing to migrate from PI Batch Database to Event Frames. Use Get-PIAFLinkBatchDatabaseAnalysisStatus to review the results of the analysis.

PI Powershell