How to define Customize Web ADI Layout In R12
How to define Customize Web ADI Layout In R12:
Defining Layouts:
Layouts enable you to customize the user interface presented in your spreadsheet. Use the layout functionality to determine the fields in a spreadsheet, set their positions, and specify default values for the fields.
A layout must be available before you create a spreadsheet in the Create Document flow. Some integrators offer predefined layouts, or you can use the procedure described in this chapter to create a layout.
Note: For some products, the layouts are predefined and preselected. Therefore you cannot select an alternate layout during document creation.
Note: Unless your User is assigned the System Administrator responsibility, you must be granted access to an integrator to modify its layout. Specific form functions grant access to specific integrators. See
the product-specific documentation for information regarding access to individual integrator layouts.
Use the Define Layout flow to perform the following :
Use this procedure to define or modify a layout. The define layout flow consists of the
following actions:
1. Select the integrator.
Navigation: Oracle Web ADI --> Define Layout.
Select the integrator. Existing layouts for the integrator will be displayed.
Click on Go.
2. Select an existing layout to update or create a new layout.
Choose Create to create a new layout; or, select an existing layout and choose Update to modify it. To create a new layout based on an existing layout, select Duplicate.
3. Enter a name for the layout and select the number of headers.
Enter a Layout Name and specify the Number of Headers to place across the top of the document.
If your document has one header, all fields that you identify as Header fields will display in a single list. If your layout includes numerous header fields, you may consider defining multiple headers to place them horizontally across the top of your document.
click on Next button.
4. Select the fields to appear on the layout, set defaults for the fields, and select the
placement of the field as context, header, or line item.
Determine the fields to be included in the Layout, their placement and default values. The page displays Required Fields and Optional Fields. Administering Web ADI 2-3 Some integrators offer the option Include Graph of Lines Data. Select the box to include a graph.
All required fields must be included in your layout. Include optional fields by selecting the Select box. The following table describes the options available for the fields in your layout:
Layout Field Options
Fields Description
Placement Defines the location of the field on the spreadsheet. Choices
are Context, Header, and Line. In your spreadsheet:
• Context: Appears at the top of the spreadsheet as
read-only, contextual information.
• Header: Fields whose values do not change for every
record you are uploading. This region appears above
the line region in the spreadsheet. If you specified
multiple headers, select the one you wish the field to
display in (for example: Header 1, Header 2, or Header
3).
• Line: Fields whose values change for every record that
is uploaded to Oracle Applications. The rows of data in
this region represent every record that will be
uploaded.
Default Types Note that some fields will have defaults predefined.
Default Type - Constant Used when the text entered in the Default Value field is
used as the default value in the spreadsheet.
Default Type - Environment Used to reference an environment variable when setting a
default for a field. Values are as follows:
• sysdate: System date
• database: Name of the current database
• oauser.id: ID of your current Oracle Applications user
Default Type - Parameter Used to reference a parameter that your system
administrator stores in the form function (Self Service Link)
that you use to access the Create Document flow. The
parameters that can be referenced are specific to each
integrator. See the product-specific documentation for the
valid values for the default type.
Default Type -SQL Used to run a SQL statement to determine the default for
the field. Web ADI runs the SQL statement entered in the
Default Value field and automatically populates the
spreadsheet with the results. If more than one value is
returned from the query, it uses the first value.
You can use the following tokens in the SQL statement for
the Default Value field:
• $profiles$.profilename: Returns the value for the
current user's profile when you enter the name of the
profile option.
• $env$.userid: Returns the current user ID.
• $env$.appid: Returns the current application ID.
• $env$.respid: Returns the current responsibility ID.
• $env$.language: Returns the current session language.
Default Type - Formula You can enter Excel-compatible formulas as default values
for fields. Follow the Excel formula syntax and enclose field
names in brackets.
For example: [credit]+[debit]
Note that referencing the field names rather than the cell
names prevents your formulas from being corrupted if the
order of the fields is changed in the layout.
5. In the Create Layout page, define display properties for the page components. Use this page to mark fields as Read Only, to Hide fields, and to move the fields up or down in the display order. Document Properties
• Protect Sheet - select Yes or No to set the state of the document when
downloaded. A protected sheet will allow you to update the data fields but will
Administering Web ADI 2-5 not allow you to insert rows. The user can change this setting in Excel by
selecting Protection from the Tools menu.
• Style sheet - select a style sheet to apply to the document.
Enter the Header information.
Enter Line Information.
click on Next button.
5. Set properties for the layout components including field width or column span,
hidden or unhidden, and position.
Click on Apply button.
Context and Header Field Properties
• Prompt Span - enter the number of columns that the field prompt will span. Important: For context and header fields, you set the number of columns for the Prompt, Hint, and Data to span. You set the column widths for the fields at the Line level. Therefore, when setting the column spans for a header or context field, be aware that the width of a column is determined by the width of the line fields in the spreadsheet.
• Title - (optional) enter a title for the header.
• Hint Span - enter the number of columns for the field hint to span. The hint for a field can include the following:
• * - indicates the field is required.
• List - indicates that the field provides a list of values. Double-click the field to invoke the list.
• Data type - the data type for each field is always displayed. For example, Text or Number.
• Data Span - enter the number of columns for the data to span.
• Hide - select this box if you want the field hidden on the spreadsheet.
• Read Only - select this box if you want the field to display as a nonrefundable, read-only field.
Line Region Properties
• Data Entry Rows - enter the number of blank rows to display when the document is generated. The user can add more rows once the document is downloaded to Excel.
• Width - enter the width of the field in characters.
• Frozen Pane - use this selection to set the fields that you want to remain visible while you scroll horizontally across the spreadsheet.
• Read Only
Design Considerations:
When setting the column spans for context and header fields, you must consider the column widths that are set at the line item level. The following figure shows the layout specifications for the Context fields and how these specifications rendered in the actual document. The Context Prompt Span is defined as 5 columns and the Context Data Span is defined as 4 columns. Note that the Prompt span covers columns B through D:
• Column B is the automatically generated Upload line item column
• Column C is the Period line item column
• Columns D, E, and F are key flexfield segment columns
Administering Web ADI 2-7
The next example shows the Hint Span for the Header set to 1. In this case because the
column that the hint falls into is narrow, all the hints are not displayed. To correct this
for this example, expand the Hint Span to 3.
The following figure shows the same document after increasing the Header Hint Span to 3.
Note that achieving the desired layout may require several iterations, as changing the column spans for the fields in the first header will affect the placement of the fields in the second header. For example, in the preceding figure, when the Hint Span was changed to 3 for Header 1, the Hint text for Header 2 was moved to a narrower column resulting in part of that text being hidden.
Defining Layouts:
Layouts enable you to customize the user interface presented in your spreadsheet. Use the layout functionality to determine the fields in a spreadsheet, set their positions, and specify default values for the fields.
A layout must be available before you create a spreadsheet in the Create Document flow. Some integrators offer predefined layouts, or you can use the procedure described in this chapter to create a layout.
Note: For some products, the layouts are predefined and preselected. Therefore you cannot select an alternate layout during document creation.
Note: Unless your User is assigned the System Administrator responsibility, you must be granted access to an integrator to modify its layout. Specific form functions grant access to specific integrators. See
the product-specific documentation for information regarding access to individual integrator layouts.
Use the Define Layout flow to perform the following :
- Define a new layout
- Modify an existing layout
- Duplicate a layout from the list and save it under a different name. You can then modify this duplicated layout.
- Delete a layout from the list
Use this procedure to define or modify a layout. The define layout flow consists of the
following actions:
1. Select the integrator.
Navigation: Oracle Web ADI --> Define Layout.
Select the integrator. Existing layouts for the integrator will be displayed.
Click on Go.
2. Select an existing layout to update or create a new layout.
Choose Create to create a new layout; or, select an existing layout and choose Update to modify it. To create a new layout based on an existing layout, select Duplicate.
3. Enter a name for the layout and select the number of headers.
Enter a Layout Name and specify the Number of Headers to place across the top of the document.
If your document has one header, all fields that you identify as Header fields will display in a single list. If your layout includes numerous header fields, you may consider defining multiple headers to place them horizontally across the top of your document.
click on Next button.
4. Select the fields to appear on the layout, set defaults for the fields, and select the
placement of the field as context, header, or line item.
Determine the fields to be included in the Layout, their placement and default values. The page displays Required Fields and Optional Fields. Administering Web ADI 2-3 Some integrators offer the option Include Graph of Lines Data. Select the box to include a graph.
All required fields must be included in your layout. Include optional fields by selecting the Select box. The following table describes the options available for the fields in your layout:
Layout Field Options
Fields Description
Placement Defines the location of the field on the spreadsheet. Choices
are Context, Header, and Line. In your spreadsheet:
• Context: Appears at the top of the spreadsheet as
read-only, contextual information.
• Header: Fields whose values do not change for every
record you are uploading. This region appears above
the line region in the spreadsheet. If you specified
multiple headers, select the one you wish the field to
display in (for example: Header 1, Header 2, or Header
3).
• Line: Fields whose values change for every record that
is uploaded to Oracle Applications. The rows of data in
this region represent every record that will be
uploaded.
Default Types Note that some fields will have defaults predefined.
Default Type - Constant Used when the text entered in the Default Value field is
used as the default value in the spreadsheet.
Default Type - Environment Used to reference an environment variable when setting a
default for a field. Values are as follows:
• sysdate: System date
• database: Name of the current database
• oauser.id: ID of your current Oracle Applications user
Default Type - Parameter Used to reference a parameter that your system
administrator stores in the form function (Self Service Link)
that you use to access the Create Document flow. The
parameters that can be referenced are specific to each
integrator. See the product-specific documentation for the
valid values for the default type.
Default Type -SQL Used to run a SQL statement to determine the default for
the field. Web ADI runs the SQL statement entered in the
Default Value field and automatically populates the
spreadsheet with the results. If more than one value is
returned from the query, it uses the first value.
You can use the following tokens in the SQL statement for
the Default Value field:
• $profiles$.profilename: Returns the value for the
current user's profile when you enter the name of the
profile option.
• $env$.userid: Returns the current user ID.
• $env$.appid: Returns the current application ID.
• $env$.respid: Returns the current responsibility ID.
• $env$.language: Returns the current session language.
Default Type - Formula You can enter Excel-compatible formulas as default values
for fields. Follow the Excel formula syntax and enclose field
names in brackets.
For example: [credit]+[debit]
Note that referencing the field names rather than the cell
names prevents your formulas from being corrupted if the
order of the fields is changed in the layout.
5. In the Create Layout page, define display properties for the page components. Use this page to mark fields as Read Only, to Hide fields, and to move the fields up or down in the display order. Document Properties
• Protect Sheet - select Yes or No to set the state of the document when
downloaded. A protected sheet will allow you to update the data fields but will
Administering Web ADI 2-5 not allow you to insert rows. The user can change this setting in Excel by
selecting Protection from the Tools menu.
• Style sheet - select a style sheet to apply to the document.
Enter the Header information.
Enter Line Information.
5. Set properties for the layout components including field width or column span,
hidden or unhidden, and position.
Context and Header Field Properties
• Prompt Span - enter the number of columns that the field prompt will span. Important: For context and header fields, you set the number of columns for the Prompt, Hint, and Data to span. You set the column widths for the fields at the Line level. Therefore, when setting the column spans for a header or context field, be aware that the width of a column is determined by the width of the line fields in the spreadsheet.
• Title - (optional) enter a title for the header.
• Hint Span - enter the number of columns for the field hint to span. The hint for a field can include the following:
• * - indicates the field is required.
• List - indicates that the field provides a list of values. Double-click the field to invoke the list.
• Data type - the data type for each field is always displayed. For example, Text or Number.
• Data Span - enter the number of columns for the data to span.
• Hide - select this box if you want the field hidden on the spreadsheet.
• Read Only - select this box if you want the field to display as a nonrefundable, read-only field.
Line Region Properties
• Data Entry Rows - enter the number of blank rows to display when the document is generated. The user can add more rows once the document is downloaded to Excel.
• Width - enter the width of the field in characters.
• Frozen Pane - use this selection to set the fields that you want to remain visible while you scroll horizontally across the spreadsheet.
• Read Only
Design Considerations:
When setting the column spans for context and header fields, you must consider the column widths that are set at the line item level. The following figure shows the layout specifications for the Context fields and how these specifications rendered in the actual document. The Context Prompt Span is defined as 5 columns and the Context Data Span is defined as 4 columns. Note that the Prompt span covers columns B through D:
• Column B is the automatically generated Upload line item column
• Column C is the Period line item column
• Columns D, E, and F are key flexfield segment columns
Administering Web ADI 2-7
The next example shows the Hint Span for the Header set to 1. In this case because the
column that the hint falls into is narrow, all the hints are not displayed. To correct this
for this example, expand the Hint Span to 3.
The following figure shows the same document after increasing the Header Hint Span to 3.
Note that achieving the desired layout may require several iterations, as changing the column spans for the fields in the first header will affect the placement of the fields in the second header. For example, in the preceding figure, when the Hint Span was changed to 3 for Header 1, the Hint text for Header 2 was moved to a narrower column resulting in part of that text being hidden.
No comments:
Post a Comment