DBA Data[Home] [Help]

PACKAGE: APPS.GL_WF_CUSTOMIZATION_PKG

Source


1 PACKAGE GL_WF_CUSTOMIZATION_PKG AUTHID CURRENT_USER AS
2 /* $Header: glwfcuss.pls 120.2 2002/11/13 04:33:28 djogg ship $ */
3 
4   --
5   -- Package
6   --   GL_WF_CUSTOMIZATION_PKG
7   -- Purpose
8   --   Procedures for Journal Approval Process's customizable activities
9   -- History
10   --   08/28/97   R Goyal      Created
11   --
12 
13 
14   --
15   -- Procedure
16   --   Is_Je_Valid
17   -- Purpose
18   --   Determines if the journal batch is valid. This procedure is called from
19   --   the GL Journal Approval Process activity named "Customizable: Is Journal
20   --   Batch Valid" in the Journal Approval Workflow definition file. You may want
21   --   to customize this activity by adding journal batch validation checks that
22   --   are not encompassed by the default checks GL provides. The GL Journal
23   --   Approval Process currently checks for:
24   --   (1) Non-opened period
25   --   (2) Control total violations
26   --   (3) Untaxed journals in a batch (JE tax enabled only)
27   --   (4) Unreserved funds (Budgetary control enabled only)
28   --   (5) Frozen budget (Budget batches only)
29   --   (6) Non-opened encumbrance year (Encumbrance batches only)
30   -- History
31   --   08/28/97     R Goyal     Created.
32   -- Arguments
33   --   itemtype   	   Workflow item type (JE Batch)
34   --   itemkey    	   Unique item key
35   --   actid		   ID of activity, provided by workflow engine
36   --   funcmode		   Function mode (RUN or CANCEL)
37   --   result		   Result of activity (COMPLETE:Y or COMPLETE:N)
38   --                       COMPLETE:Y (Workflow transition branch "Yes") indicates
39   --                                  that the journal batch is valid.
40   --                       COMPLETE:N (Workflow transition branch "No") indicates
41   --                                  that the journal batch is not valid.
42   -- Notes
43   --   You should only use the result codes listed above. Using unsupported
44   --   result codes may cause unexpected behavior.
45   --
46   PROCEDURE is_je_valid  (itemtype	IN VARCHAR2,
47 		          itemkey	IN VARCHAR2,
48                        	  actid      	IN NUMBER,
49                        	  funcmode    	IN VARCHAR2,
50                           result        OUT NOCOPY VARCHAR2 );
51 
52 
53   --
54   -- Procedure
55   --   Does_JE_Need_Approval
56   -- Purpose
57   --   Determines if the journal batch needs approval. This procedure is called
58   --   from the GL Journal Approval Process activity named "Customizable: Does
59   --   Journal Batch Need Approval" in the Journal Approval Workflow
60   --   definition file. You may want to customize this activity, for example, by
61   --   adding code to allow certain users to approve their own journal batches on
62   --   particular days within a period.
63   -- History
64   --   08/26/97      R Goyal    Created.
65   -- Arguments
66   --   itemtype   	   Workflow item type (JE Batch)
67   --   itemkey    	   Unique item key.
68   --   actid		   ID of activity, provided by workflow engine
69   --   funcmode		   Function mode (RUN or CANCEL)
70   --   result		   Result of activity (COMPLETE:Y or COMPLETE:N)
71   --                       COMPLETE:Y (Workflow transition branch "Yes") indicates
72   --                                  that the journal batch needs approval.
73   --                       COMPLETE:N (Workflow transition branch "No") indicates
74   --                                  that the journal batch does not need approval.
75   -- Notes
76   --   You should only use the result codes as listed above. Using unsupported
77   --   result codes may cause unexpected behavior.
78   --
79   PROCEDURE does_je_need_approval( itemtype	IN VARCHAR2,
80 				   itemkey  	IN VARCHAR2,
81 				   actid	IN NUMBER,
82 				   funcmode	IN VARCHAR2,
83 				   result	OUT NOCOPY VARCHAR2 );
84 
85 
86   --
87   -- Procedure
88   --   Can_Preparer_Approve
89   -- Purpose
90   --   Determines if the preparer can approve the journal batch. This procedure is
91   --   called from the GL Journal Approval Process activity named "Customizable:
92   --   Is Preparer Authorized to Approve" in the Journal Approval Workflow
93   --   definition file. You may want to customize this activity, for example, to
94   --   prevent a preparer from self-approving a journal batch based on the batch
95   --   period, journal source, or other attributes.
96   -- History
97   --   08/28/97      R Goyal    Created.
98   -- Arguments
99   --   itemtype   	   Workflow item type (JE Batch)
100   --   itemkey    	   Unique item key.
101   --   actid		   ID of activity, provided by workflow engine
102   --   funcmode		   Function mode (RUN or CANCEL)
103   --   result		   Result of activity (COMPLETE:Y or COMPLETE:N)
104   --                       COMPLETE:Y (Workflow transition branch "Yes") indicates
105   --                                  that the preparer can self-approve the journal
106   --                                  batch.
107   --                       COMPLETE:N (Workflow transition branch "No") indicates
108   --                                  that the preparer cannot self-approve the
109   --                                  journal batch.
110   -- Notes
111   --   You should only use the result codes as listed above. Using unsupported
112   --   result codes may cause unexpected behavior.
113   --
114   PROCEDURE can_preparer_approve( itemtype	IN VARCHAR2,
115 				  itemkey  	IN VARCHAR2,
116 				  actid	        IN NUMBER,
117 				  funcmode	IN VARCHAR2,
118 				  result	OUT NOCOPY VARCHAR2 );
119 
120 
121 
122   --
123   -- Procedure
124   --   Verify_Authority
125   -- Purpose
126   --   Determines if the approver has appropriate authority to approve the journal
127   --   batch. This procedure is called from the GL Journal Approval Process activity
128   --   named "Customizable: Verify Authority" within the "Customizable: Verify
129   --   Authority Process" in the Journal Approval Workflow definition file. You may
130   --   want to add your own checks to verify an approver's authority.  These customized
131   --   checks will supplement the standard authorization limit check performed by
132   --   the GL Journal Approval Process.
133   -- History
134   --   08/28/97      R Goyal    Created.
135   -- Arguments
136   --   itemtype   	   Workflow item type (JE Batch)
137   --   itemkey    	   Unique item key.
138   --   actid		   ID of activity, provided by workflow engine
139   --   funcmode		   Function mode (RUN or CANCEL)
140   --   result		   Result of activity (COMPLETE:PASS or COMPLETE:FAIL)
141   --                       COMPLETE:PASS (Workflow transition branch "Pass") indicates
142   --                                     that the approver passed the journal batch
143   --                                     approval authorization check.
144   --                       COMPLETE:FAIL (Workflow transition branch "Fail") indicates
145   --                                     that the approver failed the journal batch
146   --                                     approval authorization check.
147   -- Notes
148   --   You should only use the result codes as listed above. Using unsupported
149   --   result codes may cause unexpected behavior.
150   --
151   PROCEDURE verify_authority( itemtype	IN VARCHAR2,
152 			      itemkey  	IN VARCHAR2,
153 			      actid	IN NUMBER,
154 			      funcmode	IN VARCHAR2,
155 			      result	OUT NOCOPY VARCHAR2 );
156 
157 
158 END GL_WF_CUSTOMIZATION_PKG;