Import a script from the repository using a name-based path:

<import resource="/Company Home/Data Dictionary/Scripts/library.js">

Import a script from the repository using a NodeRef reference:

<import resource="workspace://SpacesStore/6f73de1b-d3b4-11db-80cb-
112e6c2ea048">

Import a script from a Java classpath location:

<import resource="classpath:alfresco/extension/myutils.js">

companyhome—The Company Home ScriptNode.

userhome—The current user's Home Space ScriptNode.

person—The ScriptNode representing the current user's Person object.

space—The current space ScriptNode, if any. For a script executed as part of a rule, the space object is the space in which the rule resides. If the rule is inherited, this may not be the expected space.

document—The current document ScriptNode, if any.

script—The ScriptNode representing the script object itself. This is only available if the script is loaded from the Java classpath.

args—An associative array of any URL parameters passed using the Script Processor Servlet.

search—A host object providing access to the various Alfresco search interfaces such as FTS-Alfresco, Lucene, XPath and Saved Search results.

people—A host object providing access to and manipulating Alfresco person objects and groups.

actions—A host object providing invocation of registered Alfresco actions.

logger—A host object providing access to console logging facilities for script debugging.

session—Session-related information, such as the current authentication ticket.

classification—Access to the root elements of the Classification API.

utils—Access to a library of helper functions that are not provided as part of generic JavaScript.

webprojects—The root of the WCM JavaScript API providing access to Web projects, sandboxes, WCM assets, and project membership.

invitations—The root of the Invitations API providing access to invitations for Web sites.

groups—The root of Group authorities providing access to advanced authority APIs for manipulating groups and zones.

properties—An associative array (map) of the properties for the node. For example:

userhome.properties.name

var name1 = userhome.properties.name
var name2 = userhome.properties["name"];
var name3 = userhome.properties["cm:name"];
var name4 = userhome.properties["{http://www.alfresco.org/
model/content/1.0}name"];

var locale = document.properties.locale.properties.name;

var localeNoderef =
document.properties.locale.nodeRef;

var mimetype = document.properties.content.mimetype;
var content = document.properties.content.content;

document.content = "some new text content";
var mimetype = document.mimetype;
var url = document.url;

children—A read-only JavaScript array of the child nodes. For example:

mynode.children[0]

assocs—A read-only associative array of the target associations of the node. For example:

mynode.assocs["cm:translations"][0]

sourceAssocs—A read-only associative array of the source associations to the node. For example:

mynode.sourceAssocs["cm:translations"][0]

childAssocs—A read-only associative array of the child associations of the node. For example:

myforumnode.childAssocs["fm:discussion"][0]

parentAssocs—A read-only associative array of the parent associations of the node. Each named entry in the children, assocs, sourceAssocs, childAssocs, and parentAssocs arrays contain an array of the ScriptNode objects on the end of the association. For example:

mynode.parentAssocs["cm:contains"][0]

aspects—A read-only array of the aspects as fully qualified QName strings applied to the node

isContainer—Returns true if the node is a folder node; otherwise, it is false.

isDocument—Returns true if the node is a content node; otherwise, it is false.

content—The content of the node on the default cm:content property as a string value that can be modified to update the content of the node

url—A read-only URL to the content stream for this node

downloadUrl—A read-only URL to the content stream for this node as an HTTP1.1 attachment object

mimetype—The MIME type encoding for content on the default cm:content property attached to this node

size—A read-only size in bytes of content on the default cm:content property attached to this node

displayPath—A read-only display path to this node

qnamePath—A read-only QName type path to this node

icon16—A read-only small icon image for this node

icon32—A read-only large icon image for this node

isLocked—Returns true if the node is locked; otherwise, it is false.

id—GUID for the node

nodeRef—NodeRef as a string for the node

name—Shortcut access to the cm:name property

type—Fully qualified QName type of the node

typeShort—Prefix string or short QName type of the node

parent—The primary parent node. This will be null if this is the root node.

parents—An array of the parent nodes

