1 PACKAGE PA_TIME_CLIENT_EXTN AS
2 /* $Header: PAPSSTCS.pls 120.6 2006/07/29 11:40:08 skannoji noship $ */
3 /*#
4 * This extension enables you to provide a customized business message for expenditures during validation and approval.
5 * @rep:scope public
6 * @rep:product PA
7 * @rep:lifecycle active
8 * @rep:displayname Display Business Message
9 * @rep:compatibility S
10 * @rep:category BUSINESS_ENTITY PA_PROJECT
11 * @rep:category BUSINESS_ENTITY PA_LABOR_COST
12 * @rep:doccd 120pjapi.pdf See the Oracle Projects API's, Client Extensions, and Open Interfaces Reference
13 */
14
15 /*#
16 * This procedure enables you to provide a customized business message for expenditures during validation and approval.
17 * @param P_Timecard_Table The entire timecard in PL/SQL table format (used when the extension is called from Oracle Time and Labor)
18 * @rep:paraminfo {@rep:required}
19 * @param P_Module Application calling this extension (for example, OTL for Oracle Time and Labor)
20 * @rep:paraminfo {@rep:required}
21 * @param P_Expenditure_Id Identifier of the expenditure
22 * @rep:paraminfo {@rep:required}
23 * @param P_Person_id Identifier of employee who submitted the expenditure
24 * @rep:paraminfo {@rep:required}
25 * @param P_Week_Ending_Date Ending Date of the expenditure period
26 * @rep:paraminfo {@rep:required}
27 * @param X_Msg_Application_Name Short name of application defined in AOL (PA for Oracle Projects)
28 * @rep:paraminfo {@rep:required}
29 * @param X_Message_data Message Code
30 * @rep:paraminfo {@rep:required}
31 * @param X_Msg_Token1_Name Message token name to be used in message
32 * @rep:paraminfo {@rep:required}
33 * @param X_Msg_Token1_Value Message token value to be used in message
34 * @rep:paraminfo {@rep:required}
35 * @param X_Msg_Token2_Name Message token name to be used in message
36 * @rep:paraminfo {@rep:required}
37 * @param X_Msg_Token2_Value Message token value to be used in message
38 * @rep:paraminfo {@rep:required}
39 * @param X_Msg_Token3_Name Message token name to be used in message
40 * @rep:paraminfo {@rep:required}
41 * @param X_Msg_Token3_Value Message token value to be used in message
42 * @rep:paraminfo {@rep:required}
43 * @rep:scope public
44 * @rep:lifecycle active
45 * @rep:displayname Display Business Message
46 * @rep:compatibility S
47 */
48
49 -- =======================================================================
50 -- Start of Comments
51 -- API Name : Display_Business_Message
52 -- Type : Public
53 -- Pre-Reqs : None
54 -- Type : Procedure
55 --
56 --
57 -- This API will be used to generate a customized message which will
58 -- be displayed in the final review screen and supervisor approval screens.
59 --
60 -- The message generated by this API could be used to ensure that the
61 -- employees are billable to a specified percentage determined as follows.
62 --
63 -- (billable hours in timecard )/(total hours on timecard) *100
64 --
65 -- The messages are customizable by customers, hence the customer could
66 -- generate message that would display total number of hours, % utilization
67 -- etc.
68 --
69 --
70 -- Parameters:
71 -- IN
72 --
73 -- P_Timecard_Table Pa_Otc_Api.Timecard_Table -- Only populated when
74 -- P_Module is 'OTL'
75 -- P_Module VARCHAR2 - Possible values: SST or OTL
76 -- P_Expenditure_Id pa_expenditures_all.expenditure_id%TYPE DEFAULT NULL,
77 -- P_Person_id per_all_people_f.person_id%TYPE,
78 -- P_Week_Ending_Date Date,
79 --
80 -- OUT
81 --
82 -- X_Application_Name Fnd_Application.Application_short_name%TYPE,
83 -- X_Msg_Token1_Name Varchar2,
84 -- X_Msg_Token1_Value Varchar2,
85 -- X_Msg_Token2_Name Varchar2,
86 -- X_Msg_Token2_Value Varchar2,
87 -- X_Msg_Token3_Name Varchar2,
88 -- X_Msg_Token3_Value Varchar2
89
90 PROCEDURE Display_Business_Message(
91 P_Timecard_Table IN Pa_Otc_Api.Timecard_Table,
92 P_Module IN VARCHAR2,
93 P_Expenditure_Id IN pa_expenditures_all.expenditure_id%TYPE DEFAULT NULL,
94 P_Person_id IN per_all_people_f.person_id%TYPE,
95 P_Week_Ending_Date IN Date,
96 X_Msg_Application_Name OUT NOCOPY Fnd_Application.Application_short_name%TYPE,
97 X_Message_data OUT NOCOPY Varchar2,
98 X_Msg_Token1_Name OUT NOCOPY Varchar2,
99 X_Msg_Token1_Value OUT NOCOPY Varchar2,
100 X_Msg_Token2_Name OUT NOCOPY Varchar2,
101 X_Msg_Token2_Value OUT NOCOPY Varchar2,
102 X_Msg_Token3_Name OUT NOCOPY Varchar2,
103 X_Msg_Token3_Value OUT NOCOPY Varchar2);
104
105 PROCEDURE Set_Batch_Name (
106 p_expenditure_id IN NUMBER,
107 p_person_id IN NUMBER,
108 p_expenditure_ending_date IN DATE,
109 p_expenditure_organization_id IN NUMBER,
110 x_user_batch_name OUT NOCOPY VARCHAR2,
111 x_return_status OUT NOCOPY VARCHAR2,
112 x_msg_application_name OUT NOCOPY VARCHAR2,
113 x_message_data OUT NOCOPY VARCHAR2,
114 x_token_name1 OUT NOCOPY VARCHAR2,
115 x_token_val1 OUT NOCOPY VARCHAR2,
116 x_token_name2 OUT NOCOPY VARCHAR2,
117 x_token_val2 OUT NOCOPY VARCHAR2,
118 x_token_name3 OUT NOCOPY VARCHAR2,
119 x_token_val3 OUT NOCOPY VARCHAR2,
120 x_token_name4 OUT NOCOPY VARCHAR2,
121 x_token_val4 OUT NOCOPY VARCHAR2,
122 x_token_name5 OUT NOCOPY VARCHAR2,
123 x_token_val5 OUT NOCOPY VARCHAR2
124 );
125
126 -- =======================================================================
127 -- Start of Comments
128 -- API Name : Override_match_status
129 -- Type : Public
130 -- Pre-Reqs : None
131 -- Type : Procedure
132 -- Function : This procedure will be called for negative items
133 -- ( i.e quantity < 0 ) when the user submits a timecard
134 -- This extension allows the customers to convert an unmatched
135 -- negative item into a matched item( which will be matched by
136 -- Oracle Projects during transaction import). Conversely
137 -- customers can convert a matched reversal into an unmatched
138 -- negative.
139 --
140 -- Parameters :
141 -- IN
142 -- p_person_id Identifier of the employee
143 -- p_project_id Project Identifier of the item
144 -- p_task_id Task Identifier of the item,
145 -- p_expenditure_type Expenditure Type of the item
146 -- p_expenditure_type_class System Linkage Function of the item
147 -- p_expenditure_item_date Date of the item
148 -- p_quantity number of units for the transaction,
149 -- p_expenditure_comment Item Level comment
150 -- p_attribute_category Descriptive Flexfield context field
151 -- p_attribute1 Descriptive flexfield segment
152 -- p_attribute2 Descriptive flexfield segment
153 -- p_attribute3 Descriptive flexfield segment
154 -- p_attribute4 Descriptive flexfield segment
155 -- p_attribute5 Descriptive flexfield segment
156 -- p_attribute6 Descriptive flexfield segment
157 -- p_attribute7 Descriptive flexfield segment
158 -- p_attribute8 Descriptive flexfield segment
159 -- p_attribute9 Descriptive flexfield segment
160 -- p_attribute10 Descriptive flexfield segment
161 -- p_match_status Value of 'M'for Matched Item and 'U' for
162 -- Unmatched
163 -- x_match_status Return match status, return 'M' if you
164 -- want Oracle Projects to match this item
165 -- Return 'U' if you want to unmatch an item.
166 --
167 /*-------------------------------------------------------------------------*/
168
169 PROCEDURE Override_Match_Status(
170 p_person_id IN per_people_f.person_id%TYPE,
171 p_project_id IN pa_projects_all.project_id%TYPE,
172 p_task_id IN pa_tasks.task_id%TYPE,
173 p_expenditure_type IN pa_expenditure_types.expenditure_type%TYPE,
174 p_expenditure_type_class IN pa_system_linkages.function%TYPE,
175 p_expenditure_item_date IN pa_expenditure_items_all.expenditure_item_date%TYPE,
176 p_quantity IN pa_expenditure_items_all.quantity%TYPE,
177 p_expenditure_comment IN Varchar2,
178 p_attribute_category IN pa_expenditure_items_all.attribute_category%TYPE,
179 p_attribute1 IN pa_expenditure_items_all.attribute1%TYPE,
180 p_attribute2 IN pa_expenditure_items_all.attribute2%TYPE,
181 p_attribute3 IN pa_expenditure_items_all.attribute3%TYPE,
182 p_attribute4 IN pa_expenditure_items_all.attribute4%TYPE,
183 p_attribute5 IN pa_expenditure_items_all.attribute5%TYPE,
184 p_attribute6 IN pa_expenditure_items_all.attribute6%TYPE,
185 p_attribute7 IN pa_expenditure_items_all.attribute7%TYPE,
186 p_attribute8 IN pa_expenditure_items_all.attribute8%TYPE,
187 p_attribute9 IN pa_expenditure_items_all.attribute9%TYPE,
188 p_attribute10 IN pa_expenditure_items_all.attribute10%TYPE,
189 p_match_status IN Varchar2,
190 x_match_status OUT NOCOPY varchar2);
191
192
193 END PA_TIME_CLIENT_EXTN;
[Home] [Help]