This
call allows the user to divert all the
documents from its Inbox with a particular datadefinition attached to them for
a specified period of time to some other users’ inbox. This call is generally
used to divert action item to other users, in case if a user is not available.
|
Name |
Parent Tag |
Description |
Valid Values |
Default Values |
Option |
Root |
Unique option for the call |
NGOSetDivert |
N/A |
CabinetName |
Root |
Name of the Database cabinet to which user wants to connect. |
|
N/A |
UserDBId |
Root |
UserDatabse ID, which is returned in the NGOConnect Cabinet call |
|
N/A |
DivertAction |
Root |
It is an outer tag, which contains the complete information about the
objects on which the transaction is to be performed. It contains the
information about the datadefinition, which is required to be attached with
the documents and the user for which the documents are to be moved and the
period for which action should occur. |
|
|
UserIndex |
DivertAction |
Index of the user for which any new documents added to its Inbox and
has the given data class attached to it are to be moved to some other user’s
Inbox. |
|
|
DataDefIndex |
DivertAction |
Index of the data definition, which should be attached with the
document, which is added to a user’s Inbox so as to divert the document to
some other user’s Inbox. |
|
|
DivertedUser Index |
DivertAction |
Index of the user to whose Inbox documents are to be diverted |
|
|
DurationFlag |
DivertAction |
Flag, which specifies whether there is some specific period for which
the diversion action is to be performed. |
Y – Diversion is to be performed for a specific period N – No period is specified i.e. the diversion of documents will take
place for indefinite period |
|
FromDate |
DivertAction |
Date from which the diversion of documents will start. |
|
|
ToDate |
DivertAction |
Date upto, which the diversion of documents is to be done. |
|
|
IncludeCurrent |
DivertAction |
Flag, which specifies whether the documents currently in the Inbox of
the user whose inbox documents are to be diverted are also to be moved to the
inbox of the user to whom the documents will be diverted. |
Y – Documents currently in inbox are also to be diverted. N – Documents currently in inbox are not to be diverted. |
|
LeaveCopy |
DivertAction |
Flag, which specifies whether the copy of the documents diverted is to
be kept with the user whose documents, are to be diverted. |
Y – Copy of the documents to be diverted is also to be made in the
inbox of the user whose documents are diverted. N – Copy of the documents to be diverted is not to be made in the inbox
of the user whose documents are diverted. |
|
Confidential |
DivertAction |
Not Used |
|
|
InformByEmail |
DivertAction |
Flag, which specifies whether to inform the diverted user by mail
whenever any ActionItem is diverted to him |
Y- Inform diverted user by mail N – Do not inform diverted user by mail |
N |
Name |
Parent Tag |
Description |
Option |
Root |
Unique option for the call |
Status |
Root |
Status of the call. If Status is 0 then the call is successful |