Class ecm.model.Repository
Extends
ecm.model._ModelObject, ecm.model._OpenedSearchesMixin, ecm.model._RecentSearchesMixin,
ecm.model._RecentObjectsMixin.
Represents a single repository on the server.
For an IBM FileNet P8 content server, this class represents a single object store. There can be multiple
repository objects for a single server object. For other content servers, a single repository object
exists for each server object.
Defined in: <ecm\model\Repository.js>.
Constructor Summary
Constructor Attributes | Constructor Name and Description |
---|---|
ecm.model.Repository(properties)
Constructs a repository object.
|
Field Summary
Field Attributes | Field Name and Description |
---|---|
For FileNet P8, indicates that new major versions should be created when add is performed.
|
|
All classes search type constants (IBM Content Manager only).
|
|
For IBM Content Manager only, contains one of the
ALL_CLASSES_SEARCH options for all classes
searches. |
|
For IBM Content Manager only, a boolean value indicating whether the "All" classes pseudo class choice for
searches is hidden.
|
|
A boolean value indicating whether this repository supports the "All" classes pseudo class choice for
searches.
|
|
A boolean indicating if this repository is enabled for the Approval Workflow Launch action.
|
|
An array of attributes for the repository.
|
|
For FileNet P8 and IBM Content Manager only, indicates that Box copy is supported on the repository.
|
|
For FileNet P8 and IBM Content Manager only, indicates that Box share is supported on the repository.
|
|
Comment capability type constants.
|
|
A boolean value indicating the repository queries support searching for all versions of an item (CMIS only).
|
|
A setting indicating the comment capabilities of this repository.
|
|
A setting indicating the query capabilities of this repository.
|
|
For FileNet P8, indicates that new major versions should be created when checkin is performed.
|
|
A boolean indicating that this repository is connected.
|
|
A string value indicating the process engine connection point to use (optional).
|
|
An array of ecm.model.ContentClass objects.
|
|
The default search type used when creating a search (i.e.
|
|
The default search version used when creating a search (i.e.
|
|
For IBM Content Manager only, indicates that new IBM Content Navigator name property should be set to the
file name when a file name is selected.
|
|
The property that represents the name of documents in the repository.
|
|
An array of system property names that are displayed when viewing or editing the properties of a document
(P8, CM8, and CMIS only).
|
|
The FileNet P8 domain ID (GUID).
|
|
An array of ecm.model.EntryTemplate objects.
|
|
For FileNet P8 and IBM Content Manager only, indicates that new IBM Content Navigator entry templates are
supported on the repository.
|
|
The property that represents the name of folders in the repository.
|
|
A boolean value indicating the repository supports searching for folders (CMIS only).
|
|
An array of system property names that are displayed when viewing or editing the properties of a folder (P8,
CM8, and CMIS only).
|
|
A boolean value indicating whether the current user is "admin".
|
|
Flag indicating if AFP transform to PDF is enabled (Content Manager OnDemand only).
|
|
A boolean indicating if this repository object is for administering IBM Content Navigator configurations.
|
|
If oAuthEnabled is true, this is the OAuth client id for the Box application associated with this repository
(Box only).
|
|
A boolean indicating if this repository object uses OAuth (Box only).
|
|
For FileNet P8, contains the display name of the object store associated with this repository.
|
|
For FileNet P8, contains the symbolic name of the object store associated with this repository.
|
|
An array of ecm.model.SearchTemplate objects that have been opened.
|
|
An array of strings for the privileges granted on the repository for the logged-in user.
|
|
A string value holding the data model type for records.
|
|
A string value holding the repository type for records.
|
|
A boolean indicating if this repository is enabled to support role-based redactions.
|
|
An array of ecm.model.RedactionPolicy objects representing redaction policies for this repository.
|
|
An array of ecm.model.Role objects representing redaction roles for this repository.
|
|
A ecm.model.admin.RepositoryReadConfig object holding the configuration information.
|
|
An array of ecm.model.Role objects for this repository.
|
|
The identifier of the folder that represents the root folder of this repository (IBM Content Manager only).
|
|
The default columns used in the list view when creating a search.
|
|
A list of document properties that are hidden when searching.
|
|
A list of folder properties that are hidden when searching.
|
|
A mapping from a data type to a list of operators that are hidden when searching on a particular data type.
|
|
A list of search types (i.e.
|
|
The default columns used in the magazine view when creating a search.
|
|
A boolean indicating if a new search has to match all properties.
|
|
For FileNet P8, contains the p8 server connection URL associated with this repository.
|
|
Server print default properties.
|
|
An array of printer objects.
|
|
For Box only, indicates that Box administrator.
|
|
This repository will be displayed in the Browse Pane RepositorySelector
|
|
This repository will be displayed in the Manage EntryTemplate RepositorySelector
|
|
This repository will be displayed in the Search Pane RepositorySelector
|
|
This repository will be displayed in the Manage Teamspace RepositorySelector
|
|
This repository will be displayed in the Workflow Pane RepositorySelector
|
|
A boolean indicating the repository supports adding items.
|
|
A boolean indicating the repository supports Box share.
|
|
A boolean value indicating the repository queries support searching with multiple classes.
|
|
A boolean indicating the repository supports recommendation.
|
|
A boolean indicating the repository supports tag.
|
|
A boolean indicating if this repository is enabled for sync.
|
|
For FileNet P8 and IBM Content Manager only, indicates that task manager service password for this
repository.
|
|
For FileNet P8 and IBM Content Manager only, indicates that task manager service user id for this repository.
|
|
An array of ecm.model.Teamspace objects of type "instance".
|
|
A boolean indicating that teamspaces are supported on the repository.
|
|
An array of ecm.model.Teamspace objects of type "template".
|
|
An array of ecm.model.SearchTemplateFolder objects.
|
|
An array of ecm.model.SearchTemplate objects.
|
|
A string value holding the search template filter.
|
|
A boolean indicating that the repository is enabled for text search.
|
|
A string indicating the type of the repository.
|
|
A boolean indicating if this repository is enabled for cross-repository searches.
|
|
The full, display user name for the user logged into the repository.
|
|
The user Id for the user logged into the repository.
|
|
The login name used to login to the repository.
|
|
A boolean indicating that single-sign on is supported for this repository.
|
|
An array of ecm.model.ProcessApplicationSpace objects or if there is only one application space, an
array of ecm.model.ProcessRole objects (FileNet P8 only)
|
|
An array of ecm.model.WorklistFolder objects
|
|
An array of ecm.modelWorklist objects for this repository.
|
Method Summary
Method Attributes | Method Name and Description |
---|---|
addDataObject(parentFolder, objectStore, templateName, criterias, childComponentValues, permissions, securityPolicyId, teamspaceId, callback)
Adds a data object to the repository.
|
|
addDocumentItem(parentFolder, objectStore, templateName, criterias, contentSourceType, mimeType, filename, content, childComponentValues, permissions, securityPolicyId, addAsMinorVersion, autoClassify, allowDuplicateFileNames, setSecurityParent, teamspaceId, callback, isBackgroundRequest, onError, compoundDocument, uploadProgress, parameters, application, parameters)
Adds a document to the repository.
|
|
addDocumentItemUsingForm(parentFolder, objectStore, templateName, contentSourceType, filename, form, securityPolicyId, addAsMinorVersion, autoClassify, allowDuplicateFileNames, setSecurityParent, teamspaceId, callback, isBackgroundRequest, onError, compoundDocument)
Adds a document to the repository.
|
|
addEntryTemplate(entryTemplate, callback)
Adds an entry template design to the repository.
|
|
addFolderItem(parentFolder, objectStore, templateName, criterias, childComponentValues, permissions, securityPolicyId, teamspaceId, callback)
Adds a folder to the repository.
|
|
addSearchTemplate(searchTemplate, callback, teamspace)
Adds a search template to the content server.
|
|
addSystemRole(name, description, privilege, callback)
Adds a system role (template) to this repository.
|
|
addTeamspace(teamspace, callback, onError, parentFolderName)
Adds a new teamspace to the repository.
|
|
addTeamspaceTemplate(teamspace, callback, onError)
Adds a new teamspace template to the repository.
|
|
applyHold(items, holdNames, callback)
Applies one or more holds from the specified items.
|
|
Returns true if the server allows password changing.
|
|
Returns true if the server allows password changing.
|
|
Returns true if the repository allows browsing of folders.
|
|
changePassword(password, newPassword, callback)
Performs a password change on the server.
|
|
clearContentClassesCache(filterType)
Clears the repository content classes cache for the provided filter type.
|
|
clearEntryTemplateCache(filter, allFolders, folderId, objectStore)
Clear the entry template cache held by this repository
|
|
Clears the search template cache.
|
|
createHold(name, description, folderName, callback)
Creates a new hold record.
|
|
createRedactionPolicy(newPolicy, callback)
Adds a redaction policy to the repository
|
|
createRedactionRole(newRole, callback)
Adds a redaction role to the repository
|
|
decommissionTeamspace(teamspace, deleteOption, destinationFolderId, callback)
Decommission a teamspace.
|
|
deleteItems(items, callback, allVersions)
Deletes the specified items from the repository.
|
|
deleteRedactionPolicy(id, callback)
Deletes a redaction policy from this repository.
|
|
deleteRedactionRole(id, callback)
Deletes a redaction role from this repository.
|
|
deleteSystemRole(id, callback)
Deletes a system role (template) from this repository.
|
|
deleteTeamspace(teamspaceId, type, callback)
Deletes the specified teamspace from the content server.
|
|
editTeamspace(teamspace, callback, updateUsers, updateRoles)
Saves a modified teamspace template.
|
|
editTeamspaceTemplate(teamspace, callback, updateUsers, updateRoles)
Saves a modified teamspace template.
|
|
findGroups(callback, directoryName, searchString, searchType, sortType, maxResult, searchAttribute, queryAcrossDomains)
Query for the specified groups
|
|
findUsers(callback, directoryName, searchString, searchType, sortType, maxResult, searchAttribute, queryAcrossDomains, excludeAdminAccounts)
Query for the specified users.
|
|
getAttribute(attributeName)
Returns the value of the attribute.
|
|
getContentClass(classId, objectStore)
Returns an instance of ecm.model.ContentClass for the given class identifier.
|
|
Gets the default ecm.model.SearchTemplate object for the repository (if one exists).
|
|
getDirectories(callback)
Retrieves an array of ecm.model.Directory objects from the repository.
|
|
getDomainObjectStoreNames(callback)
Gets all the object store names in the same domain as current repository.
|
|
getEntryTemplateById(entryTemplateId, entryTemplateName, objectStore, type)
Returns an instance of ecm.model.EntryTemplate for the given entry template identifier.
|
|
getPrivilege(privilege)
Get the specified privilege from the privileges.
|
|
Return the record datamodel type for this repository.
|
|
Return the record type of this repository.
|
|
getRepositoryConfig(callback)
Retrieves the repository configuration information.
|
|
getUserEmail(userId, callback)
Returns the email address if is available from either P8 (when P8 users are configured with email addresses).
|
|
hasAttribute(attributeName)
Returns true if the given attribute exists.
|
|
For an IBM Content Manager repository, returns true if the All classes search option should be hidden.
|
|
Returns boolean indicating if this repository uses case sensitive filtering.
|
|
Returns a boolean value if IBM Content Navigator entry templates are supported in this repository.
|
|
Returns true if this repository has a linked account assigned for the current user.
|
|
Returns whether this repository is a Content repository for Enterprise Records.
|
|
Returns whether this repository is a FilePlan repository for Enterprise Records.
|
|
Returns a boolean value if IBM Content Navigator role-based redaction is supported in this repository.
|
|
Returns a boolean value if search templates are supported in this repository.
|
|
lockItems(items, callback, returnVersion, errorCallback)
Locks the specified items on the repository.
|
|
logoff()
Disconnects from the server.
|
|
logon(password, callback, desktopId, synchronous, errorCallback, backgroundRequest)
Connects to the server and authenticates with the provided password.
|
|
onAddTeamspace(teamspace)
An event function called after the teamspace has been added.
|
|
onAddTeamspaceTemplate(teamspace)
An event function called after a teamspace template has been added.
|
|
onChange(modelObject)
Event function, called when the repository has changed or cached information has been cleared due to a call
to refresh.
|
|
onConnected(repository, repositoryJSON)
An event function that is invoked when either login completes successfully or the repository is otherwise
considered connected (such as after a refresh of the browser and the repository is already connected in the
session.
|
|
onDisconnected(repository)
An event function that is invoked when logout completes successfully.
|
|
onEntryTemplateAdded(entryTemplate)
A event function called after an entry template has been added to the repository.
|
|
onEntryTemplateDeleted(entryTemplate)
A event function called after an entry template has been deleted.
|
|
onEntryTemplateUpdated(entryTemplate)
A event function called after an entry template has been updated.
|
|
onHoldApplied(repository)
An event function called after the hold has been applied.
|
|
onHoldCreated(repository)
An event function called after the hold has been created.
|
|
onHoldRemoved(repository)
An event function called after the hold has been removed.
|
|
onSearchTemplateAdded(searchTemplate)
A event function called after a search template has been added to the repository.
|
|
onSearchTemplateDeleted(searchTemplateId, searchVsId)
An event function that is called after a search template has been deleted.
|
|
onSearchTemplateFoldersRetrieved(repository)
An event function called after the search template folders have been retrieved.
|
|
An event function called after a teamspace has been deleted.
|
|
An event function called after a teamspace template has been deleted.
|
|
onUpdateTeamspace(teamspace)
An event function called after the teamspace has been updated.
|
|
onUpdateTeamspaceTemplate(teamspace, repo)
An event function called after a teamspace template has been updated.
|
|
onWorklistContainersRetrieved(worklistContainers)
An event function called after the worklist continer objects have been retrieved.
|
|
refresh()
Clears all cached information related to this repository and invokes the
onChange(this) event. |
|
removeHold(items, holdNames, callback)
Removes one or more holds from the specified items.
|
|
retrieveAdminRoot(itemIdOrPath, itemRetrievedCallback, templateID, version, vsId, objectStoreId, params)
Retrieves the admon root (@link ecm.model.ContentItem} from the repository.
|
|
retrieveCheckedOutItems(callback, sortProperty, sortDescending)
Retrieves all items that are checked out by the current user.
|
|
retrieveContentClasses(callback, filterType)
Retrieves an array of ecm.model.ContentClass objects.
|
|
retrieveContentClassList(callback, itemList)
Retrieves a specified list of ecm.model.ContentClass objects (instead of all classes), this is a case
for teamspace builder.
|
|
retrieveEntryTemplates(callback, filter, folderId, rootFolderId, objectStore, onError)
Retrieves an array of ecm.model.EntryTemplate objects from a repository based on a filter.
|
|
retrieveEntryTemplatesByIds(entryTemplateIds, callback)
Retrieves an array of ecm.model.EntryTemplate given their ids.
|
|
retrieveEntryTemplatesResultSet(callback, filter, pageResults, orderBy, descending, criteria)
Retrieves a ecm.model.ResultSet object holding the list of all entry templates.
|
|
retrieveFileNames(items, callback, userPartFileName)
Retrieves filenames of the items
|
|
retrieveHolds(items, isAply, callback)
Retrieves the holds that can be applied to, or removed from, a specified list of items.
|
|
retrieveItem(itemIdOrPath, itemRetrievedCallback, templateID, version, vsId, objectStoreId, action, params)
Retrieves the specified ecm.model.ContentItem from the repository.
|
|
retrieveMultiItem(itemIdArray, itemRetrievedCallback, templateID, version, vsId, retrieveSecurityParent, retrieveSocialData)
Retrieves multiple items by sending more than one docid.
|
|
retrieveODAddDocPermission(templateName, callback)
Retrieve AppGroupNames & AppNames using the supplied templateName parameters.
|
|
retrieveODAppGroups(callback, templateName)
Retrieve AppGroupNames & AppNames using the supplied templateName parameters.
|
|
retrievePrivileges(callback)
Retrieves all the privileges for the repository
|
|
retrieveRedactionPolicies(callback, refresh)
Retrieves an array of ecm.model.RedactionPolicy objects representing redaction policies available for this repository.
|
|
retrieveRedactionRoles(callback, refresh)
Retrieves an array of ecm.model.Role objects representing redaction roles available for this repository.
|
|
retrieveRoles(callback)
Retrieves an array of ecm.model.Role objects available for this repository.
|
|
retrieveSearchTemplate(docId, vsId, version, callback, backgroundRequest, backgroundRequest)
Retrieves an ecm.model.SearchTemplate object from the repository.
|
|
retrieveSearchTemplateFolders(callback)
Retrieves the search template folders (only Content Manager OnDemand supports this type of search).
|
|
retrieveSearchTemplates(callback, filter)
Retrieves an array of ecm.model.SearchTemplate objects for the repository.
|
|
retrieveSecurityPolicies(callback)
Retrieves a ecm.model.ResultSet object holding the list of all security policies.
|
|
retrieveServerPrinters(callback, force)
Retrieves server printers and faxes.
|
|
retrieveTeamspaceById(Id, type, callback, params)
Retrieves an ecm.model.Teamspace object from the repository.
|
|
retrieveTeamspaceFolders(callback)
Retrieve an array of ecm.model.Teamspace objects
|
|
retrieveTeamspaceFoldersResultSet(callback, pageResults, orderBy, descending, offline, offline)
Retrieves teamspaces and return a ecm.model.ResultSet object holding the list of teamspaces.
|
|
retrieveTeamspaceTemplateFolder(callback)
Retrieve an array of ecm.model.Teamspace template objects
|
|
retrieveTeamspaceTemplateFolderResultSet(callback, orderBy, descending, criteria)
Retrieves teamspace templates and return a ecm.model.ResultSet object holding the list of teamspace
templates.
|
|
retrieveVersions(items, version, callback, synchronous)
Returns an ecm.model.ResultSet object containing the requested versions for each item.
|
|
retrieveWorklistContainers(callback, rootContainersOnly)
Retrieves an array of ecm.model.ProcessApplicationSpace objects or if there is only one application
space, return an array of ecm.model.ProcessRole objects (FileNet P8 only)
|
|
retrieveWorklistFolders(callback)
Retrieves an array of ecm.model.WorklistFolder objects.
|
|
retrieveWorklists(callback)
Retrieves an array of ecm.model.Worklist objects (Content Manager only).
|
|
searchTemplatesDeleted(searchTemplates)
Deletes search templates.
|
|
serverPrint(params, items, callback)
Runs a server print using the supplied printer parameters.
|
|
setRecordDatamodelType(datamodel)
Sets the record's datamodel type for this repository for Enterpise Records.
|
|
setRecordType(recordType)
Sets the record type for this repository for Enterprise Records.
|
|
Returns boolean indicating if this repository supports repository filtering.
|
|
unlockItems(items, callback, errorCallback)
Unlocks the specified items in the repository.
|
|
updateEntryTemplate(entryTemplate, checkoutEntryTemplate, callback)
Updates an existing entry template design in the repository.
|
|
updateRedactionPolicy(newRole, callback)
Updates a redaction policy in the repository
|
|
updateRedactionRole(newRole, callback)
Updates a redaction role in the repository
|
|
usesEJB()
For a FileNet P8 repository, returns true if the serverName URL uses EJB.
|
|
validateTeamspace(Id, type, callback)
Validates a ecm.model.Teamspace template data.
|
Constructor Detail
ecm.model.Repository(properties)
- Parameters:
- properties
- The properties of the repository. The properties can be any of the public fields as defined below and in ecm.model._ModelObject.
Field Detail
addAsMajorVersion
ALL_CLASSES_SEARCH
- Since:
- 2.0.3.5
allClassesSearch
ALL_CLASSES_SEARCH
options for all classes
searches. If allPseudoClassHidden
is true, the value will always be
ALL_CLASSES_SEARCH.HIDDEN
.
- Since:
- 2.0.3.5
allPseudoClassHidden
- Deprecated:
- As of 2.0.3.5. Use allClassesSearch instead.
- Since:
- 2.0.3.2
allPseudoClassSupported
approvalWorkflowEnabled
- Since:
- 2.0.3.7
attributes
boxCopyEnabled
- Since:
- 2.0.3.6
boxShareEnabled
- Since:
- 2.0.3.6
CAPABILITY_COMMENT
capabilityAllVersionsSearchable
capabilityComment
capabilityQuery
checkinAsMajorVersion
connected
connectionPoint
contentClassCache
defaultSearchType
- Since:
- 2.0.3
defaultSearchVersion
- Since:
- 2.0.3
docNamePropSetWithFileName
- Since:
- 2.0.3.6
documentNameProperty
- Since:
- 2.0.3
documentSystemProperties
- Since:
- 2.0.3
domainId
- Since:
- 2.0.3
entryTemplateCache
entryTemplatesEnabled
- Since:
- 2.0.3
folderNameProperty
- Since:
- 2.0.3
folderSearchSupported
- Since:
- 2.0.3.5
folderSystemProperties
- Since:
- 2.0.3
isAdminUser
isAFP2PDFEnabled
- Since:
- 2.0.2
isForAdministration
- Since:
- 2.0.3
oAuthClientId
- Since:
- 2.0.3.5
oAuthEnabled
- Since:
- 2.0.3.5
objectStoreDisplayName
objectStoreName
openedSearches
privileges
recordDatamodelType
recordRepositoryType
redactionEnabled
- Since:
- 2.0.3.8
redactionPolicies
redactionRoles
repositoryConfig
roles
rootFolderId
- Since:
- 2.0.3
rootItem
- Deprecated:
- Use retrieveItem with a path of "/" to retrieve the root item. This value is null until a retrieveItem with a path of "/" is performed.
searchDefaultColumns
- Since:
- 2.0.3
searchFilteredDocumentProperties
- Since:
- 2.0.3
searchFilteredFolderProperties
- Since:
- 2.0.3
searchFilteredOperators
- Since:
- 2.0.3
searchFilteredSearchTypes
- Since:
- 2.0.3.6
searchMagazineDefaultColumns
- Since:
- 2.0.3
searchMatchAll
- Since:
- 2.0.3
serverName
serverPrinterDefaults
serverPrinters
shareAdminUserId
- Since:
- 2.0.3.6
showInBrowseView
showInEntryTemplateView
showInSearchView
showInTeamspaceView
showInWorkView
supportsAddDocument
supportsBoxShare
supportsMultiClassSearch
- Since:
- 2.0.3.8
supportsRecommendation
supportsTag
syncEnabled
- Since:
- 2.0.3
taskManagerProxyPwd
- Since:
- 2.0.3.6
taskManagerProxyUserId
- Since:
- 2.0.3.6
teamspaces
teamspacesEnabled
teamspaceTemplates
templateFolders
templates
templatesFilter
textSearchType
type
unifiedSearchesEnabled
- Since:
- 2.0.3
userDisplayName
userId
userLoginName
- Since:
- 2.0.3.8
useSSO
worklistContainers
worklistFolders
worklists
Method Detail
addDataObject(parentFolder, objectStore, templateName, criterias, childComponentValues, permissions, securityPolicyId, teamspaceId, callback)
- Parameters:
- parentFolder
- A ecm.model.ContentItem object for the parent folder.
- objectStore
- A object store object holding identifier information (FileNet P8 only).
- templateName
- A string value holding the content class name.
- criterias
- An object holding the criteria information.
- childComponentValues
- An object holding the child component values (Content Manager only).
- permissions
- An object holding the permission information.
- securityPolicyId
- A string value holding the security policy id (FileNet P8 only).
- teamspaceId
- A string value holding the teamspace id.
- callback
- A callback function called after the item has been added. Will pass a ecm.model.ContentItem object as a parameter.
addDocumentItem(parentFolder, objectStore, templateName, criterias, contentSourceType, mimeType, filename, content, childComponentValues, permissions, securityPolicyId, addAsMinorVersion, autoClassify, allowDuplicateFileNames, setSecurityParent, teamspaceId, callback, isBackgroundRequest, onError, compoundDocument, uploadProgress, parameters, application, parameters)
- Parameters:
- parentFolder
- A ecm.model.ContentItem object for the parent folder.
- objectStore
- A object store object holding identifier information (FileNet P8 only).
- templateName
- A string value holding the content class name.
- criterias
- An object holding the criteria information.
- contentSourceType
- A string value holding the content source type.
- mimeType
- A string value holding the MIME type.
- filename
- A string value holding the file name.
- content
- A object holding the file stream.
- childComponentValues
- An object holding the child component values (Content Manager only).
- permissions
- An object holding the permission information.
- securityPolicyId
- A string value holding the security policy id (FileNet P8 only).
- addAsMinorVersion
- A boolean value indicating whether to add as a minor version.
- autoClassify
- A boolean value indicating whether to automatically classify this object on add (FileNet P8 only).
- allowDuplicateFileNames
- A boolean value indicating whether the content server will allow duplicate file names.
- setSecurityParent
- A boolean value indicating whether the security parent should be set.
- teamspaceId
- A string value holding the teamspace id.
- callback
- A callback function called after the item has been added. Will pass a ecm.model.ContentItem object as a parameter.
- isBackgroundRequest
- A boolean flag indicating that this add request should be placed in a background process.
- onError
- A callback function that is called if an error is returned when adding this document.
- compoundDocument
- A boolean value indicating whether this is a compound document (FileNet P8 only).
- uploadProgress
- A boolean value indicating whether the event listener is added for upload progress event.
- parameters
- application
- parameters
- Since:
- 2.0.3.6 An object holding additional parameters to be passed in the request.
addDocumentItemUsingForm(parentFolder, objectStore, templateName, contentSourceType, filename, form, securityPolicyId, addAsMinorVersion, autoClassify, allowDuplicateFileNames, setSecurityParent, teamspaceId, callback, isBackgroundRequest, onError, compoundDocument)
- file: The file to upload
- criterias: Document repository properties
- childComponentValues: Child component values
- acl: Document permissions
- Parameters:
- parentFolder
- A ecm.model.ContentItem object for the parent folder.
- objectStore
- A object store object holding identifier information (FileNet P8 only).
- templateName
- A string value holding the content class name.
- contentSourceType
- A string value holding the content source type.
- filename
- A string value holding the file name.
- form
- A form object holding the file stream.
- securityPolicyId
- A string value holding the security policy id (FileNet P8 only).
- addAsMinorVersion
- A boolean value indicating whether to add as a minor version.
- autoClassify
- A boolean value indicating whether to automatically classify this object on add (FileNet P8 only).
- allowDuplicateFileNames
- A boolean value indicating whether the content server will allow duplicate file names.
- setSecurityParent
- A boolean value indicating whether the security parent should be set.
- teamspaceId
- A string value holding the teamspace id.
- callback
- A callback function called after the item has been added. Will pass a ecm.model.ContentItem object as a parameter.
- isBackgroundRequest
- A boolean flag indicating that this add request should be placed in a background process.
- onError
- A callback function called if there is an error returned when adding this document.
- compoundDocument
- A boolean value indicating whether this is a compound document (FileNet P8 only).
addEntryTemplate(entryTemplate, callback)
- Parameters:
- entryTemplate
- A design instance of ecm.model.EntryTemplate.
- callback
- A function that is invoked when the add has completed successfully. The entry template design with updated ID information is passed as the only argument. Design instances of entry templates should not be used to add items.
- Since:
- 2.0.3
addFolderItem(parentFolder, objectStore, templateName, criterias, childComponentValues, permissions, securityPolicyId, teamspaceId, callback)
- Parameters:
- parentFolder
- A ecm.model.ContentItem object for the parent folder.
- objectStore
- A object store object holding identifier information (FileNet P8 only).
- templateName
- A string value holding the content class name.
- criterias
- An object holding the criteria information.
- childComponentValues
- An object holding the child component values (Content Manager only).
- permissions
- An object holding the permission information.
- securityPolicyId
- A string value holding the security policy id (FileNet P8 only).
- teamspaceId
- A string value holding the teamspace id.
- callback
- A callback function called after the item has been added. Will pass a ecm.model.ContentItem object as a parameter.
addSearchTemplate(searchTemplate, callback, teamspace)
- Parameters:
- searchTemplate
- An instance of ecm.model.SearchTemplate.
- callback
- A function that is invoked when the add has completed successfully. The search template is passed as the only argument.
- teamspace
addSystemRole(name, description, privilege, callback)
- Parameters:
- name
- A string value holding the name of the role to add.
- description
- A string value holding a description of the role.
- privilege
- A set of privileges for the role.
- callback
- A function invoked after the role has been added. Passes a ecm.modle.Role object as a parameter.
addTeamspace(teamspace, callback, onError, parentFolderName)
- Parameters:
- teamspace
- A ecm.model.Teamspace object.
- callback
- A callback function called after the teamspace has been added. Passes a ecm.model.Teamspace object as a parameter.
- onError
- A callback function called when an error occurs.
- parentFolderName
- An optional parameter indicating the name of the parent folder for the new teamspace (P8 only). When not specified, new P8 teamspaces are partioned into YYYY-MM folders.
addTeamspaceTemplate(teamspace, callback, onError)
- Parameters:
- teamspace
- A ecm.model.Teamspace object.
- callback
- A callback function called after the teamspace template has been added.
- onError
- A callback function called when an error occurs.
applyHold(items, holdNames, callback)
- Parameters:
- items
- An array of ecm.model.Item objects representing the documents to be applied to the holds.
- holdNames
- An array of hold names.
- callback
- A function invoked after the holds have been applied to the items.
canChangeExpiredPassword()
canChangePassword()
canListFolders()
changePassword(password, newPassword, callback)
- Parameters:
- password
- A string value holding current password.
- newPassword
- A string holding the new password to set.
- callback
- A callback function called when the new password has been set.
clearContentClassesCache(filterType)
- Parameters:
- filterType
- A string value holding the filter type for the cached content classes. If no filter type is provided, the entire content class cache is cleared.
- Since:
- 2.0.3
clearEntryTemplateCache(filter, allFolders, folderId, objectStore)
- Parameters:
- filter
- A string value holding the filter criteria (setting to null, will clear all entry templates).
- allFolders
- A boolean value indicating that all folder entry templates in the cache should be cleared.
- folderId
- A string value holding a folder identifier to clear from the cache.
- objectStore
- An object store object holding its identifier information, will clear items with same object store.
clearSearchTemplates()
createHold(name, description, folderName, callback)
- Parameters:
- name
- The name of the hold.
- description
- A description of the hold.
- folderName
- A string value holding the folder name
- callback
- A funtion invoked after the hold is created.
createRedactionPolicy(newPolicy, callback)
- Parameters:
- newPolicy
- A ecm.model.Policy object holding data for the policy to be created.
- callback
- A function invoked after the policy has been added.
- Since:
- 2.0.3.8.
createRedactionRole(newRole, callback)
- Parameters:
- newRole
- A ecm.model.Role object holding data for the role to be created.
- callback
- A function invoked after the role has been added.
- Since:
- 2.0.3.8.
decommissionTeamspace(teamspace, deleteOption, destinationFolderId, callback)
- Parameters:
- teamspace
- A ecm.model.Teamspace object.
- deleteOption
- A string value of deleteAll or refileAll.
- destinationFolderId
- Id of the destination folder.
- callback
- A callback function called after the teamspace has been added. Passes a ecm.model.Teamspace object as a parameter.
deleteItems(items, callback, allVersions)
- Parameters:
- items
- An array of ecm.model.Item objects for the items to delete.
- callback
- A function invoked after the items are successfully deleted.
- allVersions
- If true, deletes all versions of the items.
deleteRedactionPolicy(id, callback)
- Parameters:
- id
- A string value holding the policy identifier.
- callback
- A function invoked after the policy has been deleted.
deleteRedactionRole(id, callback)
- Parameters:
- id
- A string value holding the role identifier.
- callback
- A function invoked after the role has been deleted.
deleteSystemRole(id, callback)
- Parameters:
- id
- A string value holding the role identifier.
- callback
- A function invoked after the role has been deleted.
deleteTeamspace(teamspaceId, type, callback)
- Parameters:
- teamspaceId
- A string value holding the teamspace identifier
- type
- A string value holding the teamspace type
- callback
- A function that is invoked when the delete has completed successfully.
editTeamspace(teamspace, callback, updateUsers, updateRoles)
- Parameters:
- teamspace
- A ecm.model.Teamspace object.
- callback
- A callback function called after the teamspace template has been saved.
- updateUsers
- A boolean value indicating whether the list of users should also be updated.
- updateRoles
- A boolean value indicating whether the list of roles should also be updated.
- Since:
- 2.0.3
editTeamspaceTemplate(teamspace, callback, updateUsers, updateRoles)
- Parameters:
- teamspace
- A ecm.model.Teamspace object.
- callback
- A callback function called after the teamspace template has been saved.
- updateUsers
- A boolean value indicating whether the list of users should also be updated.
- updateRoles
- A boolean value indicating whether the list of roles should also be updated.
- Deprecated:
- use editTeamspace instead.
findGroups(callback, directoryName, searchString, searchType, sortType, maxResult, searchAttribute, queryAcrossDomains)
- Parameters:
- callback
- A callback function called when the query for groups finishes. Passes an array of ecm.model.UserGroup objects as a parameter.
- directoryName
- A string value holding the P8 directory name to use.
- searchString
- A string value holding the actual search string. For CM, use the % wild card to query for Starts with, Ends with and Contains. P8 uses the searchType parameter.
- searchType
- A string value holding the P8 search type (Starts with = 2 Ends with = 3 and Contains = 4).
- sortType
- A string value holding the P8 sort type (Ascending = 1 and Descending = 2).
- maxResult
- A string value holding the maximum results expected.
- searchAttribute
- A string holding the P8 search by attribute (Short Name = 1 and Display Name).
- queryAcrossDomains
- A boolean value indicating if the query should cross domains. It is for IBM Content Manager only.
findUsers(callback, directoryName, searchString, searchType, sortType, maxResult, searchAttribute, queryAcrossDomains, excludeAdminAccounts)
- Parameters:
- callback
- A callback function called when the query for users finishes. Passes an array of ecm.model.User objects as a parameter.
- directoryName
- A string value holding the FileNet P8 directory name to use.
- searchString
- A string value holding the actual search string. For Content Manager, use the % wild card to query
for Starts with, Ends with, and Contains. FileNet P8 uses the
searchType
parameter. - searchType
- A string value holding the FileNet P8 search type (Starts with = 2 Ends with = 3 and Contains = 4).
- sortType
- A string value holding the FileNet P8 sort type (Ascending = 1 and Descending = 2).
- maxResult
- A string value holding the maximum results expected.
- searchAttribute
- A string holding the FileNet P8 search by attribute (Short Name = 1 and Display Name).
- queryAcrossDomains
- A boolean value indicating if the query should cross domains. It is for Content Manager only. *
- excludeAdminAccounts
- A boolean value indicating if the query should exclude admin account with Item Super Access privilege. It is for Content Manager only.
getAttribute(attributeName)
- Parameters:
- attributeName
getContentClass(classId, objectStore)
- Parameters:
- classId
- The identifier of the content class.
- objectStore
- P8 only. The object store for the class if it is not from the active repository.
getDefaultTemplate()
getDirectories(callback)
- Parameters:
- callback
- A callback function that is called when the directories have been retrieved. Passes an array of ecm.model.Directory objects as a parameter.
getDomainObjectStoreNames(callback)
- Parameters:
- callback
- A callback function called after the object store names have been retrieved. Passes an array of object store names as a parameter.
getEntryTemplateById(entryTemplateId, entryTemplateName, objectStore, type)
Important: Do not modify the contents of the returned entryTemplate instance. A private
copy can be created by calling the clone
method on the returned instance.
- Parameters:
-
entryTemplateId
- A string value holding the identifier of the entry template.
For Filenet P8, this is the entry template ecm.model.ContentItem ID.
For IBM Content Manager, this is the entry template Content Manager ITEMID.
-
entryTemplateName
- A string value holding the entry template name.
-
objectStore
- An object store object holding its identifier information.
-
type
- A string value holding the type attribute of the entry template.
getPrivilege(privilege)
Get the specified privilege from the privileges.
- Parameters:
-
privilege
- A string value holding the privilege name to look up.
{String}
getRecordDatamodelType()
Return the record datamodel type for this repository.
- Returns:
- {String} It will return
"Base"
, "DoD"
, "Pro"
, or
"DoDClassified"
.
{String}
getRecordType()
Return the record type of this repository.
- Returns:
- {String} It will return
"Content"
, "FilePlan"
, or
"Plain"
getRepositoryConfig(callback)
Retrieves the repository configuration information. If no callback is provided, the repository configuration
associated with this repository is returned. If the repository configuration is not retrieved, it is
synchronously retrieved and returned.
If a callback is provided, the repository configuration associated with this repository is passed to the
callback method. If the repository configuration is not retrieved, it is asynchronously retrieved and passed
to the callback when the retrieve has completed.
- Parameters:
-
callback
- A callback function called after the configuration information has been retrieved.
getUserEmail(userId, callback)
Returns the email address if is available from either P8 (when P8 users are configured with email addresses).
- Parameters:
-
userId
- The user to look up the email address for.
-
callback
- Function to call when the server request completes.
hasAttribute(attributeName)
Returns true if the given attribute exists. Returns false otherwise.
- Parameters:
-
attributeName
hideSearchAllClasses()
For an IBM Content Manager repository, returns true if the All classes search option should be hidden.
- Since:
- 2.0.3.5
isCaseSensitiveFiltering()
Returns boolean indicating if this repository uses case sensitive filtering.
- Since:
- 2.0.3
isEntryTemplateSupported()
Returns a boolean value if IBM Content Navigator entry templates are supported in this repository.
- Since:
- 2.0.3
isOAuthLinked()
Returns true if this repository has a linked account assigned for the current user.
{Boolean}
isRecordContentRepository()
Returns whether this repository is a Content repository for Enterprise Records.
- Returns:
- {Boolean} It will return true if the record repository type is
"Content"
.
{Boolean}
isRecordFilePlanRepository()
Returns whether this repository is a FilePlan repository for Enterprise Records.
- Returns:
- {Boolean} It will return true if the record repository type is
"FilePlan"
.
isRedactionSupported()
Returns a boolean value if IBM Content Navigator role-based redaction is supported in this repository.
- Since:
- 2.0.3.8
isSearchTemplateSupported()
Returns a boolean value if search templates are supported in this repository.
lockItems(items, callback, returnVersion, errorCallback)
Locks the specified items on the repository.
- Parameters:
-
items
- An array of ecm.model.Item objects representing the items to lock.
-
callback
- A function invoked when the items have successfully been locked.
-
returnVersion
- The version of the item to be returned in the response.
-
errorCallback
- An option method to call when errors occur during logon.
logoff()
Disconnects from the server.
logon(password, callback, desktopId, synchronous, errorCallback, backgroundRequest)
Connects to the server and authenticates with the provided password.
- Parameters:
-
password
- The password to use for login.
-
callback
- A function that is invoked on successful login.
-
desktopId
- An optional parameter to be used to log into a different desktop. If it is not provided, the
current desktop's id is used.
-
synchronous
- An optional flag indicating the logon request should be synchronous.
-
errorCallback
- An option method to call when errors occur during logon.
-
backgroundRequest
- An optional flag indicating if the logon request should be run without showing a status dialog.
onAddTeamspace(teamspace)
An event function called after the teamspace has been added.
- Parameters:
-
teamspace
- A ecm.model.Teamspace object as a parameter.
onAddTeamspaceTemplate(teamspace)
An event function called after a teamspace template has been added.
- Parameters:
-
teamspace
- A ecm.model.Teamspace object.
onChange(modelObject)
Event function, called when the repository has changed or cached information has been cleared due to a call
to refresh.
- Parameters:
-
modelObject
- The instance of the particular ecm.model object that changed. This could be this repository object
or a nested object.
onConnected(repository, repositoryJSON)
An event function that is invoked when either login completes successfully or the repository is otherwise
considered connected (such as after a refresh of the browser and the repository is already connected in the
session.
- Parameters:
-
repository
- ecm.model.Repository object is passed as a parameter.
-
repositoryJSON
- an object obtained from the JSON returned from the server for this repository. This object is
intended to be used by plug-ins to access additional fields added to the repository JSON from a
plug-in repository type.
onDisconnected(repository)
An event function that is invoked when logout completes successfully.
- Parameters:
-
repository
- ecm.model.Repository object is passed as a parameter.
onEntryTemplateAdded(entryTemplate)
A event function called after an entry template has been added to the repository.
- Parameters:
-
entryTemplate
- A ecm.model.EntryTemplate is passed as a parameter.
onEntryTemplateDeleted(entryTemplate)
A event function called after an entry template has been deleted.
- Parameters:
-
entryTemplate
- A ecm.model.EntryTemplate is passed as a parameter.
onEntryTemplateUpdated(entryTemplate)
A event function called after an entry template has been updated.
- Parameters:
-
entryTemplate
- A ecm.model.EntryTemplate is passed as a parameter.
onHoldApplied(repository)
An event function called after the hold has been applied.
- Parameters:
-
repository
- ecm.model.Repository object is passed as a parameter.
onHoldCreated(repository)
An event function called after the hold has been created.
- Parameters:
-
repository
- ecm.model.Repository object is passed as a parameter.
onHoldRemoved(repository)
An event function called after the hold has been removed.
- Parameters:
-
repository
- ecm.model.Repository object is passed as a parameter.
onSearchTemplateAdded(searchTemplate)
A event function called after a search template has been added to the repository.
- Parameters:
-
searchTemplate
- A ecm.model.SearchTemplate is passed as a parameter.
onSearchTemplateDeleted(searchTemplateId, searchVsId)
An event function that is called after a search template has been deleted.
- Parameters:
-
searchTemplateId
- A string value holding the search template's ID.
-
searchVsId
- A string value holding the search template's version series ID (FileNet P8 only).
onSearchTemplateFoldersRetrieved(repository)
An event function called after the search template folders have been retrieved.
- Parameters:
-
repository
- ecm.model.Repository object is passed as a parameter.
onTeamspaceDeleted(id)
An event function called after a teamspace has been deleted.
- Parameters:
-
id
- The teamspace id as a parameter.
onTeamspaceTemplateDeleted(id)
An event function called after a teamspace template has been deleted.
- Parameters:
-
id
- The teamspace template id as a parameter.
onUpdateTeamspace(teamspace)
An event function called after the teamspace has been updated.
- Parameters:
-
teamspace
- A ecm.model.Teamspace object as a parameter.
onUpdateTeamspaceTemplate(teamspace, repo)
An event function called after a teamspace template has been updated.
- Parameters:
-
teamspace
- A ecm.model.Teamspace object.
-
repo
- A ecm.model.Repository object
onWorklistContainersRetrieved(worklistContainers)
An event function called after the worklist continer objects have been retrieved.
- Parameters:
-
worklistContainers
- An array of ecm.model.ProcessApplicationSpace objects or ecm.model.ProcessRole
objects as a parameter.
refresh()
Clears all cached information related to this repository and invokes the onChange(this)
event.
removeHold(items, holdNames, callback)
Removes one or more holds from the specified items. This is only supported for Content Manager OnDemand.
- Parameters:
-
items
- An array of ecm.model.Item objects representing the documents to be removed from the
holds.
-
holdNames
- An array of hold names.
-
callback
- A function invoked after the holds have been removed from the items.
retrieveAdminRoot(itemIdOrPath, itemRetrievedCallback, templateID, version, vsId, objectStoreId, params)
Retrieves the admon root (@link ecm.model.ContentItem} from the repository.
- Parameters:
-
itemIdOrPath
- A String value holding the item identifier or item path.
-
itemRetrievedCallback
- A callback function called after the item has been retrieved. Will pass a
ecm.model.ContentItem object as a parameter.
-
templateID
- A string value holding the template Id.
-
version
- A string holding the version requested; ie. "current" or "released" (optional).
-
vsId
- A string value holding the version series identifier (optional, FileNet P8 only)
-
objectStoreId
- A string value holding the object store identifier (FileNet P8 only).
-
params
- An object containing parameters to control the request to the server. For example, you can set the
retrieve to be performed in the background. See ecm.model.Request for a list of parameters
supported by a server request.
retrieveCheckedOutItems(callback, sortProperty, sortDescending)
Retrieves all items that are checked out by the current user.
- Parameters:
-
callback
- A function called with a ecm.model.ResultSet object holding the items that were retrieved
-
sortProperty
-
sortDescending
- Since:
- 2.0.3
retrieveContentClasses(callback, filterType)
Retrieves an array of ecm.model.ContentClass objects.
- Parameters:
-
callback
- A callback function to call when the classes have been retrieved. Passes an array of
ecm.model.ContentClass objects as a parameter.
-
filterType
- A string value holding the filter type.
retrieveContentClassList(callback, itemList)
Retrieves a specified list of ecm.model.ContentClass objects (instead of all classes), this is a case
for teamspace builder.
- Parameters:
-
callback
- A callback function to call when all the classes have been retrieved. Passes an array of
ecm.model.ContentClass objects as a parameter.
-
itemList
- A list of ecm.model.ContentClass items.
retrieveEntryTemplates(callback, filter, folderId, rootFolderId, objectStore, onError)
Retrieves an array of ecm.model.EntryTemplate objects from a repository based on a filter.
- Parameters:
-
callback
- A callback function to be called after the entry templates are retrieved. Passes an array of
ecm.model.EntryTemplate objects as a parameter.
-
filter
- A string value holding the filter criteria (setting to null, will retrieve all entry templates).
-
folderId
- A string value holding the folder identifier.
-
rootFolderId
- A string value holding the root folder identifier.
-
objectStore
- An object store object holding its identifier information.
-
onError
retrieveEntryTemplatesByIds(entryTemplateIds, callback)
Retrieves an array of ecm.model.EntryTemplate given their ids. The repository entryTemplateCache
is checked first - any entry templates already in the cache are not retrieved again from the repository.
- Parameters:
-
entryTemplateIds
- An array of entry template ids for which the entry templates will be returned.
-
callback
- A callback function to be called after the entry templates are retrieved. Passes an array of
ecm.model.EntryTemplate objects as a parameter.
retrieveEntryTemplatesResultSet(callback, filter, pageResults, orderBy, descending, criteria)
Retrieves a ecm.model.ResultSet object holding the list of all entry templates.
- Parameters:
-
callback
- A callback function called after the entry template result set has been retrieved. Passes a
ecm.model.ResultSet objects as a parameter.
-
filter
- A filter flag.
-
pageResults
- A boolean indicating whether the result set should be paged.
-
orderBy
- The attribute ID of the attribute to sort the contents by, if any.
-
descending
- If true, then sorting will be in descending order.
-
criteria
- Filter criteria for retrieving entry templates.
- Since:
- 2.0.3
retrieveFileNames(items, callback, userPartFileName)
Retrieves filenames of the items
- Parameters:
-
items
- Array of ecm.model.ContentItem to get filenames.
-
callback
- A callback function called when the filenames have been retrieved. Passes the map of item id and
filenames as a parameter.
-
userPartFileName
- It is for Content Manager to return file name for part name or based on properties. FileNet will
not use this parameter.
retrieveHolds(items, isAply, callback)
Retrieves the holds that can be applied to, or removed from, a specified list of items.
- Parameters:
-
items
- An array of ecm.model.Item objects for the items to be queried for valid holds.
-
isAply
- If true the holds listed are for apply, if false the holds are for remove.
-
callback
- A function invoked after the hold information has been retrieved. Two arguments are passed to this
callback: the list of holds, and a boolean value indicating if new holds can be created.
retrieveItem(itemIdOrPath, itemRetrievedCallback, templateID, version, vsId, objectStoreId, action, params)
Retrieves the specified ecm.model.ContentItem from the repository.
- Parameters:
-
itemIdOrPath
- A String value holding the item identifier or item path.
-
itemRetrievedCallback
- A callback function called after the item has been retrieved. Will pass a
ecm.model.ContentItem object as a parameter.
-
templateID
- A string value holding the template Id.
-
version
- A string holding the version requested; ie. "current" or "released" (optional).
-
vsId
- A string value holding the version series identifier (optional, FileNet P8 only).
-
objectStoreId
- A string value holding the object store identifier (FileNet P8 only).
-
action
- A string value to pass up to the mid-tier specifying the action being performed (optional).
-
params
- An object containing parameters to control the request to the server. For example, you can set the
retrieve to be performed in the background. See ecm.model.Request for a list of parameters
supported by a server request.
retrieveMultiItem(itemIdArray, itemRetrievedCallback, templateID, version, vsId, retrieveSecurityParent, retrieveSocialData)
Retrieves multiple items by sending more than one docid. If the array contains only one docid and the item
cannot be retrieved the call will return an error. However, if the array contains more than one docid and one
refers to an item that cannot be retrieved the call will succeed and result in a list of
ecm.model.ContentItem objects representing only the successfully retrieved items.
- Parameters:
-
itemIdArray
- An array of string values holding the item identifier
-
itemRetrievedCallback
- A callback function called after the item has been retrieved. Will pass an array of
ecm.model.ContentItem objects as a parameter.
-
templateID
- A string value holding the template Id.
-
version
- A string holding the version requested; ie. "current" or "released" (optional).
-
vsId
- A string value holding the version series identifier (optional, FileNet P8 only).
-
retrieveSecurityParent
- Boolean value to indicate if the security parent value should be retrieved ((optional, FileNet P8
only).
-
retrieveSocialData
- Boolean value to indicate if social data should be retrieved for documents in the results (optional,
FileNet P8 only).
retrieveODAddDocPermission(templateName, callback)
Retrieve AppGroupNames & AppNames using the supplied templateName parameters.
- Parameters:
-
templateName
- templateName parameters to send to the server.
-
callback
- Function to call when the retrieve add document permission on cmod.
retrieveODAppGroups(callback, templateName)
Retrieve AppGroupNames & AppNames using the supplied templateName parameters.
- Parameters:
-
callback
- Function to call when the retrieve app groups request completes.
-
templateName
- templateName parameters to send to the server.
retrievePrivileges(callback)
Retrieves all the privileges for the repository
- Parameters:
-
callback
- A callback function called when the privileges have been retrieved. Passes the array of privileges
as a parameter.
retrieveRedactionPolicies(callback, refresh)
Retrieves an array of ecm.model.RedactionPolicy objects representing redaction policies available for this repository.
- Parameters:
-
callback
- A function invoked after the redaction policies have been retrieved. It is passed one argument, an array of
ecm.model.RedactionPolicy objects which represent the redaction policies.
-
refresh
- Boolean indicating the list should be retrieved fresh from the server.
retrieveRedactionRoles(callback, refresh)
Retrieves an array of ecm.model.Role objects representing redaction roles available for this repository.
- Parameters:
-
callback
- A function invoked after the redaction roles have been retrieved. It is passed one argument, an array of
ecm.model.Role objects which represent the redaction roles.
-
refresh
- Boolean indicating the list should be retrieved fresh from the server.
retrieveRoles(callback)
Retrieves an array of ecm.model.Role objects available for this repository.
- Parameters:
-
callback
- A function invoked after the roles have been retrieved. It is passed one argument, an array of
ecm.model.Role objects which represent the roles.
retrieveSearchTemplate(docId, vsId, version, callback, backgroundRequest, backgroundRequest)
Retrieves an ecm.model.SearchTemplate object from the repository.
- Parameters:
-
docId
- A string value holding the document id of the serch template to retrieve
-
vsId
- A string value holding the version series Id of the search template (optional, FileNet P8 only)
-
version
- A string value holding the version to return; ie. "current" or "released" (optional)
-
callback
- A callback function called after the searches have been retrieved. Passes an
ecm.model.SearchTemplate object as a parameter.
-
backgroundRequest
- Boolean flag indicating if the request to retrieve the search template should be run in the
background.
-
backgroundRequest
retrieveSearchTemplateFolders(callback)
Retrieves the search template folders (only Content Manager OnDemand supports this type of search).
- Parameters:
-
callback
- A callback function called after the search template folders have been retrieved. Passes an array
of ecm.model.SearchTemplateFolder objects as a parameter.
retrieveSearchTemplates(callback, filter)
Retrieves an array of ecm.model.SearchTemplate objects for the repository.
- Parameters:
-
callback
- A callback function called after the searches have been retrieved. Passes an array of
ecm.model.SearchTemplate objects as a parameter.
-
filter
- A string value holding the search filter type.
retrieveSecurityPolicies(callback)
Retrieves a ecm.model.ResultSet object holding the list of all security policies.
- Parameters:
-
callback
- A callback function called after the security policies result set has been retrieved. Passes a
ecm.model.ResultSet objects as a parameter.
- Since:
- 2.0.3
retrieveServerPrinters(callback, force)
Retrieves server printers and faxes.
- Parameters:
-
callback
- Callback function called after retrieval of the printers.
-
force
- A boolean value indicating whether to return the cached list or re-retrieve a new list.
retrieveTeamspaceById(Id, type, callback, params)
Retrieves an ecm.model.Teamspace object from the repository.
- Parameters:
-
Id
- A string value holding the teamspace identifier.
-
type
- A string value holding the teamspace type.
-
callback
- A callback function called after the teamspace has been retrieved. Passes a
ecm.model.Teamspace object as a parameter.
-
params
- An object containing parameters to control the request to the server. For example, you can set the
retrieve to be performed in the background. See ecm.model.Request for a list of parameters
supported by a server request.
retrieveTeamspaceFolders(callback)
Retrieve an array of ecm.model.Teamspace objects
- Parameters:
-
callback
- A callback function called after the teamspaces has been retrieved. Passes an array
ecm.model.Teamspace objects as a parameter.
retrieveTeamspaceFoldersResultSet(callback, pageResults, orderBy, descending, offline, offline)
Retrieves teamspaces and return a ecm.model.ResultSet object holding the list of teamspaces.
- Parameters:
-
callback
- A callback function called after the teamspace result set has been retrieved. Passes a
ecm.model.ResultSet objects as a parameter.
-
pageResults
- A boolean indicating whether the result set should be paged.
-
orderBy
- The attribute ID of the attribute to sort the contents by, if any.
-
descending
- If true, then sorting will be in descending order.
-
offline
- If true, then offline teamspaces will also be returned.
-
offline
retrieveTeamspaceTemplateFolder(callback)
Retrieve an array of ecm.model.Teamspace template objects
- Parameters:
-
callback
- A callback function called after the teamspace templates has been retrieved. Passes an array
ecm.model.Teamspace objects as a parameter.
retrieveTeamspaceTemplateFolderResultSet(callback, orderBy, descending, criteria)
Retrieves teamspace templates and return a ecm.model.ResultSet object holding the list of teamspace
templates.
- Parameters:
-
callback
- A callback function called after the teamspace result set has been retrieved. Passes a
ecm.model.ResultSet objects as a parameter.
-
orderBy
- The attribute ID of the attribute to sort the contents by, if any.
-
descending
- If true, then sorting will be in descending order.
-
criteria
retrieveVersions(items, version, callback, synchronous)
Returns an ecm.model.ResultSet object containing the requested versions for each item.
- Parameters:
-
items
- A single item or an array of items.
-
version
- Identifies which versions to return. May be a specific version string or the special strings
"released"
, "current"
, or "reservation"
. If
version is null all versions are retrieved for each of the item identifiers.
-
callback
- A function that is called when the versions have been retrieved.
-
synchronous
- An optional flag indicating the request should be synchronous.
retrieveWorklistContainers(callback, rootContainersOnly)
Retrieves an array of ecm.model.ProcessApplicationSpace objects or if there is only one application
space, return an array of ecm.model.ProcessRole objects (FileNet P8 only)
- Parameters:
-
callback
- A callback function called after the containers have been retrieved. Passes an array of
ecm.model.ProcessApplicationSpace objects or ecm.model.ProcessRole objects as a
parameter.
-
rootContainersOnly
- A {boolean} flag indicating whether to return the first tier root containers, regardless of the
number of items.
retrieveWorklistFolders(callback)
Retrieves an array of ecm.model.WorklistFolder objects.
- Parameters:
-
callback
- A callback function called after the worklist folders have been retrieved. Passes an array of
ecm.model.WorklistFolder objects as a parameter.
retrieveWorklists(callback)
Retrieves an array of ecm.model.Worklist objects (Content Manager only).
- Parameters:
-
callback
- A callback function called after the worklists have been retrieved. Passes an array of
ecm.model.Worklist objects as a parameter.
searchTemplatesDeleted(searchTemplates)
Deletes search templates.
- Parameters:
-
searchTemplates
- An array of ecm.model.SearchTemplate objects to delete.
serverPrint(params, items, callback)
Runs a server print using the supplied printer parameters.
- Parameters:
-
params
- Print parameters to send to the server.
-
items
- An array of ecm.model.Item objects to be printed.
-
callback
- Function to call when the server print request completes.
setRecordDatamodelType(datamodel)
Sets the record's datamodel type for this repository for Enterpise Records. This only applies to File Plan
Repositories.
- Parameters:
-
datamodel
- A string value holding the data model type.
setRecordType(recordType)
Sets the record type for this repository for Enterprise Records.
- Parameters:
-
recordType
- The record type for the repository.
supportsFiltering()
Returns boolean indicating if this repository supports repository filtering.
- Since:
- 2.0.3
unlockItems(items, callback, errorCallback)
Unlocks the specified items in the repository.
- Parameters:
-
items
- An array of ecm.model.Item objects representing the items to unlock.
-
callback
- A function invoked when the items have successfully been unlocked.
-
errorCallback
- An option method to call when errors occur during logon.
updateEntryTemplate(entryTemplate, checkoutEntryTemplate, callback)
Updates an existing entry template design in the repository.
- Parameters:
-
entryTemplate
- A design instance of ecm.model.EntryTemplate.
-
checkoutEntryTemplate
- Boolean flag indicating whether to check out the entry template after updating it.
-
callback
- A function that is invoked when the update has completed successfully. The entry template design
with updated ID information is passed as the only argument. Design instances of entry templates
should not be used to add items.
- Since:
- 2.0.3
updateRedactionPolicy(newRole, callback)
Updates a redaction policy in the repository
- Parameters:
-
newRole
- A ecm.model.RedacationPolicy object holding data for the policy to be updated.
-
callback
- A function invoked after the policy has been updated.
- Since:
- 2.0.3.8.
updateRedactionRole(newRole, callback)
Updates a redaction role in the repository
- Parameters:
-
newRole
- A ecm.model.Role object holding data for the role to be updated.
-
callback
- A function invoked after the role has been updated.
- Since:
- 2.0.3.8.
usesEJB()
For a FileNet P8 repository, returns true if the serverName URL uses EJB.
validateTeamspace(Id, type, callback)
Validates a ecm.model.Teamspace template data.
- Parameters:
-
Id
- A string value holding the teamspace identifier.
-
type
- A string value holding the teamspace type.
-
callback
- A callback function called after the teamspace has been retrieved. Passes a
ecm.model.Teamspace object as a parameter.
- Since:
- 2.0.2