Files
alfresco-community-repo/source/web/jsp/admin/avm-console-help.txt
Derek Hulley 5c7525fc4a Merged V3.1 to HEAD
12943: Port of support for ADB-47 from V2.1-A to 3.1
   12948: Port of tests from CHK-2235 for ADB-20 from V2.1-A to 3.1
   12965: Activated index tracker Quartz job by default
   12974: Port for lazy creation of home folders with configuration from V2.1-A to V3.1: original CHK-2619, CHK-2716
   12976: Merged V2.1A to V3.1
      8562: (record-only) Fix to lazily create home folders - DO NOT MERGE
      8694: (record-only) Added configuration for lazy or eager creation of home folders
   12978: Merged V3.0 to V3.1
      12920: Merged V2.2 to V3.0
         12456: Wire up AVM locking service by interface to allow for potential over-ride
         12457: Make AVM ChildKey case insensitive
         12470: Merged V2.2.1-NBC-FIXES to V2.2
            12156: Optimizations to WCMWorkflowEvaluator and WCMWorkflowDeletedEvaluator    
            12605: Hide annoying "Virtualisation Server not started" warnings (by making them debug)
         12707: AVM console - "snap" also allows tag and description to be specified
   12979: Build/test fix
   ___________________________________________________________________
   Modified: svn:mergeinfo
      Merged /alfresco/BRANCHES/DEV/V2.2.1-NBC-FIXES:r12156
      Merged /alfresco/BRANCHES/V2.1-A:r8562,8694
      Merged /alfresco/BRANCHES/V3.0:r12920
      Merged /alfresco/BRANCHES/V2.2:r12456-12457,12470,12605,12707
      Merged /alfresco/BRANCHES/V3.1:r12943,12948,12965,12974,12976,12978-12979


git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@13544 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
2009-03-11 01:06:49 +00:00

365 lines
7.0 KiB
Plaintext

