IBM® Enterprise
Records provides
the following sample events for Base, DoD, and PRO data models.
You can customize the samples as needed. See the Readme file in
the Events folder in the software package.
Table 1. Events and descriptionsEvents |
Description |
RMAutoDeclare |
Configures auto-declaration of records. When a user performs
a specific operation (such as check in or file into a folder) on a
document in a Records Object Store (ROS), IBM Enterprise
Records automatically creates
a corresponding electronic record in a specific File Plan Object Store
(FPOS). You can also configure this sample event to declare every
document that belongs to a specific document class when a user checks
in the document.
The sample event supports unclassified declaration
of electronic record only. This event must be configured to use asynchronous
and NOT synchronous events.
|
RMAutoSynchronizeProperties |
Synchronizes the properties of records and their associated
documents. For example, when a user updates a property value of a
record, IBM Enterprise
Records updates
the corresponding property value in the associated documents as well.
This
sample event works for properties that use the same symbolic name.
You can synchronize from document to record or from record to document,
but not both. If you synchronize from record to document, IBM Enterprise
Records updates the document when
the record's corresponding property is updated.
This event also
synchronizes property aliases across object stores either from record
to document or from document to record, but not both.
|
RMUpdateDateDeclared RMLastRetrievalOfRecord
|
Together, these sample events determine when to dispose
of the container, or ensure that a disposition schedule does not dispose
of a container where records have been recently declared or retrieved.
IBM Enterprise
Records applies this sample event
to the Volume and Box classes and sets the Date Last Declaration on
the parent folder when a user declares a record.
For the PRO
data model, IBM Enterprise
Records automatically
subscribes the RMUpdateDateDeclared event to the Volume or Box class,
and you only need to enable the event. For the other data models,
you must run the import script to create the RMUpdateDateDeclared
event and subscribe to the Volume or Box class.
RMLastRetrievalOfRecord
sets the date of the last review of a record's content to its
folder's LastRetrievalofRecord property.
|
RMSecurityPropagation |
(PRO Only) Used only for the PRO data model, this sample
event sets the marking value of the Security Category property of
the record, volume, and record folder (but not record category) based
on the highest level of an associated entity.
For
example, when the propagation is from record to folder, IBM Enterprise
Records updates the parent folder's
security if the record's security is higher than its parent folder.
Other folders in which the record is filed are not affected.
When
the propagation is from folder to record, IBM Enterprise
Records updates the security of
records at a lower security level to the highest security level of
their parent folders
The setting in System Configuration for
the PRO FPOS controls how security is propagated — from folder to
record, from record to folder, both, or no propagation allowed.
|
RMSendEmailOnSupercede |
This sample event causes an email to be sent each time a
record is superseded by a new version. The email message contains
the details about the superseding record's description, date,
and time it was superseded. The email is sent when the container has
the disposition schedule that defines a trigger based on a supercede
event.
Restriction: This event is not supported in
JBoss or WebLogic.
|
IBM Enterprise
Records sample event
handler jar files are stored as code modules in the target object
store. The advantage is that you can add or update the event handler
by checking in a new version without restarting the application server.
Configuring IBM Enterprise
Records sample
events is as follows:
Create event actions
Before starting this
procedure, make sure the folder named CodeModules exists under the
root folder of the object store where you are about to create event
actions. If such a folder does not exist, follow the instructions
in the IBM FileNet® P8 Platform Installation
and Upgrade Guide to create
the folder.
- Copy the folder under the CD root, ~CDRoot\RecordsManager.<platform>\Events,
to the server where you run EM. This folder contains the import scripts,
JAR files, and configuration files.
- Run the appropriate import scripts to create event actions you
want to use.
- Right-click on the target IBM Enterprise
Records object
store.
- Select Import All.
- On the Import Helper dialog, Import Options tab, Import Manifest
File field, browse to the folder you copied and select the import
script for the required event. Each file is named after the event.
For example, the import file for the RMAutoDeclare event is named RMAutoDeclareImport.xml.
- On the External Content Path field, browse to the ~\Events\lib folder.
- Click Import.
After the import is completed, you should see an "Import Success"
message. The event action should be created under the object store's
Event Action folder, and the code modules will be created in the Code
Module folder.
Customize configuration files
RMAutoDeclare
and RMSendEmailOnSupercede events have their own configuration files.
The import script creates the files in the object store:
- The RMAutoDeclare configuration file is RMAutoDeclare.properties under Root
Folder\RM Samples folder.
- The RMSendEmailOnSupercede configuration
file is RMSendEmailOnSupercede.properties under
the same Root Folder\RM Samples folder.
Check out the configuration file either from Workplace or Workplace XT or Enterprise Manager. After editing, check
it in. See Configuring autodeclaration of records. For
the RMSendEmailOnSupercede file, the comments
preceding the line you modify are self-explanatory (SMTP host, port
number, sender and receiver email addresses).
Create subscriptions
Each event requires
subscriptions to one or more classes.
Subscription to the RMAutoDeclare event
- In Enterprise Manager, navigate
to the Object Stores/ROS/Document
class or subclass where you want to create the
subscription.
- Right-click the class and select Add Subscription.
- Specify a unique name and a description for the subscription.
- Select the Applies to all instances radio
button.
- On the Specify Triggers screen, select the Check In event trigger.
- On the Specify Event Action screen, select the event action you
have imported.
- On the Specify Additional Properties screen, clear the Synchronous check
box, as recommended, and check or clear the Include Subclasses check
box as appropriate for each event and complete the wizard.
To subscribe to the Folder class or subclass
- In Enterprise Manager, navigate
to Object Stores/ROS/Folder
class or subclass where you want to create the
subscription.
- Right-click the class and select Add Subscription.
- Specify a unique name and a description for the subscription.
- Select the Applies to all instances radio
button.
- On the Specify Triggers screen, select the File event trigger.
- Clear the Synchronous check box, as recommended,
and check or clear the Include Subclasses check
box as appropriate, and complete the wizard.
To subscribe to a specific folder in the ROS:
- In Enterprise Manager, navigate
to the folder where you want to create the subscription.
- Right-click the folder and select New Subscription.
- Specify a unique name and a description for the subscription.
- Accept the default.
- Select the File event trigger.
- On the Specify Event Action screen, select the RMAutoDeclare event.
- On the Specify Additional Properties screen, clear the Synchronous check
box, as recommended, and accept the rest of the default settings and
complete the wizard.
Subscription to the RMAutoSynchronizeProperties event
Subscribing
to the RMAutoSynchronizeProperties event synchronizes the properties
from the source document to its record, or from the record to its
source document.
Do not attempt to synchronize in both directions.
This event must be configured to use synchronous events.
To
synchronize from the source document to its record:
- In Enterprise Manager, navigate
to Object Stores/ROS/Document
class or subclass.
- Right-click and select Add Subscription.
- Specify a unique name and a description for the subscription.
- Select the Applies to all instances radio
button.
- On the Specify Triggers screen, select the Update event trigger.
- Select the event action you have imported.
- On the Specify Additional Properties screen, select the Synchronous check
box, but clear the Include Subclasses check
box and complete the wizard.
To synchronize from the record to its source document
- In Enterprise Manager, navigate
to Object Stores/ROS/Document
class or subclass.
- Right-click and select Add Subscription.
- Specify a unique name and a description for the subscription.
- Select the Applies to all instances radio
button.
- On the Specify Triggers screen, select the Update event trigger.
- Select the event action you have imported.
- On the Specify Additional Properties screen, select the Synchronous check
box, but clear the Include Subclasses check
box and complete the wizard.
Subscription to the RMLastRetrievalOfRecord event
To
subscribe to the RMLastRetrievalOfRecord event:
- In Enterprise Manager, navigate
to Object Stores/FPOS/Other Classes/CustomObject/RM
System class.
- Right-click and select Add Subscription.
- Specify a unique name and a description for the subscription.
- Select the Applies to all instances radio
button.
- In the Specify Triggers screen, select the Creation event trigger.
- Select the event action you have imported.
- In the Specify Additional Properties screen, clear the Include
Subclasses check box , select the Synchronous check
box, and complete the wizard.
Subscription to the RMSecurityPropagation event (For
PRO only)
You can create a subscription to this event for
the Record Folder class, the Volume class, or the Record class.
To
subscribe to the event for the Record Folder class
- In Enterprise Manager, navigate
to Object Stores/PRO-FPOS/Other Classes/Folder/RM
Folder/Record Folder class.
- Right-click and select Add Subscription.
- Specify a unique name and a description for the subscription.
- Select the Applies to all instances radio
button.
- On the Specify Triggers screen, select the File and Update event
triggers.
- Select the event action you have imported.
- On the Specify Additional Properties screen, clear the Include
Subclasses check box, and complete the wizard.
To subscribe to the event for the Volume class:
- In Enterprise Manager, navigate
to Object Stores/PRO FPOS/Other Classes/Folder/RM
Folder/Volume class.
- Right-click and select Add Subscription.
- Specify a unique name and a description for the subscription.
- Select the Applies to all instances radio
button.
- In the Specify Triggers screen, select the File and Update event
triggers.
- Select the event action you have imported.
- On the Specify Additional Properties screen, clear the Include
Subclasses check box and complete the wizard.
To subscribe to the event for the Record class:
- In Enterprise Manager, navigate
to Object Stores/PRO-FPOS/Document Class/Record
class.
- Right-click and select Add Subscription.
- Specify a unique name and a description for the subscription.
- Select the Applies to all instances radio
button.
- On the Specify Triggers screen, select the Update event trigger.
- Select the event action you have imported.
- On the Specify Additional Properties screen, select the Include
Subclasses check box and complete the wizard.
Subscription to the RMSendEmailOnSupercede event
To
subscribe to the RMSendEmailOnSupercede event
- In Enterprise Manager, navigate
to Object Stores/FPOS/Document Class/Record
class.
- Right-click and select Add Subscription.
- Specify a unique name and a description for the subscription.
- Select the Applies to all instances radio
button.
- On the Specify Triggers screen, select the Update and Checkin
event trigger.
- Select the event action you have imported.
- On the Specify Additional Properties screen, select the Include
Subclasses check box and complete the wizard.
Subscription to the RMUpdateDateDeclared event
For
the PRO data model, you need to enable the already existing event,
as follows:
- In Enterprise Manager, navigate
to the Object Stores/FPOS/Events/Event
Action folder.
- Right-click UpdateDateDeclared.
- Click Enable.
For the DoD and Base data models, subscribe to the Record
Category, Volume, and Box classes after you create the event.
Subscribe
to the event for the Record Category class
- In Enterprise Manager, navigate
to Object Stores/<FPOS>/Other Classes/Folder/RM Folder/Record
Category
- Right-click and select Add Subscription.
- Specify a unique name and a description for the subscription.
- Select the Applies to all instances radio
button.
- On the Specify Triggers screen, select the File event trigger.
- Select the event action you have imported.
- In the Specify Additional Properties screen, clear the Include
Subclasses check box and complete the wizard.
To subscribe to the event for the Volume class:
- In Enterprise Manager, navigate
to Object Stores/FPOS/Other Classes/Folder/RM
Folder/Volume
- Right-click and select Add Subscription.
- Specify a unique name and a description for the subscription.
- Select the Applies to all instances radio
button.
- On the Specify Triggers screen, select the File event trigger.
- Select the event action you have imported.
- On the Specify Additional Properties screen, clear the Include
Subclasses check box and complete the wizard.
To subscribe to the event for the Box class
- In Enterprise Manager, navigate
to Object Stores/FPOS/Other Classes/Folder/RM
Folder/Physical Container/Box
- Right-click and select Add Subscription.
- Specify a unique name and a description for the subscription.
- Select the Applies to all instances radio
button.
- On the Specify Triggers screen, select the File event trigger.
- Select the event action you have imported.
- On the Specify Additional Properties screen, clear the Include
Subclasses check box and complete the wizard.
For information on customizing events, see the P8 software
package.