NGOOperateActionItemExt

This call can be used to perform various operations on ActionItem like initiate ActionItem, forward ActionItem, refer ActionItem, and return ActionItem etc. The ActionItem document is added to the FolderIndex specified in the input. Upon initiation the actionitem document is moved to the Inbox of the specified users and rights are assigned on the actionitem document.

Input Parameter description	View sample InputXml
Output Parameter description	View sample OutputXml
Errors and Warnings

Input Parameters description

Name	Parent Tag	Description	Valid Values	Default Values
Option	Root	Unique option for the call	NGOOperate ActionItemExt	N/A
CabinetName	Root	Name of the cabinet to which the User wants to connect.		N/A
UserDBId	Root	UserDatabase ID, which is returned in the NGOConnectCabinet call.		N/A
CurrentDate Time	Root	Indicates the time when the action item is being operated on.		N/A
ActionItem	Root	Contains the actionitems that are to be operated on.		N/A
Document Name	Action Item	Name of the action item document, user has to pass this if document index is not specified.		N/A
Document Index	Action Item	Index of the action item document. If it is not passed then a new document is created by the document name specified in the folder specified by <FolderIndex> tag.	Integer > 0
FolderIndex	Action Item	Folder Index of AI Folder created at the time of action item. This is used when document index is not passed. In that case a new document is created in the specified folder. This is mandatory when user don’t provide document index.	Integer > 0
Document Type	Action Item	Type of the document.	A	N/A
ActionType	Action Item	Type of the ActionItem.		N/A
ActionGroupId	Action Item	Group that is created at the time of ActionItem definition.		N/A
FromUser	Action Item	Index of the Login user.	Integer > 0	N/A
ToUser	Action Item	User index of the target user, to whom the action item will be passed.	Integer > 0	N/A
RightFlag	Action Item	It is a flag, which specifies whether to assign rights to target user on action item document and attachments on action item.	Y - Rights will be assigned N - Rights will not be assigned	N/A
CC	Action Item	User index of the cc user. Reference will be created for action item document to the inbox of specified user.		N/A
Attachments	Action Item	This tag contains all the Attachments.		N/A
Attachment	Attachments	Contains information about attachments of actionitem.		N/A
Objecttype	Attachment	Object Type of the attachment. It can be folder or document.		N/A
ObjectIndex	Attachment	Object index of the attachment. It can be folder or document.		N/A
DataDefinition	Action Item	It contains information about the data class associated with action item document.		N/A
DataDefIndex	Data Definition	Index of the data class associated with the action item document i.e. created at the time of action item creation.		N/A
Fields	Data Definition	It contains information about the fields of data class associated with action item document.		N/A
Field	Fields	It contains information about individual field of the data class.		N/A
IndexId	Field	Index Id of the field.	Integer > 0	N/A
IndexName	Field	Name of the field.		N/A
IndexType	Field	Index type of the field.		N/A
IndexValue	Field	Value of the field.		N/A
DeleteAll References	Action Item	It is a flag, which specifies whether to delete all references or not. In case of completion of action item it is passed as ‘Y’ otherwise it sis passed as ‘N’.	Y or N	N
Untouched	Action Item	It contains information about the untouched reminder.		N/A
Reminder Index	Untouched	Reminder Index of the untouched reminder set at the time of action item creation.		N/A
UserToBe Reminded	Untouched	Index of the user who has to be reminded when the reminder is generated. At the time of initiate reminder index is 0 and it is set when the call is made foe initiate action item.		N/A
ReminderDateTime	Untouched	Data and time of the reminder.		N/A
Message	Untouched	Message to be send when reminder is generated.		N/A
MailFlag	Untouched	Whether the user is to be reminded by mail or not.	Y or N	N
FaxFlag	Untouched	Flag that indicates whether fax will be sent to the user or not.	Y or N	N
ReminderType	Untouched	Type of the reminder. ‘U’ – Untouched. ‘C’ – Completed.	U or C	U
Completed	Action Item	It contains information about the complete alarms.		N/A
Reminder Index	Completed	Reminder Index of the complete reminder set at the time of action item creation. At the time of initiate reminder index is 0 and it is set when the call is made foe initiate action item.		N/A
UserToBe Reminded	Completed	Index of the user who has to be reminded when the reminder is generated.		N/A
ReminderDateTime	Completed	Data and time of the reminder.		N/A
Message	Completed	Message to be send when reminder is generated.		N/A
MailFlag	Completed	Whether the user is to be reminded by mail or not.	Y or N	N
FaxFlag	Completed	Flag that indicates whether fax will be sent to the user or not.	Y or N	N
ReminderType	Completed	Type of the reminder. ‘U’ – Untouched. ‘C’ – Completed.	U or C	U
TrackNumber	Action Item	TrackNumber associated with the actionitem.		N/A
Coordinator	Action Item	Coordinator of the actionitem.		N/A

Output Parameters description

Name	Parent Tag	Description
Option	Root	NGOOperateActionItemExt
Status	Root	Status of the call. If the Status is 0, then the call is successful.
DocumentIndex	Root	Unique index of the action item document.
DataDefinition	Root	Contains information about the data class associated with action item document.
DataDefIndex	Data Definition	Index of the data class associated with action item document.
DataDefName	Data Definition	Name of the data class associated with action item document.
Comment	Data Definition	Comment associated with the data class.
Fields	Data Definition	Contain information about the fields associated with the data class.
Field	Fields	Contains information about individual field of data class.
IndexId	Field	Index of the field.
IndexName	Field	Name of the field.
IndexType	Field	Type of field.
IndexLength	Field	Length of the field.
IndexAttribute	Field	Attribute of field.
Untouched	Root	Contains information about the untouched reminders associated with action item.
ReminderIndex	Untouched	Index of the untouched reminder.
UserToBeReminded	Untouched	Index of the user who has to be reminded when untouched alarm is generated.
ReminderDateTime	Untouched	Date and time of the untouched reminder.
Message	Untouched	Message of the reminder.
MailFlag	Untouched	Flag which indicates whether the user is to be reminded by mail or not.
FaxFlag	Untouched	Flag which indicates whether the user is to be reminded through Fax or not.
ReminderType	Untouched	Type of the reminder.
Completed	Root	Contains information about the complete reminders associated with action item.
ReminderIndex	Completed	Index of the Complete reminder.
UserToBeReminded	Completed	Index of the user who has to be reminded when Complete alarm is generated.
ReminderDateTime	Completed	Date and time of the Complete reminder.
Message	Completed	Message of the reminder.
MailFlag	Completed	Flag which indicates whether the user is to be reminded by mail or not.
FaxFlag	Completed	Flag which indicates whether the user is to be reminded through Fax or not.
ReminderType	Completed	Type of the reminder set.

Errors returned from call

Code	Message	Comments
-50146	Invalid session.	Session corresponding to the UserDBId sent in the call is invalid.
-50006	User account has expired.	The account of the user has expired.
-50010	User not alive.	The user is not alive.
-50125	Cabinet has been locked for Administrative purposes.	The cabinet has been locked by some user for Administrative purposes.
-50154	Data class not associated with document.	The ActionItem Data class is not associated with the actionitem document.
-50074	Invalid parameters.	If the DocumentIndex is Null or the RightFlag or the DeleteAllReference flag is not Y/N.
-50003	User does not exist.	If the Coordinator does not exist in the same group as of the Logged-in user.