File
A File object is of type PsObject and represents a file in Vault.
The $file object is dynamically generated based on the defined File Properties in Vault. Therefore all file properties are directly available on this object.
The properties are named the same as in Vault, including whitespaces. If you want to access such a property you have to enclose it in single quotes.
Syntax
1 | $file.'Full Path' |
Remarks
Depending on the configured Property types in Vault the properties are converted to a corresponding PowerShell data type.
Vault |
PowerShell |
|---|---|
Number |
Long |
Text |
String |
Boolean |
Boolean |
Thumbnail |
ThumbnailType |
Localization
$file is supporting this feature:
all active properties can be accessed via the displayName
all active properties can be accessed via _SystemName
except: the ones with guids (=user defined)
except: Internal ones ending with !dateonly or !timeonly (Date Version Created (Time only) and Date Only -> can be accessed via DateVersionCreated.Date or DateVersionCreated.Time)
internal properties starting with Entity!… or File!… can be accessed directly without Entity! (e.g. File!VaultStatus, Entity!HasAttachments)
Examples
Accessing Title for different Vault languages
1 2 3 | $file.Title #can be used with English Vault $file.Titel #can be used with German Vault $file._Title #can be used with all Vault language environments |
File-object on an english environment:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 | Classification : None _Classification : None Version : 2 _VersionNumber : 2 Comment : Change Category _Comment : Change Category Number of Attachments : Autodesk.DataManagement.Client.Framework.Vault.Currency.Properties.ImageInfo _NumManualAttachments : Autodesk.DataManagement.Client.Framework.Vault.Currency.Properties.ImageInfo Date Version Created : 3/31/2025 4:03:54 PM _DateVersionCreated : 3/31/2025 4:03:54 PM Created By : Administrator _CreateUserName : Administrator Checked In : 3/31/2025 4:03:54 PM _CheckInDate : 3/31/2025 4:03:54 PM File Name : _Jet Engine Model.iam _ClientFileName : _Jet Engine Model.iam File Name (Historical) : _Jet Engine Model.iam _ClientFileName(Ver) : _Jet Engine Model.iam Date Modified : 4/29/2024 10:57:57 AM _ModDate : 4/29/2024 10:57:57 AM File Size : 9224704 _FileSize : 9224704 Linked to Item : True _ItemLinked : True Item Assignable : True _ItemAssignable : True Checked Out Local Spec : _CheckoutLocalSpec : Checked Out Machine : _CheckoutMachine : Checked Out : 3/31/2025 4:03:51 PM _CheckoutDate : 3/31/2025 4:03:51 PM Checked Out By : _CheckoutUserName : Hidden : False _Hidden : False Latest Version : True _LatestVersion : True Controlled By Change Order : False _ControlledByChangeOrder : False Change Order State : _ChangeOrderState : Visualization Attachment : None _VisualizationAttachment : None Originator : Administrator _Originator : Administrator Original Create Date : 3/31/2025 2:28:07 PM _OrigCreateDate : 3/31/2025 2:28:07 PM Thumbnail : Autodesk.DataManagement.Client.Framework.Vault.Currency.Properties.ThumbnailInfo _Thumbnail : Autodesk.DataManagement.Client.Framework.Vault.Currency.Properties.ThumbnailInfo Provider : Inventor _Provider : Inventor iLogicRuleStatus : _iLogicRuleStatus : Folder Path : $/Designs/InventorSamples/Models/Assemblies/Jet Engine/Jet Engine Model/Workspace _FolderPath : $/Designs/InventorSamples/Models/Assemblies/Jet Engine/Jet Engine Model/Workspace Name : _Jet Engine Model.iam _Name : _Jet Engine Model.iam File Extension : iam _Extension : iam Has Drawing : False _HasDrawing : False Has Parent Relationship : False _HasParentRelationship : False Has Model State : False _HasModelState : False Is Table Driven : False _IsTableDriven : False Is True Model State : False _IsTrueModelState : False Property Compliance : Compliant _Compliance : Compliant Property Compliance (Historical) : Compliant _Compliance(Ver) : Compliant Latest Released Revision : False _LatestReleasedRevision : False Released Revision : False _ReleasedRevision : False Initial Release Date : _InitReleaseDate : Initial Approver : _InitApprover : Latest Released Date : _LatestReleaseDate : Latest Approver : _LatestApprover : Obsolete : False _Obsolete : False Category Name : Engineering _CategoryName : Engineering Category Name (Historical) : Engineering _CategoryName(Ver) : Engineering Category Glyph : Autodesk.DataManagement.Client.Framework.Vault.Currency.Properties.ImageInfo _CategoryGlyph : Autodesk.DataManagement.Client.Framework.Vault.Currency.Properties.ImageInfo Category Glyph (Historical) : Autodesk.DataManagement.Client.Framework.Vault.Currency.Properties.ImageInfo _CategoryGlyph(Ver) : Autodesk.DataManagement.Client.Framework.Vault.Currency.Properties.ImageInfo Lifecycle Definition : Flexible Release Process _LifeCycleDefinition : Flexible Release Process Lifecycle Definition (Historical) : Flexible Release Process _LifeCycleDefinition(Ver) : Flexible Release Process State : Work in Progress _State : Work in Progress State (Historical) : Work in Progress _State(Ver) : Work in Progress State Glyph : Autodesk.DataManagement.Client.Framework.Vault.Currency.Properties.ImageInfo _StateGlyph : Autodesk.DataManagement.Client.Framework.Vault.Currency.Properties.ImageInfo State Glyph (Historical) : Autodesk.DataManagement.Client.Framework.Vault.Currency.Properties.ImageInfo _StateGlyph(Ver) : Autodesk.DataManagement.Client.Framework.Vault.Currency.Properties.ImageInfo Revision Scheme : Standard Alphabetic Format _RevisionDefinition : Standard Alphabetic Format Revision Scheme (Historical) : Standard Alphabetic Format _RevisionDefinition(Ver) : Standard Alphabetic Format Revision : A _Revision : A File Replicated : True _FileReplicated : True Has Markup : False _HasMarkup : False Has Markup (Historical) : False _HasMarkup(Ver) : False Archive Status : None _ArchiveStatus : None Archive Status (Historical) : None _ArchiveStatus(Ver) : None Author : Inventor _Author : Inventor Comments : _Comments : Keywords : _Keywords : Rev Number : _RevNumber : Subject : _Subject : Title : Jet Engine _Title : Jet Engine Company : Autodesk Inc. _Company : Autodesk Inc. DWG Creator Name : _DWGCreatorName : DWG Creator Version : _DWGCreatorVersion : Checked By : _CheckedBy : Cost : _Cost : Cost Center : _CostCenter : Date File Created : _CreationDate : Description : _Description : Material : _Material : Part Number : 333-021 _PartNumber : 333-021 Stock Number : _StockNumber : User Status : _UserStatus : GeoRss : _GeoRss : Application Version : 2024 (Build 280153000, 153) _ApplicationVersion : 2024 (Build 280153000, 153) DWG Type : _DwgType : Designer : Autodesk Inc. _Designer : Autodesk Inc. Engineer : _Engineer : Engr Approved By : _EngrApprovedBy : Manager : _Manager : Mfg Approved By : _MfgApprovedBy : Project : _Project : Type Tag : _TypeTag : Entity Type : File _EntityType : File Entity Type ID : FILE _EntityTypeID : FILE Entity Icon : Autodesk.DataManagement.Client.Framework.Vault.Currency.Properties.ImageInfo _EntityIcon : Autodesk.DataManagement.Client.Framework.Vault.Currency.Properties.ImageInfo Path : $/Designs/InventorSamples/Models/Assemblies/Jet Engine/Jet Engine Model/Workspace _EntityPath : $/Designs/InventorSamples/Models/Assemblies/Jet Engine/Jet Engine Model/Workspace Full Path : $/Designs/InventorSamples/Models/Assemblies/Jet Engine/Jet Engine Model/Workspace/_Jet Engine Model.iam _FullPath : $/Designs/InventorSamples/Models/Assemblies/Jet Engine/Jet Engine Model/Workspace/_Jet Engine Model.iam Attachments : False _HasAttachments : False Link Target Path : _LinkTargetPath : Date Version Created (Date Only) : 3/31/2025 12:00:00 AM Date Version Created (Time Only) : 1/1/0001 4:03:00 PM Checked In (Date Only) : 3/31/2025 12:00:00 AM Checked In (Time Only) : 1/1/0001 4:03:00 PM Date Modified (Date Only) : 4/29/2024 12:00:00 AM Date Modified (Time Only) : 1/1/0001 10:57:00 AM Checked Out (Date Only) : 3/31/2025 12:00:00 AM Checked Out (Time Only) : 1/1/0001 4:03:00 PM Original Create Date (Date Only) : 3/31/2025 12:00:00 AM Original Create Date (Time Only) : 1/1/0001 2:28:00 PM Initial Release Date (Date Only) : Initial Release Date (Time Only) : Latest Released Date (Date Only) : Latest Released Date (Time Only) : Type Description : Autodesk Inventor Assembly _EntityDescription : Autodesk Inventor Assembly Vault Status : Autodesk.DataManagement.Client.Framework.Vault.Currency.Properties.EntityStatusImageInfo _VaultStatus : Autodesk.DataManagement.Client.Framework.Vault.Currency.Properties.EntityStatusImageInfo Vault Status Modifier : False _VaultStatusModifier : False Id : 393 MasterId : 387 PersistentId : PersistentMasterId : IsCheckedOut : False ThinClientHyperLink : http://localhost/AutodeskTC/vault/explore/file/387 ThickClientHyperLink : http://localhost/AutodeskDM/Services/EntityDataCommandRequest.aspx?Vault=vault&ObjectId=%24%2FDesigns%2FInventorSamples%2FModels%2FAssemblies%2FJet+Engine%2FJet+Engine+Model%2FWorkspace%2F_Jet+Engine+Model.iam&ObjectType=File&Command=Select LocalPath : |