Skip Headers

Oracle E-Records Implementation Guide
Release 12.1
Part Number E13700-04
Go to Table of Contents
Go to previous page
Go to next page


This topic describes using attachments with Oracle E-Records, the types of attachments available, and how attachments are stored.

This chapter covers the following topics:

Types of Documents

Electronic records store the snapshot of an ERES event in Oracle Applications. Along with capturing the main transactional details of the event in an XML format, you can store an attachment related to the key business entities involved in the ERES event. These attachments become part of the e-record and e-record storage.

There are two types of attachments:

ERP Documents

Attachments related to the business entities involved in the transaction being snapshot by an e-record. For example, attachments related to a recipe, which is being changed by an ERES event. These attachments are currently attached to different business entities. These attachments are already stored in Oracle Applications.

Non-ERP Documents

Attachments directly related to an e-record entity. For example, a standard operating procedure (SOP) followed during the transaction being snapshot by an e-record. These attachments are attached only to e-records directly. These records must be uploaded into Oracle Applications using Files Approval.

ERP Documents

When e-signatures is enabled for a transaction that allows attachments, the attachments are sent through the signature process with the transaction. The attachment is captured as part of the e-record, and once the signature process is complete, the attachment is stored with the e-record.

When the e-record is queried, either by transaction or generic, the attachment is available for viewing.

For setup information, refer to the Oracle E-Records Developers Cookbook available on My Oracle Support.

Uploading Documents

You can upload a document using Files Approval. Each document is assigned a category, which contains rules for the approval process. Each category has fifteen descriptive flexfield segments that can be used to store information about the documents in that category.

When a document is in either the No Approval Required or Approved status, you can attach the document to an E-Business entity using the Oracle Applications Attachments functionality.

Document Approval Modes

Files Approval has two modes, user and administrator. Depending on how you are logged in, you can either upload, update, and delete all files, or only the files where you are the author.

Document Status

There are five statuses for a document:


This is the default value for all documents when they are first uploaded.


A document is approved after all signers approve it.

Waiting for Approval

A document is waiting for approval when it is in the approval process, but not all signoffs have been completed.


A document is rejected when one signer rejects the document. Rejected documents are not published and are not available for attaching to ERP entities.

Approval Not Required

When approvals for a document are not required, set the status to No Approval Required. No rules are required to be set for this document status. If you send the document for approvals after upload, then it is automatically set to Approval Not Required.


The following rules are set to determine what privileges you have based on the status of a document.

Operations New Approved Waiting for Approval Rejected Approval Not Required
Update Yes No No No No
Delete Yes No No No No
Overwrite Yes No No No No
Send for Approval Yes No No No No

Checklist Functionality

The checklist functionality lets you set up a verification checklist that is uploaded with the document into the iSignatures system. The checklist is a PDF form that contains fields to be entered answering questions about the file being uploaded. This form can be empty fields that you enter information into, or they can have validation against them based on setup in Adobe Acrobat.

The checklist can be created by any product that lets you turn the file into a PDF. Then, the document is edited in Adobe Acrobat to have logic and buttons added to make it a usable form.

The file must be uploaded into the iSignatures system under the EDR iSign Checklist Templates category, and must be in either the Approved or Approval Not Required status. You must set up three configuration variables to activate the checklist. These include:

When a document is uploaded into iSignatures, the checklist appears after the Apply button is clicked. Then, you enter information into the checklist and click the checklist Submit button. As the document moves through the signature process the checklist can be updated. In the e-record, the checklist link is under the Related Applications section.

Coding for Checklist

In Adobe Acrobat, some code has to be added to the top of the PDF file to enable some validation, including the Submit button.

var submit_on = this.getField("SUBMIT_ENABLED").value;

if (submit_on == "Y")




Uploading Documents

When a document is captured, it has an associated category. Each category can have up to 15 descriptive flexfields. This information is stored in the database with the document, and can be used to search for the document.

