PI Powershell

SetAFEventFrame Class

Save PDF

TABLE OF CONTENTS

SetAFEventFrame Class

Save PDF

Last UpdatedDec 15, 2025
3 minute read

PI System
Powershell Tools for the PI System 2024 R2
Developer

Set an AF Event Frame

The Set-AFEventFrame cmdlet edits an existing AF Event Frame

Inheritance Hierarchy

SystemObject
  InternalCommand
    Cmdlet
      PSCmdlet
        OSIsoft.PowerShellOSICmdletBase
          OSIsoft.PowerShellSetAFEventFrame

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

Syntax

[CmdletAttribute("Set", "AFEventFrame", SupportsShouldProcess = true)]
public class SetAFEventFrame : OSICmdletBase

<CmdletAttribute("Set", "AFEventFrame", SupportsShouldProcess := true)>
Public Class SetAFEventFrame
	Inherits OSICmdletBase

Dim instance As SetAFEventFrame

[CmdletAttribute(L"Set", L"AFEventFrame", SupportsShouldProcess = true)]
public ref class SetAFEventFrame : public OSICmdletBase

[<CmdletAttribute("Set", "AFEventFrame", SupportsShouldProcess = true)>]
type SetAFEventFrame =  
    class
        inherit OSICmdletBase
    end

The SetAFEventFrame type exposes the following members.

Constructors

	Name	Description
	SetAFEventFrame

Properties

	Name	Description
	AFAnalysis	AF Analysis which created the AF Event Frame
	AFElementTemplate	AF Element Template to base the AF Event Frame off of
	AFEventFrame	AF Event Frame to edit
	CheckIn	Check in changes immediately
	Description	Description to set on the AF Event Frame
	EndTime	End time to set on the AF Event Frame
	IsRoot	Is the AF Event Frame owned by the AF Database
	NewName	New name to set on the AF Event Frame
	PassThru	Returns objects that were changed. By default, this cmdlet does not generate any output.
	StartTime	Start time to set on the AF Event Frame

Examples

Set-AFEventFrame -Description "Modified endtime: Manual downtime event" -EndTime "1-Nov-2017 18:30:00" -CheckIn -AFAnalysis $afAnalysis -AFEventFrame $MyEventFrame

Where:

$MyEventFrame = Get-AFEventFrame -ID 7570ec51-31c6-4611-0000-000000015f31 -AFServer (Get-AFServer -Name PIAF1)

$afElement = Get-AFElment -Name Boiler1 -Refresh -AFDatabase $afDB

$afAnalysis = $afElement.Analyses[0]

This example edits the description and the end time for an event frame. The analysis that is associated with the event frame is updated as well. The change is checked in immediately.

Examples

Set-AFEventFrame -Description "Golden Batch" -CheckIn -AFDatabase $afDB

Where:

$MyEventFrame = Get-AFEventFrame -ID 7570ec51-31c6-4611-0000-000000015f31 -AFServer (Get-AFServer -Name PIAF1)

This example edits the description of an event frame to mark it as a good reference event frame. The change is checked in immediately.

PI Powershell