Syntax: dssetprop [options] [server | handle] property-value+
dsgetprop [options] [server | handle] property-spec
dslistprop [options] [server | handle]
The three DocuShare property commands allow the administrator to inspect any DocuShare DSClass,
object, and object property value.
· The dssetprop command replaces the current value of the named property with the value
provided. Password related properties are excluded.
· The dsgetprop command returns the current value of the named property. Password related
properties are excluded.
· The dslistprop command looks up the handle in the DocuShare database and returns a list of
names for all readable properties associated with that handle. Use dslistprop to list
classname properties.
These commands require a DocuShare handle, such as Collection-10 or User-23, as the first argument. If
the handle or property cannot be found in the DocuShare database, the command will display a message
stating that the handle or property cannot be found and then exits the command with a -1 status.
Options for dssetprop
-append Used for parent property, append to current parent list. If both replace and
append options are enabled, treat as append. If -q is enabled, the append
option is enabled by default unless replace is enabled.
-h Help. Print out the usage information for the command.
-replace Used for parent property, replace existing parent(s).
-l Level. Write the specified level (debug, trace, info, warn, error, fatal)
messages to the log file.
-q Quiet. Run the command in quiet mode. Suppresses all informational
messages with user yes/no prompts. Assume Yes to all prompts and proceed
at your own risk.
Example of yes/no prompt: Replace existing parent(s) or append to parent list?
-u User. For dsgetprop and dssetprop only. Run the command as the specified
user, by user object handle. By default, all commands run as the admin user,
which gives them unrestricted rights and makes admin the author of any edit
operations performed by the command. For example, specifying -u User-12
causes the command to run as User-12 instead of admin.
Examples for using dssetprop
dssetprop Document-11 title "Sales Results" — set the title of Document-11 to "Sales Results".
dssetprop -append Document-11 parents Collection-11, Collection-12 — add Document-11 to
Collection-11 and Collection-12.
dssetprop -replace Document-11 parents Collection-13 — remove Document-11 from the parent
collection and have it appear only in Collection-13.
dssetprop URL-11 custom_date “11/05/04 8:14 PM†— set a custom date for object URL-11.
dssetprop URL-11 expiration_date “11/05/04 8:14 PM†— set an expiration date for object URL-11
dssetprop serverEmail joesmith@acme.com — set the email address of the site admin to
“joesmith@acme.com.â€