INSTALLATION  INSTRUCTIONS  
Insum    
APEX  Applications  Common  Objects    
 
 
 
 
Author:   Sylvain  Martel  
Creation  Date:   July  2,  2014  
Last  Updated:   September  19,  2016    
Document  Ref:   Insum  EBS  APEX  Integration    
Version:   1.2.2  
 
 
Installation  Instructions   Doc  Ref:  Insum  EBS  APEX  Integration    
September  19,  2016  

Document  Control  
 

Change  Record  
3  

Date   Author   Version   Change  Reference  

       
3-­Jul-­14   Sylvain  Martel   1.0   No  Previous  Document  
1-­Dec-­14   Sylvain  Martel   1.1   Naming  standardization  
Multi-­org  support  
19-­Jan-­15   Sylvain  Martel   1.2   JSP  and  Profile  Option  precisions  
23-­Feb-­15   Sylvain  Martel   1.2.1   Added  SQL  script  files  for  components.  
19-­Sep-­16   Sylvain  Martel   1.2.2   Added  Form  Functions  section  

 
 
 
 

APEX  Applications Common Objects     Document  Control          ii  

File  Ref:  Insum  -­  APEX  Application  Common  Objects  -­  Installation  Instructions.docx          (v.  1.2.2)  
 
Installation  Instructions   Doc  Ref:  Insum  EBS  APEX  Integration    
September  19,  2016  

Contents  

Document  Control .................................................................................................................... ii

Installation  Instructions  for  APEX  Applications  Common  Objects .................................... 1
Description ......................................................................................................................... 1
Pre-­Installation  Steps ....................................................................................................... 1
Installation  Steps  (Global  for  all  applications  types) ................................................... 2
Installation  Steps  (APEX  applications  accessed  from  EBS) ........................................ 4
Installation  Steps  (APEX  applications  accessed  directly) ............................................ 7
Form  Functions  in  EBS ................................................................................................... 10
 
 

APEX  Applications Common Objects     Document  Control          iii  

File  Ref:  Insum  -­  APEX  Application  Common  Objects  -­  Installation  Instructions.docx          (v.  1.2.2)  
 
Installation  Instructions   Doc  Ref:  Insum  EBS  APEX  Integration    
September  19,  2016  

Installation  Instructions  for  APEX  Applications  Common  Objects  

 
 

Description  

This  document  describes  the  required  authentication  scheme  configuration  for  any  APEX  page  or  
application  to  be  called  from  an  Oracle  E-­Business  Suite  (EBS)  function.    This  authentication  scheme  will  
provide  the  following:  
•   Create  a  custom  authentication  for  calls  made  by  an  EBS  function    
•   Provide  a  seamless  login  integration  between  EBS  and  APEX  allowing  EBS  users  to  access  
APEX  applications  /  pages  without  the  need  to  reenter  credentials    

The  connection  between  EBS  and  APEX  differs  depending  of  the  EBS  version.    This  document  assumes  
the  instance  is  part  of  the  R12  family  (R12.0.4  to  R12.1.3).  
 
 
    Note:  The  PL/SQL  package  and  views  have  not  been  tested  on  EBS  R12.2.x  
 

There  are  2  types  of  integration  available  for  APEX  applications:  

•   Applications  accesed  from  an  EBS  function  in  the  EBS  navigation  window  
•   Applications  accessed  directly  from  a  desktop  browser  or  from  a  mobile  device  

This  document  will  describe  both  methods  and  indicate  which  method  applies  to  your  application  type.  
 
 

Pre-­Installation  Steps  

Requirements  

q   Have  executed  the  installation  of  EBS  common  objects  as  described  in  document  Insum  -­  EBS  
Objects  for  APEX  -­  Installation  Instructions    
q   Provide  APEX  developer  user  credentials  for  Application  Builder  
q   Create  an  APEX  application  with  the  minimum  required  to  save  an  application  (Login  and  blank  
HTML  Page)  
 
Installation  Summary  

q   Define  Application  Items  

q   Define  Custom  Authentication  Scheme  
q   Define  Substitution  Strings  (Mobile  only)  
q   Modify  Login  Page  
q   Add  an  Initialization  PL/SQL  Code  for  the  application  
 

