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 | Classification : None _Classification : None Version : 13 _VersionNumber : 13 Comment : Property Edit _Comment : Property Edit Number of Attachments : Autodesk.DataManagement.Client.Framework.Vault.Currency.Properties.ImageInfo _NumManualAttachments : Autodesk.DataManagement.Client.Framework.Vault.Currency.Properties.ImageInfo Date Version Created : 19.04.2018 17:35:26 _DateVersionCreated : 19.04.2018 17:35:26 Created By : coolOrange _CreateUserName : coolOrange Checked In : 19.04.2018 17:35:26 _CheckInDate : 19.04.2018 17:35:26 File Name : Pad Lock.iam _ClientFileName : Pad Lock.iam File Name (Historical) : Pad Lock.iam _ClientFileName(Ver) : Pad Lock.iam Date Modified : 19.04.2018 17:35:20 _ModDate : 19.04.2018 17:35:20 File Size : 1064448 _FileSize : 1064448 Linked to Item : True _ItemLinked : True Checked Out Local Spec : _CheckoutLocalSpec : Checked Out Machine : _CheckoutMachine : Checked Out : 19.04.2018 17:35:24 _CheckoutDate : 19.04.2018 17:35:24 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 : coolOrange _Originator : coolOrange Original Create Date : 09.09.2015 16:00:20 _OrigCreateDate : 09.09.2015 16:00:20 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/Padlock/Assemblies _FolderPath : $/Designs/Padlock/Assemblies Name : Pad Lock.iam _Name : Pad Lock.iam File Extension : iam _Extension : iam Property Compliance : Compliant _Compliance : Compliant Property Compliance (Historical) : Noncompliant equivalence _Compliance(Ver) : Noncompliant equivalence Latest Released Revision : False _LatestReleasedRevision : False Released Revision : False _ReleasedRevision : False Initial Release Date : _InitReleaseDate : Initial Approver : _InitApprover : Category Name : Base _CategoryName : Base Category Name (Historical) : Base _CategoryName(Ver) : Base 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 Has Markup : False _HasMarkup : False Has Markup (Historical) : False _HasMarkup(Ver) : False 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 Author : B. ROEPKE _Author : B. ROEPKE Comments : _Comments : Keywords : Vault, Tutorial, Padlock _Keywords : Vault, Tutorial, Padlock Rev Number : _RevNumber : Subject : test _Subject : test Title : Pad Lock _Title : Pad Lock Company : Autodesk, Inc. _Company : Autodesk, Inc. DWG Creator Name : _DWGCreatorName : DWG Creator Version : _DWGCreatorVersion : Checked By : B. ROEPKE _CheckedBy : B. ROEPKE Cost : 17 _Cost : 17 Cost Center : _CostCenter : Date File Created : _CreationDate : Description : PAD LOCK ASSEMBLY _Description : PAD LOCK ASSEMBLY Material : _Material : Part Number : ERP-41881007 _PartNumber : ERP-41881007 Stock Number : _StockNumber : User Status : _UserStatus : GeoRss : _GeoRss : Designer : B. ROEPKE _Designer : B. ROEPKE Engineer : B. ROEPKE _Engineer : B. ROEPKE Engr Approved By : D. BRISSON _EngrApprovedBy : D. BRISSON Manager : klaus _Manager : klaus Mfg Approved By : _MfgApprovedBy : Project : PADLOCK _Project : PADLOCK Type Tag : _TypeTag : Item Assignable : True _ItemAssignable : True Obsolete : False _Obsolete : False Has Drawing : True _HasDrawing : True Has Parent Relationship : True _HasParentRelationship : True Has Model State : _HasModelState : Is Table Driven : _IsTableDriven : Is True Model State : _IsTrueModelState : Latest Released Date : _LatestReleaseDate : Latest Approver : _LatestApprover : 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/Padlock/Assemblies _EntityPath : $/Designs/Padlock/Assemblies Full Path : $/Designs/Padlock/Assemblies/Pad Lock.iam _FullPath : $/Designs/Padlock/Assemblies/Pad Lock.iam Attachments : False _HasAttachments : False Link Target Path : _LinkTargetPath : Date Version Created (Date Only) : 19.04.2018 00:00:00 Date Version Created (Time Only) : 01.01.0001 17:35:00 Checked In (Date Only) : 19.04.2018 00:00:00 Checked In (Time Only) : 01.01.0001 17:35:00 Date Modified (Date Only) : 19.04.2018 00:00:00 Date Modified (Time Only) : 01.01.0001 17:35:00 Checked Out (Date Only) : 19.04.2018 00:00:00 Checked Out (Time Only) : 01.01.0001 17:35:00 Original Create Date (Date Only) : 09.09.2015 00:00:00 Original Create Date (Time Only) : 01.01.0001 16:00:00 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 : 138381 MasterId : 28663 PersistentId : PersistentMasterId : IsCheckedOut : False ThinClientHyperLink : http://localhost/AutodeskTC/Vault/explore/file/28663 ThickClientHyperLink : http://localhost/AutodeskDM/Services/EntityDataCommandRequest.aspx?Va ult=Vault&ObjectId=%24%2FDesigns%Padlock%2FAssemblies%2FPad+Lock.iam &ObjectType=File&Command=Select LocalPath : |