Business Event Annotations (Oracle Applications Help)

Business Event Annotations

This section describes what you should know about Integration Repository annotations for business events, and includes the following topics:

Annotating Business Events
Annotations for Business Events - Syntax
Required Annotations
Optional Annotations
Template
Example

Annotating Business Events

You should annotate business events in *.wfx files.
You should annotate only events. Subscriptions need not be annotated; they will not be available in Integration Repository.
Before annotating, make sure that no comments beginning with /*# are present. These "slash-star-pound" characters are used to mark the start of repository annotations, and will produce errors or unspecified behavior if used in normal comments.
To annotate, use a text editor such as emacs or vi to edit the file.
In the .wfx file, place the annotations within the <IREP_ANNOTATION> tag for the business event. Note that the <IREP_ANNOTATION> tag is a child node of the <WF_EVENTS> tag.
For .wfx files having multiple business event definitions, each of the business event definitions should be separately annotated. That is, you should place the annotation within an <IREP_ANNOTATION> tag for the appropriate business events.
Enter a meaningful description that covers the condition under which the business event is raised, and the UI action that invokes the business event.
Define product codes in FND_APPLICATION.
Use existing business entities for your events. For the list of existing business entities, see Business Entity Annotation Guidelines.
If you decide not to annotate or publish the event after all, you should remove the annotation only, and not the associated tags.

The presence of either the <IREP_ANNOTATION/> tag or <IREP_ANNOTATION></IREP_ANNOTATION> tag is an indication to the loader that the business event has been reviewed for annotation and does not need to be published to integration repository. The next time the user downloads these events, the loader will insert empty <IREP_ANNOTATION> tags.
If you remove the entire <IREP_ANNOTATION> tag for the business event and then upload it, on a subsequent download the loader will insert a partially filled annotation template for the business event.

Annotations for Business Events - Syntax

The annotations for business events are:

<IREP_ANNOTATION>
/*#
* This event is raised after the Purchase Order has been pushed 
* to Oracle Order management open interface tables. This event 
* will start the workflow OEOI/R_OEOI_ORDER_IMPORT to import the 
* order.
* @rep:scope public
* @rep:displayname OM Generic Inbound Event
* @rep:product ONT
* @rep:category BUSINESS_ENTITY ONT_SALES_ORDER
*/
</IREP_ANNOTATION>

Refer to General Guidelines for Annotations for details of element definitions.

Required Annotations

Follow the links below to view syntax and usage of each annotation.

Must begin with description sentence(s)
rep:displayname
rep:scope
rep:product
rep:category BUSINESS_ENTITY

Optional Annotations

Template

You can use this template when annotating .wfx files.

.
.
.

<oracle.apps.wf.event.all.sync>
.
.
.
<WF_TABLE_DATA>
   <WF_EVENTS>
      <VERSION>...</VERSION>
      <GUID>....</GUID>
      <NAME>event name</NAME>
      <TYPE>EVENT</TYPE>
      <STATUS>ENABLED</STATUS>
      <GENERATE_FUNCTION/>
      <OWNER_NAME> ... </OWNER_NAME>
      <OWNER_TAG>...</OWNER_TAG>
      <CUSTOMIZATION_LEVEL>...</CUSTOMIZATION_LEVEL>
      <LICENSED_FLAG>..</LICENSED_FLAG>
      <DISPLAY_NAME>...</DISPLAY_NAME>
      <DESCRIPTION> Description for business event </DESCRIPTION>
      <IREP_ANNOTATION>
 /*#
  * Put your long package description here; it can span multiple lines.
  *
  * @rep:scope <scope>
  * @rep:displayname <display name>
  * @rep:product <product or pseudoproduct short code>
  * @rep:category BUSINESS_ENTITY <entity name>
  */
	  </IREP_ANNOTATION>
   </WF_EVENTS>
</WF_TABLE_DATA>


.
.
.

<WF_TABLE_DATA>
   <WF_EVENTS>
      <VERSION>...</VERSION>
      <GUID>....</GUID>
      <NAME>event name</NAME>
      <TYPE>EVENT</TYPE>
      <STATUS>ENABLED</STATUS>
      <GENERATE_FUNCTION/>
      <OWNER_NAME> ... </OWNER_NAME>
      <OWNER_TAG>...</OWNER_TAG>
      <CUSTOMIZATION_LEVEL>...</CUSTOMIZATION_LEVEL>
      <LICENSED_FLAG>..</LICENSED_FLAG>
      <DISPLAY_NAME>...</DISPLAY_NAME>
      <DESCRIPTION> Description for business event </DESCRIPTION>
      <IREP_ANNOTATION>
 /*#
  * Put your long package description here; it can span multiple lines.
  *
  * @rep:scope <scope>
  * @rep:displayname <display name>
  * @rep:product <product or pseudoproduct short code>
  * @rep:category BUSINESS_ENTITY <entity name>
  */
	  </IREP_ANNOTATION>
   </WF_EVENTS>