APEX  Applications Common Objects     Installation  Instructions  for  APEX  Applications  Common  Objects          1  of  10  
File  Ref:  Insum  -­  APEX  Application  Common  Objects  -­  Installation  
Instructions.docx          (v.  1.2.2)  
 
Installation  Instructions   Doc  Ref:  Insum  EBS  APEX  Integration    
September  19,  2016  

Installation  Steps  (Global  for  all  applications  types)  

 
The  following  steps  are  required  for  all  application  types  
 
 
Define  Application  Items  

In  order  set  APEX  in  the  same  context  as  EBS,  we  need  to  save  some  connection  values  from  the  EBS  
user  who  is  calling  the  APEX  applications.    Create  application  items  of  scope  Application.  

q   Log  in  APEX  as  developer  

q   Click  on  the  Edit  button  of  the  created  application  

q   Click  on  the  Shared  Components  icon  

q   Click  on  the  Aplication  Items  link  under  Logic  

q   Execute  the  following  steps  for  each  Application  Item:  

Ø   Click  on  the  Create  >  button  
Ø   Name:  EBS_APEX_LANG  
Ø   Scope:  Application  
Ø   Click  on  the  Create  Application  Item  button  

q   Repeat  the  previous  steps  for  those  following  Applications  Items  

Application  Item  
EBS_APPS_FRAMEWORK_AGENT  
EBS_ICX_DATE_FORMAT_MASK  
EBS_ICX_LANGUAGE  
EBS_ICX_LIMIT_TIME  
EBS_ICX_NUMERIC_CHARACTERS  
EBS_ICX_SESSION_TIMEOUT  
EBS_LOGIN_ID  
EBS_ORG_ID  
EBS_RESP_APPL_ID  
EBS_RESP_APPL_SHORT_NAME  
EBS_RESP_ID  
EBS_RESP_NAME  
EBS_SEC_GROUP_ID  
EBS_SESSION_ID  
EBS_USER_ID  

APEX  Applications Common Objects     Installation  Instructions  for  APEX  Applications  Common  Objects          2  of  10  
File  Ref:  Insum  -­  APEX  Application  Common  Objects  -­  Installation  
Instructions.docx          (v.  1.2.2)  
 
Installation  Instructions   Doc  Ref:  Insum  EBS  APEX  Integration    
September  19,  2016  

Define  Substitution  Strings  

Create  the  following  substitution  strings  for  applications  accessed  directly.    

q   Click  on  the  Edit  button  of  the  created  application  

q   Click  on  Edit  Application  Properties  button  

q   In  the  substitution  section,  enter  the  following  items  and  assign  the  appropriate  values:  
 
Substitution  String   Substitution  Value   Comment    
EBS_APPLICATION_NAME   [Name  of  the  EBS  module  –   Example:  
Name  of  the  APEX  application]   Payables  –  Simple  Invoices  

EBS_MOBI_APPL_SHORT_NAME   [Application  Short  Name  of   Used  as  a  parameter  when  calling  
the  required  responsibility]   MO_GLOBAL.init  API.  
 
   

APEX  Applications Common Objects     Installation  Instructions  for  APEX  Applications  Common  Objects          3  of  10  
File  Ref:  Insum  -­  APEX  Application  Common  Objects  -­  Installation  
Instructions.docx          (v.  1.2.2)  
 
Installation  Instructions   Doc  Ref:  Insum  EBS  APEX  Integration    
September  19,  2016  

Installation  Steps  (APEX  applications  accessed  from  EBS)  

 
The  following  steps  are  required  for  applications  accessed  from  EBS  ONLY  
 
 

Define  Custom  Authentication  Scheme  

An  APEX  application  will  use  the  EBS  authentication  to  allow  a  user  to  access  APEX.  

q   Log  in  APEX  as  developer  

q   Click  on  the  Edit  button  of  the  created  application  

q   Click  on  the  Shared  Components  icon  

q   Click  on  the  Authentication  Scheme  link  under  Security  

q   Click  on  the  Create  >  button  

Ø   Create  Scheme:  select  Based  on  a  pre-­configured  scheme  from  the  gallery  
Ø   Name:  EBS  Custom  Login  
Ø   Scheme  Type:  select  Custom  
Ø   Authentication  Function  Name:  ebs_validate_login  
Ø   PL/SQL  Code:    
FUNCTION ebs_validate_login (
p_username IN VARCHAR2
, p_password IN VARCHAR2) RETURN BOOLEAN
AS
BEGIN
RETURN xxapex_common_pkg.validate_login(p_username, p_password,
'EBS');
END ebs_validate_login;

