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$file.Title #can be used with English Vault
2$file.Titel #can be used with German Vault
3$file._Title #can be used with all Vault language environments

File-object on an english environment:

  1Classification                    : None
  2_Classification                   : None
  3Version                           : 13
  4_VersionNumber                    : 13
  5Comment                           : Property Edit
  6_Comment                          : Property Edit
  7Number of Attachments             : Autodesk.DataManagement.Client.Framework.Vault.Currency.Properties.ImageInfo
  8_NumManualAttachments             : Autodesk.DataManagement.Client.Framework.Vault.Currency.Properties.ImageInfo
  9Date Version Created              : 19.04.2018 17:35:26
 10_DateVersionCreated               : 19.04.2018 17:35:26
 11Created By                        : coolOrange
 12_CreateUserName                   : coolOrange
 13Checked In                        : 19.04.2018 17:35:26
 14_CheckInDate                      : 19.04.2018 17:35:26
 15File Name                         : Pad Lock.iam
 16_ClientFileName                   : Pad Lock.iam
 17File Name (Historical)            : Pad Lock.iam
 18_ClientFileName(Ver)              : Pad Lock.iam
 19Date Modified                     : 19.04.2018 17:35:20
 20_ModDate                          : 19.04.2018 17:35:20
 21File Size                         : 1064448
 22_FileSize                         : 1064448
 23Linked to Item                    : True
 24_ItemLinked                       : True
 25Checked Out Local Spec            :
 26_CheckoutLocalSpec                :
 27Checked Out Machine               :
 28_CheckoutMachine                  :
 29Checked Out                       : 19.04.2018 17:35:24
 30_CheckoutDate                     : 19.04.2018 17:35:24
 31Checked Out By                    :
 32_CheckoutUserName                 :
 33Hidden                            : False
 34_Hidden                           : False
 35Latest Version                    : True
 36_LatestVersion                    : True
 37Controlled By Change Order        : False
 38_ControlledByChangeOrder          : False
 39Change Order State                :
 40_ChangeOrderState                 :
 41Visualization Attachment          : None
 42_VisualizationAttachment          : None
 43Originator                        : coolOrange
 44_Originator                       : coolOrange
 45Original Create Date              : 09.09.2015 16:00:20
 46_OrigCreateDate                   : 09.09.2015 16:00:20
 47Thumbnail                         : Autodesk.DataManagement.Client.Framework.Vault.Currency.Properties.ThumbnailInfo
 48_Thumbnail                        : Autodesk.DataManagement.Client.Framework.Vault.Currency.Properties.ThumbnailInfo
 49Provider                          : Inventor
 50_Provider                         : Inventor
 51iLogicRuleStatus                  :
 52_iLogicRuleStatus                 :
 53Folder Path                       : $/Designs/Padlock/Assemblies
 54_FolderPath                       : $/Designs/Padlock/Assemblies
 55Name                              : Pad Lock.iam
 56_Name                             : Pad Lock.iam
 57File Extension                    : iam
 58_Extension                        : iam
 59Property Compliance               : Compliant
 60_Compliance                       : Compliant
 61Property Compliance (Historical)  : Noncompliant equivalence
 62_Compliance(Ver)                  : Noncompliant equivalence
 63Latest Released Revision          : False
 64_LatestReleasedRevision           : False
 65Released Revision                 : False
 66_ReleasedRevision                 : False
 67Initial Release Date              :
 68_InitReleaseDate                  :
 69Initial Approver                  :
 70_InitApprover                     :
 71Category Name                     : Base
 72_CategoryName                     : Base
 73Category Name (Historical)        : Base
 74_CategoryName(Ver)                : Base
 75Category Glyph                    : Autodesk.DataManagement.Client.Framework.Vault.Currency.Properties.ImageInfo
 76_CategoryGlyph                    : Autodesk.DataManagement.Client.Framework.Vault.Currency.Properties.ImageInfo
 77Category Glyph (Historical)       : Autodesk.DataManagement.Client.Framework.Vault.Currency.Properties.ImageInfo
 78_CategoryGlyph(Ver)               : Autodesk.DataManagement.Client.Framework.Vault.Currency.Properties.ImageInfo
 79Lifecycle Definition              : Flexible Release Process
 80_LifeCycleDefinition              : Flexible Release Process
 81Lifecycle Definition (Historical) : Flexible Release Process
 82_LifeCycleDefinition(Ver)         : Flexible Release Process
 83State                             : Work in Progress
 84_State                            : Work in Progress
 85State (Historical)                : Work in Progress
 86_State(Ver)                       : Work in Progress
 87Revision Scheme                   : Standard Alphabetic Format
 88_RevisionDefinition               : Standard Alphabetic Format
 89Revision Scheme (Historical)      : Standard Alphabetic Format
 90_RevisionDefinition(Ver)          : Standard Alphabetic Format
 91Revision                          : A
 92_Revision                         : A
 93File Replicated                   : True
 94_FileReplicated                   : True
 95Author                            : B. ROEPKE
 96_Author                           : B. ROEPKE
 97Comments                          :
 98_Comments                         :
 99Keywords                          : Vault, Tutorial, Padlock
