NGOOperateActionItem

This call can be used to perform various operations on ActionItem like initiate ActionItem, forward ActionItem, refer ActionItem, and return ActionItem etc. This transaction add new operate ActionItem document or files the reference of existing document in the inboxes of the users specified in the list and also sends reminders to the given users. The user should supply either the Document Index or Document Name. If document index is not passed then a new document is created as required in case of initiation action item. RightFlag is user to indicate whether the rights are to be assigned to user or not on attachments and action item document. DeletallReference flag is passed to indicate whether to delete all existing references of document. There are two types of reminder that can be set for an action item. They are

Untouched- reminder is generated when an action item remains untouched for some specified time defined at the time of creation of action item.

Completed- reminder is generated when an action item is not completed among the time defined at the time of creation of action item.

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 ActionItem	N/A
CabinetName	Root	Name of the Database cabinet to which user wants to connect.	The name of the cabinet.	N/A
UserDBId	Root	UserDatabse ID, which is returned in the NGOConnect Cabinet call		N/A
Current DateTime	Root	Date and time when the given operation is being performed.
FolderIndex	Root	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
ActionGroupId	Root	Group that is created at the time of ActionItem definition
ActionItem	Root	Parent Tag containing information about the Action Item.		N/A
DocumentIndex	ActionItem	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.
DocumentName	ActionItem	Name of the action item document, user has to pass this if document index is not specified
DocumentType	ActionItem	Type of the Document	A
FromUser	ActionItem	Index of the user who is passing the action item to the given users.
ToUser	ActionItem	User index of the target user, to whom the action item will be passed.
RightFlag	ActionItem	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
Cc	ActionItem	User index of the cc user. Reference will be created for action item document to the inbox of specified user
AttachmentIds	ActionItem	It is an outer tag which contains information about the attachments of action item		N/A
ObjectIndex	AttachmentIds	Object index of the attachment. It can be folder or document.
DataDefinition	ActionItem	It contains information about the data class associate with action item document.		N/A
DataDefIndex	DataDefinition	Index of the data class associated with the action item document i.e. created at the time of action item creation
Fields	DataDefinition	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
IndexType	Field	Index type of the field
Indexvalue	Field	Value of the field
Untouched	ActionItem	It contains information about the untouched alarms		N/A
ReminderIndex	Untouched	Reminder Index of the untouched alarm set at the time of action item creation
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.
ReminderDate Time	Untouched	Data and time of the reminder
Message	Untouched	Message to be send when reminder is generated
Completed	Untouched	It contains information about the complete alarms
ReminderIndex	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.
UsertoBe Reminded	Completed	Index of the user who has to be reminded when the reminder is generated
ReminderDate Time	Completed	Data and time of the reminder
Message	Completed	Message to be send when reminder is generated
DeleteAll References	Root	It is a flag, which specifies whether to deleteallreferences or not. In case of completion of action item it is passed as “Y” otherwise it sis passed as “N”

Output Parameters description

Name	Parent Tag	Description
Option	Root	NGOOperateActionItem
Status	Root	Status of the call. If 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 associate with action item document
DataDefName	~~Data~~ ~~Definition~~Fields	Name of the data class. It is actually same as name of the action item
~~Comment~~DataDefIndex	~~Data~~ ~~Definition~~Fields	~~Comments associated with data class.~~Index of the data class associated with the Action Item.
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
IndexType	Field	Type of field
IndexName	Field	Name of the 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
Completed	Completed	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

Errors returned from call

Code	Message	Comments
-50017	Folder not found.	Folder specified in input does not exist in the system
-50154	Data class not associated with document.	Data class specified in the input is not associated with the document index specified. this error is not raised in case of initiate action item as document is created at that time.
-50003	User does not exist	This exception is thrown when Specified to user does not exist in the system.