index

Package BANINST1.fp_circulation

Process API for circulation (FP_CIRCULATION).


Program units
f_workflow_logon_pidm   Function will return the pidm of the current workflow user as defined in the travel products FTOBPROF table.
p_update_circulation   Procedure responsible for update the circulation tables for all five states of an approval process.
p_update_notification   Wrapper procedure that calls p_update_circulation.
p_create_circulation   Procedure responsible for update the circulation tables for all five states of an approval process.

Constants
APPROVED  
ADDAPPROVER  
DENIED  
RETURN  
NOTIFY  
DENYADVANCE  


APPROVED

APPROVED                CONSTANT VARCHAR2(30) := 'APPROVED';

ADDAPPROVER

ADDAPPROVER             CONSTANT VARCHAR2(30) := 'ADDAPPROVER';

DENIED

DENIED                  CONSTANT VARCHAR2(30) := 'DENIED';

RETURN

RETURN                  CONSTANT VARCHAR2(30) := 'RETURN';

NOTIFY

NOTIFY                  CONSTANT VARCHAR2(30) := 'NOTIFY';

DENYADVANCE

DENYADVANCE             CONSTANT VARCHAR2(30) := 'DENYADVANCE';

f_workflow_logon_pidm

Function f_workflow_logon_pidm(p_workflow_user_logon_in IN FORCIRS.FORCIRS_USER_ID%TYPE)
  RETURN SPRIDEN.SPRIDEN_PIDM%TYPE

Function will return the pidm of the current workflow user as defined in the travel products FTOBPROF table.

Parameters
p_workflow_user_logon_in.   The Workflow users logon as defined in the FTOBPROF table.

Returns
pidm.  The pidm of the workflow user.


p_update_circulation

Procedure p_update_circulation(p_fobcirh_id        IN FOBCIRH.FOBCIRH_ID%TYPE,
                               p_node_key          IN NUMBER,
                               p_doc_type          IN NUMBER,
                               p_document_id       IN FOBCIRH.FOBCIRH_ID%TYPE,
                               p_status_in         IN VARCHAR2,
                               p_workflow_logon_in IN VARCHAR2,
                               p_approver_logon_in IN VARCHAR2,
                               p_comment_in        IN VARCHAR2)

Procedure responsible for update the circulation tables for all five states of an approval process.

Parameters
p_fobcirh_id.   The circulation header internal identification record id. Number(19) Required.
p_node_key.   Represents the forcirs_order value. VARCHAR2(50) Required.
p_doc_type.   Type of document being processes. Reimbursement is 86, Authorization is 85. Required.
p_document_id.   Represents a third party product header identification record. Number(19) Required.
p_status_in.   Represents one of the fp_circulation constants. Required.
p_workflow_logon_in.   Represents the workflow user processing this step in the approval process. VARCHAR2(50) Required.
p_approver_logon_in.   Represents and adhoc approver workflow logon. VARCHAR2(50) Optional.
p_comment_in.   Represents the comment as entered in the workflow form. Optional.


p_update_notification

Procedure p_update_notification(p_fobcirh_id        IN OUT FOBCIRH.FOBCIRH_ID%TYPE,
                                p_node_key          IN OUT NUMBER,
                                p_doc_type          IN OUT NUMBER,
                                p_document_id       IN OUT FOBCIRH.FOBCIRH_ID%TYPE,
                                p_workflow_logon_in IN VARCHAR2)

Wrapper procedure that calls p_update_circulation. Called only to insert forcirn records.

Parameters
p_fobcirh_id.   The circulation header internal identification record id. Number(19) Required.
p_node_key.   Represents the forcirs_order value. VARCHAR2(50) Required.
p_doc_type.   Type of document being processes. Reimbursement is 86, Authorization is 85. Required.
p_document_id.   Represents a third party product header identification record. Number(19) Required.
p_workflow_logon_in.   Represents the workflow user processing this step in the approval process. VARCHAR2(50) Required.


p_create_circulation

Procedure p_create_circulation(p_circulation_key     IN NUMBER,
                               p_node_key            IN NUMBER,
                               p_approver_wf_id      IN VARCHAR2,
                               p_approver_logon_in   IN VARCHAR2,
                               p_comment_in          IN VARCHAR2,
                               p_expense_owner_name  IN VARCHAR2,
                               p_expense_owner_email IN VARCHAR2,
                               p_doc_code            IN VARCHAR2,
                               p_doc_type            IN NUMBER,
                               p_doc_purpose         IN VARCHAR2,
                               p_doc_description     IN VARCHAR2,
                               p_doc_comments        IN VARCHAR2,
                               p_travel_ind          IN VARCHAR2,
                               p_relocation_ind      IN VARCHAR2,
                               p_total_amt           IN NUMBER,
                               p_reimburse_amt       IN NUMBER,
                               p_paid_by_other_amt   IN NUMBER,
                               p_te_url              IN VARCHAR2,
                               p_budget_avail_ind    IN VARCHAR2,
                               p_document_id         IN NUMBER,
                               p_delegate_name       IN VARCHAR2,
                               p_delegate_email      IN VARCHAR2)

Procedure responsible for update the circulation tables for all five states of an approval process.

Parameters
p_circulation_key.   Same as fobcirh_id. The circulation header internal identification record id. Number(19) Required.
p_node_key.   Represents the forcirs_order value. VARCHAR2(50) Required.
p_approver_wf_id.   Same as p_workflow_logon_in.  Represents the workflow user processing this step.
p_approver_logon_in.   Same as p_approver_logon_in. Represents and adhoc approver workflow logon.
p_comment_in.   Represents the comment as entered in the workflow form. Optional.
p_expense_owner_name.   Represents the name of the owner submitting the document from third party application.
p_expense_owner_email.   Email address of the expense owner.
p_doc_type.   Type of document being processes. Reimbursement is 86, Authorization is 85. Required.
p_doc_code.   Document code.
p_doc_type.   Represents (P)erson or (C) chain.
p_doc_purpose.   Document purpose.
p_doc_description.   Description of the document being submitted.
p_travel_ind.   Indicates whether travel document is associated with actual travel.
p_relocation_ind.   Indicates whether the travel document is associated with a relocation event.
p_total_amt.   The total amount of money for the document being submitted.
p_reimburse_amt.   The amount that is reimbursable for the document being submitted.
p_paid_by_other_amt.   Paid by other amount.
p_te_url.   The URL of the travel and expense application
p_budget_avail_ind.   Budget availability indicator.
p_document_id.   Represents a third party product header identification record. Number(19) Required.
p_delegate_name.   Represents the name of the delegate submitting the document for the traveler (owner).
p_delegage_email.   Email address of the delegate.