This is a chart describing each event:
Event | Triggering Moment | Event Handler Name | Scope | Description |
|---|---|---|---|---|
Add Users to Group | After | AddedUsersToGroupEvent | Global Event | Represents the event raised after users are added to a group. Parameters include group ID and list of user IDs. Example usage: Send an email notification to each of the users that they have been added to the user group. |
Add Users to Group | Before | AddingUsersToGroupEvent | Global Event | Represents the event raised before users are added to a group. Parameters include group ID and list of user IDs. Example usage: Implement a validation logic if each users should be added to the user group. |
Create Contact | After | CreatedContactEvent | Global Event | Represents the event raised after contact is created. Parameters include contact object and updated contact fields. |
Create Contact | Before | CreatingContactEvent | Global Event | Represents the event raised before contact is created. Parameters include contact object. Example usage: Implement validation logic if the contact should be created. |
Create User | After | CreatedUserEvent | Global Event | Represents the event raised after user is created. Parameters include user object. Example usage: Send an email notification to the user. |
Create User | Before | CreatingUserEvent | Global Event | Represents the event raised before user is created. Parameters include user object. Example usage: Implement validation logic if the user should be created. |
Remove Users from Group | After | RemovedUsersFromGroupEvent | Global Event | Represents the event raised after users are removed from a user group. Parameters include group ID and list of removed user IDs. Example usage: Send email notification to each of the removed users that they have been removed from the user group. |
Remove Users from Group | Before | RemovingUsersFromGroupEvent | Global Event | Represents the event raised before users are removed from a user group. Parameters include group ID and list of to-be-removed user IDs. Example usage: Implement validation logic if each user should be allowed to be removed from the user group. |
Update Contact | After | UpdatedContactEvent | Global Event | Represents the event raised after contact is updated. Parameters include contact object and updated contact fields. Example usage: Send a verification email to the contact that the contact information has been updated. |
Update Contact | Before | UpdatingContactEvent | Global Event | Represents the event raised before contact is updated. Parameters include contact object. Example usage: Implement validation logic if the contact should be allowed for update. |
Update User | After | UpdatedUserEvent | Global Event | Represents the event raised after user is updated. Parameters include old user object and updated user object. Example usage: Send an email notification to the user that the user information has been updated. |
Update User | Before | UpdatingUserEvent | Global Event | Represents the event raised before user is updated. Parameters include old user object and updated user object. Example usage: Implement validation logic if the user is allowed for update. |
Abort Case | After | AbortedCaseEvent | Case Event | Represents the event raised after case is aborted. Parameters include folder ID and casetype ID. Example usage: Notify a user on the folder status via email after case got aborted. |
Abort Case | Before | AbortingCaseEvent | Case Event | Represents the event raised before case is aborted. Parameters include folder Id and casetype ID. Example usage: Validate against case folder information if the case should be aborted. |
Accept Work Item | After | AcceptedWorkitemEvent | Case Event | Represents the event raised after the task is accepted by the assignee. Parameters include folder ID, casetype ID, process ID, and work item ID. Example usage: Modify case folder field information with assignee's user information. |
Add Attachment | After | AddedAttachmentEvent | Case Event | Represents the event raised after an attachment is added to a case. Parameters include folder ID, casetype ID, attachment type ID, attachment name, and attachment GUID. Example usage: Insert a MVAL record into a record group in a case folder that contains information about all attachments in the case folder. |
Add Attachment | Before | AddingAttachmentEvent | Case Event | Represents the event raised before an attachment is added to a case. Parameters include folder ID, casetype ID, attachment type ID, and attachment name Example usage: Implement a validation logic if the attachment should be saved. |
Add User to Team Role | After | AddedUserToTeamRoleEvent | Case Event | Represents the event raised after a user is added to a team role. Parameters include folder ID, casetype ID, role ID, user ID Example usage: Update folder assignments after a user has been added to team role. |
Add User to Team Role | Before | AddingUserToTeamRoleEvent | Case Event | Represents the event raised before adding an user to team role Parameters include folder ID, casetype ID, role ID, user ID Example usage: Implement a validation logic if logged in user has permission to add a user to the team role. |
Assign Activity | Before | AssigningActivityEvent | Case Event | Represents the event raised before the activity is being assigned to a user Parameters include folder ID, casetype ID, rolde ID, assigneeID, assignee type, adhoc role name, adhoc activity name Example usage: Implement a validation logic if activity should be assigned to the user. |
Assign Work Item | After | AssignedWorkitemEvent | Case Event | Represents the event raised after the task is assigned to a user Parameters include folder ID, casetype ID, process ID, and work item ID. Example usage: Update case folder field information on newly assigned user. |
Change Action Office | After | ChangedActionOfficeEvent | Case Event | Represents the event raised after the action office or initiating office is changed. Parameters include folder reference object and old office ID Example usage: Change folder owner or folder assignment based on the changed office. |
Change Action Office | Before | ChangingActionOfficeEvent | Case Event | Represents the event raised before the action office or initiating office is changed. Parameters include folder reference object and new office ID Example usage: Implement a validation logic if current office should be changed to the new office. |
Change Filing Structure | After | ChangedFilingStructureEvent | Case Event | Represents the event raised after a filing structure is changed. Parameters include folder reference object and old filing structure ID. |
Change Filing Structure | Before | ChangingFilingStructureEvent | Case Event | Represents the event raised before a filing structure is changed. Parameters include folder reference object and old filing structure ID. |
Change Folder Number | After | ChangedFolderNumberEvent | Case Event | Represents the event raised after the folder number is changed. Parameters include folder reference object and old folder number. Example usage: Update case folder field information regarding the changed folder number. |
Change Folder Number | Before | ChangingFolderNumberEvent | Case Event | Represents the event raised before the folder number is changed Parameters include folder reference object and new folder number. Example usage: Implement a validation logic if new folder number already exists. |
Change Folder Owner | After | ChangedFolderOwnerEvent | Case Event | Represents the event raised after the folder owner is changed. Parameters include folder reference object and old folder owner ID. Example usage: Update folder team roles and assignments based on the changed folder owner. |
Change Folder Owner | Before | ChangingFolderOwnerEvent | Case Event | Represents the event raised before the folder owner is changed. Parameters include folder reference object and new folder owner ID. Example usage: Implement a validation logic if new folder owner should be allowed. |
Change Responsible Office | After | ChangedResponsibleOfficeEvent | Case Event | Represents the event raised after the responsible office is changed. Parameters include folder reference object and old office ID. Example usage: Implement update logic to modify case information accordingly based on the changed responsible office. |
Change Responsible Office | Before | ChangingResponsibleOfficeEvent | Case Event | Represents the event raised before the responsible office is changed. Parameters include folder reference object and new office ID. Example usage: Implement a validation logic if the responsible office should be changed. |
Check-out/ Check-in Attachment | After | EditedAttachmentEvent | Case Event | Represents the event raised after a case attachment (document) is checked out/checked in. Parameters include folder ID, casetype ID, and attachment object. Example usage: Send an email notification to folder owner that the attachment has been checked out. |
Check-out/ Check-in Attachment | Before | EditingAttachmentEvent | Case Event | Represents the event raised before Check out/Check in of attachment in a case. Parameters include folder ID, casetype ID, and attachment object. Example usage: Implement a validation logic if the attachment should be allowed to be checked out. |
Close Case | After | ClosedCaseEvent | Case Event | Represents the event raised after the case is closed. Parameters include folder ID and casetype ID. Example usage: Implement an update logic to modify case information after case is closed. |
Close Case | Before | ClosingCaseEvent | Case Event | Represents the event raised before the case is closed Parameters include folder ID and casetype ID. Example usage: Implement a validation logic if the case should be allowed to close. |
Complete Activity | After | CompletedActivityEvent | Case Event | Represents the event raised after the activity is completed. Parameters include folder ID, casetype ID, process ID, and activity ID. Example usage: Send a notification to users in team role. |
Complete Work Item | After | CompletedWorkitemEvent | Case Event | Represents the event raised after the work item is completed. Parameters include folder ID, casetype ID, process ID, and work item ID. Example usage: Send a notification to users in team role. |
Complete Work Item | Before | CompletingWorkitemEvent | Case Event | Represents the event raised before the work item is completed. Parameters include folder ID, casetype ID, and work item ID. Example usage: Implement a validation logic if the work item should be completed. |
Create Case | After | CreatedCaseEvent | Case Event | Represents the event raised after a new case is created. Parameters include folder ID and casetype ID. Example usage: Add/Remove team role assignments or send email notification, etc. |
Create Case | Before | CreatingCaseEvent | Case Event | Represents the event raised before case is created. Parameters include case folder object. Example usage: Implement validation logic for the case or pre-populate case information before it gets created. |
Create Case | Init | InitCreatingNewCaseEvent | Case Event | Represents the event raised before showing the user interface to create a new case folder. Parameters include case type ID, custom case data to be used for new folder, parent folder ID. Example usage: Pre-populate case information before the new case folder gets shown to user. |
Delegate Work Item | After | DelegatedWorkitemEvent | Case Event | Represents the event raised when the work item is delegated to another user. Parameters include folder ID, casetype ID, process ID, work item ID, and new work item ID. Example usage: Implement logic to update user roles and/or add/remove users from roles. |
Delete Attachment | After | DeletedAttachmentEvent | Case Event | Represents the event raised after a case attachment (document) is deleted. Parameters include folder ID, casetype ID and attachment object. Example usage: Update folder case field information on attachments. |
Delete Attachment | Before | DeletingAttachmentEvent | Case Event | Represents the event raised before a case attachment (document) is deleted. Parameters include folder ID, casetype ID and attachment object. Example usage: Implement validation logic to check if the currently logged in user has permission to delete the attachment. |
Delete Case | After | DeletedCaseEvent | Case Event | Represents the event raised after the case is deleted. Parameters include folder object. Example usage: Send an email to the team role users that the case has been deleted. |
Delete Case | Before | DeletingCaseEvent | Case Event | Represents the event raised before the case is deleted. Parameters include folder ID and casetype ID. Example usage: Implement validation logic to check if the currently logged in user has permission to delete the case folder. |
Execute Business Action | Execute | ExecuteBusinessActionEvent | Case Event | Represents the event raised when a form is submitted with an Action Verb. Parameters include folder object and business action arguments object. |
Execute Business Action | After | ExecutedBusinessActionEvent | Case Event | Represents the event raised after case action is processed by eCASE and workflow runtime. Parameters include business action arguments object. |
Generate Case Number | Init | GenerateFolderNumberEvent | Case Event | Represents the event raised before generating custom case number for a case. Parameters include data dictionary, parent folder ID, casetype object, office ID, and default group name. Example usage: Implement a logic to update case folder number |
Get InfoPath Item Picker List | Init | GetItemPickerListEvent | Case Event | Represents the event raised by infopath itempicker to customize the list of values for item picker. Parameters include folder ID, casetype ID, itempicker list name, search token, and max rows count. |
Get Item Picker List | Init | GetListEvent | Case Event | Represents the event raised by itempicker to obtain the customized list of values. Parameters include folder ID, casetype ID, arguments for loading list, and arguments for filtering list items. |
Init Toolbar Case Actions | Init | InitBusinessActionsEvent | Case Event | Represents the event raised to build the list of business actions for the folder and the user role. Parameters include folder object, user ID and role name. |
Lock Case | After | ChangedCaseLockEvent | Case Event | Represents the event raised after a case is locked/unlocked. Parameters include folder ID, casetype ID and flag if case event is raised for lock. Example usage: Implement update logic to case folder information when case is locked/unlocked. |
Lock Case | Before | ChangingCaseLockEvent | Case Event | Represents the event raised before a case is locked/unlocked. Parameters include folder ID, casetype ID and flag if case event is raised for lock. Example usage: Implement validation logic if case can be locked or unlocked. |
Lock/ Unlock Attachment | After | ChangedAttachmentLockEvent | Case Event | Represents the event raised after an attachment is locked/unlocked. Parameters include folder ID, casetype ID and attachment object, and flag if event is raised for lock. Example usage: Implement update logic for case folder information when attachment is locked/unlocked. |
Lock/ Unlock Attachment | Before | ChangingAttachmentLockEvent | Case Event | Represents the event raised before an attachment is locked/unlocked. Parameters include folder ID, casetype ID and attachment object, and flag if event is raised for lock. Example usage: Implement validation logic if attachment can be locked or unlocked. |
Open Case | Init | InitOpeningCaseEvent | Case Event | Represents the event raised before showing the user interface to open a case folder. Folder toolbar menus can be adjusted in this event. Parameters include folder ID, casetype ID, toolbar menus and active tabs. Example usage: Implement a logic to hide/show case folder's toolbar action menus and tabs. |
Reject Workitem | After | RejectedWorkitemEvent | Case Event | Represents the event raised when the work item is rejected and assigned to another user. Parameters include folder ID, casetype ID, process ID, work item ID, and new work item ID. Example usage: Send email notification to folder owner and/or update case folder information. |
Remove User from Team Role | After | RemovedUserFromTeamRoleEvent | Case Event | Represents the event raised after the user is removed from the team role. Parameters include folder ID, casetype ID, role ID and user ID. Example usage: Implement update logic to modify folder information or attachments that are associated with the removed user. |
Remove User from Team Role | Before | RemovingUserFromTeamRoleEvent | Case Event | Represents the event raised before removing user from team role. Parameters include folder ID, casetype ID, role ID and user ID. Example usage: Implement validation logic if the user should be allowed to be removed from the team role. |
Reopen Case | After | ReopenedCaseEvent | Case Event | Represents the event raised after the case is reopened. Parameters include folder ID and casetype ID. Example usage: Implement update logic to case folder field information that reflect the status of the case folder. |
Replace Email Template | After | ReplacedEmailTemplateEvent | Case Event | Represents the event raised after email template has been replaced. It's parameters include folder ID, casetype ID, sender ID, activity ID, recipient ID, notification ID, custom fields dictionary, recipient fields dictionary, attachment IDs and attachment file paths. Example usage: Modify email template information based on requirements. |
Replace Letter Template | After | ReplacedLetterTemplateEvent | Case Event | Represents the event raised after letter template has been replaced. Parameters include letter template arguments and letter template key value pairs. Example usage: Modify letter template key value pairs based on requirements. |
Resume case | After | ResumedCaseEvent | Case Event | Represents the event raised after the case is resumed from suspended state. Parameters include folder ID and casetype ID. Example usage: Implement update logic for case folder information that are associated with case folder status. |
Save Custom Attachment Properties | After | SavedCustomAttachmentPropertiesEvent | Case Event | Represents the event raised after custom attachment properties are saved. Parameters include folder ID, casetype ID, flag if attachment is new, record object that holds properties information in database, and a list of properties that were updated. Example usage: Implement update logic in the attachment after property changes are saved. |
Save Custom Attachment Properties | Before | SavingCustomAttachmentPropertiesEvent | Case Event | Represents the event raised before the Custom attachment properties are saved. Parameters include folder ID, casetype ID, record object with all properties and field values, flag if attachment is new, and a list of attachment's updated properties. Example usage: Implement validation logic if attachment properties should be allowed to be changed. |
Skip Work Item | After | SkippedWorkitemEvent | Case Event | Represents the event raised after the work item is skipped. Parameters include folder ID, casetype ID, process ID and work item ID. Example usage: Implement update logic in case folder information or task assignments based on the skipped work item. |
Start Activity | After | StartedActivityEvent | Case Event | Represents the event raised after workflow activity is started. Parameters include folder ID, casetype ID, process ID and activity ID. Example usage: Implement update logic in case folder information based on the started activity event. |
Start Case Workflow | After | StartedCaseWorkflowEvent | Case Event | Represents the event raised after the workflow is started. Parameters include folder ID and casetype ID. Example usage: Implement update logic in case folder information or in team roles after workflow has been started. |
Suspend Case | After | SuspendedCaseEvent | Case Event | Represents the event raised after the case is suspended. Parameters include folder ID and casetype ID. Example usage: Implement update logic in case folder information that are associated with case folder status. |
Suspend Case by Subfolder | After | SuspendedCaseBySubfolderEvent | Case Event | Represents the event raised after the case is suspended by a subfolder Parameters include folder ID, casetype ID and sub-folder ID. Example usage: Implement update logic in case folder or sub folder information after the folder is suspended. |
Timer Event | Execute | TimerEvent | Case Event | Represents the events fired by the eCASE runtime based on the configuration for date fields of folders and date fields of tasks. Parameters include folder ID, casetype ID, event type, event name, field used to trigger the event, current value of the field, and work item ID of the task which triggered the event. |
Update Case | After | UpdatedCaseEvent | Case Event | Represents the event raised after the case is updated. Parameters include case folder object and updated case folder data object. Example usage: Implement update logic to update folder team role and/or update case folder information based on the update. |
Update Case | Before | UpdatingCaseEvent | Case Event | Represents the event raised before the case is updated. Parameters include case folder object. Example usage: Implement validation logic to validate fields if they should be updated and/or pre-populate fields before the folder update. |
Update Data from Workflow | After | UpdatedDataFromWorkflowEvent | Case Event | Represents the event raised after the workflow data is updated into single valued case fields. Parameters include folder ID, casetype ID and list of updated fields. Example usage: Implement update logic in case folder or in the workflow based on the updated fields. |
Add Users to Application | After | AddedUsersToApplication | App Event | Represents the event raised after users are added to the application. Parameters include application type ID, and list of user IDs Example usage: Send an email notification to each of the users that they have been added to the application. |
Add Users to Application | Before | AddingUsersToApplication | App Event | Represents the event raised before users are added to the application. Parameters include application type ID and list of user IDs Example usage: Implement a validation logic if each users should be added to the application. |
Get Data Set | Init | GetDataSetAppEvent | App Event | Represents the application event raised by UI to obtain some data. Parameters include app type ID, dataset name, and args dictionary that contains a collection of objects. |
Grant Role | After | GrantedRoleEvent | App Event | Represents the event raised after principal is added to a role. Parameters include role assignment information object. Example usage: Send an email notification to the added principal that he/she has been added to the role. |
Grant Role | Before | GrantingRoleEvent | App Event | Represents the event raised before principal is added to a role. Parameters include role assignment information object. Example usage: Implement validation logic if the principal is allowed to be added to the role. |
Post Process Report | Execute | PostProcessReportEvent | App Event | Represents the application event raised when Crystal Reports report is created and exported. Parameters include report format, report argument dictionary, report information object, and exported report file name. |
Remove User from Application | After | RemovedUsersFromApplication | App Event | Represents the event raised after users are removed from the application. Parameters include app type ID and list of removed user IDs. Example usage: Send email notification to each of the removed users that they have been removed from the application. |
Remove User from Application | Before | RemovingUsersFromApplication | App Event | Represents the event raised before users are removed from the application. Parameters include app type ID and list of to-be-removed user IDs. Example usage: Implement validation logic if each user should be allowed to be removed from the application. |
Revoke Role | After | RevokedRoleEvent | App Event | Represents the event raised after principal is removed from a role. Parameters include role assignment information object. Example usage: Send an email notification to the principal that he/she is removed from the role. |
Revoke Role | Before | RevokingRoleEvent | App Event | Represents the event raised before principal is removed from a role. Parameters include role assignment information object. Example usage: Implement validation logic if the principal should be removed from the role. |