pcmcmd

The portal utility pcmcmd is the command line interface to PcmPortal.

Use pcmcmd to connect to a Contenta database, communicate with the database through a socket, and navigate and manipulate data using ASCII commands.
Execute at a command prompt:
OSCommand
UNIXsource $XYV_PDM_ROOT/bin/pdm.cshrc

$XYV_PDM_ROOT/bin/pcmcmd

Windowscd Contenta_home\bin

pcmcmd

Where on Windows, Contenta_home is the top level directory where Contenta software is located.
If you execute the command without switches, you are prompted for necessary information, described below.
Prompted for:Command line switchDescription
Host name-hostThe name of the Contenta Server node.
Socket number-socket

The socket number that PcmPortal uses to communicate with the database.

Note that the socket number you indicate must be an active PcmPortal number.
Database-dbaseThe name of the Contenta database to which you want to connect.
Login-userA valid Contenta user login name, typically sysadmin.
Password-passwordThe password for the user login name you entered.

After providing the information, the portal selects the desktop associated with the login name, selects and displays information about the desktop then displays a CMD> prompt.

Example:
Host name: keeter
Socket number: 6050
Database: apiguide
Login: sysadmin
Password: manager

You can issue the command with the necessary information in the command line, for example:

pcmcmd -host server -socket num -dbase dbname -user username -password password

Sample system response:
AUTO> select desktop
|000001|000105|
pcmtrain|/#1/#2|/Global/sysadmin|sysadmin|/
#1#2|SysAdmin |25|#2|#1|read_write| | | | |
|99|NO|2328|YES|
CMD>
The following describes the information about the desktop shown in the sample system response above:
System responseDescription
AUTO> select desktopThis command is automatically generated by the portal. The command selects thecurrent desktop, the output that followsdescribes the desktop contents.
|000001|000105||000001| — is the item count; a six digit number of items (lines) that follow.

|000105| — is the character count; a six digit number of characters that follow that does not include end-of-line characters.

pcmtrain

|/#1/#2

|/Global/sysadmin

|sysadmin

|/#1#2

|SysAdmin

|25

|#2

|#1

|read_write

|

|

|

|

|

|99

|NO

|2328

|YES|

Field 1: DATABASE

Field 2: ID_PATH

Field 3: NAME_PATH

Field 4: NAME

Field 5: DESKTOP

Field 6: TYPE

Field 7: CLASS

Field 8: OBJECT_ID

Field 9: CONFIGURATION_ID

Field 10: STATUS

Field 11: PROJECT_LOCK

Field 12: OWNER_LOCK

Field 13: EDIT_LOCK

Field 14: LOCK_TYPE

Field 15: LOCK_SESSION_ID

Field 16: OBJECT_TYPE

Field 17: HAS_NOTES

Field 18: REV

Field 19: IS_CURRENT

To list the contents of the current container object, at the pcmcmd CMD> prompt type:
list children
Sample system response:
|000013|000834|
|XyBooks, Inc.|/#1/#2|Configuration|67|#6|#6|read_write||||||97|NO|
|ProjMan|/#1/#2|ProjMan|25|#257|#1|read_write| | | | | |83|NO|
|CEuser1|/#1/#2|Desktop|25|#303|#1|read_write| | | | | |81|NO|
|CEuser2|/#1/#2|Desktop|25|#302|#1|read_write| | | | | |81|NO|
|CEuser3|/#1/#2|Desktop|25|#305|#1|read_write| | | | | |81|NO|
|CEuser4|/#1/#2|Desktop|25|#307|#1|read_write| | | | | |81|NO|
|CEuser5|/#1/#2|Desktop|25|#310|#1|read_write| | | | | |81|NO|
|CEuser6|/#1/#2|Desktop|25|#311|#1|read_write| | | | | |81|NO|
|CEuser7|/#1/#2|Desktop|25|#312|#1|read_write| | | | | |81|NO|
|CEuser8|/#1/#2|Desktop|25|#313|#1|read_write| | | | | |81|NO|
|XyWriters|/#1/#2|WorkPool|69|#266|#1|read_write| | | | | |82|NO|
|XyReviewers|/#1/#2|WorkPool|69|#267|#1|read_write| | | | | |82|NO|
For a description of the fields (after the item count and number of characters) at the pcmcmd CMD> prompt type:
labels on
Sample system response:
Field 1: NAME
Field 2: DESKTOP
Field 3: TYPE
Field 4: CLASS
Field 5: OBJECT_ID
Field 6: CONFIGURATION_ID
Field 7: STATUS
Field 8: PROJECT_LOCK
Field 9: OWNER_LOCK
Field 10: EDIT_LOCK
Field 11: LOCK_TYPE
Field 12: LOCK_SESSION_ID
Field 13: OBJECT_TYPE
Field 14: HAS_NOTES
To access Help and view a list of commands and parameters, at the pcmcmd CMD> prompt type:
help
For additional information about a command, at the pcmcmd CMD> prompt type:
help command
For example:
help user
Sample system response:
|user|<create/delete/info/password> <options>|manage users|
The information is displayed in the format: |command|syntax|description|