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
Created By              : Administrator
_CreateUserName         : Administrator
Folder Path             : $/Designs/Vault
_FolderPath             : $/Designs/Vault
Name                    : Vault
_Name                   : Vault
Property Compliance     : Compliant
_Compliance             : Compliant
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    : Basic Release Process
_LifeCycleDefinition    : Basic Release Process
State                   : Work in Progress
_State                  : Work in Progress
Create Date             : 11.04.2016 15:53:47
_CreateDate             : 11.04.2016 15:53:47
Type Tag                : 
_TypeTag                : 
Share Path              : 
_SharePath              : 
Obsolete                : False
_Obsolete               : False
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
_EntityPath             : $/Designs
Full Path               : $/Designs/Vault
_FullPath               : $/Designs/Vault
Link Target Path        : 
_LinkTargetPath         : 
Create Date (Date Only) : 11.04.2016 00:00:00
Create Date (Time Only) : 01.01.0001 15:53:00
Type Description        : Folder
_EntityDescription      : Folder
Folder Create Date      : 11.04.2016 15:53:47
_Folder!CreateDate      : 11.04.2016 15:53:47
Id                      : 26766
MasterId                : 26766
PersistentId            : 
PersistentMasterId      : 
IsLibrary               : False