The list of categories can be restricted by modifying the value set EDR_FILE_CATEGORIES to include a WHERE clause. The clause defines the categories to appear in the category list of values.

To upload a document into the file approval system:

  1. Navigate to the Files Approval window.

  2. Click Upload File. The File Upload window displays.

  3. Select the Category for the document. The list is a value set that can be modified through the System Administration responsibility. Each category has rules set up in AME that determine the approval process. Required.

  4. Based on the category selected, the window displays all descriptive flexfield segments set up for the category. Some of these fields are required. Complete all necessary fields based on the category.

  5. Click Browse to select the document to upload. Required.

  6. Enter a Description of the document. This field has a maximum of 255 characters and supports MLS.

  7. Select the If File Exists option. Required. Valid values are:

  8. Enter a Version Label.

  9. Click Apply. A message displays that the file is uploaded.

  10. Query the documents to see the document in the list. You can update, delete, see details, or send the file for approval.

Querying Documents

When you query a document, you can view all documents in the system, or narrow your search using the available criteria. The search criteria is not case sensitive and handles trailing wildcards. For example, searching for abc returns all matches for abc% and ABC%.

The Advanced Search option lets you search for the documents based on the descriptive flexfield information associated to the document.

To query uploaded documents:

  1. Navigate to the Files Approval window.

  2. Search for documents in the system. You can enter criteria to narrow your search. Enter at least one search criteria.

  3. Click Go. The search results display. The following information displays for each record:

  4. Click Details to see more information about the document and its history.

  5. Click Update to change information about the document.

  6. Click Delete to delete the document from the system. Refer to Security for information on which documents can be deleted.

  7. Click Send for Approval to begin the approval process for the document.

Viewing Document Details

Viewing the details of a document includes all information stored in the flexfields, as well as the information about all previous versions of the file. In addition, you can open and view all versions of the file from this window. You can view all documents and their properties logged in as either user or administrator.

To view details of a document:

  1. Click Details for the record. The File Details: <filename> window displays. This window displays all information about every version of the file. The header information is the current document and all flexfields that were defined for that category. The rest of the window displays information about all other versions of the file. This information includes:

  2. Click the File Name attachment to see the document. The document opens using standard browser plug-ins based on the document type. You can save a copy of the document to your hard drive, but you cannot make edits to the attached copy.

Updating a Document

The information about the document, stored in the descriptive flexfield segments, can be updated. If you change the category of a versioned document, then that becomes the first version of a new category for that document. This is not available if the document is approved.

If you are logged into user mode, then you can only update documents you own. If you do not own the document, then the icon is disabled.

To update a document:

  1. Click Update for the selected record on the Files Approval window. The Update File: <filename> window displays.

  2. Update desired fields. If you change the category, then the flexfields change based on the new category.

  3. Click Apply.

Deleting Documents

Documents can be deleted from the system based on their status. Refer to Security to see which documents can be deleted.

If you are logged into user mode, then you can only delete documents you own. If you do not own the document, then the icon is disabled.

To delete a document:

  1. Click Delete for the selected record on the Files Approval window. A warning window displays.

  2. Click Yes to delete the document.

Sending Documents for Approval

All documents must be sent through an approval process. Based on the rules set up for a category, the document runs through an approval process, either online or by sending notifications to everyone who must sign a document. If a document is rejected by anyone in the signing group, then all other notifications are closed, and a new notification is sent to say that the document was rejected or a message displays saying the signing process was rejected.

When a document is uploaded into the system, it is in a New status. This is the only time a document can be sent for approval. All other statuses occur after the approval process begins.

After a document is sent for approval, all approvers receive a notification in their Workflow notifications list. The document is approved or rejected and signed.

If the rules for a category are set for no approvals, then you must click Send for Approvals for that document, but it is immediately set to Approval Not Required.

If you are logged into user mode, then you can only send for approval documents you own.

The Approval Process

The approval process follows several paths based on how the system is configured. You can sign online or deferred, or deferred allowed, which does both. In addition, you can add dynamic users to the signing process for that document, and remove existing users, depending on the setup of the system.

