You are on page 1of 35

Essential changes to template.fmb and setting up a form in the Oracle Applications Environment.

Developed by : Infosys Technologies Limited

17-Feb-2004

Note: This material contents might be changed/modified. Please note that in advance.

Essential changes to template.fmb and setting up a form in the Oracle Applications Environment.

Intended Audience : Developer community involved in form module development for Oracle Applications. Technology involved : Forms 4.5 Oracle Applications 11.0.3 FTP software Telnet to connect to UNIX server.

This document gives step-wise approach for all customization changes that are required to be done to the template.fmb before we code anything special to achieve the given functionality according to the client requirements. These steps are to be followed every time we develop a customized form from template.fmb. This document also tries to explain the different steps involved in registering the form module into Oracle Applications.

Essential changes to template.fmb and setting up a form in the Oracle Applications Environment. The document is divided into following parts for ease of understanding. Changes required to template.fmb (binary form module) Setups in the Oracle Applications for the form registration. Transfer and Compilation of form module on server Testing the form.

Essential changes to template.fmb and setting up a form in the Oracle Applications Environment.

Changes required to template.fmb (binary form module)

Essential changes to template.fmb and setting up a form in the Oracle Applications Environment. Changes required to template.fmb: Lets take the sample data: Client Requirement (This will change per request basis) : We need to display data in the EMP (say) table in APPS (say) schema on the front end screen. Thus we need a customized screen (which is not provided by standard Oracle installation). Target form module name : GLBEMP.fmb Target Application name : Toshiba GLB system Target responsibility name : TSB Global Administrator Standard template.fmb is available with your project. The subsequent steps to develop the GLBEMP.fmb (target form) from the TEMPLATE.fmb will use above information as the sample data. Please note that the snapshots given in the document are just to facilitate better realization of the content and may not exactly be congruent to the steps to be carried out by the user.

Essential changes to template.fmb and setting up a form in the Oracle Applications Environment.

Step 1 : Open the template.fmb with Forms designer utility and save it with specific form name.
Template.fmb before saving
Form module binary file name (.fmb)

GLBEMP.fmb after saving

Form module name

Essential changes to template.fmb and setting up a form in the Oracle Applications Environment.

Step 2 : Delete the objects which are not required (which are provided by default in template.fmb)
Before step 2 Objects which are not useful in the target form After step 2

Essential changes to template.fmb and setting up a form in the Oracle Applications Environment.

Step 3 : Add the objects which are required by client requirement. (This step will change from request to request. The developer is expected to know tasks like How to add data After step 3 blocks, canvases, windows? How are they inter-related)

Objects which are useful in the target form are added

Essential changes to template.fmb and setting up a form in the Oracle Applications Environment.

Step 4 : Set the form module level properties.


After step 4
Set the First Navigation Block property equal to the block name in which the focus would be when the form is started e.g. In this example, First Navigation Block = EMP

Essential changes to template.fmb and setting up a form in the Oracle Applications Environment.

Step 5 : Set the block level properties.


