Function Name: getAlarmXml
Class: com.newgen.dmsapi.DMSInputXml
Description: This function is used to generate Alarm Xml.
Prototype:
|
public String getAlarmXml |
( |
|
|
|
|
String alarmType, |
|
|
|
String objectType, |
|
|
|
String objectId, |
|
|
|
String userIndex, |
|
|
|
String actionType, |
|
|
|
String informMode, |
|
|
|
String comment |
|
|
) |
|
|
Name |
Description |
Valid Values |
Default Behaviour |
|
alarmType |
Specifies the type of Alarms that is, System Level Alarms or User Level Alarms. |
U-User Level Alarms S-System Level Alarms |
N/A |
|
objectType |
It indicates type of Object. |
D-Document F-Folder |
D |
|
objectId |
It indicates the Index of the Object for which Alarm is set. |
Integer > 0 |
N/A |
|
userIndex |
The Index of the User for whom Alarm has been set. |
Integer > 0 |
N/A |
|
actionType |
Value, which represents the Action Type for the Alarm.
|
User level Alarms 2 –Document Deleted 3- Document Expired. 5- Document Image changed 6- Document Notes added 8- Document Moved 9- Document Renamed 10- Document Shared 11-Create Document Version 12-Document Checked In 13-Document Checked Out 14-Undo Document Check Out
System level Alarms 1 –Space exhausted. 4- Document Added 7-Back up taken. |
N/A |
|
informMode |
Reserved for internal use. |
Null |
|
|
comment |
The comment associated with the Alarm. |
|
Blank |
Xml forAlarms containing all the Properties of the Alarm.
<Alarm>
<Alarmtype></AlarmType>
<ObjectType></ObjectType>
<ObjectId></ObjectId>
<UserIndex></UserIndex>
<ActionType></ActionType>
<Comment></Comment>
</Alarm>
Function Name: getAlarmXml
Class: com.newgen.dmsapi.DMSInputXml
Description: This function is used to generate Alarm Xml.
Prototype:
|
public String getAlarmXml |
( |
|
|
|
|
String alarmIndex |
|
|
) |
|
Input Parameters:
|
Name |
Description |
Valid Values |
Default Behaviour |
|
alarmIndex |
The unique Index of the Alarm. |
Integer>=0 |
N/A |
Output Parameters:
Xml for Alarms containing Alarm Indexes.
<AlarmIndex>10</AlarmIndex>