Class ecm.widget.layout.CommonActionsHandler
Provides the default implementation for many of the common actions. This class invokes methods from the
ecm.widget.dialog package and ecm.model package.
Defined in: <ecm\widget\layout\CommonActionsHandler.js>.
Constructor Summary
| Constructor Attributes | Constructor Name and Description |
|---|---|
Method Summary
| Method Attributes | Method Name and Description |
|---|---|
|
actionAbout(repository, items)
Displays the About dialog box.
|
|
|
actionAddDocFromRepo(repository, items, callback, teamspace, resultSet)
|
|
|
actionAddDocumentAttachment(repository, items, callback)
Displays a dialog that allows the user to add a new Document object to a repository and attach it to the
current workitem.
|
|
|
actionAddEditServiceDocument(repository, items, callback, teamspace, resultSet, virtualItems, propertiesMap, virtualItemObjects)
|
|
|
actionAddFolderAttachment(repository, items, callback)
Displays a dialog that allows the user to add a new Folder object to a repository and attach it to the
current workitem.
|
|
|
actionAddToFavorites(repository, items, callback, teamspace, resultSet)
Adds the first input item to favorites.
|
|
|
actionAddToFolder(repository, items, callback, teamspace, resultSet, parameterMap, action)
Displays the Add to Folder dialog box to enable the user to add a document to a folder.
|
|
|
actionApplyHold(repository, items)
|
|
|
actionAsperaDownload(repository, item, callback, teamspace, resultSet, parameterMap, action, version, partNum)
|
|
|
actionBoxCopy(repository, items, callback, teamspace, resultSet, parameterMap, action)
Displays the Copy to Folder dialog box to enable the user to copy a document or folder to a folder in a
different repository.
|
|
|
Opens the change locale dialog.
|
|
|
actionChangePassword(repository, items)
Opens the change password dialog box.
|
|
|
Opens the change Windows login username dialog.
|
|
|
actionCheckIn(repository, items, callback, teamspace, propertiesMap, virtualItemObjects, action)
|
|
|
actionCheckOut(repository, items, callback, teamspace, resultSet, parameterMap, action)
|
|
|
actionCheckOutDownload(repository, items, callback, teamspace, resultSet, parameterMap, action)
|
|
|
actionCheckOutLabelWithDownload(repository, items, callback, teamspace, resultSet, parameterMap, action)
|
|
|
actionCheckOutNoDownload(repository, items, callback, teamspace, resultSet, parameterMap, action)
|
|
|
actionConnectRepository(repository, items)
|
|
|
actionContinueWF(repository, items, callback)
Continues the selected items on their Content Manager workflows.
|
|
|
actionConvertEntryTemplate(repository, items, container, entryTemplate, resultSet)
|
|
|
actionCopyEntryTemplate(repository, items, container, entryTemplate, resultSet)
|
|
|
actionCopyToEditService(repository, items, callback, teamspace, resultSet, virtualItems, propertiesMap, virtualItemObjects)
|
|
|
actionCopyToFolder(repository, items, callback, teamspace, resultSet, parameterMap, action, defaultSelectedRepository)
Displays the Copy to Folder dialog box to enable the user to copy a document or folder to a folder.
|
|
|
actionCopyToOfficeOnline(repository, items, callback, teamspace, resultSet, virtualItems, propertiesMap, virtualItemObjects)
|
|
|
actionCreateDocumentEntryTemplate(repository, items, container, entryTemplate, resultSet)
|
|
|
actionCreateFolder(repository, items, callback, teamspace, resultSet)
|
|
|
actionCreateFolderEntryTemplate(repository, items, container, entryTemplate, resultSet)
|
|
|
actionCreateFolderUsingTemplate(repository, items, callback, teamspace, useSelectedTemplate)
|
|
|
actionCreateHold(repository, items)
|
|
|
actionCreateTeamSpace(repository, items, container, teamspace, resultSet)
|
|
|
actionCreateTemplate(repository, items, container, teamspace, resultSet)
|
|
|
actionDeleteAsyncTask(repository, items, callback, teamspace, resultset, parameterMap)
Deletes the given asynchronous task.
|
|
|
actionDeleteFavorite(repository, items)
Delete the favorite.
|
|
|
actionDeleteItem(repository, items, callback, teamspace, resultSet, parameterMap)
|
|
|
actionDeleteTracker(repository, items, callback)
Displays a confirmation dialog box that allows the user to remove the current work item from the tracker
in-basket or cancel the action.
|
|
|
actionDeleteWorkspace(repository, items, callback)
|
|
|
actionDemoteVersion(repository, items)
|
|
|
actionDisableSync(repository, items)
Disables a list of items for sync.
|
|
|
actionDisableWorkspace(repository, items, callback)
|
|
|
actionDisconnectBox(repository, items)
Disconnects Box (secondary) repository users from the desktop login account.
|
|
|
actionDownload(repository, items, callback, teamspace, resultSet, parameterMap, action, version, trackFiles)
|
|
|
actionDownloadAll(repository, items, callback, teamspace, resultSet, parameterMap, action, version)
|
|
|
actionDownloadAllAsPdf(repository, items, callback, teamspace, resultSet, parameterMap, action, version)
|
|
|
actionDownloadAsCSV(repository, items, callback, teamspace, resultSet, parameterMap, action, version)
|
|
|
actionDownloadAsOriginal(repository, items, callback, teamspace, resultSet, parameterMap, action, version)
|
|
|
actionDownloadAsPdf(repository, items, callback, teamspace, resultSet, parameterMap, action, version)
|
|
|
actionDownloadAsUtf8(repository, items, callback, teamspace, resultSet, parameterMap, action, version)
|
|
|
actionEdit(repository, items, callback, teamspace, resultSet)
Opens the item in the edit properties dialog.
|
|
|
actionEditDoc(repository, items)
|
|
|
actionEditEntryTemplate(repository, items, container, entryTemplate, resultSet)
|
|
|
actionEditSearch(repository, items, callback, teamspace, resultSet, parameterMap)
|
|
|
actionEditTeamspaceClasses(repository, items, callback)
|
|
|
actionEditTeamspaceEntryTemplates(repository, items, callback)
|
|
|
actionEditTeamspaceRoles(repository, items, callback)
|
|
|
actionEditTeamspaceSearches(repository, items, callback)
|
|
|
actionEditTeamspaceTeam(repository, items, callback)
|
|
|
actionEditWF(repository, items, callback)
Displays a dialog box that allows the user to specify the Content Manager workflow properties.
|
|
|
actionEditWithNativeApplication(repository, items, callback, teamspace, resultSet, parameterMap)
|
|
|
actionEditWithOfficeOnline(repository, items, callback, teamspace, resultSet, parameterMap)
|
|
|
actionEditWorkspace(repository, items, callback, teamspace, resultSet, parameterMap)
|
|
|
actionEnableSync(repository, items)
Enables a list of items for sync.
|
|
|
actionEnableWorkspace(repository, items, callback)
|
|
|
actionExport(repository, items, callback, teamspace, resultSet)
|
|
|
actionExportAll(repository, items, callback, teamspace, resultSet, parameterMap)
|
|
|
actionExportTemplate(repository, items, callback, teamspace, resultSet, parameterMap, action)
Exports teamspace templates.
|
|
|
actionHelp(repository, items)
Opens help information in a new window.
|
|
|
actionImport(repository, items, callback, teamspace, resultSet, virtualItems, propertiesMap, virtualItemObjects)
|
|
|
actionImportTemplate(repository, items, callback, teamspace, resultSet, parameterMap, action)
Imports teamspace templates.
|
|
|
actionImportUsingTemplate(repository, items, callback, teamspace, useSelectedTemplate)
|
|
|
actionLaunch(repository, items, callback)
Opens a browser popup window and renders the selected workflow launch processor in that window.
|
|
|
actionLaunchWorkflowAction(repository)
Displays a dialog box that will list the "transfered" workflow definitions from a FileNet P8 repository.
|
|
|
actionLock(repository, items)
|
|
|
actionLogOut(repository, items)
Opens the logout confirmation dialog box.
|
|
|
actionMakeWorkspaceTemplateDefault(repository, items, callback)
|
|
|
actionManageEntryTemplates(repository, items, container)
|
|
|
actionManageTeamspaces(repository, items, container)
|
|
|
actionMergeSplit(repository, items, openUseSelf, teamspace, resultSet, parameterMap, openUseSelf)
Opens the selected and supported content items in the viewer in Document Builder mode.
|
|
|
actionMoveDocumentToFolder(repository, items, callback, teamspace, resultSet)
Displays the Move to Folder dialog box to enable the user to move a document to another parent folder.
|
|
|
actionMoveFolderToFolder(repository, items, callback, teamspace, resultSet)
Displays the Move to Folder dialog box to enable the user to move a folder from one parent folder to another.
|
|
|
actionMoveTeamspaceDocumentToFolder(repository, items, callback, teamspace, resultSet)
Displays the Teamspace Move to Folder dialog box to enable the user to move a document outside of the
teamspace.
|
|
|
actionMoveToInbox(repository, items, callback)
Moves the work item to the current user's personal in-basket.
|
|
|
actionNewExcelDocument(repository, items, callback, teamspace, resultSet, virtualItems, propertiesMap, virtualItemObjects)
|
|
|
actionNewPowerPointDocument(repository, items, callback, teamspace, resultSet, virtualItems, propertiesMap, virtualItemObjects)
|
|
|
actionNewWordDocument(repository, items, callback, teamspace, resultSet, virtualItems, propertiesMap, virtualItemObjects)
|
|
|
actionOpen(item, callback, errorCallback)
Opens the input item.
|
|
|
actionOpenAsyncTask(repository, items, callback)
Opens an asynchronous task.
|
|
|
actionOpenEForm(repository, items, callback, servicesUrl)
Opens a browser popup window and renders the selected eform object in that window.
|
|
|
actionOpenFolder(repository, items, callback, teamspace, resultSet, parameterMap)
Opens the folder.
|
|
|
actionOpenSearch(repository, items, callback, teamspace, resultSet, parameterMap)
Use this method when you want to open non-autorun search templates in a search tab, but for autorun search
templates you want to run the search and get the resultSet (which can then be put in a content list).
|
|
|
actionOpenSearchInTab(repository, items, callback, teamspace, resultSet, parameterMap)
Use this method when you want to always open the search template in a search tab.
|
|
|
actionOpenSearchNewTab(repository, items, callback, teamspace, resultSet, parameterMap)
|
|
|
actionOpenStep(repository, items, callback)
Displays a dialog box that allows the user to open the Content Manager Step Processor.
|
|
|
actionOpenTeamspace(repository, items, callback, teamspace, resultSet, parameterMap)
Opens teamspaces.
|
|
|
actionPreview(repository, items)
Displays the content items in a preview window.
|
|
|
actionPrintDoc(repository, items, callback, teamspace, resultSet, parameterMap)
|
|
|
actionPrintDocAll(repository, items, callback, teamspace, resultSet, parameterMap)
|
|
|
actionPromoteVersion(repository, items)
|
|
|
actionReassign(repository, items, callback)
Displays a dialog that allows the user to select another user to be assigned to the FileNet P8 workflow.
|
|
|
actionRefreshAttachments(repository, items)
|
|
|
actionRefreshGrid(repository, items, callback, teamspace, resultSet)
This refreshes the result set that an item or items are contained within.
|
|
|
actionRefreshInbasket(repository, items)
This refreshes the in-basket result set that an item or items are contained within.
|
|
|
actionRemoveFromFolder(repository, items, callback, teamspace, resultSet)
Displays a confirmation dialog box that allows the user to remove items from a folder or to cancel the
action.
|
|
|
actionRemoveFromMySyncedFiles(repository, items)
Disables a list of items for sync.
|
|
|
actionRemoveHold(repository, items)
|
|
|
actionRemoveWF(repository, items, callback)
Displays a confirmation dialog that allows the user to remove the Content Manager items from their workflow
or to cancel the action.
|
|
|
actionRenameFavorite(repository, items)
Rename the favorite.
|
|
|
actionResponseWF(repository, items, callback, teamspace, resultSet, parameterMap, action)
Makes a call to Content Manager service that will process a running workflow item with a custom response.
|
|
|
actionResumeWF(repository, items, callback)
Resumes the selected items on their Content Manager workflows (that have been suspended).
|
|
|
actionReturnToSender(repository, items, callback)
Returns the workitem to the sender it originally came from.
|
|
|
actionScheduleAsyncTask(repository, items, callback, teamspace, resultset, parameterMap, action)
Schedules the a new async task by presenting the async task creation dialog.
|
|
|
actionSearchProperties(repository, items)
|
|
|
actionSelectDocumentAttachment(repository, items, callback)
Displays a dialog that allows the user to select a Document object from a repository to be attached to the
current workitem.
|
|
|
actionSelectFolderAttachment(repository, items, callback)
Displays a dialog that allows the user to select a Folder object from a repository to be attached to the
current workitem.
|
|
|
actionSendAllAsPDF(repository, items, callback, teamspace, resultSet, parameterMap, action)
|
|
|
actionSendAsPDF(repository, items, callback, teamspace, resultSet, parameterMap, action)
|
|
|
actionSendAttachments(repository, items, callback, teamspace, resultSet, parameterMap, action)
|
|
|
actionSendAttachmentsAll(repository, items, callback, teamspace, resultSet, parameterMap, action)
|
|
|
actionSendLinksToDocs(repository, items, callback, teamspace, resultSet, parameterMap, action)
|
|
|
actionSendLinksToFolders(repository, items, callback, teamspace, resultSet, parameterMap, action)
|
|
|
actionSendLinksToSearches(repository, items, callback, teamspace, resultSet, parameterMap, action)
|
|
|
actionShare(repository, items, callback, teamspace, resultSet)
Share the item.
|
|
|
actionShowHyperlink(repository, items, callback, teamspace, resultSet, parameterMap)
Displays the View Link dialog box.
|
|
|
actionStartWF(repository, items, callback)
Displays a dialog box that allows the user to specify the Content Manager workflow properties and then launch
the workflow.
|
|
|
actionSuspendWF(repository, items, callback)
Displays a dialog that allows the user to specify the Content Manager workflow suspend options and then
suspend the items.
|
|
|
actionTrackDownload(repository, items, callback, teamspace, resultSet, parameterMap, action, version)
|
|
|
actionTransferWorkflow(repository, items, callback)
Displays a dialog that will "transfer" a workflow definitions from a P8 repository.
|
|
|
actionUnlock(repository, items, callback, teamspace, resultSet, parameterMap, action)
|
|
|
actionUnshare(repository, items, callback, teamspace, resultSet, parameterMap, action)
|
|
|
actionView(repository, items, openUseSelf, teamspace, resultSet, parameterMap, openUseSelf)
Completes the appropriate view action or obtains the appropriate viewer for which to view the input content
items.
|
|
|
actionViewAnnotation(repository, items, callback, teamspace, resultSet)
|
|
|
actionViewChildDocuments(repository, items, callback, teamspace, resultSet, parameterMap)
|
|
|
actionViewFullReport(repository, items, openUseSelf, teamspace, resultSet, parameterMap, openUseSelf)
Completes view full report action for line data file
|
|
|
actionViewProcessInformation(repository, items, callback)
Display a dialog box that shows the selected item process information
|
|
|
actionViewStep(repository, items, callback)
Opens a browser popup window and renders the selected workflow step processor in that window.
|
|
|
actionWorkspaceProperties(repository, items, callback, teamspace, resultSet)
|
|
|
downloadUsingAspera(transferSpec)
|
Method Detail
actionAbout(repository, items)
Displays the About dialog box.
- Parameters:
- repository
- Instance of ecm.model.Repository.
- items
actionAddDocFromRepo(repository, items, callback, teamspace, resultSet)
- Parameters:
- repository
- items
- callback
- teamspace
- resultSet
actionAddDocumentAttachment(repository, items, callback)
Displays a dialog that allows the user to add a new Document object to a repository and attach it to the
current workitem.
- Parameters:
- repository
- A ecm.model.Repository object
- items
- An array of ecm.model.WorkItem objects
- callback
- A callback function called after the item has been added to the repository. Passes the selected content item as a parameter in the callback function.
actionAddEditServiceDocument(repository, items, callback, teamspace, resultSet, virtualItems, propertiesMap, virtualItemObjects)
- Parameters:
- repository
- items
- callback
- teamspace
- resultSet
- virtualItems
- propertiesMap
- virtualItemObjects
actionAddFolderAttachment(repository, items, callback)
Displays a dialog that allows the user to add a new Folder object to a repository and attach it to the
current workitem.
- Parameters:
- repository
- A ecm.model.Repository object
- items
- An array of ecm.model.WorkItem objects
- callback
- A callback function called after the item has been added to the repository. Passes the selected content item as a parameter in the callback function.
actionAddToFavorites(repository, items, callback, teamspace, resultSet)
Adds the first input item to favorites. Shows the add favorites dialog.
- Parameters:
- repository
- Instance of ecm.model.Repository
- items
- Array of items. Only the first item is edited.
- callback
- teamspace
- resultSet
actionAddToFolder(repository, items, callback, teamspace, resultSet, parameterMap, action)
Displays the Add to Folder dialog box to enable the user to add a document to a folder.
- Parameters:
- repository
- Instance of ecm.model.Repository.
- items
- Array of items.
- callback
- A callback function that is called after the document is added.
- teamspace
- Instance of ecm.model.Teamspace.
- resultSet
- Instance of ecm.model.ResultSet.
- parameterMap
- action
actionApplyHold(repository, items)
- Parameters:
- repository
- items
actionAsperaDownload(repository, item, callback, teamspace, resultSet, parameterMap, action, version, partNum)
- Parameters:
- repository
- item
- callback
- teamspace
- resultSet
- parameterMap
- action
- version
- partNum
actionBoxCopy(repository, items, callback, teamspace, resultSet, parameterMap, action)
Displays the Copy to Folder dialog box to enable the user to copy a document or folder to a folder in a
different repository.
- Parameters:
- repository
- Instance of ecm.model.Repository.
- items
- Array of items.
- callback
- A callback function that is called after the document is added.
- teamspace
- Instance of ecm.model.Teamspace.
- resultSet
- Instance of ecm.model.ResultSet.
- parameterMap
- action
- Since:
- 2.0.3.6
actionChangeLocale()
Opens the change locale dialog.
actionChangePassword(repository, items)
Opens the change password dialog box.
- Parameters:
- repository
- Instance of ecm.model.Repository.
- items
actionChangeWindowsLoginName()
Opens the change Windows login username dialog.
actionCheckIn(repository, items, callback, teamspace, propertiesMap, virtualItemObjects, action)
- Parameters:
- repository
- items
- callback
- teamspace
- propertiesMap
- virtualItemObjects
- action
actionCheckOut(repository, items, callback, teamspace, resultSet, parameterMap, action)
- Parameters:
- repository
- items
- callback
- teamspace
- resultSet
- parameterMap
- action
actionCheckOutDownload(repository, items, callback, teamspace, resultSet, parameterMap, action)
- Parameters:
- repository
- items
- callback
- teamspace
- resultSet
- parameterMap
- action
actionCheckOutLabelWithDownload(repository, items, callback, teamspace, resultSet, parameterMap, action)
- Parameters:
- repository
- items
- callback
- teamspace
- resultSet
- parameterMap
- action
actionCheckOutNoDownload(repository, items, callback, teamspace, resultSet, parameterMap, action)
- Parameters:
- repository
- items
- callback
- teamspace
- resultSet
- parameterMap
- action
actionConnectRepository(repository, items)
- Parameters:
- repository
- items
actionContinueWF(repository, items, callback)
Continues the selected items on their Content Manager workflows.
- Parameters:
- repository
- A ecm.model.Repository object
- items
- An array of ecm.model.WorkItem objects
- callback
- A callback function that is called after the items have been continued.
actionConvertEntryTemplate(repository, items, container, entryTemplate, resultSet)
- Parameters:
- repository
- items
- container
- entryTemplate
- resultSet
actionCopyEntryTemplate(repository, items, container, entryTemplate, resultSet)
- Parameters:
- repository
- items
- container
- entryTemplate
- resultSet
actionCopyToEditService(repository, items, callback, teamspace, resultSet, virtualItems, propertiesMap, virtualItemObjects)
- Parameters:
- repository
- items
- callback
- teamspace
- resultSet
- virtualItems
- propertiesMap
- virtualItemObjects
actionCopyToFolder(repository, items, callback, teamspace, resultSet, parameterMap, action, defaultSelectedRepository)
Displays the Copy to Folder dialog box to enable the user to copy a document or folder to a folder.
- Parameters:
- repository
- Instance of ecm.model.Repository.
- items
- Array of items.
- callback
- A callback function that is called after the document is added.
- teamspace
- Instance of ecm.model.Teamspace.
- resultSet
- Instance of ecm.model.ResultSet.
- parameterMap
- action
- defaultSelectedRepository
actionCopyToOfficeOnline(repository, items, callback, teamspace, resultSet, virtualItems, propertiesMap, virtualItemObjects)
- Parameters:
- repository
- items
- callback
- teamspace
- resultSet
- virtualItems
- propertiesMap
- virtualItemObjects
actionCreateDocumentEntryTemplate(repository, items, container, entryTemplate, resultSet)
- Parameters:
- repository
- items
- container
- entryTemplate
- resultSet
actionCreateFolder(repository, items, callback, teamspace, resultSet)
- Parameters:
- repository
- items
- callback
- teamspace
- resultSet
actionCreateFolderEntryTemplate(repository, items, container, entryTemplate, resultSet)
- Parameters:
- repository
- items
- container
- entryTemplate
- resultSet
actionCreateFolderUsingTemplate(repository, items, callback, teamspace, useSelectedTemplate)
- Parameters:
- repository
- items
- callback
- teamspace
- useSelectedTemplate
actionCreateHold(repository, items)
- Parameters:
- repository
- items
actionCreateTeamSpace(repository, items, container, teamspace, resultSet)
- Parameters:
- repository
- items
- container
- teamspace
- resultSet
actionCreateTemplate(repository, items, container, teamspace, resultSet)
- Parameters:
- repository
- items
- container
- teamspace
- resultSet
actionDeleteAsyncTask(repository, items, callback, teamspace, resultset, parameterMap)
Deletes the given asynchronous task.
- Parameters:
- repository
- The authenticating repository associated with this task.
- items
- The array of async tasks to be deleted
- callback
- The callback function when the delete completes.
- teamspace
- Not applicable.
- resultset
- The result set this async task came from.
- parameterMap
- Additional parameters passed to this delete function.
actionDeleteFavorite(repository, items)
Delete the favorite. Shows a confirmation dialog.
- Parameters:
- repository
- Instance of ecm.model.Repository
- items
- Array of items.
actionDeleteItem(repository, items, callback, teamspace, resultSet, parameterMap)
- Parameters:
- repository
- items
- callback
- teamspace
- resultSet
- parameterMap
actionDeleteTracker(repository, items, callback)
Displays a confirmation dialog box that allows the user to remove the current work item from the tracker
in-basket or cancel the action.
- Parameters:
- repository
- An ecm.model.Repository object.
- items
- An array of ecm.model.WorkItem objects.
- callback
- A callback function that is called after the items have been deleted from the tracker in-basket.
actionDeleteWorkspace(repository, items, callback)
- Parameters:
- repository
- items
- callback
actionDemoteVersion(repository, items)
- Parameters:
- repository
- items
actionDisableSync(repository, items)
Disables a list of items for sync.
- Parameters:
- repository
- Instance of ecm.model.Repository
- items
- An array of ecm.model.Item or ecm.model.Teamspace objects
- Since:
- 2.0.3.5
actionDisableWorkspace(repository, items, callback)
- Parameters:
- repository
- items
- callback
actionDisconnectBox(repository, items)
Disconnects Box (secondary) repository users from the desktop login account.
- Parameters:
- repository
- Instance of ecm.model.Repository.
- items
- Since:
- 2.0.3.5
actionDownload(repository, items, callback, teamspace, resultSet, parameterMap, action, version, trackFiles)
- Parameters:
- repository
- items
- callback
- teamspace
- resultSet
- parameterMap
- action
- version
- trackFiles
actionDownloadAll(repository, items, callback, teamspace, resultSet, parameterMap, action, version)
- Parameters:
- repository
- items
- callback
- teamspace
- resultSet
- parameterMap
- action
- version
actionDownloadAllAsPdf(repository, items, callback, teamspace, resultSet, parameterMap, action, version)
- Parameters:
- repository
- items
- callback
- teamspace
- resultSet
- parameterMap
- action
- version
actionDownloadAsCSV(repository, items, callback, teamspace, resultSet, parameterMap, action, version)
- Parameters:
- repository
- items
- callback
- teamspace
- resultSet
- parameterMap
- action
- version
actionDownloadAsOriginal(repository, items, callback, teamspace, resultSet, parameterMap, action, version)
- Parameters:
- repository
- items
- callback
- teamspace
- resultSet
- parameterMap
- action
- version
actionDownloadAsPdf(repository, items, callback, teamspace, resultSet, parameterMap, action, version)
- Parameters:
- repository
- items
- callback
- teamspace
- resultSet
- parameterMap
- action
- version
actionDownloadAsUtf8(repository, items, callback, teamspace, resultSet, parameterMap, action, version)
- Parameters:
- repository
- items
- callback
- teamspace
- resultSet
- parameterMap
- action
- version
actionEdit(repository, items, callback, teamspace, resultSet)
Opens the item in the edit properties dialog.
- Parameters:
- repository
- Instance of ecm.model.Repository
- items
- Array of items. Only the first item is edited.
- callback
- Callback function.
- teamspace
- Instance of ecm.model.Teamspace.
- resultSet
- * The result set in which the items reside.
actionEditDoc(repository, items)
- Parameters:
- repository
- items
actionEditEntryTemplate(repository, items, container, entryTemplate, resultSet)
- Parameters:
- repository
- items
- container
- entryTemplate
- resultSet
actionEditSearch(repository, items, callback, teamspace, resultSet, parameterMap)
- Parameters:
- repository
- items
- callback
- teamspace
- resultSet
- parameterMap
actionEditTeamspaceClasses(repository, items, callback)
- Parameters:
- repository
- items
- callback
actionEditTeamspaceEntryTemplates(repository, items, callback)
- Parameters:
- repository
- items
- callback
actionEditTeamspaceRoles(repository, items, callback)
- Parameters:
- repository
- items
- callback
actionEditTeamspaceSearches(repository, items, callback)
- Parameters:
- repository
- items
- callback
actionEditTeamspaceTeam(repository, items, callback)
- Parameters:
- repository
- items
- callback
actionEditWF(repository, items, callback)
Displays a dialog box that allows the user to specify the Content Manager workflow properties.
- Parameters:
- repository
- A ecm.model.Repository object.
- items
- An array of ecm.model.WorkItem objects.
- callback
- A callback function that is called after the items have been edited.
actionEditWithNativeApplication(repository, items, callback, teamspace, resultSet, parameterMap)
- Parameters:
- repository
- items
- callback
- teamspace
- resultSet
- parameterMap
actionEditWithOfficeOnline(repository, items, callback, teamspace, resultSet, parameterMap)
- Parameters:
- repository
- items
- callback
- teamspace
- resultSet
- parameterMap
actionEditWorkspace(repository, items, callback, teamspace, resultSet, parameterMap)
- Parameters:
- repository
- items
- callback
- teamspace
- resultSet
- parameterMap
actionEnableSync(repository, items)
Enables a list of items for sync.
- Parameters:
- repository
- Instance of ecm.model.Repository
- items
- An array of ecm.model.Item or ecm.model.Teamspace objects
- Since:
- 2.0.3.5
actionEnableWorkspace(repository, items, callback)
- Parameters:
- repository
- items
- callback
actionExport(repository, items, callback, teamspace, resultSet)
- Parameters:
- repository
- items
- callback
- teamspace
- resultSet
actionExportAll(repository, items, callback, teamspace, resultSet, parameterMap)
- Parameters:
- repository
- items
- callback
- teamspace
- resultSet
- parameterMap
actionExportTemplate(repository, items, callback, teamspace, resultSet, parameterMap, action)
Exports teamspace templates.
- Parameters:
- repository
- An ecm.model.Repository object
- items
- Array of objects.
- callback
- A callback function that is called after a teamspace template is exported.
- teamspace
- Instance of ecm.model.Teamspace.
- resultSet
- Instance of ecm.model.ResultSet.
- parameterMap
- action
actionHelp(repository, items)
Opens help information in a new window.
- Parameters:
- repository
- Instance of ecm.model.Repository.
- items
actionImport(repository, items, callback, teamspace, resultSet, virtualItems, propertiesMap, virtualItemObjects)
- Parameters:
- repository
- items
- callback
- teamspace
- resultSet
- virtualItems
- propertiesMap
- virtualItemObjects
actionImportTemplate(repository, items, callback, teamspace, resultSet, parameterMap, action)
Imports teamspace templates.
- Parameters:
- repository
- An (@link ecm.model.Repository} object.
- items
- Array of objects.
- callback
- A callback function that is called after the teamspace template is imported.
- teamspace
- Instance of ecm.model.Teamspace.
- resultSet
- Instance of ecm.model.ResultSet.
- parameterMap
- action
actionImportUsingTemplate(repository, items, callback, teamspace, useSelectedTemplate)
- Parameters:
- repository
- items
- callback
- teamspace
- useSelectedTemplate
actionLaunch(repository, items, callback)
Opens a browser popup window and renders the selected workflow launch processor in that window.
- Parameters:
- repository
- A ecm.model.Repository object
- items
- An array of ecm.model.ContentItem objects, only opens the first item.
- callback
- A callback function.
actionLaunchWorkflowAction(repository)
Displays a dialog box that will list the "transfered" workflow definitions from a FileNet P8 repository. The
user can select a workflow and launch it.
- Parameters:
- repository
- A ecm.model.Repository object.
actionLock(repository, items)
- Parameters:
- repository
- items
actionLogOut(repository, items)
Opens the logout confirmation dialog box.
- Parameters:
- repository
- Instance of ecm.model.Repository.
- items
actionMakeWorkspaceTemplateDefault(repository, items, callback)
- Parameters:
- repository
- items
- callback
actionManageEntryTemplates(repository, items, container)
- Parameters:
- repository
- items
- container
actionManageTeamspaces(repository, items, container)
- Parameters:
- repository
- items
- container
actionMergeSplit(repository, items, openUseSelf, teamspace, resultSet, parameterMap, openUseSelf)
Opens the selected and supported content items in the viewer in Document Builder mode.
- Parameters:
- repository
- Instance of ecm.model.Repository.
- items
- Input content items selected for opening in the viewer in Document Builder mode.
- openUseSelf
- - (true/false) default is false. Open a window use itself instead of open a new window if value is true.
- teamspace
- resultSet
- parameterMap
- openUseSelf
actionMoveDocumentToFolder(repository, items, callback, teamspace, resultSet)
Displays the Move to Folder dialog box to enable the user to move a document to another parent folder.
- Parameters:
- repository
- Instance of ecm.model.Repository.
- items
- Array of items.
- callback
- A callback function that is called after the document is moved.
- teamspace
- Instance of ecm.model.Teamspace.
- resultSet
- Instance of ecm.model.ResultSet.
actionMoveFolderToFolder(repository, items, callback, teamspace, resultSet)
Displays the Move to Folder dialog box to enable the user to move a folder from one parent folder to another.
- Parameters:
- repository
- Instance of ecm.model.Repository.
- items
- Array of items.
- callback
- A callback function that is call after the folder is moved.
- teamspace
- Instance of ecm.model.Teamspace.
- resultSet
- Instance of ecm.model.ResultSet.
actionMoveTeamspaceDocumentToFolder(repository, items, callback, teamspace, resultSet)
Displays the Teamspace Move to Folder dialog box to enable the user to move a document outside of the
teamspace.
- Parameters:
- repository
- Instance of ecm.model.Repository.
- items
- Array of items.
- callback
- A callback function that is called after the document is moved.
- teamspace
- Instance of ecm.model.Teamspace.
- resultSet
- Instance of ecm.model.ResultSet.
- Since:
- 2.0.3
actionMoveToInbox(repository, items, callback)
Moves the work item to the current user's personal in-basket. Does not display any UI.
- Parameters:
- repository
- A ecm.model.Repository object.
- items
- An array of ecm.model.WorkItem objects.
- callback
- A callback function called after the items have been moved to their in-basket.
actionNewExcelDocument(repository, items, callback, teamspace, resultSet, virtualItems, propertiesMap, virtualItemObjects)
- Parameters:
- repository
- items
- callback
- teamspace
- resultSet
- virtualItems
- propertiesMap
- virtualItemObjects
actionNewPowerPointDocument(repository, items, callback, teamspace, resultSet, virtualItems, propertiesMap, virtualItemObjects)
- Parameters:
- repository
- items
- callback
- teamspace
- resultSet
- virtualItems
- propertiesMap
- virtualItemObjects
actionNewWordDocument(repository, items, callback, teamspace, resultSet, virtualItems, propertiesMap, virtualItemObjects)
- Parameters:
- repository
- items
- callback
- teamspace
- resultSet
- virtualItems
- propertiesMap
- virtualItemObjects
actionOpen(item, callback, errorCallback)
Opens the input item.
- Parameters:
- item
- The item to open.
- callback
- Callback function called on complete.
- errorCallback
- Since:
- 2.0.3.7 Callback function called on error
actionOpenAsyncTask(repository, items, callback)
Opens an asynchronous task. If it's a recurring task, it will retrieve all of its instances instead.
- Parameters:
- repository
- Instance of ecm.model.Repository.
- items
- An array of ecm.model.AsyncTask to open.
- callback
- The callback when the asynchronous task finishes opening.
actionOpenEForm(repository, items, callback, servicesUrl)
Opens a browser popup window and renders the selected eform object in that window.
- Parameters:
- repository
- A ecm.model.Repository object
- items
- An array of ecm.model.ContentItem objects, only opens the first item.
- callback
- A callback function.
- servicesUrl
- A String holding a services URL to use when opening the eform object.
actionOpenFolder(repository, items, callback, teamspace, resultSet, parameterMap)
Opens the folder.
- Parameters:
- repository
- Instance of ecm.model.Repository
- items
- Array of items. Only the first item is opened.
- callback
- Callback function.
- teamspace
- Instance of ecm.model.Teamspace.
- resultSet
- Instance of ecm.model.ResultSet.
- parameterMap
- parameterMap.widget contains the widget to set the result set on and to onOpenItem.
actionOpenSearch(repository, items, callback, teamspace, resultSet, parameterMap)
Use this method when you want to open non-autorun search templates in a search tab, but for autorun search
templates you want to run the search and get the resultSet (which can then be put in a content list). Used by
browse, favorites, and teamspaces.
- Parameters:
- repository
- items
- callback
- teamspace
- resultSet
- parameterMap
actionOpenSearchInTab(repository, items, callback, teamspace, resultSet, parameterMap)
Use this method when you want to always open the search template in a search tab. Used by search selector and
search pane.
- Parameters:
- repository
- items
- callback
- teamspace
- resultSet
- parameterMap
actionOpenSearchNewTab(repository, items, callback, teamspace, resultSet, parameterMap)
- Parameters:
- repository
- items
- callback
- teamspace
- resultSet
- parameterMap
actionOpenStep(repository, items, callback)
Displays a dialog box that allows the user to open the Content Manager Step Processor.
- Parameters:
- repository
- An ecm.model.Repository object.
- items
- An array of ecm.model.WorkItem objects.
- callback
- A callback function that is called after the items have been edited.
- Since:
- 2.0.2
actionOpenTeamspace(repository, items, callback, teamspace, resultSet, parameterMap)
Opens teamspaces.
- Parameters:
- repository
- An ecm.model.Repository object.
- items
- Array of objects.
- callback
- A callback function that is called after the teamspace is opened.
- teamspace
- Instance of ecm.model.Teamspace.
- resultSet
- Instance of ecm.model.ResultSet.
- parameterMap
actionPreview(repository, items)
Displays the content items in a preview window.
- Parameters:
- repository
- Instance of ecm.model.Repository.
- items
- Content items to view.
actionPrintDoc(repository, items, callback, teamspace, resultSet, parameterMap)
- Parameters:
- repository
- items
- callback
- teamspace
- resultSet
- parameterMap
actionPrintDocAll(repository, items, callback, teamspace, resultSet, parameterMap)
- Parameters:
- repository
- items
- callback
- teamspace
- resultSet
- parameterMap
actionPromoteVersion(repository, items)
- Parameters:
- repository
- items
actionReassign(repository, items, callback)
Displays a dialog that allows the user to select another user to be assigned to the FileNet P8 workflow.
- Parameters:
- repository
- An ecm.model.Repository object.
- items
- An array of ecm.model.WorkItem objects.
- callback
- A callback function that is called after the items have been reassigned to another user.
actionRefreshAttachments(repository, items)
- Parameters:
- repository
- items
- Deprecated:
- This function is no longer used.
actionRefreshGrid(repository, items, callback, teamspace, resultSet)
This refreshes the result set that an item or items are contained within. If no items are provided, it will
refresh the repository. If no repository is provided, it will refresh the desktop.
- Parameters:
- repository
- Instance of ecm.model.Repository.
- items
- Array of items.
- callback
- Callback function.
- teamspace
- Instance of ecm.model.Teamspace.
- resultSet
- An instance of ecm.model.ResultSet representing the result set that this item was obtained from, if any.
actionRefreshInbasket(repository, items)
This refreshes the in-basket result set that an item or items are contained within.
- Parameters:
- repository
- Instance of ecm.model.Repository.
- items
- Array of {@link ecm.model.WorkItem) objects.
actionRemoveFromFolder(repository, items, callback, teamspace, resultSet)
Displays a confirmation dialog box that allows the user to remove items from a folder or to cancel the
action.
- Parameters:
- repository
- Instance of ecm.model.Repository.
- items
- Array of objects.
- callback
- A callback function that is called after the items have been unfiled.
- teamspace
- An instance of ecm.model.Teamspace.
- resultSet
- An instance of ecm.model.ResultSet.
actionRemoveFromMySyncedFiles(repository, items)
Disables a list of items for sync.
- Parameters:
- repository
- Instance of ecm.model.Repository
- items
- An array of ecm.model.Item or ecm.model.Teamspace objects
- Since:
- 2.0.3.5
actionRemoveHold(repository, items)
- Parameters:
- repository
- items
actionRemoveWF(repository, items, callback)
Displays a confirmation dialog that allows the user to remove the Content Manager items from their workflow
or to cancel the action.
- Parameters:
- repository
- An ecm.model.Repository object.
- items
- An array of ecm.model.WorkItem objects.
- callback
- A callback function that is called after the items have been removed.
actionRenameFavorite(repository, items)
Rename the favorite. Shows the rename favorites dialog.
- Parameters:
- repository
- Instance of ecm.model.Repository.
- items
- Array of items. Only the first item is renamed.
actionResponseWF(repository, items, callback, teamspace, resultSet, parameterMap, action)
Makes a call to Content Manager service that will process a running workflow item with a custom response.
- Parameters:
- repository
- A ecm.model.Repository object.
- items
- An array of ecm.model.WorkItem objects.
- callback
- A callback function that is called after the items have been edited.
- teamspace
- A ecm.model.Teamspace object (can be null).
- resultSet
- A ecm.model.ResultSet object (can be null).
- parameterMap
- An array of extra parameters to be passed to the action (can be null).
- action
- A ecm.model.Action object holding the specific action details (including custom response name).
actionResumeWF(repository, items, callback)
Resumes the selected items on their Content Manager workflows (that have been suspended).
- Parameters:
- repository
- An ecm.model.Repository object.
- items
- An array of ecm.model.WorkItem objects.
- callback
- A callback function that is called after the items have been resumed.
actionReturnToSender(repository, items, callback)
Returns the workitem to the sender it originally came from. Does not display any user interface (UI).
- Parameters:
- repository
- An ecm.model.Repository object.
- items
- An array of ecm.model.WorkItem objects.
- callback
- A callback function that is called after the items have been returned to the sender.
actionScheduleAsyncTask(repository, items, callback, teamspace, resultset, parameterMap, action)
Schedules the a new async task by presenting the async task creation dialog.
- Parameters:
- repository
- The authenticating repository associated with this task.
- items
- The array of async tasks to be scheduled
- callback
- The callback function when the scheduling completes.
- teamspace
- Not applicable.
- resultset
- Not applicable
- parameterMap
- Additional parameters passed to this delete function.
- action
- The action which called this function.
actionSearchProperties(repository, items)
- Parameters:
- repository
- items
actionSelectDocumentAttachment(repository, items, callback)
Displays a dialog that allows the user to select a Document object from a repository to be attached to the
current workitem.
- Parameters:
- repository
- A ecm.model.Repository object
- items
- An array of ecm.model.WorkItem objects
- callback
- A callback function called after the item has been selected from the repository. Passes the selected content item as a parameter in the callback function.
actionSelectFolderAttachment(repository, items, callback)
Displays a dialog that allows the user to select a Folder object from a repository to be attached to the
current workitem.
- Parameters:
- repository
- A ecm.model.Repository object
- items
- An array of ecm.model.WorkItem objects
- callback
- A callback function called after the item has been selected from the repository. Passes the selected content item as a parameter in the callback function.
actionSendAllAsPDF(repository, items, callback, teamspace, resultSet, parameterMap, action)
- Parameters:
- repository
- items
- callback
- teamspace
- resultSet
- parameterMap
- action
actionSendAsPDF(repository, items, callback, teamspace, resultSet, parameterMap, action)
- Parameters:
- repository
- items
- callback
- teamspace
- resultSet
- parameterMap
- action
actionSendAttachments(repository, items, callback, teamspace, resultSet, parameterMap, action)
- Parameters:
- repository
- items
- callback
- teamspace
- resultSet
- parameterMap
- action
actionSendAttachmentsAll(repository, items, callback, teamspace, resultSet, parameterMap, action)
- Parameters:
- repository
- items
- callback
- teamspace
- resultSet
- parameterMap
- action
actionSendLinksToDocs(repository, items, callback, teamspace, resultSet, parameterMap, action)
- Parameters:
- repository
- items
- callback
- teamspace
- resultSet
- parameterMap
- action
actionSendLinksToFolders(repository, items, callback, teamspace, resultSet, parameterMap, action)
- Parameters:
- repository
- items
- callback
- teamspace
- resultSet
- parameterMap
- action
actionSendLinksToSearches(repository, items, callback, teamspace, resultSet, parameterMap, action)
- Parameters:
- repository
- items
- callback
- teamspace
- resultSet
- parameterMap
- action
actionShare(repository, items, callback, teamspace, resultSet)
Share the item.
- Parameters:
- repository
- The authenticating repository associated with this task.
- items
- The array of items.
- callback
- teamspace
- resultSet
actionShowHyperlink(repository, items, callback, teamspace, resultSet, parameterMap)
Displays the View Link dialog box.
- Parameters:
- repository
- Instance of ecm.model.Repository.
- items
- callback
- teamspace
- resultSet
- parameterMap
actionStartWF(repository, items, callback)
Displays a dialog box that allows the user to specify the Content Manager workflow properties and then launch
the workflow.
- Parameters:
- repository
- An ecm.model.Repository object.
- items
- An array of ecm.model.WorkItem objects.
- callback
- A callback function called after the items have been started on the workflow.
actionSuspendWF(repository, items, callback)
Displays a dialog that allows the user to specify the Content Manager workflow suspend options and then
suspend the items.
- Parameters:
- repository
- An ecm.model.Repository object.
- items
- An array of ecm.model.WorkItem objects.
- callback
- A callback function that is called after the items have been removed.
actionTrackDownload(repository, items, callback, teamspace, resultSet, parameterMap, action, version)
- Parameters:
- repository
- items
- callback
- teamspace
- resultSet
- parameterMap
- action
- version
actionTransferWorkflow(repository, items, callback)
Displays a dialog that will "transfer" a workflow definitions from a P8 repository.
- Parameters:
- repository
- A ecm.model.Repository object
- items
- A ecm.model.ContentItem object for workflow definition
- callback
- Since:
- 2.0.2
actionUnlock(repository, items, callback, teamspace, resultSet, parameterMap, action)
- Parameters:
- repository
- items
- callback
- teamspace
- resultSet
- parameterMap
- action
actionUnshare(repository, items, callback, teamspace, resultSet, parameterMap, action)
- Parameters:
- repository
- items
- callback
- teamspace
- resultSet
- parameterMap
- action
actionView(repository, items, openUseSelf, teamspace, resultSet, parameterMap, openUseSelf)
Completes the appropriate view action or obtains the appropriate viewer for which to view the input content
items.
- Parameters:
- repository
- Instance of ecm.model.Repository.
- items
- Input content items to view.
- openUseSelf
- - Overloaded, is the action when called from Action.js (the ICN content list). A boolean when called from BookmarkLayout.js indicating whether the document should be opened in a new browser window.
- teamspace
- resultSet
- parameterMap
- openUseSelf
actionViewAnnotation(repository, items, callback, teamspace, resultSet)
- Parameters:
- repository
- items
- callback
- teamspace
- resultSet
actionViewChildDocuments(repository, items, callback, teamspace, resultSet, parameterMap)
- Parameters:
- repository
- items
- callback
- teamspace
- resultSet
- parameterMap
actionViewFullReport(repository, items, openUseSelf, teamspace, resultSet, parameterMap, openUseSelf)
Completes view full report action for line data file
- Parameters:
- repository
- Instance of ecm.model.Repository.
- items
- Input content items to view.
- openUseSelf
- - Overloaded, is the action when called from Action.js (the ICN content list). A boolean when called from BookmarkLayout.js indicating whether the document should be opened in a new browser window.
- teamspace
- resultSet
- parameterMap
- openUseSelf
actionViewProcessInformation(repository, items, callback)
Display a dialog box that shows the selected item process information
- Parameters:
- repository
- A ecm.model.Repository object.
- items
- An array of ecm.model.WorkItem objects.
- callback
- A callback function that is called after the items have been displayed.
- Since:
- 2.0.2
actionViewStep(repository, items, callback)
Opens a browser popup window and renders the selected workflow step processor in that window.
- Parameters:
- repository
- A ecm.model.Repository object
- items
- An array of ecm.model.WorkItem objects, only opens the first item.
- callback
- A callback function.
actionWorkspaceProperties(repository, items, callback, teamspace, resultSet)
- Parameters:
- repository
- items
- callback
- teamspace
- resultSet
downloadUsingAspera(transferSpec)
- Parameters:
- transferSpec