Generate Audit Trail 

 

Function Name: getGenerateAuditTrailXml

 

Class: com.newgen.dmsapi.DMSInputXml

 

Description: This call generates the audit trail information for a given action and it is an Application specific call. The given action may be performed by a user or a group or the action may be related to a dataclass etc. All the actions performed are from the point of view of an application. All the log actions are encapsulated into major Categories. The subordinate actions within each Category are assigned unique Ids.

 

Input Parameters

Sample InputXml

OutPut Parameters

Sample OutputXml

View xml API::NGOGenerateAuditTrail

 

 

Prototype:

public String getGenerateAuditTrailXml (String cabinetName,String userDBId, String actionId,

                 String category, String activeObjectId ,

 String activeObjectType, String subsdiaryObjectId ,

 String subsdiaryObjectType, String comment,

 String currentDateTime, String userIndex)

 

Overloaded functions:

 

public String getGenerateAuditTrailXml(String cabinetName,String userDBId, String actionId,

                                                 String category, String activeObjectId,

 String activeObjectType, String subsdiaryObjectId,

 String subsdiaryObjectType, String comment)

 

Input Parameters description

Name

Description

Valid Values

Default

Values

CabinetName

Name of the cabinet to which the User wants to connect.

 

N/A

UserDBId

UserDatabase ID, which is returned in the NGOConnectCabinet call.

 

N/A

ActionId

Id of the action performed.

 

N/A

Category

Different log actions can be categorized into categories such as Cabinet, Folder, Document etc.

 

N/A

ActiveObjectId

Index of the object on which the specified action is performed.

Integer > 0

 

ActiveObject

Type

Type of the object e.g. F - folder,

D - document,

A – Actionitem etc.

 

N/A

Subsdiary

ObjectId

Id of the Subordinate action performed on the given object.

Integer > 0

 

Subsdiary

ObjectType

Type of the object on which subsidiary action is performed.

 

N/A

Comment

Comments associated with the action performed.

 

N/A

Current

DateTime

Time when the given action is performed

 

N/A

UserIndex

Index of the user for which the log is to be generated.

 

N/A

 

 

Output Parameters:

An inputXmlInputXml string of the NGOGenerateAuditTrail call.