To send a document for approval:

  1. Select the file to send for approval.

  2. Click Send for Approval. The List of Signers window displays.

Signing a Document

The List of Signers window displays all the people required to sign the document. In addition, you can see any overriding details about the signers. So, if someone sets their signing rules to someone else while on vacation, you see the original signer's name as well as the overriding signer's name.

After signing has begun, you can also see the time the person signed the document, the signature type, and any other additional comments the signer includes. The status of a signer changes from pending to completed after the signing process is complete.

Note: The following steps are for a FULL signing implementation. If your system is set up for e-initials, then only the signing window displays. Also, you cannot set up Ad Hoc signers with e-initials. For details on e-initials, refer to the section on Implementing E-Records.

To sign a document online:

  1. Navigate to the List of Signers window by sending a document for approval.

  2. The following information displays:

  3. View any related events associated to the current event. In the E-signatures History section, there is a References section that contains links to any parent or child events related to the current event. During the signing process, these events are available through the link. These events are viewed based on the following scenarios:

  4. Click the Sign icon on the List of Signers window next to your name. The E-signature Event window displays. This window includes all the e-record header information, as well as the flexfield information about the record, and a link to the attached document.

  5. Answer the prompt I have read the e-record at the bottom of the window.

  6. Select a Signing Reason, if applicable.

  7. Enter a Signer Comment, if applicable.

  8. Select the appropriate Signature Type. You can also configure this list in the Workflow.

  9. Click Approve to complete the signing process, Reject to fail the document, or Cancel to stop the signing process. Cancel brings you back to the List of Signers window. If the document is approved or rejected, then the Sign window displays. This window displays the information entered into the previous window.

  10. Enter your username and password to sign the document.

  11. Click Submit to view the Confirmation window. Cancel brings you back to the previous window.

  12. Ensure that all the information on the Confirmation window is correct. This information includes the name of the event, the e-record ID, the identfier, the identifier value, and the current status of the e-record.

  13. Click OK to complete the process.

To defer the signing process:

  1. Click Submit on the List of Signers window. This can be done before anyone has signed, or after people have begun to sign.

  2. The message Are you sure you want to defer the e-signature process. On deferring the e-signature, offline workflow notifications would be sent out for obtaining the e-signature appears. Click Yes to defer the signing process and view the Confirmation window or No to return to the List of Signers window.

  3. Ensure that all the information on the Confirmation window is correct. This information includes the name of the event, the e-record ID, the identifier, the identifier value, and the current status of the e-record.

  4. Click OK to complete the process.

  5. The Files Approval window displays, and notifications are sent to all the signers.

Signing With E-Initials

If you have set up your system to sign with e-initials, then the E-signatures window displays, rather than the List of Signers window.

To sign with e-initials:

  1. Select the file to send for approval.

  2. Click Send for Approval. The E-signatures window displays. The following information displays:

  3. Enter the Signature Type, which is the type of signer. For example, reviewer or author. This list is configurable in Workflow.

  4. Select a Response, which is either Approve or Reject. Depending on how the system is set up, if the response entered is Reject, no other signer can continue, the process is terminated.

  5. Enter any Comments, if applicable.

  6. Enter your username and password to sign the document.

  7. Click the Sign icon to complete the signature process.

  8. Click Submit after all signatures are obtained.

Updating Signers

Based on system setup, you can update the list of existing signers for a document. This change is only for the single document being sent for approvals.

To update the signers:

  1. Click Update Signers on the List of Signers window. The Update Signers window displays.

  2. From this window, you can delete a signer, add new signers, or continue through to reordering signers.

To delete a signer:

  1. Click the Delete icon next to the name of the person to be deleted on the Update Signers page. A message displays Are you sure you want to remove this default signer?

  2. Click Yes to delete the signer, and Cancel to return to the previous window.

Adding Signers

Adding signers can include adding a single person, or a group of people. No one can be added twice. So, if someone is a single signer to a document and a group is added that the signer is part of, then the rest of the group is added, but that signer is not added again.

