Data fields
The fields and data returned by PcmPortal are described.
- String — any form of alphanumeric data
- Numeric — decimal numbers
- ID — relative or absolute object id_paths
- Boolean — string fields that contain YES or NO
| Field | Description |
|---|---|
| 2.X_TOOL | Boolean 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_TYPE | Contains the system abstract number associated with an object type. |
| ACCELERATOR_KEY | Hot key that an application can use to invoke the tool. |
| ANCHOR_TYPEL | Contains the anchor type of a link type as defined by link manager. |
| APPLICATION | Contains the name of the application which owns a given database session. |
| ATTRIBUTE_CONFIG | Unused. |
| ATTRIBUTE_NAME | Contains an attribute’s name. Names may be up to 149 characters long. |
| ATTRIBUTE_OBJECT | Contains 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_SCOPE | Identifies 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_VALUE | Contains the attribute’s value. Values may be up to 255 characters long. |
| BASE_OBJECT | Contains the name of the system base class from which the object type was created. |
| BASE_TYPE | Contains an internal system value used in the creation of objects. |
| BEGIN_REV | Contains the first revision of an object to which (see END_REV). |
| BLOB_ID | Contains the object id of the SDL Contenta object |
| CAN_MODIFY | Indicates (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_TAG | Contains the caption used by a link type. |
| CHECKPOINT_ID | Checkpoint’s unique ID. |
| CHOICE | One of the legal values associated with a property sheet SELECT field. |
| CLASS | SDL 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_TYPE | Can 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. |
| COMMAND | Portal Command to which the current help description applies. |
| COMMAND_LINE | Contains a tool’s command line. |
| COMMENT | Checkpoint comment field. |
| CONFIG | Target CFG search string for each object found. |
| CONFIGURATION_ID | Object ID of the configuration or project that controls the currently selected object. |
| COUNT | Contains a count of the number of references to a link type. |
| CURRENT | Indicates whether or not an object is at the most current view under a configuration or project. |
| CURRENT_TEMPLATE | Contains the name of the workflow template which is selected for editing. |
| DATABASE | Name of the currently opened database. |
| DATE | Contains the date and time when the SDL Contenta Server was built. |
| DATETIME | Contains either the date and time that a checkpoint was created, or the date and time that a session was created. |
| DBSCHEMA | Contains the rev of the SCHEMA (i.e. PCM.sql) under which the database was create or to which it has been upgraded. |
| DBTYPE | Contains the name of the database platform for which the SDL Contenta Server has been compiled. |
| DBVERSION | Contains the SDL Contenta Server release number under which the database was created or to which it has been upgraded. |
| DEFAULT | When 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. |
| DESCRIPTION | Brief description of the portal command specified in the COMMAND field. |
| DESKTOP | ID path of the current user’s desktop. |
| DESKTOP_ID | Contains the SDL Contenta object id of a user’s desktop. |
| DESKTOP_TYPE | Contains the name of the SDL Contenta object type for the users desktop such as ProjMan and Desktop. |
| DISPLAYABLE | Indicates whether or not a SDL Contenta application should\ display a property sheet field. |
| DOCTYPE | Contains the DOCTYPE setting required by a link type . |
| DONE_DATE | Date on which the currently selected project was forwarded from the specified task. |
| DUE_DATE | Target date for completion of that task (if the project creator specified one). |
| EDIT_LOCK | Name of the user currently exporting the object. If the object is not currently exported, the field is blank. |
| END | Destination task of the task route. |
| END_REV | The last version of a SDL Contenta object for which a link end is valid (see BEGIN_REV) |
| EVENT | Describes the kinds of events which are encountered during a tree walk. Event types are as follows:
|
| FIELDDATA | Current value of the property sheet field. |
| FIELDNAME | Property sheet field name. |
| FIELDTYPE | Data type of the property sheet field. Valid values: CHARSTRING, INT, SHEET, LIST, UNKNOWN |
| FROM | Name of the user who originated the note. |
| FUTURE1 FUTURE2 | Reserved for future use by link manager. |
| HAS_NOTES | Indicates 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. |
| HOST | Contains the name of the host machine from which a client application is attached to the database. |
| ICON | Contains the name of an icon used to display either an object type, or a workflow task. |
| ID_PATH | ID path of the object. Displayed by any command whose results describe an object or list of objects. |
| INDEX | Index number assigned to the role. |
| IS_CURRENT | Indicates whether or not the currently selected object is at the most current view under a configuration or project. |
| IS_STALE | Indicates whether or not the currently selected object has been modified by another process since the last select or list children command. |
| KEY | Unique identifier for the note: G for global, L for local. |
| LEVEL | Numeric value assigned to an access level. |
| LE_ID | Contains a link end id. |
| LINKTYPE_ID | Contains a link type id. |
| LINK_END_ID | Contains a link end id. |
| LOCK_APPLIED | During 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_ID | Contains the session id of the process which owns the on an object. |
| LOCK_TYPE | Describes 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_NAME | Contains a user’s login name. This can be different than the user’s desktop name. |
| LT_ID | Contains a link type id. |
| MARKED_FOR_POST | Indicates whether or not the object will post during the next post command. |
| MODIFIABLE | Indicates whether or not an application can modify the contents of the property sheet field. |
| NAME | Name of the object. Displayed by many commands. |
| NAME_PATH | Name path of an object. Commands that describe an object or list of objects display the NAME_PATH field. |
| NEW | Plus sign (+) if the note has not yet been read by the notes open command. |
| NUMBER | Sequence number of the note or workflow state. |
| OBJECT | Target OBJ search string for each object found. |
| OBJECT_ID | Object ID of the currently selected object. Commands that describe an object or list of objects display the OBJECT_ID field. |
| OBJECT_TYPE | Unique 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. |
| OCCURRENCES | Contains the number of occurrences of a reference to a link end. |
| OLD_X | Contains the X anchor point of a task icon, set by a 2.X application. |
| OLD_Y | Contains the Y anchor point of a task icon, set by a 2.X application. |
| OPERATION | System operation that results in the checkpoint. |
| OUT_OF_DATE | The 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. |
| OWNER | Name of the user who owns the currently selected project. |
| OWNER_LOCK | Name 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_ID | Contains 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. |
| PATH | Describes the path for an appdata key or value. |
| PLATFORM | Describes the OS platform for which the SDL Contenta Server was compiled. |
| PORT_NUMBER | Tells the client issuing the fork command to which socket to connect. |
| PROJECT_LOCK | Name 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 STATUS | Indicates whether a tool is executed successfully with a value of 0 or 1; any other value indicates failure. |
| REV | Revision number of the currently selected object at the time the checkpoint was created.
|
| ROLE | Role name. Commands that manipulate roles display the ROLE field. |
| ROLES | List of roles the user can assume. |
| SEQUENCE | Displays the number of times a project has been forwarded to get to the current task in the workflow. |
| SEQUENCE_NUM | Link end sequence number. |
| SESSION_ID | A unique ID assigned to each database session. |
| SESSION_TYPE | Describes a session as able to hold EDIT locks, or CHECKOUT locks. |
| SIZE | Raw size of the file or object that has been opened. |
| SLICE_CLASS | Describes the type of slice. Values are CHILD, CONTENT, END, REFERENCE, or START. |
| SLICE_CONTENT_SIZE | Contains the size of a slices content data. |
| SLICE_CONTROL_SIZE | Contains the size of a slices control data. |
| SLICE_ID | Contains the id of a slice. This is a number which is unique within a compound object. |
| SLICE_PARENT | Reserved 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_POID | When 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_TYPE | Contains a text label assigned to a slice by a tool or adapter. |
| STANDARD_TOOL | Indicates 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. |
| START | Name 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. |
| SUBJECT | Contains the subject of a note. |
| SYNTAX | Contains the command syntax in the help. |
| SYSTEM_NUMBER | Contains 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. |
| TASK | Contains the name of a task in a workflow. |
| TEMP | Contains the temp directory stored in the UNIX environment variable or Windows registry setting TEMP (or temp). |
| TEMPLATE | Contains the name of a link type template. |
| TEXT | Contains the text, or body of a note. |
| TOKEN | Contains the COOKIE to be passed to tools by the current application. |
| TOOLBAR_LABEL | Obsolete. |
| TOOLBOX | Contains the name of a toolbox to which a tool is assigned. |
| TOOL_ID | Contains 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. |
| TRIGGER | Contains 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.
|
| UID | This field contains a unique id assigned to each user at the time of creation of that user. |
| UNIQUE_ID | The unique id assigned to each link end. |
| USER | Contains 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. |
| VALUE | This field contains the data stored in an appdata value. |
| VAR_NAME | Contains the name of an internal SDL Contenta Server variable. |
| VAR_TYPE | Contains the type of an internal SDL Contenta Server variable. Valid types are: DATEFORMAT, DATETIME, INTEGER, STRING, TIMEFORMAT, TIMEZONE, TOGGLE, or YEARFORMAT. |
| VAR_VALUE | Contains the value of an internal SDL Contenta Server variable. |
| VERSION | Contains the release version of the SDL Contenta Server. |
| X | An X anchor point for graphical display of a 3.0 workflow task icon, or task route line. |
| Y | A Y anchor point for graphical display of a 3.0 workflow task icon, or task route line. |