PI Powershell

NewAFCheckIn Class

Save PDF

TABLE OF CONTENTS

NewAFCheckIn Class

Save PDF

Last UpdatedDec 15, 2025
4 minute read

PI System
Powershell Tools for the PI System 2024 R2
Developer

NewAFCheckIn Class

Check in changes to an AF Server

The New-AFCheckin cmdlet checks in changes to the specified AF objects. You can also check in all changes to and AF Server or AF Database. AF Server only includes: AFContact, AFNotificationContactTemplate, and UOMDatabase objects. All other objects must be retrieved via the AF Database.

Inheritance Hierarchy

SystemObject
  InternalCommand
    Cmdlet
      PSCmdlet
        OSIsoft.PowerShellOSICmdletBase
          OSIsoft.PowerShellNewAFCheckIn

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

Syntax

[CmdletAttribute("New", "AFCheckIn", SupportsShouldProcess = true)]
public class NewAFCheckIn : OSICmdletBase

<CmdletAttribute("New", "AFCheckIn", SupportsShouldProcess := true)>
Public Class NewAFCheckIn
	Inherits OSICmdletBase

Dim instance As NewAFCheckIn

[CmdletAttribute(L"New", L"AFCheckIn", SupportsShouldProcess = true)]
public ref class NewAFCheckIn : public OSICmdletBase

[<CmdletAttribute("New", "AFCheckIn", SupportsShouldProcess = true)>]
type NewAFCheckIn =  
    class
        inherit OSICmdletBase
    end

The NewAFCheckIn type exposes the following members.

Constructors

	Name	Description
	NewAFCheckIn

Properties

	Name	Description
	AFCheckedOutMode	Check in objects only that were checked out with a given CheckOutMode. The valid values are: AllObjects : ObjectsCheckOutToMe : ObjectsCheckOutThisSession : ObjectsCheckOutThisThread
	AFDatabase	AFDatabase to check in. Can filter which objects to filter with AFCheckedOutMode parameter
	AFServer	AFDatabase to check in. Can filter which objects to filter with AFCheckedOutMode parameter
	ItemToCheckIn	AF Objects to check in. Can pass more than one object as an array of comma separated values
	PassThru	Returns objects that were changed. By default, this cmdlet does not generate any output

Examples

New-AFCheckIn -AFDatabase $afDB -AFCheckedOutMode AllObjectsCheckedOutThisSession

Where:

$afDB = Get-AFDatabase -Name "AFDatabase1" -AFServer (Get-AFServer -Name "PIAF1")

Checks in all checked out objects in the current session in the AF Database "AFDatabase1" on the AF Server "PIAF1"

Examples

New-AFCheckIn -AFServer $afDB -AFCheckedOutMode AllObjectsCheckedOutThisSession

Where:

$afServer = Get-AFServer -Name "PIAF1"

Checks in all checked out objects in the current session in the AF Server"PIAF1". Note that the only objects checked out on the server level are AFContact, AFNotificationContactTemplate, and UOMDatabase check outs.

Examples

New-AFCheckin -ItemToCheckIn $checkedoutElement

Where:

$checkedoutElement is an AF Element that has previously been checked out. This can be done explicitly with New-AFCheckOut or implicitly by making a change to the object.

Checks in the checked out AF Element stored in $checkedoutElement. This variable can also store multiple AF Elements and all will be checked in.

Examples

New-AFCheckin -ItemToCheckIn $checkedoutElement1, $checkedoutAttribute1, $checkedoutAttribute2

Where:

$checkedoutElement1, $checkedoutAttribute1, and $checkedoutAttribute2 are an AF Element, AF Attribute, and AF Attribute (respectively) which have all been checked out.

Checks in the comma separated list of AF Objects to the AF Server.

PI Powershell