For being able to read the values of file fields, the read permission is
required for the file concerned. This is not the case for the following
fields whose values can be queried without having been granted any
permissions: id
, name
, visibleName
,
path
, visiblePath
, objType
.
If the set column is marked, the value can be set, however only in the Content Management Server. In the Template Engine, only read access is permitted for the values. Version-specific values always refer to the draft version in the Content Manager, if present, otherwise to the released version. In the Template Engine, version-specific values refer to the released version because no draft versions exist in the Template Engine.
Field | Type | Explanation | Applic. | get | set | descr |
---|---|---|---|---|---|---|
allSuperLinks |
stringlist | List of the IDs of all links that point to the file (as
with superLinks ), however, with an explicit mirror file,
including the links that point to its implicit mirror files. |
CM, TE | • | ||
allSuperObjects |
stringlist | List of the IDs of all files that contain links pointing
to the file (as with superObjects ), however, with
an explicit mirror file, including the files that contain links
pointing to its implicit mirror files. |
CM, TE | • | ||
archivedContentIds |
stringlist | List of the IDs of all archived versions. | CM | • | ||
children (folders only) |
stringlist | List of the IDs of the files in the folder | CM, TE | • | ||
committedContentId |
number | ID of the file’s committed version. | CM | • | ||
contentIds |
stringlist | List of the IDs of all versions of the file | CM | • | ||
dependencies |
string | Returns for debugging purposes the file's
dependencies
in the property list format. For each entry the following is listed:
the dependency type (depType ), the dependent file
(expObjId ), and the referenced file (refObjId ).
The dependency types have the following meaning: 1 - object ,
2 - content , 3 - reference ,
4 - children , 5 - usesAll . |
TE | • | ||
dependingObjectIds |
stringlist | The list of files depending on this file. | TE | • | ||
dependOnObjectIds |
stringlist | The list of files on which the file depends. | TE | • | ||
editedContentId |
number | ID of the file’s draft version. | CM | • | ||
exportMimeType |
string | The mime type for the file name extension of the released version (or, if it does not exist, of the draft version) | CM, TE | • | ||
getKeys |
stringlist | List of the file fields that can be queried with get
|
CM, TE | • | ||
hasChildren |
bool | Specifies whether the file contains other files. | CM, TE | • | • | |
hasMirrors |
bool | (From version 6.5) Specifies whether mirror files of this file exist. | CM, TE | • | ||
hasSuperLinks |
bool | Specifies whether there is a reference to the file | CM, TE | • | • | |
id |
string | The file ID | CM, TE | • | • | |
isCommitted |
bool | Specifies whether the file has a committed version | CM | • | • | |
isEdited |
bool | Specifies whether the file has a draft version | CM | • | • | |
isExplicitMirror |
bool | (From version 6.5) Specifies whether the file is an explicit mirror file (meaning that it was not created by the system but by a user or a script). | CM, TE | • | ||
isExportable |
bool | Specifies whether the file has a released version which
is valid with regard to time (checks validFrom and
validUntil ). |
CM, TE | • | ||
isMirror |
bool | (From version 6.5) Specifies whether the file is a mirror file. | CM, TE | • | • | |
isReleased |
bool | Specifies whether the file has a released version | CM | • | • | |
isRoot |
bool | Specifies whether the file is the base folder | CM, TE | • | ||
mirrors |
stringlist | (From version 6.5) Returns the list of the IDs of all mirror files of the file concerned. | CM, TE | • | ||
name |
string | Name of the file | CM, TE | • | • | • |
next |
string | The ID of the file that is the successor of the specified file in the folder containing it. | CM, TE | • | ||
objClass |
string | The name of the file’s format | CM, TE | • | • | • |
objCount |
number | The number of files in the file hierarchy excluding implicit mirror files | CM, TE | • | • | • |
objType |
string | The file type | CM, TE | • | • | |
objectsToRoot |
stringlist | List of the IDs of the files that are on the path from the file to the base folder (including the file and the basefolder themselves) | CM, TE | • | ||
original |
string | (From version 6.5) If the file concerned is a mirror file, the ID of the original file | CM, TE | • | ||
parent |
string | The ID of the folder containing the specified file | CM, TE | • | • | • |
path |
string | The path of the file (formed from the names of the files) | CM, TE | • | • | |
permalink |
string | (From version 6.6) A permanent URI for this file (permalink) that persists even if the file is renamed or moved. | CM | • | • | |
prefixPath |
string | The path of the file, with a "/" at the end for folders | CM, TE | • | ||
previous |
string | The ID of the file that is the predecessor of the specified file in the folder in which it is contained | CM, TE | • | ||
releasedContentId |
number | ID of the file’s released version. | CM | • | ||
releasedVersions |
stringlist | The list of the IDs of all already released versions of the file (current released version and all archived versions) | CM | • | ||
reminderComment |
string | (From version 6.5) The comment associated with the reminder of the file | CM | • | ||
reminderFrom |
string | (From version 6.5) The date the reminder becomes active (in the 14-digit format) | CM | • | ||
reminderGroups |
stringlist | (From version 6.5) The list of user groups whose members will be reminded of the file | CM | • | ||
reminderUsers |
stringlist | (From version 6.5) The list of users who will be
reminded of the file, not including the members of the
reminderGroups |
CM | • | ||
setKeys |
stringlist | The list of all file fields which can be set with
set |
CM | • | ||
sortValue |
string | The value according to which the files are sorted within the folder that contains them. Determined by the sort keys of the folder. | CM, TE | • | ||
superLinks |
stringlist | The list of all IDs of the links that refer to the file | CM, TE | • | ||
superObjects |
stringlist | The list of all IDs of the files that contain links to the file | CM, TE | • | ||
suppressExport |
bool | Specifies whether the file is exported | CM, TE | • | • | • |
toclist (folders only) |
stringlist | The list of the IDs of a folder’s files that appear in
a toclist (<NPSOBJ
list="toclist"></NPSOBJ>) (all folders and
documents that are valid with respect to time and have a released
version for which suppressExport is not set) |
CM, TE | • | ||
validControlActionKeys |
stringlist | The names of the actions that can be executed for the
file and the respective user – subset of {edit, commit,
release, unrelease, revert, reject } |
CM | • | ||
validCreateObjClasses |
stringlist | The list of the names of the file formats the user may
use when creating files in the current folder. (This corresponds to
the list of validSubObjClasses that are specified in the
format of the file, for which the user has the appropriate file
creation permissions.) |
CM | • | ||
validObjClasses |
stringlist | The list of the names of the file formats the user may
assign to the file (all validSubObjClasses of the parent
folder that are valid for the file’s type). |
CM | • | ||
validPermissions |
stringlist | The list of all available permissions for the file | CM | • | ||
version |
number | The version of the file | CM, TE | • | • | |
visibleExportTemplates |
stringlist | The list of the IDs of the layouts that are visible
from the file (i. e. are located in the objectsToRoot
path) and which can be applied during export or preview. The value
of this parameter also depends on the
preferEditedTemplates user preference. |
CM | • | ||
visibleName |
string | The name of the file plus the file name extension (except for folders) | CM, TE | • | ||
visiblePath |
string | The path of the file with the name extension added
("/index.contentType " is added for
folders). |
CM, TE | • | ||
workflowName |
string | The name of the workflow assigned to the file | CM, TE | • | • | • |
next.objAttr |
The file field value of the successor in the folder | CM, TE | • | |||
parent.objAttr |
The file field value of the folder containing the file | CM, TE | • | |||
previous.objAttr |
The file field value of the predecessor in the folder | CM, TE | • | |||
up.objAttr |
The file field value of the file itself is output if it is not empty, otherwise the folder containing the file is queried for the entire key | CM, TE | • | |||
permissions. |
stringlist | The list of groups that have the specified access permission for the file | CM, TE | • |