Show TOC

PROPERTY / PROPLocate this document in the navigation structure

Use

Sets, reads and removes properties on the resource stored in the DTR. Each resource exposes a number of properties.

There are two types of properties:

  • Properties whose semantics are enforced by the server ( live properties ). Most of these properties are calculated: Their values cannot be changed directly with the property command, but are changed as a result of commands executed on the server.

  • Properties that can be maintained freely by the user with the property command ( dead properties ). The dead properties can only be changed on checked-out resources.

Syntax

Syntax

PROPERTY <resourcePath> <-pn propertyName> [-pv propertyValue] [-s|-g|-r] [-a] [-dn] [-nuri] [-reg]

Arguments

<resourcePath(s)>

The path to the resource.

<-pn propertyName>

Specifies the name of the property. Property name should be specified in the following format namespacePrefix:name . Specifying the namespace is mandatory.

[-s]

If the property already exists, this sets the property with the specified name and value or adds it if it does not exist.

[-pv propertyValue]

To specify the value of the property.

[-g]

Gets and displays the property and its value.

[-r]

Removes the property.

[-a]

Name of the activity to be used to check out the folder item in case it is activity recorded and is not already checked out. The activity will be created if it does not exist.

[-dn]

Specifies if the name of the activity given is the display name and not the actual name. Use this argument to specify an already existing activity.

[-nuri]

To specify the namespace URI to be used to manage a property. If the namespace specified is not registered for the given prefix then the operation fails. In case you want to get all properties, then properties for all registered namespaces are displayed.

[-reg]

Registers the namespace URI if it is not already registered.

Description

This command can be used to add, edit or delete a property for a resource. If more than one resource is specified together, then the other options will be applicable to each of them. If the resource is not a folder item then the URL of the resource should be specified.

In case -g/-r/-s is not specified the default action is get (-g).

Example

Finding All Properties of a File

To find all properties defined on the file a.java in the current folder, execute:

prop a.java -g -all

The -g option means "get", the -all option means "all properties".

Finding Certain Properties of a File

To search for certain properties defined for the a.java file in the current folder (for example, for the name of the developer who created a.java ), execute:

prop a.java -g -pn DAV:creator-displayname

The -pn option is used to specify a property name in the form namespacePrefix:name . A namespace prefix is a shortcut for a namespace. There are two predefined namespace prefixes: DAV and XCM. In this case, the namespace prefix is "DAV" and the name is "creator-displayname".

Note

The property command is based on the PROPPATCH command of the WebDAV/DeltaV protocol.