q   Click  on  Create  Authentication  Scheme  button  

q   Edit  the  newly  created  Authentication  Scheme  EBS  Custom  Login  

q   In  the  Post-­Logout  URL:  

Ø   Go  To:  select  URL  
Ø   URL:  http://hostname:port/OA_HTML/OA.jsp?OAFunc=OAHOMEPAGE  

q   Click  on  the  Apply  Changes  button  

q   Make  sure  the  custom  authentication  is  the  current  one  for  the  application  (the  word  Current  
shows  up  at  the  end  of  the  authentication  name)  

   

APEX  Applications Common Objects     Installation  Instructions  for  APEX  Applications  Common  Objects          4  of  10  
File  Ref:  Insum  -­  APEX  Application  Common  Objects  -­  Installation  
Instructions.docx          (v.  1.2.2)  
 
Installation  Instructions   Doc  Ref:  Insum  EBS  APEX  Integration    
September  19,  2016  

Modify  Login  Page    

Create  a  process  in  the  Login  Page  (default  page  101)  to  get  EBS  cookies,  execute  the  authentication  
and  assign  those  values  to  APEX  applications  items.  

q   Log  in  APEX  as  developer  

q   Click  on  the  Edit  button  of  the  created  application  
q   Edit  the  Login  page  (default  page  101)  
q   Delete  existing  before  header  process  Get  Username  Cookie  using  navigation  Page  Rendering  
>  Before  Header  >  Processes  (double  click  on  Get  Username  Cookie  to  Edit  the  process)  
Ø   Click  on  Delete  button  
Ø   Click  Ok  button  to  confirm  
q   Create  a  before  header  process  using  navigation  Page  Rendering  >  Before  Header  >  
Processes  >  Create  (right  click  to  get  to  the  context  menu)  
Ø   Select  the  category  of  the  process  you  wish  to  create:  PL/SQL  
Ø   Name:  Get  EBS  Username  -­  Login  
Ø   Sequence:  10  
Ø   Process  Point:  On  Load  –  Before  Header  
Ø   Enter  PL/SQL  Page  Process:  Refer  to  Get  EBS  Username  -­  Login  –  EBS.sql  file  in  the  
SQL  subdirectory  of  the  installation  package.  
Ø   Click  on  Create  Process  button  
 

q   Create  another  before  header  process  by  following  navigation  Page  Rendering  >  Before  
Header  >  Processes  >  Create  (right  click  to  get  to  the  context  menu)  
Ø   Select  the  category  of  the  process  you  wish  to  create:  PL/SQL  
Ø   Name:  Assign  Static  EBS  Values  
Ø   Sequence:  20  
Ø   Process  Point:  On  Load  –  Before  Header  
Ø   Enter  PL/SQL  Page  Process:  Refer  to  Assign  Static  EBS  Values  -­  EBS.sql  file  in  the  SQL  
subdirectory  of  the  installation  package.
Ø   Click  on  Create  Process  button  

q   Deactivate  the  existing  Login  process  by  following  navigation  Page  Processing  
>  Processing  >  Processes  (double  click  on  Login  to  Edit  the  process)  
Ø   In  the  Conditions  section,  select  Condition  Type  Never  
Ø   Click  on  Apply  Changes  button  

   

APEX  Applications Common Objects     Installation  Instructions  for  APEX  Applications  Common  Objects          5  of  10  
File  Ref:  Insum  -­  APEX  Application  Common  Objects  -­  Installation  
Instructions.docx          (v.  1.2.2)  
 
Installation  Instructions   Doc  Ref:  Insum  EBS  APEX  Integration    
September  19,  2016  

Add  an  Initialization  PL/SQL  Code  for  the  application    