To add signers:

  1. Click Add Signer on the Update Signers window. The Add Signer window displays.

  2. Select the search criteria or enter a name or partial name with wildcard. You can search by Group, User, or User ID.

  3. Select the users or group you want to add as signers. If the user or group is already part of the signing list, then the select box is disabled.

  4. Click Apply. The Reorder Signers window displays.

Reordering Signers

You can change the order of the signers. This change is only valid for the document you are signing. This window does not appear if your event is set up for parallel signing.

To reorder signers:

  1. Select the name of the signer to move.

  2. Click the up or down arrows to move one space at a time, or click the top or bottom arrows to move to the beginning or end of the list.

  3. When you have finished reordering the users, or you do not want to change the order, click Finish. The List of Signers window displays.

Managing Templates Using iSignatures

Oracle E-Records supports both XSL and RTF stylesheets. A stylesheet is uploaded into the system using the EDR E-record Templates category.

For XSL stylesheets, there can be a subscription enabled, XSL Upload. If the subscription is enabled for the event, then after approvals are complete, the stylesheet moves to the XSL repository and can be used to create new e-records. Update the input configuration variables for the event to recognize the new stylesheet name and version.

For RTF stylesheets, after being uploaded into the system, the file is processed using the Oracle XML Publisher API. The RTF template is uploaded into the XDO repository and centrally controlled by XDO. An XDO API then generates the PDF. The subscription RTF Upload must be enabled. The file is stored in the XDO Repository. Refer to the Oracle XML Publisher User's Guide for more details.

Oracle E-Records includes the print count as part of the header information when printing e-records. Therefore, you must not include print count as part of your RTF document.

Linking a Document to a Website

You can link to an iSignatures document from a web site. The document that appears is based on the version, so if a new version is uploaded, then either the link needs to change or you can continue to point to the older version of the document.

The GetDocument.htm File

You must create a document named GetDocument.htm and place it in a public directory. This is an example of the GetDocument.htm file.

         <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
				<title>iSign Repository</title>
				<script language="javascript">
								<!-- Define the isign host name and port -->
								 var isign_host = "";

			<!-- Define the dbc filename without extension -->
			var dbcfile = "";
 										<!-- Define the protocol -->
										var protocol = "http";
								   	<!-- Define the path for OA.jsp -->
                             var oajsp = "/OA_HTML/jsp/edr/FilePreview.jsp?a=a";

                           <!-- do not modify these variables -->

                           var url = protocol + "://" + isign_host + oajsp;
                           var filecategory = "";
                           var filename ="";
                           var uname= ;
                              var idx ='$');

                           <!-- get the handle to the url search and pick the filename and category -->
                              valLength = uname.length ;
                              if (idx != -1) {
                                   var pairs = uname.substring(1, valLength).split('$');
                        filecategory = pairs[0];
                        filename = pairs[1];



                           <!-- attach a random number to the url, to avoid caching issues -->
                           var rand = Math.random();

                           url = url + "&rand=" + rand;
                           if (filecategory != null && filecategory != "")
                                    url = url + "&fileCategory=" + filecategory;
                           if (filename != null && filename != "")


                                   url = url + "&fileName=" + filename;

                                   <!-- create frameset to not expose the isign url -->
                                    document.write("<frameset border=0 frameborder=no framespacing=0 rows=\"*\">");
                                    document.write("<frame name='isign' src='" + url + "' frameborder='no' scrolling='auto' noresize marginheight=10 marginwidth=10 framespacing=0>");

                                    document.write("Viewing this page requires a browser capable of displaying frames");


                                   <!-- throw error if filename is not a part of the url -->


                                    document.write("Invalid url format.");


Setting Up the URL

The beginning of every URL must be:


The ... must be replaced with the location of the GetDocument.htm file.

The end of every link is a combination of the category and filename. For example, if the URL is pointing to a Technical Design with the name isign_v1.1.txt, then the end of the link is:


Therefore, the entire link is: