The in-process COM Servers provided in the FileNet® Workplace Application Integration Toolkit are organized into the following three categories:
The Toolkit provides COM interfaces to support client application interaction with the various components. The following table identifies these interfaces.
CAUTION Only the methods discussed in this help
document are guaranteed to be supported by FileNet. Therefore, customers are
recommended to not use any undocumented members of an interface, as they
may be subject to change and/or removal in future releases.
Core Component | Interface | Description |
---|---|---|
AppIntSession | IAppIntSession | Represents a client application logon "session" to FileNet Workplace on which the client application invokes various commands. |
SilentSessionLogin | ISilentSessionLogin | Similar to the SessionLogin component, except it does not present a GUI to the user. |
StdSessionLogin | IStdSessionLogin | Maintains vital state information required for establishing a login session with FileNet Workplace and automatically handles requests for new tokens as they expire. This component also supports the use of unified login. The IStdSessionLogin interface replaces the deprecated ISessionLogin interface. |
Command / Response | Interface(s) | Description |
All Command / Response components |
Standard interfaces automatically used by every Application Integration command. |
|
Add | IAddCmd, IAddRsp |
Custom interfaces which support execution of the Add command. |
AddFolder | IAddFolderCmd, IAddFolderRsp |
Custom interfaces which support execution of the AddFolder command. |
AddViaTemplate | IAddViaTemplateCmd, IAddViaTemplateRsp |
Custom interfaces which support execution of the AddViaTemplate command. |
CancelCheckout | ICancelCheckoutCmd | Custom interface which supports execution of the CancelCheckout command. |
Checkin |
Custom interfaces which support execution of the Checkin command. | |
CheckoutList | ICheckoutListCmd, ICheckoutListRsp |
Custom interfaces which support execution of the CheckoutList command. |
Download | IDownloadCmd,
IDownloadCmd2, IDownloadRsp |
Custom interfaces which support execution of the Download command. |
GetPreferences | IGetPreferencesCmd, IGetPreferencesRsp |
Custom interfaces which support execution of the GetPreferences command. |
IsCheckedOut | IIsCheckedOut, IIsCheckedOutRsp |
Custom interfaces which support execution of the IsCheckedOut command. |
Open | IOpenCmd, IOpenRsp, IOpenRsp2 | Custom interfaces which support execution of the Open command. |
QuickCheckin | IQuickCheckinCmd | Custom interfaces which support execution of the QuickCheckin command. |
SelectEntryTemplate | ISelectEntryTemplateCmd, ISelectEntryTemplateRsp |
Custom interfaces which support execution of the SelectEntryTemplate command. |
SelectObject | ISelectObjectCmd, ISelectObjectCmd2 ISelectObjectRsp |
Custom interfaces which support execution of the SelectObject command. |
SelectProperties | ISelectPropertiesCmd, ISelectPropertiesRsp |
Custom interfaces which support execution of the SelectProperties command. |
ShowProperties | IShowPropertiesCmd | Custom interfaces which support execution of the ShowProperties command. |
Tasks | ITasksCmd, ITasksRsp |
Custom interfaces which support execution of the Tasks command. |
Transport | ITransportCmd, ITransportRsp |
Custom interfaces which support execution of the Transport command. |
Upload | IUploadCmd, IUpdateRsp |
Custom interfaces which support execution of the Upload command. |
Miscellaneous | Interface | Description |
BaseServerURL | IBaseServerURL |
Used to obtain the Application Engine server, port and client application information when initializing the SilentSessionLogin component with the ISilentSessionLogin interface. |
DlgResults | IDlgResults | Used to retrieve the values entered by the user in the File Save As dialog, which is invoked through the IFileSaveAsDlg interface. |
FileSaveAsDlg | IFileSaveAsDlg | Displays a File Save As dialog to prompt the user to specify a destination filename and directory. |
LinkDescriptor | ILinkDescriptor |
Specifies a relationship to establish between the current object store item and previously added items during an Add or AddViaTemplate operation. |
ObjectStoreItem | IObjectStoreItem | Encapsulates an object store item into a simple component for use by a number of command and response components. |
ServletParameter | IServletParameter | Specifies an input parameter name and value for use by the Transport command. |