Specify the priority, initial state, and whether to include
subclasses. You must also define whether the corresponding event action executes
in synchronous or asynchronous mode.
- Enabled Initial state
- The subscription is enabled by default. To change the default, clear the check
box . After clearing the check box, you must enable the subscription through the
object property sheet before the subscription will function.
- Include subclasses
- Select if you want the subscription to apply to the target
object subclasses. Applies to class subscriptions only.
- Synchronous
- Determines whether the event action runs in synchronous or asynchronous mode.
NOTE Do
not select this option for workflow subscriptions. Launching a workflow
takes more time than a synchronous event can handle. A workflow subscription
must run in asynchronous mode to prevent the action from timing out before
launching the workflow successfully.
- In synchronous execution, the call to execute the event action blocks
further processing by the subscription processor until the action completes
and returns. The action runs in the same transaction as the originating
activity on the target object. If the action fails, the transaction rolls
back.
- In asynchronous execution, the action occurs on a separate execution
thread, allowing the subscription processor to continue without waiting
for the action results. The action cannot be in the same transaction
as the originating activity.
- Filter Expression
- Optionally holds an expression evaluated against the source
object, or an object referenced by an event source object, to determine
whether the subscription should "fire." The expression uses the
same format as the WHERE clause of a query; however, only a subset of the
operators are supported. Filter expression examples:
Type_CVLStr='Confidential'
where Type_CVLStr
is the symbolic name of the DocumentSensitivity
document class property, which expects a value of the String data type,
in this case Confidential.
SVCPDateTime=20040611T000000Z
where SVCPDateTime
is a property of the TimeFormat
document class, which expects a value in the DateTime data type, in this
case 20040611T000000Z
.
TIP The creation event fires when you add a new document or when you check out an existing document. You can fire the creation event only when a new document is added, as either a minor or a major version, by using the following filter:
((MajorVersionNumber=1 and MinorVersionNumber=0 and VersionStatus=1) or (MajorVersionNumber=0 and MinorVersionNumber=1 and (VersionStatus=2 or VersionStatus=3)))
- Filter Property Name
- Optionally specifies the symbolic property name, which must be a singleton object-valued property of the source object. If set, the filter expression applies to the object that property references, rather than the source itself. For example, when adding a subscription for a creation event on an RCR object, you can specify property name "Tail" as the filter property. The Tail property represents the RCR relationship container. By specifying the filter property, the filter expression is evaluated against the object referenced by the filter property, that is, the container rather than the RCR. For instance, you can specify the event to fire only when the container has a title = "accounting".
If an invalid symbolic name is provided, the filter expression is ignored and has no effect on event firing.
There are two situations where using the filter property is desirable:
- File or unfile events on folder class instances.
For file or unfile events, the RCR is the source object, the Head property represents the containee, and the Tail property represents the container (or folder). To apply the filter expression on the folder class or object, set "Tail" as the filter property. Similarly, use "Head" to filter events on certain containees only.
- Publish request event on document class instances.
For publish request events, the Publish Request is the source object of the event, and the "InputDocument" is the property of Publish Request class that represents the source document to be published. To apply a filtering condition against the source document, set the "InputDocument" for the filter property.