Documentation Center

Data fields

The fields and data returned by PcmPortal are described.

There are four types of fields:
  • String — any form of alphanumeric data
  • Numeric — decimal numbers
  • ID — relative or absolute object id_paths
  • Boolean — string fields that contain YES or NO
FieldDescription
2.X_TOOLBoolean which indicates whether a tool uses the old connection methods rather than the 3.0 or higher API.

TRUE if the tool uses the old methods.

ABSTRACT_TYPEContains the system abstract number associated with an object type.
ACCELERATOR_KEYHot key that an application can use to invoke the tool.
ANCHOR_TYPELContains the anchor type of a link type as defined by link manager.
APPLICATIONContains the name of the application which owns a given database session.
ATTRIBUTE_CONFIGUnused.
ATTRIBUTE_NAMEContains an attribute’s name. Names may be up to 149 characters long.
ATTRIBUTE_OBJECTContains the id of the SDL Contenta object to which this attribute is attached (i.e. the object which has this attribute set as a LOCAL attribute).
ATTRIBUTE_SCOPEIdentifies the attribute as being either LOCAL, meaning that the attribute has been specifically set on the current object, or INHERITED, meaning that the attribute has been set somewhere in the selected path to the current object.
ATTRIBUTE_VALUEContains the attribute’s value. Values may be up to 255 characters long.
BASE_OBJECTContains the name of the system base class from which the object type was created.
BASE_TYPEContains an internal system value used in the creation of objects.
BEGIN_REVContains the first revision of an object to which (see END_REV).
BLOB_IDContains the object id of the SDL Contenta object
CAN_MODIFYIndicates (YES or NO) whether or not the workflow of the currently selected project can be modified (that is, allows the workflow add, workflow delete, or workflow update commands).
CAPTION_TAGContains the caption used by a link type.
CHECKPOINT_IDCheckpoint’s unique ID.
CHOICEOne of the legal values associated with a property sheet SELECT field.
CLASSSDL Contenta base object from which the currently selected object was derived. The table Classes lists the possible CLASS values corresponding to SDL Contenta object types.
CLASS_TYPECan be either the object type number of the SDL Contenta base object from which the current object was derived (see CLASS) or can contain a description of a link end class type.
COMMANDPortal Command to which the current help description applies.
COMMAND_LINEContains a tool’s command line.
COMMENTCheckpoint comment field.
CONFIGTarget CFG search string for each object found.
CONFIGURATION_IDObject ID of the configuration or project that controls the currently selected object.
COUNTContains a count of the number of references to a link type.
CURRENTIndicates whether or not an object is at the most current view under a configuration or project.
CURRENT_TEMPLATEContains the name of the workflow template which is selected for editing.
DATABASEName of the currently opened database.
DATEContains the date and time when the SDL Contenta Server was built.
DATETIMEContains either the date and time that a checkpoint was created, or the date and time that a session was created.
DBSCHEMAContains the rev of the SCHEMA (i.e. PCM.sql) under which the database was create or to which it has been upgraded.
DBTYPEContains the name of the database platform for which the SDL Contenta Server has been compiled.
DBVERSIONContains the SDL Contenta Server release number under which the database was created or to which it has been upgraded.
DEFAULTWhen returned by requesting a list of tools, indicates whether or not the tool represents the default (double click) operation for the currently selected object.

When returned by requesting the definition of an abstract, indicates whether or not a particular field has been assigned a default value by pcmadmin.

DESCRIPTIONBrief description of the portal command specified in the COMMAND field.
DESKTOPID path of the current user’s desktop.
DESKTOP_IDContains the SDL Contenta object id of a user’s desktop.
DESKTOP_TYPEContains the name of the SDL Contenta object type for the users desktop such as ProjMan and Desktop.
DISPLAYABLEIndicates whether or not a SDL Contenta application should\ display a property sheet field.
DOCTYPEContains the DOCTYPE setting required by a link type .
DONE_DATEDate on which the currently selected project was forwarded from the specified task.
DUE_DATETarget date for completion of that task (if the project creator specified one).
EDIT_LOCKName of the user currently exporting the object. If the object is not currently exported, the field is blank.
ENDDestination task of the task route.
END_REVThe last version of a SDL Contenta object for which a link end is valid (see BEGIN_REV)
EVENTDescribes the kinds of events which are encountered during a tree walk. Event types are as follows:
  • CH – Child. A child slice or object was encountered.
  • FA – Focus Again. An object has been brought into focus for at least the second time.
  • FE – Focus End. The tree walk has ended. There will be no more events.
  • FI – Focus In. An object is being brought into focus for the first time.
  • FO – Focus Out. An object is being brought out of focus, either because the tree walk is about to enter a child, or because the tree walk is finished with the object.
  • FS – Focus Start. This is the first event in the tree walk. The root object is being brought into focus.
  • GE – Group End. A group end slice has been encountered.
  • GS – Group Start. A group start slice has been encountered.
  • RF – Reference. A reference slice has been encountered.
  • SL – Slice. A content slice has been encountered.
