1 package icx_admin_sig as
2 /* $Header: ICXADSIS.pls 120.0 2005/10/07 12:11:54 gjimenez noship $ */
3
4 /* Procedure help_win_script should be called from within the header section
5 of an html page to insert javascript code that can then be called to
6 display the help text in a seperate browser window.
7
8 Parameters:
9
10 defHlp: This is the target that you wish to call for the given
11 Self Service Applications Page that is currently being
12 displayed. The Technical Writers should be adding the
13 appropriate targets in the documentation to support your calling
14 the proper help page with the correct context.
15
16 language_code:
17 This is the language you wish to display the help content in.
18 If for some reason you do not plan to translate some or all of
19 you help content then you can override the users current
20 language preference setting with a hardcoded value.
21 I recommend you do not pass a value for this setting
22 so that the function will use the current language preference
23 for that user.
24 If the help content does not exist for the given target
25 and language then the user will be presented with a list of
26 languages where the target does exist.
27
28 application_short_name:
29 This tells the iHelp system which product owns the
30 iHelp documentation content. This application_short_name
31 will be used to select the appropriate target for a
32 given product. The documentation would have been staged
33 under this product when it was originally loaded
34 into the system.
35 */
36 procedure help_win_script (
37 defHlp in varchar2 default null,
38 language_code in varchar2 default null,
39 application_short_name in varchar2 default 'ICX');
40
41 /* Called by OAPageLayoutBean in the OA framework to implement the
42 Global Menu help button. Need this API because JDBC setBoolean API
43 does not work with Oracle. Since we need to call the
44 we can't use the fnd_help.get_url with helpsystem parameter set to
45 false - we have to create this api to pass in the appropriate value.
46 */
47
48 function icx_fnd_help (
49 defHlp in varchar2 default null,
50 p_application_id in number default 178) return varchar2;
51
52
53 /*
54 ** Return the proper syntax for generating the help_win javascript function
55 ** but don't pipe it out to htp. This is used by BIS in their reports.
56 */
57 function help_win_syntax (
58 defHlp in varchar2 default null,
59 language_code in varchar2 default null,
60 application_short_name in varchar2 default 'ICX') return VARCHAR2;
61
62 /* function background returns the url to the background gif */
63 function background (language_code in varchar2 default null ) return varchar2;
64
65 /* procedure header paints the header used by all of the admin screens.
66 This header contains the ICXLOGO.gif and icons that link to Functions,
67 Responsibilities, Register Web Users, Universal Home Page, and Help text */
68 procedure Openheader(defStatus in varchar2 default null, extraOnLoad in varchar2 default null,language_code in varchar2 default null);
69 procedure Closeheader (language_code in varchar2 default null);
70 procedure Closeheader2 (language_code in varchar2 default null);
71
72 /*
73 ** displays the toolbar
74 ** Parameters:
75 ** language_code - language ex. 'US'
76 ** disp_find - 'Y' display the find button on toolbar
77 ** 'N' do not dislay the find button
78 ** disp_wizard - 'Y' display the wizard button on the toolbar
79 ** 'N' do not display the wizard
80 ** disp_help - 'Y' display the help button on the toolbar
81 ** 'N' do not display the help
82 ** disp_export - 'Y' display the export button on the toolbar
83 ** 'N' do not display the help
84 ** disp_exit - 'Y' display the exit button on the toolbar
85 ** 'N' do not display the exit
86 */
87 procedure toolbar (language_code in varchar2 default null,
88 disp_find in varchar2 default null,
89 disp_mainmenu in varchar2 default 'Y',
90 disp_wizard in varchar2 default 'N',
91 disp_help in varchar2 default 'Y',
92 disp_export in varchar2 default null,
93 disp_exit in varchar2 default 'Y');
94
95 procedure Startover(language_code in varchar2 default null);
96 /* procedure footer paints the footer used by all of the admin screens.
97 This folter contains the WebApps email address. */
98 procedure footer;
99
100 /* procedure error_screen displays an error message in its own html page.
101 This screen is used to display database-side errors from the admin pages.
102 It displays an icon with a link to the previous page, and the error text.
103 If api_msg_count and api_msg_data are passed then error_screen will also
104 display all of the sessions api error messages */
105 procedure error_screen (title varchar2,
106 language_code in varchar2 default null,
107 api_msg_count in number default null,
108 api_msg_data in varchar2 default null);
109
110 /*procedure showTable displays an table with retrieved rows from a pl/sql table
111 and put it in a nice formatted html table. In the procedure that calls
112 showTable has to define a table as type of pp_table. row_count is the number
113 of rows to pass, col_num is the number of colmns to display with passed data
114 other parameters are html specifications. */
115
116 type pp_table is table of varchar2(5000) index by binary_integer;
117 procedure showTable(p_table pp_table,
118 row_count in binary_integer default 0,
119 col_num in binary_integer default 0,
120 p_border in binary_integer default 0,
121 p_cellpadding in binary_integer default 0,
122 p_cellspacing in binary_integer default 0,
123 p_width in binary_integer default 0,
124 p_cell_width in binary_integer default 0,
125 p_indent in binary_integer default 0,
126 img in varchar2 default 'FNDIBLBL.gif');
127
128 procedure displayTable(wlcm_table pp_table,
129 row_count in binary_integer default 0,
130 col_num in binary_integer default 0,
131 language_code in varchar2 default null,
132 img in varchar2 default 'FNDIGRBL.gif');
133 end icx_admin_sig;
[Home] [Help]