To Define a Document Attribute
You can identify the following types of document for a document attribute:
- An external document stored in a Document Management repository
2. A PL/SQL document represents data from the database as a character string, generated from a PL/SQL procedure. Specify the default value of a PL/SQL document as
plsql:<procedure>/<document_identifier>.
Replace <procedure> with the PL/SQL package and procedure name, separated by a period. Replace <document_identifier> with the PL/SQL argument string that you want to pass directly to the procedure. The argument string should identify the document.
Note: The PL/SQL procedure must follow a standard API format. See: Standard APIs for "PL/SQL" and "PL/SQL CLOB" Documents.
For example, the following string represents the PL/SQL document, po_req:2034, generated by the procedure po_wf.show_req.
plsql:po_wf.show_req/po_req:2034
Note: The maximum length of the data that a PL/SQL document can contain is 32 kilobytes. If you expect your document to exceed 32 Kb, you should use a PL/SQL CLOB document to hold the data instead.
3. A PL/SQL CLOB document represents data from the database as a character large object (CLOB), generated from a PL/SQL procedure. Specify the default value of a PL/SQL CLOB document as
plsqlclob:<procedure>/<document_identifier>.
Replace <procedure> with the PL/SQL package and procedure name, separated by a period. Replace <document_identifier> with the PL/SQL argument string that you want to pass directly to the procedure. The argument string should identify the document.
Note: The PL/SQL procedure must follow a standard API format. See: Standard APIs for "PL/SQL" and "PL/SQL CLOB" Documents.
For example, the following string represents the PL/SQL CLOB document, po_req:2036, generated by the procedure po_wf.show_req_clob.
plsqlclob:po_wf.show_req_clob/po_req:2036
PL/SQL CLOB documents do not support further substitution of message attribute tokens. The contents of the CLOB are printed in the message body as they are generated by the PL/SQL procedure.
- Do not use tokens within the CLOB.
- Ensure that the PL/SQL procedure performs any formatting you require.
Attention: Only notifications viewed from the Notifications Worklist can include PL/SQL CLOB documents. You cannot use PL/SQL CLOB documents in e-mail notifications sent through the Notification Mailer. Ensure that you do not include PL/SQL CLOB documents in notifications sent to recipients whose mail preference is MAILTEXT, MAILHTML, or MAILATTH.
4. If you wish to generate the document identifier for a PL/SQL or PL/SQL CLOB document dynamically, you can token substitute the document identifier with other item type attributes. See: To Token Substitute an Attribute.
plsql:po_wf.show_req/&item_attr1:&item_attr2
Note: If you are defining a message attribute of type Document, you can also include a special token in your argument string called &#NID which Oracle Workflow substitutes with the notification ID of the runtime notification.
5. To specify a document managed by an external document management system, enter the following in the default value field:
DM:<node_ID>:<document_ID>:[version]
Replace <node_ID> with the node ID of the document management system, as listed in the Document Management Nodes web page. Replace <document_ID> with the ID assigned to the document by the document management system. You may also optionally specify the version number of the document, if multiple versions of the document exist. See: Defining Document Management Repositories.
6. Choose OK when you are done.
