Modify Reminders

 

Function Name: getModifyReminderXml

 

Class: com.newgen.dmsapi.DMSInputXml

 

Description: This function is used to modify Reminder for a set of Users on an Object. Reminder facility is only supported for document.

 

Input Parameters                                                            Sample InputXML

Output Parameters                                                         Sample OutputXML

View xml API::NGOModifyReminderExt

 

Prototype:

 

public String getModifyReminderXml (

                                                                       String cabinetName,

                                                                       String userDbId,

                                                                       String userIndex,

                                                                       String reminderDateTime,

                                                                       String comment,

                                                                       String documentIndex,

                                                                       String reminderIndex,  

                                                                       String reminderType,

                                                                       String mailFlag,

                                                                       String faxFlag

                                                                   )

 

Overloaded Function :

 

public String getModifyReminderXml (

                                                                       String cabinetName,

                                                                       String userDbId,

                                                                       String userIndex,

                                                                       String reminderDateTime,

                                                                       String comment,

                                                                       String documentIndex

                                                                   )

 

Input Parameters:

 

Name

Description

Valid Values

Default Behavior

cabinetName

Name of the Database Cabinet to which the User wants to connect.

 

N/A

userDbId

UserDatabase ID, which is returned in the ConnectCabinet call.

 

N/A

UserIndex

User index for which the reminder is set.

 

N/A

reminderDateTime

New reminder date time.

 

N/A

Comment

New comments added to the reminder on reminder date time.

 

N/A

DocumentIndex

New document index to be set for the given reminder.

Integer > 0

N/A

reminderIndex

Index of the Reminder to be modified.

 

 

reminderType

New Reminder type to be set for the specified reminder

U’ – Untouched‘C’ - Completed

“u”

MailFlag

This flag indicates whether a mail is to be sent on the stipulated time.

‘Y’ – Yes

‘N’ – No

N

faxFlag

Fax flag associated with the reminder.

‘Y’ – Yes

‘N’ – No

N

 

Output Parameters:

 

An Input Xml for NGOModifyReminderExt.