1 package PA_WORKPLAN_WORKFLOW_CLIENT AUTHID CURRENT_USER as
2 /*$Header: PAXSTWCS.pls 120.6 2006/07/20 12:11:41 vkadimes noship $*/
3 /*#
4 * This extension enables you to customize the workflow processes for submitting, approving, and publishing a workplan.
5 * @rep:scope public
6 * @rep:product PA
7 * @rep:lifecycle active
8 * @rep:displayname Workplan Workflow Extension
9 * @rep:compatibility S
10 * @rep:category BUSINESS_ENTITY PA_PROJECT
11 * @rep:category BUSINESS_ENTITY PA_TASK
12 * @rep:doccd 120pjapi.pdf See the Oracle Projects API's, Client Extensions, and Open Interfaces Reference
13 */
14
15 /*#
16 * This procedure starts the workflow process for a workplan.
17 * @param p_item_type The workflow item type
18 * @rep:paraminfo {@rep:required}
19 * @param p_item_key The workflow item key
20 * @rep:paraminfo {@rep:required}
21 * @param p_process_name Name of the workflow process
22 * @rep:paraminfo {@rep:required}
23 * @param p_structure_version_id Identifier of the structure version
24 * @rep:paraminfo {@rep:required}
25 * @param p_responsibility_id Identifier of the user responsibility
26 * @rep:paraminfo {@rep:required}
27 * @param p_user_id Identifier for the user
28 * @rep:paraminfo {@rep:required}
29 * @param x_msg_count API standard: number of error messages
30 * @rep:paraminfo {@rep:required}
31 * @param x_msg_data API standard: error messageThe
32 * @rep:paraminfo {@rep:required}
33 * @param x_return_status API standard: return status of the API (success/failure/unexpected error)
34 * @rep:paraminfo {@rep:required}
35 * @rep:scope public
36 * @rep:lifecycle active
37 * @rep:displayname Start Workflow.
38 * @rep:compatibility S
39 */
40 procedure START_WORKFLOW
41 (
42 p_item_type IN VARCHAR2
43 ,p_item_key IN VARCHAR2
44 ,p_process_name IN VARCHAR2
45 ,p_structure_version_id IN NUMBER
46 ,p_responsibility_id IN NUMBER
47 ,p_user_id IN NUMBER
48 ,x_msg_count OUT NOCOPY NUMBER --File.Sql.39 bug 4440895
49 ,x_msg_data OUT NOCOPY VARCHAR2 --File.Sql.39 bug 4440895
50 ,x_return_status OUT NOCOPY VARCHAR2 --File.Sql.39 bug 4440895
51 );
52 /*#
53 * This procedure determines the approver for the workplan approval process.
54 * @param p_item_type The workflow item type
55 * @rep:paraminfo {@rep:required}
56 * @param p_item_key The workflow item key
57 * @rep:paraminfo {@rep:required}
58 * @param actid Identifier of the action
59 * @rep:paraminfo {@rep:required}
60 * @param funcmode Workflow function mode
61 * @rep:paraminfo {@rep:required}
62 * @param resultout Process result
63 * @rep:paraminfo {@rep:required}
64 * @rep:scope public
65 * @rep:lifecycle active
66 * @rep:displayname Select Approver
67 * @rep:compatibility S
68 */
69 procedure SELECT_APPROVER
70 (
71 p_item_type IN VARCHAR2
72 ,p_item_key IN VARCHAR2
73 ,actid IN NUMBER
74 ,funcmode IN VARCHAR2
75 ,resultout OUT NOCOPY VARCHAR2 --File.Sql.39 bug 4440895
76 );
77 /*#
78 * This procedure determines which users receive workflow notifications when a workplan is submitted, approved, rejected, or published.
79 * @param p_item_type The workflow item type
80 * @rep:paraminfo {@rep:required}
81 * @param p_item_key The workflow item key
82 * @rep:paraminfo {@rep:required}
83 * @param p_status_code The workplan status code
84 * @rep:paraminfo {@rep:required}
85 * @param actid Identifier of the action
86 * @rep:paraminfo {@rep:required}
87 * @param funcmode Workflow function mode
88 * @rep:paraminfo {@rep:required}
89 * @param resultout Process result
90 * @rep:paraminfo {@rep:required}
91 * @rep:scope public
92 * @rep:lifecycle active
93 * @rep:displayname Set Notification Party
94 * @rep:compatibility S
95 */
96 procedure set_notification_party
97 (
98 p_item_type IN VARCHAR2
99 ,p_item_key IN VARCHAR2
100 ,p_status_code IN VARCHAR2
101 ,actid IN NUMBER
102 ,funcmode IN VARCHAR2
103 ,resultout OUT NOCOPY VARCHAR2 --File.Sql.39 bug 4440895
104 );
105
106
107 /*#
108 * This API is a client extension. While publishing a workplan version, if user chooses the option of
109 * Review and Publish Workplan, a preview document is sent as a notification to all the project stakeholders
110 * which contains the details of the version to be published. This client extension API lets the user customize this
111 * preview document.
112 * @param document_id Unique Identifier of the Preview Document.
113 * @rep:paraminfo {@rep:required}
114 * @param display_type Display type of the Preview Document
115 * @rep:paraminfo {@rep:required}
116 * @param document The actual document content.
117 * @rep:paraminfo {@rep:required}
118 * @param document_type Document Type
119 * @rep:paraminfo {@rep:required}
120 * @rep:scope public
121 * @rep:lifecycle active
122 * @rep:displayname Show Workplan Preview.
123 * @rep:compatibility S
124 */
125 procedure show_workplan_preview
126 (document_id IN VARCHAR2,
127 display_type IN VARCHAR2,
128 document IN OUT NOCOPY clob, --File.Sql.39 bug 4440895
129 document_type IN OUT NOCOPY VARCHAR2); --File.Sql.39 bug 4440895
130
131 /*#
132 * This procedure enables you to specify the lead time between the start of the task execution
133 * workflow process and start date of the associated task.
134 * execution lead time before which task execution workflow process should be started . The project
135 * identifier,task identifier and the task execution workflow item type will be passed to client extension
136 * so that task execution lead time can be set per task.
137 * @param p_item_type The workflow item type
138 * @rep:paraminfo {@rep:required}
139 * @param p_task_number Unique identifier of the task for which the lead time needs to be set
140 * @rep:paraminfo {@rep:required}
141 * @param p_project_number The unique Oracle Projects number for the project
142 * @rep:paraminfo {@rep:required}
143 * @param x_lead_days Lead days (number of days to start the workflow ahead of the task start date of the associated task)
144 * @rep:paraminfo {@rep:required}
145 * @rep:scope public
146 * @rep:lifecycle active
147 * @rep:displayname Set Lead Days
148 * @rep:compatibility S
149 */
150 procedure SET_LEAD_DAYS
151 (
152 p_item_type IN VARCHAR2 :='PATSKEX'
153 ,p_task_number IN VARCHAR2
154 ,p_project_number IN VARCHAR2
155 ,x_lead_days OUT NOCOPY NUMBER --File.Sql.39 bug 4440895
156 );
157
158
159 end PA_WORKPLAN_WORKFLOW_CLIENT;
[Home] [Help]