template usage

7/29/2019 Template Usage

1/35

Note:

This material contents might be changed/modified. Pleasenote that in advance.

Essential changes to template.fmb and setting up a

form in the Oracle Applications Environment.

Developed by : Infosys Technologies Limited 17-Feb-2004


2/35

1

Developer community involved in form module development for Oracle Applications.

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 OracleApplications.


3/35

2

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.


4/35

3


5/35

4

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 willuse 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.


6/35

5

Step 1 : Open the template.fmb with Forms designer utility and save it with specific form name.

Template.fmb before saving GLBEMP.fmb after saving

Form modulebinary filename (.fmb)

Form modulename


7/356

Step 2 : Delete the objects which are not required (which are provided by default in template.fmb)

Before step 2 After step 2

Objects whichare not useful inthe target form


8/357

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

blocks, canvases, windows?How are they inter-related)

After step 3

Objects whichare useful in thetarget form areadded


9/358

Step 4 : Set the form module level properties.

After step 4

Set the First Navigation Block

property equal to the blockname in which the focus wouldbe when the form is started

e.g. In this example,

First Navigation Block = EMP


10/359

Step 5 : Set the block level properties.

After step 5

Set the Navigation properties

using Next Navigation blockor

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 thenFORMS navigates in a sequential

order through different blocks.

(Typical example would be the

untimely appearances ofcalendar

or progress indicatorblocks in the

template.fmb


11/3510

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

After step 6

This is the information used by

the Oracle Applications

runtime.

We must change this to reflect

information about the target

form.

Changes to

reflect the

information about

the target form.

We changed :

Form name

version

Date and time

PL/SQL editor inForms designer


12/3511

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 runtimeto 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 formAfter step 7

Changes to reflect the

information about the target

form.

We changed :

Form description

Date and time

First Window name


13/3512

Step 8 : Code changes to program unit APP_CUSTOM (Package Body). This unit is by default

provided in the template.fmb.

Some intermediate codebefore the actual point ofcode change

Change the string 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 toEMP.

Thus the code will look like:

If (wnd = EMP) then

.

.


14/3513

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 OracleApplications, is the setup required for the Oracle Applications environment to have details

about our target form. (GLBEMP.fmb)


15/3514


16/3515

After logging into the Oracle Applications, navigate to Application Developer

responsibility.


17/3516

Step 9: Register Form -

Open the Forms screen by clicking on following menu.

Application Developer Application Form


18/3517

Name of the formmodule. This should

coincide with the name

of.fmb file you saved

Name of application under

which the form is

registered.

The physical executable

file (.fmx) for target form

should reside in the

corresponding applicationtop forms directory.

e.g. Here, application is

Toshiba GLB system.

Thus the target dir is:

$CUST_GLB_TOP/forms/

US.

Register form (cont.)

Enter the target form details and save the details.


19/3518

Step 10 : Register Form Function-

Open the Form Functions screen by clicking on following menu.

Application Developer Application Function


20/3519

Register form function (cont.) -

Select Description in the pane selector and enter the relevant details like function-name.


21/3520

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. Navigatingout of the field causes the

application field to default

to the value that we

saved in the form

registration stage.

(Toshiba GLB system)


22/3521

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)


23/3522

Step 11: Register Menu Item

Query for the target responsibility name. (In this example TSB:Global Administrator)

Note the menu name associated.

The menu nameassociated withtheresponsibility


24/35

23

Step 11: Register Menu Item -

Open the Menus screen by clicking on following menu.

Application Developer Application Menu


25/35

24

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)


26/35

25

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


27/35

26

This completes all the setups that are essential for the form module to run in the Oracle

Applications environment.


28/35

27


29/35

28

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 correspondingdirectory on the server is $CUST_GLB_TOP/forms/US (Actual path is the decoded valueof this unix shell variable. This information about corresponding top for an application can

be obtained from the Application screen in Application Developer responsibility. Usermay 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 ifrequired.)


30/35

29

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.


31/35

30


32/35

31

Login into the target responsibility. (TSB: Global Administrator in our example)


33/35

32

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)


34/35

33

You should be able to see your target form in front of you. (Congratulations!!).

The form information which

we set in the Pre-form

trigger.(step 6)

First Navigational block (EMP)

set in the form module

properties (Step 4)


35/35

Thank You

template usage

Documents