Skip Headers
Oracle Workflow Developer's Guide
Release 2.6.3.5
Part Number B12161-02
|
|
|
|
|
|
|
|
|
Previous |
Next |
|
Contents |
Index |
Glossary |
To Copy a Message
2. Hold down your mouse select button as you drag the message to the item type branch you want to copy to.
3. When you release your mouse button, a property page appears for the new message.
Note: You can also use the Copy and Paste options in the Edit menu.
4. Enter a new internal name and display name.
5. Make any additional modifications to the properties of the message.
6. When you are done, choose OK.
Note: Copying a message also copies any message attributes assigned to it.
See Also
To Create a Message
Embedding Oracle Applications Framework Regions in Messages
If you are using Oracle Applications and you have Oracle Applications Framework set up in Oracle JDeveloper for custom development, you can embed Oracle Applications Framework regions in a notification message. To embed a region, define a message attribute whose value is a Java Server Page (JSP) call that references the region.
The message attribute representing the region must be of type document and must have a source of Send. You can assign the attribute any appropriate internal name, display name, and description.
Specify the value for the attribute in the following format:
JSP:/OA_HTML/OA.jsp?OAFunc=<Function_Name>
where <Function_Name> is the self-service function name for the region you want to embed in the notification, as registered in the Form Functions window in Oracle Applications. For example:
JSP:/OA_HTML/OA.jsp?OAFunc=EMBED_WL_FUNC
To pass parameters to the region, specify the value for the attribute in the following format:
JSP:/OA_HTML/OA.jsp?OAFunc=<Function_Name>&<Name1>=<Value1>&<Name2>=<Value2>...
where <Function_Name> is the function name for the region, <Name1> and <Value1> are the parameter name and value for the first parameter, <Name2> and <Value2> are the parameter name and value for the second parameter, and so on. For example:
JSP:/OA_HTML/OA.jsp?OAFunc=EMBED_WL_FUNC&Order_Type=12345
You can set the value for the message attribute in the following ways:
- Specify the complete JSP call as a constant default value for the message attribute.
- Specify an item type attribute of type document as the message attribute value, and include logic in your workflow process that dynamically sets the item type attribute value at runtime. This method lets you dynamically set the complete JSP call.
- Use token substitution in the message attribute value to dynamically set the function name within the JSP call.
- Create an item type attribute for the function name.
- Create an additional message attribute for the function name, and specify the corresponding item type attribute as the value of that message attribute.
- Include logic in your workflow process that dynamically sets the item type attribute value to the appropriate function name at runtime.
- Specify the value for the message attribute representing the region in the following format:
JSP:/OA_HTML/OA.jsp?OAFunc=-&funcname_attr-
where funcname_attr is the internal name of the message attribute that specifies the function name.
- Use token substitution in the message attribute value to dynamically set the parameter values for the function within the JSP call. In this case you must specify the function name and the parameter names as constants within the JSP call, and token substitute only the parameter values.
- Create an item type attribute for each parameter value.
- Create an additional message attribute for each parameter value, and specify the corresponding item type attribute as the value of that message attribute.
- Include logic in your workflow process that dynamically sets the item type attribute values to the appropriate parameter values at runtime.
- Specify the value for the message attribute representing the region in the following format:
JSP:/OA_HTML/OA.jsp?OAFunc=<Function_Name>&<Name1>
=-&msgattr1-&<Name2>=-&msgattr2-...
where <Function_Name> is the function name for the region, <Name1> and <Name2> are the first and second parameter names, msgattr1 and msgattr2 are the internal names of the message attributes that specify the first and second parameter values, and so on.
Note: The Frame Target field is not applicable for message attributes of type document. Additionally, you must not select the Attach Content check box for a message attribute that references a region. An Oracle Applications Framework region can only be displayed within the message body of a notification. It cannot be included as an attachment to the notification.
To embed the region in the message, enter the token for the message attribute in the HTML body for the message. A message can include multiple regions, which will be displayed in the sequence in which their tokens appear in the HTML Body field. Additionally, the message can include calls to the special message function WF_NOTIFICATION() to produce a table of message attributes or an action history table, which will also be rendered as Oracle Applications Framework regions. See: WF_NOTIFICATION() Message Function.
Note: If you embed an Oracle Applications Framework region in a message, then the message body can only contain message attribute tokens referencing such regions and calls to the special message function WF_NOTIFICATION(). The message body cannot contain any tokens for message attributes that do not reference regions.
Leave the Text Body field blank for an Oracle Applications Framework region message. Oracle Workflow does not use the text body for such messages. Instead, a text version of the message is derived directly from the included regions. Note that non-text content such as images, links, or special HTML formatting will not appear in the text version of a region.
Follow these guidelines when you are developing an Oracle Applications Framework region for inclusion in a notification message:
- Oracle Workflow notifications support embedded Oracle Applications Framework regions only. You cannot include an entire Oracle Applications Framework page.
- Ensure that the event handling in the controllers for the embedded Oracle Applications Framework region does not interfere with the event handling of the region controller for the main message body. To avoid such interference, when handling any events in the controller code, you must qualify those events with the region associated with the controller.
- The embedded region must be complete within itself. You should associate the region with its own application module and assign it a region title.
- The embedded region must be a view-only region. That is, it cannot contain elements that allow user input, such as buttons.
- The embedded region must not contain any information that is specific to a particular user session.
- If you do not want to send an embedded region in e-mail, you can exclude the message body from notification e-mail messages by assigning the notification a message template that directs recipients to access the notification through the Worklist Web pages instead.
- For a notification that requires a response, define the special message attributes #WFM_OPEN_MAIL and #WFM_OPEN_MAIL_DIRECT, and set the values of these attributes to WFMAIL:VIEW_FROMUI to use the Workflow View From UI message template.
- For a notification that does not require a response, define the special message attribute #WFM_OPEN_MAIL_FYI, and set the value of this attribute to WFMAIL:VIEW_FROMUI_FYI to use the Workflow View FYI From UI message template.
- If the embedded region includes subtabs or Hide/Show regions, ensure that you provide alternate representations of that content for inclusion in an e-mail message or in the plain text version of a notification used for electronic signatures. You can choose to exclude the message body from e-mail, or you can code alternate representations in the controllers for the embedded region.
For example, for a subtab region you can create a separate region displaying that content and include the separate region programmatically in the e-mail or plain text cases. For Hide/Show regions, you should remove the Hide/Show region and instead display all the child rows of the Hide/Show region directly in the current container.
- For usability reasons, we recommend that if your Stack Layout region includes a Table Layout region, you should restrict to 200 the number of rows returned from the query for the Table Layout region.
If your Stack Layout region includes a region in the Table Layout region style, the Notification Details page displays the Table Layout region with the Next and Previous rowset functionality available when appropriate. However, because e-mail clients cannot interpret the rowset functionality, e-mail notifications display the Table Layout region with static row data, which is restricted to 200 rows.
- Do not enable sorting or navigation features for table components programmatically at runtime.
- Register your Oracle Applications Framework region as a self-service function (non-form function) in the Form Functions window in Oracle Applications. The internal name that you define for the function is the function name that you must include in the message attribute value to reference the region. See: Form Functions Window, Oracle Applications Developer's Guide.
When you register the function, enter the HTML Call in the Web HTML tabbed region of the Form Functions window, using the following format:
OA.jsp?page=/<directory_path>/<Region_Code>
&akRegionApplicationId=<Region_Application_ID>
OA.jsp?page=/oracle/apps/fnd/wf/worklist/webui/
WFNTFWORKLIST&akRegionApplicationId=601
For more information about building an Oracle Applications Framework region, refer to OracleMetaLink note 269138.1, Oracle Applications Framework Developer's Guide.
Copyright © 2003, 2004, Oracle. All rights reserved.