Review, Markup, and Approval
Online Collaboration Essentials
7
You may also use the
SOAP
object’s
connect
,
request
, and
response
methods to
create customized commenting and review within browser-based workflows. You can do
this by setting up a SOAP-based annotation store on the server using the
Collab
object’s
addAnnotStore
and
setStoreSettings
methods.
The
Collab
object’s
addAnnotStore
method requires three parameters:
cIntName
: The internal name for the annotation store.
cDispName
: The display name for the annotation store.
cStore
: The definition for the new
Collab
store class.
The new
Collab
store class must contain the following definitions for the functions used
to add, delete, update, and enumerate through the array of annotations:
●
enumerate
: Communicates with the Web service to request the array of annotations
stored on the server. It is used when the PDF document is loaded for online review, or
when the user clicks
Upload
or
Send
on the
Commenting Toolbar.
●
complete
: Passes the annotation data to the collaboration server so that it can be
updated.
update
: Uploads new and modified annotations to the server.
The class
SDKSampleSOAPAnnotStore
, as shown in the sample code below, is defined
●
in
sdkSOAPCollabSample.js
in the Acrobat SDK, and contains complete definitions of the
three functions described above.
The sample code below provides a standard example of how to use the
SOAP
and
Collab
objects to customize your online collaborative review. Note that all of the reviewers must
have a copy of the JavaScript collaboration store code. In Acrobat 7.0, the
Custom
collaboration store type allows you to put the JavaScript on the server. The store type used
is
CUSTOM,
and the setting is a URL to the JavaScript file:
// Here is the URL for a SOAP HTTP service:
var mySetting = "http://sampleSite/comments.asmx?WSDL";
// Here is the internal name for the collaborative store:
var myType = "mySOAPCollabSample";
// Set the connection settings for the SOAP collab store:
Collab.setStoreSettings(mySetting, myType);
// Set the default collab store:
Collab.defaultStore = myType;
Acrobat JavaScript Scripting Guide
127