The  Initialization  PL/SQL  Code  attribute  in  the  application  properties  would  be  executed  each  time  a  
page  is  about  to  be  executed.    This  is  the  moment  where  the  APEX  application  has  to  initialize  the  EBS  
context.  
q   Log  in  APEX  as  developer  
q   Click  on  the  Edit  button  of  the  application  in  the  Application  Builder  pane.  
q   Clic  on  the  Edit  Application  Properties  button    
q   Click  on  the  Security  tab  
q   Scroll  down  to  the  Database  Session  section  
q   In  the  Initialization  PL/SQL  Code  attribute,  enter  the  following  PL/SQL  code:  Refer  to  file  
Initialization  PLSQL  Code  -­  EBS.sql  in  the  SQL  subdirectory  of  the  installation  package  for  
code  to  insert.  
q   Click  on  Create  Process  button  
   

APEX  Applications Common Objects     Installation  Instructions  for  APEX  Applications  Common  Objects          6  of  10  
File  Ref:  Insum  -­  APEX  Application  Common  Objects  -­  Installation  
Instructions.docx          (v.  1.2.2)  
 
Installation  Instructions   Doc  Ref:  Insum  EBS  APEX  Integration    
September  19,  2016  

Installation  Steps  (APEX  applications  accessed  directly)  

 
 The  following  steps  are  required  for  applications  accessed  directly  ONLY  
 

Define  Custom  Authentication  Scheme  

The  custom  authentication  will  use  EBS  credentials  to  validate  a  user  access  to  an  APEX  application.  

q   Log  in  APEX  as  developer  

q   Click  on  the  Edit  button  of  the  created  application  

q   Click  on  the  Shared  Components  icon  

q   Click  on  the  Authentication  Scheme  link  under  Security  

q   Click  on  the  Create  >  button  

Ø   Create  Scheme:  select  Based  on  a  pre-­configured  scheme  from  the  gallery  
Ø   Name:  EBS  Custom  Login  
Ø   Scheme  Type  :  select  Custom  
Ø   Authentication  Function  Name:  ebs_validate_login  
Ø   PL/SQL  Code:    
FUNCTION ebs_validate_login (
p_username IN VARCHAR2
, p_password IN VARCHAR2) RETURN BOOLEAN
AS
BEGIN
RETURN xxapex_common_pkg.validate_login(p_username, p_password,
'MOBILE');
END ebs_validate_login;

q   Click  on  Create  Authentication  Scheme  button  

q   Edit  the  newly  created  Authentication  Scheme  EBS  Custom  Login  

q   In  the  Post-­Logout  URL:  

Ø   Go  To:  select  Home  Page  

q   Click  on  the  Apply  Changes  button  

q   Make  sure  the  custom  authentication  is  the  current  one  for  the  application  (the  word  Current  
shows  up  at  the  end  of  the  authentication  name)  

   

APEX  Applications Common Objects     Installation  Instructions  for  APEX  Applications  Common  Objects          7  of  10  
File  Ref:  Insum  -­  APEX  Application  Common  Objects  -­  Installation  
Instructions.docx          (v.  1.2.2)  
 
Installation  Instructions   Doc  Ref:  Insum  EBS  APEX  Integration    
September  19,  2016  

Define  Substitution  Strings  

Create  the  following  substitution  strings  for  applications  accessed  directly.    

q   Log  in  APEX  as  developer  

q   Click  on  the  Edit  button  of  the  created  application  

q   Click  on  Edit  Application  Properties  button  

q   In  the  substitution  section,  enter  the  following  items  and  assign  the  appropriate  values:  
 
Substitution  String   Substitution  Value   Comment    
EBS_MOBI_RESP_KEY   [Responsibility  Key  of  the   Used  as  a  parameter  when  calling  
required  responsibility   the  APPS_INITIALIZE  API.  
authorizing  this  application]  
EBS_MOBI_APPL_SHORT_NAME   [Application  Short  Name  of   Used  as  a  parameter  when  calling  
the  required  responsibility]   MO_GLOBAL.init  API.  

Modify  Login  Page  

Create  a  process  in  the  Login  Page  (default  page  101)  to  get  EBS  cookies,  execute  the  authentication  
and  assign  those  values  to  APEX  applications  items.  

q   Log  in  APEX  as  developer  

q   Click  on  the  Edit  button  of  the  created  application  

q   Edit  the  Login  page  (default  page  101)  

q   Edit  the  Clear  Page(s)  Cache  process  (Page  Processing  >  Processes  and  double  click  on  
Clear  Page(s)  Cache)  