Help For The AVM Console.
-------------------------
Basic Syntax:
Enter commands into the Command box of the form:
command, arg1, arg2, arg3, ... argn
Enter further data into the Optional Data box for
command like write, create that require input data.
Click Execute to run the command.
Individual Commands:
ls - Lists the contents of the given directory.
ls, avmpath, #versionnumber#
avmpath is a valid avm path which are of the form:
storename:/name/name/name.../name
The root of the store is simply
storename:/
#versionnumber# is an integer constant indicating
the version number. -1 is used to reference the 'HEAD'
version.
------
lsr - Lists the contents of the given directory recursively.
lsr, avmpath, #versionnumber#
avmpath and #versionnumber# as above.
------
lsrep - Lists all the avmstores.
lsrep
------
lsver - Lists the versions in a given store.
lsver, storename
storename is the name of the store (alphanumeric).
------
mkrep - Create a new store.
mkrep, storename
storename as above.
------
setstoreproperty - Set the value of store property.
setstoreproperty, storename, qname, value
value - the new property value - the type will be auto-detected. At present only TEXT
and INT types are suppored as well as collections of these types. Collections
can be specified using a comma seperated list enclosed in square brackets.
qname - the property name in the form {namespaceURI}localName
------
setstorepermission - Set a permission mask on a store.
setstorepermission, storename, authority, permission
authority - the user or group identifier.
permission - the permission name to set.
------
clearstorepermission - Clears a permission mask on a store for a given authority.
clearstorepermission, storename, authority
authority - the user or group identifier.
------
load - Loads content recursively into an avm directory.
load, fspath, avmpath
fspath is a local filesystem path. Use '/'s to
be safe, even on windows.
avmpath as above and must be a path to a directory.
------
mkdir - Create a new directory
mkdir, avmpath, name
avmpath is as above and must point to a directory.
name must be a valid Alfresco path component name.
------
mkbr - Create a branch
mkbr, srcavmpath, dstavmpath, name, #versionnumber#
srcavmpath is a valid avmpath
dstavmpath is a valid avmpath to a directory
name is a valid path component name.
------
mkldir - Create a new layered directory
mkldir, targetavmpath, avmpath, name
targetavmpath is a valid avmpath to a directory which
will be what the new layered directory is transparent to.
avmpath is and avmpath to the directory which will contain
the new layered directory.
name is a valid path component name.
------
rename - Renames a node from one place to another.
rename, srcdiravmpath, srcname, dstdiravmpath, dstname
srcdiravmpath is the avm directory that contains the node
to be renamed.
srcname is the name of the node to rename.
dstdiravmpath is the avm directory that the renamed
node will live in.
dstname is the name of the renamed node.
------
cp - Copies a file from one place to another.
cp, avmpath, #versionnumber#, diravmpath, name
avmpath is the path to the file to copy.
#versionnumber# is as above.
diravmpath is the directory in which the copy will
reside.
name is the name of the copy.
------
snap - Creates a snapshot (a new version of an
avmstore).
snap, storename, tag, description
storename is the name of the store to snapshot.
tag is the short label - note: cannot contain ',' using this interface
description is the longer description - note: cannot contain ',' using this interface
------
cat - Shows the textual content of a node. Sorry no binary
viewing.
cat, avmpath, #versionnumber#
avmpath as above.
#versionnumber# as above.
------
rm - Remove a node.
rm, avmpath, name
avmpath is a pointer to a directory.
name is the name of the node in that directory
to remove.
------
rmrep - Purges a store, i.e. makes it truly go away.
rmrep, name
name is the name of the store to purge.
------
rmver - Purges a particular version of a store.
rmver, name, #versionnumber#
name is the name of the store.
#versionnmber# is the version to purge.
------
write - Writes content to an existing file.
write, avmpath
avmpath is a path to a file.
This command expects the content to be written in
the Optional Data box.
------
create - Create a new file.
create, avmpath, name
avmpath is a path to a directory.
name is the name to give the new file.
This command expects the content to be written in
the Optional Data box.
------
stat - Get information on a node.
stat, avmpath, #versionnumber#
avmpath as above.
#versionnumber# as above.
------
getnodeproperties - List all properties of a node.
getnodeproperties, avmpath, #versionnumber#
avmpath as above.
#versionnumber# as above.
------
descnode - Describes a node (including lock information).
descnode, avmpath, #versionnumber#
avmpath as above.
#versionnumber# as above.
------
deletenodeproperty - Delete a property of a node.
deletenodeproperty, avmpath, #versionnumber#, qname
avmpath as above.
#versionnumber# as above.
qname - a property name in the form {namespaceURI}localName
------
setnodeproperty - Set the value of node property.
setnodeproperty, avmpath, qname, value
value - the new property value - the type will be auto-detected. At present only TEXT,
NODE_REF and INT types are suppored as well as collections of these types. Collections
can be specified using a comma seperated list enclosed in square brackets.
qname - the property name in the form {namespaceURI}localName
------
setnodepermission - Set a permission mask on a node.
setnodepermission, avmpath, authority, permission
authority - the user or group identifier.
permission - the permission name to set.
------
clearnodepermission - Clears a permission mask on a node for a given authority.
clearnodepermission, avmpath, authority
authority - the user or group identifier.
------
history - Get a list of the previous versions
of a node.
history, avmpath, #versionnumber#, #count#
avmpath as above.
#versionnumber# as above.
#count# The number of versions into the past to list.
-1 means all.
------
statstore - Show information about a store.
statstore, storename
storename The name of the store.
------
compare - Compares two trees.
compare, avmpath, #versionnumber#, avmpath, #versionnumber#
------
update - Promotes a node from one tree to another.
update, avmpath, #versionnumber#, avmpath
------
resetLayer - Resets a layer.
resetLayer, avmpath
------
flatten - Flattens a layer against a target tree.
flatten, avmpath, avmpath
------
getnodeaspects - List all aspects of a node.
getnodeaspects, avmpath, #versionnumber#
------
addnodeaspect - Add an aspect to a node.
addnodeaspect, avmpath, qname
qname - an aspect name in the form {namespaceURI}localName
------
deletenodeaspect - Remove an aspect and it's properties from a node.
deletenodeaspect, avmpath, qname
qname - an aspect name in the form {namespaceURI}localName