In the FileNet Application Integration Add-In architecture, events are handled through the use of an event sink which is responsible for trapping events fired from the infrastructure and routing them to the appropriate event handler. Both the event sink, as well as the event handlers must be implemented by the third-party application.
During command execution, the ExpressAddin component and Application Integration Add-In infrastructure perform operations until information or behavior is required from the third-party application. At that point, events are fired to request the information or behavior from the application. The events are trapped by the event sink and are routed to the corresponding _IExpressAddinEvents interface event handler method. The event handler performs the required action and transfers any requested information back to the ExpressAddin. This process continues until the command has completed execution.
Each FileNet Application Integration command that is supported for use by the ExpressAddin component has a corresponding set of event handlers. For every command that an Add-In application intends to execute, the application must provide these valid event handlers in order to manage the events fired by the command. The Add-In Sample Application demonstrates how to implement the event sink and basic event handlers.
The following table lists the required event handlers for each supported FileNet Application Integration command. The table also describes how the client preference settings are used by the commands, and identifies which portions of the FileNet Workplace GUI are displayed during command execution. (The client preference settings are specified in the bstrPreferencesXml parameter of the IExpressAddin::Startup method.)
Supported Command | Required Event Handlers |
---|---|
|
|
Add Document |
This command requires the same list of event handlers as the Add Document using Add Wizard command. The only difference is that this command displays the FileNet Workplace Add Via Template Wizard to guide the user through the process of adding a document, rather than the Add Wizard. |
Add Folder using Add Folder Wizard |
|
Cancel Checkout |
This command requires the same list of event handlers as the Add Document using Add Wizard command. However, the following differences exist between this command and Add Document using Add Wizard:
|
Checkin Document using Checkin Wizard |
This command requires the same list of event handlers as the Add Document using Add Wizard command. However, the following differences exist between this command and Add Document using Add Wizard:
|
Checkin Document using Quick Checkin |
This command requires the same list of event handlers as the Add Document using Add Wizard command. However, the following differences exist between this command and Add Document using Add Wizard:
|
Get Info |
This command requires the same list of event handlers as the Add Document using Add Wizard command. However, the following differences exist between this command and Add Document using Add Wizard:
|
Logoff | |
Open using My Checkouts |
|
Open using Select Item |
This command requires the same list of event handlers as the Open
using My Checkouts command. However, this command differs from Open
using My Checkouts in that it displays the FileNet Workplace Select Item
(Open) JSP page to display the list of documents available for opening,
rather than the Checkout List JSP page. In addition, this command does
not use the |
Save Document |
This command requires the same list of event handlers as the Add Document using Add Wizard command. However, the following differences exist between this command and Add Document using Add Wizard:
|
Show My Inbox Tasks | |
Insert > Insert a Hyperlink |
|