Class ecm.widget.dialog.StepProcessorWindow

Provides a mechanism that is used to display the IBM FileNet Business Process Manager widget in a separate browser window.
Defined in: <ecm\widget\dialog\StepProcessorWindow.js>.

Constructor Summary

Constructor Attributes	Constructor Name and Description
	ecm.widget.dialog.StepProcessorWindow() Creates a browser pop-up window to render the IBM FileNet P8 Step or Launch processors

Method Summary

Method Attributes	Method Name and Description
	destroy()
	getCurrentItem(item) Returns the ecm.model.WorkItem object that was opened in a browser pop-up window.
	launch(item, callback) Opens the browser pop-up window and renders the Launch processor.
	launchFromEntryTemplate(item, workItem, callback) Launches a workflow definition that has been specified by an entry template.
	launchTransferedWorkflow(item) Gets the launch processor URL information and opens a launch processor for the work item.
	onStepProcessorNewItemLoaded(currentWorkItem, newWorkItem) An event function that is called when the step processor window is loaded with the next work item.
	onStepProcessorWindowCancelled(item, refresh) An event function that is called when the step processor work item window has been cancelled.
	onStepProcessorWindowCompleted(item) An event function that is called when the step processor work item has been dispatched.
	open(item, callback) Opens the browser pop-up window and renders the Step processor.

Constructor Detail

ecm.widget.dialog.StepProcessorWindow()

Creates a browser pop-up window to render the IBM FileNet P8 Step or Launch processors

Method Detail

destroy()

getCurrentItem(item)

Returns the ecm.model.WorkItem object that was opened in a browser pop-up window.

Parameters:
item: A ecm.model.WorkItem object.

Returns:: An {ecm.model.WorkItem} object.

launch(item, callback)

Opens the browser pop-up window and renders the Launch processor.

Parameters:
item: A ecm.model.ContentItem object for the workflow definition to be launched. This can also be a document or folder content item, in which case, it will look for a workflow subscription association to launch. If there are multiple workflow subscriptions, it will display a selection dialog to the user first.
callback: A function to be called after the work item is rendered.

launchFromEntryTemplate(item, workItem, callback)

Launches a workflow definition that has been specified by an entry template.

Parameters:
item: A ecm.model.ContentItem object for the initiating attachment information
workItem: A ecm.modle.WorkItem object to be launched.
callback: A callback function to be called after the workflow has been launched

launchTransferedWorkflow(item)

Gets the launch processor URL information and opens a launch processor for the work item. The work item represents a workflow definition that has been transferred.

Parameters:
item: A ecm.modle.WorkItem object to be launched.

onStepProcessorNewItemLoaded(currentWorkItem, newWorkItem)

An event function that is called when the step processor window is loaded with the next work item.

Parameters:
currentWorkItem: A ecm.model.WorkItem object.
newWorkItem: A ecm.model.WorkItem object.

onStepProcessorWindowCancelled(item, refresh)

An event function that is called when the step processor work item window has been cancelled.

Parameters:
item: A ecm.model.WorkItem object.
refresh: A boolean value. If true, the item is refreshed.

onStepProcessorWindowCompleted(item)

An event function that is called when the step processor work item has been dispatched.

Parameters:
item: A ecm.model.WorkItem object.

open(item, callback)

Opens the browser pop-up window and renders the Step processor.

Parameters:
item: An ecm.model.WorkItem object.
callback: A function to be called after the work item is rendered.