You can access the IBM Lotus Quickr Java API by creating
a well-formed XML document and running it against the Lotus Quickr processor
from the operating system command line or Lotus Domino server console.
1. With a text editor, create
a new XML document, add the desired well-formed XML, and save the document
as an .xml file.
2. Perform one of the following
steps to process the XML:
- From an operating system command prompt, navigate to the
domino_server_root\jvm\bin directory and enter the following command:
java com.lotus.quickplace.api.QPAPI arguments
- From the Lotus Domino server console, enter the following
load java com.lotus.quickplace.api.QPAPI arguments
are arguments described in the following list.
Specifies the XML file to execute.
XML output document created by Lotus Quickr which contains
processed output and status codes. If you do not specify an output file,
the file is stdout.xml.
The name of the well-formed XML document used by Lotus
Quickr during a search to determine the identity of the user performing
the search. This document is required as input when accessing the API to
search the Lotus Quickr service.
For example, to search for the word "SSL" in
the service, you must specify the user who is performing the search. For
example, "cn=John Smith,o=IBM". The search returns documents
that John Smith has access to that contain the word "SSL."
The command is processed by the Lotus Quickr processor,
and the QPAPI.process() method is invoked to process the XML. The Java
runtime environment you installed is responsible for executing the QPAPI
Return to the Java
API overview and index.