FIELDDATACurrent value of the property sheet field.
FIELDNAMEProperty sheet field name.
FIELDTYPEData type of the property sheet field. Valid values:

CHARSTRING, INT, SHEET, LIST, UNKNOWN

FROMName of the user who originated the note.
FUTURE1

FUTURE2

Reserved for future use by link manager.
HAS_NOTESIndicates whether or not one or more notes are attached to the currently selected object. Displayed by any command whose results describe an object or list of objects.
HOSTContains the name of the host machine from which a client application is attached to the database.
ICONContains the name of an icon used to display either an object type, or a workflow task.
ID_PATHID path of the object. Displayed by any command whose results describe an object or list of objects.
INDEXIndex number assigned to the role.
IS_CURRENTIndicates whether or not the currently selected object is at the most current view under a configuration or project.
IS_STALEIndicates whether or not the currently selected object has been modified by another process since the last select or list children command.
KEYUnique identifier for the note: G for global, L for local.
LEVELNumeric value assigned to an access level.
LE_IDContains a link end id.
LINKTYPE_IDContains a link type id.
LINK_END_IDContains a link end id.
LOCK_APPLIEDDuring a tree walk, YES means that the object was locked by the current process, NO means the object is either unlocked, or locked by another process. An empty field means that the event is not describing an object.
LOCK_SESSION_IDContains the session id of the process which owns the on an object.
LOCK_TYPEDescribes what combination of EDIT, CHECKOUT, PROJECT, and/or OWNER are applied to an object. For example, an object which has been checked out of a project shows “PROJECT+CHECKOUT”. If this field is blank there is no lock applied to the object.
LOGIN_NAMEContains a user’s login name. This can be different than the user’s desktop name.
LT_IDContains a link type id.
MARKED_FOR_POSTIndicates whether or not the object will post during the next post command.
MODIFIABLEIndicates whether or not an application can modify the contents of the property sheet field.
NAMEName of the object. Displayed by many commands.
NAME_PATHName path of an object. Commands that describe an object or list of objects display the NAME_PATH field.
NEWPlus sign (+) if the note has not yet been read by the notes open command.
NUMBERSequence number of the note or workflow state.
OBJECTTarget OBJ search string for each object found.
OBJECT_IDObject ID of the currently selected object. Commands that describe an object or list of objects display the OBJECT_ID field.
OBJECT_TYPEUnique number that identifies the object class of all SDL Contenta base objects and user defined objects. The table

Refer to Object Types for a list of the object type values for SDL Contenta objects.

OCCURRENCESContains the number of occurrences of a reference to a link end.
OLD_XContains the X anchor point of a task icon, set by a 2.X application.
OLD_YContains the Y anchor point of a task icon, set by a 2.X application.
OPERATIONSystem operation that results in the checkpoint.
OUT_OF_DATEThe field indicates whether there is a new version of the object in stable data. If there is a new version this field is Yes. If the data is not out-of-date (matches the data in stable data) this field is No.
OWNERName of the user who owns the currently selected project.
OWNER_LOCKName of the user who has declared ownership of the currently selected object through the user lock set command. If the object is not currently owned, the field is blank.
PARENT_SESSION_IDContains the session id of the process which owns checkout locks.

If the process which created the checkout locks has disconnect from the database, this field contains 0.

PATHDescribes the path for an appdata key or value.
PLATFORMDescribes the OS platform for which the SDL Contenta Server was compiled.
PORT_NUMBERTells the client issuing the fork command to which socket to connect.
PROJECT_LOCKName of the project that holds the currently selected object in its post list. If the object is not in a post list, the field is blank.
RETURN STATUSIndicates whether a tool is executed successfully with a value of 0 or 1; any other value indicates failure.
REVRevision number of the currently selected object at the time the checkpoint was created.
ROLERole name.

Commands that manipulate roles display the ROLE field.