isCategory—Returns true if this is a category node; otherwise, it is false.

childByNamePath(path)— Performs a path-based query on the name property of the nodes; returns a node found at the specified path relative to the current node, else, null is returned. For example:

var testingFolder =userhome.childByNamePath("QA/Performance/Testing");

childrenByXPath(xpath)—Performs an XPath-based query relative to the current node; returns an array of the nodes found or an empty array if no results are matched. For example:

var nodes = userhome.childrenByXPath("*[@cm:name='Finance Documents']/*");

activeWorkflows—Returns an array of all active workflows of which this node is involved, or returns null if the node is not part of an active workflow

isScriptContent(obj)—Returns true if the supplied node property value is a ScriptContentData object

hasAspect(type)—Returns true if an aspect was applied to the node. For example:

var isTemplatable = document.hasAspect("cm:templatable");

specializeType(type)—Specializes the type of a node where the type name supplied is a subtype of the current type as defined in the Data Dictionary; returns true on success, otherwise, it is false.

isSubType(type)—Determines if this node is a subtype of the specified type; returns true if this node is a subtype of the specified type.

properties—The property array can be modified to update or add new properties. For example:

// change the name of this document
document.properties.name = "Backup of " + document.properties.name;
// add a new property string
document.properties["cm:locale"] = mylocalenode;
// save the property modifications
document.save();

name —A helper property to get/set the name. This is a shortcut for properties.name.

content—A property to modify the text content of a node. For example:

mynode.content = mynode.content + "append some text";

This is very powerful, as it allows the content of a node to be changed from within a script. It is recommended that nodes with binary content should not be manipulated this way.

createFile(name)—Creates a new file (cm:content) node with the specified name as a child of this node; returns the newly created node as the result of the function or throws an exception if the creation failed. For example:

var myfile = userhome.createFile("newfile.txt");

createFolder(name)—Creates a new folder (cm:folder) node with the specified name as a child of this node; returns the new node as the result of the function or throws an exception if the creation fails. For example:

var myfolder = userhome.createFolder("New Folder");

createNode(name, type)—Creates a new node of the specified type as a QName in either full or short form. For example:

var node = userhome.createNode("myfolder", "cm:folder");

createNode(name, type, assocType)—Creates a new node of the specified type as a child of the current node with the given child association type. The assocType parameter is the QName of the child association type to create. For example:

