This
transaction is used to Set Annotations on the document. The Annotation Groups
sent in the call will be final and will overwrite all the previous Annotations
on that page of the document. This call can also be used for a particular Version.
This call accepts a parameter deleteothergroups that specifies the operation
to be done on Remaining Annotation Groups of the document but not mentioned in
the list of Annotation Index passed to the call. If the User passes A in
deleteothergroups tag then Annotaion Groups of type A that are not passed in
the list of indexes will be deleted. If the User passes null for
deleteothergroups tag then all remaining Annotations will be retained and if
N is passed then remaining Annotation of type N will be deleted. Whenever
Annotation is set and if AutoVersioning for that document is Y and
SuppAutoVersionFlag is passed as N then a new Version of the document is
created
|
|
|
Name |
Parent Tag |
Description |
Valid Values |
Default Values |
|
Option |
Root |
Unique option for the call. |
NGOSet Annotations |
N/A |
|
CabinetName |
Root |
Name of the Cabinet to which the User
wants to connect. |
Name of the cabinet |
N/A |
|
UserDBId |
Root |
UserDatabase ID that is returned in the NGOConnect Cabinet call. |
|
N/A |
|
DocumentIndex |
Root |
Unique Index of the document. |
Integer >= 0 |
N/A |
|
LimitCount |
Root |
The number of Versions to limit. |
Integer >= 0 |
No check is done on limit of Annotations. |
|
VersionNo |
Root |
The Version of the document on which the Annotation is to
be set. |
X .Y where X>=1 and Y>=0 |
Current Version |
|
SupAutoVersion |
Root |
To suppress auto Versioning to stop from creating a new
Document Version. |
N No Y Yes |
N |
|
SupAnnot Version |
Root |
Flag that specifies whether to suppress carry forwarding
of Annotations with the new Versions of document. |
N No Y Yes |
N |
|
DeleteOther Groups |
Root |
Specifies what has to be done with previous Annotation
Groups that are not passed in the Annotation Group list. |
A Image Annotation. N Notes B Both Image and Notes. NULL - No Annotation is to be deleted. |
NULL |
|
Annotation Groups |
Root |
Contains the Annotation Groups. |
|
N/A |
|
AnnotationGroup |
Annotation Groups |
The Annotation Group that is to be set. |
|
N/A |
|
AccessType |
Annotation Group |
The type of Access on Annotation S, I, P. |
S shared I inherited P private |
I |
|
AnnotGroup Index |
Annotation Group |
The Group Index of the Annotation Group. |
Integer>=0 |
N/A |
|
AnnotationType |
Annotation Group |
Type of Annotation, Image or Text. |
A Image and text Annotations. N - text Annotation (Notes). |
N/A |
|
AnnotGroup Name |
Annotation Group |
The name of the Annotation Group. |
The name of Annotation Group. |
Default |
|
CreationDate Time |
Annotation Group |
The Date and Time at which the Annotation is being
created. |
Valid Date in the format- yyyy-mm-dd hh:mm:ss |
Current Date and Time |
|
AnnotationBuffer |
Annotation |
The Annotation data. |
The Annotation data in Annotation format. |
NULL |
|
FinalizedFlag |
Annotation Group |
Whether the Annotation Group has to be finalized or not. |
Y yes and N no |
Y |
|
Name |
Parent Tag |
Description |
|
Option |
Root |
Unique Option for the Call. |
|
Status |
Root |
Status of the call. If it is 0 then call is successful. |
|
AnnotationGroups |
Root |
Contains the Annotation Groups that have been set. |
|
AnnotationGroup |
Annotation Groups |
Contains the Annotations. |
|
AccessType |
Annotation Group |
Type of Access on the Annotation Group added. P private I inherited S - shared |
|
AnnotGroupIndex |
Annotation Group |
The Annotation Group Index of the Annotation Group that
has been added. |
|
AnnotationType |
Annotation Group |
Type of Annotation. If no value is returned then the
Annotations are Image Annotations else if
N is returned then it is Text Annotation (notes). |
|
PageNo |
Annotation Group |
The page number on which the Annotation Group has been
added. |
|
AnnotGroupName |
Annotation Group |
The name of the added Annotation Group. |
|
CreationDateTime |
Annotation Group |
The creation Date and Time of the added Annotation Group. |
|
LoginUserRights |
Annotation Group |
The Rights of the logged in User. |
|
Owner |
Annotation Group |
The name of the Owner of the added Annotation Group. |
|
RevisedDateTime |
Annotation Group |
The Date and Time at which the Annotation Group was last
changed. |
|
FinalizedFlag |
Annotation Group |
Whether the Annotation Group has been finalized or not. Y yes and N no |
|
FinalizedDateTime |
Annotation Group |
The Date and Time at which the Annotation Group was
finalized. |
|
FinalizedBy |
Annotation Group |
The User Index of the User who finalized the Annotation
Group. |
|
FinalizedByUser |
Annotation Group |
The name of the User who finalized the Annotation Group. |
|
FailedAnnotations |
Root |
Contains information about the Annotations that could not be set. |
|
FailedAnnotation |
Failed Annotations |
Contains information about a particular Annotation that could not be set. |
|
AnnotationIndex |
Failed Annotation |
Index of Annotation that could not be set. |
|
StatusCode |
Failed Annotation |
The Error Code returned. |
|
Flag |
Failed Annotation |
M When Annotation could not be set. |
|
Code |
Message |
Comments |
|
-50025 |
Document
not found. |
Document
with the specified Document Index does not exist. |
|
-50071 |
Document
has been checked out. |
The
specified document has been checked out. |
|
-50022 |
Insufficient
rights for the current operation. |
The
logged in User does not possess sufficient Rights to add Annotations to the
document. |
|
-50076 |
Invalid
object access type. |
This
exception occurs when any value other than S, P and I were given as input for
access type. |
|
-50074 |
Invalid
parameters. |
This
exception is raised when User wants to finalize Annotation and specify
invalid value for FinalizedFlag. |
|
-50174 |
Limit on
number of Versions exceeded. |
This
exception can come when AutoVersioning is set for the document and User has
specified suppautoVersionNing as N, in that case a new Version is created
for the document and while creating Version if limit on number of Versions
exceeded. |
|
-50132 |
Document
has been deleted. |
Document
has been deleted from the System |
|
-50026 |
Document
is in use. |
Document
is locked by some other User. |
|
-50027 |
Properties
of the Document have been finalized. |
Properties
of the document has been finalized |
|
-50053 |
Check
rights failed. |
Check
Rights operation failed internally |
Warnings returned
from call
|
Code |
Message |
Comments |
|
50020 |
Not all Annotations modified or deleted |
Not able to set all Annotations. |
Codes returned in the
form of status code
|
Code |
Message |
Comments |
|
-50183 |
Object has been Finalized. |
Annotation has been finalized. |
|
-50061 |
Insufficient rights for current operation. |
User has insufficient Rights on Annotation. |
|
-50090 |
Annotation with the same name already exists. |
Annotation with the same name already exists. |
|
-50034 |
Annotation not found. |
Specified Annotation not found in the System. |