EMS Event Type

Programming Guides › Programming Guide for C › Event API Guidance › Event API Reference › EMS Event Type

EMS Event Type

EMS events result from actions performed on directory objects.

SiteMinder calls EMS events when:

Directory objects are created, updated, or deleted
Relationships, such as membership, are formed between objects

After calling an event, SiteMinder logs session activities to the objects. When an EMS-based application, such as Delegated Management Services (DMS), logs in to EMS, a new session is created. EMS validates the login session and reports an appropriate event.

These Directory objects are associated with EMS events:

Users
Roles
Organizations
Generic, or user-defined directory objects

Each of the objects above is associated with the following object events:

Create
Delete
Modify

EMS events are classified according to category:

Administrative events are generated by a user with sufficient privilege to modify objects in a directory.
Session events are generated when a session is initialized or terminated.
End-user events are generated by users who self-register or modify their own user profiles.
Workflow Preprocess events are generated when a workflow preprocess step is complete.
Workflow Postprocess events are generated when a workflow postprocess step is complete.

Event Category	EMS Event
SmLogEmsCat_DirectoryAdmin	SmLogEmsEvent_CreateUser SmLogEmsEvent_DeleteUser SmLogEmsEvent_ModifyUser SmLogEmsEvent_AssignUserRole SmLogEmsEvent_RemoveUserRole SmLogEmsEvent_EnableUser SmLogEmsEvent_DisableUser SmLogEmsEvent_CreateOrg SmLogEmsEvent_DeleteOrg SmLogEmsEvent_ModifyOrg SmLogEmsEvent_CreateRole SmLogEmsEvent_DeleteRole SmLogEmsEvent_ModifyRole SmLogEmsEvent_PasswordModify SmLogEmsEvent_CreateObject SmLogEmsEvent_DeleteObject SmLogEmsEvent_ModifyObject
SmLogEmsCat_DirectoryUser	SmLogEmsEvent_CreateUser SmLogEmsEvent_ModifyUser SmLogEmsEvent_PasswordModify
SmLogEmsCat_DirectorySession	SmLogEmsEvent_Login SmLogEmsEvent_Logout SmLogEmsEvent_LoginFail SmLogEmsEvent_SessionTimeout SmLogEmsEvent_AuthFail

Event Category

EMS Event

SmLogEmsCat_DirectoryAdmin

SmLogEmsEvent_CreateUser

SmLogEmsEvent_DeleteUser

SmLogEmsEvent_ModifyUser

SmLogEmsEvent_AssignUserRole

SmLogEmsEvent_RemoveUserRole

SmLogEmsEvent_EnableUser

SmLogEmsEvent_DisableUser

SmLogEmsEvent_CreateOrg

SmLogEmsEvent_DeleteOrg

SmLogEmsEvent_ModifyOrg

SmLogEmsEvent_CreateRole

SmLogEmsEvent_DeleteRole

SmLogEmsEvent_ModifyRole

SmLogEmsEvent_PasswordModify

SmLogEmsEvent_CreateObject

SmLogEmsEvent_DeleteObject

SmLogEmsEvent_ModifyObject

SmLogEmsCat_DirectoryUser

SmLogEmsEvent_CreateUser

SmLogEmsEvent_ModifyUser

SmLogEmsEvent_PasswordModify

SmLogEmsCat_DirectorySession

SmLogEmsEvent_Login

SmLogEmsEvent_Logout

SmLogEmsEvent_LoginFail

SmLogEmsEvent_SessionTimeout

SmLogEmsEvent_AuthFail

Logging Workflow Events

When a preprocess or postprocess event is handled, the event will be logged. In this case, the category in the log is either SmLogEmsCat_EventPreprocess or SmLogEmsCat_EventPostprocess. The Event ID is the original Event ID (for example, SmLogEmsEvent_CreateUser).

In addition, the following fields of SmLog_EMS_t apply to preprocess and postprocess events:

Field	Description
nVersion	Version number of the SiteMinder server.
nCurrentTime	Time when the event occurred.
szUserName	The name of the administrator who generated the original event.
szSessionId	The EMS session ID.
szDirName	The name of the SiteMinder directory where the target object is located.
szObjPath	Full distinguished name of the object targeted by this event.
szFieldDesc	Name of the workflow library that executed the event.
szStatusMsg	This includes a workflow completion code and an optional error message. The following workflow completion codes are defined in SmApi.h: Sm_DmsWorkflowApi_Success Sm_DmsWorkflowApi_Ignore Sm_DmsWorkflowApi_Failure Sm_DmsWorkflowApi_Reject Sm_DmsWorkflowApi_NoUserContext Sm_DmsWorkflowApi_SkipSuccess

More Information:

SmLog_EMS_t