WFSetReminder

This call allows setting reminders to the user, for processing workitems. You can view the XML input and output parameters, which have to be passed for setting reminder . There is a list of errors and warning that can occur in the execution.

 

Input Parameter description

 View Sample InputXML

Output Parameter description

 View Sample OutputXML

Errors and Warnings

 View Sample Code

 

Input Parameter description

* implies for the mandatory parameter.

Name

Parent Tag

Description

Valid Value

Option *

Root

It refers to the case sensitive call name.

case sensitive call name.

EngineName *

Root

It is the cabinet or database name, which has to be connected.

NA

SessionID *

Root

It is the logged in user session id

NA

UserIndex *

Reminder

It is the user id to whom the reminder has to be sent

NA

ReminderDateTime*

Reminder

It is the reminder date \time on which the reminder has to be sent

NA

Comment

Reminder

It is the message which can be sent with reminder

NA

UserType

Reminder

It is the user type to whom the reminder is sent

NA

ProcessInstanceId

Reminder

It is the process instances id for which the reminder has to be sent

NA

WorkItemId

Reminder

It is the workitem id for which the reminder has to be sent

NA

Operation

Root

It is the operation specified for the workitem

"I" for insert and "D" for delete

UserType

Reminder

It is the user type to whom the reminder is sent

U-User

G-Group

RemIndex

Reminder

Index of reminder. To be given if Operation type is ‘D’

 

 

Output Parameter description

Name

Parent Tag

Description

Option

Root

It refers to the case sensitive call name.

MainCode

Exception

Error code specified by WAPI.

 

Errors and Warnings

Code

Constant Value

Message

11

WM_INVALID_SESSION_HANDLE

Invalid session