ROLESList of roles the user can assume.
SEQUENCEDisplays the number of times a project has been forwarded to get to the current task in the workflow.
SEQUENCE_NUMLink end sequence number.
SESSION_IDA unique ID assigned to each database session.
SESSION_TYPEDescribes a session as able to hold EDIT locks, or CHECKOUT locks.
SIZERaw size of the file or object that has been opened.
SLICE_CLASSDescribes the type of slice. Values are CHILD, CONTENT, END, REFERENCE, or START.
SLICE_CONTENT_SIZEContains the size of a slices content data.
SLICE_CONTROL_SIZEContains the size of a slices control data.
SLICE_IDContains the id of a slice.

This is a number which is unique within a compound object.

SLICE_PARENTReserved for future use.
SLICE_REF_CLASS

When a CHILD or REFERENCE slice points at an SDL Contenta object, this field contains the system base class number of that object.

SLICE_REF_POIDWhen a CHILD or REFERENCE slice point at an SDL Contenta object, this field contains the path to that object.
SLICE_REF_TYPE

When a CHILD or REFERENCE slice points at an SDL Contenta object, this field contains the object type number of that object.

SLICE_TYPEContains a text label assigned to a slice by a tool or adapter.
STANDARD_TOOLIndicates if a tool is a standard (out-of-the-box) SDL Contenta tool; YES, when standard (out-of-the-box) tool otherwise this field contains NO.
STARTName of the task from which the task route originates.
STATUS

This field indicates whether or not an object, workflow template, or appdata user’s settings may be modified.

When describing an object, the field contains, read_write, read_only, reference, or locked. The object may be modified only if the field contains read_write.

When describing a workflow template the field contains either read_write or locked. The workflow

template may be modified only if the field contains read_write.

When describing the list of users to be used to access appdata, the field contains MODIFY or VIEW. A users appdata settings may be modified only if this field contains MODIFY.

SUBJECTContains the subject of a note.
SYNTAXContains the command syntax in the help.
SYSTEM_NUMBERContains the system field number in an abstract definition.

If this field contains a number greater than 0, then the field is required by the system. If the field contains –1, then it may be removed by pcmadmin. All user defined fields have a system_number of –1.

TASKContains the name of a task in a workflow.
TEMPContains the temp directory stored in the UNIX environment variable or Windows registry setting TEMP (or temp).
TEMPLATEContains the name of a link type template.
TEXTContains the text, or body of a note.
TOKENContains the COOKIE to be passed to tools by the current application.
TOOLBAR_LABELObsolete.
TOOLBOXContains the name of a toolbox to which a tool is assigned.
TOOL_IDContains a tool’s id number. This number is unique within any given object type.
TRANSLATION

Indicates the line end translation mode which has been chosen for the currently selected compound object. Values are DOS, UNIX, or NONE.

TRIGGERContains the command line for a trigger placed on a task route.
TYPE
This field is used in describing appdata users, appdata entries, workflows, sessions, and objects.
  • When describing appdata users, this field can be either GLOBAL or USER.
  • When describing appdata entries, this field can be either KEY or VALUE.
  • When describing a workflow, this field can be TASK, TASK_GRAPHIC, TASKROUTE, TASKROUTE_GRAPHIC, or TEAMMEMBER.
  • When describing a workflow, this field can be TASK, TASK_GRAPHIC, TASKROUTE, TASKROUTE_GRAPHIC, or TEAMMEMBER.
  • When used to describe an object, this field contains the name of the object’s object type.
UIDThis field contains a unique id assigned to each user at the time of creation of that user.
UNIQUE_IDThe unique id assigned to each link end.
USERContains the desktop name of an SDL Contenta user.
VALID

This field describes whether or not a tool is valid in the current context.

If the tool is available, the field contains YES otherwise the field contains NO.

VALUEThis field contains the data stored in an appdata value.
VAR_NAMEContains the name of an internal SDL Contenta Server variable.
VAR_TYPEContains the type of an internal SDL Contenta Server variable.

Valid types are: DATEFORMAT, DATETIME, INTEGER, STRING, TIMEFORMAT, TIMEZONE, TOGGLE, or YEARFORMAT.

VAR_VALUEContains the value of an internal SDL Contenta Server variable.
VERSIONContains the release version of the SDL Contenta Server.
XAn X anchor point for graphical display of a 3.0 workflow task icon, or task route line.
YA Y anchor point for graphical display of a 3.0 workflow task icon, or task route line.