Oracle E-Records has utilities that let you maintain your system. You can view XML and e-record information from within the application. This information can be used to verify XML and XSL information, as well as e-record layouts prior to the event being used. You can also update or delete existing indexed XML elements, or add new elements.
This chapter covers the following topics:
The XML Generator window is used to generate an XML document using a specific map code and document ID. The resulting XML document is then displayed for technical review, or subsequently copied into the e-record generator with an XSL style document to view the readable electronic record.
Developers can use this utility to verify if their XML mapping is correct.
Navigate to the XML Generator window by selecting Generate XML.
Select the Event Map Code from the list of values. The map code is created in XML Gateway.
Enter the Event Key, which is the value for the root element.
Click Generate. The XML is generated and then displayed on the window. Click Clear All to start over.
The E-record Generator window lets you see the e-record format based on given XML and XSL documents. If you need to make changes to your XML or XSL, once the changes are made, then rerun this utility to see the new e-record format. Once the XSL is correct, upload it into the database for it to take effect for any generated e-records.
Navigate to the E-record Generator window by selecting Generate E-record Document.
Paste your XML document into the XML field. Required.
Paste your XSL style document into the XSL field. Required.
Click Generate. The format for the e-record document displays. Click Clear All to start over.
This feature enables customers and users to validate whether the required setup for any business event is complete. A user selects the business event and transaction key, and the application checks all the setup required such as profile options, configuration variables, approval setup, workflow subscriptions and e-record templates to enable a business event for e-signatures. Users can review approvers, approval rules, and associated input configuration variable values. The user can validate generated XML and e-record formats and content before deploying it to the production environment.
Some of the use cases for this utility, include:
A developer implementing e-signature for a transaction can review the final XML in order to create the AME transaction attribute definitions (which require XPATH expressions to be written using the final XML).
A developer implementing e-signature for a transaction completes development and wants to test the setup for a particular instance of a business transaction. This transaction can have data that is different from the data in the raw XML file used to create the map at development time.
A developer modifies the XML map for the transaction and wants to validate the setup based on the new map.
An Administrator makes changes in the AME rules with new approvers for a new set of rules and wants to validate the setup.
You can select data either from a database to verify already transacted information, or from an object, when you have raw XML, and want to test how it can be transformed. In addition, if you complete a transaction with failures, you can turn on the EDR: Developer Mode profile option putting the system into debug mode, rerun the event, and the raw XML is stored in the EDR_RAW_XML_TL table.
Refer to "Running E-record Event Setup Verification report" for additional information.
Navigate to the Validate Event window.
Enter the Event name you want to validate.
Select the Database Data Source.
Enter the Event Key you want to validate against.
Click Validate. The Event Details window displays with all the current information about the selected event.
Navigate to the Validate Event window.
Enter the Event name you want to validate.
Select the View Object Data Source.
Enter the Raw XML Payload you want to use for the validation. If you have run the event in Developer Mode then you do not need to enter the XML Payload, as the system pulls the information from the EDR_RAW_XML_TL table.
Enter the Event Key you want to validate against.
Click Validate. The Event Details window displays with all the current information about the selected event.
The Event Details window displays information about the event and event key combination you are validating.
This section displays two profile options that are critical to the setup of e-records. These are EDR: E-records and E-signatures and Server Time Zone.
The meta data section displays information about the business event, the business event subscriptions and their associated parameters. If this information is not correct, navigate to the Workflow Business Events window to make any necessary changes.
The run time data section displays information about the AME rules, approvers, and any routing rule overrides that are currently set up. To change this information, you must navigate to the Oracle Approval Management window and complete the setup.
In addition, this section displays all the configuration variable information. If this information is not correct, navigate to the Configuration Variables window to make any necessary changes.
The XML payload section displays the raw XML as it is currently set for this event. Click Export to download this XML to your machine so you can make changes to it.
The e-record section displays the actual e-record for this event. This can be either a text version or RTF version, depending on how the e-record is set up.
When creating an indexed XML element, it can be defined as a query element, a secure element, or both. A query element is used in the E-record Query window and lets you view e-records based on one or many elements. A secure element is used to set up security rules. Restrict or grant access based on an element.
Navigate to the XML Elements window.
Click Create Element. The Create XML Element window displays.
Enter the Owner Application short name. Required.
Enter the Display Name. This name appears in the generic query when querying e-records and the page used to create security rules. Required.
Enter the XML Element. Only the XML elements belonging to the ERES events of the particular application are shown in the list of values. Required.
Enter the name of the Document Type Definition. The DTDs in the list of values contain the element already selected. You then select a DTD knowing which event it applies to. Normally, this is left blank.
Enter the Description, which is an internal descriptive name for the element.
Select the Query Element and Secure Element options where applicable. The Query Element option lets you see this element on the E-record Query window, and the Secure Element option lets you use the element for setting up security rules.
Click Apply. The element is created in a non-indexed state.
Run the E-record Indexed XML Element Maintenance program. Refer to "Setting Up Indexed XML Elements" for details.
All e-records are XML documents consisting of many XML elements. An XML element which is indexed and used for special purposes such as querying or creating security rules is called an Indexed XML Element.
The search criteria is not case sensitive and handles trailing wild cards. For example, searching for abc returns all matches for abc% and ABC%.
Navigate to the XML Element window.
Search for elements in the system. You can enter criteria to narrow your search.
Enter the XML Element name.
Enter the Display Name.
Enter the Status of the Element. Required. Valid options are:
Indexed displays only indexed XML elements
Not Indexed displays all non-indexed XML elements
All displays all XML elements
Click Go. The elements display in the Results section of the window. The following information displays for each record:
Owner displays the product family that owns the element.
Display Name displays the long description name of the element.
XML Element displays the name of the element.
Document Type Definition displays the DTD that the element is from.
Status displays whether the element is Indexed or Not Indexed. An indexed element can be used for searching e-records and creating security rules if they have been identified as query or secure elements. A non-indexed element is indexed by running the E-record Indexed XML Element Maintenance program.
You can view the details for the Indexed XML elements. You cannot make any changes from this window.
Click Details for the element. The XML Element:<element_name> window displays.
View details about the element including the General Details, Element Usage, and Event Details.
Basic information about an element can be updated. You can add or change the Document Type Definition (DTD), add a description for the element, and modify whether the element is Query or Secure.
Click Update from the XML Element window. The Update XML Indexed window displays.
Make any modifications to the element information:
Add or change the Document Type Definition Name.
Add or change the Definition of the element.
Change the Query Element and Secure Element options.
Click Apply.
Run the E-record Indexed XML Element Maintenance program. Refer to "Setting Up Indexed XML Elements" for details.
Click Delete from the XML Indexed Element window. A warning window displays.
Click Yes to delete the element.
Run the E-record Indexed XML Element Maintenance program. Refer to "Setting Up Indexed XML Elements" for details.
When new, deleted, or changed XML elements are synchronized into the system, they are available for query on all existing records in the system. To make them available for query on new elements, the Oracle E-records XML Element Synchronization Program must be run.
This program is run in the background as a cron job. It is run as often as necessary, based on the amount of querying done in your system. For example, if your system has several hundred records entered every day, and there is a need to have the ability to query these records immediately, then have this program run every hour.
Navigate to the Submit Request window from the ERES Administrator responsibility.
Enter Oracle E-records XML Element Synchronization Program in the Name field.
Click Schedule.
Select the necessary information to schedule the program and save the new schedule.
Click Submit.
View or print the report.
When indexes are added, changed, or deleted the system does not remove the old information and replace it with the new information. Instead, new rows are added which over time causes fragmentation of the table. This can cause performance problems during query. The Oracle E-records XML Element Optimization Program cleans up the fragmented information to help improve performance. This program can be run as often as needed, based on the use of your system.
Navigate to the Submit Request window from the ERES Administrator responsibility.
Enter Oracle E-records XML Element Optimization Program in the Name field.
Enter the Optimization Level. Valid options are Fast which only defragments the table and Full which defragments the table and removes old data.
Enter the Minutes for each optimization which determines the number of minutes the program runs.
Click Submit.
View or print the report.
In Oracle E-records, temporary tables are populated to complete the signature process and for reporting purposes. The tables used for these purposes are EDR_ERECORDS, EDR_ESIGNATURES, and EDR_TRANS_QUERY_TEMP. Once the process is complete and all reporting is done, the data is no longer used. This program lets you clean these tables.
Navigate to the Submit Request window from the ERES Administrator responsibility.
Enter E-records Temporary Data Cleanup in the Name field.
Click Submit.
The Framework Verification window lets you test the components of the framework without dependencies to any other products. This lets you validate the framework setup in an environment separate from setups in Oracle Applications.
The Framework Verification window can be used in four modes; deferred allowed, online only, offline only, and offline using forms library. The difference between offline and offline using forms library is that it invokes the AddTransaction and POST Forms Commit procedures. These procedures now support DB mode being passed as a parameter. Now, the corresponding files are modified to handle the DB mode as a parameter to the Add Transaction call.
The Oracle Application Framework (OAF) can also be enabled for e-records and e-signatures, without any additional setup required.
You can use attachments with this verification utility. The attached files are shown along with the e-record.
This window also supports descriptive flexfields. When an e-record is generated, you can see all the flexfield information associated to that e-record.
The following components are added to use with this window, which have no connection to any other product:
A model to support inserts and updates from a window.
An Oracle window that acts on the above data model with attachments and descriptive flexfields enabled.
A business event that is raised from the above window when an insert happens.
An Approval Management Transaction that represents the approval matrix.
DTD and XML maps that represent the business event data.
An XSL stylesheet that represents the e-record.
The ability to have Multilingual Support (MLS).
Debug mode
Multiple Query modes
The Single Event Framework Verification window can be used for testing different aspects of the framework setup. Different fields are populated based on the part of the framework you are testing.
Verify that the EDR: E-records and E-Signatures profile option is set to Yes.
Verify that the Framework Verification Event (oracle.apps.edr.framework.test) subscription is enabled.
Navigate to Transaction Type Configuration Variables and set ESIGNATURE_REQUIRED to Y.
Create an approval group in AME with at least two approvers.
Define a Rule and associate approval group. This step is mandatory to test e-signatures from the Framework Verification window.
Navigate to the ERES Framework Verification window.
Enter the information for the test record:
Test No. is a new, unique, alphanumeric ID for this test record. After it is saved, it can be used again in query mode. Required.
Description is a short description of the test record.
Numeric Value is any number for testing numeric format in the framework setup.
Date Value is a date entered based on the system date configuration that lets you test the date format in the framework setup.
Debug Mode can be set to On or Off. If it is set on, then messages of what is happening during process display.
Signature Mode can be online only, offline only, deferred, or offline using forms library. This is required when raising an ERES event.
Query Key Type tells the EDR_STANDARD package how to build the where clause when form call for transaction query from the E-record Details option on the Actions menu. It is required only when you want to see the e-record details. The valid values are:
Append %When the event Key is passed to EDR_STANDARD.PSIG_QUERY, it builds dynamic SQL for the event key as ' event_key like '||event_key||'%'.
Prepend %When the event key is passed to EDR_STANDARD.PSIG_QUERY, it builds dynamic SQL for the event key as ' event_key like '||'%' ||event_key.
Apply % Both SidesWhen event Key is passed to EDR_STANDARD.PSIG_QUERY, it builds dynamic SQL for the event key as ' event_key like '||'%' ||event_key||'%'.
Use Equal ConditionWhen the event key is passed to EDR_STANDARD.PSIG_QUERY, it builds dynamic SQL for the event key as ' event_key = '|event_key.
Signature Status is not an active field. It displays the current state of the test record. This field is initially blank, but changes to the status of the current record as it goes through the signature process.
The Descriptive Flexfield lets you enter information into a number of flexfield attributes. You can then see this information on the e-record.
Navigate to the ERES Framework Verification window.
Enter required data.
Set Signature Mode to Deferred Allowed.
Save the record. The signature process starts.
Complete the signature process for one user and click Finish.
Close the window and respond to the message window. This sets the signature status to Pending.
Navigate to the worklist of the next approver and respond to the notification. If the second user also approves, then when you query the record it displays as Complete. If the second user rejects, then it displays as Rejected assuming there are only two users in the approval group.
Navigate to the ERES Framework Verification window.
Enter required data.
Set Signature Mode to Offline only.
Save the record. This sets the signature status to Pending.
Navigate to the approvers worklist and respond to the notification.
Repeat Step 5 for all approvers.
Navigate to the ERES Framework Verification window.
Enter required data.
Set Signature Mode to Offline using forms library.
Save the record. This sets the signature status to Pending.
Navigate to the approvers worklist and respond to the notification.
Repeat Step 5 for all approvers.
Navigate to the ERES Framework Verification window.
Enter required data.
Set Signature Mode to Online only.
Save the record. This sets the signature status to Pending. The signature windows display.
Complete the signature process for one user and click Finish. If you click Finish or close the browser without completing the signature process, then the window does not save any changes.
Navigate to the ERES Framework Verification window.
Query for a record that has completed the signature process.
Select E-record Details from the Actions menu.
Navigate to the ERES Framework Verification window.
Query for an existing record and select Request Signature from the Actions menu.
Query for an existing record.
Click the attachment icon and attach a file or long text.
Set Category to either Other or Miscellaneous.
Select Request Signature from the Actions menu. The e-record displays the attachment along with the e-record.
The Inter Event Framework Verification window lets you test the related events set up in your system to ensure the set up was completed successfully.
The system is seeded with four events for testing related events:
| Event Name | Display Name |
|---|---|
| oracle.apps.edr.InterEvt.Event1 | EDR ERES Inter Event Verification Event 1 |
| oracle.apps.edr.InterEvt.Event2 | EDR ERES Inter Event Verification Event 2 |
| oracle.apps.edr.InterEvt.Event3 | EDR ERES Inter Event Verification Event 3 |
| oracle.apps.edr.InterEvt.Event4 | EDR ERES Inter Event Verification Event 4 |
| oracle.apps.edr.OAFInterEvent1 | EDR ERES OAF Inter Event Verification Event 1 |
| oracle.apps.edr.OAFInterEvent2 | EDR ERES OAF Inter Event Verification Event 2 |
| oracle.apps.edr.OAFInterEvent3 | EDR ERES OAF Inter Event Verification Event 3 |
| oracle.apps.edr.OAFInterEvent4 | EDR ERES OAF Inter Event Verification Event 4 |
You can set up test scenarios with a hierarchy of events to replicate the inter event signature process. This lets you test the setup of your system without modifying the existing environment, or adding any unnecessary data into the Evidence Store.
Navigate to the Inter Event Test Scenarios Navigator from the EDR Administrator responsibility.
Right-click on the root node Test Scenarios. The shortcut menu displays.
Select Add Test Scenario. The Test Scenario window displays.
Enter the Test Scenario name.
Enter the Test Scenario Instance.
Select the Test Scenario Type for the new test. This can be either Forms for a Forms-based test or OAF for an Oracle Applications Framework test.
Select the Debug Mode for the test. Debug can be either On or Off.
The Descriptive Flexfield lets you enter information into a number of flexfield attributes. You can then see this information on the e-record.
Click Save to save the new test scenario.
Either collapse and expand the root node or click Refresh from the right-click shortcut window to view the new test scenario.
Navigate to the Inter Event Test Scenarios Navigator from the EDR Administrator responsibility.
Right-click on the test scenario to copy. The shortcut menu displays.
Select Copy Test Scenario. The Test Scenario window displays.
Enter the new Test Scenario name.
Enter the new Test Scenario Instance.
Select the Debug Mode for the test. Debug can be either On or Off.
Click Save to save the copied test scenario.
Either collapse and expand the root node or click Refresh from the right-click shortcut window to view the new test scenario.
Navigate to the Inter Event Test Scenarios Navigator from the EDR Administrator responsibility.
Right-click on the test scenario and select Show Test Scenario Details from the shortcut menu. The Test Scenario window displays.
View the information for the test scenario.
Set the Debug Mode if necessary.
Click Save if the debug mode was changed or Cancel to exit the window.
Navigate to the Inter Event Test Scenarios Navigator from the EDR Administrator responsibility.
Right-click on the test scenario to send for signatures.
Click Request E-signature from the shortcut menu. The List of Signers window displays.
Proceed through the signature process normally.
After the signature process is complete, you can select E-record Details from the Actions menu. The E-record Details window displays with all the details about the signatures. If the test was sent for multiple signatures, then this displays all the records.
After the signature process is complete, you can select E-record Details from the Actions menu. The E-record Details window displays with all the details about the signatures. If the test was sent for multiple signatures, then this displays only the last record.
Query for an existing record.
Click the attachment icon and attach a file or long text.
Set Category to either Other or Miscellaneous.
Select Request Signature from the Actions menu. The e-record displays the attachment along with the e-record.
You can add several events to a test scenario. These events have an established hierarchy, which are grouped together. Below the test scenario, you can have three levels of events.
Navigate to the Inter Event Test Scenarios Navigator from the EDR Administrator Responsibility.
Right-click on the test scenario where you want to add an event and click Add Event. The Event window displays.
Select the Event Name to be raised from the list of values.
Enter the Execution Order. This dictates the order in which the events are raised.
Select the Signature Mode for the event. This can be online only, offline only, or deferred and is required when raising an ERES event.
Select the Execution Mode for the event as either Raise with Other Events or Raise Separate.
The execution mode determines how to group events for the signature process. For example, set up a hierarchy which has Event4 associated to Event3, Event3 associated to Event2, and Event2 associated to Event1. If you select Raise Separate for Event2, then Event1 and Event2 are run first, then Event3 and Event4 are run. If you select Raise with Other Events, then they are all raised at the same time.
The Related Event Name field is blank if the event being added is the highest level event. This field displays when adding Related Events to an existing event.
Either collapse and expand the root node or click Refresh from the right-click shortcut window to view the new event.
Navigate to the Inter Event Test Scenarios Navigator from the EDR Administrator Responsibility.
Right-click on the event name to add a related event to and click Add Related Event. The Event window displays.
Select the Event Name to be raised from the list of values.
Enter the Execution Order. This dictates the order in which the events are raised.
Select the Signature Mode for the event. This can be online only, offline only, or deferred and is required when raising an ERES event.
Select the Execution Mode for the event as either Raise with Other Events or Raise Separate.
The execution mode determines how to group events for the signature process. For example, set up a hierarchy which has Event4 associated to Event3, Event3 associated to Event2, and Event2 associated to Event1. If you select Raise Separate for Event2, then Event1 and Event2 are run first, then Event3 and Event4 are run. If you select Raise with Other Events, then they are all raised at the same time.
The Related Event Name field displays the name of the event directly above in the hierarchy when adding Related Events to an existing event.
Either collapse and expand the root node or click Refresh from the right-click shortcut window to view the new event.
Navigate to the Inter Event Test Scenarios Navigator from the EDR Administrator Responsibility.
Right-click on the event and select Show Event Details from the shortcut menu. The Event window displays.
Edit the Execution Order, Signature Mode, and Execution Mode if necessary.
Click Save if any information changed or Cancel to exit the window.
Once a event has completed approvals, it can be necessary to launch another event. For example, after all approvals are complete, it can be necessary to send Workflow notifications to other people to let them know the event is complete. You can use the Approval Completion event and subscription as a hook to initiate another event. This can be used both through the forms and as an API. For details on setting up this event, refer to the Oracle E-Records Developer's Guide.