You are on page 1of 6

ORACLE WHITE PAPER

ORACLE WEB APPLICATIONS DESKTOP INTEGRATOR:
DEFINE LAYOUT
EXECUTIVE SUMMARY
Layouts allow users to customize the user interface presented in the documents they create. Layout functionality can
be used to determine the fields that exist in a document, their position, and any default values that are automatically
placed into fields.

INTRODUCTION
In the Create Document Page Flow, users are required to select a Layout. The Layout they choose will determine how
their document is generated. The Layout affects the number of fields that appear in the document, their placement, and
their default values.
Layouts can be defined and modified on site through the Define Layout Page Flow. This document describes the
process of defining a Layout.

ACCESS THE DEFINE LAYOUT PAGE FLOW
Access the Define Layout Page Flow by clicking on the Define Layout link in the Self Service Home Page. Contact
your Oracle Applications System Administrator if you do not see this link after logging into Self Service and selecting
a responsibility.

SELECT INTEGRATOR
After selecting the Define Layout link, you will be prompted to select an Integrator. All Layouts are defined under an
Integrator. An Integrator indicates the Oracle Applications task you will be performing on the desktop. The Integrator
you choose in this screen determines the list of fields that can be included in your Layout.

4/30/03

1

numeric and underscore characters can be used. This determines the list of columns you will have to choose from when choosing the fields to include in your Layout. and also assures what you enter is unique. There cannot be any spaces in the Layout Key. This serves as a standard for Layout Keys.ORACLE WHITE PAPER SELECT LAYOUT From this screen. The key is a unique value used internally to reference the Layout. Set the Key to Layout Name_Your Initials. All other selections will create Layouts that 4/30/03 2 . view and delete Layouts for an Integrator. Layout Name A screen will appear prompting you for a name and key for the new Layout. Define Layout New Layouts can be created for the selected Integrator by pressing the “Define Layout” button in the main Layout page. only uppercase English. the key cannot be changed. Once you save the Layout. you can create. you will be able to upload values from your desktop to Oracle Applications when using the Layout. You must also select a Column List. If you choose the first value in the Column List LOV. edit. The Layout name is what users will see in the Create Document Page Flow.

Placement The placement value you choose for each field in the Layout will determine where that field appears in the document. All of them must be included in your Layout. Define Fields Use the following screen to determine the placement of fields. and set default values for fields. Any number of optional fields may be selected. These “read only” Layouts can be used with Contents to generate documents for reporting purposes. add optional fields. Optional Fields Check the optional fields you want to include in your Layout.ORACLE WHITE PAPER do not allow upload. 4/30/03 3 . Required Fields These fields appear at the top of the screen.

ORACLE WHITE PAPER Context: Appears at the top of the document as read only. Environment You can reference an environment variable when setting a default for a field in your document. Line: Place fields in the line region whose values change within the group of records you are creating in the document. 4/30/03 4 . this will save you from reentering this information for every record in the line region.chartofaccountsid ID of the chart of accounts assigned to your current set of books. Constant Use this Default Type when the actual value in the Default Value field will be placed into the document. contextual information Header: When uploaded. data in these fields is repeated for every record in the line region. Valid values for the Environment Default Type: Default Value Description sob. To accomplish this. There are five types of defaults you may set: None Use this Default Type when no Default Value is set. Place fields whose values do not change amongst the records being entered in the document in the header region. Defaults You can have fields be automatically populated with default values when your document is created. set a Default Type and Default value for a field in your Layout.

id ID of your current Oracle Applications user. the placement of fields. sob.consolidationflag “true” or “false” will be returned depending on the current set of books being a consolidation set of books. sob.setofbooksname Name of the current set of books. sob. sob.setofbooksid ID of the current set of books. oauser. the first value returned will be used. See your system administrator for valid Default Values when using the Parameter Default Type. optional fields.adbflag “true” or “false” will be returned if depending on the current set of books having average balances enabled. and defaults. sysdate System date database Name of the current database.transactioncalendarid ID of the calendar assigned to the current set of books. Oracle Web Applications Desktop Integrator (Web ADI) will run the SQL statement entered into Default Value and automatically populate the document with the result.language Parameter You can reference a parameter your system administrator stores in the form function (Self Service Link) you use to access the Create Document Page Flow. $env$. 4/30/03 5 . Update Layout You can update the Layout name.latestencumbranceyear The last encumbrance year of the current set of books. sob. $env$.accountedperiodtype The value for Period Type in the current Set of books definition.periodsetname The name of the calendar assigned to the current set of books.respid.currencycode Currency for your current set of books. $env$. sob.userid. $env$.ORACLE WHITE PAPER sob. You may use the following tokens in the SQL statement you enter in Default Value: $profile$.profileName. sob.appid. If more than one value is returned from the query. sob. SQL You can run a SQL statement to determine the default for a field.

4/30/03 6 .ORACLE WHITE PAPER Duplicate Layout After pressing Duplicate. for any purpose. nor subject to any other warranties or conditions. you will be prompted to enter a name and key for the new Layout. Oracle. This document is provided for information purposes only and the contents hereof are subject to change without notice. including implied warranties and conditions of merchantability or fitness for a particular purpose. without our prior written permission. CONCLUSION Layouts provide a means of customizing the desktop user interface to fit the individual user’s needs. Oracle is a registered trademark of Oracle Corporation and/or its affiliates. Fields not required can be excluded from the document to simplify what is seen and quicken data entry. and also reduce keystrokes if values in the document can be derived. Delete Layout You will be presented with a message asking for confirmation before the Layout is deleted. whether expressed orally or implied in law. Default functionality can also provide contextual information to users. This document is not warranted to be error-free. We specifically disclaim any liability with respect to this document and no contractual obligations are formed either directly or indirectly by this document. Other names may be trademarks of their respective owners. This document may not be reproduced or transmitted in any form or by any means. Copyright © 2003. electronic or mechanical. All rights reserved.