1 PACKAGE IEM_KnowledgeBase_PUB AUTHID CURRENT_USER as
2 /* $Header: iemvknbs.pls 115.8 2003/07/31 01:21:18 sboorela shipped $ */
3 -- *****************************************************
4 -- Start of Comments
5 -- Package name : IEM_KnowledgeBase_PUB
6 -- Purpose : Public Package. PL/SQL KB apis. The eMC client has access
7 -- to various Java query and retrieval APIs provided direclty
8 -- by the SMS and MES teams. These are to be used to query and
9 -- retrieve documents from these KBS.
10 -- History : mpawar 12/19/99
11 -- : rtripath 12/25/99 Developed The Body of The Package
12 -- NOTE :
13 -- End of Comments
14 -- *****************************************************
15
16 TYPE EMSGRESP_rec_type IS RECORD (
17 DOCUMENT_ID VARCHAR2(50) ,
18 SCORE VARCHAR2(30) ,
19 KB_REPOSITORY_NAME VARCHAR2(100) ,
20 KB_CATEGORY_NAME VARCHAR2(100) ,
21 DOCUMENT_TITLE VARCHAR2(100) ,
22 URL VARCHAR2(256) ,
23 DOCUMENT_LAST_MODIFIED_DATE DATE );
24
25
26 TYPE KBCAT_rec_type IS RECORD (
27 DISPLAY_NAME VARCHAR2(50) ,
28 IS_REPOSITORY VARCHAR2(1) ,
29 CATEGORY_ID number(15) ,
30 PARENT_CAT_ID number(15) ,
31 CATEGORY_ORDER NUMBER(5)
32 );
33 TYPE EMSGRESP_tbl_type IS TABLE OF EMSGRESP_rec_type
34 INDEX BY BINARY_INTEGER;
35
36 TYPE KBCAT_tbl_type IS TABLE OF KBCAT_rec_type
37 INDEX BY BINARY_INTEGER;
38
39 -- *******************************************************
40 -- Start of comments
41 -- API name : Get_SuggResponse
42 -- Type : Public
43 -- Function : This API returns a list of suggested responses for an
44 -- email. The document URL can be displayed on the GUI. The
45 -- URL should directly download a document to the client.
46 -- Pre-reqs : None.
47 -- Parameters :
48 -- IN
49 -- p_api_version IN NUMBER Required
50 -- p_init_msg_list IN VARCHAR2 Optional Default = FND_API.G_FALSE
51 -- p_commit IN VARCHAR2 Optional Default = FND_API.G_FALSE
52 -- p_EMAIL_ACCOUNT_ID IN NUMBER,
53 -- p_MESSAGE_ID IN VARCHAR2,
54 -- OUT
55 -- x_return_status OUT VARCHAR2
56 -- x_msg_count OUT NUMBER
57 -- x_msg_data OUT VARCHAR2
58 -- x_Email_SuggResp_tbl OUT EMSGRESP_tbl_type
59 --
60 -- Version : 1.0
61 -- Notes :
62 --
63 -- End of comments
64 -- **********************************************************
65 PROCEDURE Get_SuggResponse (p_api_version_number IN NUMBER,
66 p_init_msg_list IN VARCHAR2 ,
67 p_commit IN VARCHAR2 ,
68 p_EMAIL_ACCOUNT_ID IN NUMBER,
69 p_MESSAGE_ID IN VARCHAR2,
70 p_CLASSIFICATION_ID IN NUMBER,
71 x_return_status OUT NOCOPY VARCHAR2,
72 x_msg_count OUT NOCOPY NUMBER,
73 x_msg_data OUT NOCOPY VARCHAR2,
74 x_Email_SuggResp_tbl OUT NOCOPY EMSGRESP_tbl_type
75 );
76
77 -- *******************************************************
78 -- Start of comments
79 -- API name : Get_KBCategories
80 -- Type : Public
81 -- Purpose : This API is used to display a KB query screen to the agent
82 -- Each email account is mapped to relevant KBS and categories
83 -- within a KBS. This information is retrieved and displayed
84 -- on the GUI. It allows the agent to choose from a list of
85 -- available KBS and categories to search for documents
86 -- that can help him answer the email. This list of KBS and
87 -- categories different for each email account. The query is
88 -- invoked by calling a Java API.
89 -- Pre-reqs : None.
90 -- Parameters :
91 -- IN
92 -- p_api_version IN NUMBER Required
93 -- p_init_msg_list IN VARCHAR2 Optional Default = FND_API.G_FALSE
94 -- p_commit IN VARCHAR2 Optional Default = FND_API.G_FALSE
95 -- p_EMAIL_ACCOUNT_ID IN NUMBER,
96 -- p_LEVEL IN NUMBER := 1,
97 --
98 -- OUT
99 -- x_return_status OUT VARCHAR2
100 -- x_msg_count OUT NUMBER
101 -- x_msg_data OUT VARCHAR2
102 -- x_KB_Cat_tbl OUT KBCAT_tbl_type
103 --
104 -- Version : 1.0
105 -- Notes :
106 --
107 -- End of comments
108 -- **********************************************************
109 PROCEDURE Get_KBCategories (p_api_version_number IN NUMBER,
110 p_init_msg_list IN VARCHAR2 ,
111 p_commit IN VARCHAR2 ,
112 p_EMAIL_ACCOUNT_ID IN NUMBER,
113 p_LEVEL IN NUMBER := 1,
114 x_return_status OUT NOCOPY VARCHAR2,
115 x_msg_count OUT NOCOPY NUMBER,
116 x_msg_data OUT NOCOPY VARCHAR2,
117 x_KB_Cat_tbl OUT NOCOPY KBCAT_tbl_type
118 );
119 -- *******************************************************
120 -- Start of comments
121 -- API name : Delete_ResultsCache
122 -- Type : Public
123 -- Purpose : This API should be called when an email has been successfully
124 -- dealt with. It deleted the suggested responses to the named
125 -- email. It will also release any additional routing storage
126 -- associated with this email.
127 -- Pre-reqs : None.
128 -- Parameters :
129 -- IN
130 -- p_api_version IN NUMBER Required
131 -- p_init_msg_list IN VARCHAR2 Optional Default = FND_API.G_FALSE
132 -- p_commit IN VARCHAR2 Optional Default = FND_API.G_FALSE
133 -- p_EMAIL_ACCOUNT_ID IN NUMBER,
134 -- p_MESSAGE_ID IN VARCHAR2,
135 --
136 -- OUT
137 -- x_return_status OUT VARCHAR2
138 -- x_msg_count OUT NUMBER
139 -- x_msg_data OUT VARCHAR2
140 --
141 -- Version : 1.0
142 -- Notes :
143 --
144 -- End of comments
145 -- **********************************************************
146 PROCEDURE Delete_ResultsCache ( p_api_version_number IN NUMBER,
147 p_init_msg_list IN VARCHAR2 ,
148 p_commit IN VARCHAR2 ,
149 p_EMAIL_ACCOUNT_ID IN NUMBER,
150 p_MESSAGE_ID IN VARCHAR2,
151 x_return_status OUT NOCOPY VARCHAR2,
152 x_msg_count OUT NOCOPY NUMBER,
153 x_msg_data OUT NOCOPY VARCHAR2
154 );
155
156 -- THIS API IS NOT BEING CALLED NOW, MAY BE USEFUL LATER Currently
157 --get_suggresponse api is serving the purpose
158
159 PROCEDURE Get_KB_SuggResponse (p_api_version_number IN NUMBER,
160 p_init_msg_list IN VARCHAR2 ,
161 p_commit IN VARCHAR2 ,
162 p_EMAIL_ACCOUNT_ID IN NUMBER,
163 p_MESSAGE_ID IN VARCHAR2,
164 p_CLASSIFICATION_ID IN NUMBER,
165 x_return_status OUT NOCOPY VARCHAR2,
166 x_msg_count OUT NOCOPY NUMBER,
167 x_msg_data OUT NOCOPY VARCHAR2,
168 x_Email_SuggResp_tbl OUT NOCOPY EMSGRESP_tbl_type);
169
170 PROCEDURE Get_SuggResponse_dtl(p_api_version_number IN NUMBER,
171 p_init_msg_list IN VARCHAR2 ,
172 p_commit IN VARCHAR2 ,
173 p_EMAIL_ACCOUNT_ID IN NUMBER,
174 p_MESSAGE_ID IN VARCHAR2,
175 p_CLASSIFICATION_ID IN NUMBER,
176 x_return_status OUT NOCOPY VARCHAR2,
177 x_msg_count OUT NOCOPY NUMBER,
178 x_msg_data OUT NOCOPY VARCHAR2,
179 x_Email_SuggResp_tbl OUT NOCOPY EMSGRESP_tbl_type
180 );
181 -- This API is introduced in 11.5.0/MP-R. This will be called for showing alternate suggested response
182 -- Documents.
183 PROCEDURE Get_SuggResponse_dtl(p_api_version_number IN NUMBER,
184 p_init_msg_list IN VARCHAR2 ,
185 p_commit IN VARCHAR2 ,
186 p_EMAIL_ACCOUNT_ID IN NUMBER,
187 p_MESSAGE_ID IN VARCHAR2,
188 x_return_status OUT NOCOPY VARCHAR2,
189 x_msg_count OUT NOCOPY NUMBER,
190 x_msg_data OUT NOCOPY VARCHAR2,
191 x_Email_SuggResp_tbl OUT NOCOPY EMSGRESP_tbl_type
192 );
193 END IEM_KnowledgeBase_PUB;
[Home] [Help]