Folder

A Folder object is of type PsObject and represents a folder in Vault.
The $folder object is dynamically generated based on the defined Folder Properties in Vault.
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
$folder.'Folder Path'

Localization

$folder 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)

Example:

$folder.’Folder Path’ can be used when working against english vault $folder.Ordnerpfad can be used when working against german vault $folder._FolderPath can be used on all vault language environments

Examples

Folder-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
Created By              : Administrator
_CreateUserName         : Administrator
Create Date             : 3/31/2025 2:26:56 PM
_CreateDate             : 3/31/2025 2:26:56 PM
Folder Path             : $/Designs/InventorSamples/Models/Assemblies
_FolderPath             : $/Designs/InventorSamples/Models/Assemblies
Name                    : Assemblies
_Name                   : Assemblies
Property Compliance     : Compliant
_Compliance             : Compliant
Obsolete                : False
_Obsolete               : False
Category Name           : Folder
_CategoryName           : Folder
Category Glyph          : Autodesk.DataManagement.Client.Framework.Vault.Currency.Properties.ImageInfo
_CategoryGlyph          : Autodesk.DataManagement.Client.Framework.Vault.Currency.Properties.ImageInfo
Lifecycle Definition    :
_LifeCycleDefinition    :
State                   :
_State                  :
State Glyph             :
_StateGlyph             :
Archive Status          : None
_ArchiveStatus          : None
Type Tag                :
_TypeTag                :
Share Path              :
_SharePath              :
Entity Type             : Folder
_EntityType             : Folder
Entity Type ID          : FLDR
_EntityTypeID           : FLDR
Entity Icon             : Autodesk.DataManagement.Client.Framework.Vault.Currency.Properties.ImageInfo
_EntityIcon             : Autodesk.DataManagement.Client.Framework.Vault.Currency.Properties.ImageInfo
Path                    : $/Designs/InventorSamples/Models
_EntityPath             : $/Designs/InventorSamples/Models
Full Path               : $/Designs/InventorSamples/Models/Assemblies
_FullPath               : $/Designs/InventorSamples/Models/Assemblies
Link Target Path        :
_LinkTargetPath         :
Create Date (Date Only) : 3/31/2025 12:00:00 AM
Create Date (Time Only) : 1/1/0001 2:26:00 PM
Type Description        : Folder
_EntityDescription      : Folder
Folder Create Date      : 3/31/2025 2:26:56 PM
_Folder!CreateDate      : 3/31/2025 2:26:56 PM
Id                      : 7
MasterId                : 7
PersistentId            :
PersistentMasterId      :
IsLibrary               : False
ThinClientHyperLink     : http://localhost/AutodeskTC/vault/explore/folder/7
ThickClientHyperLink    : http://localhost/AutodeskDM/Services/EntityDataCommandRequest.aspx?Vault=vault&ObjectId=%24%
                          2FDesigns%2FInventorSamples%2FModels%2FAssemblies&ObjectType=Folder&Command=Select