</WF_TABLE_DATA>

.
.
.
</oracle.apps.wf.event.all.sync>

Example

For reference, here is an example of an annotated .wfx file:

  <?xml version="1.0" encoding="UTF-8" ?> 
- <!--  $Header: sigdg_appEVan.htm 120.17 2015/07/21 21:15:36 appldev noship $ --> 
- <!--  dbdrv: exec java oracle/apps/fnd/wf WFXLoad.class java &phase=daa+38 \ --> 
- <!--  dbdrv: checkfile(115.2=120.0):~PROD:~PATH:~FILE \ --> 
- <!--  dbdrv: -u &un_apps &pw_apps &jdbc_db_addr &jdbc_protocol US \ --> 
- <!--  dbdrv: &fullpath_~PROD_~PATH_~FILE --> 
- <oracle.apps.wf.event.all.sync>
- <ExternalElement>
- <OraTranslatibility>
- <XlatElement Name="WF_EVENTS">
- <XlatID>
  <Key>NAME</Key> 
  </XlatID>
  <XlatElement Name="DISPLAY_NAME" MaxLen="80" Expansion="50" /> 
- <XlatID>
  <Key Type="CONSTANT">DISPLAY_NAME</Key> 
  </XlatID>
  <XlatElement Name="DESCRIPTION" MaxLen="2000" Expansion="50" /> 
- <XlatID>
  <Key Type="CONSTANT">DESCRIPTION</Key> 
  </XlatID>
  </XlatElement>
  </OraTranslatibility>
  </ExternalElement>
- <WF_TABLE_DATA>
+ <WF_EVENTS>
  <VERSION>1.0</VERSION> 
  <GUID>A3BBD9D401776AE4E0340800208ACA52</GUID> 
  <NAME>oracle.apps.ont.oi.po_ack.create</NAME> 
  <TYPE>EVENT</TYPE> 
  <STATUS>ENABLED</STATUS> 
  <GENERATE_FUNCTION /> 
  <OWNER_NAME>Oracle Order Management</OWNER_NAME> 
  <OWNER_TAG>ONT</OWNER_TAG> 
  <CUSTOMIZATION_LEVEL>L</CUSTOMIZATION_LEVEL> 
  <LICENSED_FLAG>Y</LICENSED_FLAG> 
  <DISPLAY_NAME>Event for 3A4 Outbound Acknowledgment</DISPLAY_NAME> 
  <DESCRIPTION>Event for 3A4 Outbound Acknowledgment</DESCRIPTION> 
  <IREP_ANNOTATION>/*# * This event confirms the buyer of the results of order import. This event will start the workflow OEOA/R_OEOA_SEND_ACKNOWLEDGMENT. * * @rep:scope public * @rep:displayname Event for 3A4 Outbound Acknowledgment * @rep:product ONT * @rep:category BUSINESS_ENTITY ONT_SALES_ORDER */</IREP_ANNOTATION> 
  </WF_EVENTS>
  </WF_TABLE_DATA>
- <WF_TABLE_DATA>
- <WF_EVENTS>
  <VERSION>1.0</VERSION> 
  <GUID>9B8BF9DB705D09C9E0340800208ACA52</GUID> 
  <NAME>oracle.apps.ont.oi.po_inbound.create</NAME> 
  <TYPE>EVENT</TYPE> 
  <STATUS>ENABLED</STATUS> 
  <GENERATE_FUNCTION /> 
  <OWNER_NAME>Oracle Order Management</OWNER_NAME> 
  <OWNER_TAG>ONT</OWNER_TAG> 
  <CUSTOMIZATION_LEVEL>L</CUSTOMIZATION_LEVEL> 
  <LICENSED_FLAG>Y</LICENSED_FLAG> 
  <DISPLAY_NAME>OM Generic Inbound Event</DISPLAY_NAME> 
  <DESCRIPTION>OM Generic Inbound Event</DESCRIPTION> 
  <IREP_ANNOTATION>/*# * This event is raised after the Purchase Order has been pushed to Oracle Order management open interface tables. This event will start the workflow OEOI/R_OEOI_ORDER_IMPORT to import the order. * * @rep:direction OUT * @rep:scope public * @rep:displayname OM Generic Inbound Event * @rep:lifecycle active * @rep:product ONT * @rep:compatibility S * @rep:category BUSINESS_ENTITY ONT_SALES_ORDER */</IREP_ANNOTATION> 
  </WF_EVENTS>
  </WF_TABLE_DATA>
  </oracle.apps.wf.event.all.sync>