1 PACKAGE Eng_Workflow_Ext AUTHID CURRENT_USER AS
2 /* $Header: ENGXWKFS.pls 115.4 2004/05/27 22:52:43 mkimizuk ship $ */
3
4
5 -- API name : StartCustomWorkflow
6 -- Type : Extenstion
7 -- Pre-reqs : None.
8 -- Function : Place folder where users can add their own custom logic
9 -- for customized workflows while starting Workflow Process.
10 -- This procedure called from Eng_Workflow_Util.StartWorkflow
11 -- after creating process and before starting the process
12 --
13 --
14 -- Parameters :
15 -- IN :
16 -- p_validation_level IN NUMBER Optional
17 -- Identifies validation Level
18 -- e.g. FND_API.G_VALID_LEVEL_FULL
19 -- x_item_type IN VARCHAR2 Required
20 -- Identifies workflow item type
21 -- p_process_name IN VARCHAR2 Required
22 -- Identifies workflow process name
23 -- p_change_id IN NUMBER Optional
24 -- Identifies Change Object
25 -- p_change_line_id IN NUMBER Optional
26 -- Identifies Change Object
27 -- p_wf_user_id IN NUMBER Required
28 -- Identifies Workflow Owner
29 -- p_host_url IN VARCHAR2 Required
30 -- Identifies Host URL for OA Page
31 -- p_action_id IN NUMBER Optional
32 -- Identifies Action for Workflow
33 -- p_adhoc_party_list IN VARCHAR2 Optional
34 -- Identifies paties being assigned to a task for Workflow
35 -- e.g Comment Request wf process will send request ntf to them
36 -- p_route_id IN NUMBER Optional
37 -- Identifies Workflow Routing for Approval Routing
38 -- p_route_step_id IN NUMBER Optional
39 -- Identifies Workflow Routing Step for Approval Routing
40 -- p_object_name IN VARCHAR2 Required
41 -- Identifies Object Name
42 -- p_object_id1 IN NUMBER Required
43 -- Identifies Object
44 -- p_object_id2 IN NUMBER Optional
45 -- Identifies Object
46 -- p_object_id3 IN NUMBER Optional
47 -- Identifies Object
48 -- p_object_id4 IN NUMBER Optional
49 -- Identifies Object
50 -- p_object_id5 IN NUMBER Optional
51 -- Identifies Object
52 -- p_parent_object_name IN VARCHAR2 Optional
53 -- Identifies Parent Object Name
54 -- p_parent_object_id1 IN NUMBER Optional
55 -- Identifies Parent Object
56 --
57 -- OUT : x_return_status OUT NOCOPY VARCHAR2(1)
58 -- x_msg_count OUT NOCOPY NUMBER
59 -- x_msg_data OUT NOCOPY VARCHAR2(2000)
60 -- IN OUT :
61 -- x_item_key IN OUT NOCOPY VARCHAR2
62 -- Identifies workflow item key
63 -- Version : Current version 1.0 Initial Creation
64 -- Initial version 1.0
65 --
66 -- Notes : Note text
67 PROCEDURE StartCustomWorkflow
68 ( p_validation_level IN NUMBER := NULL
69 , x_return_status OUT NOCOPY VARCHAR2
70 , x_msg_count OUT NOCOPY NUMBER
71 , x_msg_data OUT NOCOPY VARCHAR2
72 , p_item_type IN VARCHAR2
73 , x_item_key IN OUT NOCOPY VARCHAR2
74 , p_process_name IN VARCHAR2
75 , p_change_id IN NUMBER := NULL
76 , p_change_line_id IN NUMBER := NULL
77 , p_wf_user_id IN NUMBER -- User Id
78 , p_host_url IN VARCHAR2
79 , p_action_id IN NUMBER := NULL
80 , p_adhoc_party_list IN VARCHAR2 := NULL
81 , p_route_id IN NUMBER := NULL
82 , p_route_step_id IN NUMBER := NULL
83 , p_parent_item_type IN VARCHAR2 := NULL
84 , p_parent_item_key IN VARCHAR2 := NULL
85 , p_object_name IN VARCHAR2 := NULL
86 , p_object_id1 IN NUMBER := NULL
87 , p_object_id2 IN NUMBER := NULL
88 , p_object_id3 IN NUMBER := NULL
89 , p_object_id4 IN NUMBER := NULL
90 , p_object_id5 IN NUMBER := NULL
91 , p_parent_object_name IN VARCHAR2 := NULL
92 , p_parent_object_id1 IN NUMBER := NULL
93 ) ;
94
95
96 -- API name : AbortCustomWorkflow
97 -- Type : Extenstion
98 -- Pre-reqs : None.
99 -- Function : Place folder where users can add their own custom logic
100 -- for customized workflows while abortting Workflow Process.
101 -- This procedure called from Eng_Workflow_Util.AbortWorkflow
102 -- before aborting the process or releasing 'BLOCK_ABORT' activity
103 --
104 -- Parameters :
105 -- IN :
106 -- p_validation_level IN NUMBER Optional
107 -- Identifies validation Level
108 -- e.g. FND_API.G_VALID_LEVEL_FULL
109 -- p_item_type IN VARCHAR2 Required
110 -- Identifies workflow item type
111 -- p_item_key IN VARCHAR2 Required
112 -- Identifies workflow item key
113 -- p_process_name IN VARCHAR2 Optional
114 -- Identifies workflow process name
115 -- p_wf_user_id IN NUMBER Required
116 -- Identifies Workflow Owner
117 -- OUT : x_return_status OUT NOCOPY VARCHAR2(1)
118 -- x_msg_count OUT NOCOPY NUMBER
119 -- x_msg_data OUT NOCOPY VARCHAR2(2000)
120 -- Version : Current version 1.0 Initial Creation
121 -- Initial version 1.0
122 --
123 -- Notes : Note text
124 PROCEDURE AbortCustomWorkflow
125 ( p_validation_level IN NUMBER := NULL
126 , x_return_status OUT NOCOPY VARCHAR2
127 , x_msg_count OUT NOCOPY NUMBER
128 , x_msg_data OUT NOCOPY VARCHAR2
129 , p_item_type IN VARCHAR2
130 , p_item_key IN VARCHAR2
131 , p_process_name IN VARCHAR2 := NULL
132 , p_wf_user_id IN NUMBER -- User Id
133 ) ;
134
135
136 -- API name : GetCustomMessageSubject
137 -- Type : Extenstion
138 -- Pre-reqs : None.
139 -- Function : Workflow PL/SQL Document API to get ntf custom message subject.
140 -- Place folder where users can add their own custom logic
141 -- for customized message while Workflow getting ntf information.
142 -- This procedure called from Eng_Workflow_NTF_Util.GetMessageSubject
143 --
144 -- Return your message if you want to put your custom ntf message subject
145 --
146 -- Parameters : Please refer to workflow guide
147 -- p_document_id IN VARCHAR2 Required
148 -- Format:
149 -- <wf item type>:<wf item key>:<&#NID>
150 PROCEDURE GetCustomMessageSubject
151 ( document_id IN VARCHAR2
152 , display_type IN VARCHAR2
153 , document IN OUT NOCOPY VARCHAR2
154 , document_type IN OUT NOCOPY VARCHAR2
155 ) ;
156
157
158 -- API name : GetCustomMessageBody
159 -- Type : Extenstion
160 -- Pre-reqs : None.
161 -- Function : Workflow PL/SQL CLOB Document API to get ntf custom message body.
162 -- Place folder where users can add their own custom logic
163 -- for customized message while Workflow getting ntf information.
164 -- This procedure called from Eng_Workflow_NTF_Util.GetMessageTextBody
165 -- or GetMessageHTMLBody
166 --
167 -- Return your message body if you want to put your custom ntf message body
168 --
169 -- Parameters : Please refer to workflow guide
170 -- p_document_id IN VARCHAR2 Required
171 -- Format:
172 -- <wf item type>:<wf item key>:<&#NID>
173 --
174 PROCEDURE GetCustomMessageBody
175 ( document_id IN VARCHAR2
176 , display_type IN VARCHAR2
177 , document IN OUT NOCOPY CLOB
178 , document_type IN OUT NOCOPY VARCHAR2
179 ) ;
180
181
182 -- API name : RespondToNtf
183 -- Type : Extenstion
184 -- Pre-reqs : None.
185 -- Function : Place folder where users can add their own custom logic
186 -- to be executed while responding seeded ToDo notifications.
187 -- This procedure called from Eng_Workflow_Pub notification call-back
188 -- procedures.
189 --
190 -- Parameters :
191 -- IN
192 -- itemtype - type of the current item
193 -- itemkey - key of the current item
194 -- actid - process activity instance id
195 -- funcmode - function execution mode. this is set by the engine
196 -- as 'RUN', 'RESPOND'. . .
197 -- result
198 --
199 --
200 PROCEDURE RespondToNtf
201 ( x_return_status OUT NOCOPY VARCHAR2
202 , x_msg_count OUT NOCOPY NUMBER
203 , x_msg_data OUT NOCOPY VARCHAR2
204 , p_item_type IN VARCHAR2
205 , p_item_key IN VARCHAR2
206 , p_actid IN NUMBER
207 , p_func_mode IN VARCHAR2
208 , p_result IN VARCHAR2
209 ) ;
210
211 END Eng_Workflow_Ext ;
[Home] [Help]