1 package etrm_static as
2 g_index_url varchar2(512) := 'http://etrm-test.us.oracle.com/static/etrm_index.html';
3 g_base_url varchar2(512) := 'http://etrm-test.us.oracle.com/';
4
5 g_product_dependency_text varchar2(32000) :=
6 '<p>This report shows external dependencies for a product. It lists views in this application that reference tables or views in other applications along with tables and views in this application that
7 are used in the views of another application. For example, if an AR view selects from tables in AR and AP,
8 the AR version of this report will list the AP dependencies (but not the AR ones). Please note: the report does not include dependencies to file system objects or database objects (e.g. packages) that do not appear in the Applications FND model.</p>';
9
10 g_legal_text1_r11 varchar(32000) :=
11 '<h1>Oracle eBusiness Suite Technical Reference</h1>
12 <h5>Release 11i - and/or its affiliates. All rights reserved.<h5>
13 ';
14 g_legal_text1_r12 varchar(32000) :=
15 '<h1>Oracle eBusiness Suite Technical Reference</h1>
16 <h5>Release 12 - and/or its affiliates. All rights reserved.<h5>
17 ';
18 g_legal_text2 varchar(32000) :=
19 '<p class="OraCopyright">
20 This software and related documentation are provided under a license agreement containing restrictions on use and disclosure and are protected by intellectual property laws. Except as expressly permitted in your license agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license, transmit, distribute, exhibit, perform, publish, or display any part, in any form, or by any means. Reverse engineering, disassembly, or decompilation of this software, unless re
21 quired by law for interoperability, is prohibited.
22
23 </p>
24 <p class="OraCopyright">
25 The information contained herein is subject to change without notice and is not warranted to be error-free. If you find any errors, please report them to us in writing.
26 </p>
27 <p class="OraCopyright">
28 If this is software or related documentation that is delivered to the U.S. Government or anyone licensing it on behalf of the U.S. Government, the following notice is applicable:
29 <br/>U.S. GOVERNMENT END USERS: Oracle programs, including any operating system, integrated software, any programs installed on the hardware, and/or documentation, delivered to U.S. Government end users are "commercial computer software" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations. As such, use, duplication, disclosure, modification, and adaptation of the programs, including any operating system, integrated software, any programs install
30 ed on the hardware, and/or documentation, shall be subject to license terms and license restrictions applicable to the programs. No other rights are granted to the U.S. Government.
31
32 </p>
33 <p class="OraCopyright">
34 This software or hardware is developed for general use in a variety of information management applications. It is not developed or intended for use in any inherently dangerous applications, including applications that may create a risk of personal injury. If you use this software or hardware in dangerous applications, then you shall be responsible to take all appropriate fail-safe, backup, redundancy, and other measures to ensure its safe use. Oracle Corporation and its affiliates disclaim any l
35 iability for any damages caused by use of this software or hardware in dangerous applications.
36
37 </p>
38 <p class="OraCopyright">
39 Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.
40 <br/>Intel and Intel Xeon are trademarks or registered trademarks of Intel Corporation. All SPARC trademarks are used under license and are trademarks or registered trademarks of SPARC International, Inc. AMD, Opteron, the AMD logo, and the AMD Opteron logo are trademarks or registered trademarks of Advanced Micro Devices. UNIX is a registered trademark of The Open Group.
41 </p>
42 <p class="OraCopyright">
43 This software or hardware and documentation may provide access to or information on content, products, and services from third parties. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to third-party content, products, and services. Oracle Corporation and its affiliates will not be responsible for any loss, costs, or damages incurred due to your access to or use of third-party content, products, or services.
44 </p>
45 <p class="OraCopyright">
46 This documentation is in preproduction status and is intended for demonstration and preliminary use only. It may not be specific to the hardware on which you are using the software. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to this documentation and will not be responsible for any loss, costs, or damages incurred due to the use of this documentation.
47 </p>
48 <p class="OraCopyright">
49 The information contained in this document is for informational sharing purposes only and should be considered in your capacity as a customer advisory board member or pursuant to your beta trial agreement only. It is not a commitment to deliver any material, code, or functionality, and should not be relied upon in making purchasing decisions. The development, release, and timing of any features or functionality described in this document remains at the sole discretion of Oracle.
50 <br/>This document in any form, software or printed matter, contains proprietary information that is the exclusive property of Oracle. Your access to and use of this confidential material is subject to the terms and conditions of your Oracle Software License and Service Agreement, which has been executed and with which you agree to comply. This document and information contained herein may not be disclosed, copied, reproduced, or distributed to anyone outside Oracle without prior written consent
51 of Oracle. This document is not part of your license agreement nor can it be incorporated into any contractual agreement with Oracle or its subsidiaries or affiliates.
52
53 </p>
54 <p class="OraCopyright">
55 ORACLE CONFIDENTIAL. For authorized use only. Do not distribute to third parties.
56 </p>
57 <p class="OraCopyright">
58 For information about Oracle's commitment to accessibility, visit the Oracle Accessibility Program website at <a href="http://www.oracle.com/pls/topic/lookup?ctx=acc&id=docacc">http://www.oracle.com/pls/topic/lookup?ctx=acc&id=docacc</a>.
59 </p>
60 <p class="OraCopyright">
61 Access to Oracle Support
62 </p>
63 <p class="OraCopyright">
64 Oracle customers have access to electronic support through My Oracle Support. For information, visit <a href="http://www.oracle.com/pls/topic/lookup?ctx=acc&id=info">http://www.oracle.com/pls/topic/lookup?ctx=acc&id=info</a> or visit <a href="http://www.oracle.com/pls/topic/lookup?ctx=acc&id=trs">http://www.oracle.com/pls/topic/lookup?ctx=acc&id=trs</a> if you are hearing impaired.
65 </p>';
66 g_help_text varchar2(32767) :=
67 '
68 <h1>eTRM Electronic Technical Reference Manual version 3.1 Help</h1>
69 <h5>About eTRM</h5>
70 <pre>
71 eTRM version 3.1
72 and/or its affiliates. All rights reserved.
73 </pre>
74 <p>eTRM was designed and developed by Peter Goldthorp from Oracle Applications Development Services Division.</p>
75
76
77
78 <h3>What is eTRM?</h3>
79
80 <h5>eTRM Overview</h5>
81 <p>eTRM is a pl/sql utility which reads design information in an Oracle database
82 and displays its output in html format.</p>
83
84 <h5>What information will I find in the eTRM?</h5>
85 <p>The eTRM shows you a web-based view of the Oracle Applications data model.
86 It provides access to schema object definitions and descriptions.</p>
87
88 <h5>What about ER/Database diagrams?</h5>
89 <p>ER or database schema diagrams are available as pdf files for most products.
90 They can be accessed from the FND tab</p>
91
92 <h3>
93 How do I use eTRM?</h3>
94 <p>
95 eTRM has 3 access modes:</p>
96 <ol>
97 <li> Search</li>
98 <li> FND (FND Model)</li>
99 <li> DBA (Data Dictionary)</li>
100 </ol>
101 <p>Each mode is presented on a separate html tab.</p>
102
103 <h5>Search Access</h5>
104 <p>
105 The Search tab is the opening page for eTRM. It allows you to perform search engine queries against the table and column descriptions in the FND Model. eTRM performs an intermedia text search on the descriptions in FND_TABLES, FND_VIEWS and FND_COLUMNS using the text you enter on the search form. For example, if you enter ''contract compliance'' and then press ''Search'', eTRM will look for tables, views and columns that contain that phrase. The search engine tries to present the most relev
106 ant entries at the top of the list. It uses the following logic for this: first it counts the number of column descriptions that include an exact match for the phrase. Tables with a large column count (many column descriptions match the phrase) will be listed above ones with a lower count. If an ''exact match'' search does not return many entries. eTRM will perform a second search. This time it looks for descriptions that contain <i>any</i> of the words in the search condition</p>
107
108 <p>
109 The search form can also be used for quick navigation to data dictionary objects. The search form will find objects that match the exact name (no wildcards) entered in the search condition. For example entering ''per_people_f'' in the form, will list the view itself in addition to any objects that include the word ''per_people_f'' in their description.</p>
110
111 <h5>DBA Data Dictionary Access</h5>
112 <p>The DBA tab provides an html form to query the dba_objects view. The form allows navigation using drill down navigation or query values. For example you can enter ''AMS\_%'' (without the quotes) in the Object Name field to see a count by schema of objects that start with ''AMS_''. If you click on one of the object types it will display a list of them. Clicking on one of the items in the list will cause its definition to be displayed in a separate window.</p>
113 <p>
114 Object definition and dependency information is available for every item. In addition to this, eTRM includes custom reports for tables, views and pl/sql packages. These provide additional details such as columns and index information for tables. The opening page on the DBA tab allows navigation by schema or product prefix. The product prefix option provides a short cut for populating the Object Name field. This will show the distribution of objects that use the product prefix. Please note t
115 hat this may not represent a complete list of items that belong to that product. Some products use more than one prefix.</p>
116
117
118 <h5>FND Model Access</h5>
119 <p>
120 The FND tab allows access to the FND Model. Applications databases hold design information in a series of (FND_) tables. This information records details that are not available from the data dictionary (dba_objects). For example, views are mapped to the products that own them in the FND model. Primary and foreign key constraints represent another example. These constraints are registered in the FND model but are not typically implemented in the product. The FND tab provides a mechanism to
121 access these properties.</p>
122
123
124 <p>It shows design data for tables, views, concurrent programs and quick codes. The FND tab acts as a navigator for this data. You can query by product, object name or object type. The navigator allows you to drill down to find the name of an individual table, view, concurrent program or quick code. When you click on the name the object''s definition is displayed in a separate window. This window will include a hypertext link to the dba information if it is available. Static files are also
125 available from the FND tab.</p>
126
127
128 <p>Most of the content that eTRM displays is generated dynamically; each mouse click causes a new database query. This means eTRM will always show the current structure of the database. It never gets out of sync. Unfortunately, it presents problems for people who want to work off-line. Static files are designed to address this. They are self contained pdf and html files that contain diagrams, extracts and summaries of the data that is contained in eTRM.</p>
129
130 <h5>What information is eTRM showing me?</h5>
131 <p>Once you have told eTRM what object you want information on (by doing
132 the object search or by navigating the virtual appl_top until you have
133 reached the required object), you will be presented with a report that
134 shows both traditional Technical Reference Manual information and dependency
135 information. This report will include different information for different
136 types of objects, but for example, if you were to have selected a table,
137 you would see the following:
138 <ul>
139 <li>Table description (where present)</li>
140 <li>Primary keys</li>
141 <li>Unique keys</li>
142 <li>Foreign keys</li>
143 <li>References to the table as a lookup</li>
144 <li>Indexes</li>
145 <li>Columns (with descriptions where present)</li>
146 </ul>
147
148
149
150 <h3>FAQ/Problems</h3>
151
152 <h5>What if I encounter a problem with the eTRM system?</h5>
153 <p>Any bugs or problems encountered with the eTRM system should be reported
154 to the associated product support organization. These types of issues
155 may be reported by submitting a MetaLink Itar.</p>
156
157
158 <h5>Are eTRM''s available for all products?</h5>
159 <p>Currently, the Applications product suite is the only group which
160 publishes the Technical Reference manuals electronically. For a
161 complete and detailed list of products, navigate to the FND tab.</p>
162
163 <h5>Will eTRM''s be made available for other products in the future?</h5>
164 <p>Technical Reference manuals are produced for every production product in
165 the Applications eBusiness suite. New products will be added to eTRM as they
166 are added to the suite.</p>
167
168 <h5>Can I request that eTRM''s be made available for other products?</h5>
169 <p>eTRM was developed to publish technical reference information for products in the
170 eBusiness Suite. There are no plans to expand this to products outside the suite.</p>
171
172 <h5>May I request or order hard copies of Technical Reference Manuals?</h5>
173 <p>eTRM replaces the paper based Technical Reference Manuals we produced in the past.
174 Technical Reference Manuals are available in hard copy format for Applications version
175 11.5.1 and earlier. Technical reference information for 11.5.4 and later versions of
176 Applications will be published via eTRM. ''Static'' html files are included in the published eTRM. These can be downloaded for offline working. Static files are available from the FND tab.</p>
177
178 <h5>How is the eTRM data obtained?</h5>
179
180 <p>The majority of the data upon which eTRM reports, is obtained from the objects and schemas within an eBusiness database itself. Some data (such as diagrams and descriptions) is pulled from a separate Oracle Designer Repository and added to the data natively available in the database.</p>
181
182 <h5>Is there any way with eTRM to see the differences between any two point releases?</h5>
183
184 <p>Not at the moment. This feature is being considered for a future release of eTRM.</p>
185
186 <h5>Can I add eTRM to my own database (on customer site for instance)</h5>
187
188 <p>No. Currently eTRM is available only via MetaLink. The idea of supplying eTRM directly to customers is being reviewed for possible inclusion in a future release.</p>
189
190 <h5>I don''t like eTRM. Can I get something like the old printed manuals please?</h5>
191
192 <p>No. eTRM has completely replaced the old paper manuals. It is possible to download certain static reports (provided with eTRM) and then print these for reference.</P>
193
194 <h5>The earlier version used to contain a link which explains possible values for a particular column. e.g. pay.pay_payroll_actions.action_type column, which has a specific set of possible values. But in Ver 3.0 of eTRM, there is no means of knowing such a vital information. Where can I find the required information?</h5>
195
196 <p>The eTRM team has received several requests for this feature to be put (back) into eTRM. The reason it was available before, was that eTRM used to run against an Oracle Designer case repository. This repository provided the required data natively. Now that eTRM (v3) runs against a live E-Business database - making it much more accurate and complete - the required data is not available as easily (if at all).</p>
197
198 <h5>I''m looking for TRMs for the following modules, the eTRM web site provides on line information for specific objects, but is it possible to have everything in one pdf file?
199 <ul>
200 <li>Bills Of Material,</li>
201 <li>Customer Support and Services,</li>
202 <li>Order Management,</li>
203 <li>Global Accounting Engine,</li>
204 <li>Self Service Purchasing,</li>
205 <li>Projects,</li>
206 <li>Application Object Library/Workflow</li>
207 </ul>
208 </h5>
209
210 <p>Unfortunately no. As you may know, the Apps TRMs are no longer produced in PDF format. eTRM reports on all products included in a given Apps point release (i.e. in the rapid install database for that release). Due to its dynamic nature, eTRM can currently provide only html format reports. Selected information from each product is downloadable as a file for printing etc but not in PDF format.</p>
211
212 <h5>I can login into Metalink OK but, whren I try to get to the eTRM docs the site asks me to login in again - then I get a link to eTRMs, press it and am asked to login again - around and around in a loop. Can you help?</h5>
213
214 <p>We have occasionally seen this type of issue before; it usually stems from one of the following:</p>
215 <ol>
216 <li><b>Cookie problem:</b> delete your cookies and temporary internet files and then close or restart all browser windows before trying to access eTRM again.</li>
217 <li><b>Cookies not accepted on client machine:</b> reconfigure the browser cookie setting to accept cookies.</li>
218 <li><b>The CSI number used is a "partner" CSI:</b> Partner CSIs are explicitly prevented access to eTRM due to the detailed clickthrough agreement that must be accepted by customers when accessing eTRM for the first time.</li>
219 <li><b>Environment issues:</b> Check to see if you can access eTRM using your CSI on another PC and/or internet connection? If yes, this will rule out any problem with the CSI number. If you are not able to access eTRM on another PC and/or network connection - preferably one NOT behind a firewall (using the CSI you gave), we must look again at the CSI. If you *are* able to do this, say on a different network connection, then the firewall you are using would be the most likely culprit.</li
220 >
221
222 <li><b> A firewall at the client site is preventing eTRM traffic from passing successfully:</b> This can be tricky and may require you to consult with your firewall admin. If you have successfully used eTRM before (with the same client machine and on the same network), perhaps something was amended on your firewall in the interim. If you are on a home connection, is there a personal firewall running? If you do have a personal firewall or similar, please try disabling it and try eTRM again.
223 We have seen issues with access to eTRM where the customer''s firewall has an HTTP proxy feature for outgoing traffic which modifies or blocks HTTP requests sent from the user''s browser. If you are behind a corporate firewall, you may need to talk with your firewall admin to identify this.</li>
224
225 </ol>
226
227 ';
228
229 g_etrm_home1 varchar2(32767) :=
230 '<h5>Oracle eBusiness Suite Electronic Technical Reference Manual - eTRM</h5>';
231
232 g_etrm_home2 varchar2(32767) :=
233 '<p><b>eTRM</b> is a pl/sql utility that reads design information in an Oracle database and displays its output in html format. It shows database design and dependency information for the Oracle eBusiness Suite. Enter the name of a database object (example: per_people_f) or a search condition (example: contract compliance) then press ''Search'' to search for information. Alternatively you can browse the FND Model or Oracle Data Dictionary from the FND or DBA tabs</p>
237 <p><b>Send us your comments! </b>
234
235 <!-- Beginning of Feedback Section -->
236
238 Email the <a href="mailto:[email protected]?subject=MetaLink Feedback - Self-Service Index">Web Page Manager</a> to report broken hyperlinks or
239 share your comments and ideas. Your comments will be routed to the Knowledge Team for evaluation.</p>
240 <p>Please note: The Web Page Manager cannot process requests for information, technical support or other questions. Contact your local support center to submit technical support requests.
241
242 Use the MetaLink <a href="http://metalink.oracle.com/metalink/plsql/fee_main.startup">Feedback</A> feature for all other requests including licensing issues.
243 </p>
244 <p><b>Known Issues: </b>
245
246 The source text of a materialized view is machine-generated from the corresponding logical view (#) and does not represent the developer definition of the view query. We plan to enhance eTRM to provide the MV logical source text in a future update.
247 </p>
248
249 <!-- End of Feedback Section -->';
250
251
252
253
254 function index_url return varchar2;
255 function base_url return varchar2;
256 function legal_text return varchar2;
257 function help_text return varchar2;
258 function etrm_home1 return varchar2;
259 function etrm_home2 return varchar2;
260 function product_dependency_text return varchar2;
261 end etrm_static;
[Home] [Help]