var node = myforum.createNode("My Discussion", "fm:forum", fm:discussion");

createNode(name, type, properties)—Creates a new node as a child of the current node with the specified properties

createNode(name, type, properties, assocType)—Creates a new node of the specified type as a child of the current node with the given child association name and properties with that child association type

createNode(name, type, properties, assocType, assocName)—Creates a new node as a child of the current node containing the specified child association name, properties, and the given child association type and name

addNode(node)—Adds an existing node as a child of this node

removeNode(node)—Removes all parent-child relationships between two nodes; the child node will be cascade deleted if one of the associations was the primary association (the one with which the child node was created)

createAssociation(target, assocType)—Creates a new target association to the specified node with the given association type Qname

removeAssociation(target, assocType)—Removes the association to the specified node with the given association type Qname

remove()—Deletes the node discarding any variable or references to the ScriptNode. Returns true on success; otherwise, it is false. For example:

mynode.remove();

copy(destination)—Copies the node to the specified destination node (excluding children of the source node); returns the newly copied ScriptNode instance on success or null if the copy fails

copy(destination, deepCopy)—Copies the node to the specified destination node (copies all child nodes of the source if the deepCopy argument is true; otherwise, only copies the source node itself); returns the copied ScriptNode instance on success or null if the copy fails reason. For example:

var docCopy = document.copy(userhome);

move(destination)—Moves the node to the new parent destination; returns true on success or false on failure to move.

addAspect(aspect)—Adds a new aspect to the node where the type is a QName of the aspect to add in either fully qualified or short name form; returns true if the aspect was added successfully; returns false otherwise. For example:

document.addAspect("cm:translatable");

addAspect(aspect, properties)—Adds a new aspect and properties to the node, allowing mandatory aspect properties to be supplied when the new aspect is applied. For example:

var props = new Array(1);
props["cm:template"] = myTemplateNode.nodeRef;
document.addAspect("cm:templatable", props);

removeAspect(aspect)—Removes the specified aspect from the node

content—A read/write value representing the content as a string

mimetype—A read/write string value representing the MIME type of the content

encoding—A read/write string value representing the encoding of the content, such as "UTF-8"

size—A read-only long value representing the size in bytes of the content

url—A read-only string representing the download URL for the content

downloadUrl—A read-only string representing the download (as attachment) URL for the content

write(content)—Copies the content from the specified ScriptContent

guessMimetype(filename)—Guesses and applies the MIME type to the content based on the given file name

owner — The owner property of the node (as a UID)

hasPermission(permission)—Checks for permissions on the node; returns true if the user has the specified permission on the node.

getPermissions()—Returns a string of the permissions attached to a node in the format [ALLOWED|DENIED];[USERNAME|GROUPNAME];PERMISSION. For example: ALLOWED;kevinr;Consumer can be easily tokenized on the semicolon (;) character.

inheritsPermissions()—Returns true if the node currently inherits its permissions from the parent space, or false to indicate the permissions are set specifically on the node.

setInheritsPermissions(inherit)—Indicates that the node should inherit permissions from the parent node when set to true, or false to break the inheritance chain.

setPermission(permission)—Applies a permission for all users to the node.

setPermission(permission, authority)—Applies a permission for the specified authority (such as username or group) to the node.

removePermission(permission)—Removes a permission for all users from the node.

removePermission(permission, authority)—Removes a permission for the specified authority (such as username or group) from the node.

setOwner(userId)—Sets the owner of the node.

takeOwnership()—Takes ownership of the node.

getOwner()—Gets the owner of the node (as a UID).

checkout()—Performs a check-out operation of the node; returns the resulting working-copy node

checkout(destination)—Performs a check-out operation of the node to the specified destination; returns the resulting working copy node

checkin()—Performs a check-in operation on a working-copy node (copies the current state of the working copy to the original node, including any content updated in the working node); returns the original node that was previously checked out

checkin(description) —Performs a check-in operation on a working-copy node, applying the specified version history note text; returns the original node that was previously checked out

checkin(description, majorVersion) —Performs a check-in operation on a working-copy node, applying the specified version history note text and version (major or minor) increment; returns the original node that was previously checked out

cancelCheckout()—Cancels the check-out of a working-copy document, deleting the working copy and any changes made to it; returns the original node that was previously checked out

isVersioned—A read-only Boolean property to determine if the document versioned

versionHistory—A read-only property for listing all versions of the document (in descending version-created date order)

createdDate—A read-only property representing the date on which the version was created

creator—A read-only property representing the username of the person who created the version

label—A read-only property representing the version label

type—A read-only property representing the version type (MAJOR, MINOR)

description—A read-only property representing the description (history comment) of the version

nodeRef—A read-only property representing the node reference of the document that was versioned

ScriptNode node—A read-only property representing the node as it was versioned

getVersion(label)—Retrieves a specific version of a document identified by label, or null if the label does not exist

createVersion(description, major)—Creates a version snapshot of the current document

transformDocument(mimetype)—Transforms a document to a new document MIME type format; returns the transformed document node if successful, or null if the transformation failed

transformDocument(mimetype,destination)—Transforms a document to a new document MIME type format; returns the transformed document node if successful, or null if the transformation failed

transformImage(mimetype)—Transforms an image to a new image format; returns the transformed image node if successful or null if the transformation failed

transformImage(mimetype,options)—Transforms an image to a new image format, applying the supplied ImageMagick options; returns the transformed image node if successful or null if the transformation failed

transformImage(mimetype,destination)—Transforms an image to a new image format; returns the transformed image node if successful or null if the transformation failed

transformImage(mimetype,options,destination)—Transforms an image to a new image format, applying the supplied ImageMagick options; returns the transformed image node if successful or null if the transformation failed

processTemplate(template)—Executes a FreeMarker template file against the node; returns a string as the result of the template execution

processTemplate(template,args)—Executes a FreeMarker template file against the node, passing the supplied array of name/value pair arguments to the template; returns a string as the result of the template execution

luceneSearch(query)—Returns an array of ScriptNode objects found by the Alfresco repository full-text search. For example:

var nodes = search.luceneSearch("TEXT:alfresco");

luceneSearch(store, query)—Returns an array of ScriptNode objects found by the Alfresco repository full-text search in the given store. For example:

var nodes = search.luceneSearch("workspace://sitestore", "TEXT:site");

luceneSearch(query, sortColumn, asc)—Returns an array of ScriptNode objects satisfying the search criteria sorted by the specified sortColumn (the property name to sort on), and asc (true => ascending order, false => descending order). For example:

var nodes = search.luceneSearch("TEXT:alfresco", "@cm:modified", false);

luceneSearch(store, query, sortColumn, asc)—Returns an array of ScriptNode objects satisfying the search criteria and sorted in the given store

xpathSearch(xpath)—Returns an array of ScriptNode objects found by the Alfresco repository XPath search

xpathSearch(store, xpath)—Returns an array of ScriptNode objects found by the Alfresco repository XPath search in the given store

savedSearch(node)—Returns an array of ScriptNode objects found by executing the Saved Search referenced by the supplied node object

savedSearch(noderef)—Returns an array of ScriptNode objects found by executing the Saved Search referenced by the supplied noderef string

findNode(NodeRef noderef)—Returns a single ScriptNode object as specified by the NodeRef object for that node or null if the search failed

findNode(noderef)—Returns a single ScriptNode object as specified by the string form of the NodeRef for that node, or returns null if the search failed

findNode(referenceType, reference)—A helper to convert a Web script request URL to a NodeRef. The ReferenceType can be node, path, or qname. The reference elements supplied depend on the reference type:

ISO9075Encode(value)—A helper to encode a value into ISO9075-encoded format for encoding Lucene PATH statements

ISO9075Decode(value)—A helper to decode a value from ISO9075-encoded format

tagSearch(store, tag)—Returns an array of ScriptNode objects representing the nodes within the store that have the given tag applied; uses the default store (SpacesStore) if null value is supplied

query(search)—Returns an array of ScriptNode objects representing the search results

createPerson(username)—Creates a person (cm:person) with the given user name; returns the person node created, or null if the user name already exists

createPerson(firstName, lastName, emailAddress, createUserAccount, setAccountEnabled)—Creates a person (cm:person) with a generated user name; returns the person node created, or null if the user cannot be created

getPerson(username)—Returns a single (cm:person) node associated with the specified user name, or null if the person does not exist

getGroup(groupname) —Returns a single (usr:authorityContainer) node associated with the specified group name, or null if the group does not exist

search
{
  query: string,     mandatory, in appropriate format, encoded
for the  given language
  store: string,     optional, defaults to
'workspace://SpacesStore'
  language: string,  optional, one of: lucene, xpath,
jcr-xpath, fts-alfresco, sql-cmis-strict - defaults to 'lucene'
  sort: [],    optional, Array of sort column options
  page: object optional, paging information object if
supported by language
}
sort
{
  column: string,   mandatory, sort column in appropriate
format for language
  ascending: boolean  optional, defaults to false
}
  page
{
  maxItems: int,   optional, max number of items to return in
result set
  skipCount: int   optional, number of items to skip ove
 before returning results
}

var results = search.query({query: "TEXT:alfresco"});

var sort1 =
{
  column: "@{http://www.alfresco.org/model/content/1.0}" +
"modified",
  ascending: false
};

var sort2 =
{
  column: "@{ "http://www.alfresco.org/model/content/1.0}" +
"created",
  ascending: false
};
var paging =
{
  maxItems: 100,
  skipCount: 0
};
var def =
{
  query: "cm:name:test*",
  store: "workspace://SpacesStore",
  language: "fts-alfresco",
  sort: [sort1, sort2],
  page: paging
};
var results = search.query(def);

deleteGroup(group) —Removes a group from the system

createGroup(groupName)—Creates a new top-level group where groupName is the unique group name to create (do not prefix with GROUP_)

createGroup(parentGroup, groupName)—Creates a new group as a child of the specified parent group node (can be null for a top-level group)

addAuthority(parentGroup, authority) —Adds an authority (user or group) to the specified parent group

removeAuthority(parentGroup, authority) —Removes an authority from a group

getMembers(group)—Returns an array of person nodes belonging to the specified group (including all subgroups)

getMembers(group, recurse)—Returns an array of person nodes belonging to the specified group; only returns people of subgroups if recurse is specified as true

getContainerGroups(person)—Gets the groups that contain the specified authority

isAdmin(person)—Returns true if the specified user is an administrator authority

changePassword(oldpassword, newpassword)—Changes the password for the current user only (the old password must be supplied)

setPassword(userName, password)—Sets the password for the given user by an administrator authority

registered—Returns an array of string objects representing the names of all registered actions

create(name)—Returns the action for the given action name, or null if the action name is not registered

isLoggingEnabled()—Returns true if console logging is enabled.

To enable console logging, set the Log4J category of log4j.logger.org.alfresco.repo.jscript.ScriptLogger to DEBUG. This is in the log4j.properties file (Tomcat), or log4j.xml file (JBoss) on the Alfresco server.

log(string)—Logs a string message to the console.

ticket —Gets the current authentication ticket

getAllCategoryNodes(aspect)—Gets an array of all the category nodes in the given classification

getAllClassificationAspects()—Gets an array of all the QNames (in prefix:localName form) of all classification aspects

createRootCategory(aspect, name)—Creates a new root category in the given classification

getRootCategories(aspect)—Gets all the root category nodes as an array for a given classification

createWebProject(dnsName, name, title, description)—Creates a new Web project

getWebProject(WebProjectRef) —Gets a Web project

listWebProjects()—Lists all Web projects

listWebProjects(userName)—Lists all Web projects for which the specified user has membership

pad(string,length)—Pads a string with leading zeros to the specified length; returns the new string

getNodeFromString(noderef)—Returns a ScriptNode object representing the supplied NodeRef string

toBoolean(string)—Returns a Boolean object from a string value

shortQName(string)—Returns the short, or prefix, version of a long QName

postActivity(activityType, siteId, appTool, jsonActivityData)—Posts a custom activity type.

postActivity(activityType, siteId, appTool, nodeRef)—Posts a predefined activity type, looking up activity data asynchronously, including name, displayPath, typeQName, firstName, and lastName of posting user.

postActivity(activityType, siteId, appTool, nodeRef, beforeName)—Posts a predefined activity type, such as for a checked-out or renamed NodeRef; do not use this parameter for a deleted (or about-to-be-deleted) nodeRef.

postActivity(activityType, siteId, appTool, NodeRef, name, typeQName, parentNodeRef)—Posts a predefined activity, such as for the deleted NodeRef.

getAllRootGroups()—Gets the root groups that do not have a parent group; returns the root groups (empty if there are no root groups).

getAllRootGroupsInZone(zone)—Gets all the root groups in the specified zone.

getGroup(shortName)—Gets a group given its short name; returns the authority, or null if it cannot be found.

createRootGroup(shortName, displayName)—Creates a new root group; returns the authority, or null if it cannot be found. There is a partial match on shortName with the characters "*" and "?". If this is empty, everything is matched.

searchGroups(shortNameFilter)—Searches for groups; returns the groups matching the query.

searchGroupsInZone(shortNameFilter, zone)— Searches for groups in the specified zone; returns groups matching the query.

Create workflow packages

Start, cancel, or delete workflow instances

End and progress workflow paths to the next node with a specified transition