100_Keywords                         : Vault, Tutorial, Padlock
101Rev Number                        :
102_RevNumber                        :
103Subject                           : test
104_Subject                          : test
105Title                             : Pad Lock
106_Title                            : Pad Lock
107Company                           : Autodesk, Inc.
108_Company                          : Autodesk, Inc.
109DWG Creator Name                  :
110_DWGCreatorName                   :
111DWG Creator Version               :
112_DWGCreatorVersion                :
113Checked By                        : B. ROEPKE
114_CheckedBy                        : B. ROEPKE
115Cost                              : 17
116_Cost                             : 17
117Cost Center                       :
118_CostCenter                       :
119Date File Created                 :
120_CreationDate                     :
121Description                       : PAD LOCK ASSEMBLY
122_Description                      : PAD LOCK ASSEMBLY
123Material                          :
124_Material                         :
125Part Number                       : ERP-41881007
126_PartNumber                       : ERP-41881007
127Stock Number                      :
128_StockNumber                      :
129User Status                       :
130_UserStatus                       :
131GeoRss                            :
132_GeoRss                           :
133Designer                          : B. ROEPKE
134_Designer                         : B. ROEPKE
135Engineer                          : B. ROEPKE
136_Engineer                         : B. ROEPKE
137Engr Approved By                  : D. BRISSON
138_EngrApprovedBy                   : D. BRISSON
139Manager                           : klaus
140_Manager                          : klaus
141Mfg Approved By                   :
142_MfgApprovedBy                    :
143Project                           : PADLOCK
144_Project                          : PADLOCK
145Type Tag                          :
146_TypeTag                          :
147ErpMaterial                       :
148ErpVersion                        :
149Test                              :
150Item Assignable                   : True
151_ItemAssignable                   : True
152Obsolete                          : False
153_Obsolete                         : False
154Has Drawing                       : True
155_HasDrawing                       : True
156Has Parent Relationship           : True
157_HasParentRelationship            : True
158Has Model State                   :
159_HasModelState                    :
160Is Table Driven                   :
161_IsTableDriven                    :
162Is True Model State               :
163_IsTrueModelState                 :
164Latest Released Date              :
165_LatestReleaseDate                :
166Latest Approver                   :
167_LatestApprover                   :
168Entity Type                       : File
169_EntityType                       : File
170Entity Type ID                    : FILE
171_EntityTypeID                     : FILE
172Entity Icon                       : Autodesk.DataManagement.Client.Framework.Vault.Currency.Properties.ImageInfo
173_EntityIcon                       : Autodesk.DataManagement.Client.Framework.Vault.Currency.Properties.ImageInfo
174Path                              : $/Designs/Padlock/Assemblies
175_EntityPath                       : $/Designs/Padlock/Assemblies
176Full Path                         : $/Designs/Padlock/Assemblies/Pad Lock.iam
177_FullPath                         : $/Designs/Padlock/Assemblies/Pad Lock.iam
178Attachments                       : False
179_HasAttachments                   : False
180Link Target Path                  :
181_LinkTargetPath                   :
182Date Version Created (Date Only)  : 19.04.2018 00:00:00
183Date Version Created (Time Only)  : 01.01.0001 17:35:00
184Checked In (Date Only)            : 19.04.2018 00:00:00
185Checked In (Time Only)            : 01.01.0001 17:35:00
186Date Modified (Date Only)         : 19.04.2018 00:00:00
187Date Modified (Time Only)         : 01.01.0001 17:35:00
188Checked Out (Date Only)           : 19.04.2018 00:00:00
189Checked Out (Time Only)           : 01.01.0001 17:35:00
190Original Create Date (Date Only)  : 09.09.2015 00:00:00
191Original Create Date (Time Only)  : 01.01.0001 16:00:00
192Initial Release Date (Date Only)  :
193Initial Release Date (Time Only)  :
194Latest Released Date (Date Only)  :
195Latest Released Date (Time Only)  :
196Type Description                  : Autodesk Inventor Assembly
197_EntityDescription                : Autodesk Inventor Assembly
198Vault Status                      : Autodesk.DataManagement.Client.Framework.Vault.Currency.Properties.EntityStatusImageInfo
199_VaultStatus                      : Autodesk.DataManagement.Client.Framework.Vault.Currency.Properties.EntityStatusImageInfo
200Vault Status Modifier             : False
201_VaultStatusModifier              : False
202Id                                : 138381
203MasterId                          : 28663
204PersistentId                      :
205PersistentMasterId                :
206IsCheckedOut                      : False
207LocalPath                         :