q   Change  the  existing  sequence  for  Clear  Page(s)  Cache  from  30  to  100  
Ø   Change  field  Sequence  to  100  
Ø   Click  Apply  Changes  button  to  confirm  

q   Create  a  On  Submit  process  by  following  navigation  Page  Processing  >  Processes  
>  Create  (right  click  to  get  to  the  context  menu)  
Ø   Select  the  category  of  the  process  you  wish  to  create:  PL/SQL  
Ø   Name:  Assign  Static  EBS  Values  
Ø   Sequence  :  30  
Ø   Process  Point  :  On  Submit  –  After  Computations  and  Validations  

Ø   Enter  PL/SQL  Page  Process:  Refer  to  file  Assign  Static  EBS  Values  –  Mobile.sql  in  the  
SQL  subdirectory  of  the  installation  package  for  code  to  insert.  

Ø   Click  on  Create  Process  button  

   

APEX  Applications Common Objects     Installation  Instructions  for  APEX  Applications  Common  Objects          8  of  10  
File  Ref:  Insum  -­  APEX  Application  Common  Objects  -­  Installation  
Instructions.docx          (v.  1.2.2)  
 
Installation  Instructions   Doc  Ref:  Insum  EBS  APEX  Integration    
September  19,  2016  

Add  an  Initialization  PL/SQL  Code  for  the  application    

The  Initialization  PL/SQL  Code  attribute  in  the  application  properties  would  be  executed  each  time  a  
page  is  about  to  be  executed.    This  is  the  moment  where  the  APEX  application  has  to  initialize  the  EBS  
context.  
q   Log  in  APEX  as  developer  
q   Click  on  the  Edit  button  of  the  application  in  the  Application  Builder  pane.  
q   Clic  on  the  Edit  Application  Properties  button    
q   Click  on  the  Security  tab  
q   Scroll  down  to  the  Database  Session  section  
q   In  the  Initialization  PL/SQL  Code  attribute,  enter  the  following  PL/SQL  code:  Refer  to  file  
Initialization  PLSQL  Code  -­  Mobile.sql  in  the  SQL  subdirectory  of  the  installation  package  
for  code  to  insert.  
q   Click  on  Create  Process  button  

APEX  Applications Common Objects     Installation  Instructions  for  APEX  Applications  Common  Objects          9  of  10  
File  Ref:  Insum  -­  APEX  Application  Common  Objects  -­  Installation  
Instructions.docx          (v.  1.2.2)  
 
Installation  Instructions   Doc  Ref:  Insum  EBS  APEX  Integration    
September  19,  2016  

Form  Functions  in  EBS  

Once  you  have  created  your  APEX  application,  you  need  to  define  a  function  in  EBS  which  will  be  used  
by  the  EBS-­APEX  integration  package  to  access  your  APEX  extension.  

 
  The  Use  the  System  Administrator  responsibility  to  create  the  form  function.  
  Follow  navigation:  System  Administrator  >  Application  >  Function  
 

Define  Custom  Form  Function  

Define  custom  functions  to  access  your  APEX  applications.  

q   Open  the  Form  Functions  window  

q   Click  on  the  New  icon  

Ø   Description  tab  
§   Function:  [Enter  the  function  name]  
§   User  Function  Name:  [Enter  the  user  function  name]  
§   Description:  [Enter  optional  description]  
Ø   Properties  tab  
§   Type:  SSWA  jsp  function  
§   Maintenance  Mode  Support:  None  
§   Context  Dependence:  Responsibility  
Ø   Form  tab  
§   Form:  (blank)  
§   Application:  (blank)  
§   Parameters:  (blank)  
Ø   Web  HTML  tab  
§   HTML  Call:  LaunchApex.jsp?application=APEX_App_ID&page=APEX_Page  
Where:    
APEX_App_ID  is  the  APEX  application  (Ex.:  102)  
APEX_Page  is  the  target  page  to  open  for  the  user  (Ex.:  1001)  
Example:  LaunchApex.jsp?application=102&page=1001  
§   MDS  Reference  Path:  (blank)  

q   Save  function  
 
 
End  of  document.  
 

APEX  Applications Common Objects     Installation  Instructions  for  APEX  Applications  Common  Objects          10  of  10  
File  Ref:  Insum  -­  APEX  Application  Common  Objects  -­  Installation  
Instructions.docx          (v.  1.2.2)