After step 5
Set the Navigation properties using Next Navigation block or Previous Navigation Block. (This sets the Inter-block navigation) e.g. In this example, Next Navigation Block = EMP Previous Navigation Block = EMP If we dont set these property then FORMS navigates in a sequential order through different blocks. (Typical example would be the untimely appearances of calendar or progress indicator blocks in the template.fmb

Essential changes to template.fmb and setting up a form in the Oracle Applications Environment.

Step 6 : Code changes to When-New-Form-Instance trigger (form-level). The trigger is by default provided in the template.fmb. Open it in the PL/SQL editor and make changes
Before step 6
PL/SQL editor in Forms designer

This is the information used by the Oracle Applications runtime. We must change this to reflect information about the target form.

After step 6

Changes to reflect the information about the target form. We changed : Form name version Date and time

10

Essential changes to template.fmb and setting up a form in the Oracle Applications Environment.

Step 7 : Code changes to Pre-Form trigger (form-level). The trigger is by default provided in the template.fmb. Open it in the PL/SQL editor and make changes.
Before step 7
This is the information used by the Oracle Applications runtime to display the information in the help menu of a form screen.

We need to change this to reflect information about the target form.

Set the name of the window which should be shown first. We must change this to reflect the correct window name to be shown in the target form

After step 7

Changes to reflect the information about the target form. We changed : Form description Date and time First Window name
11

Essential changes to template.fmb and setting up a form in the Oracle Applications Environment.

Step 8 : Code changes to program unit APP_CUSTOM (Package Body). This unit is by default provided in the template.fmb.

Some intermediate code before the actual point of code change

Change the string <your first window> to reflect the name of the window that we set in step7 (changes to Pre-form trigger)
e.g. in this case change the string <your first window> to EMP. Thus the code will look like: If (wnd = EMP) then . .

12

Essential changes to template.fmb and setting up a form in the Oracle Applications Environment. This completes all the code changes that are essential for the form module to work properly in the Oracle applications environment. The next set of tasks to be done, before we are ready to run the form through Oracle Applications, is the setup required for the Oracle Applications environment to have details about our target form. (GLBEMP.fmb)

13

Essential changes to template.fmb and setting up a form in the Oracle Applications Environment.

Setups in the Oracle Applications for the form registration.

14

Essential changes to template.fmb and setting up a form in the Oracle Applications Environment. After logging into the Oracle Applications, navigate to Application Developer responsibility.

15

Essential changes to template.fmb and setting up a form in the Oracle Applications Environment. Step 9: Register Form Open the Forms screen by clicking on following menu. Application Developer Application Form

16

Essential changes to template.fmb and setting up a form in the Oracle Applications Environment. Register form (cont.) Enter the target form details and save the details.

Name of application under which the form is registered. The physical executable file (.fmx) for target form should reside in the corresponding application top forms directory. e.g. Here, application is Toshiba GLB system. Thus the target dir is: $CUST_GLB_TOP/forms/ US.

Name of the form module. This should coincide with the name of .fmb file you saved

17

Essential changes to template.fmb and setting up a form in the Oracle Applications Environment. Step 10 : Register Form FunctionOpen the Form Functions screen by clicking on following menu. Application Developer Application Function

18

Essential changes to template.fmb and setting up a form in the Oracle Applications Environment. Register form function (cont.) Select Description in the pane selector and enter the relevant details like function-name.

19

Essential changes to template.fmb and setting up a form in the Oracle Applications Environment. Register form function (cont.) Select Form in the pane selector and enter the relevant details like form name and save the details.

Form name which we registered in Register form step. We should enter the User form name value from form registration. Navigating out of the field causes the application field to default to the value that we saved in the form registration stage. (Toshiba GLB system)

20

Essential changes to template.fmb and setting up a form in the Oracle Applications Environment. Step 11: Register Menu Item To register a menu item, we will require the menu (set of menu items) associated with target responsibility. Thus we will first get the target menu name from Responsibility Screen. (Click Application developer Security Responsibility Define)

21

Essential changes to template.fmb and setting up a form in the Oracle Applications Environment. Step 11: Register Menu Item Query for the target responsibility name. (In this example TSB:Global Administrator) Note the menu name associated.

The menu name associated with the responsibility

22

Essential changes to template.fmb and setting up a form in the Oracle Applications Environment. Step 11: Register Menu Item Open the Menus screen by clicking on following menu. Application Developer Application Menu

23

Essential changes to template.fmb and setting up a form in the Oracle Applications Environment. Register Menu Item (cont.) Query for the menu associated with the responsibility for which we want access to the target form. (TSB_GA in our example)

24

Essential changes to template.fmb and setting up a form in the Oracle Applications Environment. Register Menu Item (cont.) Add a new row to the menu (Click on Edit New Record). Add relevant details and save the record.

New record added for the employee form. Function name given is same as that given in Register Function step

25

Essential changes to template.fmb and setting up a form in the Oracle Applications Environment. This completes all the setups that are essential for the form module to run in the Oracle Applications environment.

26

Essential changes to template.fmb and setting up a form in the Oracle Applications Environment.

Transfer and Compilation of form module on server

27

Essential changes to template.fmb and setting up a form in the Oracle Applications Environment. Step 12: The next task is to transfer the form module binary file (.fmb file) to the application server. For this, we can use any FTP utility. As explained earlier, the form module executable file should be available in the forms directory of the given application top. Thus, once we move the file to the server, we must move it to the appropriate directory. In our example, the application in question is Toshiba GLB system for which corresponding directory on the server is $CUST_GLB_TOP/forms/US (Actual path is the decoded value of this unix shell variable. This information about corresponding top for an application can be obtained from the Application screen in Application Developer responsibility. User may need to explore more to understand this). Thus our form should be transferred to $CUST_GLB_TOP/forms/US. ($CUST_GLB_TOP/forms/US/GLBEMP.fmb) Step13 :

We compile the binary form module (.fmb) to generate the executable form module (.fmx) ($CUST_GLB_TOP/forms/US/GLBEMP.fmx) (This is done using f45gen utility provided by Oracle. Please refer Oracle documentation if required.)

28

Essential changes to template.fmb and setting up a form in the Oracle Applications Environment. This completes all tasks that are essential for the form module to run in the Oracle Applications environment. We should try to test the form now.

29

Essential changes to template.fmb and setting up a form in the Oracle Applications Environment.

Testing the target form.

30

Essential changes to template.fmb and setting up a form in the Oracle Applications Environment. Login into the target responsibility. (TSB: Global Administrator in our example)

31

Essential changes to template.fmb and setting up a form in the Oracle Applications Environment. After logging into the target responsibility (TSB: Global Administrator in our example), launch the target form by clicking the menu item which was defined in the Register Menu screen (Step 11). (Employee Test Form in our example)

32

Essential changes to template.fmb and setting up a form in the Oracle Applications Environment. You should be able to see your target form in front of you. (Congratulations!!).

First Navigational block (EMP) set in the form module properties (Step 4)
33

The form information which we set in the Pre-form trigger.(step 6)

Essential changes to template.fmb and setting up a form in the Oracle Applications Environment.

Thank You

34

You might also like