Emit-Event
The Emit-Event webject emits a custom Windchill workflow event with optional event parameters.
Syntax
<ie:webject name="Emit-Event" type="ACT">
<ie:param name="AUTHORIZATION"
data="$(@SERVER[]authorization[0])"/>
<ie:param name="CONNECTION_ATTEMPTS" data="attempts"/>
<ie:param name="CONNECTION_ATTEMPT_INTERVAL" data="interval"/>
<ie:param name="DBUSER" data="username"/>
<ie:param name="EVENT_TYPE" data="custom_event_name"/>
<ie:param name="INSTANCE" data="appl_name"/>
<ie:param name="OBJECT" data="ufid"/>
<ie:param name="OBJECT_REF" data="ufid"/>
<ie:param name="PASSWD" data="password"/>
<ie:param name="SESSION_ID" data="$(session[]session_id[])"/>
<ie:param name="STRING" data="text"/>
</ie:webject>
<ie:param name="AUTHORIZATION"
data="$(@SERVER[]authorization[0])"/>
<ie:param name="CONNECTION_ATTEMPTS" data="attempts"/>
<ie:param name="CONNECTION_ATTEMPT_INTERVAL" data="interval"/>
<ie:param name="DBUSER" data="username"/>
<ie:param name="EVENT_TYPE" data="custom_event_name"/>
<ie:param name="INSTANCE" data="appl_name"/>
<ie:param name="OBJECT" data="ufid"/>
<ie:param name="OBJECT_REF" data="ufid"/>
<ie:param name="PASSWD" data="password"/>
<ie:param name="SESSION_ID" data="$(session[]session_id[])"/>
<ie:param name="STRING" data="text"/>
</ie:webject>
Parameters
|
Required
|
Interdependent
|
Optional
|
|---|---|---|
|
EVENT_TYPE
|
AUTHORIZATION
|
CONNECTION_ATTEMPTS
|
|
INSTANCE
|
DBUSER
|
CONNECTION_ATTEMPT_INTERVAL
|
|
PASSWD
|
OBJECT
|
|
|
OBJECT_REF
|
||
|
SESSION_ID
|
||
|
STRING
|
 |
If a parameter is listed in the table but is not defined below, then it has a common parameter definition. For descriptions of those parameters, see Common Webject Parameters section in Adapter Webjects Overview.
|
EVENT_TYPE
The name of the custom event being emitted. The names of custom events can be defined in the following ways:
• As the names of resources in the Windchill resource bundle wt.workflow.engine.WfCustomEventType.
• As LDAP directory entries. Any object in the LDAP directory with the object class ptcWindchillEventTypeDefinition defines a custom event type.
◦ The ptcWindchillEventTypeId attribute of each such object defines a value that can be specified for the EVENT_TYPE parameter.
◦ The wt.workflow.engine.eventTypeQueryURL property in wt.properties specifies the LDAP URL of the node in the directory that serves as the root node of a subtree containing these custom workflow event type definitions.
This parameter is required.
OBJECT
Specifies a name=value pair.
• name is the name of a parameter that is carried in the event notification.
• value is the UFID (unique federation identifier) of an object to be associated with the event parameter name.
The object referenced by the UFID is retrieved from the database and passed as the value of the event parameter.
This parameter can be specified multiple times in order to specify as many parameters as are needed by the event being emitted. This parameter is optional.
OBJECT_REF
Specifies a name=value pair.
• name is the name of a parameter that is carried in the event notification.
• value is the UFID (unique federation identifier) of an object to be associated with the event parameter name.
The object reference identified by the UFID is passed as the value of the parameter.
This parameter can be specified multiple times in order to specify as many parameters as are needed by the event being emitted. This parameter is optional.
STRING
Specifies a name=value pair.
• name is the name of a parameter that is carried in the event notification.
• value is the string value of the parameter.
This parameter can be specified multiple times in order to specify as many parameters as are needed by the event being emitted. This parameter is optional.