NGOGenerateAuditTrail

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 Parameter description

View sample InputXml

Output Parameter description

View sample OutputXml

Errors and Warnings

 

 

Input Parameters description

Name

Parent Tag

Description

Valid Values

Default

Values

Option

Root

Unique option for the call

NGOGenerate

AuditTrail

N/A

CabinetName

Root

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

 

N/A

UserDBId

Root

UserDatabase ID, which is returned in the NGOConnectCabinet call.

 

N/A

Action

Root

Parent Tag containing information about each Action Performed.

 

N/A

ActionId

ActionRoot

Id of the action performed.

 

N/A

Category

ActionRoot

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

 

N/A

ActiveObjectId

ActionRoot

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

Integer > 0

 

ActiveObject

Type

ActionRoot

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

D - document,

A – Actionitem etc.

 

N/A

Subsdiary

ObjectId

ActionRoot

Id of the Subordinate action performed on the given object.

Integer > 0

 

Subsdiary

ObjectType

ActionRoot

Type of the object on which subsidiary action is performed.

 

N/A

Comment

ActionRoot

Comments associated with the action performed.

 

N/A

Current

DateTime

ActionRoot

Time when the given action is performed

 

N/A

UserIndex

ActionRoot

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

 

N/A

 

Output Parameters description

Name

Parent Tag

Description

Option

Root

NGOGenerateAuditTrail

Status

Root

Status of the call. If the Status is 0, then the call is successful.

 

Errors returned from call

Code

Message

Comments

-50074

Invalid parameters.

The value for some input parameter is not correct or is invalid.

-50146

Invalid session.

The specified UserDBId is incorrect.

-50006

User account has expired.

The account of the user who attempts to generate the audit trail has expired.

-50010

User not alive.

The user who attempts to generate the audit trail is not alive.

-50125

Cabinet has been locked for Administrative purposes.

The cabinet has been locked by some user for Administrative purposes.