Audit trail events

The following table lists the audit events available in different ImageMaster modules:

Module	Category	Event	Properties	Docu ment	Description
Client
WebClient	search	searchDocuments	query	No	The user has performed a search for documents.
WebClient	read	openDocument		Yes	The user has opened a document.
This can be done in the preview or in the document view.
WebClient	read	openHistory	revisionId	Yes	The user has loaded an earlier version of a document.
WebClient	read	openAttachment	contentKeyOpened fileNameOpened	Yes	The user has opened a document attachment.
WebClient	read	showRetention		Yes	The user has opened the document's retention settings.
WebClient	read	showHolds		Yes	The user has opened the document's legal hold settings.
WebClient	create	createDocument		Yes	The user has created a new document.
WebClient	update	updateDocument		Yes	The user has changed an existing document.
WebClient	delete	deleteDocument		Yes	The user has moved a document to the recycle bin.
WebClient	delete	restoreDocument	documentId	No	The user has restored the document.
WebClient	delete	eraseDocument	documentId	No	The user has erased the document.
WebClient	print	printDocument		Yes	The user has printed a document.
WebClient	export	exportDocument		Yes	The user has exported a document.
WebClient	export	exportHitlist	query	Yes	The user has exported a hit list.
WebClient	update	setHold	holdName	Yes	The user has set a legal hold on a document.
WebClient	update	abortDocumentHold	holdName	Yes	The user has aborted a legal hold on a single document.
WebClient	update	abortHold	holdName eventName	No	The user has aborted a named legal hold.
WebClient	search	getHolds		No	The user has retrieved the list of existing named legal holds.
WebClient	search	processReport	reportName query	No	The user has performed an existing report.
WebClient	search	getAuditTrail	query	No	The user has retrieved the audit trail.
WebClient	export	exportAuditTrail	query	No	The user has exported the audit trail.
WebClient	session	loginSystem		No	The user has logged in successfully.
Possible errors: CLS-00430, CLS-00429, CLS-00204
WebClient	session	changeProfile		No	The user has changed his profile.
WebClient	configuration	updateConfiguration	configurationName configuration	No	The user has updated settings.
The setting is specified in the property “configurationName” which can be one of the following: ArchiveConfiguration, AuditConfiguration, SharePointConfiguration, PasswordCheckerConfiguration, ldap-authentication, SAP_AL_ContentRepositoriesConfiguration, SAP_AL_ContentServerConfiguration, SAP_AL_ImaServerConfiguration, SAP_AL_SystemALConfiguration, SAP_ILM_ContentServerRefConfiguration, SAP_ILM_AuthenticationConfiguration, OperationalClientSettings, LogConfiguration, MimeTypeConfiguration, msxConfig, msxMessageClasses, SearchConnectorConfiguration
WebClient	configuration	createFisProfile	profileName	Yes	The user has created a new FIS profile.
WebClient	configuration	updateFisProfile	profileName	Yes	The user has updated a FIS profile.
WebClient	configuration	deleteFisProfile	profileName	Yes	The user has deleted a FIS profile.
WebClient	configuration	createFisRole	roleId roleName	No	The user has created a FIS access role.
WebClient	configuration	enableTenant	tenantNumber tenantName	No	The user has enabled a tenant.
WebClient	configuration	disableTenant	tenantNumber tenantName	No	The user has disabled a tenant.
WebClient	configuration	renameTenant	tenantNumber tenantName	No	The user has renamed a tenant.
WebClient	administration	updateFulltextIndex	jobId jobName action query	No	The user has processed a new action to re-index documents.
WebClient	configuration	createDocumentType	documentTypeId documentTypeName	No	The user has created a document type.
WebClient	configuration	updateDocumentType	documentTypeId documentTypeName	No	The user has updated a document type.
WebClient	configuration	deleteDocumentType	documentTypeId documentTypeName	No	The user has deleted a document type.
WebClient	configuration	createDocumentTypePresentation	documentTypeId documentTypeName	No	The user has created a document type presentation.
WebClient	configuration	updateDocumentTypePresentation	documentTypeId documentTypeName	No	The user has updated a document type presentation.
WebClient	configuration	deleteDocumentTypePresentation	documentTypeId documentTypeName	No	The user has deleted a document type presentation.
WebClient	authorization	createUser	userName roleName	No	The user has created a new user.
WebClient	authorization	updateUser	userName roleName	No	The user has updated an existing user.
WebClient	authorization	deleteUser	userName roleName	No	The user has deleted a user.
WebClient	authorization	createRole	roleName rights	No	The user has created a role.
WebClient	authorization	updateRole	roleName rights	No	The user has updated a role.
WebClient	authorization	deleteRole	roleName	No	The user has deleted an existing role.
WebClient	authorization	createSecurityKey		No	The user has created a 2-factor authentication key.
WebClient	authorization	changeSecurityKey		No	The user has changed the 2-factor authentication key.
WebClient	authorization	switchOnTwoFactor		No	The user has switched on 2-factor authentication.
WebClient	authorization	switchOffTwoFactor		No	The user has switched off 2-factor authentication.
WebClient	authorization	generateBackupKeys		No	The user has generated new backup keys.
WebClient	administration	assignPolicy	policyName mailboxId	No	The user has assigned a policy to mailboxes.
WebClient	administration	unselectMailboxes	mailboxId	No	The user has unselected mailboxes.
WebClient	administration	unarchiveMailboxes	mailboxId	No	The user has unarchived mailboxes.
WebClient	configuration	configureAuditTrail	configurationName configuration	No	The user has updated the audit configuration.
ImaWebService – Configuration and Administration All events from ImaWebService share these properties: operationName, clientName
ImaWebService	administration	initSystem		Yes	The system is initialized.
Initialization is performed via initSystem or initSearchSystem. Possible error: INS-1000
ImaWebService	authorization	createRole	roleId roleName	No	A role is created.
ImaWebService	authorization	updateRole	roleId roleName	No	A role is modified.
ImaWebService	authorization	deleteRole	roleId roleName	No	A role is deleted.
ImaWebService	configuration	createDocumentType	documentTypeId documentTypeName	No	A document type is created.
ImaWebService	configuration	updateDocumentType	operationName documentTypeId documentTypeName	No	A document type is modified.
ImaWebService	configuration	deleteDocumentType	documentTypeId documentTypeName	No	A document type is deleted.
ImaWebService	configuration	createAttributeType	attributeTypeId attributeTypeName	No	An attribute type is created.
ImaWebService	configuration	updateAttributeType	attributeTypeId attributeTypeName	No	An attribute type is updated (constraints changed).
ImaWebService	configuration	deleteAttributeType	attributeTypeId attributeTypeName	No	An attribute type is deleted.
ImaWebService	configuration	listSystemInfo		No	One of the following operations is executed:
listRoles, getLogCustomization, getProperties, getSystemInfo, listTenants, listAttributeTypes, listDocumentTypes, listConstraintCheckers, listIndices
ImaWebService	configuration	updateConfiguration	configurationName configuration	No	System settings have been updated:
The configuration specified by the “configurationName” property was changed. The configuration is represented as an ImageMaster document of the type “_COMMONS_CONFIGURATION”. A separate event configureAuditTrail is used for the “AuditConfiguration” category.
ImaWebService	administration	updateFulltextErrors	action query jobId jobName	No	The user has updated the full-text error list.
ImaWebService	administration	updateFulltextIndex	action query jobId jobName	No	The user has processed a new action to re-index documents.
ImaWebService	configuration	renameTenant	tenantNumber tenantName	No	A tenant is renamed.
ImaWebService	configuration	enableTenant	tenantNumber tenantName	No	A tenant is enabled.
ImaWebService	configuration	disableTenant	tenantNumber tenantName	No	A tenant is disabled.
ImaWebService	configuration	getTenantOwnership	query	No	The tenant ownership is queried.
ImaWebService	configuration	setTenantOwnership	roleId roleName documentTypeId documentTypeName tenantName	Optional	A tenant ownership is changed for an object:
The properties for name and ID are set if the object is a role or document type. If the object is a document, the document is attached to the event.
ImaWebService	configuration	createFisProfile	profileName	Yes	The user has created a new FIS profile.
ImaWebService	configuration	updateFisProfile	profileName	Yes	The user has updated a FIS profile.
ImaWebService	configuration	deleteFisProfile	profileName	Yes	The user has deleted a FIS profile.
ImaWebService	administration	runJob	jobId jobName	No	The execution of an asynchronous job is triggered via the web service.
ImaWebService	administration	createJob	jobId jobName	No	A new asynchronous job is created.
ImaWebService	administration	updateJob	jobId jobName jobState	No	An asynchronous job is updated.
ImaWebService	administration	deleteJob	jobId jobName	No	An asynchronous job is deleted.
ImaWebService	administration	unlockJob	jobId jobName	No	The concurrency lock on an asynchronous job is manually removed.
ImaWebService		updateSystemPassword	name	No	A system password entry is created or modified.
ImaWebService	configuration	deleteSystemPassword	name	No	A system password entry is created or deleted.
ImaWebService	configuration	changeMasterPassword		No	The master password for the password store is changed.
ImaWebService	configuration	configureAuditTrail	configurationName configuration	No	The audit trail configuration was changed.
In this case configurationName is “AuditConfiguration”. The configuration is represented as an ImageMaster document of the type “_COMMONS_CONFIGURATION”. The “configuration” attribute contains the new audit trail configuration if a configuration is added or updated. It is not defined if the current audit trail configuration is deleted.
ImaWebService – Documents All events from ImaWebService share these properties: operationName, clientName
ImaWebService	create	createDocument	batchId	Yes	A document is created.
ImaWebService	delete	deleteDocument		Yes	A document is moved to recycle bin.
ImaWebService	delete	eraseDocument		Yes	A document is irreversibly deleted.
ImaWebService	delete	restoreDocument		Yes	A document is restored.
ImaWebService	update	deleteRevision	revisionId isLatest	Yes	A revision within the document is deleted.
ImaWebService	update	lockFolder	entryId, name, path	No	A folder is locked.
ImaWebService	update	unlockFolder	entryId, name, path	No	A folder is unlocked.
ImaWebService	read	readDocument		Yes	A document is retrieved through one of the operations getContent, getLatestRevision or getRevision.
ImaWebService	update	checkoutDocument	revisionId	Yes	A document is checked out.
ImaWebService	update	updateDocument	revisionId	Yes	A modified document is checked in.
ImaWebService	update	cancelCheckout		Yes	A document checkout is cancelled.
ImaWebService	search	query	query duration firstHit lastHit	No	A query is executed via the web service.
ImaWebService	create	closeBatch	batchId	No	A batch is closed.
Possible error: BAT-00001
ImaWebService	delete	cancelBatch	batchId	No	A batch is cancelled.
Possible error: BAT-00001 The Integration Service will write an eraseDocument event for each deleted document as part of the cancel operation.
ImaWebService	create	migrateDocument	revisionId recycleBin	Yes	A document is created as part of a migration operation.
ImaWebService	update	migrateRevision	revisionId recycleBin	Yes	A revision is migrated into an existing document.
ImaWebService – Folders All events from ImaWebService share these properties: operationName, clientName
ImaWebService	create	createFolder	entryId name path	No	A new folder is created.
ImaWebService	delete	deleteFolder	entryId name path	No	A folder is deleted.
ImaWebService	update	renameFolder	entryId name path	No	A folder is renamed.
ImaWebService	update	moveFolder	entryId name path	No	A folder is moved.
ImaWebService	update	fileDocument	entryId name path	Yes	A document is placed in a folder.
ImaWebService	update	unfileDocument	entryId name path	Yes	A document is removed from a folder.
ImaWebService	update	renameFiledDocument	entryId name path	Yes	A document that is filed in a folder is renamed.
ImaWebService	update	moveFiledDocument	entryId name path	Yes	A document is moved to a different folder.
ImaWebService	export	exportFolders	path	No	Part of the folder structure is exported via the web service.
ImaWebService – Retention All events from ImaWebService share these properties: operationName, requestOrigin
ImaWebService	update	addPlan	planId planName	Yes	A new retention plan is added to a document via addPlan or addPlanTemplate.
ImaWebService	update	abortPlan	planId planName	Yes	A retention plan is aborted.
ImaWebService	update	removePlan	planId planName	Yes	A retention plan is removed from a document.
ImaWebService	update	setHold	holdId holeName	Yes	A legal hold is added to a document.
ImaWebService	update	abortDocumentHold	holdId holdName	Yes	A hold is aborted on the document.
ImaWebService	update	removeHold	holdId holeName	Yes	A legal hold is removed from a document.
This removes all information about the legal hold from the document.
ImaWebService	configuration	createEvent	eventId eventName isGlobal isPeriodic	No	A new event is defined in the system.
ImaWebService	configuration	deleteEvent	eventId eventName	No	An event is deleted from the system.
ImaWebService	update	signalEvent	eventId eventName	Optional	An event is signaled.
If this is done for a specific document, the document will be associated with the audit trail event.
ImaWebService – ARM All events from ImaWebService share these properties: operationName, clientName
ImaWebService	administration	createRecoveryProcess	archiveId packetSize transactionSize description startTime endTime processId	No	A recovery process was created.
ImaWebService	administration	cancelRecoveryProcess	processId isForced	No	A recovery process was cancelled.
ImaWebService	administration	pauseRecoveryProcess	processId	No	A recovery process was paused.
ImaWebService	administration	purgeRecoveryProcess	processId deleteItemLog deleteProcessLog	No	A recovery process was purged.
ImaWebService	administration	resumeRecoveryProcess	processId	No	A recovery process was resumed.
ImaWebService	administration	scheduleRecoveryProcess	processId startTime	No	A recovery process was scheduled for execution.
ImaWebService	administration	startRecoveryProcess	processId	No	A recovery process was started.
ImaWebService	administration	getRecoveryInfo	processId	No	Information about recovery processes was requested.
ImaWebService – Userlib Note: All events from ImaWebService share these properties: operationName, clientName
ImaWebService	authorization	assignRoles	userId userName roleName	No	New roles are assigned to a user.
ImaWebService	authorization	createUser	userId userName roleName	No	A user is created.
ImaWebService	authorization	updateUser	userId userName	No	A user is updated.
ImaWebService	authorization	deleteUser	userId userName	No	A user is deleted.
ImaWebService	session	resolveUser	userId userName	No	User information is retrieved via the web service.
ImaWebService	session	checkPassword	userId userName	No	A password check is performed.
ImaWebService	session	checkSecurityQandA	userId userName	No	A password question check is performed.
Integration Service
IntegrationService	delete	eraseDocument	batchId	Yes	The IntegrationService erases a document in response to a cancelBatch operation.
IntegrationService	delete	createPrivilegedDeleteRequest	privilegedDeleteReason	Yes	A request for a privileged delete to remove a document is created.
IntegrationService	delete	denyPrivilegedDeleteRequest	privilegedDeleteReasonForDenial	Yes	A request for a privileged delete to remove a document is denied.
IntegrationService	delete	approvePrivilegedDeleteRequest	privilegedDeleteReason	Yes	A request for a privileged delete to remove a document is approved and the document is erased.
Integration Service ARM
ARM	administration	recoveryProcessComplete	processId	No	A recovery process finished running.
Integration Service RetentionManagement
RetentionManagement	update	addPlan	planName planId templateName isHold	Yes	Retention management automatically assigns a plan template to the document.
RetentionManagement	update	liftHold	holdId holeName	Yes	A legal hold on the document is lifted (the legal hold plan reached its end).
RetentionManagement	update	updateAttribute	planName planId attributeName value	Yes	An attribute in the document is updated as part of the execution of a retention plan.
RetentionManagement	update	protectDocument	planName planId tag protectionTime	Yes	A retention plan adds a protection to the document (delete protection, change protection, or a time based delete protection).
RetentionManagement	update	unprotectDocument	planName planId	Yes	A (not time based) protection is removed from the document.
RetentionManagement	delete	deleteDocument	planName planId	Yes	The document is deleted by a retention plan.
RetentionManagement	administration	sendEmail	template subject recipient	Yes	A retention plan on the document sends an e-mail.
SAP Contentserver All events from SAP Contentserver share these properties: sapOperation, issuer, contentRepository
SAP Contentserver	read	getDocumentInformation	sapDocumentId	Yes	Get information of an SAP document.
SAP Contentserver	read	readDocument	sapDocumentId	Yes
SAP Contentserver	create	createDocument	sapDocumentId	Yes	Create an SAP document.
SAP Contentserver	update	appendToContent	sapDocumentId	Yes	Append data to existing content of an SAP document.
SAP Contentserver	update	updateDocument	sapDocumentId	Yes	Update an existing SAP document.
SAP Contentserver	delete	deleteContentOrDocument	sapDocumentId	Yes	Delete an existing SAP document.
SAP Contentserver	search	searchContent	sapDocumentId	Yes	Search in the content of an existing SAP document.
SAP Contentserver	search	searchAttribute	sapDocumentId	Yes	Search in the content of an existing SAP document using printlists.
SAP Contentserver	update	updateCertificate		Yes	Insert a new / update an existing certificate in content server.
SAP Messenger
SAPMessenger	create	registerDocument	sapDocumentId, contentRepository logicalSystem	Yes	Registers an ImageMaster document to SAP.
The registration is done by sending link information to the SAP system. After successful registration the ImageMaster document will be accessible from SAP.
SAP ILM
SAP ILM	read	findProperties		Yes	Get properties of a folder / item.
SAP ILM	update	updateProperties		Yes	Set properties on a folder / item.
SAP ILM	delete	deleteItem		Yes	Delete a folder /item.
SAP ILM	create	createFolder		Yes	Create a folder.
SAP ILM	create	createItem		Yes	Create an item.
SAP ILM	read	readDocument		Yes	Retrieve an item with content.
SAP ILM	read	getDocumentInformation		Yes	Retrieve information of item (content type, modification date).
Postbox
PostboxClient	read	openDocument	postboxId time customerId documentTypeName wkn isin	Yes	User reads the document for the first time.
PostboxClient	read	openFile	postboxId time customerId docType docIdExternal	Yes	User reads the file for the first time.
PostboxClient	update	markRead	postboxId time customerId documentTypeName wkn isin	Yes	User marks the document as read.
PostboxClient	update	archiveDocument	postboxId time customerId documentTypeName wkn isin	Yes	User archives the document.
PostboxClient	delete	deleteDocument	postboxId time customerId documentTypeName wkn isin	Yes	User deletes the document.
PostboxClient	export	exportDocument	postboxId time customerId documentTypeName wkn isin	Yes	User exports the document.
PostboxClient	create	createCorrespondence	postboxId time customerId		User creates a correspondence.
FIS
FIS	delete	sapDelete	businessDocumentId linkDocumentId sapDocumentId contRep requestId operation	Yes	An SAP document is deleted.
Possible error: FIS-00207
Signature Service
Signature Service	create	createTimestamp	contentKey signer hashAlgorithm	Yes	A timestamp signature is created for a new content object.
Signature Service	update	refreshTimestamp	contentKey signer hashAlgorithm	Yes	A timestamp signature is (re-)created for a content object that was modified.
Signature Service	read	verifyTimestamp	contentKey validityStatus validityMessage	Yes	A timestamp signature was verified via an explicit request.
Signature Service	create	storeHashDigests	contentKey hashRefId hashAlgorithm	Yes	One or more hash digests are stored in the hash tree for long-term evidence preservation.
Signature Service	read	getEvidenceRecord	contentKey hashRefId	Yes	An evidence record is retrieved for a content object.
Signature Service	configuration	loadedCustomerTrustlist	subject issuerAndSerial x509certificate	No	The customer trust list was loaded:
The trust list was used to create the trust anchor. From this point on, the services defined in the customer trust list are considered trustworthy.
Workflow
WorkflowService	update	startWorkflow	processKey processName	Yes	A workflow is started for the document.
WorkflowService	update	finishWorkflow	processKey processName	Yes	A workflow for the document has been finished.
WorkflowService	update	completeTask	processKey processName taskName formAction	Yes	A user has completed a workflow task.