Fetch Log

Function Name: getFetchLogXml

Class: com.newgen.dmsapi.DMSInputXml

Description: This function is used to fetch the Log generated for the Objects. The ActionLog List fetches the Log for all the actions performed on the Object. If Log is to be generated for some specific Actions, then List of Action Ids for those particular Actions alone should be sent, else, null should to be sent for actionlog List.User can also specify the particular Group or User who has performed the Action and Objects for which the Log has to be fetched. User can fetch Log either for Groups or Users at a time. If Log for all the Groups and Users is required, then null should be sent.

Input Parameters	Sample InputXML
View xml API::NGOFetchLog	Sample OutputXML

Prototype:

public String getFetchLogXml	(
		String cabinetName, userIndex,
		String actionLogIdList, String groupUserIdList,
		String groupUserFlag, String objectIdList,
		String objectType, String folderIndex ,
		String includeSubFolders, String dateFrom,
		String dateTo, String previousActionIndex,
		String previousAction, String noOfRecordsFetched,
		String totalCountFlag
	)

Input Parameters:

Name	Description	Valid Values	Default Behaviour
CabinetName	Name of the Database Cabinet to which the User wants to connect.		N/A
UserIndex	UserDatabase ID, which is returned after execution of getConnectCabinetXml call		N/A
ActionLogIdList	It contains a List of Ids corresponding to which the Log has to be fetched. It is generated by the function getActionLogId.		For all defined Actions, Log will be generated.
GroupUserIdList	It contains the List of User Id’s belonging to a particular Group. The List is generated by the function getGroupUserIndex.		Log will be for all Groups and Users who has performed the Action.
GroupUserFlag	It specifies whether the call, Fetch Log is for a Group or a User.	G – Group U – User	Log will be for all Groups and Users who has performed the Action.
ObjectIdList	It specifies a List of those Object Indexes for which, the Log has to be fetched. Generated by the function getObjectIndexXml.		For all Objects, Log will be generated.
ObjectType	It specifies the Type of the Objects (whose Indexes are sent in the ObjectIndex tags).	‘C’ –Cabinet ‘F’ - Folder ‘D’ - Document ‘A’ - Annotation ‘T’ – Data Class	For all Objects, Log will be generated.
FolderIndex	Specifies the Index of the Folder in which, the Objects whose Log has to be fetched lies directly or in its subfolders.	Integer > =0	No check for Folder Index.
IncludeSubFolders	Specifies whether the subfolders are to be included or not while fetching the Log.	‘Y’ – Yes ‘N’ – No	Y
DateFrom	Specifies the Date, starting from which, the Log has to be fetched.	Date in yyyy-mm-dd hh:mm:ss format.	No limit for Date. All the Log should be fetched.
DateTo	Specifies the Date up to which the Log has to be fetched.	Date in yyyy-mm-dd hh:mm:ss format.	No limit for date. All the logs should be fetched.
TotalCountFlag	Specifies whether the Total count of Records obtained from the Fetch Log call is required or not.	Y – Total count is required. N – Total count is not required.	N
PreviousActionIndex	This tag is used for fetching Log of actions in batches. It specifies the Index of the last Action in the previous batch. For first batch, value of this field is 0.	Integer >=0	0
PreviousAction	This tag is used for fetching Log of Actions in batches. It specifies the value of the last Action performed in the previous batch on which sorting is done.	Depends upon the sorting parameter of the previous batch.	NULL
NoOfRecordsFetched	It specifies the Total number of Records for the Log that is to be fetched.	Integer > 0	50