Configuring and Extending Applications

Download as pdf or txt
Download as pdf or txt
You are on page 1of 236
At a glance
Powered by AI
Some of the key takeaways are that Oracle Applications Cloud allows for configuring and extending applications, and includes concepts like offerings, roles, privileges and personalizations.

Some of the main components discussed are offerings, which are groupings of business functions, roles which control access, and work areas which contain tasks and content.

Some of the key terms defined in the glossary are flexfields, segments, value sets and trees, among many others.

Oracle Applications

Cloud

Conguring and Extending


Applications
20A
Oracle Applications Cloud
Conguring and Extending Applications

20A
Part Number F24357-02
Copyright © 2011, 2020, Oracle and/or its aliates. All rights reserved.

Authors: Essan Ni Jirman, Barnali Roy, P.S.G.V. Sekhar

This software and related documentation are provided under a license agreement containing restrictions on use and disclosure and are protected by
intellectual property laws. Except as expressly permied in your license agreement or allowed by law, you may not use, copy, reproduce, translate,
broadcast, modify, license, transmit, distribute, exhibit, perform, publish, or display any part, in any form, or by any means. Reverse engineering,
disassembly, or decompilation of this software, unless required by law for interoperability, is prohibited.

The information contained herein is subject to change without notice and is not warranted to be error-free. If you nd any errors, please report
them to us in writing.

If this is software or related documentation that is delivered to the U.S. Government or anyone licensing it on behalf of the U.S. Government, then
the following notice is applicable:

U.S. GOVERNMENT END USERS: Oracle programs, including any operating system, integrated software, any programs installed on the hardware,
and/or documentation, delivered to U.S. Government end users are "commercial computer software" pursuant to the applicable Federal Acquisition
Regulation and agency-specic supplemental regulations. As such, use, duplication, disclosure, modication, and adaptation of the programs,
including any operating system, integrated software, any programs installed on the hardware, and/or documentation, shall be subject to license
terms and license restrictions applicable to the programs. No other rights are granted to the U.S. Government.

This software or hardware is developed for general use in a variety of information management applications. It is not developed or intended for use
in any inherently dangerous applications, including applications that may create a risk of personal injury. If you use this software or hardware in
dangerous applications, then you shall be responsible to take all appropriate fail-safe, backup, redundancy, and other measures to ensure its safe
use. Oracle Corporation and its aliates disclaim any liability for any damages caused by use of this software or hardware in dangerous applications.

Oracle and Java are registered trademarks of Oracle and/or its aliates. Other names may be trademarks of their respective owners.

Intel and Intel Xeon are trademarks or registered trademarks of Intel Corporation. All SPARC trademarks are used under license and are trademarks or
registered trademarks of SPARC International, Inc. AMD, Opteron, the AMD logo, and the AMD Opteron logo are trademarks or registered trademarks
of Advanced Micro Devices. UNIX is a registered trademark of The Open Group.

This software or hardware and documentation may provide access to or information about content, products, and services from third parties. Oracle
Corporation and its aliates are not responsible for and expressly disclaim all warranties of any kind with respect to third-party content, products, and
services unless otherwise set forth in an applicable agreement between you and Oracle. Oracle Corporation and its aliates will not be responsible
for any loss, costs, or damages incurred due to your access to or use of third-party content, products, or services, except as set forth in an applicable
agreement between you and Oracle.

The business names used in this documentation are ctitious, and are not intended to identify any real companies currently or previously in existence.
Oracle Applications Cloud
Conguring and Extending Applications

Contents

Preface i

1 Overview 1
Overview of Conguration ........................................................................................................................................................... 1
Congurations and Extensions .................................................................................................................................................. 2
Personalization .............................................................................................................................................................................. 6
Context Layers ............................................................................................................................................................................... 6
Business Process Models ........................................................................................................................................................... 15

2 Conguration Life Cycle 17


Overview of Conguration Life Cycle ..................................................................................................................................... 17
Congurations and Extensions ................................................................................................................................................ 18
Sandboxes ..................................................................................................................................................................................... 19
Migration ....................................................................................................................................................................................... 34
Conguration Management ..................................................................................................................................................... 47

3 Page Modication 51
Overview of Page Modication ................................................................................................................................................ 51
Overview of Using Page Composer ......................................................................................................................................... 51
Modify Page Content Using Page Composer ....................................................................................................................... 54
Congure the Global Page Template ..................................................................................................................................... 62
Saved Search Management ...................................................................................................................................................... 63
Infolet Management .................................................................................................................................................................. 66
Congure Infotiles on a Page .................................................................................................................................................. 70
New Page Creation ...................................................................................................................................................................... 71
Oracle Applications Cloud
Conguring and Extending Applications

4 User Interface Text Modication 75


Considerations for Selecting a Tool to Change Text .......................................................................................................... 75
Overview of User Interface Text Tool .................................................................................................................................... 77
Bulk Text Modication .............................................................................................................................................................. 78
Modify Text with User Interface Text Update ...................................................................................................................... 81
Overview of Translating Modied Text ................................................................................................................................. 82
Translate Existing Strings at Runtime .................................................................................................................................... 83
Translate New Strings Added Using Conguration Tools ................................................................................................. 84
Translate Strings Oine ........................................................................................................................................................... 85
Translate New Strings Oine From English to German .................................................................................................... 86
FAQs for User Interface Text Modication ........................................................................................................................... 88

5 Theme Management 89
Overview of Conguring Themes and Home Page Seings ............................................................................................ 89
Create Themes ............................................................................................................................................................................ 90
Manage Themes .......................................................................................................................................................................... 91
Appearance Seings for Changing the Look and Feel of the Application ..................................................................... 92
Change the Logo and Color Schemes of the Application ................................................................................................. 98
FAQs for Theme Management .............................................................................................................................................. 102

6 Flexelds 105
Overview of Flexelds .............................................................................................................................................................. 105
Overview of Flexeld Conguration ..................................................................................................................................... 105
Flexeld Components .............................................................................................................................................................. 107
Flexelds at Runtime ............................................................................................................................................................... 108
Flexeld Modication Using Page Composer .................................................................................................................... 109
How Flexelds Work with Oracle Application Cloud Architecture ................................................................................. 109
Flexeld Management ............................................................................................................................................................... 111
Flexeld Deployment ................................................................................................................................................................ 128
Value Sets ................................................................................................................................................................................... 134
Descriptive Flexelds ................................................................................................................................................................ 150
Extensible Flexelds ................................................................................................................................................................. 158
Key Flexelds ............................................................................................................................................................................. 182
Oracle Applications Cloud
Conguring and Extending Applications

7 Conguration of Home Page and Navigation 201


Overview of Conguring Home Page and Navigation ...................................................................................................... 201
Congure Navigation ............................................................................................................................................................... 202
Congure Home Page .............................................................................................................................................................. 210
Deep Links .................................................................................................................................................................................. 214

8 Help Content Management 215


How You Manage Dierent Types of Help ......................................................................................................................... 215
Manage Help for Fields and Other UI Elements ................................................................................................................ 216
Why can't I see the Manage Help Content or Edit Geing Started link? ....................................................................... 216
Help Windows ............................................................................................................................................................................ 216
Geing Started Work Area ...................................................................................................................................................... 218
Manage All Added Help Content ........................................................................................................................................... 219
Page or Section Values ........................................................................................................................................................... 220
Copy Added Help for Migration ............................................................................................................................................. 221
Oracle Applications Cloud
Conguring and Extending Applications
Oracle Applications Cloud Preface
Conguring and Extending Applications

Preface
This preface introduces information sources that can help you use the application.

Using Oracle Applications

Help
Use help icons to access help in the application. If you don't see any help icons on your page, click your user image
or name in the global header and select Show Help Icons. Not all pages have help icons. You can also access the Oracle
Help Center to nd guides and videos.

Watch: This video tutorial shows you how to nd and use help.
 
You can also read about it instead.

Additional Resources
• Community: Use Oracle Cloud Customer Connect to get information from experts at Oracle, the partner
community, and other users.

• Training: Take courses on Oracle Cloud from Oracle University.

Conventions
The following table explains the text conventions used in this guide.

Convention Meaning

boldface Boldface type indicates user interface elements, navigation paths, or values you enter or select.

monospace Monospace type indicates le, folder, and directory names, code examples, commands, and URLs.

> Greater than symbol separates elements in a navigation path.

i
Oracle Applications Cloud Preface
Conguring and Extending Applications

Documentation Accessibility
For information about Oracle's commitment to accessibility, visit the Oracle Accessibility Program website.
Videos included in this guide are provided as a media alternative for text-based help topics also available in this guide.

Contacting Oracle

Access to Oracle Support


Oracle customers that have purchased support have access to electronic support through My Oracle Support. For
information, visit My Oracle Support or visit Accessible Oracle Support if you are hearing impaired.

Comments and Suggestions


Please give us feedback about Oracle Applications Help and guides! You can send an e-mail to:
[email protected].

ii
Oracle Applications Cloud Chapter 1
Conguring and Extending Applications Overview

1 Overview

Overview of Conguration
Oracle applications by default provide robust functionality, tailored to support most of the business requirement an
organization could have. But you can still make changes to your application to best t your specic business or personal
needs.

Types of Changes
You can make 2 types of changes, based on who's making the change and for whom.

• Congurations: These are changes made by administrators, and these changes aect many users. For example,
you hide a page entry in the springboard for specic job roles, or create a new page for all users.
• Personalization: These are changes made by individual users, and they aect only the users that made them.
For example, you change the column width of a table for yourself.
Here's a visual representation of how changes are categorized.

Application
changes

Just yourself For For multiple people


whom?

Personalization Configuration

An administrator can't make personalizations for any specic user other than themselves. Personalizations are also
limited to certain types of changes such as springboard and infolet personalizations, and resizing columns and tables.

Congurations are preserved when the application is updated to a newer release.

1
Oracle Applications Cloud Chapter 1
Conguring and Extending Applications Overview

What You Can Change


You can congure many aspects of the application, for example the user interface, business intelligence, and data
model.

The application is built using a common data model. So, when you make an application change in one area, that change
is available to all objects in the application. For example, if you add an aribute to an object, you can easily add that
aribute to these related artifacts:

• Web-based view page


• Associated mobile page
• Associated reports

Generally, you use the same tools and processes to congure all applications. For more information on conguring
business intelligence, see the Creating and Editing Analytics and Reports guides relevant to your products.

Related Topics
• Overview of Conguration Life Cycle

Congurations and Extensions


Examples of Congurations and Extensions
You can make congurations and extensions using browser-based composers and other tools. All users or a subset of
users can view and use these congurations and extensions. If your role has an administrative privilege, you can access
most conguration tools to modify the user interface (UI), create and modify objects, and so on. Some conguration
tools, such as Application Composer, are available only for specic product families.

Modifying the UI
To modify the UI, use:
• The User Interface Text tool to edit text that appears on multiple pages. For example, you can change the
term, "buyer" to "customer" if that is your preferred term, and the change aects all pages where the term is
displayed.
• The Appearance work area to change the look and feel of the application pages.
• The Announcements work area to create, edit, and delete announcements displayed on the home page.
• Page Composer to congure application pages for other users. For example, you can:

◦ Add elds
◦ Add validation
◦ Change default content
◦ Rearrange regions
◦ Add external content

2
Oracle Applications Cloud Chapter 1
Conguring and Extending Applications Overview

◦ Save queries

Tip: In Page Composer, you can make changes using the WYSIWYG view. However, in some cases, you can
also use the Source view.

Conguring Navigation
Use the Structure work area to congure the Navigator and springboard. On the Navigator, select Conguration >
Structure.

Adding User-Dened Aributes to Business Components Using Flexelds


Most business components, except those in Oracle Engagement Cloud products, support using exelds to add
aributes to objects. Use exelds to create your own aributes without programming. A exeld captures data that is
related to a specic purpose, such as information about job positions or inventory items. Each aribute is a segment of
a exeld, and corresponds to a reserved column in the application database.

Modifying Reports and Analytics


Predened analyses, dashboards, and reports help in meeting business intelligence requirements. You can modify them
to t specic business needs, for example, change the layout.
For more information, see the Creating and Administering Analytics and Reports guides relevant to your products.

Managing Help
Many pages have help icons that you click to open help windows. From there, you can add your own content to the
window, for example your company policies or best practices. You can also use the Manage Help Content task in the
Setup and Maintenance work area to view and edit all of the help that anyone added.
Note: You must have the appropriate job roles to add and edit help.

Related Topics
• How You Manage Dierent Types of Help
• Overview of Flexelds

Tools for Congurations and Extensions


You can congure and extend your application to suit your business needs.
Choose an appropriate tool based on the types of congurations and extensions to make, such as:
• Page modications
• Branding modications
• Object modications
• Security modications
• Business intelligence modications
• Help content management

Note: The following tables present only the key tasks for application changes, not all tasks.

3
Oracle Applications Cloud Chapter 1
Conguring and Extending Applications Overview

Page Modications
This table shows some types of modications that you can make to pages, and the corresponding tools to use. You can
modify only certain pages in Page Composer.

Modication Task Tool

Add, move, delete, show, or hide Page Composer


components on a page  
 

Change a page layout Page Composer


   

Create a site-level search for all users Page Composer


   

Change a page title Structure


   

Modify dialog box content Page Composer


   

Modify aributes for a exeld on a Page Composer


page  
 

Change properties for user interface Page Composer


(UI) components on a standard page  
 

Congure the UI Shell template Page Composer


   

Update a text string wherever it User Interface Text


appears across all pages  
 

Change the look and feel of Appearance page


application pages  
 

Change the announcements on the Announcements page


home page  
 

Branding Modications
This table shows some types of modications that you can make to use your own branding logo, and the corresponding
tools to use.

Modication Task Tool

Congure the UI Shell template Page Composer


   

4
Oracle Applications Cloud Chapter 1
Conguring and Extending Applications Overview

Modication Task Tool

Change the logo and application Appearance page


name in the UI  
 

Change report layouts Layout editor in the BI application or external applications such as Microsoft Word
   

Object Modications
This table shows some types of modications that you can make to objects, and the corresponding tools to use.

Modication Task Tool

Add an aribute to a business Setup and Maintenance work area


object using exelds (not Oracle  
Engagement Cloud)
 

Add a business object page to the Setup and Maintenance work area
Navigator menu  
 

Security Modications
This table shows a security modication that you can make to objects, and the corresponding tool to use.

Modication Task Tool

Add data security to a custom object Setup and Maintenance work area
   

Business Intelligence Modications


This table shows some types of modications that you can make to business intelligence (BI) analytics and reports, and
the corresponding tools to use. For more information, see the Creating and Administering Analytics and Reports guides
relevant to your products.

Modication Task Tool

Create report layout Layout editor in the BI application or external applications such as Microsoft Word
   

Change report layouts Layout editor in the BI application or external applications such as Microsoft Word
   

Create a report The BI application


   

Modify analyses Reports and Analytics work area or the BI application

5
Oracle Applications Cloud Chapter 1
Conguring and Extending Applications Overview

Modication Task Tool

   

Congure dashboards The BI application


   

Help Content Management


This table shows some types of changes that you can make to help, and the corresponding tools to use.

Modication Task Tool

Add and manage help that users can


see in help windows Help windows and Manage Help Content task
 

Modify text that is displayed when Page Composer


the user hovers over a buon, link,  
icon, or tab title
 

Simultaneously replace multiple User Interface Text


occurrences of a word or phrase that  
appear in the help for UI elements
 

Related Topics
• Overview of Flexelds
• How You Manage Dierent Types of Help

Personalization
Personalization refers to the changes that every user of the application can make to certain artifacts in the user interface
(UI).
Note: Personalization changes remain for a user each time the user signs in to the application.

Personalization includes:
• Changes based on how you use the UI, such as changing the width of a column in a table
• Changes that you select to save, such as search parameters
• Changes you make to the springboard and infolets

Context Layers
6
Oracle Applications Cloud Chapter 1
Conguring and Extending Applications Overview

Overview of Context Layers


You can use context layers to congure pages for specic sets of users. All you need to do is make sure that your
sandbox or conguration tool is set to the correct context before you make your changes. If you're using the Unied
Sandboxes feature, which you get by default, you set the context when you create your sandbox. If you have opted out
of this feature and are using Classic Sandboxes, you can select the layer from the conguration tools you want to use. If
a tool doesn't have the option to set a context layer, then its changes are made to the Site layer.
Note: Changes made using the User Interface Text tool are made in all layers, and not just the Site layer.

Available Layers
Dierent application families have dierent context layers. Every application has these layers:
• Site: Changes made in this layer aect all users of the application.
• User: Changes made in this layer aect just one specic user. But, you can't use this layer to make changes for
other users. Personalizations are stored in this layer, and users can make personalizations only for themselves.
An administrator can't make a personalization for another user.

You can congure dierent layers that are available for dierent application families:

• Customer Relationship Management

◦ Site
◦ External or Internal
◦ Job Role

• Human Capital Management

◦ Site
◦ Country
◦ Organization
◦ Time Card Layout

• Others

◦ Site

Layer Rules
Layers exist in a hierarchy. The lower a level is in the hierarchy, the more specic its context is. Layers at lower levels
exist within the scope of the layers above them. This means that the value is set for a context layer within the scope of
the context value for the layers above it. Let's say you're conguring a page for the developer job role. When you select
Job Role as the context level and set the value as Developer, you must also specify a value for the External or Internal
layer.
An object or a page can have multiple congurations at the same time. But this is possible only when at least one of
these conditions are met:

• Congurations are in dierent layers


• Congurations are in the same layer, but the layers have dierent context values

7
Oracle Applications Cloud Chapter 1
Conguring and Extending Applications Overview

When a user requests an object or page, congurations at the lowest layer applicable to them are given precedence.
Let's say you added three columns to the table. You then congured these columns for each context layer as follows:

1. At the Site layer, you added three columns to the Sales table, namely, Promotion Name, Sales Points and
Partner Name.
2. For the external developer, the Sales Points column is hidden.
3. For the internal sales role, the Sales Points column isn't hidden.
Liam, who's an internal salesperson, personalizes this page for himself and hides the Sales Points column.

This is how these columns appear for dierent users:

Users Columns

Internal sales role Sales Points isn't hidden


   

External developer Sales Points is hidden


   

Liam Sales Points is hidden


   

8
Oracle Applications Cloud Chapter 1
Conguring and Extending Applications Overview

Here's a visual representation of these congurations in dierent context layers and values.

Site Layer
Adds three new columns to the Sales table

Internal or External Layer

Internal External
Sales Points column is Sales Points column is
not hidden hidden

Sales Sales Developer Recruiter


Executive Director

Job Role Layer Job Role Layer

Liam
Hides Sales
Points
column

User Layer

Examples of Working with Context Layers


Here are a couple of scenarios where you use context layers to make sure that the appropriate congurations and
personalizations are available to the appropriate users. For instance, job role is a layer. You can congure a page to
make certain changes visible to only a specic job role, such as a sales representative.

9
Oracle Applications Cloud Chapter 1
Conguring and Extending Applications Overview

An Administrator Congures a Page for Sales Representatives


Let's say you want to remove the Export buon from the Sales home page. But you want to remove it only for sales
representatives. Here's what you do before you make your changes:

• Make sure you have the role you're trying to make changes for. If you don't, your security administrator can
help you with that.
• Create and activate a sandbox.

◦ If you're using the Unied Sandboxes feature, which you get by default, select Page Composer as a
conguration tool when you create your sandbox. Also, set the context layer as Job Role with the value,
Sales Representative.
◦ If you have opted out of the Unied Sandboxes feature and are using Classic Sandboxes, you set the
context layer as Job Role with the value, Sales Representative in Page Composer before you make your
changes.

Once all these conditions are met, you can remove the Export buon from your page. When you make this change, the
conguration engine in Oracle Metadata Services generates an XML, and then stores it in the Oracle Metadata Services
repository. So, the original le for the page remains untouched.

When a sales representative requests access to the Sales home page, the conguration engine checks the repository for
XML les that satisfy these two conditions:

• Does the le match the requested artifact, in this case, the Sales home page?
• Does the le match the active context, in this case, the Sales Representative job role?

The conguration engine also looks for additional XML les with personalizations made by the specic sales
representative who requested access to the Sales home page. But for now, let's assume our sales representative hasn't
made any personalizations. Once the conguration engine nds an XML le that satises both these conditions, that
XML le is then layered over the base artifact. In this scenario, the XML le removes the Export buon from your sales
representative's page.

10
Oracle Applications Cloud Chapter 1
Conguring and Extending Applications Overview

Here's an image that shows you how this conguration is done.

Administrator Sales Representative


Adds a new
Requests
attribute to a
page
page

Checks for
XML file
Generates and
stores XML file

XML file
found
Configuration Oracle Metadata Configuration
Engine Services Repository Engine

Layers matched XML


file over base artifact

Sales
Home Page Returns page with new
attribute

A Recruiter Personalizes a Page


Let's say you added three new page entries A, B, and C to the springboard on the home page. You added page entries A
and B at the Site layer for all users and page entry C at the Job Role layer for just recruiters. But Liam, who's a recruiter,
doesn't use page entry B all that much, and wants to hide it from her springboard. Liam can do this by personalizing her
springboard to show only page entries A and C. Personalizations are done in the user layer, and are applicable only to
the user who made them.

11
Oracle Applications Cloud Chapter 1
Conguring and Extending Applications Overview

To hide page entry B, Liam goes to the springboard and clicks the Personalize Springboard icon. She then deselects
page entry B and clicks OK. When she does this, an XML le is generated for Liam's user layer with this change.

The next time Liam opens her home page, the conguration engine retrieves three XML les:

• The le for the changes you made at the Site layer
• The le for the changes you made at the Job Role layer
• The le for the personalization changes Liam made

The les are always applied in the order of their decreasing scope. The le for the context with the largest scope is
applied rst, and the le for the context with the most specic scope is applied last. In this scenario, this is what happens
when each le is applied.

• The rst le adds page entries A and B to the springboard for everyone.
• The second le adds page entry C since Liam is a recruiter.
• The third le removes B from the springboard since Liam chose to hide it.

When a dierent recruiter accesses this page, only the XML les for the Site and Job Role layer are applied. This user
has A, B, and C on the springboard.

12
Oracle Applications Cloud Chapter 1
Conguring and Extending Applications Overview

Here are two diagrams that show you how this personalization ow works. In the rst image, you as an administrator
add page entries A and B to the home page at the Site layer. You add page entry C at the Job Role layer for recruiters.
The image also shows Liam hiding B.

1 2

Adds A and B Administrator Adds C for


for everyone recruiters

Hides B
3

Configuration
Engine You
(1) Generates and
stores XML file Site (3) Generates and
(+A and B) stores XML file User
for your User layer
(2) Generates and (-B)
stores XML file Recruiter
(+C)

Oracle Metadata
Services Repository

The next image shows Liam and another recruiter accessing the same home page. The numbers and leers show the
sequence of the steps.

13
Oracle Applications Cloud Chapter 1
Conguring and Extending Applications Overview

1 1
Requests Requests
home page home page

4 4
Liam Another
Configuration recruiter
Engine
2
Layers
XML file Checks for XML file(s)
Site XML file found
a
3 Layers
XML file
Site
Layers a
XML file
Recruiter
b
Layers
XML file
Recruiter
Oracle Metadata b
Layers Services Repository
XML file
User
c

5 5
Returns home page with Returns home page with
A and C Home Page A, B, and C

Related Topics
• Autoprovisioning
• How do I provision roles to users
• How can I personalize the page entries on my home page
• Personalize Infolets

14
Oracle Applications Cloud Chapter 1
Conguring and Extending Applications Overview

Example of Using Context Layers in Application Changes


While making application changes, when you use the dialog box to select the context layer, you can also include lower
layers to view the application changes from those layers.
The following scenarios explain what happens based on your selected layers. For these examples, the available layers
are Site, Country, and Job Role.

What You See While Making Application Changes


Suppose you choose to:

• Edit the Job Role layer and select Sales Representative as the value for that layer
• Include the Country layer and select France as the value

Note: The Site layer is automatically included because it applies to everyone.

While modifying pages in Page Composer, you see changes that apply to sales representatives in France, based on:

• What was dened for each layer


• Which is the highest layer with application changes for a specic artifact

What Your Application Changes Apply to


No maer what you see while making application changes, your changes apply only to the selected layer for your
changes, that is, Job Role. For example, say a eld is hidden in the Site layer, but displayed in the Country layer for
France. No changes exist for the eld in the Job Role layer for sales representative. Since Country is higher than Site,
you see the eld displayed while modifying pages in Page Composer. However, if you choose to hide the eld as part
of your changes, then that change applies to the Job Role layer for sales representatives. Users with other job roles in
France may still see the eld. However, Job Role is higher than Country. So, no sales representatives in any country can
see the eld, unless a layer higher than Job Role applies to any of these users and has the eld displayed.

Business Process Models


The application is based on business process models that map out business ows. When you congure and extend
your application, for example to add new pages, you can use these models to help you plan. For diagrams of
business process models, see Oracle Fusion Business Process Models (1542019.1) on My Oracle Support at hps://
support.oracle.com.

Business Process Modeling Levels


The business ows are presented in a ve-level hierarchy: industry (L0), business process area (L1), business process
(L2), activity (L3), and tasks (L4).
• The hierarchy goes from a high-level, conceptual view to a low-level, application-specic view.
• L1 through L3 are business-driven and don't depend on any specic implementation in the application.
• L4 aligns with specic features and functionality in the application.

15
Oracle Applications Cloud Chapter 1
Conguring and Extending Applications Overview

Business Process Models In the Application


The application is organized around these hierarchy levels and ows, which puts focus on the activities and tasks that
you must perform. Several aspects of the application are inuenced by, if not directly based on, the business process
modeling levels. For example, the navigation, user interface, and parts of security are inuenced by the business
process modeling levels.

16
Oracle Applications Cloud Chapter 2
Conguring and Extending Applications Conguration Life Cycle

2 Conguration Life Cycle

Overview of Conguration Life Cycle


Always make your congurations in a separate environment, called the test environment, and then migrate them to the
production environment, which is the one you use for your everyday business. You must never make these changes
directly in the application instance you use for your business needs. This is very important because any incomplete,
awed, or unvalidated conguration you make can disrupt your business.
You need to create and enter a sandbox before you can start using conguration tools such as Page Composer and
Application Composer to modify your application. Changes you make with these tools are stored in the sandbox as XML
les. These changes are then merged with the mainline metadata when you publish your sandbox.

Note: Changes you make in one sandbox aren't available in another one.

In essence, here's what a typical conguration life cycle looks like:

1. An administrator congures the application in a sandbox in the test environment.


2. Administrator validates the changes in the sandbox.
3. The sandbox is published.
4. Quality Assurance validates the whole environment after all congurations are complete and published.

17
Oracle Applications Cloud Chapter 2
Conguring and Extending Applications Conguration Life Cycle

5. Congurations are migrated from the test environment to the production environment.

Makes
changes
1
Sandbox
2
Validates
changes
Administrator 3

Publishes all
changes to mainline

Validates
mainline

T
4

Quality
Test Environment
Assurance
5

Migrate changes
to production

P
Production
Environment

Congurations and Extensions


Conguration Workow
While using Application Composer and Page Composer to make changes to your application, use sandboxes to save
your changes in a segregated environment. For example, before making application changes, suppose you create a
sandbox named MySandbox, and then make your changes in that sandbox. Now, if others want to see your changes, they
can use MySandbox.

18
Oracle Applications Cloud Chapter 2
Conguring and Extending Applications Conguration Life Cycle

Note: If you have multiple users working on the same sandbox, then conicts may arise within a sandbox.
Hence, users must adhere to the prescribed guidelines to avoid such conicts.

After you complete your application changes, others can review and approve your changes, and then publish to the test
environment.

Note that a exeld sandbox is for testing only and can't be published. Instead, you can deploy a exeld to the test
environment using the exeld UI. To test a exeld conguration before deploying it to the test environment, deploy
it to a exeld sandbox. The changes that you deploy to a sandbox are isolated from the test environment. Users who
make the exeld sandbox active in their session can only see these changes. After you're satised with the changes in
the sandbox, you can deploy the changes to the test environment.

You can also use the Manage Congurations dialog box to:

• View others' conguration metadata les


• Download others' conguration metadata les for manually moving them to another environment or
diagnosing any issues

Considerations for Viewing and Diagnosing Application Changes


Use the Manage Congurations dialog box to view and diagnose changes made to application pages. Application
changes are role-dependent and by default, the Manage Congurations dialog box displays the changes that the
signed-in user had performed.
Before you begin viewing application changes, ensure that you have administrative privileges to access the Manage
Congurations dialog box. If you're unable to display the page that contains the changes:

1. Click your user image or name in the global header, and select Manage Congurations from the
Administration menu.
2. Use the Search text eld on the Manage Congurations dialog box to search for the page, page fragment, or
task ow.
You can view the application changes for a user in the Current Context column on the Manage Congurations dialog
box. On this dialog box, you can change the page, page fragment, or task ow for which you're viewing application
changes using the Search eld.

Developers too may be assigned to specic roles and can view only those application changes that are permied for
the specic roles. However, administrators can view all application changes made at the site level, and for any user, in
the All Layers column on the Manage Congurations page. To view application changes made by more than one user,
administrators can select multiple users.

Page-Level Changes
To diagnose issues pertaining to application changes, determine whether changes have been applied to a page. Use the
Manage Congurations dialog box to determine if page-level changes exist. If a page modication causes problems,
such as a user interface component disappears from a page, you can export the application changes and examine the
document le.

Related Topics
• Overview of Context Layers

19
Oracle Applications Cloud Chapter 2
Conguring and Extending Applications Conguration Life Cycle

Sandboxes
Overview of Sandboxes
You use sandboxes to make application changes and test them without impacting other users in the environment.
Wherever possible, make changes to the application in a sandbox rather than making direct changes in the mainline
environment. Sandboxes set apart untested conguration changes from the mainline environment. So you can test your
changes in the sandbox and then publish it. After publishing, your changes become available in the mainline metadata
or other sandboxes after they're refreshed. So everyone can then see your changes in the environment. Mainline
metadata is the primary branch of metadata a sandbox is published to.

Why You Need Sandboxes


Today's business landscape is quite dynamic. Companies are expected to respond quickly to address both customer
and market needs. So multiple teams need to make application changes at the same time while sharing the same data
model and conguration starting point. But you may get conicts between teams working that way. To avoid such
conicts, sandboxes come in handy.

Unied Sandboxes
You can either use the Unied Sandboxes UI, which is the default feature you get, or opt out of it using the Oerings
work area to get Classic Sandboxes.

With Unied Sandboxes, you can refresh your sandboxes to bring in the latest changes from the mainline metadata
to your sandboxes, and do many other new and versatile sandbox activities. You get a consistent sandbox experience
across all conguration tools and a more robust user interface with this feature.

With Unied Sandboxes, you can do these additional sandbox activities:


• Select the conguration tools to enable for your sandboxes while creating them.
• Enable all conguration tools in the same way using the Sandboxes UI. So you get a consistent sandbox
experience across tools.
• Restrict access to various sandbox activities for users. For example, you can specify these access rights for your
sandboxes:
◦ Full access
◦ Edit and preview access
◦ View only access
• View just your application changes without having other context layers hide your content.
• Test your changes in a preview mode that shows you exactly how your application changes would appear in a
published sandbox.
• Refresh and merge sandboxes with latest changes in mainline metadata from other published sandboxes. After
merging all changes, you can publish your sandbox.
• After opting in to the Unied Sandboxes feature, if you register your target environment in your source
environment, you can do these additional migration tasks using the Migration UI:
◦ Migrate your changes from the test environment to the target environment without manually
downloading and uploading the conguration set le.

20
Oracle Applications Cloud Chapter 2
Conguring and Extending Applications Conguration Life Cycle

◦ Move only new changes from the source environment to the target environment.

Sandbox Usage
You typically use sandboxes for either of these purposes:
• Test-Only: You can make application changes using test-only sandboxes, which you don't want to publish to
the mainline code.
• Publish: Once satised with the application changes made in the test-only sandbox, you can replicate these
changes in a sandbox that you want to publish. And then publish your changes to the mainline code. This
sandbox type is also known as the integration sandbox, because teams working in parallel use this sandbox as
the nal staging point before publication to the mainline code.

Note: Before each patch or upgrade, publish or delete your sandboxes. If you haven't yet completed your
work, restart with a new sandbox.

Unied Sandboxes
Enable or Disable the Unied Sandboxes Feature
You get to use Unied Sandboxes by default. But if you want to use Classic Sandboxes instead of the default sandboxes,
opt out of the Unied Sandboxes feature.
Before you start, consider these points:
• Make sure you totally understand what it means to opt in to or opt out of the feature and what impact that
would have.

◦ When you use Application Composer in your Unied Sandbox, an object can only be edited in any one
sandbox in the environment at a time.
◦ You can't deploy your exelds to a sandbox after you opt in to Unied Sandboxes. You must deploy
them directly to the mainline environment.
• You must publish or delete any sandboxes that are open right now. Use the Manage Sandboxes dialog box
to do these tasks. You can open this dialog box by clicking your user image or name in the global header and
selecting Manage Sandboxes. Once you opt in to Unied Sandboxes, you can no longer see the published
Classic Sandboxes.

In the Oerings work area, enable or disable the Unied Sandboxes feature:
• Oering: Any with the Application Extensions functional area
• Functional Area: Application Extensions
• Feature: Unied Sandboxes
• Opt In Task: Click Continue if you're sure about enabling or disabling this feature.

Related Topics
• Congure Oerings

Create and Activate Unied Sandboxes


To make changes to the application, you must rst store the changes in an active sandbox. You can either create a
sandbox or select an existing one, and make it active. You must activate the conguration tools you want to use in your

21
Oracle Applications Cloud Chapter 2
Conguring and Extending Applications Conguration Life Cycle

sandbox. If you plan to use Page Composer in your sandbox and edit pages at a layer other than Site, you need to create
a sandbox just for that layer, and activate only Page Composer in it.
Note: You can create up to 20 sandboxes. But, you can increase this limit using the Maximum Number of
Sandboxes prole option. In the Setup and Maintenance work area, use the Manage Applications Core
Administrator Prole Values task in the Application Extensions functional area.

Create and Activate Sandboxes


Follow these steps to create and activate sandboxes for most conguration tools. For exelds, use the Manage
Descriptive Flexelds task or the Manage Extensible Flexelds task instead.

1. Click Navigator > Conguration > Sandboxes.


2. On the Sandboxes page, click Create Sandbox.
3. Enter a name and description for your sandbox.
4. In the Publishable eld, select Yes or No. If you set this option as No, you can just use your sandbox for testing
purposes, but can never publish it.
5. In the All Tools section, select the tools you want to activate for this sandbox. The context layers for all selected
tools are set as Site by default. So the changes you make using these tools aect all users.
6. If you select Page Composer, you can click the Edit Sandbox Context icon and change the context layer
from Site to another layer, for example External. You can nd the Edit Sandbox Context icon in the Support
Context column.

Note: If you want to use other tools along with Page Composer in your sandbox, don't change
the context layer for Page Composer, even though you can. That's because all tools except Page
Composer support only a single context layer, Site. So if you change the context layer for Page
Composer from Site to any other layer, all other tools that you might have selected earlier will be
deselected.

7. Click Create to just create the sandbox, or Create and Enter to enter or activate the sandbox after creating it.
Here are a few things to know about activating tools in your sandbox.

• If you try to use a conguration tool in a sandbox without activating the tool in it, you get a message prompting
you to activate the tool. You can add more tools to your sandbox later also.

• To create and manage saved searches and make UI adjustments (for example, change a table's column width)
just for yourself, you must leave your sandbox before making these changes. But if you want to make these
changes for others too, then make the changes with Page Composer open, in which case you also must be in a
sandbox.

Activate Existing Sandboxes


Follow these steps to activate a sandbox.

1. Click Navigator > Conguration > Sandboxes.


2. From the list of sandboxes, if available, nd the one you want to activate, and click the Enter Sandbox icon for
that sandbox. Your sandbox is activated, and you can see its name on the sandbox bar above the global header.
You can use the options available on the sandbox bar to quickly do some activities, such as view sandbox
details, publish the sandbox, or leave the sandbox.

Related Topics
• Set Prole Option Values
• Considerations for Managing Flexelds

22
Oracle Applications Cloud Chapter 2
Conguring and Extending Applications Conguration Life Cycle

Best Practices for Using Page Composer in Unied Sandboxes


Here are a few things to keep in mind if you're using Page Composer in your sandbox:
• While creating your sandbox, you can change the context layer for Page Composer from the default, Site, to
another layer, or from another layer back to Site. But for all other tools, you can use only the Site layer. After
you create your sandbox, you can't change the context layer for Page Composer.
• While creating your sandbox, if you have selected Page Composer and a layer that's not Site, don't add other
tools to your sandbox. If you do, you will be prompted to conrm adding other tools and changing the layer for
Page Composer to Site.
• After you create a sandbox that has only Page Composer and a context layer that isn't Site, you can't go back
and add any other tool to your sandbox.
• While creating your sandbox, suppose you have selected multiple tools including Page Composer. And then
you try to change Page Composer's context layer to a layer that's not Site. That change won't happen unless
you conrm that all other tools should be removed from the sandbox.

How to Resolve Conicts in Unied Sandboxes


When you're in a sandbox, if other users publish their sandboxes, you get refresh notications on the sandbox bar
above the global header. At this time, it's a good practice to refresh your sandbox. When you refresh, all changes
published in the mainline environment are brought into your sandbox. You get sandbox merge conicts in the merge
log when dierent users change a specic le using dierent sandboxes. If the changes are made to dierent les,
they're automatically merged, and aren't even reported in the merge log.
Note: In Application Composer, an object gets automatically locked when you create it or modify it in a
sandbox. So in such cases, an object can only be edited in any one sandbox at a time. If the sandbox is
published or deleted, the lock is removed.

You must resolve all conicts agged in the merge log so that you can publish your sandbox. To review the merge log,
on the Sandbox Detail: <Sandbox Name> page, click the Merge Log tab. The log displays details about the sandbox
merge statuses. Let's understand what these statuses mean and how we can resolve the sandbox merge conicts based
on their statuses.

Merge Status Icon What It Means How I Can Resolve Merge


Conicts

Automatically Merged Content Auto Merge Dierent users changed These changes are merged
    dierent aributes of the automatically.
same le using dierent  
sandboxes.
 

Resolvable Conicts Resolvable Dierent users changed the


    same aribute of the same le These changes can be merged
using dierent sandboxes. to the mainline environment.
  On merging, the changes in
the mainline environment
overwrites your sandbox
changes. So review the merge
actions and accept or reject
them.

• If you accept, you can


later redo any changes
that were overwrien

23
Oracle Applications Cloud Chapter 2
Conguring and Extending Applications Conguration Life Cycle

Merge Status Icon What It Means How I Can Resolve Merge


Conicts

and then publish your


sandbox.
• If you reject, your
sandbox remains
untouched, but you still
need to accept a merge
before you publish your
sandbox.

Unresolvable Conicts Unresolvable Dierent users changed les


    in dierent sandboxes, but Do any of these tasks:
the merge conicts can't be
automatically resolved. • Undo your sandbox
  changes.
• In your sandbox, make
the same change, which
the other user made in
the published sandbox,
and try to resolve the
conict.
• Create another sandbox
and make your changes
in that one.

How the Refresh and Merge Processes Work in Unied Sandboxes


Sandbox changes are refreshed and merged when two dierent users make changes to the same le using two
dierent sandboxes. Let's look at an example. Suppose your manager creates a sandbox named Sandbox1 and you
create another sandbox named Sandbox2. Your manager then makes a change to a le using Sandbox1 and publishes
it to the mainline environment. Now if you make changes to the same le and refresh Sandbox2, all changes published
in the mainline environment are merged into Sandbox2. What if both you and your manager entered dierent values
to the same aribute of the le? In that case, the value that your manager entered using Sandbox1 persists because
Sandbox1 is published to the mainline metadata. To bring back the changes that you made in Sandbox2, you need to
reenter the sandbox and make the changes again.

Application Changes That Can or Can't be Merged


Let's again take the same example of Sandbox1 and Sandbox2. Here's a list of application changes made in Sandbox2
that can merge with the mainline environment, when the same le is changed in both sandboxes.

Application Changes Tools Used to Make the Changes

Changes in business objects and their Application Composer and Congure Business Objects
related elds  
 

Changes in data security Data Security


   

Changes in lookups Lookups


   

UI text changes User Interface Text

24
Oracle Applications Cloud Chapter 2
Conguring and Extending Applications Conguration Life Cycle

Application Changes Tools Used to Make the Changes

   

Changes to messages, such as Messages


warning messages and information  
messages
 

Note: Flexelds and setup tasks, apart from the ones listed in the table, aren't supported in Unied
Sandboxes. So changes in these artifacts aren't merged when Sandbox2 is refreshed.

And here's a list of changes made in Sandbox2 that can't merge with the mainline environment when the same le is
changed in both sandboxes. To bring back those changes, you can create another sandbox, make the changes in it, and
publish that sandbox.

Application Changes Tools Used to Make the Changes

Changes to the appearance of the Appearance


application  
 

Changes in pricing conguration Manage Service Mappings


   

Changes to the page content Page Composer


   

Changes to global page template Page Template Composer


   

New pages created Page Integration


   

Related Topics
• Considerations for Deploying a Flexeld to a Sandbox

Options to Open Conguration Tools from Unied Sandboxes


In Unied Sandboxes, after activating the conguration tools, you can also use shortcuts to quickly open some of these
tools and make your changes. But you can't open all tools from there. In which case, you can get to those tools using
regular navigation.

Use Shortcuts in Sandboxes


After you activate a sandbox, all tools activated in it are listed on the sandbox bar and the Sandbox Details page. You
can open these tools from either of these locations:

• The Tools drop-down buon on the sandbox bar above the global header
• The Active Tools section of the Sandbox Detail: <Sandbox Name> page

In this list, you may notice that some tools are available, while others, for example, Lookups and Messages are grayed
out. You can click the available tools to open them directly from the Sandboxes UI.

25
Oracle Applications Cloud Chapter 2
Conguring and Extending Applications Conguration Life Cycle

Use Regular Navigation


This table lists the regular navigation options to open all tools that you can activate in your sandboxes. It also indicates
whether you can open the tools from the Sandboxes UI.

Tool Name Can Open Using the Sandboxes UI? Regular Navigation

Application Composer Yes


    Click Navigator > Application Composer.

Congure Business Objects Yes


    Click Navigator > Business Objects.

Appearance Yes
    Click Navigator > Appearance.

Manage Service Mappings No


    Click Navigator > Pricing Administration,
and then on the Tasks panel tab, click
Manage Service Mappings.

Page Integration Yes


    Click Navigator > Page Integration.

Structure Yes
    Click Navigator > Structure.

Lookups No
    In the Setup and Maintenance work area,
use the lookup tasks, such as:

• Manage Standard Lookups


• Manage Common Lookups
• Manage Set Enabled Lookups

User Interface Text Yes


    Click Navigator > User Interface Text.

Messages No
    In the Setup and Maintenance work area,
use the messages tasks, such as:

• Manage Messages
• Manage Messages for General
Ledger

Data Security No
    Click Navigator > Security Console, and
then click the Administrator tab, and click
Manage Database Resources.

Page Composer Yes


    Click your user image or name in the
global header and select Edit Pages.

Global Page Template No


    Click your user image or name in the
global header and select Edit Global Page
Template.

26
Oracle Applications Cloud Chapter 2
Conguring and Extending Applications Conguration Life Cycle

Related Topics
• Update Existing Setup Data

Object Locking in Application Composer


The automatic object locking ability in Application Composer avoids the risk of conicts between multiple users working
on objects in parallel and prevents any sandbox merge conicts that may arise when dierent users change a specic
object using dierent sandboxes.
Application Composer automatically places a lock on a business object when you create or modify it in a unied
sandbox. The locked object displays a lock icon next to its object name in Application Composer's object navigation tree.
A gold lock indicates that the object is locked in the current sandbox. A gray lock indicates that the object is locked in
a dierent sandbox. Hover over a locked object's name in the navigation tree to display the name of the sandbox that
holds the lock.

Application Composer displays and enforces object locks across all unied sandboxes. You can only edit a locked object
in the sandbox that holds the lock. For example if the Service Request object is modied in Sandbox A, only Sandbox
A holds the lock and anyone using Sandbox A can modify Service Request. Any other sandbox displays a gray lock on
Service Request in Application Composer, and prevents users from modifying it.

The lock status of objects changes each time you publish or delete a sandbox, or when a new object lock is established.
Collapse and then expand Application Composer's object tree to update the lock status of all objects. Any action that
causes the object tree to be refreshed will update the lock status, including when you exit and reenter a sandbox, or
refresh a sandbox. If an object is locked and that lock is not yet visible in the current sandbox, a new lock is not allowed
to be placed on that object and an error message appears while saving the changes.

For more information on how object locking works in unied sandboxes, see the FAQs on Object Locking.

Best Practices for Preventing Object Locking


Here are some tips on how you can prevent or work around object locking:
• Plan your object model and user interface congurations, and divide the work to prevent two users requiring
the same object or objects locked.
• Name sandboxes clearly with appropriate names or initials, so when a lock is in place, it's easy to identify who
to contact to release the lock from the sandbox holding the lock.
• Perform congurations in smaller increments. Test and publish more frequently to prevent holding locks.
• Delete test sandboxes created to try out new congurations after they are no longer needed to prevent
unnecessary locking.

Publish Unied Sandboxes


After you're done making changes to the application, publish the sandbox to make your changes available to all
users. You must have the Administer Sandbox (FND_ADMINISTER_SANDBOX_PRIV) privilege to publish sandboxes.
Remember, you can't make further changes in the sandbox once you publish it.
Before you start, do these tasks:
• Test or validate your changes in the sandbox in preview mode before actually publishing it. If you made
changes using Page Composer, don't forget to close it before testing. To preview your changes, click the
Sandbox Mode drop-down buon on the sandbox bar above the global header, and select Preview as if
Published (Context: All).
Note: You can see the sandbox bar only when you're in an active sandbox.

27
Oracle Applications Cloud Chapter 2
Conguring and Extending Applications Conguration Life Cycle

• Resolve all conicts agged in the merge log of your sandbox.

To publish a sandbox:
1. Click Navigator > Conguration > Sandboxes.
2. On the Sandboxes page, click the name of the sandbox you want to publish.
3. Click Publish.
Note: The Publish buon might be disabled for your sandbox because of various reasons. For
example, you haven't yet made any changes in your sandbox, or the Control Publish Sandbox
Action in Production Environment prole option (FND_ALLOW_PUBLISH_SANDBOX) is set to No.
4. Click Continue to Publish. The sandbox is published to the mainline metadata.
5. Click Done.

FAQs for Unied Sandboxes


Who can preview, edit, and publish sandboxes?
Users with the Administer Sandbox (FND_ADMINISTER_SANDBOX_PRIV) privilege can preview, edit, and publish
sandboxes. This privilege is assigned by default to the administrators for product families. Your security administrator
can dene which users have job roles with this privilege.
Note: With other sandbox privileges, users can only do some tasks. Users having the Manage Sandbox
(FND_MANAGE_SANDBOX_PRIV) privilege can edit but not publish sandboxes. While those having the View
Sandbox (FND_VIEW_SANDBOX_PRIV) privilege can view sandboxes in read-only mode.

Why can't I create more sandboxes?


Probably, you have reached the limit for the maximum number of sandboxes. But don't worry, try any of these
solutions:
• Increase the limit using the Maximum Number of Sandboxes prole option. In the Setup and Maintenance
work area, use the Manage Applications Core Administrator Prole Values task in the Application
Extensions functional area. The default value set for this prole option is 20.
• Delete an unused sandbox.
• Publish a sandbox.

Related Topics
• Set Prole Option Values

Why is the Publish buon on my Sandbox Detail page disabled?


That could be because of one or more of these reasons:
• You haven't yet made any changes in your sandbox. The Publish buon is enabled only after you make a
conguration change in the sandbox.
• Another sandbox is currently being published in this environment. Try publishing your sandbox again later.
• Your mainline metadata has changes from other published sandboxes. You must refresh your sandbox and
then publish it.
• You don't have the Administer Sandbox (FND_ADMINISTER_SANDBOX_PRIV) privilege, which is required for
publishing sandboxes. To get this privilege, contact your security administrator.

28
Oracle Applications Cloud Chapter 2
Conguring and Extending Applications Conguration Life Cycle

• The Control Publish Sandbox Action in Production Environment prole option


(FND_ALLOW_PUBLISH_SANDBOX) is set to No. To enable publishing, set this prole option to Yes. In the
Setup and Maintenance work area, use the Manage Applications Core Administrator Prole Values task in
the Application Extensions functional area.
• The application is in maintenance mode. Try publishing your sandbox again later.
• While creating this sandbox, you have set the Publishable eld as No, which means this sandbox can never be
published.
• Your sandbox is in an inactive state, which happens if a publish action on it failed. You can never publish such
inactive sandboxes.
• You just had a release update or upgrade, and all sandboxes that were available before the update or upgrade,
can no longer be published. In the future, publish your sandboxes before the release updates or upgrades
happen.
• A conguration set was just migrated into the environment, and now all sandboxes in the environment
can no longer be published. In the future, publish or delete sandboxes in an environment before migrating
congurations there.

Related Topics
• Set Prole Option Values

Why doesn't the page I am editing with Page Composer work with the sandbox
context?
Let's see why you might get errors about the page not supporting the context layer of the active sandbox, and how you
can resolve them.
• Maybe the context layer of your sandbox isn't a layer that your page supports. Context layers vary based on the
category you select for the sandbox. For example, the Customer Relationship Management category supports
certain layers that apply to certain pages, and the Human Capital Management category supports other layers
and pages. You can activate a sandbox with the appropriate layer and try editing the page again.
• You might not have a role that gives you access to what the sandbox layer covers. For example, if the Internal
context layer requires a role with back-end access, you can edit pages at that layer only if you have the role. For
more information, contact your security administrator.

Why are the lookup, message, and data security changes appearing in my Unied
Sandbox even though I haven't yet refreshed my sandbox?
Lookups, messages, and data security records are values stored in tables. These records aren't copied to your sandbox
until you make changes in these artifacts in your sandbox. But what if another user changes these artifacts in a dierent
sandbox and publishes it before you make changes in your sandbox? In that case, the other user's changes show up in
your sandbox as soon as you make changes to these artifacts, even before you refresh your sandbox.

How can I deploy exelds to a Unied Sandbox?


You can't deploy your exelds to a sandbox if you have opted in to Unied Sandboxes. You must deploy them directly
to the mainline environment.

Related Topics
• Considerations for Managing Flexelds

How does object locking impact object workows?


When you create an object workow for an object that is not currently locked, a lock is created for that object.

29
Oracle Applications Cloud Chapter 2
Conguring and Extending Applications Conguration Life Cycle

You can create a new object workow for a locked object in the sandbox that holds the lock. However, an object locked
in a dierent sandbox is disabled for selection in Application Composer's list of available objects while creating an object
workow. Hover over the name of the disabled object in the list to identify which sandbox has a lock on that object.

When are object locks released?


An object lock exists until the sandbox that holds the lock is published or deleted. A lock is not removed when the
change that caused the lock is deleted or reverted. For example, adding a new page layout creates a lock on an object if
the object is not already locked, but deleting the layout will not release the lock.

Does importing and exporting congurations impact object locks?


Importing congurations can impact sandboxes. You must delete existing sandboxes before importing new
congurations to release all locks and to prevent users from thinking that they can refresh and publish after an import.

How does object locking aect parent and child objects?


An object is locked only when it is directly modied. Modifying a child object will not result in a lock on the parent object.
For example, consider a Custom Context subtab (a subtab that displays content of a dierent object), which is added to
the Premium Accounts object. The Custom Context subtab displays the Accounts object, which is the parent object of
Premium Accounts. The object lock is placed on Premium Accounts and not Accounts, because Accounts (the parent
object) was not modied.

How does object locking work for dynamic choice lists?


When you create a custom dynamic choice list, a lock is placed on the object that the custom dynamic choice list is
created for. The data source object (the object that the dynamic choice list pulls data from) is not locked.

Can I manually set or remove object locks?


No, you can't manually set or remove object locks. Locks are automatically set when you create or modify objects in a
unied sandbox, and automatically released when you publish or delete the sandbox that holds the locks.

Classic Sandboxes
How You Manage Congurations in Classic Sandboxes
You can apply dierent types of congurations to an application. For example, you can apply changes to an
application's metadata stored in the metadata services repository or changes related to data security of the application.
All such congurations are stored in sandboxes and are validated before applying them to an application.

Types of Congurations in Sandboxes


Sandboxes can contain the following types of congurations:
• Metadata changes - These changes (such as non-exeld user interface (UI) page changes) are captured in a
metadata sandbox.
• Data security changes - These changes are additionally captured in a data security enabled sandbox.
• Changes in the generated exelds business components - These changes are captured in a exeld that's
deployed as a single exeld sandbox.

Once you're ready to make sandbox changes available in the mainline metadata, either publish the metadata or data
security sandbox, or deploy the exeld. You can download only metadata and data security sandboxes as a sandbox
le for import to another application instance.

30
Oracle Applications Cloud Chapter 2
Conguring and Extending Applications Conguration Life Cycle

The following table lists the dierences among the types of sandboxes.

Type of Changes Type of Sandbox Method for Making Changes Downloadable?


Available in Mainline
Metadata

Metadata Sandbox Publish sandbox Yes


       

Data security Sandbox enabled for data Publish sandbox Yes


  security changes    
 

Flexeld Flexeld deployed as a Deploy exeld No


  exeld-enabled sandbox    
 

All changes made in an active sandbox are captured in that sandbox.

Environment
To make application changes, you must rst create a sandbox and then use tools, such as Page Composer to make
the changes. These changes remain within the sandbox and don't aect the mainline metadata. You must test and
validate your changes in the sandbox. After testing, you can publish your sandbox to make the changes available in the
production environment for other users.

Don't make application changes directly in the mainline metadata. Make all application changes in the sandbox rst.
When you make changes to an application in a sandbox, you isolate the changes from the mainline metadata. After
completing the changes in the sandbox, verify them. When you're ready to save the changes, publish the metadata or
security-enabled sandbox to the mainline metadata.

When you create a sandbox, you can see the information pertaining to only the existing application changes in the
current mainline metadata. For example, suppose you make an application change in a sandbox and publish it. Then,
on creating another sandbox for the next change, you will see the previous change in the new sandbox because that
change exists in the current mainline metadata.

Flexeld sandboxes are for testing only and can't be published. Make exeld congurations that are stored in a
database. Then, deploy those congurations to a sandbox to see the resulting deployment artifacts in a sandbox
environment. Flexelds are deployed directly to the mainline metadata using the exeld user interface.

Tools
You can use several conguration tools to make application changes. For example, you can modify objects and pages
using Page Composer, which uses sandboxes. Oracle Business Process Composer and Oracle SOA Composer are
also tools used for making application changes, but they don't use sandboxes. They have their own mechanisms for
handling application changes.

Managing a Flexeld Sandbox


To create a exeld-enabled sandbox, deploy a exeld to a sandbox using the Manage Flexeld task ow. The exeld
sandbox gets its name from the exeld you deploy. You can't test two exelds in the same sandbox. After deploying
a exeld as a sandbox, sign out and sign in again to view how the sandbox reects the exeld changes, such as new
segments. You can redeploy the same exeld to the same sandbox repeatedly as you make incremental changes to
the exeld setup. A exeld sandbox can't be published. So, when the exeld is deployed to the mainline metadata,

31
Oracle Applications Cloud Chapter 2
Conguring and Extending Applications Conguration Life Cycle

any page changes or data security in the exeld sandbox can't reach the mainline metadata. If you're entitled to do so,
manage exeld-enabled sandboxes in the Sandboxes UI.

Related Topics
• Considerations for Deploying a Flexeld to a Sandbox

Guidelines for Working with Classic Sandboxes


In the runtime conguration workow, use sandboxes to isolate the changes from the mainline metadata for testing and
validating. After you're satised with the changes, you can publish the changes back to the mainline metadata.
The testing sandboxes are never published and therefore produce no concurrency conicts between sandboxes. You
can have several testing sandboxes at the same time.

Application changes in the sandboxes that are published are merged back to the mainline metadata. This gure
illustrates the two types of sandboxes and their relationship to the mainline metadata.

Mainline Code

Sandbox intended
for publishing

Merge to
mainline
Make
application
changes and Publish
Create Sandbox
validate within sandbox
sandbox

Sandbox intended
for testing
Make
application
Do not publish
Create Sandbox changes and
(testing only)
validate within
sandbox
Sandbox intended
for testing
Make
application
changes and Do not publish
Create Sandbox
validate within (testing only)
sandbox

Working with a Single Sandbox


Conicts may arise when users edit a shared artifact, such as when a user performs an operation that adds or edits a
translatable string. For example, suppose:
• One user edits a eld's display label or help text, or a validation rule's error message. Whereas, another user
performs an operation at the same time that similarly aects translatable strings.

32
Oracle Applications Cloud Chapter 2
Conguring and Extending Applications Conguration Life Cycle

• Two or more users are working in Navigator menus that are shared across applications. Whenever a conict
arises among users, the application displays concurrency warning messages.

Working with Multiple Sandboxes


Multiple sandboxes are used when congurations are stored in testing as well as production sandboxes. Suppose, after
you create a sandbox, a concurrent change is made in the mainline metadata. Now, when you aempt to publish that
sandbox, the application detects such conicts at publication time, and you get error messages. For example, when
you try to publish your sandbox, you may get a message showing a conict on oracle/apps/menu/fnd/applcore/
dataSecurity/dataSecurityService/mds/DSMO.xml. This message indicates that the security changes that you made
in your sandbox conict with other security changes in the mainline metadata. Delete the sandbox and recreate your
changes in a new sandbox.
If multiple users are permied to work in multiple sandboxes at the same time, follow these guidelines to avoid conicts:

• Any number of test-only sandboxes can operate concurrently. That is, multiple users can use multiple
sandboxes concurrently for testing if these sandboxes will never be published. Sandboxes that are used
for testing only, and that aren't published, cause no conicts with each other. Be aware, however, that all
modications will be lost when the sandboxes are deleted.
• For sandboxes that aren't for test-only and will be published, users can use multiple concurrent sandboxes only
if they operate on mutually exclusive artifacts. For example, you can have:

◦ One sandbox that contains a page that a user is modifying to add a task ow
◦ Another sandbox that contains a dierent page from a dierent application

However, some objects might still share underlying artifacts, and thus it's not always obvious if two objects
are truly mutually exclusive. Thus, proceed with caution when using multiple concurrent sandboxes that will
be published. It's still possible that a conict could occur, which would require the deletion of one or more
sandboxes.
• Suppose the users update an artifact in both, the mainline metadata and in one sandbox, or in two dierent
sandboxes. Now, when you publish the sandbox, the application detects such conicts and you get an error
message. At this point, cancel publishing the sandbox to avoid overwriting previous changes.

Note: For a sandbox that contains congurations pertaining to ADF Business Components, sign out and sign
in again after switching in or out of this sandbox. This process ensures avoiding any inconsistencies between
the runtime caches and the ADF Business Components denitions.

Create and Activate Classic Sandboxes


To make changes to the application artifacts, you must rst store them in an active sandbox. You can either create a
sandbox or select an existing sandbox, and designate it as an active sandbox. The active sandbox holds the context for
all the changes. The sandbox uses a database to store the actual changes. After testing your changes, you can publish
the sandbox, or deploy the exeld, and the changes are merged into the mainline metadata. Eventually, the sandbox is
archived.
This procedure is for seing up non-exeld sandboxes. For exelds, use the Manage Descriptive Flexelds task or the
Manage Extensible Flexelds task.

To create and activate a sandbox:

1. Click your user image or name in the global header, and select Manage Sandboxes from the Administration
menu.
2. Use the Manage Sandboxes dialog box to create a sandbox.
3. Click Save and Close.

33
Oracle Applications Cloud Chapter 2
Conguring and Extending Applications Conguration Life Cycle

4. On the Manage Sandboxes dialog box, select the new sandbox or an existing one, and click Set as Active. The
sandbox is designated as the active sandbox.
5. Close the Manage Sandboxes dialog box.

Once a sandbox is active for your session, the sandbox name is displayed on the sandbox bar above the global
header.

Publish Classic Sandboxes


After completing the application changes in the sandbox, publish them to make them available in the application for all
others.
Before you start publishing your sandbox, test or validate your changes. If you made application changes using Page
Composer, don't forget to close it while testing.
1. Click your user image or name in the global header, and select Manage Sandboxes from the Administration
menu.
2. On the Manage Sandboxes dialog box, select the sandbox and click Publish. The Publish conrmation message
box appears.
3. Click Yes. The sandbox is published to the mainline metadata.
4. Close the Manage Sandboxes dialog box.

Migration
Overview of Migration
You can move your congurations from the test environment, which is the source, to the production environment,
which is the target. You use the Migration page to create a migration set and export it from the source environment,
and then import it into the target environment. A conguration set is a JAR le that contains all your congurations
across all product families, such as Oracle Metadata Services repository, JEDI, CRM, and BI. Changes you export from
the source environment can't be merged with any changes you manually make in the target environment. As such, it's
very important that you never congure the target environment directly.
To move your congurations, you can either use Unied Migration, which you get by default or Classic Migration. To
use Classic Migration, you need to opt out of the Unied Sandboxes feature using the Oerings work area. Both the
appearance and behavior of your Migration page changes when you use Classic Migration.

Note: In Unied Migration, the conguration set is called migration set.

Unied Migration
Here are the things you can do in a Unied Migration:
• You can register the target environment in the source environment.
• You have the option to migrate only new changes if both environments are synchronized.
• Your migration set is automatically sent to the target environment for import, if the target is registered and
available.
• Your migration set is imported into a sandbox instance before it's applied to the target environment. You can
preview your congurations in this sandbox instance before applying them to the mainline.

34
Oracle Applications Cloud Chapter 2
Conguring and Extending Applications Conguration Life Cycle

Classic Migration
Here are a few things to know if you choose to use Classic Migration:
• You always need to migrate all congurations in the source environment.
• You have to manually download the conguration set from the source environment, and manually upload it
into the target.
• You can't preview congurations in the target environment before applying them.
Here's a diagram that shows what you can do with Classic and Unied Migrations.

Migration

Classic Migration Unified Migration

Cannot preview Can preview


changes changes

Environments
registered?

Move all Move new


No Yes
changes changes

Manually download Automatically


and upload send migration
migration set set to target

35
Oracle Applications Cloud Chapter 2
Conguring and Extending Applications Conguration Life Cycle

Contents of the Conguration Set


You use the Migration page to create a set of congurations and extensions made to an environment, download the set,
and then upload it into another environment. This conguration set includes congurations across all product families.
Note: In Unied Migration, the conguration set is called migration set.

What It Includes
The conguration set includes, but isn't limited to these changes:
• Application changes done using Application Composer. However, not all changes made using Application
Composer are migrated.
• Changes made to application artifacts using these tools:
◦ Page Composer
◦ Appearance
◦ Structure
◦ User Interface Text
◦ Page Integration
• Changes in these artifacts of the Applications Core Setup application:
◦ Messages
◦ Lookups
◦ Data security, but not the ones created by the HCM Proles UI
◦ Descriptive, extensible, and key exelds, and value sets
◦ Aachment categories and metadata
◦ Deep links
• Changes in Reports and Analytics, such as regeneration of SOAP services, including user-dened aributes
• Changes done using the Manage Oracle Social Network Objects task
• Changes in functional security seings made in Application Composer, including functional privileges that
control access to custom objects. However, not all security changes are migrated.
Note: If you migrate any functional security associated with roles in the source to a target instance,
and the corresponding role doesn't exist in the target instance, an error occurs on import. To avoid
these errors, you can selectively create these roles in the target environment when you import your
conguration set.

What It Might Include


Depending on what modules you select during export, your conguration set might include these changes:
• Changes in CRM email templates created in Application Composer
• Changes in Enterprise Scheduler Service (ESS) module:
◦ Job denitions

36
Oracle Applications Cloud Chapter 2
Conguring and Extending Applications Conguration Life Cycle

◦ Job sets
◦ Job schedules
◦ Incompatibilities
◦ Work shifts
◦ Work assignments
◦ Work assignment schedules
◦ Job request parameters
• Changes in Service Oriented Architecture (SOA) artifacts, such as congurations done using SOA Composer
• Changes done using Oracle Business Intelligence Enterprise Edition, including but not limited to these features:
◦ Oracle Business Intelligence Answers
◦ Oracle Business Intelligence Delivers
◦ Business Intelligence Composer
◦ Dashboard Builder
◦ Oracle Business Intelligence Publisher
Note: You can move congurations done using business intelligence tools only if the Business
Intelligence in Conguration Set Migration Disabled prole option is set to No.

What It Doesn't Include


Your conguration set doesn't include these items:
• The following Application Composer changes:
◦ Object artifacts that were generated from the Import and Export page in Application Composer to make
extensions available for importing and exporting
◦ User names and passwords for secured SOAP web service connections
◦ The enabled aachment feature for custom objects
• Personalizations
• Changes in activity types and subtypes
Note: Activity types and subtypes are performance metrics that managers use to track the
performance of their team members. For example, email is an activity type that sales managers
can use to track the performance of their salespeople. The subtypes of this activity type can be
outbound and inbound. Managers can use activity subtypes to track more details about an activity
type.

• Unpublished congurations within a sandbox


• Deletions, for example, the set doesn't include the removal of a custom object. After you import a conguration
set into the target environment, you must examine the environment for any deletions that you must make
manually.

• Roles or role hierarchy changes


• Custom roles created outside of Application Composer
• Entitlements or privileges created outside of Application Composer

37
Oracle Applications Cloud Chapter 2
Conguring and Extending Applications Conguration Life Cycle

• Security Console changes, including these changes made directly in the Security Console:

◦ Enterprise roles
◦ New duty roles
◦ Role hierarchy changes

You must manually update the target environment with any Security Console changes.

Related Topics
• Import and Export Custom Objects

Migrate Congurations Using Classic Migration


Using a conguration set, you can move your congurations from a test environment, which is your source, to a
production environment, which is your target.

Before You Start


Before creating a conguration set, make sure you meet these conditions:
• The source and target environments are of the same release, with the same standard and one-o patches
applied to both environments.
• All Page Composer congurations made in sandboxes are complete and published.
• All congurations and extensions made using the Structure page, the Manage Standard Lookups task, and
Security Console, are complete.
• To move content created using Oracle Business Intelligence Enterprise Edition, set the Business Intelligence
in Conguration Set Migration Disabled prole option to No in source and target environments. You can nd
this prole option in the Manage Administrator Prole Values task in the Setup and Maintenance work area.
• You have the following privileges to access the Migration page:

◦ Manage Outgoing Conguration Set


◦ Manage Incoming Conguration Set

Contact your security administrator for details.


• You never make changes in the target or production environment while applying congurations.

Note: If you make changes to the production environment in emergency situations, you must make the same
changes to the test environment. Making the changes to the test environment ensures that these changes are
included in the next conguration migration.
• Don't make any changes in the source environment during the export process.
• You delete any temporary les on the server from previous migrations. If there are temporary les on the
server, click the Delete buon next to your previous import and export records.

Create Conguration Sets


1. In the source environment, click Navigator > Conguration > Migration.
2. On the Outgoing tab of the Migration page, click Create Conguration Set.

38
Oracle Applications Cloud Chapter 2
Conguring and Extending Applications Conguration Life Cycle

3. Provide a name for the conguration set.


4. Optionally, type a description of the conguration set.
5. Select the content you want to migrate. The choices available on this dialog box are ltered by the oerings you
have opted in for.
Note: The Industry solution extensions module is for Oracle's internal use only and has no impact
on migration.
6. Click Save and Close.
7. Click Refresh periodically to see the current status of the set creation because creating a conguration set
can take a few minutes. You can click Log to review the process log, which provides more details about the
congurations that are being compressed. If an error or exception occurs during this process, the log gives you
information about the congurations that failed to compress. The process runs asynchronously, so you can
close the page and return to it later.
8. Eventually, the status changes to Ready for Download, which means that the congurations are ready for you
to download. Before downloading the congurations, you can click Content Read Me to download the Readme
le listing all the congurations you exported.
9. Click Download to download your conguration set. Ensure that the downloaded le is a JAR le.
10. After you download the le on your local le system, click Delete to remove the temporary les from the server.

Apply Conguration Sets


After you apply congurations, end users must sign out and sign back in to see the changes. So apply congurations
when fewer people are signed into the environment. To apply congurations to the target environment, follow these
steps:
1. Open the Migration page in the target environment.
2. Click the Incoming tab.
3. Click Browse, specify the name and location of the conguration set le, and click Open.
4. Once the status for the conguration set on the Incoming page is Ready to Apply Congurations, review
the roles in your conguration set that are missing in your target environment. Create any missing roles as
required. To review and create the roles, follow these steps:
a. Click Details.
b. Select an application.
c. Select the roles you want to create.
d. Click Create Role, and click Yes.
e. After the roles are created, click OK.
f. Click Save and Close.
5. Click Apply to apply the conguration set to your target environment.
6. Periodically, click Refresh to view the current status of the Apply action. When the conguration set is
successfully applied to the target environment, the status is displayed as Applied and Deleted. You can review
the process log, if required. The process runs asynchronously, so you can close the page and return to it
later. If problems occur during an Apply action, log a service request using My Oracle Support at hps://
support.oracle.com.

Post Migration Tasks


Do these tasks after you apply your conguration set to the target environment:
1. Access the target environment and look for any deletions that you must make manually.
2. Delete and recreate any web service connections in the target environment, using the target environment URL
and credentials.
3. Deploy all exelds that display a Patched status.

39
Oracle Applications Cloud Chapter 2
Conguring and Extending Applications Conguration Life Cycle

4. Do the following tasks to send the new and updated social network denitions to the social network server:
a. In the Setup and Maintenance work area, open the Manage Oracle Social Network Objects task.
b. As part of the applying congurations process, some objects are created or updated. If the Enabled value
of such an object is anything other than No, trigger the process of sending its denition to the social
network server. You can do this by disabling the object and enabling it again with its original status. For
example, if the Enabled value is Manual, then you can do these tasks:
i. Disable the object.
ii. Enable the object, and select the value, Manual.
iii. Click OK and save the changes.
c. On the Manage Oracle Social Network Objects page, click Synchronize to synchronize a selected object,
or click Synchronize All to synchronize all objects at the same time.
5. Manually migrate all business processes created in the source environment to the target environment.
6. If a new theme was created and applied in the source environment, and you want to use that theme in the
target environment, then go to the Appearance work area and manually apply that theme.
7. After applying congurations, do functional testing to verify the changes. Suppose testing exposes problems
with the congurations, such as importing more than what you intended, or the changes weren't what you
expected. In such cases, restore your environment to its pre-migration conguration.
a. Open the conguration set in the Incoming tab or infotile of the Migration page.
b. Click Restore to revert to the state before the conguration set was applied.
8. Finally, broadcast information to the users that they must sign out and sign in to view the most recent changes.

Things to Know About Migration


• You can't restore your environment to an earlier conguration if the environment is upgraded after your
previous migration. But if a new import is submied in the upgraded instance, then the most recent import can
be reversed.
• The lookup values for lookup elds that exist in both source and target aren't overwrien during the
conguration import. The values from the source are added to the target and they coexist for the same
eld. For example, the Status eld in its source environment has values, Open and Closed. In the target
environment, this eld has values, Yes and No. After the import, the Status eld in the target environment has
values, Open, Closed, Yes, and No.
• During conguration import, the data security privileges aren't automatically revoked in the target
environment. For example, say a specic privilege is granted in the target environment, but the corresponding
privilege doesn't exist in the source environment. During import, the privilege in the target environment isn't
automatically revoked. To address this issue manually, add such a privilege to the source environment and
revoke it. The revoke action is picked up as a conguration instance during the conguration import process
and applied to the target environment.
• You can create reports directly in the target environment. However, make sure that you create the reports and
reference them to subject areas that were created in the source environment. Don't create subject areas directly
in the target environment.
• You can initiate conguration export and import tasks only from the mainline metadata. If you initiate
migration from a sandbox, the process doesn't execute.
• While an upload or restore activity processes Presentation Services changes, these things can happen:

◦ Reports that were submied by Oracle Enterprise Scheduler to Oracle Business Intelligence Publisher and
were scheduled to execute during the process, might fail.
◦ The Reports and Analytics pane might not be displayed.

40
Oracle Applications Cloud Chapter 2
Conguring and Extending Applications Conguration Life Cycle

◦ Oracle Business Intelligence Publisher reports might not be displayed on Oracle Business Intelligence
Presentation Services analyses or dashboard pages.
◦ Users might not be able to access these Oracle Business Intelligence Enterprise Edition features:
• Oracle Business Intelligence Answers
• Oracle Business Intelligence Delivers
• Business Intelligence Composer
• Oracle Business Intelligence Interactive Dashboards
• When you restore your environment to an earlier conguration, you lose all personalizations you made after
the previous migration.

Related Topics
• Import and Export Custom Objects

Migrate Congurations Using Unied Migration


Use a migration set to move your congurations from the source environment to the target environment. With Unied
Migration, you can import your congurations into a sandbox in the target environment before you apply them to
the mainline. And if you register your target environment in your source environment, you can do these additional
migration tasks:

• Migrate your changes from the test environment to the target environment without manually downloading and
uploading the migration set le.
• Move only new changes from the source environment to the target environment. This type of migration is
called delta migration. However, only sandbox-aware modules support delta migration. All other modules move
all changes every time they're migrated, even in delta migrations.

Before You Start


Before creating a migration set, consider these points:
• Make sure that the source and target environments are of the same release, with the same standard and one-
o patches applied to both environments.
• Make sure that both source and target environments are using the Unied Sandboxes feature, which you get by
default. You can't migrate your congurations if only one environment uses this feature.
• You should delete or publish any sandboxes in the target environment that have Application Composer
enabled, before you begin your migration.
• Make sure that all Page Composer congurations made in sandboxes are complete and published.
• Make sure that all congurations and extensions made using the Structure page, the Manage Standard
Lookups task, and the Security Console, are complete.
• For faster migration, set the Business Intelligence Extender in Conguration Set Migration Disabled prole
option to Yes in the target environment. You can nd this prole option in the Manage Administrator Prole
Values task in the Setup and Maintenance work area. By seing this prole option, you exclude Business
Intelligence Extender artifacts from your migration set. So you can specically use this option for certain
product-specic implementations that don't use Business Intelligence Extender.
• To move content created using Oracle Business Intelligence Enterprise Edition, set the Business Intelligence
in Conguration Set Migration Disabled prole option to No in both the source and target environments. You

41
Oracle Applications Cloud Chapter 2
Conguring and Extending Applications Conguration Life Cycle

can nd this prole option in the Manage Administrator Prole Values task in the Setup and Maintenance
work area.
• You must have the following privileges to access the Migration page:
◦ Manage Outgoing Conguration Set
◦ Manage Incoming Conguration Set
Contact your security administrator for details.
• You should never make changes in the target or production environment while applying congurations.
Note: If you make changes to the production environment in emergency situations, you must make
the same changes to the test environment. Making the changes to the test environment ensures
that these changes are included in the next conguration migration.

• Don't make any changes in the source environment during the export process.
• Delete any temporary les on the server from previous migrations. If there are temporary les on the server,
click the Delete buon next to your previous import and export records.

Register the Target Environment


1. In your source environment, go to the Manage Conguration Set Migration Target Security Policy task in
the Setup and Maintenance work area.
2. Enter the URL of your target environment. Use the full URL, including the host and protocol information.
3. Enter your user name and password.
4. Click Save and Close.
Note: If you have registered the target environment, you don't need to manually download the migration set
from the source environment and upload it to the target environment. You can directly sign in to the target
environment, go to the Incoming infotile on the Migration page, and upload the migration set le. However, if
you didn't register the target environment, or if the target was unreachable during export, you must download
your migration set.

Verify the Target Environment


1. In the source environment, click Navigator > Conguration > Migration.
2. Click the Environment Info infotile.
3. Verify that the page displays the same URL as the target instance.
If you don't see the correct target instance, try registering it again.

Create Migration Set


1. In the source environment, click Navigator > Conguration > Migration.
2. Click Create Migration Set from the Outgoing infotile. If you want to migrate all congurations instead of just
the new changes, click the Move All Changes link for a full migration.
3. Provide a name for the migration set.
4. Provide the email ID of the person you want to notify after the migration set is created. You can provide
multiple email IDs separated by commas. When the migration set is created, email notications are sent to
these specied people.
5. Optionally, type a description of the set.
6. Select the content you want to migrate.

42
Oracle Applications Cloud Chapter 2
Conguring and Extending Applications Conguration Life Cycle

Note: The Industry solution extensions module is for Oracle's internal use only and has no impact
on migration.
7. Click Save and Close.
8. Click the Refresh icon periodically to see the current status of the set creation. You can click the Log icon to
review the process log, which provides more details about the congurations that are being compressed. If an
error or exception occurs during this process, the log gives you information about the congurations that failed
to compress. The process runs asynchronously, so you can close the page and return to it later.
9. Eventually, the status changes to Ready for Download, which means that the migration set is complete. You can
click Content Read Me to download the Readme le listing all the congurations you exported.
10. If you have registered the target environment, you don't need to download your migration set. In such cases,
you can directly apply the migration set.
11. If you didn't register the target environment, do these tasks:
◦ Click the Download icon to download your migration set. Ensure that the downloaded le is a JAR le.
◦ After you download the le on your local le system, click Delete to remove the temporary les from the
server.

Apply Migration Set


After you apply congurations, end users must sign out and sign back in to see the changes. So, apply congurations
when fewer people are signed in to the environment. To apply congurations to the target environment, follow these
steps:
1. Open the Migration page in the target environment.
2. Click the Incoming infotile.
3. Click the Upload Migration Set link. Then, browse for your migration set le, and click OK.
Note: If you have registered the target environment, you don't need to upload the migration set
to the target environment. That's because your migration set is automatically sent to the target
environment for import. But, if you didn't register the target environment, or if the target was
unreachable during export, you must upload your migration set.
4. Provide the email ID of the person you want to notify after the migration set is imported. You can provide
multiple email IDs separated by commas. When the migration set is imported, email notications are sent to
these specied people.
5. Review the roles in your migration set that are missing in your target environment, and create them if required.
To review and create the roles, follow these steps:
a. Click the Details icon.
b. Select an application.
c. Select the roles you want to create.
d. Click Create Role, and click Yes.
e. After the roles are created, click OK.
f. Click Save and Close.
6. Click Import to import your migration set into a sandbox instance in the target environment.
7. Wait for the status to change to Successfully Imported.
8. Optionally, click Preview to view your congurations in the sandbox preview mode.
9. Provide the email ID of the person you want to notify after the migration set is applied. You can provide
multiple email IDs separated by commas. When the migration set is applied, email notications are sent to
these specied people.
10. Click Apply when you're ready to apply your congurations to the target environment.

43
Oracle Applications Cloud Chapter 2
Conguring and Extending Applications Conguration Life Cycle

11. Periodically, click the Refresh icon to view the current status of the apply action. The migration set is
successfully applied to the target environment when the status changes to Applied and Deleted. You can review
the process log, if required.
The process runs asynchronously, so you can close the page and return to it. If problems occur during an Apply
action, log a service request using My Oracle Support at hps://support.oracle.com.ter.

Post Migration Tasks


Do these tasks after you apply your migration set to the target environment:
1. Access the target environment and look for any deletions that you must make manually.
2. Delete and recreate any web service connections in the target environment, using the target environment URL
and credentials.
3. Deploy all exelds that display a Patched status.
4. Do the following steps to send the new and updated social network denitions to the social network server:
a. In the Setup and Maintenance work area, open the Manage Oracle Social Network Objects task.
b. As part of the applying congurations process, some objects are created or updated. If the Enabled value
of such an object is anything other than No, trigger the process of sending its denition to the social
network server. You can do this by disabling the object and enabling it again with its original status. For
example, if the Enabled value is Manual, then you can do this:
i. Disable the object.
ii. Enable the object, and select the value, Manual.
iii. Click OK and save the changes.
c. On the Manage Oracle Social Network Objects page, click Synchronize to synchronize a selected object.
You can also click Synchronize All to synchronize all objects at the same time.
5. Manually migrate all business processes created in the source environment to the target environment.
6. If a new theme was created and applied in the source environment, and you want to use that theme in the
target environment, then go to the Appearance work area and manually apply that theme.
7. After applying congurations, perform functional testing to verify the changes. Suppose testing exposes
problems with the congurations, such as importing more than what you intended, or the changes weren't
what you expected. In such cases, restore your environment to its pre-migration conguration.
a. Open the migration set in the Incoming infotile of the Migration page.
b. Provide the email ID of the person you want to notify after the conguration is restored. You can provide
multiple email IDs separated by commas. When the conguration is restored, email notications are sent
to these specied people.
c. Click Restore to revert to the state before the migration set was applied.
8. Finally, broadcast information to the users that they must sign out and sign in to view the most recent changes.

Things to Know About Migration


• You can't restore your environment to an earlier conguration if the environment is upgraded after your
previous migration. But if a new import is submied in the upgraded instance, then the most recent import can
be reversed.
• Lookup values for lookup elds that exist in both source and target aren't overwrien during the conguration
import. The lookup values from the source are added to the target and all the lookup values coexist for the
same eld. For example, the Status eld in its source environment has values, Open and Closed. In the target
environment, this eld has values, Yes and No. After the import, the Status eld in the target environment has
values, Open, Closed, Yes, and No.

44
Oracle Applications Cloud Chapter 2
Conguring and Extending Applications Conguration Life Cycle

• Lookups can be migrated with both conguration migration, and setup data migration. However, once you use
one of these methods, you should use the same method for all subsequent lookup migrations. Don't use both
methods to migrate lookups between the same set of environments.
• During migration, data security privileges aren't automatically revoked in the target environment. For example,
say a specic privilege is granted in the target environment, but the corresponding privilege doesn't exist in
the source environment. During import, the privilege in the target environment isn't automatically revoked. To
address this issue manually, add such a privilege to the source environment and revoke it. The revoke action
is picked up as a conguration instance during the conguration import process and applied to the target
environment.
• You can create reports directly in the target environment. But, ensure that you create the reports and reference
them to subject areas that were created in the source environment. Don't create the subject areas directly in the
target environment.
• You can't initiate a migration if you're in an active sandbox.
• While an upload or restore activity processes Presentation Services changes, these things can happen:

◦ Reports that were submied by Oracle Enterprise Scheduler to Oracle Business Intelligence Publisher and
were scheduled to execute during the process might fail.
◦ The Reports and Analytics pane might not be displayed.
◦ Oracle Business Intelligence Publisher reports might not be displayed on Oracle Business Intelligence
Presentation Services analyses or dashboard pages.
◦ Users might not be able to access these Oracle Business Intelligence Enterprise Edition features:
• Oracle Business Intelligence Answers
• Oracle Business Intelligence Delivers
• Business Intelligence Composer
• Oracle Business Intelligence Interactive Dashboards
• When you restore your environment to an earlier conguration, you lose all personalizations you made after
the previous migration.

Related Topics
• Manage Themes

Preview Mode in Unied Migration


After you import your congurations into the target environment, you can preview them in a sandbox instance before
you apply them. But you can't preview all your congurations. You can only preview those congurations that are
sandbox aware, and have no dependency on non-sandbox artifacts.
Note: When migrating congurations, make sure you have the appropriate administrator roles to view and
test all your changes in preview mode.

What You Can See


The ADF module is the only module that's sandbox aware. As such, changes to these MDS artifacts from ADF are
available for preview:
• Custom objects
• Custom aributes

45
Oracle Applications Cloud Chapter 2
Conguring and Extending Applications Conguration Life Cycle

• Pages
• Workows
• Groovy scripts
• Triggers
• Lookups
• Aachments
• Data security
• Strings
• Web services

Note: Though visible, these web services won't be functional because their connections aren't
migrated.

However, if any of these artifacts have any dependency on non-sandbox aware artifacts, they don't show up in your
preview.

What You Can't See


Artifacts that aren't part of the ADF module aren't visible in preview mode. Here are a few of those non-sandbox aware
artifacts:
• BI reports
• BI custom subject areas
• Functional security
• New custom objects
• Email templates
• Workspace congurations
• Notication preferences
• ESS artifacts
• SOA artifacts
• Industry extensions
• Analytics

FAQs for Migration


What's the dierence between a delta migration and full migration?
A delta migration moves only those changes that were made to an environment after the last migration was done.
On the other hand, a full migration moves all changes made to an environment.
For instance, let's say Alpha is your source environment, and Beta is your target environment. You create object X in
Alpha environment and do a migration. Then, you create object Y in Alpha environment and do another migration. If
the second migration is a delta migration, only the object Y is moved. However, if it's a full migration, both the objects X
and Y are moved.

46
Oracle Applications Cloud Chapter 2
Conguring and Extending Applications Conguration Life Cycle

When can I do a delta migration?


You can do a delta migration if you meet these three conditions:
• You have registered your target environment in your source environment, without any issues.
• You're using the Unied Sandboxes feature in both source and target environments.
• Both of your environments are still synchronized.

Why aren't my environments synchronized?


Your environments might not be synchronized if you did either of these things:
• Directly congured the target environment.
• Upgraded one of the environments or both of them.

How can I synchronize my environments?


If your source and target environments aren't synchronized, you must do a full migration to synchronize them again.

Conguration Management
Considerations for Exporting and Moving Congurations
Congurations are stored in XML les. You can use these XML les to export congurations for the following reasons:
• To move congurations and extensions to another environment, such as the production environment.
• To diagnose issues noticed in the test environment.
• To send les to your help desk for further diagnosing.

The following table lists the tools to use to export and move congurations and extensions.

Tasks Tools to Use

Move all congurations to another Conguration Set Migration.


application environment.  
 

Move only descriptive exeld Setup and Maintenance work area. Moves congurations for a specied module.
congurations to another application  
environment. To move congurations for all modules, use Conguration Set Migration.
   

Move only extensible exeld Setup and Maintenance work area. Moves congurations for a specied module.
congurations to another application  
environment. To move congurations for all modules, use Conguration Set Migration.
   

Move only value set congurations to Setup and Maintenance work area. Moves congurations for a specied module.
another application environment.  
  To move congurations for all modules, use Conguration Set Migration.
 

47
Oracle Applications Cloud Chapter 2
Conguring and Extending Applications Conguration Life Cycle

Tasks Tools to Use

Move only lookups to application Setup and Maintenance work area. Move application standard lookups, application common
environment. lookups, or both.
   

Move only data security policies to Setup and Maintenance work area.
another application environment.  
  It doesn't move Oracle Fusion Human Capital Management roles.
 

Export congurations to a le to help Manage Congurations dialog box.


diagnose an issue.  
 

Downloading Congurations
You can download all congurations of a page for all layers using the Download Conguration for All Layers link in
the Manage Congurations dialog box. To open Manage Congurations dialog box, click your user name in the global
header, and select Manage Congurations. The le you download contains all the conguration XML les for the page.
However, you can't upload this le anywhere.

Downloading Conguration Set Reports


After exporting congurations, you can view and download a conguration set report that contains a list of all
congurations available in a conguration set. To do so, click Content Read Me from the Outgoing tab of the
Conguration Set Migration page. To open the Conguration Set Migration page, select Conguration > Migration
from the Navigator menu.
This report includes all new or updated:

• Objects
• Fields
• Pages
• Business intelligence (BI) changes

Business logic changes such as Groovy scripts and triggers aren't included in the conguration set report.

Related Topics
• Guidelines for Moving Related Common Reference Objects
• Overview of Context Layers
• Export Setup Data Using Oering or Functional Area

Download Congurations From a Page


Let's say the congurations you made to a page resulted in an error. You need to download the congurations you
made to that page to diagnose what went wrong. You can use the Manage Congurations dialog box to download all
the conguration XML les for that page. The downloaded les contain the changes made to all the layers of that page,
and you can use them to diagnose conguration issues.

48
Oracle Applications Cloud Chapter 2
Conguring and Extending Applications Conguration Life Cycle

Download Conguration Files


Do you know the le path to the page you want to download congurations from? If you do, then follow these steps:

1. Click your user image or name in the global header, and on the Seings and Actions menu, select Manage
Congurations.
2. In the Search eld, enter the le path to your page and click the Search icon.
3. Click Download Conguration for All Layers.
If you don't know the le path, then follow these steps:

1. Create and activate a sandbox.


2. Go to the page you want to download congurations from.
3. Click your user image or name in the global header, and on the Seings and Actions menu, select Edit Pages.
4. Click the Structure tab.
5. Click any component on the page.
6. In the conrmation window, click Edit.
7. Go back to the Add Content tab.
8. Click Manage Congurations.
9. Scroll down and click Download Conguration for All Layers.

49
Oracle Applications Cloud Chapter 2
Conguring and Extending Applications Conguration Life Cycle

50
Oracle Applications Cloud Chapter 3
Conguring and Extending Applications Page Modication

3 Page Modication

Overview of Page Modication


You can use Page Composer to change page content, layout, and more. Using other tools, you can create pages and
change UI text, themes, infolets, and so on.

Let's look at some of the things that you can do using other tools:
• Change the UI text using tools, such as User Interface Text.
• Change the look and feel of the application using the Appearance page.
• Open an infolet page and modify it using Page Composer.
• Create and manage pages for hosting third-party applications using Page Integration page.

Note: You can't use Page Composer to congure your home page. Instead, you can use other tools such as,
Structure and Appearance for home page congurations.

Related Topics
• Congure Home Page Navigation
• Overview of Conguring Home Page and Navigation
• Overview of Conguring Themes and Home Page Seings
• Dene Home Page Appearance

Overview of Using Page Composer


Guidelines for Page Modication
Before modifying pages, you must do these tasks:
• Understand the typical workows for working with application changes.
• Verify that the page can be modied. To do so, you can check if either the Edit Pages or the Edit <Page
Name> Pages menu item is available in the Seings and Actions menu. If no, then that means the page can't
be modied.
• Conrm that your privileges are sucient for modifying the page.
• Activate a sandbox.

Related Topics
• Overview of Sandboxes
• Create and Activate Unied Sandboxes
• Conguration Workow
• Overview of Context Layers

51
Oracle Applications Cloud Chapter 3
Conguring and Extending Applications Page Modication

• Best Practices for Using Page Composer in Unied Sandboxes

Page Composer Views


You can use either Design view or Source view for viewing and changing page content and layout in Page Composer.
To open a view option, select it from the View menu at the top left corner of the page. Although both views share many
common page modication features, you can use some unique features in each view.

Design View
In Design view, you see one region that shows a WYSIWYG rendering of the page and its content. Work with
components directly and access their properties from the toolbar in the chrome of the individual component.

Source View
In Source view, you see two regions:
• Selection pane, showing a WYSIWYG rendering of the page and its content
• Source pane, showing a hierarchical ordering of the page components, including some components that
otherwise don't appear on the page. You can select and congure such components in Source view.

Tip: Controls on individual components are inactive in Source view, but you can click an individual
component to select it.

In Source view, you can:


• Click a component in the Selection pane to highlight the component in the hierarchical list. The cursor turns to
a magnier and a blue outline appears around the component selection. You can also traverse the hierarchy
and select components directly.
• Click Edit on the view header to work with components indirectly and access their properties. You can also right
click the object in the hierarchy, and click Edit.

Page Component Properties


All components have congurable properties that control, or express their appearance and functionality. Many
properties are common to all component types, while some properties are unique to one component type. Use the
Component Properties dialog box to view the properties of a component. You can open this dialog box by selecting the
component that you want to edit and clicking Edit Component. You can see properties of similar functions in tabs that
name the category of the properties.
Note: Properties and tabs can vary from component to component.

Component Property Tabs


This table describes the tabs that you might see in a component properties dialog box.

Tab Description

Parameters Seings that control component aspects that are specic, or often unique to the component.

52
Oracle Applications Cloud Chapter 3
Conguring and Extending Applications Page Modication

Tab Description

   
For example, on a page containing a map, a component might have a parameter that provides
a choice between units of measurement.
 

Display Options
  Includes these seings that aect the chrome of a component:

• Header, header text, and border


• Actions menu
• Edit, Remove, Expand, Collapse, and other icons
• Tooltips

For example, display options on image layout components specify the image source URL and
its optional link target.

Child Components The list of all components contained within and under the control of the parent component,
  including controls to order the child components.
 

Style Seings that aect the look and feel of the component chrome or the component contents.
  For example, font, color, and dimension. These seings override corresponding values from a
Content Style parent object, such as a component, page, and application, providing an opportunity to ne-
  tune appearance.
 
Some style properties might be disabled at the component level if other page or application
elements (such as the skin) don't support modication to the property.
 

Events Events and event handlers associated with all components on the current page.
   
For example, when you select a check box within the current context, it's an event. The code
that drives the result of an event, such as making another component visible is an event
handler.
 

Considerations for Modifying Objects That Appear on Multiple


Pages
Use Page Composer to modify objects that appear on multiple pages. Whether your application changes aect one or
more pages depends on the way you include the object on the page and the applications that you use.
Consider these points when you modify objects that appear on multiple pages.

Appearance of Object Modications Based on Shared and Non-Shared Task Flows


The following table briey describes the task ow scenarios when object modications appear on one or more pages.

If the object is... Then the modications...

Not part of a shared task ow Don't appear on other pages

53
Oracle Applications Cloud Chapter 3
Conguring and Extending Applications Page Modication

If the object is... Then the modications...

   

Part of a shared task ow Do appear on all pages that include the shared task ow
   

Caution: When shared task ows include embedded logic that uses data from the page, the logic can override
the application changes that you make in Page Composer.

Modify Page Content Using Page Composer


Modify Page Components Using Resource Catalog
Use the Resource Catalog to modify pages. This catalog provides a selection of task ows, portlets, and layout
components. Open the Resource Catalog in Page Composer from either Design view or Source view.
Aspects of components pertinent to page modications include:
• Opening the Resource Catalog
• Adding components
• Hiding components manually
• Hiding components programmatically

Before You Start


Activate a sandbox.

Open the Resource Catalog


In Design view:
1. Open the page that you want to modify in Page Composer.
2. From the existing components, select the one that you want to be the parent component.

Tip: Alternatively, use the Add Box icons (Add Box Above, Add Box Below, Add Box Left, and Add
Box Right) to insert a box component. Then select the component as the parent component.
3. Click the Add Content buon associated with the parent component.
The Resource Catalog appears.

Add Components
In Design view:
1. Open the Resource Catalog.
2. In the Resource Catalog, nd the component that you want to add.
3. Click the Add icon associated with the component.
4. Cut and paste, or drag and drop the component to place it.

54
Oracle Applications Cloud Chapter 3
Conguring and Extending Applications Page Modication

In Source View:
1. Select the container component in the selection pane.
2. In the Source view toolbar, click Add Content.
3. In the Resource Catalog, nd the component you want to add.
4. Click the Add icon associated with the component.
Note: If you added an HTML markup with references to an external CSS as your component, ensure that:
• The CSS has Access-Control-Allow-Origin header in its server.
• Your link tag has crossorigin aribute specied.

Hide Components Manually


Use the Show Component property to specify whether the component appears to users. By default, all components are
visible. To manually hide a component, deselect Show Component on the Component Properties dialog box.

If the component is a child component, then deselecting the Show Component property hides only the child
component.

If the component is a parent component, then deselecting the Show Component property of the parent component
hides the parent and all child components it contains. So, when you hide a parent component, you automatically hide all
child components.

You can do any of the following:


• Hide a child component directly
• Hide a child component from within the parent component
• Hide a parent component and all child components

To hide a child component directly:


1. Click the Edit icon in the header of the child component. This opens the Component Properties dialog box.
2. Click the Display Options tab.
3. Deselect Show Component.
4. Click OK.
To hide a child component from within the parent component:
1. Click the Edit icon on the containing box's toolbar.
2. Click the Child Components tab.
3. Deselect the box next to the component you want to hide.
4. Click OK.
To hide a parent component and all child components:
1. Click the Edit icon in the box header.
2. Click the Display Options tab.
3. Deselect Show Component.
4. Click OK.

Hide Components Programmatically


You can add an Expression Language (EL) expression to a component that enables you to set a condition for hiding the
component. For example, suppose you have two check boxes (1 and 2) on a page. You also have a buon (B) that you
want to be visible only if check box 2 is selected. To step through the logic, ask yourself questions such as the ones in
the following table.

55
Oracle Applications Cloud Chapter 3
Conguring and Extending Applications Page Modication

Question Answer Purpose of Question

What's the condition? Check box 2 is selected Determines what the occurrence, or event,
    is.
What action or event must happen?  
  Determines the component that triggers
the event.
 
Determines what expression to write.
 

What happens when the condition is met? Buon "B" appears. Determines the eect of the action.
     
What happens when the event happens? Show the component: Buon B
   
(The implication is that buon B is hidden
until the event occurs.)
 

What property determines whether a The Show Component property Determines the property the code aects.
component is visible?    
 

So the logic is: If 2 is checked, then the Show Component property of B is activated.

You place the expression on the component that receives the action.

Here's a sample code that you may add to the component.


#{if checkbox2.selected = true}

After you think through the logic and nd the correct expression, add it to the property. You can add an expression
using the expression builder for the Show Component property only on dashboard pages; not on work area pages. Also,
only administrators can perform this task.

To open the EL Editor and add an expression to a property for a dashboard page:

1. Click the Edit icon in the component header.


2. Click the Display Options tab.
3. Click the Edit icon next to the Show Component property, and select Expression Builder.
4. Add an expression to check for an event or condition, and set the property. Based on the result, turn the
property on or o.
To hide a parent component and all child components programmatically for a dashboard page:

1. Click the Edit icon in the box header.


2. Click the Display Options tab.
3. Click the Edit icon next to the Show Component property, and select Expression Builder.
4. Add an expression to check for an event or condition, and set the property. Based on the result, turn the
property on or o.

Related Topics
• Overview of Sandboxes
• Create and Activate Unied Sandboxes

56
Oracle Applications Cloud Chapter 3
Conguring and Extending Applications Page Modication

Modify Pages
You can modify your user interface (UI) components by updating their properties. For example, you can change eld
labels, hide components, or make a check box required.
When you use Page composer, you always begin in Design view. You can use Design view to add content and make
layout changes. But not in all pages. For these other pages, you must use Source view to make content and layout
changes.

Note: Any changes you make apply only to the page that you're on. These changes also apply to all or specic
groups of users. But that depends on the context layer you choose when you make your changes.

Before You Start


Activate a sandbox.

Modify UI Components
1. Click your user image or name in the global header and select Edit Pages.
2. Select the context layer in which you want to make your changes. For instance, you could make changes for
only specic job roles.

Note: When you modify a UI component for a specic job role, that job role must be assigned to you
for you to test the application change in the sandbox. Your security administrator can either assign
the job role to you directly, or make the job role self-requestable for you to add it yourself from the
resource directory.
3. By default, you start in the Design view, which lets you navigate to the component you want to modify.

To use Source view, you must select Source from the View menu. This menu isn't displayed by
default. To display the View menu, set the Source View for Page Composer Enabled prole option
(FND_PAGE_COMPOSER_SOURCE_VIEW) to Yes.
4. When you have found your UI component, click the Select buon on top of the page.
5. Hover over the UI component until a border appears around it, and then click it.
6. Select Edit Component.
7. Update the component's properties to make your changes.

Each component has its own set of properties, which may include some of the properties in this table. In Design
view, you only get the main properties. To get all properties, you have to use Source view.

Property Description

Description Text used by screen readers, for information in addition to what is provided in the Short
  Desc property.
 

Label Display text for the component, for example, the eld prompt or the single prompt for a
  group of check boxes.
 

Read only Whether users can edit the component, for example, if a check box can be selected or not.
   

57
Oracle Applications Cloud Chapter 3
Conguring and Extending Applications Page Modication

Property Description

Rendered Whether the component is visible or hidden to users on the page.


   

Required Whether users must enter something for the component before saving the page.
   

Short Desc Text that appears when users hover or focus on the component, for example, hover over a
  eld label or click in the text box.
 

Show Component Whether the component is visible or hidden to users.


   

Show Required Whether an asterisk is displayed to indicate that the component is required.
   

8. If you want to modify more components, click Add Content to return to Design view. You can now repeat steps
4 to 7 to modify more components.
9. Click Close to save.

If available, click Save and Label instead to also label your changes. If you do this, you can revert to this
conguration at any point in the future. Labels are saved with a prex of composer_. For example, if you enter
myLabel, then the label is composer_myLabel.

Related Topics
• Examples of Working with Context Layers
• Overview of Conguring Home Page and Navigation
• Role Provisioning and Deprovisioning
• Overview of Sandboxes
• Create and Activate Unied Sandboxes

Modify Tabs on Pages


This example demonstrates how to modify tabs on pages using Page Composer.
The following table summarizes the key decisions for this scenario.

Decisions to Consider In this Example

Who do you want to make the All users


changes for?  
 

What changes are you going to Hide the Incentive Management tab and the Projects tab from the Worklist: Notications and
make? Approvals page
   

58
Oracle Applications Cloud Chapter 3
Conguring and Extending Applications Page Modication

Before You Start


Activate a sandbox.

Modify Tabs
Do the following:
1. From the Navigator menu, select Tools > Worklist.
2. Click your user image or name in the global header, and select Edit Pages in the Seings and Actions menu.
3. Select Site layer as the context layer, which aects all users.
4. In the View menu at the top of the page, make sure that the Design view is selected, which lets you navigate to
the component you want to modify.
5. Click the Select tab.
6. Hover over any tab on the page, and click when the cursor turns to a magnier and a blue outline appears
around the tab.
7. Select Edit Parent Component.
8. In the Component Properties dialog box, click the Children tab.
9. Deselect Incentive Compensation and Projects to hide these tabs from the page.
10. Click OK.
11. Close Page Composer.

Related Topics
• Overview of Sandboxes
• Create and Activate Unied Sandboxes

Change Page Layout


You can congure a page layout to dene the number, placement, and orientation of content regions on your pages.
Ordinarily, you set the layout style while creating a page. But for some layouts, you can change the layout style even
after adding content to the page.
Note: You can't change the page layout for all pages.

Prerequisites
Activate a sandbox.

Change Page Layout


1. Open the page you want to edit.
2. Click your user name or image and select Edit Pages to open Page Composer.
3. From the View menu, select Design.
4. Click Change Layout.
5. Select the new layout.

Related Topics
• Overview of Sandboxes
• Create and Activate Unied Sandboxes

59
Oracle Applications Cloud Chapter 3
Conguring and Extending Applications Page Modication

Modify Dialog Box Content


Use Page Composer and work in source view to modify the content in your dialog boxes.

Before You Start


Activate a sandbox.

Modify Dialog Boxes


To modify dialog box content:
1. Open the page where the dialog box appears, and then open Page Composer.
2. From the View menu, select Source. You must be in Source view to modify dialog box content.
3. Select the buon that opens the dialog box.
4. Click Edit to open the Component Properties dialog box.
5. Click the Child Components tab.
6. Edit the dialog box content.
7. Click Apply to save your changes, then OK to save your changes and close the Component Properties dialog
box.

Related Topics
• Overview of Sandboxes
• Create and Activate Unied Sandboxes

Make Application Changes Visible Based on User Roles


This example demonstrates how you can make application changes visible to a specic user role.
To control page components conditionally based on user role:
• Create security privileges
• Add an Expression Language expression to the component property that you want to control

The following table summarizes the key decisions for this scenario.

Decisions to Consider In This Example

What's the page object you're Reports link


securing?  
 

To which user role you want to make Hiring managers, Sherry Callaway and Terrance Whitaker
the changes visible?  
  Note: Create a role just for testing application changes. Call it DEVCUST_
TEST_ROLE. When you're sure that the application change works, change the
security to the appropriate role.
 

60
Oracle Applications Cloud Chapter 3
Conguring and Extending Applications Page Modication

Decisions to Consider In This Example

Which expression to add for verifying #{securityContext. userGrantedPermission['MANAGERREPORTS LINK_PRIV']}


whether a user has the appropriate  
privilege?
 

As a prerequisite, activate a sandbox.

Make Application Changes Visible to a User Role


Follow these steps:

1. Create a privilege.
2. Add the 'MANAGER_REPORTS_LINK_PRIV' object to 'DEVCUST_TEST_ROLE'.
3. Assign DEVCUST_TEST_ROLE to Terrance and Sherry.
Note: Make sure that Terrance and Sherry have access to the page before you make any changes.

4. Open the page, having the Reports link that you want to modify, in Page Composer, and select the Reports link
component.
5. Click the Edit icon. This opens the Component Properties dialog box.
6. Click the Display Options tab.
7. Click the Edit icon next to the Show Component property, and select Expression Builder....
8. Add an expression to verify whether the user has the appropriate privilege. Use this sample code:
#{securityContext.userGrantedPermission['MANAGER_REPORTS_LINK_PRIV']}
9. Save the property changes, and close Page Composer.
After you change the show component property, whenever users open this page, the application evaluates
the expression. Since Sherry and Terrance have the privilege, the Show Component property evaluates to be
selected. Hence, Sherry and Terrance can see the Reports link while all other users can't.

Related Topics
• Overview of Sandboxes
• Create and Activate Unied Sandboxes

FAQs for Page Content Conguration


How can I move page components?
To move page components using Page Composer:
• In Design view, drag and drop the component
• In Source view, do any of the following:

◦ Cut and paste the component


◦ Drag and drop the component
◦ Open the Component Properties for the container component and rearrange the components on the
Child Components tab

61
Oracle Applications Cloud Chapter 3
Conguring and Extending Applications Page Modication

How can I delete components from a page?


Click the Delete icon in the component header in Page Composer.
Caution:
• Delete a component only if you're certain that no other components or processes depend on that
component. If you're unsure whether any dependencies exist, then hide the component instead of deleting it.
• If you delete a parent component, you delete all the child components automatically.

What happens if my congurations make the page inaccessible?


If your congurations make a page inaccessible, log a service request using My Oracle Support at hps://
support.oracle.com.

How can I reset a page or task ow to a previously saved version?


To reset a page to a previously saved version or the original ready-to-use state, click Reset Page in Page Composer
(Design or Source view).
To reset a task ow to a previously saved version or the original ready-to-use state, click Reset Task Flow in Page
Composer (Source view only) while you have the task ow open.

Congure the Global Page Template


The global page template provides a common header area and the footer panel for all pages in your application. You
can use Page Composer to congure the global page template. To open the global page template in Page Composer,
click your user image or name in the global header, and select Edit Global Page Template from the Administration
menu.
You can make the following changes to the global page template:
• Add components
• Edit components

Example: Add expression language to hide the tags link


• Delete components

Example: Remove the tags link

Tip: When you move your cursor over the global page template, the areas that you can edit display a blue
outline.

Adding Components to the Global Page Template


To add components to the global page template:
1. Open the global page template in Page Composer.
2. Select the portion of the global header to which you want to add a component, and click Add Content.
3. In the component catalog, select Components to display the list of available components.
4. Click the Add buon associated with the component you want to add.

The component appears in the global header.

62
Oracle Applications Cloud Chapter 3
Conguring and Extending Applications Page Modication

5. Change component properties, as appropriate. For example, if you added the Text component, enter the text
that you want to display.

Note: If you added an HTML markup with references to an external CSS as your component,
ensure that:
◦ The CSS has Access-Control-Allow-Origin header in its server.
◦ Your link tag has crossorigin aribute specied.

6. After completing your changes, click Close. When prompted, click Save to save your changes.

Editing Components in the Global Page Template


To edit components in the global page template:
1. Open the global page template in Page Composer.
2. Select the component that you want to edit.
3. Click Edit.
4. Edit the component properties, and click OK to save your changes.
5. After completing your changes, click Close. When prompted, click Save to save your changes.

Deleting Components from the Global Page Template


To delete components from the global page template:
1. Open the global page template in Page Composer.
2. Select the component that you want to delete.
When you move your cursor over the global page template, the areas that you can edit display a blue outline.
3. Click Delete. When prompted, click Delete to delete the component.
4. After completing your changes, click Close. When prompted, click Save to save your changes.
For information about making skin modications, such as selecting a dierent color palee, see the Oracle Fusion
Applications Extensibility Guide for Developers.

Saved Search Management


Make Saved Searches Available to All Users
Use Page Composer at the site layer to create and edit saved searches, and make them available for all users. Create
and edit saved searches using Page Composer at the site layer. Users can run these saved searches again later to use
the same search criteria and other seings. You must create or edit saved searches only at the site layer to make them
available for all users.

Create and Edit Saved Searches for All Users


Follow these steps:
1. Activate a sandbox.
2. On the search page that has a Save buon, click your user image or name in the global header, and select Edit
<Page Name> Pages in the Seings and Actions menu.

63
Oracle Applications Cloud Chapter 3
Conguring and Extending Applications Page Modication

3. If prompted to select a context layer, select the site layer to open the search page in Page Composer.
4. From the View menu, select Design.
5. Create and edit saved searches.
Note: The steps for creating and editing saved searches are the same regardless of whether you're
working on saved searches for yourself or for all users.
6. Save your changes and close Page Composer.
7. After testing your changes, publish the sandbox to make your changes available to all users.

Related Topics
• Overview of Sandboxes
• Create and Activate Unied Sandboxes
• What gets saved when I create a saved search for searches with multiple criteria

Save Searches with Multiple Criteria


On many pages, you can run a search with multiple search criteria to nd specic business objects. Some of these
searches have a Saved Search list, as well as a Save buon after the search criteria. A saved search captures search
criteria and other seings so that you can easily run the same search again later. Aside from using any predened saved
searches, you can create and edit them for your own use. If you have the appropriate roles, you can also create and edit
saved searches for other users using Page Composer.
The following gure shows an example of a search with multiple search criteria elds and a Save buon. For each eld,
you can select an operator and enter search terms. You can also select from the Saved Search list to use an existing
saved search.

Create Saved Searches


Follow these steps:
1. Go to a search that has a Save buon.
2. Optionally add or reorder elds, if available.
3. Enter your search criteria values, and, click the Save buon.
4. Name your saved search and dene its seings:
◦ Set as Default: The saved search is automatically selected whenever you open this page.
◦ Run Automatically (if available): The saved search runs on this page as soon as you select it from the
list of saved searches.
If you select both options, then the saved search automatically runs whenever you open this page.

64
Oracle Applications Cloud Chapter 3
Conguring and Extending Applications Page Modication

5. Close the dialog box.


Your saved search can be limited to the current page, or in some cases available in other searches for the same object.

Change the Search Criteria in Saved Searches


Follow these steps:
1. Select the saved search if it's not selected already.
2. Set your search criteria, including any additional elds.
3. Click the Save buon.
4. If the saved search is one that you created, save without changing the name.
If it's predened, then you can't overwrite it, so you create a new saved search with a unique name.

Change Seings or Rename and Delete Saved Searches


Follow these steps:
1. Go to a search that has a Save buon.
2. Select Personalize from the Saved Search list.
3. In the Personalize Saved Searches dialog box, select a saved search.
4. Change any of the seings, where available.
◦ Set as Default: The saved search is automatically selected whenever you open this page.
◦ Run Automatically: The saved search runs on this page as soon as you select it from the list of saved
searches.
◦ Show in Search List: The saved search is available for you to select and run on this page.
• You can still nd hidden saved searches in the Personalize Saved Searches dialog box.
• You can't change this seing if the saved search is currently selected on your page.
Note: Some seings can't be changed for predened saved searches. What you do change applies
only to you, unless you're editing the saved search within Page Composer.
5. If you selected a saved search that you created, then you can rename or delete it. You can't do so for predened
saved searches.
6. Save your changes and close the dialog box.

Related Topics
• Create Watchlist Items
• What gets saved when I create a saved search for searches with multiple criteria

Save Keyword Searches with Filters


One type of search you might nd on the page is a keyword search with lters. Some of these searches have predened
saved searches, and you can also create and edit saved searches for your own use. A saved search captures entered
search terms, lters, and other seings so that you can easily run the same search again later. If you have the
appropriate roles, you can also create and edit saved searches for other users using Page Composer.

Create and Edit Saved Searches


Follow these steps:
1. Enter search terms in the search eld, and click Search, or select a saved search in the autosuggest.

65
Oracle Applications Cloud Chapter 3
Conguring and Extending Applications Page Modication

2. Click the Show Filters link if lters are currently hidden.


3. Optionally organize lters as follows, depending on what's available to you:

◦ Use the Add or Reorder buons.


◦ Click the Personalize icon to show, hide, or reorder lters, and click OK.
4. Set lter values or select lters, and click the Save buon.
5. Name your saved search.

◦ To create a saved search, enter a new, unique name.


◦ To update an existing saved search that you created, save with the original name.

You can't overwrite predened saved searches by using their names, but you can create a copy with a unique
name.
6. Click Set as Default if you want the saved search to be automatically selected whenever you open this page.
7. Click OK.
Your saved search can be limited to the current page, or in some cases available in other searches for the same object.

Change Seings or Rename and Delete Saved Searches


Follow these steps:
1. Click the Show Filters link if lters are currently hidden.
2. Select Manage from the Saved Search list.
3. Dene seings for any saved search, predened or user-dened, in the Manage Saved Searches dialog box:

◦ Default: The saved search is automatically selected whenever you open this page.
◦ Show in Saved Search List: The saved search is available for you to select and run on this page. You can
still nd hidden saved searches in the Manage Saved Searches dialog box.
Note: Changes you make to predened saved searches apply only to you, unless you're editing the
saved search within Page Composer.
4. The Active seing identies the saved search that's currently selected on the page. You can designate a
dierent active saved search to have that saved search automatically selected as soon as you click OK in this
dialog box.
5. For user-dened saved searches only, you can also rename or delete the saved search.
6. Click OK.

Related Topics
• Use Filters with Keyword Searches

Infolet Management
Overview of Conguring Infolets
Watch video

66
Oracle Applications Cloud Chapter 3
Conguring and Extending Applications Page Modication

You can congure infolets that aggregate key information for a specic area, for example, social networking or personal
prole. Your users use the page control icons on the home page with the panel or banner layout to open the infolets. Or,
if it's a home page with news feed layout, they use the infolets tabs in the Analytics section.

If your users don't nd infolet icons on the home page, you can enable them by clicking the Home Conguration tab in
the Structure work area. Let's look at some tasks you can do to congure infolets.
• Create infolets.
• Add content to infolets. For example, you can add a task ow or a performance tile report, and if an infolet
contains a performance tile report, then you can add a link to a detailed report in the same infolet.
Note: In the context of infolets, report can mean analysis.

• Edit infolets. For example, edit infolet content and add, change, or remove link to detailed report.
• Delete infolets.

Related Topics
• Personalize Infolets
• Congure Home Page Navigation

Create Infolets
Use infolet pages to create infolets. For some product-specic infolet pages, you can't create infolets.
1. Activate a sandbox.
2. Open an infolet page.
3. Click your user image or name in the global header, and on the Seings and Actions menu, select Edit Pages.
4. Select a context layer. The infolet page opens in Page Composer.
5. Click the Infolet Repository icon, and select Create Infolet.

Note: If you can't nd the Create Infolet menu item, it means you can't create infolets for
this page.
6. Enter a title for the infolet and set its views.
◦ Specify the dimensions for the front view.
◦ Enable or disable the back view.
◦ Enable or disable the expanded view, and specify its dimensions. The dimensions of the front and the
back views must be the same, but the expanded view must be bigger because it displays more details.
7. Click Save and Close.
8. Add content to the infolet views and link a detailed report to the infolet.
9. Preview the infolet's front view, drill down to the detailed report, and then preview the back and the expanded
views.
10. After you made changes, click Close to leave Page Composer.
11. Test your changes and publish the sandbox to make the new infolet available to your users.

Related Topics
• Overview of Sandboxes
• Create and Activate Unied Sandboxes

67
Oracle Applications Cloud Chapter 3
Conguring and Extending Applications Page Modication

Manage Infolets
On the infolet page, use the options available on each infolet to manage it. You can add and edit infolet content and
delete infolets. You can't add a business intelligence dashboard to an infolet because a dashboard report is generally
bigger than an infolet.

Before You Start


You must open the infolet page in Page Composer.
1. Activate a sandbox.
2. Open an infolet page.
3. Click your user image or name in the global header, and on the Seings and Actions menu, select Edit Pages.
4. Select a context layer. The infolet page opens in Page Composer.
Note: After you're done making changes, click Close to leave Page Composer, test your changes, and publish
the sandbox.

Add Content to Infolets


You can add content to the infolet's front, back, or expanded view.
1. Select the infolet's view that you want to add content to.

Note: To open infolet's back view, click the Back View icon on the boom right corner of the
infolet. And to open expanded view, click the Expanded View icon on the boom right corner of the
infolet's back view.

2. Click Add Content on the infolet. You can nd this buon on any of the infolet's views, but only if you don't
have any existing content in that view.
3. Search and select a performance tile or a task ow, and click Add. You can browse the business intelligence (BI)
catalog to nd the analytics and reports that you want to add.
4. Close the Add Content dialog box.

Edit Infolet Content


1. Click the Actions icon on the top right corner of the infolet, and select Edit Content.

Note: To edit the infolet content of the back or expanded view, open the view and use the Actions
icon on that view.

2. Click Add Content to replace the existing content of the infolet.


3. Search and select a performance tile or a task ow, and click Add. You can browse the business intelligence (BI)
catalog to nd the analytics and reports that you want to add.
4. Close the Add Content dialog box.

Edit Title and Views


To edit title and views of an infolet, click the Actions icon on the top right corner of the infolet, and select Edit Title and
Views.

68
Oracle Applications Cloud Chapter 3
Conguring and Extending Applications Page Modication

Link Detailed Reports to Infolets


To provide detailed information about a subject maer on an infolet, you can add a link to a detailed report. After you
add the link, your users can click anywhere in the infolet area to drill down to that detailed report. The detailed report
doesn't replace the existing infolet content.

Add Links to Detailed Reports


First, add a performance tile report to the infolet content, and then follow these steps:

1. Click the Actions icon on the top right corner of the infolet, and select Link Detailed Report.
2. On the Detailed Report page, click Add Content.
3. Search and select a report, and click Add to add it to the infolet.
4. Close the Add Content dialog box.
5. Click Done.

Edit or Remove Detailed Report


1. Click the Actions icon on the top right corner of the infolet, and select Edit Detailed Report.
2. On the Detailed Report page, you can edit or remove the detailed report.

◦ To edit, click Edit Report and make changes to the detailed report.
◦ To remove, click Remove Report.
3. Click Done.

Delete Infolets
To delete an infolet, click the Actions icon on the top right corner of the infolet, and select Delete.
Caution: You can't easily retrieve an infolet once you delete it. But if you have accidentally deleted any infolet,
don't worry. Contact My Oracle Support at hps://support.oracle.com.

Edit Infolet Visibility


You can show or hide an infolet on the infolet page. To edit the visibility seings of an infolet, follow these steps:
1. Click the Actions icon on the top right corner of the infolet, and select Edit Visibility.
2. Select one of these options:

◦ Yes: The infolet appears on the infolet page.


◦ No: The infolet doesn't appear on the infolet page.
◦ EL expression: The evaluation of the EL expression decides whether the infolet appears on the infolet
page.

Related Topics
• Personalize Infolets
• Overview of Sandboxes
• Create and Activate Unied Sandboxes

69
Oracle Applications Cloud Chapter 3
Conguring and Extending Applications Page Modication

FAQs for Infolet Management


Why is the icon for my infolet page not available in the page control on the home
page?
The icon for your infolet page may be hidden. Change the visibility seing of the icon using the Home Conguration
page of the Structure work area. To open this page, select Conguration > Structure from the Navigator menu, and
then click the Home Conguration tab.

Related Topics
• Congure Home Page Navigation

How can I rename an icon for an infolet page in the page control on the home page?
You can rename an icon for an infolet page using the Home Conguration page of the Structure work area. To open this
page, select Conguration > Structure from the Navigator menu, and then click the Home Conguration tab.

Related Topics
• Congure Home Page Navigation

What's the dierence between a performance tile report and a detailed report added
to the infolets content?
Performance tile report shows data in the small infolet format. When you add a performance tile report to an infolet,
users can see only the summary information about the subject maer. But this report doesn't provide detailed
information.
To provide detailed information about the subject maer on the same infolet, add a link to a detailed report. Users can
click this link to gather more information.

Congure Infotiles on a Page


You can use Page Composer to decide how your infotiles appear on your page. You can show, hide, or reorder them any
way you like.
1. Activate a sandbox.
2. Go to the page with your infotiles.
3. Click your user image or name in the global header, and select Edit Pages.
4. Click the Congure Layout icon.
5. Make changes to your page.
◦ Select the infotiles you want to show on your page, and deselect the ones you want to hide.
◦ Hover over the infotile you want to reorder, and click Move Up or Move Down.
6. Click OK.
7. Click Close.
8. Test your changes and publish your sandbox.

Related Topics
• Overview of Sandboxes

70
Oracle Applications Cloud Chapter 3
Conguring and Extending Applications Page Modication

• Publish Unied Sandboxes

New Page Creation


Create Pages for Hosting Third Party Applications
Use the Page Integration pages to create pages for hosting third party applications to address needs specic to your
organization. All these new pages are grouped in a single group on the Navigator menu and springboard.

Prerequisites
Activate a sandbox.

Creating the First Page


Follow these steps:

1. From the Navigator menu, select Conguration > Page Integration.


2. Click New Page.
3. On the Create Page page, enter a page name.
4. In the Category Name eld, enter a name for the group to place your page in.

Note: You can move your new pages to other groups later using the Structure page.

5. Search and select an icon for the page.


6. From the list of application roles, select the role to whom you want to grant access to the page. This list
contains only custom roles because you can't modify predened roles.
7. In the Web Page eld:

◦ Enter the application URL that you want to host on this page.
◦ Alternatively, you can create a secure web page URL:

i. Click the Create Secure Web Page URL icon.


ii. Select the name of the web application.
iii. Enter the destination for the web application.
iv. Enter a secure token name.
v. Save and close the Create Secure Web Page URL dialog box.

In a secure web page, the application validates the secure token and uses it to authenticate web services
within the end-user context. Using this mode of modied access, a partner can directly perform an action
or display information to the specic user without any additional authentication.
8. Click Save and Close.

New pages are secure. Your security administrator must assign the privileges shown on the Page Integration
Overview page to users such that they can access these pages.
If you have only one page in a group, then that page icon appears at the top level (not in any group) on the springboard.
However, such page icons appear in their respective categories on the Navigator menu.

71
Oracle Applications Cloud Chapter 3
Conguring and Extending Applications Page Modication

Creating Subsequent Pages


After creating the rst page, follow these steps to create more pages:
1. On the Page Integration Wizard: New Pages page, click New Page.
2. Enter a page name.
3. Follow steps 5 to 7 in the procedure for creating the rst page.
4. Click Save and Close.
After you have created the rst page, all subsequent pages are added in the same group as that of the rst page, by
default.

Related Topics
• Overview of Sandboxes
• Edit and Reorder Groups and Page Entries for Navigation
• Create and Activate Unied Sandboxes

Manage Pages Hosting Third Party Applications


After creating pages for hosting third party applications, manage them using the options available on the Page
Integration Wizard: New Pages page and the Page Integration Wizard: Existing Pages page.
You can do the following actions:
• Edit page seings.
• Add tabs to new and existing pages.
• Edit page tabs.
• Rename Categories.
• Navigate to pages.

Prerequisites
Activate a sandbox.

Editing Page Seings


Follow these steps:
1. On the Page Integration Wizard: New Pages page, click the name link for the page that you want to edit.
2. On the Edit Page page, make the required changes.
3. Click Save and Close.
You can make the following changes to a page:
• Change the icon for the page.
• Change the web page URL that you want to host on this page.
• Add tabs to the page.
• Delete the page.
Note: If a page has additional tabs, apart from the one created by default with the page, then you
can delete the page only after deleting its tabs.

72
Oracle Applications Cloud Chapter 3
Conguring and Extending Applications Page Modication

• Edit the page tabs.

Adding Tabs to New and Existing Pages


When you create a page, a page tab is created by default. You can then add more tabs to your new and existing pages,
as required.

To add tabs to new pages, follow these steps:

1. On the Page Integration Wizard: New Pages page, click the name link for the page containing the tab that you
want to edit.
2. On the Edit Page page, click Add Tab.
3. On the Create Tab page, enter a tab name.
4. Search and select an icon for the page.
5. From the list of application roles, select the role to whom you want to grant access to the page. This list
contains only custom roles because you can't modify predened roles.
6. In the Web Page eld:

◦ Enter the application URL that you want to host on this page.
◦ Alternatively, you can create a secure web page URL:

i. Click the Create Secure Web Page URL icon.


ii. Select the name of the web application.
iii. Enter the destination for the web application.
iv. Enter a secure token name.
v. Save and close the Create Secure Web Page URL dialog box.
7. Click Save and Close.
To add tabs to existing pages, follow these steps:

1. Click the Page Integration Wizard: Existing Pages icon on the left region of the Page Integration Wizard: New
Pages page.
2. Click Add Tab to Existing Page.
3. In the Select Page dialog box, select a page to add a new tab to.
4. Follow steps 2 to 7 in the procedure for adding tabs to new pages.

Editing Page Tabs


To edit page tabs, follow these steps:

1. On the Page Integration Wizard: New Pages page, click the name link for the page containing the tab that you
want to edit.
2. On the Edit Page page, click the name link for the page tab that you want to edit.
3. On the Edit Tab page, make the required changes.
4. Click Save and Close.
You can make the following changes to a page tab:

• Change the icon for the page.


• Change the web page URL that you want to host on this page tab.
• Delete the page tab.

73
Oracle Applications Cloud Chapter 3
Conguring and Extending Applications Page Modication

Renaming Categories
All pages that you create using the Page Integration Wizard: New Pages page are grouped in a single category. To
rename the category for all pages, click Rename Category on the Page Integration Wizard: New Pages page.

Navigating to Pages
On the Page Integration Wizard: New Pages page, click the icon for the page that you want to navigate to, and view its
content.

Related Topics
• Overview of Sandboxes
• Congure Links for Page Entries

74
Oracle Applications Cloud Chapter 4
Conguring and Extending Applications User Interface Text Modication

4 User Interface Text Modication

Considerations for Selecting a Tool to Change Text


You can modify and replace words or phrases that appear on pages, in messages, and other areas of the UI using
several tools or tasks.
Following are the tools for making text changes:

• Application Composer
• User Interface Text
• Page Composer

Multiple factors inuence the option you select. For example:

• The oering you use


• The extent and scope of your changes
• The components that you modify

This table presents the navigation and oering availability options associated with the tools you can use to modify user
interface text.

Tool or Task Navigation Oering Availability

Application Composer Oracle Engagement Cloud


  In the Navigator, select Conguration >  
Application Composer.

User Interface Text All applications


  In the Navigator, select Conguration >  
User Interface Text.

Page Composer All applications


  Click your user image or name in the  
global header, and select Edit <Page
Name> Pages in the Seings and Actions
menu.

If the Edit <Page Name> Pages option


isn't available in the Seings and Actions
menu, then select Edit Pages instead.

Text Modication Scenarios


The following table includes possible scenarios for modifying user interface text. Compare your situation to the scenario
in the table to determine the most appropriate tool for modifying text in your application.

75
Oracle Applications Cloud Chapter 4
Conguring and Extending Applications User Interface Text Modication

Task Scope Tool or Task Example

Simultaneously replace Comprehensive. User Interface Text Change the word "Employee"
multiple occurrences of a     to "Associate" on every page
word or phrase that appear The changes aects multiple associated with Employee Self
on multiple pages in multiple pages throughout your Service, Benets, and Payroll.
contexts application. You can edit the  
  embedded help (for example,
hints) using this method.
 

Simultaneously replace Comprehensive. User Interface Text Change the word "Employee"
multiple occurrences of a word     to "Associate" in every
or phrase that appear in parts The change aects multiple message associated with
of messages in the message messages throughout your Employee Self Service,
dictionary application. Benets, and Payroll.
     

Simultaneously replace Comprehensive. User Interface Text Change the word "Employee"
multiple occurrences of the     to "Associate" and
singular and plural forms of a The change aects multiple "Employees" to "Associates".
word or phrase that appear in pages and multiple messages  
messages and on pages throughout your application.
   

Replace a word or phrase that Targeted: A page Page Composer Change the word "Customer"
appears on a specic page     to "Account" on two specic
  The change aects user pages.
interface text on a specic  
page or page fragment.
 

Replace a word or phrase that Targeted: A message Manage Messages task Change the word "Recruit" to
appears in a specic message     "Potential Employee", but only
in the message dictionary The change aects part of in two specic messages. All
  a specic message in the other messages continue to
message dictionary. use the word "Recruit".
   

Simultaneously replace a word Targeted: A business object User Interface Text Change the label of the
or phrase associated with a     opportunity business object,
specic object wherever the The change aects a specic from "Opportunity" to "Deal".
object appears component of a specic You want the change to aect
  message in the message the business object wherever
dictionary. it appears.
   

Replace words or phrases that Targeted: Navigator menu User Interface Text Change the menu
appear in menus and menu item text   item label from "Total
items   Compensation Statements"
  to "Compensation Package
Statements".
 

Regardless of the tool you use to make changes, all application changes are wrien in a single override bundle. Hence,
the latest application changes overwrites the previous ones.

76
Oracle Applications Cloud Chapter 4
Conguring and Extending Applications User Interface Text Modication

Note: If you replace text using plain text as the input value, it supersedes any changes that use the override
bundle. For example, if you enter a direct string in Page Composer, then Page Composer writes these changes
in a le (not string resource) containing page modications. Hence, such changes overwrite the changes in the
override bundle.

Related Topics
• Guidelines for Page Modication
• Tools for Congurations and Extensions

Overview of User Interface Text Tool


You can use the User Interface Text tool to modify text in these application components:
• User Interface
• Messages
• Global Menu Label
• Enterprise Scheduler

You can use this tool to modify or translate your text. You can also export your strings to make your changes oine, if
you opt in for User Interface Text Update.

User Interface Text Update


With the User Interface Text Update opt in, you get greater control of your text, and how it's edited.

Here are some things you can do:


• Export and import your text for oine translation and modication.
• Select and replace your text more easily.
• Edit your text in an improved UI.

How to Opt In
In the Oerings work area, enable the User Interface Text Update feature:
• Oering: Any with the Application Extensions functional area
• Functional Area: Application Extensions
• Feature: User Interface Text Update
• Opt In Task: Click Continue if you're sure about enabling this feature.

Note: If you want to disable this feature, you can opt out by repeating this same ow.

Related Topics
• Congure Oerings

77
Oracle Applications Cloud Chapter 4
Conguring and Extending Applications User Interface Text Modication

Bulk Text Modication


Use the User Interface Text tool to simultaneously update multiple occurrences of entire words or phrases in the user
interface (UI).
You can use this tool to do the following activities for bulk text modication:
• Sandbox integration
• Case-sensitive and whole word searches
• Singular and plural text replacement
• Contextual previews

Note: You must activate a sandbox to use the User Interface Text tool.

To use the User Interface Text tool, on the Navigator, select Conguration > User Interface Text. Then, click Search
and Replace to search and replace texts in bulk. The User Interface Text tool searches text on pages and in messages in
the message dictionary. The search includes user assistance only if the user assistance text is in the message dictionary.
The modication functionality for this tool doesn't extend to text in service oriented architecture (SOA) processes.

In the User Interface Text tool, you can:


• Search and replace
• Preview and adjust
• Save and publish

Search and Replace


After you activate a sandbox and click Search and Replace, enter the search text and the replacement text. You can
enter the singular and plural forms of whole words or phrases. You can also use the following check boxes:
• Match Case - To perform case-sensitive searches.
• Match Complete Word or Phrase - To search for an exact match of your search text value.

Note: You can't perform partial word searches, nor can you use wildcard characters as part of the search text.

The following table lists the sample values that you can use as a guide while entering search text.

Search Text Expected Match Match? Reason

Flex ex Yes


      The application searches
Flex for any occurrence of your
  search string without regard
to its position in the strings it
searches.

Unless you select Match Case,


all matches are considered
exact.

78
Oracle Applications Cloud Chapter 4
Conguring and Extending Applications User Interface Text Modication

Search Text Expected Match Match? Reason

ex exelds No The application treats your


      search text value as a whole
Flexelds word. The text ex isn't the
  same as the text exelds.
A exeld is a...  
 
A Flexeld is a...
 

^Flex$ exelds No
      Use ^string$ in the search
Flexelds eld to say this string must
  match the complete eld.
A exeld is a...
  The application treats your
A Flexeld is a... search text value as the entire
  value of the strings it searches.

Alternatively, select Match


Complete Word or Phrase to
search for an exact match of
your search text value.

^Flex$ ex Yes


      Use ^string$ in the search
Flex eld to say this string must
  match the complete eld.

The application treats your


search text value as the entire
value of the strings it searches.

Unless you select Match Case,


both matches are considered
exact.

Use just ^string in the


search eld to say this phrase
must appear at the beginning
of a eld.

ex credits Flex Credits Conguration Yes


      The application searches
Allow rollover of ex credits for the exact spelling and
  sequence of words without
Flex Credits regard to their position in the
  strings it searches.
Manage Flex Credits
Conguration Unless you select Match Case,
  all matches are considered
exact.

ex credits ex credit shell plan No The application searches


      for the exact spelling and
Allow rollover of ex credit sequence of words without
for... regard to their position in the
  strings it searches.

79
Oracle Applications Cloud Chapter 4
Conguring and Extending Applications User Interface Text Modication

Search Text Expected Match Match? Reason

credits conguration$ Flex Credits Conguration Yes


      Use string$ in the search
Manage Flex Credits eld to say this phrase must
Conguration appear at the end of a eld.
 
The application searches
for the exact spelling and
sequence of words, where the
words appear at the end of the
strings it searches.

Unless you select Match Case,


both matches are considered
exact.

Include one or more of the following match categories in your search:


• User Interface Text
• Enterprise Scheduler Text
• Global Menu Label Text
• Multipart Validation Message

After you enter the search text and replacement text, click Preview Changes. The tool looks for exact whole word
matches.

Preview and Adjust


The preview sorts the search results and presents the matches on tabs based on match categories. Data grids on each
tab present the matches in rows. You can adjust each row independently. The grids on each tab are similar, but not
identical.

Caution: Some tab names on the Preview Text Changes page are followed by an asterisk (*) (for example,
the Messages tab). For these tabs, once you save the text changes, these changes are applied to the mainline
metadata. You can't undo your changes after you preview and save them, even though you're currently in a
sandbox. The changes will still remain even if you delete the sandbox.

Each row on all tabs includes:


• A view of the existing text and the immediately surrounding text for context. You can't edit the existing view.
• A preview of the replacement text and the immediately surrounding text for context. You can edit the preview.
• An option to exclude the row and the specic match you see in the row from the change.

Each row on the Messages tab includes an indicator. This indicator identies when the search text appears in a
message subcomponent, not necessarily in the message body displayed in the row. You can expand the row and
view subordinate rows that display the message subcomponent containing the match and the preview, in context as
previously described.

For each row in the preview, you can:


• Do nothing to accept the change as you see it.

80
Oracle Applications Cloud Chapter 4
Conguring and Extending Applications User Interface Text Modication

• Select Exclude to eliminate the row from the batch update and maintain the existing text.
• Modify the replacement text to ne-tune the change for the specic match in the row. The row remains part of
the batch update, even if the actual update diers from the other rows.

In the Global Menu Label Text tab, you can't update a secure JSON Web Token (JWT).

If you have multiple languages in your application and you want to make similar text changes in those languages:
1. Change your language preference
2. Search and replace text
3. Validate your changes

Save and Publish


After you review and adjust the matches:
1. Save your changes.
2. Thoroughly test the pages to make sure that every occurrence of the text is replaced, as you wanted.
3. Publish the sandbox.
Note the following points:
• Don't publish a sandbox before you visually inspect and validate all pages and messages that contain text that
you updated.
• Users can view:
◦ Message and enterprise scheduler text modications when you save them, even if you don't publish the
sandbox.
◦ Page text modications when you publish the sandbox.

Related Topics
• Overview of Sandboxes
• Create and Activate Unied Sandboxes

Modify Text with User Interface Text Update


You can use the User Interface Text Update feature to modify or translate multiple strings together.

Before You Start


• Create and activate a sandbox.
• Opt in for the User Interface Text Update feature.

Modify Text
1. On the Navigator, select Conguration > User Interface Text.
2. In the Find eld, enter the word or phrase you want to search for.
3. In the Replace eld, enter your replacement word or phrase.

81
Oracle Applications Cloud Chapter 4
Conguring and Extending Applications User Interface Text Modication

4. You can specify additional search parameters such as Match Case or Match Complete Word or Phrase.
5. Select the language in which you want to modify your text.
6. Select the application components you want to modify your text for.
7. Click Search. The search results are grouped into dierent tabs based on the application components you
select.

Caution: Tabs marked with an asterisk (*) have live changes that are saved directly to the
mainline metadata. You can't undo these changes once you save them. Make sure you review
changes carefully before replacing your strings.
8. Preview and adjust changes in your search results.
Here are a few things you can do:
◦ Exclude specic strings you don't want to change by selecting Exclude for those particular rows.
For results in the User Interface Text component, you can select options in the Exclude menu for
advanced string selection. Your options are:
• None: Don't exclude any result.
• All: Exclude all results.
• None (Page): Don't exclude any result on the page.
• All (Page): Exclude all results on the page.
You can also choose how many results you want to display on a page for this component.
◦ Manually tune your replacement text for specic strings.
For instance, let's say you have a string that says "Generate a bill". If you replace "bill" with "invoice",
this string becomes "Generate a invoice", which is incorrect. You can tune your replacement text for this
string to say "Generate an invoice" by manually editing the text in the replacement text box.
◦ For the User Interface Text component, you can click Export All to export your search results to view in
a .csv le.
◦ Query your search results in the User Interface Text component to nd specic strings.
9. Click Replace Strings. If you have live changes in your results, you will get a warning message. Click Yes if you
have reviewed these changes carefully and want to proceed.
10. Test your changes in the sandbox.
11. Publish your changes to merge them with the mainline metadata.

Related Topics
• Overview of Sandboxes
• Create and Activate Unied Sandboxes
• Publish Unied Sandboxes

Overview of Translating Modied Text


If you install and use multiple languages in your application and you modify text, then enter translations of the modied
text for all languages. You can enter translations for existing and newly added strings manually. You can also translate
your strings oine. But you need to opt in for the User Interface Text Update feature for oine translation.

82
Oracle Applications Cloud Chapter 4
Conguring and Extending Applications User Interface Text Modication

You can use several conguration tools to update or add strings. For example, you can use lookups to add translations,
or you can use the User Interface Text tool to update all strings and enter their translations.

Related Topics
• Translation of Flexeld and Value Set Congurations

Translate Existing Strings at Runtime


This example demonstrates how to translate existing strings manually at runtime.
The following table summarizes the key decisions for this scenario.

Decisions to Consider In this Example

What's the sandbox name that you Sandbox1


want to use for translating existing  
strings?
 

What's your base language? English


   

What's the existing text that you want Page


to modify?  
 

What's the replacement text that you Work area


want to replace the existing text with?  
 

Enter Text Translations for Existing Strings


1. Create and activate Sandbox1.
2. On the Navigator, select Conguration > User Interface Text.
3. Click Search and Replace.
4. In the Search For eld, enter the text, "page".
5. In the Replace With eld, enter the text, "work area".
6. Click Preview Changes to preview and adjust the matches, as necessary.

Caution: Some tab names on the Preview Text Changes page are followed by an asterisk
(*) (for example, the Messages tab). For these tabs, once you save the preview text changes,
these changes are applied to the mainline metadata. You can't undo your changes after you
preview and save them, even though you're currently in a sandbox. The changes still remain,
even if you delete the sandbox.
7. Save your text changes.

Note: Repeat steps 4 to 7 for any text changes required in other installed languages.

83
Oracle Applications Cloud Chapter 4
Conguring and Extending Applications User Interface Text Modication

8. Test and verify all messages and pages aected by the text changes. Be sure to test across all applications.
9. Publish Sandbox1.
Your replacement text for the existing string is now available to all users.

Related Topics
• Create and Activate Unied Sandboxes

Translate New Strings Added Using Conguration Tools


This example demonstrates how to translate new strings that were added using conguration tools. While creating
strings using conguration tools, such as the Structure page, always use the same language, that is, your base
language.
The following table summarizes key decisions for this scenario.

Decisions to Consider In this Example

What's the sandbox name that you Sandbox2


want to use for translating newly  
added strings?
 

What's the language you want to French


translate your newly added English  
string to?
 

What's the newly created English text Computer


that you want to translate in French?  
 

What's the French replacement text Ordinateur


that you want to replace the newly  
created English text with?
 

Entering Text Translations for Newly Added Strings


1. Create and activate Sandbox2.
2. From the Navigator menu, select Conguration > User Interface Text.
3. Select French as the language you want to translate your new English string to.
4. In the Search For eld, enter the newly created English string "computer". You must search in English because
the French equivalent has not yet been created.
5. Enter the French string "ordinateur" as the replacement text.
6. Click Preview Changes to preview and adjust the matches, as necessary.

84
Oracle Applications Cloud Chapter 4
Conguring and Extending Applications User Interface Text Modication

Caution: Some tab names on the Preview Text Changes page are followed by an asterisk
(*) (for example, the Messages tab). For these tabs, once you save the preview text changes,
these changes are applied to the mainline metadata. You can't undo your changes after you
preview and save them, even though you're currently in a sandbox. The changes still remain,
even if you delete the sandbox.
7. Save your text changes.
8. Test and verify all messages and pages aected by the text changes. While testing, you must sign in with
French as the language and use sandbox2.

Note: Repeat steps 3 to 8 for every active language.

9. Publish Sandbox2.
Your replacement text for the newly added string is now available to all users.

Related Topics
• Create and Activate Unied Sandboxes

Translate Strings Oine


You can translate your modied strings oine if you opt in for the User Interface Text Update feature. To translate your
strings oine, export them, add the necessary translations, and then import them back into the application.
Note: You can export only modied strings.

Before you export your strings for translation, make sure you meet these conditions:
• Create and activate a sandbox.
• Opt in for the User Interface Text Update feature.

Export Strings
1. Click Navigator > Conguration > User Interface Text.
2. Click the Export tab.
3. Select the source language for the text you want to export for translation.
4. Click Export, and download the le with all the modied strings that have been published as well as those that
are in the current sandbox.

Translate Strings
1. Extract the .zip le you downloaded, and open the .xlf le inside it using a text editor of your choice.
2. Locate the strings you want to edit. You can nd these strings inside <source> and </source>.
3. Replace the <target/> tag following the </source> tag with the translation you need. The translated string
should be inside <target> and </target>.
Let's look at an example of an English to Spanish translation.

85
Oracle Applications Cloud Chapter 4
Conguring and Extending Applications User Interface Text Modication

<source>All Receipts</Source>
<target>Todos los Recibos</target>

4. Save the le when you're done.


5. Compress the translated .xlf le into a .zip le.

Import Translated Strings


1. Click Navigator > Conguration > User Interface Text.
2. Click the Import tab.
3. Select the target language you want to import the translated strings to.
4. Click Browse, and select the .zip le you want to import.
5. Click Import.
Note: After importing your strings, test your text changes inside the sandbox. Publish the sandbox to apply
your changes to the application.

Related Topics
• Create and Activate Unied Sandboxes
• Congure Oerings

Translate New Strings Oine From English to German


In this example, you translate new strings that were added using conguration tools, from English to German.
Remember, while creating strings using conguration tools, such as Page Composer, always use the same language,
that is, your base language.
The following table summarizes key decisions for this scenario.

Decisions to Consider In this Example

What's the sandbox name that you Sandbox3


want to use for translating newly  
added strings?
 

What's your base language? English


   

What's the language you want to German


translate your newly added English  
string to?
 

What's the newly created English text Network


that you want to translate in German?  
 

What's the German replacement text Netzwerk


that you want to replace the newly  
created English text with?

86
Oracle Applications Cloud Chapter 4
Conguring and Extending Applications User Interface Text Modication

Decisions to Consider In this Example

Before you export your strings for translation, make sure you meet these conditions:
• Install both English and German languages in your application.
• Create and activate Sandbox3.
• Opt in for the User Interface Text Update feature.

Export Strings
1. Click Navigator > Conguration > User Interface Text
2. Click the Export tab.
3. Select American English as the source language for the text you want to export for translation.
4. Click Export.

Translate Strings
1. Extract the .zip le you downloaded. The .zip le name includes "en", which is the code for English Language.
2. Rename the .zip le to change the code from "en" to "de", which is the code for German language.
3. Open the .xlf le inside the .zip le using a text editor of your choice.
4. Locate the strings you want to edit. You can nd these strings inside <source> and </source>.
5. Replace the <target/> tag following the </source> tag with the translation you need. The translated string
should be inside <target> and </target>.

Here is how it should look:

<source>Network</Source>
<target>Netzwerk</target>

6. Save the le when you're done.


7. Compress the translated .xlf le into a .zip le.

Import Translated Strings


1. Click Navigator > Conguration > User Interface Text.
2. Click the Import tab.
3. Select German as the target language you want to import the translated strings to.
4. Click Browse, and select the .zip le you want to import.
5. Click Import.

Note: After importing your strings, test your text changes in Sandbox3. Publish Sandbox3 to
apply your changes to the application.

87
Oracle Applications Cloud Chapter 4
Conguring and Extending Applications User Interface Text Modication

Related Topics
• Create and Activate Unied Sandboxes
• Congure Oerings

FAQs for User Interface Text Modication


Can I undo text changes that I made using the User Interface Text
tool if I haven't published the sandbox?
It depends on types of text changes in the sandbox. You can undo all text changes done in the user interface and global
menu label by deleting the sandbox before publishing it. However, you can't undo the text changes done in messages,
analyses and reports, and scheduled processes.

Can I get a report of all modied text if I want to analyze,


troubleshoot, and diagnose the cause of unexpected action?
No, but you can use Conguration Setup Manager to export all your congurations to a .zip le. You can nd the text
changes in les ending in ".xlf.xml". These les list all text changes done in your application using browser-based tools,
such as Application Composer, Page Composer, and User Interface Text. You can use the contents of these les for
diagnosis and troubleshooting purposes. These les are read-only, so you can't edit their contents.

Why didn't text in my BI reports and SOA processes change when


I used the User Interface Text tool to perform comprehensive text
updates?
The bulk updates that you do using the User Interface Text tool aect only the text that appears on Application pages,
in message diction messages, in Global Menu Label, and in Enterprise Scheduler.

Why can't I see some of my previous changes in the History tab of


User Interface Text Update?
The History tab only shows the changes you made in your current sandbox. Previous changes which were made in or
published from a dierent sandbox aren't recorded in the history for the current sandbox.

88
Oracle Applications Cloud Chapter 5
Conguring and Extending Applications Theme Management

5 Theme Management

Overview of Conguring Themes and Home Page


Seings
Use the Appearance work area to congure the general look and feel of your application, and the default layout and
display seings of the home page. To open this work area, on the Navigator, select Conguration > Appearance. The
Appearance work area has 2 tabs: Themes and Home Page Layout. Use the Themes page to congure the default home
page layout, and to change the branding logo, background colors, icon styles, and so on. You can apply an existing
theme to your application pages, or create your own theme and apply it. Use the Home Page Layout page to congure
the display seings of the home page.

Themes and Default Home Page Layout


Use the Themes page of the Appearance work area to:

• Set the default home page layout as Panel, Banner, or News Feed. The home page with the:

◦ Panel or banner layout contains a springboard with icons that you can use to open work areas.
Also, based on setup, the home page shows either company announcements or social networking
conversations. This information appears in a panel for the panel layout, and in a banner for the banner
layout.
◦ News feed layout mainly contains the Apps section and a series of updates with important information.

• Create and edit saved themes, which means themes that aren't predened. For example, you can change the
following look and feel aspects of your application pages:

◦ Logo
◦ Background image
◦ Panel image and style
◦ Size and style of the icons on the springboard
◦ Style of the cards, which appear on a page in a grid view. These cards display a summary of a single
record, with aributes on the front side and optional back side. You can specify whether all cards should
display with a dark-colored or a light-colored nish for users.
◦ Shape of buons, menus, and tabs
◦ Colors for the background, global region, headings, page links, and buons

Tip: While making changes on the Themes page, you can click Apply any time to preview your changes.

89
Oracle Applications Cloud Chapter 5
Conguring and Extending Applications Theme Management

Display Seings of the Home Page


Use the Home Page Layout page of the Appearance work area to congure the display seings of the home page.
• For panel and banner layouts, you can specify the default content to be displayed on the home page panel and
banner, and the display photo on the main panel of the home page.
• For the news feed layout, you can rename the home page sections, show or hide them, and reorder them.

Related Topics
• Dene Home Page Appearance
• Overview of Sandboxes
• Create and Activate Unied Sandboxes

Create Themes
Use the Themes tab of the Appearance work area to create themes.

Before You Start


Activate a sandbox.

Create Themes
Follow these steps:
1. On the Navigator, select Conguration > Appearance.
2. From the Themes list, select your base theme.
3. From the Default Home Page Layout list, select Panel, Banner, or News Feed.
◦ Panel or banner layout contains a springboard with icons that you can use to open work areas.
Also, based on setup, the home page shows either company announcements or social networking
conversations. This information appears in a panel for the panel layout, and in a banner for the banner
layout.
◦ News feed layout mainly contains the Apps section with icons to open work areas and a series of updates
with important information.
4. Congure the various appearance seings for your application, as required. For example, select a branding
logo, and specify color schemes.
5. On the Actions menu, select Save As.
6. Enter a theme name.
7. Optionally, deselect Apply this theme if you don't want to apply the theme to the application immediately.
8. Click OK. If you have selected the Apply this theme check box, then your theme is saved and set as the current
theme. If you haven't selected the check box, your theme isn't applied to the application. However, the theme is
saved, and you can apply it to your application later.

Related Topics
• Overview of Sandboxes
• Create and Activate Unied Sandboxes

90
Oracle Applications Cloud Chapter 5
Conguring and Extending Applications Theme Management

Manage Themes
Use the Themes page to manage your themes. To open the Themes page, on the Navigator, select Conguration >
Appearance.
You can edit saved themes, apply themes to your application pages, and delete saved themes. You can't edit or delete
predened themes.

Before You Start


Activate a sandbox.

Apply Themes
From the Themes list, select a theme, and click Apply. If the selected theme is a predened one, then save it as a new
theme, and then edit and apply the theme, as required.

Apply the Default Theme


On the Actions menu, select Apply Default. The default theme is applied to your application.

Edit Themes
Follow these steps:
1. On the Navigator, select Conguration > Appearance.
2. From the Themes list, select your base theme.
3. Set the default layout of the home page, and congure the various appearance seings for your application, as
required. For example, select a branding logo and specify color schemes.
4. Click Apply. If the base theme you have selected is a:
◦ Predened theme, then enter a theme name, and click OK to create another theme with your
modications. This new theme is then applied to your application.
◦ Saved theme, then your theme changes are directly applied to your application.

Delete Themes
From the Themes list, select a saved theme that you want to delete, and then on the Actions menu, select Delete.

Change the Logo and Background Image


Use the Themes page to dene the:
• Branding logo, which appears above all application pages. You can use a logo of any size, but the
recommended width is lesser than 200 px and height is lesser than 50 px.
• Watermark, which appears in the background of all application pages. Use an image that's as close to 1024 by
768 pixels as possible.

91
Oracle Applications Cloud Chapter 5
Conguring and Extending Applications Theme Management

To select a logo and a background image, use one of the options:

• File: Browse and select a le from your local computer.


• Predened: Select a le from the list of predened images.
• URL: Enter a full URL for the logo or the watermark.

Appearance Seings for Changing the Look and Feel of


the Application
You congure the various appearance seings for your application using the Themes tab of the Appearance work area.
These tables summarize the appearance seings that you can congure while creating and editing your themes and
their default values.

General Seings

Seing Description Values Default Value

Default Home Layout The default layout of the • Panel Panel


  home page. • Banner  
  • News Feed

When you select a Panel or


Banner layout, the home page
contains a springboard with
icons that you can use to
open work areas. Whereas,
when you select the News
feed layout, your home page
mainly contains the Apps
section and a series of updates
with important information.

Logo The type of location where • File Predened


  your logo for the global • Predened  
header is stored. You can • URL
browse and select your logo
from that location.
 

Congure bookmark icon for • Checked Unchecked


desktop Selecting this check box  
• Unchecked
  displays the Desktop Icon list
for you to choose a bookmark
icon for your desktop.

Desktop Icon • URL URL


  The bookmark icon that  
• File
appears on your desktop.

This list is available only if


you selected the Congure

92
Oracle Applications Cloud Chapter 5
Conguring and Extending Applications Theme Management

Seing Description Values Default Value

bookmark icon for desktop


check box.

Congure shortcut icon for • Checked Unchecked


mobile Selecting this check box  
• Unchecked
  displays the Mobile Icon list
for you to choose a shortcut
icon for your mobile device.

Mobile Icon • URL URL


  The shortcut icon that appears  
• File
on your mobile device.

This list is available only if


you selected the Congure
shortcut icon for mobile
check box.

Background Image The type of location where • None Predened


  your background image of all • File  
application pages is stored. • Predened
You can browse and select the
image from that location. • URL
 

Repeat Image Selecting this check box • Checked Unchecked


  repeats the specied • Unchecked  
background image to display it
both vertically and horizontally
in the background of all
application pages.
 

Background Image Position The position of the • Center Center


  background image for all • Start  
application pages.
 

Global Region The background color of the Color palee Transparent


  global header, which is the    
uppermost region in the user
interface.
 

Global Region Background The background color of the Color palee Transparent
Color global header, which is the    
  uppermost region in the user
interface.
 

Global Text and Icon Color The color of the text that Color palee 2E444C
  appear in general and with    
icons in the global header.
This excludes the company
logo.
 

Enable color gradient Selecting this check box • Checked Unchecked


  enables color gradient for • Unchecked  

93
Oracle Applications Cloud Chapter 5
Conguring and Extending Applications Theme Management

Seing Description Values Default Value

global text and icons. This


excludes the company logo.
 

Gradient Type The gradient type for global • Top to boom Left to right
  text and icon colors. This • Left to right  
excludes the company logo. • Top left to boom right
 
This eld is available only if • Top right to boom left
you enabled color gradient.
 

Start Color and End Color The start and end colors of the Color palee 8CD3FF
  gradient for global text and    
icon colors.
 
This eld is available only if
you enabled color gradient.
 

Cover Image The type of location where • None Predened


  your cover image, which • File  
displays in the background • Predened
of the home page panel or
banner, is stored. You can • URL
browse and select the image
from that location.
 

Panel Style • Light: Overlays a Light


  Species the style for the main portion of the home  
panel or banner on the home page panel or banner
page. with a semi-transparent
white layer and makes
This eld is available only the text on top of it
if you selected the default black.
home page layout as Panel or • Dark: Overlays a portion
Banner. of the home page panel
or banner with a semi-
transparent black layer
and makes the text on
top of it white.

Navigation Icons

Seing Description Values Default Value

Icon Type The type of navigation icons • Solid Solid


  on the home page. • Outlined  
 

Size • Extra large: Sets the Extra large


  The size of the navigation size of the icons to  
icons on the home page. 96px.
• Large: Sets the size of
This eld is available only the icons to 72px.
if you selected the default

94
Oracle Applications Cloud Chapter 5
Conguring and Extending Applications Theme Management

Seing Description Values Default Value

home page layout as Panel or • Medium: Sets the size


Banner. of the icons to 64px.
• Small: Sets the size of
the icons to 48px.

Image Color Color palee 2E444C


  The image color of the    
navigation icon on the home
page.

This eld is available only


if you selected the default
home page layout as Panel or
Banner.

Group Indicator Icon The color of the three dots Color palee FFFFFF
  that appear on certain icons    
on the home page to indicate
that these icons are group
icons.
 

Label Color The color of the label text of Color palee 2E444C
  the navigation icons.    
 

Background Shape The shape that displays • None Circle


  behind the navigation icons. • Circle  
  • Square
• Rounded square
• Transparent square

The Transparent square


option is available only if you
selected the default home
page layout as News Feed.

Background Card Color • Light Light


  The background color of the  
• Dark
navigation icons on the News
Feed home page.

This eld is available only if


you selected:

• The default home page


layout as News Feed.
• The background shape
for navigation icons as
Transparent square.

Background Card Opacity Any value between 1 and 99 10


  The background opacity of the    
navigation icons on the News
Feed home page.

95
Oracle Applications Cloud Chapter 5
Conguring and Extending Applications Theme Management

Seing Description Values Default Value

This eld is available only if


you selected:

• The default home page


layout as News Feed.
• The background shape
for navigation icons as
Transparent square.

Background Color Color palee Multicolor


  The color of the shape that    
displays behind the navigation
icons.

This eld isn't displayed if


you have selected None or
Transparent square as the
background shape for the
navigation icons.

Page Seings

Seing Description Values Default Value

Heading color The text color of the headers Color palee 333333
  and subheaders of application    
pages.
 

Link Color The color of the links that Color palee 0A6DAA
  appear on the application    
pages.
 

Selection Color The color of the highlighted Color palee 047BC4


  or selected UI element on    
all work areas related to
employees, for example
Personal Information,
Benets, and Absences. These
UI elements are boxes, and
each box represents an option,
for example a specic part
of your personal prole to
update. This color applies to
the border of the box and the
selected check box (if any)
inside the box.
 

Highlight Color Color palee C74200


  The color used to highlight    
application items that need
aention. For example, the
part of the Notications icon
on the global header that

96
Oracle Applications Cloud Chapter 5
Conguring and Extending Applications Theme Management

Seing Description Values Default Value

displays the number of new


notications in your list.

Card Style The style of cards displayed • Dark: Displays the cards Dark
  on the application pages with a white or light  
having a grid view. grey background color
  and dark text.
• Light: Displays the
cards with a dark grey
background color and
light text.

Landing Page Icons for The icon color of the landing Color palee 309FDB
Employees pages for all work areas    
  related to employees, for
example Personal Information,
Benets, and Absences.
 

Buon Seings

Seing Description Values Default Value

Label The color of the label text of Color palee 000000


  the buons on all application    
pages.
 

Border The color of the buon Color palee C4CED7


  borders on all application    
pages.
 

Enable color gradient • Checked Checked


  Selecting this check box  
• Unchecked
enables color gradient for
buons on all application
pages.

This check box is available


only if you selected the default
home page layout as Panel or
Banner.

Start Color and End Color The start and end colors of Color palee • Start Color: F1F3F3
  the gradient for buons on all   • End Color: E4E8EA
application pages.
 
This eld is available only if
you enabled color gradient.
 

Background The background color for Color palee F1F3F3


  buons on all application    
pages.
 

97
Oracle Applications Cloud Chapter 5
Conguring and Extending Applications Theme Management

Seing Description Values Default Value

This eld isn't available if


you enable color gradient for
buons.
 

Corner Rounding The extent to which the • None: Removes corner Small
  corners of the buons on rounding from all  
all application pages are buons, which means
rounded. applies a rectangular
  shape to all buons.
• Small: Applies a very
small curve to the
corners of all buons.
• Medium: Applies a
moderate curve to the
corners of all buons.
• Large: Applies a large
curve to the corners
of all buons, thereby
making a pill shape.

Change the Logo and Color Schemes of the Application


This example demonstrates how to change a logo and the color schemes of an application using the Themes tab of the
Appearance work area. Users see the logo in the global header.
Note: Changes made to the logo using Page Composer overwrite the changes done using the Appearance
work area.

The following table summarizes the key decisions for this scenario.

Decisions to Consider In This Example

What's the name of the new theme? MyCompany


   

Which existing theme are you going Default


to base this theme on?  
 

Which default home page layout are Banner


you going to use?  
 

Which image are you going to use as MyCompany.png


the new logo?  
  Note: You can use a logo of any size, but the recommended width is lesser than
200 px and height is lesser than 50 px.
 

98
Oracle Applications Cloud Chapter 5
Conguring and Extending Applications Theme Management

Decisions to Consider In This Example

Which image are you going to use as MyDesktopIcon. png


your application's bookmark icon for  
desktop? Note: For best results, use a square-shaped icon with each side measuring lesser
 
than 16 px.
 

Which image are you going to use as MyMobileIcon. png


your application's shortcut icon for  
mobile devices? Note: For best results, use a square-shaped icon with each side measuring more
 
than 57 px and lesser than 144 px.
 

Which background image are you WatermarkOracle. png


going to use?  
  Note: For best results, use an image size that's as close to 1024 by 768 pixels as
possible.
 

Before You Start


Activate a sandbox.

Change the Logo and Color Schemes


You can specify the look and feel aspects of various UI elements, such as navigation icons and buons, using the
Themes page. The elds available for you to change these appearance seings may vary based on what you select for
some elds. For example, if you select News Feed as the default home layout, the Group Indicator Color eld isn't
displayed for selection because this eld isn't applicable for the news feed home page layout.
Follow these steps:
1. On the Navigator, select Conguration > Appearance. On the Appearance work area, click the Themes tab.
2. From the Themes list, select Default.
3. Select the default home layout as Banner.

Note: When you select a Panel or Banner layout, the home page contains a springboard
with icons that you can use to open work areas. Also, based on setup, the home page shows
either company announcements or social networking conversations. This information
appears in a panel for the panel layout, and in a banner for the banner layout. When you
select the News feed layout, your home page mainly contains the Apps section and a series
of updates with important information.
4. From the Logo list, select File as the type of location where your logo is stored. Browse and select
MyCompany.png.
5. Select the Congure bookmark icon for desktop check box, and from the Desktop Icon list, select File.
Browse and select MyDesktopIcon.png.

99
Oracle Applications Cloud Chapter 5
Conguring and Extending Applications Theme Management

6. Select the Congure shortcut icon for mobile check box, and from the Mobile Icon list, select File. Browse
and select MyMobileIcon.png.
7. From the Background Image list, select File as the type of location where your background image is stored.
Browse and select WatermarkOracle.png.
8. To specify the general appearance of the application, enter the values as shown in this table, or select the colors
from the color palee.

Field Value

Global Region Background Color A9A9A9 (Dark Gray)


   
This eld species the background color of the global header, which is the uppermost region
in the user interface.
 

Global Text and Icon Color 4169E1 (Royal Blue)


   
This eld species the color of the text that appear in general and with icons in the global
header.
 

Enable color gradient


  Select the check box, specify the gradient type as Top to boom, and start and end colors of
the gradient as follows:

◦ Start Color: 00BFFF (Deep Sky Blue)

◦ End Color: 4169E1 (Royal Blue)

Cover Image
  Select File as the type of location where your cover image is stored. Browse and select
MyCover.png.

For the home page with the:

◦ Panel layout, this image appears on the main panel. The recommended image size is
344x622 px.
◦ Banner layout, this image appears on the banner. The recommended image size is
2600x290 px.
◦ News feed layout, this image appears in the Things to Finish section. The
recommended image size is 2600x290 px.

Panel Style Light


   
This eld species the style of the main panel on the home page.
 

9. To specify the appearance of the navigation icons, enter the values as shown in this table, or select the colors
from the color palee.

Field Value

Icon Type Solid


   

Size Small
   

100
Oracle Applications Cloud Chapter 5
Conguring and Extending Applications Theme Management

Field Value

Image Color Multicolor


   

Group Indicator Color D02090 (Violet Red)


   
This eld species the color of the three dots that appear on certain icons on the
springboard to indicate that these icons are group icons.
 

Label Color 000000 (Black)


   
This eld species the color of the label text of the navigation icons.
 

Background Shape Circle


   

Background Color
  Multicolor

This eld isn't displayed if you have selected None as the background shape.

10. To specify the appearance of the application pages, enter the values as shown in this table, or select the colors
from the color palee.

Field Value

Heading Color 8B008B (Dark Magenta)


   
This eld species the color of the header text on the application pages.
 

Link Color 0000FF (Blue)


   
This eld species the color of the links that appear on the application pages.
 

Selection Color FFB6C1 (Light Pink)


   
This eld species the color of a selected or highlighted UI element on a page.
 

Highlight Color FFB6C1 (Yellow)


   

Card Style Light


   
This eld species the style of cards displayed on application pages having a grid view.
 

Landing Page Icons for Employees Blue


   
This eld species the icon color of the landing pages for all work areas related to
employees, for example Personal Information, Benets, and Absences.
 

101
Oracle Applications Cloud Chapter 5
Conguring and Extending Applications Theme Management

11. To specify the appearance of the buons, enter the values as shown in this table, or select the colors from the
color palee.

Field Value

Label 000000 (Black)


   
This eld species the color of the label text of the buons.
 

Border 000000 (Black)


   
This eld species the color of the buon borders.
 

Enable color gradient


  Select the check box and specify the start and end colors of the gradient as follows:

◦ Start Color: 4169E1 (Royal Blue)

◦ End Color: 00BFFF (Deep sky Blue)

Corner Rounding Small


   
This eld species the extent to which the buon corners are rounded. For example, None
indicates that the buon corners aren't rounded and Small indicates that the buon corners
are slightly rounded.
 

Tip: While making changes on the Themes page, you can click Apply any time to preview
your changes.

12. On the Actions menu, select Save As.


13. Enter the theme name as MyCompany.
14. Make sure that Apply this theme is selected.
15. Click OK.

Related Topics
• Overview of Sandboxes
• Create and Activate Unied Sandboxes
• Overview of Work Areas

FAQs for Theme Management

102
Oracle Applications Cloud Chapter 5
Conguring and Extending Applications Theme Management

What happens to my theme if changes that aect themes are


made using Page Composer?
Application changes made using Page Composer overwrite the changes made using the Appearance work area.
Caution: Before using the Appearance work area to change the look of your application, you must undo any
changes aecting the theme done using Page Composer. Otherwise, the changes that you make using the
Appearance work area may not show up in your application as you wanted.

103
Oracle Applications Cloud Chapter 5
Conguring and Extending Applications Theme Management

104
Oracle Applications Cloud Chapter 6
Conguring and Extending Applications Flexelds

6 Flexelds

Overview of Flexelds
A exeld is a set of placeholder elds associated with business objects and placed on the application pages to
contain additional data. You can use exelds to modify the business objects and meet enterprise data management
requirements without changing the data model or performing any database programming. Flexelds help you to
capture dierent data on the same database table and provide a means to modify the applications features.
For example, an airline manufacturer may require specic aributes for its orders that aren't predened. Using a
exeld for the order business object, you can create and congure the required aribute.

Types of Flexelds
Flexelds that you see on the application pages are predened. However, you can congure the exelds or modify
their properties. Users see these exelds as eld or information aributes on the UI pages. To manage exelds, use
any of the following tasks in the Setup and Maintenance work area:

• Manage Descriptive Flexelds: Expand the forms on the application page to accommodate additional
information that is important and unique to your business. You can use a descriptive exeld to collect invoice
details on a page displaying invoices.
• Manage Extensible Flexelds: Establish one-to-many data relationships and make application data context-
sensitive. The exelds appear only when the contextual data conditions are fullled. Thus, extensible exelds
provide more exibility than the descriptive exelds.
• Manage Key Flexelds: Store information combining several values, such as a number combination. The key
exelds represent objects such as accounting codes and asset categories.
• Manage Value Sets: Use a group of values to validate the data entered in the exelds.

Note: You can manage value sets within the Manage Descriptive Flexelds or Manage Extensible
Flexelds tasks.

Related Topics
• Modules in Application Taxonomy

Overview of Flexeld Conguration


Conguring a exeld involves identifying the need for enhancing a business object with user-dened aributes
and then integrating the aributes into deployment. In the case of key exelds, conguring the exeld involves
identifying value set assignments and determining segment structures.

105
Oracle Applications Cloud Chapter 6
Conguring and Extending Applications Flexelds

Overall Process for Conguring User-Dened Aributes


Before using exelds to create aributes, familiarize yourself with the context layers and the conguration life cycle of
the application. You can add aributes to a business object using a exeld, if developers have registered that object to
a exeld. For descriptive and extensible exelds, the overall conguration process involves the following:
1. Use the Highlight Flexelds feature from the Administration menu to nd exelds on pages associated with
business objects.
2. Plan the exeld conguration.
3. Plan exeld validation.
4. Dene the aributes by conguring the exeld segments.
a. Use the Manage Extensible Flexelds or Manage Descriptive Flexelds tasks, or use the Congure
Flexeld icon buon directly on the page where the exeld is highlighted. For simple congurations,
use the Add Segment, Add Context Value, and Edit Segment icon buons directly on the page where
the exeld is highlighted.
b. Optionally, validate the exeld conguration.
c. Optionally, deploy the exeld to a sandbox for initial testing.
5. Deploy the exeld to the mainline metadata to display the aributes on the application pages and to make
them available for integration with other tools such as Oracle Business Intelligence.
6. Perform the necessary steps to integrate the aributes into the technology stack.
A simple conguration is limited to such actions as adding a format-only eld or adding a eld with a basic list of values.

Overall Process for Conguring User-Dened Keys


Using key exelds, you can congure intelligent key codes containing meaningful parts according to your business
practices. You congure the key exeld to have one segment for each part that makes up your key code.
For key exelds, the overall conguration process involves the following:
1. Use the Highlight Flexelds feature from the Administration menu to nd exelds on pages associated with
business objects.
2. Plan the exeld conguration.
3. Plan the exeld validation.

4. Dene the value sets before conguring the key exeld segments by going to the Manage Value Sets task.
5. Dene the key exeld structures and their segments, and dene structure instances for each structure.
a. Use the Manage Key Flexelds task or the Congure Flexeld icon buon directly on the page where
the exeld is highlighted.
b. Optionally, validate the exeld conguration.
c. Optionally, deploy the exeld to a sandbox for initial testing.
6. Deploy the exeld to the mainline metadata to display it on the application pages and to make it available for
integration with other tools such as Oracle Business Intelligence.
7. Perform the necessary steps to integrate the exeld into the technology stack.

Related Topics
• Overview of Context Layers

106
Oracle Applications Cloud Chapter 6
Conguring and Extending Applications Flexelds

• Overview of Conguration Life Cycle

Flexeld Components
A exeld is made up of several data entities that store and render information pertaining to exeld conguration.
Flexelds are made up of the following components:
• Segments
• Value Sets
• Contexts
• Structures

Segments
A segment is a eld within a exeld and represents a single table column of your database. When conguring a
exeld, dene the appearance and meaning of individual segments. Segments represent aributes of information.
Segments can appear globally wherever the exeld is implemented, or based on a structure or context. Each segment
captures a single atomic value and represents an aribute of information.

The characteristics of a segment vary based on the type of exeld in which it's used.
• In key exelds, a segment describes a characteristic of the entity. For example, a part number that contains
details about the type, color, and size of an item.
• In a descriptive or extensible exeld, a segment represents an information aribute on the application page.
For example, details about a device containing components, some of which are global while the remaining are
contextually dependent on the category of the device.

Value Sets
Users enter values into segments while using an application. A value set is a named group of values that validate the
content of a exeld segment. You congure a exeld segment with a value set to enforce entries of only valid values
for that segment.

The conguration involves the following tasks:


• Dening the values in a value set, including characteristics such as the length and format of the values.
• Specifying formaing rules or values from an application table or predened list.

Multiple segments within a exeld, or multiple exelds, can share a single value set.

Contexts
Context-sensitive exeld segments are available to an application based on a context value. You dene contexts as
part of conguring a exeld. Users see global segments as well as any context-sensitive segments that apply to the
selected context value.

In descriptive exelds and extensible exelds, you can reuse the context-sensitive segments that are based on the
database columns, in multiple contexts.

107
Oracle Applications Cloud Chapter 6
Conguring and Extending Applications Flexelds

Structures
Key exelds have structures. Each key exeld structure is a specic conguration of segments. Adding or removing
segments, or rearranging their order, produces a dierent structure. You can reuse the segments that are based on the
database columns, in multiple structures.

Note: You can translate all these exeld components to the preferred languages without changing the
language session of the application. To specify the translations in all the enabled language rows, use the
Translation Editor option on the respective edit pages. Once the updates are made, users can view the
translated text for the specic exeld components at runtime.

Related Topics
• Enter or Edit Translated Text

Flexelds at Runtime
Business objects have an associated descriptive or extensible exeld. Using these, you can create aributes for the
business object at run time. Some business objects have an associated key exeld for conguring exible multiple part
keys.

Finding Flexelds on a Page


At run time, the aributes you dene as exeld segments appear in the application page just like any other aribute.
However, each type of exeld appears in a dierent way.
The following characteristics help you determine the type of exeld on the application page:
• Descriptive exeld segments appear as label and eld pairs or as a table of elds that correspond to the
column headers. The elds represent the exeld segments and accept values that derive from the segment's
assigned value set.
• Extensible exeld segments appear grouped within labeled regions, where each grouping is a context and the
region labels are the context names.
• Key exelds appear in the application page as a eld with a key exeld icon, where the eld's value is a
collection of segments.

To locate exelds on a page, in the global header, select your user name and in the Seings and Actions menu, select
Highlight Flexelds. The page renders in a special mode, displaying the location of exelds, if any, on the page. Do
the following:
• Hover over the Information icon to view exeld details.
• Click the Congure Flexeld icon to manage the exeld using the Manage Flexelds task.
• Click the Add Context Value, Add Segment, or Edit Segment icons to add a context value or edit a global or
context-sensitive exeld segment. This applies to both descriptive and extensible exelds.

Note: You can't create aributes on all exelds. For example, some exelds are protected, and you either
can't edit their congurations at all, or can do only limited changes to them. Consult the product-specic
documentation to verify whether there are any restrictions on using the exeld.

All segments of a single exeld are grouped together by default. The layout and positions of the exeld segments
depend on where the application developer places the exeld on the page. Flexelds may also be presented in a

108
Oracle Applications Cloud Chapter 6
Conguring and Extending Applications Flexelds

separate section of the page, in a table, or on their own page or a dialog box. You can use Oracle Composer to edit the
layout, position, or other display features of the exeld segments.

When you no longer want to view the exelds on a page, select Unhighlight Flexelds from the Administration menu.

Flexeld Modication Using Page Composer


You can use Page Composer to modify exelds specic to a page.

Extensible Flexeld Modication


In Page Composer, open the page with the exeld you want to modify. Switch to Source view, and look for a region
that is bound to an EContextsPageContainer task ow. This is the container for the extensible exeld aributes and
contexts. To view the exeld code and identifying information, open the properties panel for the region. To modify any
component within the region, select the desired tag and click Edit.

Descriptive Flexeld Modication


In Page Composer, open the page with the exeld you want to modify. Switch to Source view, and look for the
<descriptiveFlexfield> element of that exeld. Open the properties panel for this element to view the exeld
code and identifying information. Within the properties panel, you may modify properties for the global and context-
sensitive segments or re-order the segments on the page.

Note: Flexeld segments can't be edited using their individual component elements. They can only be edited
from the properties panel of the <descriptiveFlexfield> element they belong to. To nd these components,
open the properties panel of the descriptive exeld, switch to the relevant tab, and search using the unique
identifying information. For instance, if you need to nd a context sensitive segment, open the properties
panel for the exeld, go to the Flexeld Context Segments tab, and search for the segment using its Context
Value and Segment Code.

How Flexelds Work with Oracle Application Cloud


Architecture
To capture additional data, administrators or implementors congure exeld segments that represent aributes of
business objects. Business objects are enabled for both descriptive exelds and extensible exelds.
The following gure shows the layers involved in conguring a exeld:

• The business entity table and metadata in the database.


• The ADF business component objects. These are derived from the metadata and stored in Oracle Metadata
Services (MDS) repository.
• The user interface where elds dened by the exeld segments are rendered.

109
Oracle Applications Cloud Chapter 6
Conguring and Extending Applications Flexelds

The following gure illustrates that the exeld denition consists of all the metadata dened during conguration and
stored in the database.

Oracle Fusion
Applications Database

Entity Table
Enabled for
Adding
Flexfield Flexfield Definition
Segments

Define Flexfields
Create Tasks for Configure
Define Flexfields Flexfield
flexfield. Application flexfield.
Tasks
Administrators
for Application
and
Developers
Implementation
Consultants

Flexfield Deployment

Metadata ADF Business


Services Components
Repository

Attributes
on the entity display as
input fields in the user
interface.

Application developers create a exeld and register it so that it's available for conguration. Administrators and
implementation consultants congure segments and other properties of the available exelds. This information is
stored as additional exeld metadata in the database. Deploying the exeld generates ADF business components
based on the exeld metadata in the database.

The following aspects are important in understanding how exelds and Oracle Applications Cloud architecture work
together:

• Integration
• Deployment

110
Oracle Applications Cloud Chapter 6
Conguring and Extending Applications Flexelds

• Import and export


• Run time
• Patching

Integration
The aributes that you add by conguring exelds are available throughout the Oracle Fusion Middleware technology
stack. You can use the exeld segment's Application Programming Interface (API) to identify segments and integrate
the exelds in the following:

• User interface pages


• Service-oriented Architecture (SOA) infrastructure
• Oracle Business Intelligence
• Extended Spread Sheet Database (ESSbase)

Flexeld congurations are preserved across application updates.

Deployment
The metadata for the exeld is stored in the application database as soon as you save your conguration changes.
Deploying the exeld generates the ADF business components so that the run time user interface reects the latest
exeld denition in the metadata.

Importing and Exporting


Using the Setup and Maintenance work area, you can import and export exelds across the implementation site. The
deployment status must be either Deployed or Deployed to sandbox. Therefore, before you aempt migration, verify
and ensure that a exeld is successfully deployed.

Run Time
The latest denitions of a exeld reect on the user interface at run time only if the exeld is deployed. When the
user interface accesses a business object, the deployed exeld denition identies the aributes associated with the
captured values. On a page, if you add display congurations for a exeld using Oracle Composer, the same exeld
segments can appear dierently on dierent pages.

Patching
Flexeld congurations are preserved during patching and upgrading.

Flexeld Management

111
Oracle Applications Cloud Chapter 6
Conguring and Extending Applications Flexelds

Considerations for Managing Flexelds


Managing exelds involves registering, planning, and conguring exelds.
You plan and congure the registered exelds provided in your applications by applications developers. How you
congure exeld segments determines how the exeld segments appear to users. Optionally, you can modify the UI
page to change how the exeld segments appear to users on that page.

The following gure shows the processes involved in making exelds available to users. The tasks in the Dene
Flexelds activity let administrators congure and deploy exelds. After you congure and deploy a exeld to a
sandbox, deploy it again to the mainline metadata so that it's available to the users.

Register Plan flexfield


flexfield configuration

Configure
flexfield

Flexfield-
Deploy to
enabled
sandbox
sandbox

Yes Change in No Deploy to


behaviour? mainline

Flexfield is
available to users

Configure the page Change No


Yes
where the flexfield appearance
appears in UI?

112
Oracle Applications Cloud Chapter 6
Conguring and Extending Applications Flexelds

Consider the following aspects of managing exelds:


• Registering exelds
• Planning exelds
• Conguring exelds
• Enabling a exelds segment for business intelligence
• Deploying exelds
• Optionally changing a exeld segment's appearance in a user interface page
• Identifying exelds on a run time page and troubleshooting

Registering Flexelds
A exeld must be registered before it can be congured. Therefore, application development registers exelds so
that they are available to administrators and implementation consultants for conguration. The registration involves
reserving columns of entity tables for use in exelds. For more information about registering exelds, see Oracle
Fusion Applications Developer's Guide.

Planning Flexelds
Before you begin planning exelds, determine what type is appropriate to your needs, and which business objects are
available for modifying exelds. All exelds consist of segments which represent aributes of an entity. The value a
user enters for an aribute is stored in a column of the entity table. Carefully plan exelds before conguring them.
Before conguring new segments for your exelds, be sure to plan their implementation carefully.
If you have determined that a business object supports exelds, and those exelds have been registered, you can
begin planning their conguration. Note the code name of the exeld you intend to congure so that you can nd it
easily in the Dene Flexeld activity. In some cases you can determine and congure how the exeld appears on the
page. See Oracle Applications Cloud Help for specic products to determine any restrictions on using product-specic
exelds.

Conguring Flexelds
Administrators or implementors congure exelds so they meet the needs of the enterprise. Some exelds require
conguration to make an application operate correctly. You can congure exelds using the following methods:
• Use the manage exeld tasks in the Setup and Maintenance work area.
• Use the Highlight Flexelds command in the Administration menu while viewing a run time page.

◦ Use the Congure Flexeld icon buon to manage all aspects of a exeld, such as change a segment's
sequence number or congure a exeld segment's business intelligence label.
◦ Use the Add Segment and Edit Segment icon buons to add and edit descriptive or extensible exeld
segments with simple congurations.
◦ Use the Add Context icon buon to add descriptive or extensible exeld context values.

Conguring a exeld includes the following:


• Dening value sets against which the values entered by users are validated
• Dening the structure or context of the segments in the exeld
• Specifying the identifying information for each segment
• Specifying the display properties such as prompt, length and data type of each exeld segment
• Specifying valid values for each segment, and the meaning of each value within the application

113
Oracle Applications Cloud Chapter 6
Conguring and Extending Applications Flexelds

Tip: You can create value sets while creating descriptive and extensible exeld segments. However, dene
value sets before conguring key exeld segments that use them, because you assign existing value sets
while conguring key exeld segments.

When creating table-validated, independent, dependent, or subset value sets while creating descriptive and extensible
exeld segments, you can optionally specify to display the description of the selected value next to the segment at run
time. You can assign sequence order numbers to global segments and to context-sensitive segments in each context.
Segment display is always in a xed order based on the segments' sequence numbers. You cannot enter a number for
one segment that is already in use for a dierent segment. Therefore, you may consider numbering the segments in
multiples, such as 4, 5, or 10, to make it easy to insert new aributes.

A exeld column is assigned to a new segment automatically, but you can change the assignment before saving the
segment. If you must set a specic column assignment for a segment, create that segment rst to ensure that the
intended column isn't automatically assigned to a dierent segment.

Enabling a Flexeld Segment for Business Intelligence


You can enable exeld segments for business intelligence if the exeld is registered in the database as an Oracle
Business Intelligence-enabled exeld. For more information about enabling segments for business intelligence,
see points to consider when enabling descriptive, extensible, and key exeld segments for business intelligence.
For extensible exeld segments, you can't assign labels to equalize segments across contexts that are semantically
equivalent.

Deploying Flexelds
Once you have congured a exeld, you must deploy it to make the latest denition available to run time users. In the
Dene Flexelds tasks, you can deploy a exeld using either of the following commands:
• The Deploy Flexeld command deploys a exeld to the mainline metadata. This command is for general use
in a test or production environment.
• The Deploy to Sandbox command deploys a exeld to sandbox. This command is for conrming that the
exeld is correctly congured before deploying it to the mainline metadata.

In Highlight Flexelds mode, when using the:

• Add Context, Add Segment, and Edit Segment tools for extensible exelds, use the Save command to save
your changes. Then use the Deploy command to deploy the exeld to the mainline metadata
• Add Segment and Edit Segment tools for descriptive exelds, use the Save and Deploy command to save
your changes. Then deploy the exeld to the mainline metadata

Once deployed, the deployment status indicates the state of the currently congured exeld relative to the last
deployed denition.

Optionally Changing a Flexeld Segment Appearance


The exeld aributes that you dene integrate with the user interface pages where users access the aributes'
business object. Application development determines the UI pages where business objects appear and the display
paerns used by default to render exeld segments.
After a exeld has been deployed to the mainline MDS repository so that it appears on application pages, you can
modify it on a per-page basis using Page Composer. For example, you can hide a segment, change its prompt or other
properties, or reorder the user-dened global aributes so that they are interspersed with the core aributes in the
same parent layout. You can modify the appearance of descriptive and extensible exeld segments in the UI page
using Page Composer, once the exeld is deployed to the mainline metadata.

114
Oracle Applications Cloud Chapter 6
Conguring and Extending Applications Flexelds

If the applications are running in dierent locales, you can provide dierent translations for translatable text, such as
prompts and descriptions. Enter translations using the locale that requires the translated text. In the global header,
click your user name and from the Seings and Actions menu, select Set Preferences. Then change the text to the
translated text for that locale.

Identifying Flexelds on a Run Time Page


The Highlight Flexelds command in the Administration menu of the Setup and Maintenance work area identies the
location of exelds on the run time page by displaying an Information icon buon for accessing details about each
exeld.
Even if a descriptive or extensible exeld isn't yet deployed and no segments appear on the run time page in normal
view, the exeld appears in the Highlight Flexeld view for that page. For descriptive exelds, the segments as of the
last deployment appear. For extensible exelds, any segments and contexts that have been saved but not yet deployed
also appear as disabled.

Highlight Flexelds accesses the current exeld metadata denition. Use the highlighted exeld's Congure
Flexeld icon buon to manage exelds directly. Alternatively, note a highlighted exeld's name to search for it in
the tasks for managing exelds.

For more information about creating exelds and adding them to a UI page, see the Oracle Fusion Applications
Developer's Guide. For more information about modifying exeld segment appearance with Page Composer, see
guidance on modifying existing pages in the Oracle Applications Cloud Conguring and Extending Applications guide.

Flexeld Segment Properties


Independent of the value set assigned to a segment, segments may have properties that aect how they're displayed
and how they function.
The following aspects are important in understanding
• Display properties
• Properties related to segment values
• Properties related to search
• Range validation segments
• Rule validation of segment values
• Naming conventions

Display Properties
The following table summarizes display properties.

Property Description

Enabled Whether the segment can be used.


   

Sequence The order the segment appears in relation to the other congured segments.
   

Prompt The string to be used for the segment's label in the user interface.

115
Oracle Applications Cloud Chapter 6
Conguring and Extending Applications Flexelds

Property Description

   

Display type The type of eld in which to display the segment.


   

Selected and deselected values If the display type is check box, the actual values to save. For example, Y and N or 0 and 1.
   

Display size The character width of the eld.


   

Display height The height of the eld as measured in visible number of lines when the display type is a text
  area.
 

Read only Whether the eld should display as read-only, not editable text.
   

Description help text The eld-level description help text to display for the eld. Use description help text to display
  a eld-level description that expands on or claries the prompt provided for the eld.
 
If description help text is specied, a Help icon buon is displayed next to the eld in the run
time application. The description help text is displayed when the user hovers over the Help
icon buon.
 

Instruction help text The eld-level instruction help text to display for the eld.
   
Use instruction help text to provide directions on using the eld. If instruction help text is
specied, it's appears in an in-eld help note window when users move the cursor over the
eld.
 

Properties Related to Search


Extensible exeld segments can be marked as selectively required in search using the indexed property. The indexed
property requires users to enter a value before conducting a search on the aribute represented by the indexed
segment. A database administrator must create an index on the segment column representing the indexed aribute.

Range Validation of Segments


Range validation enables you to enforce an arithmetic inequality between two segments of a exeld. For example, a
product must be ordered before it can be shipped. Therefore, the order date must be on or before the ship date. Also,
the order date segment value must be less than or equal to the ship date segment value. You can use range validation
to ensure this relationship.
The conditions for range validation are as follows:
• Segments must be congured for range validation in pairs, one with the low value and one with the high value.
• Both segments must be of the same data type.
• Both segments must be parts of the same structure in a key exeld or parts of the same context in a
descriptive exeld or extensible exeld.
• The low value segment must have a sequence number that's lesser than that of the high value segment.
• Non-range validated segments can exist between a range validated pair, but range validated pairs can't overlap
or be nested.

116
Oracle Applications Cloud Chapter 6
Conguring and Extending Applications Flexelds

You can congure as many range validated pairs as you want within the same exeld. Your application automatically
detects and applies range validation to the segment pairs that you dene, in sequence order. It must detect a low value
segment rst, and the next range validated segment that it detects must be a high value segment. These two segments
are assumed to be a matching pair. The low value and the high value can be equal.

Rule Validation of Segment Values


Validation rules on descriptive and extensible exeld segments determine how an aribute is validated. The value
entered for an aribute on a business object must match a specied format or be restricted to a list of values. You can
use a value set or a Groovy validator to specify the validation rules.
Value set validation is required for global segments and context-sensitive segments, and optional for context segments.
In the case of context segments, the application may validate a value instead of the value set validating the value
against the context segment. However the application entered values must match exactly the valid context segment
values. If the context segment values are a superset or subset of the input values, you must assign a table-validated
value set or independent value set to validate context values.

You can also use Groovy validation to set additional restrictions or requirements for what values are allowed for certain
aributes of business objects. This is useful when you need to use the same value set to validate multiple segments, but
the exact validation requirement changes with each case. These validators can be dened at the global segment level,
or at the context level, based on your business needs. They have a validator code, validation expression, error message,
and description. After adding a new validator, click the Groovy Expression Builder icon to open the expression builder
window where you dene your validation expression. Groovy validation is done when a user tries to save their values to
an aribute that has a Groovy validator. If the value for this aribute fails validation against the Groovy expression, the
text dened in the Error Message column is displayed as an error message.

When you congure a descriptive exeld segment, you can specify a constant to use for seing the initial value. The
initial value can be an available parameter. For every planned segment, list the constant value or parameter, if any, to
use for the initial value.

Naming Conventions
Enter a unique code, name, and description for the segment. These properties are for internal use and not displayed to
end users. You can't change the code after the segment is created.
The Application Programming Interface (API) name is a name for the segment that isn't exposed to users. The API name
is used to identify the segment in various integration points including web services, rules, and business intelligence. Use
alphanumeric characters only with a leading character. For example, enter a code consisting of the characters A-Z, a-z,
0-9 with a non-numeric leading character. The use of spaces, underscores, multi-byte characters, and leading numeric
characters isn't permied. You can't change the API name after the segment has been created.

Naming Conventions for Flexeld APIs


Application Programming Interface (API) name is a name for your exeld component, which isn't exposed to users.
These names are used to identify exeld components in various integration points, including web services, rules, and
business intelligence.

How to Frame API Names


You must use only alphanumeric characters for API names. For example, enter a name with the characters A-Z, a-z, or
0-9, with a non-numeric leading character. Don't use spaces, underscores, multi-byte characters, or leading numeric
characters in your API names.

117
Oracle Applications Cloud Chapter 6
Conguring and Extending Applications Flexelds

Caution: Do not change API names after they're created. Doing so could break integration points.

Words You Can't Use for API Names


You can't use certain words for API names when conguring exelds because they're reserved words in ADF, SQL, PL/
SQL, Java, Groovy, and so on.
This table lists some of the reserved words that can't be used as API names. This list isn't exhaustive.

Leer Reserved Words

A ABORT, ABSTRACT, ACCEPT, ACCESS, ACTIONENABLED, ADD, ALL, ALLROWSINRANGE,


  ALTER, AND, ANY, ARRAY, ARRAYLEN, AS, ASC, ASSERT, ASSIGN, AT, ATTRIBUTEDEF,
ATTRIBUTEDEFS, ATTRIBUTEVALUE, ATTRIBUTEVALUES, AUDIT, AUTHORIZATION, AVG
 

B BEGIN, BETWEEN, BINDINGS, BODY, BOOLEAN, BREAK, BY, BYTE, BYVALUE


   

C CASCADE, CASE, CAST, CATCH, CATEGORY, CHAR, CHECK, CHILDREN, CLASS, CLONE,
  CLOSE, CLUSTER, CLUSTERS, COALESCE, COLAUTH, COLUMN, COLUMNS, COMMENT,
COMMIT, COMPRESS, CONNECT, CONST, CONSTANT, CONSTRIANT, CONTAINS, CONTINUE,
COUNT, CRASH, CREATE, CURRENT, CURRENTROW, CURRVAL, CURSOR
 

D DATABASE, DATACONTROL, DATE, DBA, DEBUGOFF, DEBUGON, DECIMAL, DECLARE,


  DEFAULT, DEFINITION, DELAY, DELETE, DELTA, DESC, DESCRIPTION, DIGITS, DISPLAY,
DISPLAYDATA, DISPLAYHINT, DISPLAYHINTS, DISPOSE, DISTINCT, DIV, DO, DOUBLE, DROP
 

E ELSE, ELSIF, EMPTY, ENABLED, ENABLEDSTRING, END, ENTRY, EQ, EQUALS, ERROR,
  ESTIMATEDROWCOUNT, EXCEPTION, EXCLUSIVE, EXISTS, EXIT, EXTENDS
 

F FALSE, FETCH, FILE, FINAL, FINALIZE, FINALLY, FINDMODE, FLOAT, FOR, FORM, FROM,
  FULLNAME, FUNCTION, FUTURE
 

G GE, GENERIC, GETCLASS, GOTO, GRANT, GROUP, GROUPBY, GT


   

H HASHCODE, HAVING, HINTS


   

I IDENTIFIED, IF, IMMEDIATE, IMPLEMENTS, IMPORT, IN, INCREMENT, INDEX, INDEXES,


  INDICATOR, INITIAL, INNER, INPUTVALUE, INSERT, INSTANCEOF, INT, INTEGER, INTERFACE,
INTERSECT, INTO, IS, ITERATORBINDING
 

J JAVA
   

K KEY
   

L LABEL, LABELS, LABELSET, LE, LEVEL, LIKE, LIMITED, LOCK, LONG, LOOP, LT
   

118
Oracle Applications Cloud Chapter 6
Conguring and Extending Applications Flexelds

Leer Reserved Words

M MANDATORY, MAX, MAXEXTENTS, MIN, MINUS, MLSLABEL, MOD, MODE, MODIFY


   

N NAME, NATIVE, NATURAL, NE, NEW, NEXTVAL, NOAUDIT, NOCOMPRESS, NOT, NOTFOUND,
  NOTIFY, NOTIFYALL, NOWAIT, NULL, NULLIF, NUMBER
 

O OF, OFFLINE, ON, ONLINE, OPEN, OPERATIONENABLED, OPERATOR, OPTION, OR, ORDER,
  ORDERBY, OTHERS, OUT, OUTER, OVERLAPS
 

P PACKAGE, PARTITION, PCTFREE, POSITIVE, PRAGMA, PRIMARY, PRIOR, PRIVATE,


  PRIVILEGES, PROCEDURE, PROTECTED, PUBLIC
 

R RAISE, RANGE, RANGESET, RANGESIZE, RANGESTART, RAW, REAL, RECORD, REFERENCES,


  RELEASE, REMR, RENAME, RESOURCE, REST, RESULT, RETURN, REVERSE, REVOKE,
ROLLBACK, ROOTNODEBINDING, ROW, ROWID, ROWLABEL, ROWNUM, ROWS, ROWTYPE,
RUN
 

S SAVEPOINT, SCHEMA, SELECT, SELECTEDVALUE, SEPARATE, SESSION, SET, SHARE, SHORT,


  SIZE, SMALLINT, SPACE, SQL, SQLBUF, SQLCODE, SQLERRM, START, STATEMENT, STATIC,
STDDEV, SUBTYPE, SUCCESSFUL, SUM, SUPER, SWITCH, SYNCHRONIZED, SYNONYM,
SYSDATE
 

T TABAUTH, TABLE, TABLES, TASK, TERMINATE, THEN, THIS, THROW, THROWS, TO,
  TOOLTIP, TOSTRING, TRANSIENT, TRIGGER, TRUE, TRY, TYPE
 

U UID, UNION, UNIQUE, UPDATE, UPDATEABLE, USE, USER


   

V VALIDATE, VALUES, VAR, VARCHAR, VARCHAR2, VARIANCE, VIEW, VIEWS, VOID, VOLATILE
   

W WAIT, WHEN, WHENEVER, WHERE, WHILE, WITH, WORK


   

X XOR
   

How Flexelds Segments are Rendered


Flexeld segments appear on pages as aributes of business objects.

Seings That Aect Flexeld Segment Display


When you congure exeld segments, the value you enter for the segment's display type determines how the segment
appears at run time.

119
Oracle Applications Cloud Chapter 6
Conguring and Extending Applications Flexelds

How Display Type Values Appear


The following series of gures (A to K) represent how the display types render on the UI at run time. Each display type
screenshot is assigned an alphabet that maps to the display type and its description in the table.

The following gure contains the representation of a check box, a drop-down list, a list of values, and a search enabled
list of values.

A. Check Box

B. Drop-down List

C. List of Values

D. Search Enabled List of Values

The following gure contains the representation of a radio buon group, text area, text box, date and time, and rich text
editor.

120
Oracle Applications Cloud Chapter 6
Conguring and Extending Applications Flexelds

This gure contains the representation of a color palee and a static URL eld.

121
Oracle Applications Cloud Chapter 6
Conguring and Extending Applications Flexelds

The following table describes each display type.

Figure Reference Display Type Description

A Check Box The eld appears as a check box. If the


    user selects the check box, the checked
value is used. Otherwise, the deselected
value is used.
 

B Drop-down List The eld appears as a list of values


    available to the user for selection.
 

C List of Values The eld appears as a list of values


    available to the user for selection. The
user can also click Search to nd more
values.
 

D Search Enabled List of Values The eld appears as a text eld with a
    Search icon buon. The users can type
a value in the text eld or they can click

122
Oracle Applications Cloud Chapter 6
Conguring and Extending Applications Flexelds

Figure Reference Display Type Description

the Search icon buon to open another


window for searching.
 

E Radio Buon Group The eld appears as a set of radio buons.


    The user can select one buon. Selecting
a buon deselects any previously selected
buon in the set.
 

F Text Area The eld appears as a text area in which


    the user can type multiple lines of text.
The display width and height specify the
visible width and number of lines in the
text area, respectively.
 

G Text Box The eld appears as a text eld in which


    the user can type a single line of text. The
display width controls the width of the text
box.
 

H Date Time The eld enables the user to enter a date


    if the data type is Date, or a date and time
if the data type is Date Time. The user can
select the date in a calendar. If the data
type is Date Time, the eld also displays
elds for specifying the hour, minutes,
seconds, AM or PM, and time zone.
 

I Rich Text Editor The eld appears as a text area in which


    the user can enter and edit multiple lines
of formaed text. The display width
and height specify the visible width and
number of lines in the rich text editor,
respectively.
 
Note: This display type is available
for extensible exelds only.
 

J Color
    The eld displays a color palee for the
user to select a color at run time and
assign it to the segment. During setup,
this display type appears in the list for
selection only if:

• You are working on an extensible


exeld segment.
• The value set for the segment is set
to ORA_FND_COLOR_#RRGGBB.

K Static URL The eld appears as a text eld in which


    users can enter a xed URL that opens the
web page when clicked.
 

123
Oracle Applications Cloud Chapter 6
Conguring and Extending Applications Flexelds

Figure Reference Display Type Description

Note: The length of the URL must


not exceed 255 characters.
 

No gure reference available Hidden The eld isn't displayed.


     

How Flexelds and Value Sets Work Together


Value sets are specic to your enterprise. When gathering information using exelds, your enterprise's value sets
validate the values that your users enter based on how you dened the value set.

You can assign a value set to any number of exeld segments in the same or dierent exelds. Value set usage
information indicates which exelds use the value set.

The following aspects are important in understanding how exelds and value sets work together:

• Dening value sets


• Shared value sets
• Deployment

Dening Value Sets


As a key exeld guideline, dene value sets before conguring the exeld, because you assign value sets to each
segment as you congure a exeld. With descriptive and extensible exelds, you can dene value sets when adding
or editing a segment.

Note: Ensure that changes to a shared value set are compatible with all exeld segments that use the value
set.

Shared Value Sets


When you change a value in a shared value set, the change aects the value set for all exelds that use that value set.
The advantage of a shared value set is that a single change propagates to all usages. The drawback is that the change
shared across usages may not be appropriate in every case.

Value Set Values


To congure user-dened aributes to be captured on the value set values in the Manage Value Sets task, congure the
Value Set Values descriptive exeld. The object's code is FND_VS_VALUES_B.This exeld expects the context code
to correspond to the value set code. For each value set, you can dene a context whose code is the value set code, and
whose context-sensitive segments are shown for the values of that value set. By default, the context segment is hidden
since it maps to the value set code and is not expected to be changed.

You can also dene global segments that are shown for all value sets. However, this would be quite unusual since it
would mean that you want to capture that aribute for all values for all value sets.

124
Oracle Applications Cloud Chapter 6
Conguring and Extending Applications Flexelds

Deployment
When you deploy a exeld, the value sets assigned to the segments of the exeld provide users with the valid values
for the aributes represented by the segments.

Default Segment Values


To populate a exeld segment with a default value when a row is created, specify a default type of constant, parameter,
or Groovy, and a default value or expression.
To synchronize a segment's value with another eld's value whenever it changes, specify the derivation value to be the
exeld parameter from which to derive the aribute's value. Whenever the parameter value changes, the aribute's
value is changed to match. If you derive an aribute from a parameter, consider making the aribute read-only, as
values entered by users are lost whenever the parameter value changes. When seing a default value or deriving a
default value from a parameter, only those aributes designated by development as parameters are available for
selection. Dierent combinations of making the segments read only or editable in combination with the default or
derivation value or both, have dierent eects.

If your segment's default type is Groovy, you can set the Groovy expression you need using the expression builder. To
open the expression builder, select Groovy Expression as your Default Type and click the Groovy Expression Builder
icon. But you should know that Groovy defaulting doesn't support derivation when a dependent parameter changes.
The expression is evaluated only at segment creation.

The following table maps these dierent combinations. Initial runtime action corresponds to the row for the aribute
value being created in the entity table. If the default value is read only, it can't subsequently be changed through the
user interface. If the default value isn't read only, users can modify it. However, if the segment value is a derived value, a
user-modied segment value is overwrien when the derivation value changes.

Default Type Default value Derivation value Initial runtime action Runtime action after
specied? specied? parameter changes

None No Yes No initial segment The changed


      value parameter derivation
  value updates segment
value
 

Constant Yes No Default segment value N/A


         

Constant Yes Yes Default segment value The changed


        parameter derivation
value updates segment
value
 

Parameter Yes No The default N/A


      segment value is the  
parameter's default
value
 

Parameter Yes Yes, and same as The default The changed


    default value segment value is the parameter derivation

125
Oracle Applications Cloud Chapter 6
Conguring and Extending Applications Flexelds

Default Type Default value Derivation value Initial runtime action Runtime action after
specied? specied? parameter changes

  parameter's default value updates segment


and derivation value value
   

Parameter Yes Yes, and dierent from The default The changed
    default value segment value is the parameter default
  parameter's default value doesn't update
value segment value. Only
  the changed derivation
value updates the
segment value.
 

Groovy Expression Yes N/A The default value Groovy expressions


      of the segment are evaluated only
is determined by at segment creation.
evaluating the groovy They're not evaluated
expression. when a dependent
  parameter is modied.
 

SQL Yes No The default segment N/A


      value is the value  
returned by executing
SQL statement
 

SQL Yes Yes The default segment The changed


      value is the value parameter derivation
returned by executing value updates segment
SQL statement value
   

Flexeld Usages
The exeld usage species the table with which the exeld and its segments are associated. A exeld can have
multiple usages. However, the rst table registered for a exeld indicates the master usage. Segments are based
on the master usage. Other usages of the same table for the same exeld use the same segment setup, though the
column names may have a dierentiating prex.
On the Manage Descriptive Flexelds and Manage Extensible Flexelds pages, click the Show Entity Usages icon for
a specic exeld to view its entity usage. On the Manage Value Sets page, you can view the exeld usages for a
selected value set.

Extensible Flexelds
For extensible exeld contexts, you can congure a dierent usage. The use of an extensible exeld context
determines the scenarios or user interfaces in which the segments of a context appear to users. For example, the
Supplier page displays an extensible exeld's supplier usage and the Buyer page for the same exeld displays the
buyer usage. Then, a context that is associated only with the supplier usage appears only on the Supplier page and not
on the Buyer page.

126
Oracle Applications Cloud Chapter 6
Conguring and Extending Applications Flexelds

Value Sets
The use of value sets species the exelds having segments where the identied value set is assigned.

FAQs for Flexeld Management


How can I access predened exelds?
Search for predened exelds using the manage exelds tasks.
1. In the Setup and Maintenance work area, go to any of the following tasks:
◦ Manage Descriptive Flexelds
◦ Manage Extensible Flexelds
◦ Manage Key Flexelds
2. On the page for the type of exeld you're looking for, enter any of the search parameters and click Search.
Tip: If you don't know the exeld name or the code, use the Module eld to lter search results.

3. Click a exeld to view its details.


For conguration that's not available through the manage exelds tasks and the UI, contact My Oracle Support at
hps://support.oracle.com.

Related Topics
• Update Existing Setup Data

Why can't I edit my exeld or value set conguration?


Your exeld or value set conguration may be protected. Application developers mark some congurations as
protected, indicating that you can't edit them.
Some examples of congurations that may be protected are:
• Descriptive exelds
• Extensible exeld contexts
• Extensible exeld pages
• Value sets

Why did my page not display any exeld?


For a exeld to be available on the page, it must be registered by developers and also deployed. The segments appear
on the page only after you have successfully deployed the exeld.
A exeld's deployment status indicates whether the exeld segments are available to users. The exeld segments
that users see at run time correspond to the exeld denition last deployed successfully.

For information about registering exelds, see the Oracle Fusion Applications Developer's Guide. Some business
objects aren't designed to support exelds. For information about how to enable business objects with exeld
capability, see Geing Started with Flexelds in the Oracle Fusion Applications Developer's Guide.

Note: Oracle Engagement Cloud doesn't support exelds.

127
Oracle Applications Cloud Chapter 6
Conguring and Extending Applications Flexelds

To add aributes to these applications, you may use Application Composer. For more information, see the product-
specic documentation.

Why did my exeld changes not appear in the runtime UI?


The ADF business components or artifacts of a exeld, which are generated into an Oracle Metadata Services (MDS)
Repository when the exeld is deployed, are cached within a user session. You must sign out and sign back in again to
view exeld denition changes reected in the runtime application user interface page.

How can I enable exeld segments for Oracle Social Network Cloud Service?
When you manage Oracle Social Network Objects during setup and maintenance, search for the business object that
includes descriptive exelds. Select the aributes that are dened as exeld segments and enable them.

Flexeld Deployment
Overview of Flexeld Deployment
Deployment generates or refreshes the Application Development Framework (ADF) business component objects
that render the exeld in a user interface. The deployment process adds user-dened aributes to the Web Services
Description Language (WSDL) schemas exposed by Oracle ADF services and used by SOA composites. Flexelds are
deployed for the rst time during the application provisioning process. After you congure or change a exeld, you
must deploy it to make the latest denition available to users.
If a descriptive exeld is enabled for business intelligence, the deployment process redeploys the exeld's business
intelligence artifacts.

You can deploy a exeld to a sandbox for testing or to the mainline metadata for use in a test or production run time
environment. You can deploy extensible exelds as a background process.

After deployment, the user-dened aributes are available for incorporating into the SOA infrastructure, such as
business process and business rule integration. For example, you can now write business rules that depend on the user-
dened aributes. You must sign out and sign back in to Oracle Applications Cloud to see the changes you deployed at
run time.

The following aspects are important in understanding exeld deployment:

• Deployment Status
• Initial Deployment Status
• Metadata Validations
• Metadata Synchronization
• Deployment as a Background Process
• Export of Artifacts from Flexeld MDS

Deployment Status
Every exeld has a deployment status. Check the deployment status of your exeld after patching. The following
table lists the dierent deployment statuses a exeld can have.

128
Oracle Applications Cloud Chapter 6
Conguring and Extending Applications Flexelds

Deployment Status Meaning

Edited The exeld metadata denition hasn't been deployed yet. Updates of the metadata denition
  aren't applied in the run time environment yet.
 

Patched The exeld metadata denition has been modied through a patch or a data migration
  action, but the exeld hasn't yet been deployed. So, the updated denition isn't reected in
the run time environment.
 

Deployed to Sandbox The current metadata for the exeld is deployed in ADF artifacts and available as a exeld-
  enabled sandbox. The status of the sandbox is managed by the Manage Sandboxes dialog box
available in the Seings and Actions menu.
 

Deployed The current metadata for the exeld is deployed in ADF artifacts and available to users. No
  changes have been made to the exeld after being deployed to the mainline metadata.
 

Error The deployment aempt in the mainline metadata failed.


   

Note: Whenever a value set denition changes, the deployment status of a exeld that uses that value
set changes to edited. If the change results from a patch, the deployment status of the exeld changes to
patched.

Initial Deployment Status of Flexelds


The Oracle Applications Cloud implementation loads exeld metadata into the database. This initial load sets
the exeld status to Edited. During installation, the application provisioning process deploys the exelds of the
provisioned applications, seing their status to Deployed if no errors occur.
In a provisioned application, deployed exelds are ready to use. In some cases, exeld availability at run time requires
setup, such as dening key exelds.

Metadata Validation
Use the Validate Metadata command to view possible metadata errors before aempting to deploy the exeld.
Metadata validation is the initial phase of all exeld deployment commands. By successfully validating metadata
before running the deployment commands, you can avoid failures in the metadata validation phase of a deployment
aempt. The deployment process ends if an error occurs during the metadata validation phase. Metadata validation
results don't aect the deployment status of a exeld.

Metadata Synchronization
When an extensible or descriptive exeld is deployed, the deployment process regenerates the XML schema denition
(XSD). As a result, the user-dened aributes are available to web services and the SOA infrastructure.
After deploying a exeld conguration, you must synchronize the updated XML schema denition (XSD) les in the
MDS repositories for each SOA application.

Note: To synchronize the updated XSD les in the MDS repositories in Oracle Cloud implementations, log a
service request using My Oracle Support at hp://support.com/

129
Oracle Applications Cloud Chapter 6
Conguring and Extending Applications Flexelds

Deployment as a Background Process


You can deploy extensible exelds oine as a background process and continue working in the session without having
to wait for the deployment to complete. You can queue up several extensible exelds and deploy as a background
process. The exelds are deployed, one at a time, in the order that you deploy them to the queue. You must deploy
extensible exelds with more than 30 categories as a background process.
You can remove an extensible exeld from the deployment queue with the Cancel Background Deployment command.
When an extensible exeld is deployed in a background process, its oine status indicates that the exeld is in a
background deployment process. A exeld's oine status is cleared and its deployment status updated when the
background deployment process has completed.

Export of Artifacts from Flexeld MDS


You can export business components from MDS for descriptive, extensible, or key exelds, mainly for use in
troubleshooting issues with exelds. Use Download Flexeld Archive on the Manage Flexelds page to export MDS
artifacts of the selected exeld, and import them to an archive on your local computer. You can use these archived
business components of exelds for troubleshooting purposes.
Alternatively, export the deployed artifacts using exportMetadata WLST.

How Flexeld Deployment Status is Calculated


Flexeld deployment status indicates how the exeld metadata denition in the Oracle Applications Cloud database
relates to the Application Development Framework (ADF) business components residing in an Oracle Metadata Services
(MDS) Repository.
The following aspects are important in understanding how exeld deployment status is calculated:

• Seings that aect exeld deployment status


• How deployment status is calculated

Seings That Aect Flexeld Deployment Status


If you have made a change to a exeld and expect a changed deployment status, ensure that you have saved your
changes. No seings aect exeld deployment status.

How Deployment Status Is Calculated


If the exeld denition has been edited through the Dene Flexelds activity task ows, the status is Edited. The latest
exeld metadata denition diverges from the latest deployed exeld denition. Any change, including if a value set
used in a exeld changes, changes the deployment status to Edited. If a exeld has never been deployed, its status is
Edited.

Note: When an application is provisioned, the provisioning framework aempts to deploy all exelds in that
application.

If you deploy the exeld to a sandbox successfully, the status is Deployed to Sandbox. The latest exeld metadata
denition in the application matches with the metadata denition that generated ADF business components in a
sandbox MDS Repository. Whether the sandbox is active or not doesn't aect the deployment status. If the exeld was
deployed to a sandbox and hasn't been edited or redeployed to the mainline metadata since then, the status remains
Deployed to Sandbox independent of whether the sandbox is active, or who is viewing the status.

130
Oracle Applications Cloud Chapter 6
Conguring and Extending Applications Flexelds

If you deploy the exeld successfully to the mainline metadata, the status is Deployed. The latest exeld metadata
denition in the application matches the metadata denition that generated ADF business components in a mainline
MDS Repository. Change notications are sent when a exeld is deployed successfully to the mainline metadata.
If either type of deployment fails and that the current exeld denition isn't deployed, the status is Error. The
deployment error message gives details about the error. The latest exeld metadata denition in the application likely
diverges from the latest successfully deployed exeld denition.

If the exeld denition has been modied by a patch, the status is Patched. The latest exeld metadata denition in
the application diverges from the latest deployed exeld denition. If the exeld denition was Deployed before the
patch and then a patch was applied, the status changes to Patched. If the exeld denition was Edited before the patch
and then a patch was applied, the status remains at Edited to reect that there are still changes (outside of the patch)
that aren't yet in eect.

When a deployment aempt fails, you can access the Deployment Error Message for details.

How Deploying a Flexeld-Enabled Sandbox Works with Mainline


Metadata
The exeld denition in a sandbox corresponds to the exeld metadata denition in the Oracle Applications Cloud
database at the time the exeld was deployed to the sandbox. When the exeld is ready for end users, the exeld
must be deployed to the mainline metadata.
A exeld-enabled sandbox uses the following components.

• Flexeld metadata in the Oracle Applications Cloud database


• Flexeld business components in a sandbox Oracle Metadata Services (MDS) repository
• User interface modications for the exeld in the mainline MDS repository

The following gure shows the two types of deployment available in the Manage Flexeld tasks of the Dene Flexelds
activity. Deploying a exeld to a sandbox creates a sandbox MDS Repository for the sole purpose of testing exeld
behavior. The sandbox is only accessible to the administrator who activates and accesses it, not to users generally.
Deploying a exeld to the mainline metadata applies the exeld denition to the mainline MDS Repository where
it is available to end users. After deploying the exeld to the mainline metadata, modify the page where the exeld

131
Oracle Applications Cloud Chapter 6
Conguring and Extending Applications Flexelds

segments appear. Modications done to the page in the sandbox MDS Repository cannot be published to the mainline
MDS Repository.

Access
Deploy flexfield to
sandbox to
sandbox.
test flexfield.
Flexfield
Metadata in Yes
Flexfield Business
Oracle Fusion
Components in Metadata
Applications
Services (MDS) Flexfield-
Database
Test in sandbox? Repository Sandbox enabled
Sandbox

Define
Flexfields

Deploy flexfield for


other users? Flexfield Business
Deployed
Components in Metadata
Flexfield
Services (MDS)
Yes Repository Mainline
Flexfield
Definition Access
Deploy flexfield.
mainline.

MDS
Modifications?

Modifications in Metadata Yes


Services Repository
(MDS) Mainline

Sandbox Metadata Services Repository Data


Deploying the exeld to a sandbox generates the Application Development Framework (ADF) business components of
a exeld in a sandbox MDS Repository for testing in isolation.

Caution: Don't modify exeld segment display properties using Page Composer in a exeld-enabled
sandbox as these changes will be lost when deploying the exeld to the mainline metadata.

132
Oracle Applications Cloud Chapter 6
Conguring and Extending Applications Flexelds

Mainline Metadata Services Repository Data


The Oracle Fusion Applications database stores the single source of truth about a exeld. When the exeld is
deployed, the ADF business component objects that implement the exeld in the run time user interface are generated
in the mainline MDS Repository from this source.

Related Topics
• How You Manage Congurations in Classic Sandboxes

Considerations for Deploying a Flexeld to a Sandbox


Deploying a exeld to a sandbox creates a exeld-enabled sandbox. Each exeld-enabled sandbox contains only
one exeld.
You can test the run time behavior of a exeld in the exeld-enabled sandbox. If changes are needed, you return to
the Dene Flexeld tasks to change the exeld denition.

When you deploy a exeld to sandbox, the process reads the metadata about the segments from the database,
generates exeld Application Development Framework (ADF) business component artifacts based on that denition,
and stores in the sandbox only the generated artifacts derived from the denition.

When you deploy a exeld sandbox, the process generates the name of the exeld sandbox, and that exeld
sandbox is set as your current active sandbox. When you next sign in to the application, you can see the updated
exeld congurations. The Oracle Applications Cloud global header displays your current session sandbox.

Note: Unlike a standalone sandbox created using the Manage Sandboxes dialog box, the sandbox deployed
for a exeld contains only the single exeld. You can manage exeld sandboxes, such as seing an
existing exeld sandbox as active or deleting it, using the Manage Sandboxes dialog box.

When you deploy a exeld to the mainline metadata after having deployed it to the sandbox, the sandbox-enabled
exeld is automatically deleted.

Sandbox MDS Repository Data


The sandbox data lets you test the exeld in isolation without rst deploying it in the mainline metadata where it could
be accessed by users.
Caution: Don't modify exeld segment display properties using Page Composer in a exeld-enabled
sandbox as these changes will be lost when deploying the exeld to the mainline metadata.

Managing a Flexeld-Enabled Sandbox


When you deploy a exeld as a sandbox, that exeld-enabled sandbox automatically gets activated in your user
session. When you sign back in to see the changes, the sandbox is active in your session.
You can only deploy a exeld to a sandbox using the Dene Flexelds task ow pages.

You also can use the Manage Sandboxes dialog box in the Administrator menu of the Setup and Maintenance work area
to activate and access a exeld-enabled sandbox.

Note: Whether you use the Dene Flexelds or Manage Sandboxes task ows to access a exeld-enabled
sandbox, you must sign out and sign back in before you can see the changes you deployed in the run time.

133
Oracle Applications Cloud Chapter 6
Conguring and Extending Applications Flexelds

You cannot publish the exeld from the sandbox to the mainline metadata. You must use the Dene Flexelds task
ow pages to deploy the exeld for access by users of the mainline metadata because the exeld conguration in the
mainline metadata is the single source of truth.

Related Topics
• How You Manage Congurations in Classic Sandboxes

Value Sets
Overview of Value Sets
A value set is a group of valid values that you assign to a exeld segment to control the values that are stored for
business object aributes.
A user enters a value for an aribute of a business object while using the application. The exeld validates the value
against the set of valid values that you congured as a value set and assigned to the segment.

For example, you can dene a required format, such as a ve-digit number, or a list of valid values, such as green, red,
and blue.

Flexeld segments are usually validated, and typically each segment in a given exeld uses a dierent value set. You
can assign a single value set to more than one segment, and you can share value sets among dierent exelds.

Note: Ensure that changes to a shared value set are compatible with all exelds segments using the value
set.

The following aspects are important in understanding value sets:


• Managing value sets
• Validation
• Security
• Precision and scale
• Usage and deployment
• Protected value set data

Managing Value Sets


To open the Manage Value Sets page, use the Manage Value Sets task. You can also use the Manage Descriptive
Flexelds and Manage Extensible Flexelds tasks for conguring a segment, including its value set. To open the
Manage Values page, select the value set from the Manage Value Sets page, and click Manage Values. Alternatively,
click Manage Values from the Edit Value Set page.

Validation
The following types of validation are available for value sets:
• Format only, where users enter data instead of selecting values from a list
• Independent, a list of values consisting of valid values you specify
• Dependent, a list of values where a valid value derives from the independent value of another segment

134
Oracle Applications Cloud Chapter 6
Conguring and Extending Applications Flexelds

• Subset, where the list of values is a subset of the values in an existing independent value set
• Table, where the values derive from a column in an application table and the list of values is limited by a
WHERE clause

A segment that uses a format only value set doesn't present a list of valid values to users. If required, you may add table
validated value sets to the list of available value sets available for conguration.

Note: For the Accounting Key Flexeld value sets, you must use independent validation only. If you use other
validations, you can't use the full chart of accounts functionality, such as data security, reporting, and account
hierarchy integration.

Security
Value set security only works in conjunction with usage within exeld segments. You can specify that data security be
applied to the values in exeld segments that use a value set. Based on the roles provisioned to users, data security
policies determine which values of the exeld segment users can view or modify.
The application of value set security has the following conditions:

• At the value set level: The value set is the resource secured by data security policies. If a value set is secured,
every usage of it in any exeld is secured. Disabling security for individual usages of the same value set isn't
possible.
• Applies to independent, dependent, or table-validated value sets.
• Applies mainly when data is being created or updated, and to key exeld combinations tables for query
purposes. Value set security doesn't determine which descriptive exeld data is shown upon querying.
• Security conditions dened on value sets always use table aliases. When lters are used, table aliases are always
used by default. When predicates are dened for data security conditions, make sure that the predicates also
use table aliases.

For key exelds, the aributes in the view object corresponding to the account combination ID, structure instance
number (SIN), and data set number (DSN) can't be transient. They must exist in the database table. For key exelds,
the SIN segment is the discriminator aribute, and the account combination segment is the common aribute.

Precision and Scale


If the data type of a value set is Number, you can specify the precision (maximum number of digits user can enter) or
scale (maximum number of digits following the decimal point).

Usage and Deployment


The usage of a value set is the exelds where that value set is used. The deployment status of exelds in which the
value set is used indicates the deployment status of the value set instance.

135
Oracle Applications Cloud Chapter 6
Conguring and Extending Applications Flexelds

The following gure shows a value set used by a segment in a key exeld and the context segment of a descriptive
exeld.

For most value sets, when you enter values into a exeld segment, you can enter only values that already exist in the
value set assigned to that segment.

Global and context-sensitive segment require a value set. You can assign a value set to a descriptive exeld context
segment. If you specify only context values, not value sets for contexts, the set of valid values is equal to the set of
context values.

Protected Value Set Data


Application developers may mark some value sets as protected, indicating that you can't edit them.

You can edit only value sets that are not marked as protected. You can't edit or delete protected value sets. If the value
set type supports values (such as independent, dependent or subset value sets), then you can't add, edit, or delete
values.

136
Oracle Applications Cloud Chapter 6
Conguring and Extending Applications Flexelds

Note: References to protected value sets aren't restricted. Value sets, protected or not, may be assigned
to any exeld segment. Likewise, other value sets may reference protected value sets; for example, an
unprotected dependent value set may reference a protected independent value set.

Related Topics
• Chart of Accounts Components
• What's the dierence between a lookup type and a value set

Validation Type Options for Value Sets


Validation and usage of value sets determine where and how users access valid values for aributes represented by
exeld segments.
Tip: As a exeld guideline, dene value sets before conguring the exeld, because you can assign value
sets to each segment as you congure a exeld. With descriptive and extensible exeld segments, you can
create value sets when adding or editing a segment on the run time page where the exeld appears.

The following aspects are important in dening value sets:


• Value sets for context segments
• Format-only validation
• Interdependent value sets
• Table validation
• Range
• Security
• Testing and maintenance

Value Sets for Context Segments


When assigning a value set to a context segment, you can only use table-validated or independent value sets.
You can use only table and independent value sets to validate context values. The data type must be character and
the maximum length of the values being stored must not be larger than the context's column length. If you use a table
value set, the value set can't reference exeld segments in the value set's WHERE clause, other than the exeld
segment to which the value set is assigned.

Format Only Validation


The format only validation type enables users to enter any value, as long as it meets your specied formaing rules. The
value must not exceed the maximum length you dene for your value set, and it must meet any format requirements
for that value set.
For example, if the value set permits only numeric characters, users can enter the value 456 (for a value set with
maximum length of three or more), but can't enter the value ABC. A format only value set doesn't otherwise restrict the
range of dierent values that users can enter. For numeric values, you can also specify if a numeric value should be zero
lled or how may digits should follow the radix separator.

Interdependent Value Sets


Use an independent value set to validate data against a list that isn't stored in an application table, and not dependent
on a subset of another independent value set. You can't specify a dependent value set for a given segment without

137
Oracle Applications Cloud Chapter 6
Conguring and Extending Applications Flexelds

having rst dened an independent value set that you apply to another segment in the same exeld. Use a dependent
value set to limit the list of values for a given segment based on the value that the user has dened for a related
independent segment. The available values in a dependent list and the meaning of a given value depend on which value
was selected for the independently validated segment.
For example, you could dene an independent value set of the states in the USA with values such as CA, NY, and so on.
Then you dene a dependent value set of cities in the USA with values such as San Francisco and Los Angeles that are
valid for the independent value CA. Similarly, New York City and Albany are valid for the independent value NY. In the
UI, only the valid cities can be selected for a given state.

Because you dene a subset value set from an existing independent value set, you must dene the independent value
set rst. Users don't have to select a value for another segment rst to have access to the subset value set.

Independent, dependent, and subset value sets require a user-dened list of valid values. Use the Manage Values page
to create and manage a value set's valid values and the order in which they appear.

Tip: You can congure the Manage Value Sets page to capture additional aributes for each valid value by
adding context-sensitive segments in a new context for FND_VS_VALUES_B descriptive eld.

Table Validation
Typically, you use a table-validated set when the values you want to use are already maintained in an application table,
such as a table of supplier names. Specify the table column that contains the valid value. You can optionally specify the
description and ID columns, a WHERE clause to limit the values to use for your set, and an ORDER BY clause.
If you specify an ID column, then the exeld saves the ID value, instead of the value from the value column, in the
associated exeld segment. If the underlying table supports translations, you can enable the display of translated
text by basing the value set's value column on a translated aribute of the underlying table. You should also dene
an ID column that's based on an aribute that isn't language-dependent so that the value's invariant ID (an ID that
doesn't change) is saved in the transaction table. The run time displays the corresponding translated text from the value
column for the run time session's locale.

Table validation lets you enable a segment to depend on multiple prior segments in the same context structure. You
can't reference other exeld segments in the table-validated value set's WHERE clause. Which means, the WHERE
clause can't reference SEGMENT.segment_code or VALUESET.value_set_code.

Table-validated value sets have unique values across the table, irrespective of bind variables. The WHERE clause
fragment of the value set is considered if it doesn't have bind variables. If it has bind variables, the assumption is that
the values are unique in the value set. If you use table validated value sets for key exelds, then you can't use all
integration options supported for key exelds, such as:
• Data security
• Oracle Transactional Business Intelligence (OTBI)
• Extended Spread Sheet Database (ESSbase)
• Tree or hierarchy integration

To use these integration options for key exelds, you must use independent value sets only.

Range
In the case of format, independent, or dependent value sets, you can specify a range to limit which values are valid. You
can specify a range of values that are valid within a value set. You can also specify a range validated pair of segments
where one segment represents the low end of the range and another segment represents the high end of the range.
For example, you might specify a range for a format-only value set with format type Number where the user can enter
only values between 0 and 100.

138
Oracle Applications Cloud Chapter 6
Conguring and Extending Applications Flexelds

Security
In the case of independent and dependent values, you can specify that data security be applied to the values in
segments that use a value set. Based on the roles provisioned to users, data security policies determine which values of
the exeld segment users can view or modify.
To enable security on a value set, specify a database resource, typically the code value for the value set. Using the
Manage Database Security Policies task, specify conditions, such as lters or SQL predicates, and policies that associate
roles with conditions. You can use a lter for simple conditions. For more complex conditions, use a SQL predicate.

Value set data security policies and conditions dier from data security conditions and policies for business objects in
the following ways:
• You can grant only read access to users. You can't specify any other action.
• When dening a condition that's based on a SQL predicate, use VALUE, VALUE_NUMBER, VALUE_DATE,
VALUE_TIMESTAMP, or VALUE_ID to reference the value from a dependent, independent, or subset value set.
For table value sets, use a table alias to dene the table, such as &TABLE_ALIAS category=70.

When you enable security on table-validated value sets, the security rule that's dened is absolute and not contingent
upon the bind variables (if any) that may be used by the WHERE clause of the value set. For example, suppose a table-
validated value set has a bind variable to further lter the value list to x, y and z from a list of x, y, z, xx, yy, zz. The data
security rule or lter wrien against the value set must not assume anything about the bind variables. Instead the whole
list of values must be available and you write the rule, for example, to permit x, or to permit y and z. By default in data
security, all values are denied and show only rows to which access has been provided.

Testing and Maintenance


You don't have to dene or maintain values for a table-validated value set, as the values are managed as part of the
referenced table or independent value set, respectively.
You can't manage value sets in a sandbox.

When you change an existing value set, the deployment status for all aected exelds changes to Edited. You must
redeploy all exelds that use that value set to make the exelds reect the changes. In the UI pages for managing
value sets, the value set's usages show which exelds are aected by the value set changes.

If your application has more than one language installed, or there is any possibility that you might install one or
more additional languages for your application in the future, select Translatable. This doesn't require you to provide
translated values now, but you can't change this option if you decide to provide them later.

Considerations for Planning Value Sets


The value sets you create and congure depend on the valid values on the business object aributes that will use the
value set. When creating value sets, you rst give the value set a name and description, and then dene the valid values
of the set.

The following aspects are important in planning value sets:


• List of values
• Plain text
• Value ranges
• Value format specication
• Security

139
Oracle Applications Cloud Chapter 6
Conguring and Extending Applications Flexelds

List of Values
You can use one of the following types of lists to specify the valid values for a segment:
• Table column
• User-dened list. Also include a sub list.
• Dependent user-dened list

If the valid values exist in a table column, use a table value set to specify the list of values. To limit the valid values to a
subset of the values in the table, use a SQL WHERE clause. Table value sets also provide some advanced features, such
as enabling validation depending on other segments in the same structure.

Use an independent value set to specify a user-dened set of valid values. For example, you can use an independent
value set of Mon, Tue, Wed, and so forth to validate the day of the week. You can also specify a subset of an existing
independent value set as the valid values for a segment. For example, if you have an independent value set for the days
of the week, then a weekend subset can comprise entries for Saturday and Sunday.

Use a dependent value set when the available values in the list and the meaning of a given value depend on which
independent value was selected for a previously selected segment value. For example, the valid holidays depend on
which country you are in. A dependent value set is a collection of value subsets, with one subset for each value in a
corresponding independent value set.

For lists of values type value sets, you can additionally limit the valid values that an end user can select or enter
by specifying format, minimum value, and maximum value. For list of values type value sets, you can optionally
implement value set data security. If the applications are running in dierent locales, you might need to provide
dierent translations for the values and descriptions.

Plain Text
Use a format-only value set when you want to allow users to enter any value, as long as that value conforms to
formaing rules. For example, if you specify a maximum length of 3 and numeric-only, then end users can enter 456,
but not 4567 or 45A. You can also specify the minimum and maximum values, whether to align the text to either side,
and whether to zero-ll. With a format-only value set, no other types of validation are applied.

Value Ranges
You can use either a format-only, independent, or dependent value set to specify a range of values. For example, you
might create a format-only value set with Number as the format type where the end user can enter only the values
between 0 and 100. Or, you might create a format-only value set with Date as the format type where the end user can
enter only dates for a specic year, such as a range of 01-JAN-93 to 31-DEC-93. Because the minimum and maximum
values enforce these limits, you need not dene a value set that contains each of these individual numbers or dates.

Value Format
Flexeld segments commonly require some kind of format specication, regardless of validation type. Before creating a
value set, consider how you will specify the required format.
The following table shows options for validation type and value data type.

Option Description

Value data type Character, Number, Date, Date Time.


   

Value subtype Text, Translated text, Numeric digits only, Time (20:08), Time (20:08:08).
   

140
Oracle Applications Cloud Chapter 6
Conguring and Extending Applications Flexelds

Option Description

An additional data type specication for the Character data type for the Dependent,
Independent, and Format validation types.
 

Maximum length Maximum number of characters or digits for Character data type.
   

Precision Maximum number of digits the user can enter.


   

Scale Maximum number of digits that can follow the decimal point.
   

Uppercase only Lowercase characters automatically changed to uppercase.


   

Zero ll Automatic text alignment and zero-lling of entered numbers (aects values that include only
  the digits 0-9).
 

Note: You cannot change the text value data type to a translated text value subtype after creating a value set.
If there is any chance you may need to translate displayed values into other languages, choose Translated
text. Selecting the Translated text subtype doesn't require you to provide translated values.

Value Sets for Context Segments


You can use only table and independent value sets to validate context values. The data type must be character and
the maximum length of the values being stored must not be larger than the context's column length. If you use a table
value set, the value set cannot reference exeld segments in the value set's WHERE clause other than the exeld
segment to which the value set is assigned.

Security
When enabling security on a value set, the data security resource name is an existing value set or one that you want to
create. The name typically matches the code value for the value set. You cannot edit the data security resource name
after you save your changes.

Related Topics
• What's the dierence between a lookup type and a value set

Considerations for Bind Variables in Table-Validated Value Sets


After you assign a value set to a exeld, you can use bind variables in the WHERE clause.

These bind variables refer to exeld elements:


• :{SEGMENT.<segment_code>}

• :{CONTEXT.<context_code>;SEGMENT.<segment_code>}

• :{VALUESET.<value_set_code>}

• :{FLEXFIELD.<internal_code>}

• :{PARAMETER.<parameter_code>}

141
Oracle Applications Cloud Chapter 6
Conguring and Extending Applications Flexelds

Segment Code
:{SEGMENT.<segment_code>}

This bind variable refers to the ID or value of a segment where <segment_code> identies the segment. Where referring
to the ID, the value set is ID-validated. Where referring to the value, the value set isn't ID-validated. The data type of the
bind value is the same as the data type of the segment's column.

For both descriptive and extensible exelds, the segment must be in the same context as the source segment. The
source segment contains the WHERE clause. For descriptive exelds, if the segment is global, then the source segment
must be global.

The segment must have a sequence number that's less than the sequence number of the target segment with this bind
variable. A matching segment must exist in the current exeld context.

This bind variable is useful when the set of valid values depends on the value in another segment. For example, the
values to select from a CITIES table might depend upon the selected country. If SEGMENT1 contains the country value,
then the WHERE clause for the CITIES table might be <country_code> = :{SEGMENT.SEGMENT1}.

Context Code
:{CONTEXT.<context_code>;SEGMENT.<segment_code>}

This bind variable, which is valid only for extensible exelds, refers to the ID (if the value set is ID-validated) or value
(if not ID-validated) of a segment that's in a dierent context than the target segment (the segment with the WHERE
clause).
• The <context_code> identies the context and must be in the same category or in an ancestor category. It can't
be a multiple-row context.
• The <segment_code> identies the segment. The data type of the bind value is the same as the data type of the
segment's column.

Note: The target segment should appear in the UI after the source segment to ensure the source segment
has a value. If the target segment's context is a single-row context, the source and target segments must be
on separate pages and the target page must follow the source page.

The framework of extensible exelds doesn't perform any additional validation related to mismatched values for
segments dened with cross context bind parameters. Administrators must populate the correct pair of segment values.

This bind variable is useful when the set of valid values depends on the value of a segment in another context. For
example, the values to select from a CERTIFICATION table for a segment in the Compliance and Certication context
might depend on the value of the country segment in the Manufacturing context.

Value Set Code


:{VALUESET.<value_set_code>}

This bind variable refers to the ID (if the value set is ID-validated) or value (if not ID-validated) of the segment that's
assigned to the value set that's identied by the value_set_code. The data type of the bind value is the same as the data
type of the segment's column.

The segment must have a sequence number that's less than the sequence number of the segment with this bind
variable. If more than one segment is assigned to the value set, the closest prior matching segment will be used to
resolve the bind expression. A matching segment must exist in the current exeld context.

This bind variable is useful when the set of valid values depends on the value in another segment and that segment
code can vary, such as when the value set is used for more than one context or exeld. For example, the values

142
Oracle Applications Cloud Chapter 6
Conguring and Extending Applications Flexelds

to select from a CITIES table might depend upon the selected country. If the value set for the segment that
contains the country value is COUNTRIES, then the WHERE clause for the CITIES table might be <country_code> = :
{VALUESET.COUNTRIES}.

Flexeld Internal Code


:{FLEXFIELD.<internal_code>}

This bind variable refers to an internal code of the exeld in which the value set is used, or to a validation date. The
internal_code must be one of the following:
• APPLICATION_ID - the application ID of the exeld in which this value set is used. The data type of
APPLICATION_ID and its resulting bind value is NUMBER.
• DESCRIPTIVE_FLEXFIELD_CODE - the identifying code of the exeld in which this value set is used. The data
type of DESCRIPTIVE_FLEXFIELD_CODE and its resulting bind value is VARCHAR2. Note that you use this string
for both descriptive and extensible exelds.
• CONTEXT_CODE - the context code of the exeld context in which this value set is used. The data type of
CONTEXT_CODE and its resulting bind value is VARCHAR2.
• SEGMENT_CODE - the identifying code of the exeld segment in which this value set is used. The data type of
SEGMENT_CODE and its resulting bind value is VARCHAR2.
• VALIDATION_DATE - the current database date. The data type of VALIDATION_DATE and its resulting bind
value is DATE.

Flexeld Parameters
:{PARAMETER.<parameter_code>}

This bind variable refers to the value of a exeld parameter where parameter_code identies the parameter. The data
type of the resulting bind value is the same as the parameter's data type.

Note: You can't assign a table value set to a context segment if the WHERE clause uses
VALUESET.value_set_code or SEGMENT.segment_code bind variables.

Create Table-Validated Value Sets Based on Lookups


In an application user interface, you want to display a list of values that customers use to enter satisfaction scores. The
value column name is 1, 2, 3, 4, 5 and the value column description is Extremely Satised, Satised, and so on. Users can
select the appropriate value or description which stores the corresponding name so the name value can be used in a
calculation expression.
In this case, you can use the FND_LOOKUPS table as the basis for a table-validated value set. The lookup meaning
corresponds to the Value Column Name and the lookup description corresponds to the Description Column Name. The
following table lists the properties of the value set.

Property Value

FROM clause FND_LOOKUPS


   

WHERE clause lookup_type = 'CN_ XX_ CUST_ SATISFACT_ SCORE'


   

143
Oracle Applications Cloud Chapter 6
Conguring and Extending Applications Flexelds

Property Value

ID column lookup_code
   

Value column meaning


   

Description column description


   

Enable column enabled_ag


   

Start Date column start_ date_active


   

End Date column end_ date_active


   

Order by display_ sequence


   

After completing this task, you should have created your customer satisfaction value set for the Incentive
Compensation page of your implementation project.

Creating a Value Set Based on a Lookup


1. From the Setup and Maintenance work area, open the Manage Value Sets task and click the Go to Task icon
buon.
2. On the Manage Value Sets page, click the Create icon buon.
3. On the Create Value Set page, enter the following values:
a. In the Value Set Code eld, enter CN_XX_CUSTOMER_SATISFACTION_SCORES
b. In the Description eld, enter Customer satisfaction score.
c. In the Module eld, select Search
d. In the Search and Select: Module subwindow, enter Incent in the User Module Name eld
e. Select Incentive Compensation.
f. Click OK.
4. On the Create Value Set page, enter the following values:
a. In the Validation Type eld, select Table.
b. In the Value Data Type eld, select Character.
c. In the Denition section FROM Clause eld, enter FND_LOOKUPS.
d. In the Value Column Name eld, enter DESCRIPTION.
e. In the Description Column Name eld, enter MEANING.
f. In the ID Column Name eld, enter LOOKUP_CODE.
g. In the Enabled Column Name eld, enter 'Y'.
h. In the Start Date Column Name eld, enter START_DATE_ACTIVE.
i. In the End Date Column Name eld, enter END_DATE_ACTIVE.
j. In the WHERE Clause eld, enter LOOKUP_TYPE = 'CN_XX_CUST_SATISFACT_SCORE'.
5. Click Save and Close.
6. In the Manage Value Sets page, click Done.

144
Oracle Applications Cloud Chapter 6
Conguring and Extending Applications Flexelds

Add Aributes to the Manage Value Sets Page


You can add aributes to independent, dependent, and subset value sets. The aributes appear on the Manage Value
Sets page where you can store additional information about each valid value. To display aributes on an application
page, you must programmatically modify the application.
To add aributes and subsequently view them on the Manage Value Sets page, perform the following steps:
1. Using the Manage Descriptive Flexelds task, nd the FND_VS_VALUES_B exeld and open it for editing.
2. Click Manage Contexts.
3. Create a new context and use the value set code for the context code.
4. Add new aributes as context-sensitive segments and save the changes.
5. Deploy FND_VS_VALUES_B to run time.
6. Sign out and sign back in.
7. Open the Manage Value Sets page to view the new aributes.

Import Value Set Values


You can import a le containing values that you want to edit or add to a given independent or dependent value set.
For example, uploading a hundred values may be more ecient than creating them individually using the Manage
Value Sets task. However, for just a few values, it may be quicker to perform the relevant tasks.

Importing Value Set Values


To import value set values:
1. Create a at le containing the values in the value set that you want to add or update.
Note:
◦ When creating the le, you must specify an existing value set code to which you want to
add values or edit existing values. If the value set does not exist, add the value set using the
appropriate Manage Value Sets setup task in the Setup and Maintenance work area.
◦ The le that you create must adhere to the formaing and content requirements for creating at
les containing value set values.
2. Upload the at le to the content repository using the File Import and Export page.
3. Import the le using the appropriate Manage Value Sets setup task in the Setup and Maintenance work area. To
import the le:
a. Click Actions > Import in the Manage Value Sets page.
b. In the File Name eld, enter the name of the at le you uploaded using the File Import and Export page.
c. In the Account eld, select the user account containing the at le.
d. Click Upload.
Note: Alternatively, you can import the le using either of the following methods:
◦ Run the Upload Value Set Values scheduled process.
◦ Use the Applications Core Metadata Import web service. For more information on the
Applications Core Metadata Import web service, see the SOAP Web Services guide for your cloud
services.

145
Oracle Applications Cloud Chapter 6
Conguring and Extending Applications Flexelds

Related Topics
• Overview of Files for Import and Export

Requirements for Flat Files to Upload Value Set Values


You can import large volumes of value set value data from the content repository. To upload value set values to the
content repository, create a at le containing the values in the value set that you want to add or update. You upload
these at les to the content repository using the File Import and Export page.

General Requirements
The rst line of the at le must contain the column names for the value set value data, including all mandatory
columns, and separated by the '|' (pipe) character. Each subsequent line should contain a row of data specied in the
same order as the column names, also separated by the '|' character.

The requirements for creating at les vary with the type of value sets:
• Independent value sets
• Dependent value sets

Independent Value Set


A at le for uploading values for independent value sets must contain the mandatory columns. The following table lists
the three mandatory columns and their data types.

Column Name Data Type

ValueSetCode VARCHAR2(60)
   

Value VARCHAR2(150)
   

Enabled Flag VARCHAR2(1), Y or N


   

Note: You can also specify optional columns.

Examples:
• To upload values to a COLORS independent value set with the minimum columns, you can use the following
at le:
ValueSetCode | Value | EnabledFlag
COLORS | Red | Y
COLORS | Orange | Y
COLORS | Yellow | Y

• To upload values to a STATES independent value set with more (optional) columns, you can use the following
at le:
ValueSetCode | Value | Description | EnabledFlag

146
Oracle Applications Cloud Chapter 6
Conguring and Extending Applications Flexelds

STATES | AK | Alaska | Y
STATES | CA | California | Y
STATES | WA | Washington | Y

Dependent Value Sets


A at le for uploading values for dependent value sets must contain the mandatory columns. The following table lists
the four mandatory columns and their data types.

Column Name Data Type

Value Set Code VARCHAR2(60)


   

Independent Value VARCHAR2(150)


   

Value VARCHAR2(150)
   

Enabled Flag VARCHAR2(1), Y or N


   

Note: You can also specify optional columns.

Example:

To upload values to a CITIES dependent value set (dependent on the STATES independent value set), you can use the
following at le:
ValueSetCode | IndependentValue | Value | EnabledFlag
CITIES | AK | Juneau | Y
CITIES | AK | Anchorage | Y
CITIES | CA | San Francisco | Y
CITIES | CA | Sacramento | Y
CITIES | CA | Los Angeles | Y
CITIES | CA | Oakland | Y

Additional Optional Columns


In addition to the mandatory columns, you can add optional columns. The following table lists the optional columns for
both dependent and independent value sets.

Column Name Type

Translated Value VARCHAR2(150), for use in value sets that are translatable
   

Description VARCHAR2(240)
   

Start Date Active DATE, formaed as YYYY-MM-DD


   

147
Oracle Applications Cloud Chapter 6
Conguring and Extending Applications Flexelds

Column Name Type

End Date Active DATE, formaed as YYYY-MM-DD


   

Sort Order NUMBER(18)


   

Summary Flag VARCHAR2(30)


   

Flex Value Aribute1 ... Flex Value VARCHAR2(30)


Aribute20  
 

User-dened Value Aribute1 . .. VARCHAR2(30)


User-dened Value Aribute10  
 

Related Topics
• Overview of Files for Import and Export

Upload Value Set Values Process


This process uploads a at le containing value set values for exelds. You can use the scheduled process to upload
a le containing values you want to edit or add to an existing independent or dependent value set. This process is
useful for adding or updating large volumes of value set value data in an automated or recurring fashion. For example,
you can upload a hundred values on a recurring basis when scheduled as a recurring process. This method could be
more ecient than using the Import action in the Manage Value Sets tasks in the Setup and Maintenance work area.
However, for a task of uploading a hundred values, it may be quicker to use the Import action in the relevant tasks.
Run this process from the Scheduled Processes Overview page. You can run it on a recurring basis whenever the at le
in the content repository account is updated.

You must create the at le containing the values data, and upload the at le to the content repository using the File
Import and Export page.

Parameters
Flat File Name

Enter the name of the at le you uploaded using the File Import and Export page.

Account

Select the user account containing the at le in the content repository to upload.

Related Topics
• Overview of Files for Import and Export
• Overview of Scheduled Processes

148
Oracle Applications Cloud Chapter 6
Conguring and Extending Applications Flexelds

Translation of Flexeld and Value Set Congurations


When you rst congure a exeld or segment, the translatable text that you enter, such as prompts and descriptions, is
stored as the text for all installed locales. You may then provide a translation for a particular locale. If you don't provide
a translation for a given locale, then the value that was rst entered is used for that locale.
To translate the text for a particular locale, sign in with that locale, or in the global header, select Seings and Actions
> Personalization > Set Preferences and specify the locale. Then, update the translatable text in the exeld using
the Manage Descriptive Flexelds task, Manage Key Flexelds task, or Manage Extensible Flexelds task. Your
modications change the translated values only for the current session's locale.

After you complete the translations, deploy the exeld.

You can dene translations for a dependent value set or an independent value set, if the value set is of type Character
with a subtype Translated text. You dene the translations by seing the current session to the locale for which you
want to dene the translation. Then use the Manage Value Sets task to enter the translated values and descriptions for
that locale.

You can dene translated values for a table value set for which multiple languages are supported and that the value
set's value column is based on a translated aribute of the underlying table. For more information about using
multilanguage support features, see the Oracle Fusion Applications Developer's Guide.

FAQs for Value Sets


What happens if a value set is security enabled?
Value set security is a feature that enables you to secure access to value set values based on the role of the user in the
application.
As an example, suppose you have a value set of US state names. When this value set is used to validate a exeld
segment, and users can select a value for the segment, you can use value set security to restrict them to selecting only a
certain state or subset of states based on their assigned roles in the application.

For example, Western-region employees may choose only California, Nevada, Oregon, and so on as valid values. They
cannot select non-Western-region states. Eastern-region employees may choose only New York, New Jersey, Virginia,
and so on as valid values, but cannot select non-Eastern-region states. Value set security is implemented using Oracle
Applications Cloud data security.

How can I set a default value for a exeld segment?


When you dene or edit a exeld segment, you pick a value from the assigned value set and set it as default.
You can set the default value for a descriptive exeld segment to be a parameter. The mapped entity object aribute
provides the initial default value for the segment.

You can set the default value to be a constant, if appropriate to the data type of the value set assigned to the segment.

In addition to an initial default value, you can set a derivation value for updating the aribute's value every time the
parameter value changes. The parameter you select identies the entity object source aribute. Any changes in the
value of the source aribute during run time are reected in the value of the segment.

149
Oracle Applications Cloud Chapter 6
Conguring and Extending Applications Flexelds

If the display type of the segment is a check box, you can set whether the default value of the segment is checked or
unchecked.

Descriptive Flexelds
Overview of Descriptive Flexelds
Use descriptive exelds to add aributes to business object entities, and dene validation for them.
All the business object entities that you can use in the application are enabled for descriptive exelds. However,
conguring descriptive exelds is an optional task.

Context
A descriptive exeld can have only one context segment to provide context sensitivity. The same underlying database
column can be used by dierent segments in dierent contexts.
For example, you can dene a Dimensions context that uses the following aributes:

• ATTRIBUTE1 column for height


• ATTRIBUTE2 column for width
• ATTRIBUTE3 column for depth

You can also dene a Measurements context that uses the same columns for other aributes:

• ATTRIBUTE1 column for weight


• ATTRIBUTE2 column for volume
• ATTRIBUTE3 column for density

Segments and Contexts


The following table lists the dierent types of descriptive exeld segments.

Segment Type Run Time Appearance

Global segment Always available


   

Context segment Determines which context-sensitive segments are displayed


   

Context-sensitive segment Displayed depending on the value of the context segment


   

150
Oracle Applications Cloud Chapter 6
Conguring and Extending Applications Flexelds

The following gure displays a descriptive exeld having one context segment called Category for which there are
three values: Resistor, Baery, and Capacitor. Additionally, the descriptive exeld comprises two global segments that
appear in each context, and three context-sensitive segments that only appear in the specic context.

Context-
Context Global sensitive
segment segments segments

Attributes: Category G1 G2 A3 A4 A5

Context: Context:
Resistor Capacitor
Context:
Battery
G1 G1

G2 G2

A3 A4

A4 A5

G1

G2

A3

A4

A5

Application development determines the number of segments available for conguring. During implementation,
congure the exeld by determining the following:

• Aributes to add using the available segments


• Context values
• The combination of aributes in each context

Value Sets
For each global and context-sensitive segment, you congure the values permied for the segment. Based on it, the
values that end users enter are validated, including interdependent validation among the segments.

Protected Descriptive Flexeld Data


Application developers may mark some data congurations in a descriptive exeld as protected, indicating that you
can't edit them.

151
Oracle Applications Cloud Chapter 6
Conguring and Extending Applications Flexelds

Considerations for Planning Descriptive Flexelds


Once you have identied a exeld to congure, plan the conguration in advance. Compile a list of the UI pages
and other artifacts in your deployment that are aected by the conguration. Verify that you are provisioned with
the roles needed to view and congure the exeld. View the exeld using the Highlight Flexelds command in the
Administration menu while viewing the run time page where the exeld appears. Plan how you will deploy the exeld
for test and production users. Review the tools and tasks available for managing exelds for adding and editing
exeld segments.
Planning a descriptive exeld can involve the following tasks:
1. Identify existing parameters.
2. Identify existing context values and whether the context value is derived.
3. Identify user-dened aributes and plan the descriptive exeld segments, segment properties, and structure.
4. Plan validation rules.
5. Plan initial values.
6. Plan aribute mapping to Oracle Business Intelligence objects.

Identify Existing Descriptive Flexeld Parameters


Some descriptive exelds provide parameters that can be used to specify the initial value of a descriptive exeld
segment. The parameter is external reference data, such as a column value or a session variable. For example, if a
exeld has a user email parameter, you can congure the initial value for a customer email aribute to be derived from
that parameter.
Review the list of available parameters in the Derivation Value eld in the Create Segment page for a descriptive
exeld. If you decide to use one of the parameters to set an initial value, select that parameter from the Derivation
Value drop-down list when you add the descriptive exeld segment.

Evaluate Whether the Context Value Is Derived


The context value for a descriptive exeld might have been precongured to be derived from an external reference.
For example, if the context is Marriage Status, then the value might be derived from an aribute in the employee
business object. When the context value is derived, you might need to take the derived values and their source into
consideration in your plan.
To determine whether the context value is derived, access the Edit Descriptive Flexeld task to view the list of
congured context values for the exeld. The Derivation Value eld in the Context Segment region displays a list
of available parameters. If context values have been precongured, see Oracle Applications Cloud Help for product-
specic information about the use of those values.

Plan the Segments, Segment Properties, and Structure


Identify the user-dened aributes you need for a business object to determine the segments of the descriptive
exeld. Determine the segment properties such as the prompt, display type, or initial value.
The structure of the descriptive exeld is determined by its global, context, and context-sensitive segments. Plan a
global segment that captures an aribute for every instance of the business object. Plan a context for segments that
depend on a condition of situation applying to a particular instance of the business object. Plan context-sensitive
segments to capture aributes that are relevant in the context.

There is only one context segment available for descriptive exelds. If you have more than one group of user-dened
aributes where you could use the context segment, you will have to pick one group over the others, based on your
company's needs and priorities, and add the other user-dened aributes as global segments.

152
Oracle Applications Cloud Chapter 6
Conguring and Extending Applications Flexelds

Plan Validation Rules


Dene each segment's validation rules and check if value sets exist for those rules or you must create new ones. If you
must create a value set, you can create it either before conguring the exeld or while creating or editing a segment.
When determining a segment's validation rules, consider the following questions:
• What is the data type - character, date, date and time, or number?
• Does the segment require any validation beyond data type and maximum length?
• Should a character type value be restricted to digits, or are alphabetic characters allowed?
• Should alphabetic characters automatically be changed to uppercase?
• Should numeric values be zero-lled?
• How many digits can follow the radix separator of a numeric value? In base ten numeric systems, the radix
separator is decimal point.
• Does the value need to fall within a range?
• Should the value be selected from a list of valid values? If so, consider the following questions:

◦ Can you use an existing application table from which to obtain the list of valid values, or do you need to
create a list?
◦ If you are using an existing table, do you need to limit the list of values using a WHERE clause?
◦ Does the list of valid values depend on the value in another exeld segment?
◦ Is the list of valid values a subset of another exeld segment's list of values?

Plan Initial Values


For every segment, list the constant value or SQL statement, if any, to use for the initial value of the user-dened
aribute.

Plan How Segments Map to Oracle Business Intelligence Objects


You can extend descriptive exelds into Oracle Transactional Business Intelligence (OTBI) for ad hoc reporting
purposes. Determine the descriptive exeld segments to be made available for reporting, and select the BI Enabled
check box accordingly on the Manage Descriptive Flexelds page. You must run a process to extend the BI enabled
segments into OTBI. For more information about extending the BI enabled segments into OTBI, see the Flexelds
chapter in the Oracle Applications Cloud Creating and Administering Analytics and Reports guide.
Depending on the reporting needs, you may map similar context-sensitive aributes from dierent contexts to the
same aribute in OTBI. For example, there may be a segment tracking the Product Color aribute in dierent contexts
of a context sensitive descriptive exeld. You can use segment labels to map these context-sensitive aributes
together by dening a segment label and updating the BI Label list accordingly.

Related Topics
• Overview of Transactional Business Intelligence Conguration of Descriptive Flexelds

Considerations for Managing Descriptive Flexelds


Conguring descriptive exelds involves managing the available exelds registered with your Oracle Applications
Cloud database and conguring their exeld-level properties, dening and managing descriptive exeld contexts,
and conguring global and context-sensitive segments.

153
Oracle Applications Cloud Chapter 6
Conguring and Extending Applications Flexelds

Every descriptive exeld is registered to include a context segment, which you may choose to use or not.

In general, conguring descriptive exelds involves:


1. Creating segment labels for business intelligence enabled exelds.
2. Conguring global segments by providing identity information, the initial default value, and the display
properties.
3. Conguring the context segment by specifying the prompt, whether the context segment should be displayed,
and whether a value is required.
4. Conguring contexts by specifying a context code, description, and name for each context value, and adding
its context-sensitive segments, each of which is congured to include identifying information, the column
assignment, the initial default value, and the display properties.
The following aspects are important in understanding descriptive exeld management:
• Segments
• Adding segments to highlighted descriptive exelds
• Usages
• Parameters
• Delimiters
• Initial Values
• Business Intelligence

Segments
You can assign sequence order numbers to global segments and to context-sensitive segments in each context.
Segment display is always in a xed order. You can't enter a number for a segment if that number is already in use for a
dierent segment.
Value sets are optional for context segments and follow specic guidelines:
• The value set that you specify for a context segment consists of a set of context codes.
• Each context code corresponds to a context that's appropriate for the descriptive exeld.
• The value set must be independent or table-validated.
• If table-validated, the WHERE clause must not use the VALUESET.value_set_code or SEGMENT.segment_code
bind variables.
• The value set must be of data type Character with the maximum length of values being stored no larger than
the context's column length.
• If you don't specify a value set for a context segment, the valid values for that context segment are derived
from the context codes. The denition of each context segment species the set of context-sensitive segments
that can be presented when that context code is selected by the end user.
• For reasons of data integrity, you can't delete an existing context. Instead, you can disable the associated
context value in its own value set by seing its end date to a date in the past.
• You can congure the individual global segments and context-sensitive segments in a descriptive exeld.
These segment types are dierentiated by their usage, but they're congured on application pages that use
most of the same properties.

Adding Segments to Highlighted Descriptive Flexelds


When you highlight exelds on a run time page and use an Add Segment icon buon to create a segment, the
segment code, name, description, table column, and sequence number are set automatically. If you use an Add
Segment icon buon to congure descriptive exeld segments, you can't use an existing value set. Value sets are

154
Oracle Applications Cloud Chapter 6
Conguring and Extending Applications Flexelds

created automatically when you add the segments. You can enter the valid values, their descriptions, and the default
value or specify the formaing constraints for the value set, such as minimum and maximum values.
Depending on display type, the value set you create using the Add Segment icon buon is either an independent value
set or a format-only value set. The following table shows which type of value set is created depending on the segment
display component you select.

Display Component Value Set Created Using Add Segment

Check Box Independent


   

Drop-down List Independent


   

List of Values Independent


   

Radio Buon Group Independent


   

Text Field With Search Independent


   

Text box Format Only


   

Text area Format Only


   

Date/Time Format Only


   

Tip: After you add a context value, refresh the page to see the new value.

Usages
Descriptive exeld usages allow for the same denition to be applied to multiple entities or application tables, such as
a USER table and a USER_HISTORY table. Descriptive exeld tables dene the placeholder entity where the exeld
segment values are stored once you have congured the descriptive exeld. When you congure a exeld, the
conguration applies to all its usages.

Parameters
Some descriptive exelds provide parameters, which are aributes of the same or related entity objects. Parameters
are public arguments to a descriptive exeld. Parameters provide outside values in descriptive exeld validation.
You use parameters to set the initial value or derivation value of an aribute from external reference data, such as a
column value or a session variable, rather than from user input. Parameters can be referenced by the logic that derives
the default segment value, and by table-validated value set WHERE clauses.

Delimiters
A segment delimiter or separator visually separates segment values when the exeld is displayed as a string of
concatenated segments.

155
Oracle Applications Cloud Chapter 6
Conguring and Extending Applications Flexelds

Initial Values
The SQL statement dening an initial value must be a valid statement that returns only one row and a value of the
correct type.
You can use two types of SQL statements:

• SQL statement with no binding. For example, select MIN(SALARY) from EMPLOYEES.
• SQL statement with bind variables. You can use these bind variables in the WHERE clause of the SQL
statement.

◦ :{SEGMENT.<segment_code>}: Identies a segment in the same context.


◦ :{PARAMETER.<parameter_code>}: Identies a parameter.
◦ :{CONTEXT.<context_code>;SEGMENT.<segment_code>}: Identies a segment in a dierent context. The
context must be in the same category or in an ancestor category, and it can't be a multiple-row context.
◦ :{VALUESET.<value_set_code>}: Identies the closest prior segment in the same context that's assigned to
the specied value set.
◦ :{FLEXFIELD.<internal_code>}: Identies a exeld.

Business Intelligence
Selecting a global, context, or context-sensitive segment's BI Enabled check box species that the segment is available
for use in Oracle Business Intelligence.
When the exeld is imported into Oracle Business Intelligence, the label you selected from the BI Label drop-down list
equalizes the segment with segments in other contexts, and maps the segment to the logical object represented by the
label.

Considerations for Enabling Descriptive Flexeld Segments for


Business Intelligence
A descriptive exeld that is registered in the database as enabled for Oracle Business Intelligence (BI) includes a
BI Enabled seing for each of its segments. When a global, context, or context-sensitive segment is BI-enabled, it is
available for use in Oracle Business Intelligence.
The following aspects are important in understanding BI-enabled exeld segments:

• Flaening business components to use BI-enabled segments in Oracle BI


• Equalizing segments to prevent duplication and complexity in the aened component
• Mapping aributes of aened business components to logical objects in Oracle BI
• Managing the labels that map segments to logical objects in Oracle BI

After you deploy a business intelligence-enabled exeld, use the Import Oracle Fusion Data Extensions for
Transactional Business Intelligence process to import the exeld changes into the Oracle Business Intelligence
repository. Users can make use of the newly-generated aributes in business intelligence applications. For example, a
user can generate a report that includes aributes added by the descriptive exeld. For additional information about
logical objects and import, refer to the Oracle Transactional Business Intelligence Administrator's Guide.

156
Oracle Applications Cloud Chapter 6
Conguring and Extending Applications Flexelds

Flaening
When you deploy a business intelligence-enabled descriptive exeld, the deployment process generates an additional
set of aened Application Development Framework (ADF) business components in addition to the usual ADF
business components and ADF faces run time artifacts that are generated during deployment. The aened business
components include aributes for business intelligence-enabled segments only. Flaening means each user-dened
column in each context shows up as an aribute in an Oracle Business Intelligence folder.

Flaened components include one aribute for the BI-enabled context-segment, and one aribute for each business
intelligence-enabled global segment. For BI-enabled context-sensitive segments, consider the following:
• If you assigned a label to the segment, the aened components include an additional single aribute
representing segments with that label.
• If you didn't assign a label, the aened components include a discrete aribute for each BI-enabled context-
sensitive segment in each context.

Mapping to Logical Objects in Business Intelligence


You can simplify reporting by representing similar segments as a single logical object in Business Intelligence.

If you assign a label to any set of context-sensitive segments that serve the same purpose in dierent contexts, you
can consolidate or equalize the segments into a single aribute. This prevents duplication and the extra workload and
complexity that result from the aening process. For example, a United States context might have a Passport segment
and a Canada context might have Visa segment. If you assign the NationalID segment label to both the Passport and
Visa segments, they are equalized into the same NationalID aribute in the aened business component.

Non-labeled context-sensitive segments aren't equalized across context values, so the aened components include a
separate aribute for each context-sensitive segment for each context value. It may not be possible to equalize similarly
labeled segments if they have incompatible data types or value set types.

Assign a label to a global segment, context segment, or context-sensitive segment to map the corresponding aribute
in the aened components to a logical object in Oracle Business Intelligence. Using labels to map segments to BI
logical objects minimizes the steps for importing the exeld into Oracle Business Intelligence.

Note: Assigning a label to a context-sensitive segment serves to equalize the aribute across contexts, as well
as map the equalized aribute to business intelligence.

Managing Labels
You may assign a predened label (if available) to segments or create new labels for assignment, as needed. Specify
a code, name, and description to identify each label. In the BI Object Name eld, enter the name of the logical object
in Oracle Business Intelligence to which the segment label should map during import. Specifying the BI logical object
minimizes the steps for importing the exeld into Oracle Business Intelligence and helps to equalize context-sensitive
segments across contexts.

If no labels are assigned to a BI-enabled segment, or the BI Object Name on the assigned label doesn't exist in business
intelligence, you must manually map the segment to the desired logical object when importing into Oracle Business
Intelligence.

In addition, context-sensitive segments without labels cannot be equalized across context values. The aened
components include a separate aribute for each non-labeled context-sensitive segment in each context.

Importing to Oracle Business Intelligence Repository


After you deploy a business intelligence-enabled exeld, import the exeld changes into the Oracle Business
Intelligence repository to make use of the newly aened business components in business intelligence and then

157
Oracle Applications Cloud Chapter 6
Conguring and Extending Applications Flexelds

propagate the exeld object changes. When you import the metadata into the Oracle Business Intelligence repository,
you must do so as the FUSION_APPS_BI_APPID user.

To import exeld changes into the Oracle Business Intelligence repository in Oracle Cloud implementations, run the
Import Oracle Fusion Data Extensions for Transactional Business Intelligence process. For additional information about
import, refer to the Oracle Transactional Business Intelligence Administrator's Guide.

Note: When you import a exeld into the Oracle Business Intelligence repository, you see both <name>_ and
<name>_c aributes for each segment, along with some other optional aributes. The <name> aribute contains
the value. The <name>_c aribute contains the code of the value set that the value comes from, and is used for
linking to the value dimension. You must import both aributes.

Extensible Flexelds
Overview of Extensible Flexelds
Extensible exelds are like descriptive exelds, with some additional features.
• You can add as many context-sensitive segments to the exeld as you need. You aren't restricted by the
number of columns predened and registered for the exeld.
• You can congure a one-to-many relationship between the entity and its extended aribute rows.

◦ A row of data can have multiple contexts associated with it.


◦ A row of data can have multiple occurrences of the same context.

• You can congure aributes in groups to form a context so that the aributes in the context always appear
together in the user interface.
• You can use existing hierarchical categories so that entities inherit the contexts that are congured for their
parents. Contexts are reusable throughout categories.
• Application development has registered some extensible exelds to support view and edit privileges. For such
exelds, you can specify view and edit privileges at the context level to control who sees the aributes and
who can change the aributes' values.

When you congure a context for multiple rows per entity, the segments are displayed as a table.

Unlike descriptive exelds, the extension columns corresponding to extensible exelds segments are part of
extension tables, separate from the base application table. Unlike descriptive exeld contexts, the set of aributes in
an extensible exeld context remains constant and doesn't dier by context value. An extensible exeld describes an
application entity, with the run time ability to expand the database that implementation consultants can use to dene
the data structure that appears in the application. Extensible exelds support one-to-many relationships between
the entity and the extended aribute rows. To get a list of predened extensible exelds, use the Manage Extensible
Flexelds task in the Setup and Maintenance work area.

The following aspects are important in understanding extensible exelds:


• Usages
• Categories
• Pages

158
Oracle Applications Cloud Chapter 6
Conguring and Extending Applications Flexelds

• Security
• Protected Extensible Flexeld Data

Usages
Similar to the descriptive exelds, you can dene multiple usages for an extensible exeld, which enables several
application tables to share the same exeld.
For example, a exeld for shipping options can be used by both a Supplier table and a Buyer table. In addition, you can
associate a context with one, some, or all of the exeld's usages. Thus, with the shipping information example, you can
associate a warehouse context with the Supplier usage, a delivery location context with the Buyer usage, and a ship-via
context with all usages.

Usages include security information for applying no security to user access or enforcing view and edit privileges. Some
product-specic extensible exelds have specialized usage elds beyond those for security.

Categories
You can congure multiple extensible exeld contexts and group the contexts into categories. All extensible exelds
have at least one category. For some extensible exelds, you can congure a hierarchy of categories. A child category
in the hierarchy can inherit contexts from its parent category.
You can dene categories for extensible exelds, and you can associate any combination of contexts with a given
category.

For example, the Electronics and Computers category hierarchy might include a Home Entertainment category, which
in turn might include an Audio category and a TV category, and so on. The Home Entertainment product might have
contexts that specify voltage, dimensions, inputs and outputs. Contexts are reusable within a given extensible exeld.
For example, the dimensions context could be assigned to any category that needs to include dimensional information.

Pages
Extensible exelds let you combine contexts into groups known as pages, which serve to connect the contexts so they
will always be presented together in the application user interface.
Each application page corresponds to one extensible exeld category, with a separate region of the page for each
associated context.

Security
When you congure a exeld, you set the privileges for a context at the usage level by selecting actions for the view
and edit privileges of a context usage.
When an end user performs a search, the user interface displays only the aribute values of the contexts for which the
user has view privileges. The user can perform a search using all aributes for all contexts, regardless of view privileges.

If end users access a context through a web service, an exception is thrown if they perform an action for which they
don't have privileges.

All extensible exelds have a base data security resource. Some data security resources for extensible exelds
are precongured with actions that you can use to specify access privileges. If no action is precongured, a security
administrator can create actions and policies to support access control on the extensible exeld aributes.

Some extensible exelds have a translatable option; these exelds also have a translation data security resource.

159
Oracle Applications Cloud Chapter 6
Conguring and Extending Applications Flexelds

Protected Extensible Flexeld Data


Application developers may mark some data congurations in an extensible exeld as protected, indicating that you
can't edit them.

If an extensible exeld is partially protected, then you can't edit the protected portions of the exeld's conguration.
For example:
• If an extensible exeld context is protected, you can't edit its:
◦ Context details
◦ Context segments
◦ Context usages
• If an extensible exeld page is protected, you can't:
◦ Edit the page details or delete the page
◦ Edit the contexts associated with the page

Note:
• There is no restriction on page references to protected contexts. The pages you create may contain any
context, whether protected or not.
• There is a restriction on category references to protected contexts. If a context is protected, you can't add it
to or delete it from any category.

Related Topics
• Update Existing Setup Data

Considerations for Planning Extensible Flexelds


Once you have identied a exeld, plan its conguration in advance. Compile a list of the UI pages and other artifacts
in your deployment that are aected by the conguration. Verify that you are provisioned with the roles required to
view and congure the exeld. View the exeld using the Highlight Flexelds option in the Administration menu
while viewing the run time page where the exeld appears. Plan how to deploy the exeld for test and production
users. Review the tools and tasks available for managing exelds for adding and editing exeld segments.
Planning an extensible exeld involves:
1. Identifying the following:
◦ A hierarchical structure of categories
◦ Existing context values
◦ User-dened aributes, the relevant extensible exeld segments, segment properties, and the structure
2. Planning the following:
◦ Validation rules
◦ Initial values
◦ Security
◦ Aribute mapping to Oracle Business Intelligence objects.

160
Oracle Applications Cloud Chapter 6
Conguring and Extending Applications Flexelds

Category Hierarchy Structure


Existing category hierarchy structures provide the framework for planning what segments to add to an extensible
exeld as user-dened aributes of an entity. Some applications provide user interfaces to create and manage an
extensible exeld's category hierarchy.

Contexts and Existing Context Values


If related aributes can be grouped together, plan adding the aributes as a context of segments, and plan the order
in which the aributes should appear. Some extensible exelds have precongured context values. Region headers
displayed in the user interface page or pages that contain the exeld segments identify existing contexts. Using the
Manage Extensible Flexelds task, nd and open the exeld for editing to view the list of congured context values.
See product-specic information for guidance in using precongured context values.

Plan the Segments and Segment Properties


List all the user-dened aributes that you want to add as extensible exeld segments. For each segment, dene
properties, including the indexed property.

Plan Validation Rules


Dene each segment's validation rules and check if value sets exist for those rules or you must create. If you must
create a value set, you can create it either before you congure the exeld or at the same time that you create or edit a
segment.
When determining a segment's validation rules, consider the following questions:

• What is the data type: character, date, date and time, or number?
• Does the segment require any validation beyond data type and maximum length?
• Should a character type value be restricted to digits, or are alphabetic characters permied?
• Should alphabetic characters automatically be changed to uppercase?
• Should numeric values be zero-lled?
• How many digits can follow the radix separator of a numeric value? In base ten numeric systems, the radix
separator is a decimal point.
• Should the value be within a range?
• Should the value be selected from a list of valid values? If yes, consider the following questions:

◦ Can you use an existing application table from which to obtain the list of valid values, or do you have to
create a list?
◦ If you are using an existing table, do you have to limit the list of values using a WHERE clause?
◦ Does the list of valid values depend on the value in another exeld segment?
◦ Is the list of valid values a subset of another exeld segment's list of values?

Plan Initial Values


For every segment, list the constant value or SQL statement, if any, to use for the initial value of the user-dened
aribute.

161
Oracle Applications Cloud Chapter 6
Conguring and Extending Applications Flexelds

Plan Security
Determine what privileges to set for view and edit access to context aributes, such as providing all users with view
access but only managers with edit access.
If your security restrictions apply to several contexts, you can create generic actions. At a minimum, create the generic
actions for the base data security resource. If the exeld has a translatable option and you plan to use translatable
contexts, then also create the generic actions for the translation data security resource. For example, the Item exeld
supports the translatable option and has a data security resource ITEM_EFF_VL in addition to the base data security
resource ITEM_EFF_B. Then, create actions for both data security resources, such as EDIT_NONTRANS_ATTRS for
ITEM_EFF_B and EDIT_TRANS_ATTRS for ITEM_EFF_VL.

If your security restrictions are more ne-grained, such as having to secure each context with a dierent privilege, then
you can create more ne-grained actions.

Plan Which Segments Map to Oracle Business Intelligence Objects


If an extensible exeld has been enabled for Oracle Business Intelligence, you can make the aributes available for use
in Oracle Business Intelligence Applications.

Considerations for Managing Extensible Flexelds


Conguring extensible exelds involves managing the available exelds registered with your application database.
The following sequence describes how to congure extensible exelds:
1. Conguring contexts by creating each context segment and the context-sensitive segments for each context
segment, and providing the following for each segments:
a. Identifying information
b. Column assignment
c. Initial default value
d. Display properties
2. Conguring context usages and usage security by selecting actions to which users should have access:
◦ View
◦ Edit
◦ None, if no special privileges should be enforced.
3. Conguring categories and category details.
4. Associating contexts with a category.
5. Creating logical pages for a category.
The following aspects are important in understanding extensible exeld management:
• Contexts and pages
• Categories
• Initial values
• Adding segments to highlighted extensible exelds
• Indexed segments
• Security
• Deployment

162
Oracle Applications Cloud Chapter 6
Conguring and Extending Applications Flexelds

Contexts and Pages


Each context is displayed to end users as a region containing its context-sensitive segments. You can specify instruction
help text to display instructions that explain how to use the region and its aributes to end users. Instruction help
text is displayed at the beginning of the context region. A context can be dened as single row or multi-row. Single
row contexts are the same as descriptive exelds contexts. A single row context has only one set of context-sensitive
segments. A multi-row context enables you to associate multiple sets of values with the same object instance.
For example, for a BOOK table, you could create a multi-row context named chapters that contains a segment for
chapter and a segment for number of pages. Multiple chapters can then be associated with each book in the BOOK
table.

For contexts that store multiple rows, you can uniquely identify each row by having the values in each row form a
unique key.

If exeld has a category hierarchy, then you can leverage the hierarchy to reuse contexts for similar entities, such as
similar items in a product catalog.

Set the context to translatable so that free-form text entered by end users is stored in the language of the user's locale,
and dierent translations of that text can be stored in other languages. Segments in the translated contexts should use
format-only value sets for storing free-form, user-entered text.

Set the context security to give an end user view or edit access to a context. The context's task ow and region appear
in the user interface only for users with view access. With edit access, an end user can edit the context's aribute values.
With no action specied for a usage, no special privileges are enforced through the context's conguration.

Dene logical pages to group contexts together in the user interface. For a given category, you may create one or more
logical pages. You may add one or more of the category's associated contexts to each of the category's logical pages.

You can specify:

• The sequence of the contexts within each page.


• The sequence in which the logical pages appear.
• Instruction help text to display instructions that explain how to use the page to end users. Instruction help text
is displayed at the beginning of the logical page, preceding all of its context regions.

Categories
A category is a grouping of related data items that can be considered to belong together. You can associate any
combination of contexts with a given category. Extensible exelds with more than 30 categories must be deployed as a
background process.
A category hierarchy logically organizes a set of categories. For example, the Electronics and Computers category
hierarchy might include a Computer category and a Home Entertainment category, which in turn might include an
Audio category and a TV category, and so on.

A category can be a child or sibling of an existing category. The hierarchy can be as simple or as complex as desired,
with any combination of zero or more sibling categories and zero or more child categories. If no category is dened, the
data items are grouped in a single predened default category.

Each category has associated contexts that store relevant information about a data item in that category. For example, a
Home Entertainment product has contexts that specify Voltage, Dimensions, Inputs and Outputs. Contexts are reusable
within a given extensible exeld. Then, the Dimensions context could be assigned to any category that needs to
include dimensional information.

163
Oracle Applications Cloud Chapter 6
Conguring and Extending Applications Flexelds

If a hierarchy includes child categories, each child category inherits the contexts from its parent category; for example,
the Home Entertainment category inherits Voltage and Dimensions from the Electronics and Computers category.

Each extensible exeld is associated with a particular category hierarchy. Consider category hierarchies to be dening
framework for extensible exelds and their contexts. A category hierarchy species which contexts are valid for each
category.

An extensible exeld can include multiple contexts which you dene to support a given category. These contexts can
be suitable for various purposes, but within a particular category, some contexts might be considered to be related to,
or dependent on, each other. You can combine these contexts into groups known as logical pages, and determine the
sequence in which the pages appear. This serves to connect the contexts so they will always be presented together and
in a particular order in the application user interface.

For example, the Home Entertainment category might have an Electrical Specications page that contains the Voltage,
Inputs and Outputs contexts, and a Physical Specications page that contains the Dimensions and Form Factor
contexts.

Initial Values
The SQL statement dening an initial value must be a valid statement that returns only one row and a value of the
correct type.
You can use two types of SQL statements:
• SQL statement with no binding. For example, select MIN(SALARY) from EMPLOYEES.
• SQL statement with bind variables. You can use these bind variables in the WHERE clause of the SQL
statement.

◦ :{SEGMENT.<segment_code>}: Identies a segment in the same context.


◦ :{PARAMETER.<parameter_code>}: Identies a parameter.
◦ :{CONTEXT.<context_code>;SEGMENT.<segment_code>}: Identies a segment in a dierent context. The
context must be in the same category or in an ancestor category, and it can't be a multiple-row context.
◦ :{VALUESET.<value_set_code>}: Identies the closest prior segment in the same context that's assigned to
the specied value set.
◦ :{FLEXFIELD.<internal_code>}: Identies a exeld.

Adding Segments to Highlighted Extensible Flexelds


When you highlight exelds on a run time page and use an Add Segment icon buon to create a segment, the
segment code, name, description, table column, and sequence number are set automatically. If you use an Add
Segment icon buon to congure extensible exeld segments, you can't use an existing value set. Value sets are
created automatically when you add segments. You can enter the valid values, their descriptions, and the default value
or specify the formaing constraints for the value set, such as minimum and maximum values.
Depending on display type, the value set you create with the Add Segment icon buon is either an independent value
set or a format-only value set. The following table shows which type of value set is created depending on the segment
display component you select.

Display Component Value Set Created Using Add Segment

Check Box Independent


   

164
Oracle Applications Cloud Chapter 6
Conguring and Extending Applications Flexelds

Display Component Value Set Created Using Add Segment

Drop-down List Independent


   

List of Values Independent


   

Radio Buon Group Independent


   

Text Field With Search Independent


   

Text box Format Only


   

Text area Format Only


   

Rich Text Editor Format Only


   

Date/Time Format Only


   

Tip: After you add a context value, refresh the page to see the new value.

Indexed Segments
You can designate an extensible exeld segment as indexed so that it's one of the selectively required aributes a
user can use in an aribute search. If you indicate in the Manage Extensible Flexeld UI page that a segment should
be indexed, the column representing the segment must be added to the database index. Commonly, a database
administrator (DBA) adds columns to the database index.
When an extensible exeld with indexed segments is deployed, search task ows are generated along with the other
exeld artifacts and specify the indexed aributes as selectively required. In the deployed extensible exeld's search
task ow, an end user must specify at least one of the indexed aributes in the search criteria. This prevents non-
selective searches, which could cause performance issues.

For example, if you index the memory and processor aributes and ensure that the corresponding columns in the
database are indexed, a user can search an item catalog for computers by entering processor or memory or both as a
search criteria. No search is performed if an end user enters an aribute that isn't indexed as a search criterion.

Security
An extensible exeld's base data security resource typically has a name with an _B sux. The translation data security
resource is a view of a translation table that typically has a name with an _VL sux.
If a exeld supports the translatable option and has a translation data security resource, make sure that you create the
action for the appropriate data security resource.

• If you create a context-specic action for a nontranslatable context, add it to the base data security resource.
• If you create a context-specic action for a translatable context, add it to the translation data security resource.

165
Oracle Applications Cloud Chapter 6
Conguring and Extending Applications Flexelds

Deployment
You can only deploy extensible exelds using the Manage Extensible Flexelds task. You can deploy extensible
exelds oine as a background process and continue working in the session without having to wait for the
deployment to complete. You can queue up several extensible exelds and deploy as a background process. The
exelds are deployed, one at a time, in the order that you deploy them to the queue. You must deploy extensible
exelds with more than 30 categories as a background process.
You can remove an extensible exeld from the deployment queue with the Cancel Background Deployment command.
When an extensible exeld is deployed in a background process, its oine status indicates that the exeld is in a
background deployment process. A exeld's oine status is cleared and it's deployment status updated when the
background deployment process has completed.

Note: The Oine Status column refreshes when you perform a new search in the Manage Extensible
Flexelds task.

Considerations for Enabling Extensible Flexeld Segments for


Business Intelligence
An extensible exeld that is registered in the database as enabled for Oracle Business Intelligence (BI) includes a BI
Enabled seing for each of its segment instances. When a segment instance is BI-enabled, it's available for use in Oracle
Business Intelligence.
The following aspects are important in understanding BI-enabled extensible exeld segments.

• Flaening business components to use BI-enabled segments in Oracle BI


• Mapping aributes of aened business components to logical objects in Oracle BI

After you deploy a business intelligence-enabled exeld, use the Import Oracle Fusion Data Extensions for
Transactional Business Intelligence process to import the exeld changes into the Oracle Business Intelligence
repository. Users can make use of the newly-generated aributes in business intelligence applications. For additional
information about logical objects and import, refer to the Oracle Transactional Business Intelligence Administrator's
Guide.

Flaening
When you deploy a business intelligence-enabled extensible exeld, the deployment process generates an additional
set of aened business components for use in business intelligence. The aened business components include
aributes for business intelligence-enabled segment instances only.

If you assigned a label to a segment, the aened components include a single aribute representing all segment
instances with that label. If you didn't assign a label, the aened components include a discrete aribute for each BI-
enabled segment instance in each structure.

Importing to Oracle Business Intelligence Repository


After you deploy a business intelligence-enabled exeld, import the exeld changes into the Oracle Business
Intelligence repository to make use of the newly aened business components in business intelligence and then
propagate the exeld object changes. When you import the metadata into the Oracle Business Intelligence repository,
you must do so as the FUSION_APPS_BI_APPID user. To import exeld changes into the Oracle Business Intelligence
repository in Oracle Cloud implementations, run the Import Oracle Fusion Data Extensions for Transactional Business

166
Oracle Applications Cloud Chapter 6
Conguring and Extending Applications Flexelds

Intelligence process. For additional information about import, refer to the Oracle Transactional Business Intelligence
Administrator's Guide.

Tip: When you import a exeld into the Oracle Business Intelligence repository, you see both <name>_ and
<name>_c aributes for each segment, along with some other optional aributes. The <name>_ aribute contains
the value. The <name>_c aribute contains the code of the value set that the value comes from, and is used for
linking to the value dimension. You must import both aributes.

Considerations for Managing Extensible Flexeld Categories


Categories are a way of extending the number of context-sensitive segments for a exeld beyond the columns
reserved for exeld segments.
For example, an Items extensible exeld has a category for each item and each category can have one or more
contexts. The laptop item belongs to the Computers category. Since extensible exelds are mapped to separate
extension tables, not just to columns as with descriptive exelds, the thirty reserved columns on the extensible exeld
table let you dene up to thirty context-sensitive segments for each context.

If you add a Dimensions context to the Computers category, thirty segments are available. But if you need to add more
than thirty aributes, create another context and associate it to the same category. You could now add an Electronics
Aributes context to the same Computers category in which you create another thirty segments. You can continue
creating more contexts and adding them to the Computers category. In this way your laptop computer item can be
extended with as many aributes as you need, because it is mapped to a category and you can keep adding contexts to
that category.

A descriptive exeld on an items table with thirty columns reserved for segments can only have a single context. Once
you congure the columns for that one context, you cannot create any more segments.

Predened and Precongured Categories


How you structure the exeld conguration depends on how categories are dened for the exeld. If the extensible
exeld is precongured with one category, associate all your contexts and pages with that category. If a product-
specic extensible exeld is precongured with several categories, associate your contexts and pages with those
categories. If the extensible exelds provide user interfaces for conguring multiple categories, associate a context
with more than one category using inheritance.
Some products provide an activity or task for creating and maintaining categories for an extensible exeld. See
product-specic information to determine if you can create categories for the exeld.

You can view a exeld's category hierarchies by using either the Highlight Flexelds feature or the Manage Extensible
Flexelds task to nd and open the exeld for editing.

Disabling Categories
While conguring an extensible exeld, you can disable a category. The Enabled column in the Category table of the
Edit Extensible Flexeld page, indicates which categories are enabled.
Note: When you deploy an extensible exeld that has a disabled category, that category and its descendant
categories aren't deployed. Contexts and their segments are deployed only if they belong to at least one
enabled category.

Contexts
Group similar aributes into contexts. The group is displayed together in a region. The region's header is the context
value.

167
Oracle Applications Cloud Chapter 6
Conguring and Extending Applications Flexelds

If a category hierarchy exists for the exeld, then you can leverage the hierarchy to reuse contexts for similar entities,
such as similar items in a product catalog.

The following gure shows the Item Extended Aributes exeld, which uses the category hierarchy feature to reuse
contexts. The exeld's Electronics and Computers category contains contexts for compliance and certication, voltage,
and materials and substances. The TV and Video subcategory and the Computer Products subcategory inherit the
Electronics and Computer contexts in addition to having their own contexts. The Materials and Substances context
belongs to both the Electronics and Computer Products category and the Tools, Auto, and Industrial Products category.

Electronics and Computer Products

Computer Products
Compliance and
Computer Context Certification Context

Tools, Auto, and


TV and Video Products Voltage Context
Industrial Products

TV and Video
Context
Materials and Materials and
Substances Context Substances Context

The following table shows an example of category hierarchy for an extensible exeld. To store voltage information for
all electronic and computer items, associate a Voltage context with the Electronics and Computers category. Both the
TV and Video subcategory and the Computers subcategory then inherit the Voltage context from the parent Electronics
and Computers category.

Display Name Code Description

Electronics and Computers PROD_ ELECTRONICS Electronics and Computers


     

• TV and Video PROD_TV_VIDEO Television and Video


   

• Computers PROD_COMPUTERS Computers


   

Oce Products and Supplies PROD_ OFFICE_ PRODUCTS_ SUPPLIES Oce Products and Supplies
     

Tools, Auto, and Industrial PROD_ TOOLS_ AUTO_ INDUSTRIAL Tools, Automotive, and Industrial
     

168
Oracle Applications Cloud Chapter 6
Conguring and Extending Applications Flexelds

Display Name Code Description

Sports and Outdoors PROD_ SPORTS_ OUTDOORS Sports and Outdoors


     

Example of Conguring an Item Extended Aributes Flexeld


The Item Extended Aributes exeld provides segments for extending the Item business object. In the Manage
Extensible Flexelds task, congure your product business object to include a technical specications logical page on
the user interface for the Electronics and Computers category of items.
In this example, your conguration of this exeld groups aributes into the following contexts:
• Materials and Substances
• Compliance and Certication
• Voltage

Scenario
The following list shows an example plan for computer aributes for the Item Extended Aributes exeld. In this
example, the Electronics Information page is inherited from the parent Electronics and Computers category.
• Page: Electronics Information

◦ Context: Compliance and Certication, single row

• ISO 14001 (International Organization for Standardization for an Environmental Management


System)
• ENERGY STAR (energy eciency guidelines)
• ROHS (Restriction of the use of certain hazardous substances in electrical and electronic
equipment)
◦ Context: Voltage, single row

• Minimum voltage
• Maximum voltage
• Current type
◦ Context: Materials and Substances, multiple rows

• Material
• Contain recyclate
• Percent unit mass
• Page: Computer Information

◦ Context: Processor Specications, single row

• Manufacturer
• CPU type
• Processor interface
• Processor class

169
Oracle Applications Cloud Chapter 6
Conguring and Extending Applications Flexelds

• Processor speed
• Cores

The following table summarizes key decisions for this scenario.

Decisions to Consider In This Example

Which extensible exeld is available Item Extended Aributes exeld


for conguring a hierarchy of  
categories?
 

Collecting Technical Specications


Your product inventory pages for electronics and computers require a technical specications page. Your product
inventory pages for furniture require a furniture specications page and an assembly instructions page. Items in both
the electronics and computer category, and in the furniture category, share aributes for specifying materials and
substances.

The following gure shows a technical specications logical page in the user interface for the Electronics and
Computers category. It contains aributes in the context of Recovery and Recycling, Compliance and Certication,
Operating Conditions, and Materials and Substances. The Materials and Substances context is congured for multiple
rows. Your users can select all the materials and substances required to make a single product.

Analysis
Use logical pages to determine how the contexts appear on the user interface. Use a context to store all the materials
and substances required to make a single product. You can congure a context to store multiple rows per entity. The
multiple rows are displayed in a table, like the Materials and Substances context.

170
Oracle Applications Cloud Chapter 6
Conguring and Extending Applications Flexelds

The Technical Specications logical page contains the aributes for the four contexts.
• Recovery and Recycling
• Compliance and Certication
• Operating Conditions
• Materials and Substances

The following gure is an example, where the Furniture category is congured to include a Furniture Specications
logical page and an Assembly Instructions logical page. The two categories (Electronics and Computers and Furniture)
share the Materials and Substances context.

Congure Security for the Item Flexeld Conguration


The following table shows an example of data security policies for the Item exeld.

Data Security Policy Role Action Condition


Resource

ITEM_EFF_B A VOLTAGE_SPEC edit_ nontrans_ All values


      voltage_ctx  
 

ITEM_EFF_VL B COMPLIANCE_ SPEC edit_ trans_ All values


      compliance_ ctx  
 

ITEM_EFF_VL C COMPUTER_SPEC edit_ trans_ars ComputerCategoryFilter


         

171
Oracle Applications Cloud Chapter 6
Conguring and Extending Applications Flexelds

Data Security Policy Role Action Condition


Resource

ITEM_EFF_VL D TELEVISION_ SPEC edit_ trans_ars TVCategoryFilter


         

The following table shows the privileges for the three exeld contexts.

Context Edit Privilege View Privilege

Voltage edit_ nontrans_ voltage_ctx NONE


     

Compliance and Certication edit_ trans_ compliance_ ctx NONE


     

Materials and Substances edit_ trans_ars NONE


     

In this example, anyone can view the contexts' aributes, but the edit privileges are restricted as follows:

• Voltage: Only voltage specialists can edit this value.


• Compliance and Certication: Only compliance specialists can edit this value.
• Materials and Substances: Only computer specialists can edit these aributes for items in the computer
category. Only television specialists can edit these aributes for items in the TV category.

To sum up, in this entire example, the Materials and Substances context is secured by a generic action with a condition
applied to restrict access by category. Voltage and Compliance and Certication are secured by actions specic to each
context.

File Format for Importing Extensible Flexelds


To import extensible exelds into an application, you create separate text les for the value sets, contexts, and context
segments. Then, you upload them to the Oracle WebCenter Content document repository. Each le must follow a
specic format, as described here. After the les are placed in the document repository, you can import the values sets,
contexts, and context segments into the application.
While creating the le, adhere to the following guidelines:

• Use a vertical bar or pipe ( | ) as a delimiter between elds for both header and value rows.
• Set the le encoding to UTF-8 without the Byte Order Mark (BOM) as per the Oracle WebCenter Content
specication.

The following sections contain specic details about each le format.

Prerequisite
You must have worked with exelds in Oracle Cloud applications.

172
Oracle Applications Cloud Chapter 6
Conguring and Extending Applications Flexelds

Value Sets
To create a le containing value sets, include the headers listed in the following table:

Header Data Type Data Size Description Required or Optional

ValueSetCode String 60 This value identies Required


      your value set across  
components.
 

ModuleType String 60 This value determines Required


      the module type of  
your value set.
 

ModuleKey String 60 This value determines Required


      the specic module of  
your value set.
 

ValidationType String 30 This value determines Required


      your value set type.  
The values you can
use are DEP, INDEP,
FORMAT, SUBSET, and
RELATED.
 

ValueDataType String 30 This value determines Required


      the data type that  
your value set uses.
Supported data types
are VARCHAR2,
NUMBER, DATE, and
TIMESTAMP.
 

ValueSubType String 30 This value determines Required for


      the data subtype ValueDataType
your value set uses. VARCHAR2
Supported data  
subtypes are TEXT,
TIME_HM, NUMERIC,
TIME_HMS, and
TRANSLATED
 

MaximumLength Integer - This value determines Required for


      the maximum length ValueDataType
of values in your value VARCHAR2
set.  
 

Description String 240 This value gives your Optional


      value set a description.  
 

Precision Integer - This value determines Optional


      the number of digits in  

173
Oracle Applications Cloud Chapter 6
Conguring and Extending Applications Flexelds

Header Data Type Data Size Description Required or Optional

the number data you Use this header only


add in your value set. for ValueDataType
  NUMBER
 

Scale Integer - This value determines Optional


      the number of digits  
after the decimal point Use this header only
in the number data you for ValueDataType
add in your value set. NUMBER
   

UppercaseOnlyFlag String 1 If this value is set to Optional


      Y, then your value  
set will accept only Use this header only
uppercase characters. for ValueDataType
If it's N, then both VARCHAR2
uppercase and  
lowercase characters
are supported.
 

ZeroFillFlag String 1 If this value is set to Optional


      Y, then zeroes are  
added to the left of the Use this header only
text you add in your for ValueDataType
value set, till the text VARCHAR2
length matches your  
MaximumLength. If the
value is N, no zeroes
are added.
 

SecurityEnabledFlag String 1 If this value is set to Optional


      Y, you can add a data  
security resource to
your value set. If the
value is N, no data
security resource is
added.
 

DataSecurityObjectName String 60 This value selects the Required if


      data security resource SecurityEnabledFlag is
you want to add to set to Y.
your value set. This  
value must match a
data security resource
in the application.
 

MinimumValue String 150 This value species the Optional


      minimum value for the  
values in your value
set.
 

MaximumValue String 150 This value species the Optional


      maximum value for the  
values in your value
set.

174
Oracle Applications Cloud Chapter 6
Conguring and Extending Applications Flexelds

Header Data Type Data Size Description Required or Optional

IndependentValueSetCode String 60 This value determines Required for


      the independent value ValidationType DEP
set your dependent and SUBSET
or subset value set is  
linked to. Don't use this header
  for validation types
other than DEP and
SUBSET.
 

Here's a sample le that contains the header values at the beginning of the le, followed by line entries of the three
value sets that are to be imported. For importing several value sets, add more line entries in a similar format.
ValueSetCode|ModuleType|ModuleKey|ValidationType|ValueDataType|ValueSubtype|MaximumLength|Description
VS_TEST_91|APPLICATION|FND|INDEP|VARCHAR2|TEXT|2|desc1
VS_TEST_92|APPLICATION|FND|INDEP|VARCHAR2|TEXT|3|
VS_TEST_93|APPLICATION|FND|INDEP|VARCHAR2|TEXT|3|desc3

Context
To create a le containing the contexts, include the headers in the following table:

Header Data Type Data Size Description Required or Optional

ApplicationId Long - This value determines Required


      the Application to  
which your exeld
and context belongs to.
 

EFFCode String 40 This value is the code Required


      of the extensible  
exeld to which you're
adding your context.
This value should
match the code of an
extensible exeld
that's already in the
application.
 

ContextCode String 80 This value is the code Required


      for your context.  
 

Name String 80 This value determines Required


      the display name of  
your context.
 

MultirowFlag String 1 If this value is set to Required


      Y, then your context  
will support multi-row
behavior. If the value

175
Oracle Applications Cloud Chapter 6
Conguring and Extending Applications Flexelds

Header Data Type Data Size Description Required or Optional

is N, only single row


behavior is supported.
 

EnabledFlag String 1 If this value is set to Y, Required


      then your context is  
enabled. If the value is
N, then your context is
disabled.
 

Description String 240 This value gives your Optional


      context a description.  
 

TranslatableFlag String 1 If this value is set to Optional


      Y, then the segments  
in your context are
translatable. If the
value is N, they're not.
 

ContextIdentier String 30 This value determines Optional


      the API name for your  
context. There are a set
of conventions to be
followed when naming
APIs.
 

InstructionHelpText String 400 This text gives the Optional


      user instructions about  
how to use the context
region.
 

FlexeldUsageCode String 30 This value determines Required


      the usage code for  
your context. The value
should match a usage
code in the application.
 

ViewPrivilegeName String 400 This value determines Optional


      which privileges can  
view this context
usage. The value
should match a
privilege in the
application.
 

EditPrivilegeName String 400 This value determines Optional


      which privileges can  
edit this context usage.
The value should
match a privilege in the
application.
 

176
Oracle Applications Cloud Chapter 6
Conguring and Extending Applications Flexelds

Header Data Type Data Size Description Required or Optional

CExtAribute1 String 150 This header adds a Optional


      user dened aribute  
to a context usage.
 
You can use up to 5
headers of this type,
CExtAribute1 to
CExtAribute5 to add
your user dened
aributes.
 

CONTEXT_ String 150 This header adds a Optional


CExtAribute1     user dened aribute  
  to a context.
 
You can use up to
5 headers of this
type, CONTEXT_
CExtAribute1
to CONTEXT_
CExtAribute5 to add
your user dened
aributes.
 

Here's a sample le that contains the header values at the beginning and lists three contexts to be imported. For
importing several contexts, add more entries in the same format.
ApplicationId|EFFCode|ContextCode|Name|EnabledFlag|MultirowFlag|Description|FlexfieldUsageCode|
ViewPrivilegeName|CExtAttribute1|CExtAttribute2|CExtAttribute3|CExtAttribute4|CExtAttribute5
0|FLEX_SN_EFF1|OBJ_TEST_4|Object test 44|Y|N|desc 44 3363|FLEX_SN_EFF1_USAGE2|flex_sn_sitems_view|||||
0|FLEX_SN_EFF1|OBJ_TEST_3|Object test 33|Y|N||FLEX_SN_EFF1_USAGE1|flex_sn_view|||||NEW_TEST11
0|FLEX_SN_EFF1|OBJ_TEST_3|Object test 33|Y|N|new desc aug 14|FLEX_SN_EFF1_USAGE2|flex_sn_sitems_edit|
CE1_TESTupd_aug15||||

Context Segment
To create a le containing context segments, include the headers in the following table:

Header Data Type Data Size Description Required or Optional

ApplicationId Long - This value determines Required


      the Application to  
which your exeld,
context, and segment
belongs to.
 

EFFCode String 40 This value is the code Required


      of the extensible  
exeld to which you're
adding your segment.
This value should
match the code of an
extensible exeld

177
Oracle Applications Cloud Chapter 6
Conguring and Extending Applications Flexelds

Header Data Type Data Size Description Required or Optional

that's already in the


application.
 

ContextCode String 80 This value is the code Required


      for the context to  
which you're adding
your segment. This
value should match a
context code that's in
the application.
 

SegmentCode String 30 This value is the code Required


      for your segment.  
 

Name String 60 This is the back Required


      end name for your  
segment.
 

ColumnName String 30 This value determines Required


      the table column your  
segment uses to save
data. This value must
match a column that's
in the application.
 

ValueSetCode String 60 This value is the code Required


      for the value set you  
want to use in your
segment. This value
must match a value set
code in the application.
 

DisplayType String 30 This value determines Required


      the display type of the  
segment.
 
Valid values for
this aribute
are TEXT_BOX,
TEXT_AREA, RICH_
TEXT_EDITOR
HIDDEN,LOV,
POP_UP_LIST, DROP_
DOWN_LIST RADIO_
BUTTON_GROUP
STATIC_URL,
CHECKBOX, COLOR,
DATE_TIME
 

Prompt String 80 This value determines Required


      the display name of the  
segment.
 

178
Oracle Applications Cloud Chapter 6
Conguring and Extending Applications Flexelds

Header Data Type Data Size Description Required or Optional

ShortPrompt String 80 This value determines Required


      the shortened display  
name of the segment.
 

EnabledFlag String 1 If this value is set to Y, Required


      then your segment is  
enabled. If the value is
N, then it's disabled.
 

RequiredFlag String 1 If this value is set to Required


      Y, user input for this  
segment is mandatory
during run time. If the
value is N, user input is
optional.
 

ReadOnlyFlag String 1 If this value is set to Y, Required


      then your segment is  
read-only. If the value
is N, it's not.
 

Description String 240 This value gives your Optional


      segment a description.  
 

UOMclass String 20 This value determines Optional


      the unit for the data  
you add in your
segment.
 

TerminologyHelpText String 80 This text provides a Optional


      description for the  
segment.
 

InFieldHelpText String 160 This text provides Optional


      instructions on how to  
use the segment.
 

SequenceNumber Integer - This value determines Optional


      the order in which your  
segments are displayed
in your context.
 

DefaultType String 30 This value determines Optional


      the type of default  
value your segment
takes if the user
doesn't enter any data
in your segment. The
types are CONSTANT,
SQL, and GROOVY_
EXPRESSION

179
Oracle Applications Cloud Chapter 6
Conguring and Extending Applications Flexelds

Header Data Type Data Size Description Required or Optional

DefaultValue String 4000 This value determines Optional


      the default value your  
segment takes if the
user doesn't enter any
data.
 

DisplayWidth Integer - This value determines Optional


      the display width of  
your segment, in terms
of maximum number
of characters displayed
in a line.
 

DisplayHeight Integer - This value determines Optional


      the display height of  
your segment, in terms
of maximum number
of lines displayed in the
segment.
 

CheckboxCheckedValue String 30 This value determines Required for display


      the value of a checked type CHECKBOX.
check box in your  
segment.
 

CheckboxUncheckedValue String 30 This value determines Required for display


      the value of an type CHECKBOX.
unchecked check box  
in your segment.
 

RangeType String 30 This value sets two Optional


      elds as two ends  
of a range of values.
Set value as LOW or
HIGH for your low end
and high end elds
respectively.
 

BIEnabledFlag String 1 This value determines Optional


      whether your segment  
is BI enabled. Y means
it's, N means it's not.
 

MultirowUniqueKeyFlag String 1 If this value is set to Required for multi-row


      Y, the segment is contexts
marked as the unique  
key for a multirow
context. Default value
for this header is N.
At least 1 segment in
a multirow context

180
Oracle Applications Cloud Chapter 6
Conguring and Extending Applications Flexelds

Header Data Type Data Size Description Required or Optional

must be marked as the


unique key.
 

ShowValueDescription String 1 If this value is set Optional


      to Y, the value set  
description for the
value set associated
to the segment is
displayed. If the value
is N, it's not displayed.
 

SegmentIdentier String 30 This value determines Optional


      the API name for your  
segment. There are
a set of conventions
to be followed when
naming APIs.
 

Here's a sample le that contains the header values at the beginning and lists a context segment to be imported. For
importing several context segments, add more entries in the same format.
ApplicationId|EFFCode|ContextCode|SegmentCode|Name|ColumnName|ValueSetCode|DisplayType|Prompt|ShortPrompt|
EnabledFlag|RequiredFlag|ReadOnlyFlag|Description|UomClass
0|FLEX_SN_EFF1|ColdSourceTargetContext|Cold_TEST_SEG1|cold seg 1|ATTRIBUTE_CHAR3|EFF_BASIC_FMT_CHR|TEXT_BOX|
Prompt|Short Prompt|Y|Y|N|TEST desc aug 14_3PM|

Related Topics
• Overview of Files for Import and Export
• Upload Files to WebCenter Content Server

Import Extensible Flexelds


Use the Import option on the Manage Extensible Flexeld page to bulk import the exeld data that includes value set,
context, and context segment details.

Prerequisite
The les containing the exeld details are available in the document repository of Oracle WebCenter Content.

Importing Flexelds
To import exelds:

1. Sign in to the application as an implementation consultant or an administrator.


2. In the Setup and Maintenance work area, open the Manage Extensible Flexeld task or a similar task for
importing exelds.
3. In Search Results, from the Actions menu, select Import.
4. On the Upload Flexeld Data dialog box, select the WebCenter Content account to which the les were
uploaded.

181
Oracle Applications Cloud Chapter 6
Conguring and Extending Applications Flexelds

5. Enter the names of the separate les containing the value set, context, and context segment information. The
names here must match with the names of the les uploaded to the selected account.
6. Click Upload. The exeld details are imported.

Note: If the import fails, click the link to the log le on the conrmation dialog box and examine the
cause of failure.

Related Topics
• Import Flexelds, Lookups, or Prole Values Using Web Services
• Import Value Set Values Using Web Services

FAQs for Extensible Flexelds


Why did the extensible exeld context not appear at run time?
If a deployed extensible exeld context doesn't appear in the user interface, verify that the context is associated with
one of the category's pages dened for the extensible exeld.

Key Flexelds
Overview of Key Flexelds
Key exelds provide a means to capture a key such as a part number, a job code, or an account code. A key exeld
consists of one or more segments, where each segment can have a meaning.
For example, a part number 10-PEN-BLA-450 might correspond to a black pen from supplier #450 sold by division #10
(oce supplies). Behind the scenes, the application uses a unique number, 13452, for this part, but the user always sees
the 10-PEN-BLA-450 part number.

The following aspects are important to understanding key exelds:


• Architecture
• Segments and segment labels
• Structures
• Segment and structure instances
• Combinations
• Dynamic combination creation
• Security

Key exelds aren't optional. You must congure key exelds to ensure that your applications operate correctly. You
congure and maintain key exeld denitions with the Manage Key Flexelds task. To get a list of predened key
exelds, use the Manage Key Flexelds task in the Setup and Maintenance work area. For information about specic
key exelds, see the help for the product where the associated business component is implemented.

182
Oracle Applications Cloud Chapter 6
Conguring and Extending Applications Flexelds

Architecture
Flexeld metadata is stored in the exeld metadata tables. When you congure a key exeld, you dene metadata
about the key exeld covering aspects such as:
• Segments are in a structure
• Structures in the exeld
• Value sets in each segment

Based on the exeld metadata, actual part numbers are captured at run time as a combination of segment values
and stored in a combinations table. A combinations table contains all the segment columns for a exeld, a unique
ID column, and a structure instance number column. The structure instance number column dierentiates multiple
arrangements of the segment columns. For example, a part number containing multiple segments can be represented
by a key exeld. A part number key exeld has a corresponding combinations table. In that table, the exeld stores a
list of the complete codes, with each segment of the code in a column, with the corresponding unique ID and structure
instance number for the code. When users dene a new part number or maintain existing part numbers in the parts
catalog, they directly maintain rows in the combinations table.

The foreign key table contains a dierent business entity than the combinations table. For example, the business entity
in the foreign key table is order lines or invoice lines that contain foreign key references to parts for ordering. Any
number of foreign key tables can reference a particular entity represented by a key exeld.

Segments and Segment Labels


A key exeld contains segments and a segment label identies a particular segment within a key exeld. Segment
labels are dened and made available by the product development. A segment contains the following details:
• A prompt
• A short prompt
• Display width
• The sequential position of the segment within the key exeld structure
• The range type
• Column name of the aribute being stored by the segment
• A default value set
• A label for the segment

Applications identify a particular segment for some purpose such as security or computations. Segment name or
segment order cannot reliably identify a segment because key exeld segments can be congured to appear in any
order with any prompts. A segment label functions as a tag for a segment.

For example, the requirement is to identify which segment in the accounting exeld contains balancing information
and which segment contains natural account information. A segment label determines which segment you are using for
natural account information. When you dene your accounting exeld, you must specify which segment labels apply
to which segments. Some labels must be unique, and cannot be applied to more than one segment in each structure.
Other labels are required, and must be applied to at least one segment in each structure.

A segment label helps a user searching for segments, such as the Cost Center label for all segments across key exelds
that store a value for the cost center.

183
Oracle Applications Cloud Chapter 6
Conguring and Extending Applications Flexelds

Structures
A key exeld structure denition includes the number of segments and their order.
In some applications, dierent users like to see dierent segment structures for the same exeld. A key exeld can
have multiple structures if registered to support more than one structure.

The exeld can display dierent elds for dierent users based on a data condition in your application data, such
as the value of another eld entered by the user or the user's role. For example, the correctly formaed local postal
address for customer service inquiries diers based on locale. A postal address key exeld could display dierent
segments and prompts for dierent users based on a location condition in your application data, such as the user's role
or a value entered by the user.

Each structure can have one or more segments. Thus a segment is a child of a structure. To store a particular segment,
such as Cost Center, in two dierent structures, you must dene the segment separately in each structure. Each
structure may have one or more structure instances. Each instance of a structure shares the same number and order of
segments, but diers in the values or value sets used in validating the segments.

Structure and Segment Instances


You can dene multiple congurations of a key exeld structure. These structure instances have the same segment
structure, in the same sequence order. They dier primarily in how each segment is validated. You dene a structure
instance for each key exeld and each key exeld structure instance.

The segments in a key exeld structure instance are segment instances. A segment instance is a segment with a
specic value set assigned to it. If a key exeld is registered with a tree structure, you can specify a tree code for a
segment instance.

Combinations
A combination is a complete code, or combination of segment values that makes up the code, that uniquely identies
an object.
For example, each part number is a single combination, such as PAD-YEL-11x14 or 01-COM-876-7BG-LTN. In these
combinations, the hyphen is the segment separator. If you have ten parts, dene ten combinations. A valid combination
is an existing or new combination that can be used because it's currently active and doesn't violate cross-validation
or security rules. A combination has dierent segments depending on the exeld structure being used for that
combination. Any combination is associated with only one particular exeld structure.

Many applications refer to a key exeld combination by using the name of the entity or the key exeld itself. For
example, Assets uses the asset key exeld and refers to one of its combinations as an asset key or asset key exeld.
In another example, Oracle Fusion General Ledger refers to combinations of the accounting exeld as account or GL
account.

Each key exeld has one corresponding table, known as the combinations table, where the exeld stores a list of the
complete codes, with one column for each segment of the code, together with the corresponding unique ID number (an
account combination ID) for that code. Then, other tables in the application have a column that stores just the unique
ID for the code. For example, you may have a part number code, such as PAD-YEL-11x14. The Parts combinations table
stores that code along with its ID, 57494. If your application lets you take orders for parts, you might then have an
Orders table that stores orders for parts. That Orders table would contain a single column that contains the part ID,
57494, instead of several columns for the complete code PAD-YEL-11x14. Typically, one combinations page maintains
the key exeld, where the key exeld is the representation of an entity in your application. Maintain individual
combinations, such as part numbers in the combinations page.

184
Oracle Applications Cloud Chapter 6
Conguring and Extending Applications Flexelds

Dynamic Combination Creation


Dynamic combination creation is the insertion of a new valid combination into a combinations table from a page other
than the combinations page. The following table lists the levels at which dynamic combination creation may be enabled.

Level Of Dynamic Combination Controlled By:


Creation

Flexeld Application development


   

Each usage or reference to the key Application development


exeld  
 

Structure instance Administrators and implementation consultants


   

Other Administrators and implementation consultants


   

If your key exeld or certain usages or references of the key exeld don't permit dynamic combination creation,
you may control whether dynamic combination creation is enabled for each structure instance. If enabled, a user can
enter a new combination of segment values using the exeld window from a foreign key page. For example, when
entering a transaction, a GL user can enter a new expense account combination for an account that doesn't yet exist.
Your application creates the new account by inserting the new combination into the combinations table behind the
scenes. Assuming that the new combination satises any existing cross-validation rules, the exeld inserts the new
combination into the combinations table, even though the combinations table isn't the underlying table for the foreign
key page.

Related Topics
• Update Existing Setup Data

Considerations for Planning Key Flexelds


Your rst step in planning your key exelds is to determine which key exelds your application requires. Your plan
should include:

• The purpose of the key exeld


• The number and length of its available segment columns
• Whether your key exeld permits more than one structure
• Whether more than one structure must be dened
• The number, order and length of your segments for each structure

Before You Begin


Once you have identied a exeld, plan its conguration in advance. Compile a list of the UI pages and other artifacts
in your deployment that are aected by the conguration. Verify that you are provisioned with the roles required to
view and congure the exeld. Use the Highlight Flexelds command in the Administration menu to view the run time

185
Oracle Applications Cloud Chapter 6
Conguring and Extending Applications Flexelds

page where the exeld appears. Plan how you deploy the exeld for test and production users and review the tools
and tasks available for managing exelds.
If you plan to use value sets, create them before conguring the key exeld. You cannot create value sets for key
exelds at the time that you add and congure key exeld segments.

Access to Flexeld-Related Tasks


To congure exelds and value sets, you must have access to the tasks for managing exelds. Contact your security
administrator for details. For information about product-specic exeld tasks, such as Manage Fixed Assets Key
Flexelds, refer to the product-specic documentation.

Restrictions
If you plan to use value sets, create them before conguring the exeld. Plan your key exeld conguration to scale
to your enterprise needs. For example, if you expect to disable old cost centers and enable new ones frequently, plan
a larger maximum size for your cost center value set so that you can have more available values. A 3-character value
set with one thousand available values provides more room for changes than a 2-character value set with 100 available
values.
Note the code name of the exeld you intend to congure so that you nd it easily in the tasks for managing key
exelds. In some cases you can congure how the exeld appears on the page. See product-specic documentation
to determine any restrictions on using product-specic key exelds.

Reporting
To report on your data by certain criteria or sub-entities, such as account number or project or region, consider making
that sub-entity a distinct segment, rather than combining it with another sub-entity. You can categorize and report on
smaller discrete units of information.

Considerations for Managing Key Flexelds


Consider the plans for a key exeld, security, and resulting run time pages when conguring key exelds.

Planning
Plan structures carefully and enable them for future needs. Don't change the number, order, and maximum length of
segments once you have acquired exeld data.

Structure Delimiters
A delimiter separates the segments when they appear to users. The delimiter value of a structure species the character
used to visually separate segment values when the key exeld is displayed as a string of concatenated segments in the
UI.

Identify the delimiter value of your key exeld carefully so that it doesn't conict with the exeld data. For example,
if your data frequently contains periods, such as in monetary or numeric values, don't use a period as your segment
separator. Any character you expect to appear frequently in your segment values or descriptions isn't a good choice for
the delimiter. If you change the conguration of a key exeld, such as the delimiter, the change aects the previously
stored key exelds with that structure.

Security
Oracle Fusion data security enforces value set security.

186
Oracle Applications Cloud Chapter 6
Conguring and Extending Applications Flexelds

Within key exelds, value set security applies to the selection of the individual segment values in the segment list of
values. When selecting a key exeld segment value from the combinations table, data security permits display of only
the combinations whose segment values you have access to. Applications development controls whether or not value
set security rules propagate to the foreign key table. By default they do.

Run Time Pages


Application development determines the user interface (UI) pages used to render exelds. The types of key exeld UI
pages are as follows:

• Combinations pages where the underlying entity objects use the combinations table itself
• Foreign key pages where the underlying entity objects contain a foreign key reference to the combinations
table
• Partial usage pages where some or all of the key exeld's segment columns are in a product table

The same key exeld can be used in dierent ways on dierent pages.

A page with a foreign key reference has a base table or view that contains a foreign key reference to a combinations
table with the actual exeld segment columns. This lets you manipulate rows containing account combination IDs
(account combination).

A page with partial usage of a key exeld presents segments that are dened on a product's transactional table in
addition to being dened on a combinations table. In the case of a partial usage page, only a part of the conguration is
likely to be visible. This enables the key exeld to act more like a descriptive exeld.

An account combination maintenance page or combinations page presents the combinations table. This enables
directly creating and maintaining account combinations. The combinations table contains all key exeld segment
columns and a unique ID column.

A typical application has only one combinations page. An application might not have a combinations page if it doesn't
support maintenance by administrators.

A page containing a search region enables users to select which aributes of the key exeld view object to use as
criteria to search for exeld metadata.

For example, you can congure seven segments for the Account key exeld. In a foreign key reference page, users
see the typical key exeld picker with all seven segments where they can search for combinations. In a partial usage
page using the same key exeld, users potentially could see only a single segment such as the Cost Center labeled
segment, or they might see multiple segments but displayed as individual segments rather than options for selecting
combinations.

For more information about key exeld pages, see the Oracle Fusion Applications Developer's Guide.

Key Flexeld Structures


A key exeld structure arranges the segments of a key so that you can reuse a single key exeld in multiple
combinations of the same segments or a subset of those segments. Multiple instances of a single structure can
accommodate dierences in the value sets assigned to the structure's segments.

187
Oracle Applications Cloud Chapter 6
Conguring and Extending Applications Flexelds

The structure determines the following aspects of a key exeld:

• The segments to include


• The order of the segments
• Segment labels on the included segments
• Properties for each segment applied to the instances of the segments in an instance of the structure

Managing Key Flexeld Structures


All the segments dened for a key exeld are available to be included in a key exeld structure.
You can dene as many segments as there are dened segment columns in your key exeld combinations table.
Ensure that you add segments in the order that your key requires. Once deployed, the order cannot be changed.

Enable segments to indicate that they are in use. A exeld doesn't display disabled segments in run time. To protect
the integrity of your data, disable a segment if you have already used it to enter data.

Key Flexeld Structure Instances and Segment Instances


A key exeld structure can have one or more alternate structure instances. The instances of a key exeld structure
share the following aspects of the structure:
• The same set of segments
• The same arrangement of segments
• The same properties at the segment and structure levels

The dierences among structure instances include whether dynamic combination creation is permied. Likewise, at the
structure instance level, dierences among segment instances are based on the following:

• Value set
• Default type and default value
• Tree code
• Whether the segment is any of the following:

◦ Required
◦ Displayed
◦ Enabled for business intelligence
◦ Optional or required as a query criterion

For example, you can use one group of value sets for the US and another for France.

188
Oracle Applications Cloud Chapter 6
Conguring and Extending Applications Flexelds

The following gure shows two structures instances for a part number structure.

Part Number Key Flexfield

Part Number Part Number


Structure A Structure B

Item Category

Type Item

Style
Part Number
Structure Instance A1 Color
Item Global Items

Type Global Types

Part Number:
COM_512
Part Number Structure B Part Number Structure B
Structure Instance B1 Structure Instance B2
Segment Instances: Segment Instances:
APAC Value Sets US Value Sets

Category APAC Categories Category US Categories

Item Global Items Item Global Items

Style APAC Styles Style US Styles

Color APAC Colors Color US Colors

Part Number: Part Number:


COM - 876 - LTN - X3 11 - 876 - 93 - GRN

The structures dier in the number of segments and the segment separators used. The structure instances share all
the properties dened for that structure. However, the structure instances may vary if the properties are dened at the
structure instance or segment instance level. For example, the value set assigned to the segment instances.

Query Required Segment Instances


You can designate a key exeld segment instance as a query for making it a selectively required aribute. A user
can use it as a key exeld combination search. On the Manage Key Flexelds UI page, if you indicate that a segment
instance requires indexing, add the column representing the segment to the database index. Commonly, a database
administrator (DBA) adds columns to the database index.

189
Oracle Applications Cloud Chapter 6
Conguring and Extending Applications Flexelds

Following deployment, the combination picker of the key exeld displays the query required aributes as selectively
required. A user must specify at least one of the query required aributes in the search criteria. This prevents
unnecessary searches that could cause performance issues.

For example, you mark the cost center and account aributes as query required and ensure that the corresponding
columns in the database are indexed. A user can search for combinations by entering cost center or account or both as
search criteria. No search is performed if a user doesn't enter at least one query required aribute as search criteria.

Tip: Index the Structure Instance Number column on your combinations table to improve run time
performance.

Dynamic Combinations
If a key exeld supports dynamic combination creation, you can select to enable this feature by selecting Dynamic
Combination Creation Allowed. As a result, users enter values at run time that produce new account combinations
for the exeld. If Dynamic Combination Creation Allowed isn't enabled, new valid combinations can only be entered
using the combinations table for the exeld.

Trees
You may dene a tree code for the value set assigned to the segment instance. When you assign the tree code to the
segment instance, tree hierarchy search operations are available on the segment values.
For a segment instance to be based on a tree, the following must be true.

• Application development registered the key exeld with a tree structure. The tree structure may be xed
across all segments in the exeld, or may vary across segments.
• A tree code for that tree structure exists.
• The tree code includes tree versions containing the values of the value set assigned to the segment instance.
• You assign the required tree code directly to the segment instance.

If these conditions are satised, you can assign the same or dierent tree codes to the dierent segment instances that
use the same value set.

Cross-Validation Rules
You can control the creation of new key exeld code combinations by dening cross-validation rules. A cross-
validation rule denes validation across segments and enforces whether a value of a particular segment can be
combined with specic values of other segments to form a new combination.
The following table compares segment validation to cross-segment validation:

Type of validation Type of control

Segment validation Controls the values you can enter for a particular segment
   

Cross-segment validation Controls the combinations of values that administrators and end users can create for key
  exelds
 

190
Oracle Applications Cloud Chapter 6
Conguring and Extending Applications Flexelds

Note: You can use cross-validation rules for any key exeld that has cross-validation enabled. See the
documentation for your key exeld to determine if it supports cross validation.

Cross-validation rules prevent the creation of combinations with values that can't coexist in the same combination.
For example, your company requires that all revenue accounts must have a specic department. Therefore, account
combinations that have revenue account values, such as all values between 4000 and 5999, must have a corresponding
department value other than 000, which indicates no department is specied. You can dene cross-validation rules that
disallow creation of combinations with incompatible segments, such as 4100-000 or 5000-000.

Alternatively, suppose your accounting key exeld has an Organization segment with two possible values, 01 and 02.
You also have a Natural Account segment with many possible values, but company policy requires that Organization 01
uses the natural account values 001 to 499 and Organization 02 uses the natural account values 500 to 999. You can
create cross-validation rules to ensure that users cannot create a general ledger account with combinations of values
such as 02-342 or 01-750.

The following aspects are important to understanding cross-validation rules:

• Rule Denitions
• Enforcement
• Timing

Rule Denitions
The following table contains denitions used in cross-validation rules:

Rule Denition Purpose

Name Uniquely identies cross-validation rules in a deployment.


   

Description Helps administrators identify the purpose of the rule.


   

Error message Explains why the aempted combination violates the rule.
   

Start Date, End Date Indicates the period of time when the rule is in eect.
   

Enabled Determines whether the rule is enforced.


   

Condition lter Determines the conditions in which an enabled cross-validation rule should be evaluated.
   

Validation lter Determines the validation that the rule enforces when that condition is met.
   

When the event specied in the condition lter is applicable, the validation lter condition must be satised before
the combination can be created. If the event specied in the condition lter isn't applicable, then the combination is
considered to pass the rule and the rule won't be evaluated even if it is enabled.

Note: If you don't specify any statement in the condition lter, then the condition is always true and the rule is
always evaluated.

191
Oracle Applications Cloud Chapter 6
Conguring and Extending Applications Flexelds

Enforcement
Cross-validation prevents creation of invalid combinations by administrators using maintenance pages and end users
using dynamic insertion in foreign key pages.

Enabled rules are enforced when there is an aempt to create a new combination of segment values. Disabled rules are
ignored. Deleting the rule has the same eect, but you can re-enable a disabled rule.

Timing
When users aempt to create a new combination, the key exeld evaluates any cross-validation rules that are enabled
and in eect.

Note: Cross-validation rules have no eect on combinations that already exist. The exeld treats any
existing invalid combinations that pre-date the rule as valid.

If you want to prevent users from using previously existing combinations that are no longer valid according to your
cross-validation rules, manually disable those combinations using the combinations page for that key exeld.

When dening a cross-validation rule, specify a start and end date to limit the time when the rule is in eect. The rule is
valid for the time including the From and To dates.

Considerations for Cross-Validation Rules


To validate the key exeld combinations of segment values across segments, optimize your cross-validation rules to
improve the experience of administrators and users.

Consider the following when dening cross-validation rules:

• Filters
• Rule Complexity
• Maintenance

Filters
A cross-validation rule includes a condition lter and a validation lter. The rule is evaluated using the following logical
order: If the condition lter is satised, then apply the validation lter.
The condition lter describes the event when the rule is evaluated. If the event specied in the condition lter isn't
applicable, then the rule isn't evaluated, even if enabled. When the event specied in the condition lter is applicable,
the validation lter condition must be satised before the combination can be created.

For example, your organization has determined that a certain company value called Operations can't use a specic cost
center called Marketing. You can dene a cross-validation rule to validate your combinations.

1. The rule evaluates the company condition lter.


2. When company is equal to Operations, the rule evaluates the cost center validation lter.
3. When cost center is equal to Marketing, the rule prevents a combination from being created.
4. The error message you dened for the rule displays to inform the user that the aempted combination violates
the rule.
Such a rule doesn't aect the creation of combinations with Marketing cost center and company values other than
Operations.

192
Oracle Applications Cloud Chapter 6
Conguring and Extending Applications Flexelds

Rule Complexity
For optimal performance and ease of understanding, dene several simple validation rules instead of using one
complex rule. Simple validation rules let you provide a more specic error message and are easier to maintain over time.
Avoid rules that control validation across more than two segments, where possible. While you can dene cross-
validation rules that span two or more segments, it becomes dicult to interpret cross-validation error messages and
rectify invalid key exeld combinations.

Maintenance
To maintain consistent validation, review existing key exelds when you update your cross-validation rules. Regardless
of your current validation rules, you can use an existing key exeld combination if it's enabled. Therefore, to ensure
accurate validation, you must review your existing combinations and disable any combinations that don't match the
criteria of your new rules.
Tip: To keep this type of key exeld maintenance to a minimum, decide upon your cross-validation rules
when you rst set up your key exeld structure. Dene cross-validation rules before creating combinations
and before combinations are used in transactions.

To prevent users from using existing combinations that are no longer valid according to your cross-validation rules,
disable them using the combinations page.

Edit a Cross-Validation Rule


Cross-validation rules prevent specic combinations of segment values in account combinations. You can use the
Manage Cross-Validation Rules task to edit existing rules or to create one-o rules.

Scenario
Your organization has a cross-validation rule called Companies 131 and 151, which restricts account combinations for
those companies to department 40 and product 211. Account combinations for both companies should now include
department 30. To edit the cross-validation rule, perform these steps.

1. In the Setup and Maintenance work area, go to the following:

◦ Oering: Financials
◦ Functional Area: Financial Reporting Structures
◦ Task: Manage Cross-Validation Rules
2. Select the chart of accounts for your organization and select the Companies 131 and 151 cross-validation rule.

193
Oracle Applications Cloud Chapter 6
Conguring and Extending Applications Flexelds

The following gure shows the section of the Edit Cross-Validation Rules page with the condition and validation lter
details for companies 131 and 151. A condition is dened for company values equal to 131 or 151, and the validation
species the department value equals 40 and the product value equals 211.

3. Click the Validation Filter icon.


4. Click Add Fields and select the Department segment.
5. Accept the default operator, which is Equals, and select department 30.

The following gure shows the Validation Filter window with three validations: department equals 40, department
equals 30, and product equals 211.

6. Click OK.
7. Click Save.

194
Oracle Applications Cloud Chapter 6
Conguring and Extending Applications Flexelds

The following gure shows the details for the updated validation on the Edit Cross-Validation Rules page. The validation
species departments equal to 30 or 40, and the product equal to 211.

8. To update the error message, search for and select the Manage Messages for General Ledger task. Query the
error message name for the cross-validation rule and edit the message to include department 30.

Related Topics
• Update Existing Setup Data

Considerations for Enabling Key Flexeld Segments for Business


Intelligence
A key exeld registered in the database as enabled for Oracle Business Intelligence (BI) includes a BI Enabled seing
for each of its segment instances. When a segment instance is BI-enabled, it's available for use in Oracle Business
Intelligence.
The following aspects are important in understanding BI-enabled key exeld segments.

• Flaening business components to use BI-enabled segments in Oracle BI


• Equalizing segments to prevent duplication and complexity in the aened component
• Mapping aributes of aened business components to logical objects in Oracle BI
• Managing the labels that map segments to logical objects in Oracle BI

After you deploy a business intelligence-enabled exeld, use the Import Oracle Fusion Data Extensions for
Transactional Business Intelligence process to import the exeld changes into the Oracle Business Intelligence
repository. Users can make use of the newly-generated aributes in business intelligence applications. For additional
information about logical objects and import, refer to the Oracle Transactional Business Intelligence Administrator's
Guide.

Flaening
When you deploy a business intelligence-enabled key exeld, the deployment process generates an additional set of
aened business components for use in business intelligence. The aened business components include aributes
for business intelligence-enabled segment instances only.

195
Oracle Applications Cloud Chapter 6
Conguring and Extending Applications Flexelds

If you assigned a label to a segment, the aened components include a single aribute representing all segment
instances with that label. If you didn't assign a label, the aened components include a discrete aribute for each BI-
enabled segment instance in each structure.

Mapping to Logical Objects in Business Intelligence


You can simplify reporting by representing similar segments as a single logical object in Business Intelligence. If you
assign a label to segments that serve the same purpose in dierent structures, you can consolidate the segments into a
single aribute. This prevents duplication and the extra workload and complexity that result from the aening process.
For example, an organization may have more than one denition of its key accounting exeld to support dierent
requirements for accounting reporting. A US Accounting Flexeld structure may have a segment called Subaccount to
track project expenditures. The same type of information may be tracked in a UK accounting exeld structure with a
segment called Project. Equalize these two segments to create a single list of values for reporting.

Non-labeled segments aren't equalized across context values, so the aened components include a separate
aribute for each segment for each structure. It may not be possible to equalize similarly labeled segments if they have
incompatible data types or value set types.

Assign a label to a segment to map the corresponding aribute in the aened components to a logical object in Oracle
Business Intelligence. Using labels to map segments to BI logical objects minimizes the steps for importing the exeld
into Oracle Business Intelligence. Assigning a label to a segment serves to equalize the aribute across structures, as
well as map the equalized aribute to business intelligence.

Managing Labels
You may assign a predened label (if available) to segments or create labels for assignment, as needed. Specify a code,
name, and description to identify each label. In the BI Object Name eld, enter the name of the logical object in Oracle
Business Intelligence to which the segment label should map during import. Specifying the BI logical object minimizes
the steps for importing the exeld into Oracle Business Intelligence and helps to equalize context-sensitive segments
across structures.

If no labels are assigned to a BI-enabled segment, or the BI Object Name on the assigned label doesn't exist in business
intelligence, you must manually map the segment to the required logical object when importing into Oracle Business
Intelligence. In addition, segments without labels cannot be equalized across structures. The aened components
include a separate aribute for each non-labeled segment in each structure.

Importing to Oracle Business Intelligence Repository


After you deploy a business intelligence-enabled exeld, import the exeld changes into the Oracle Business
Intelligence repository to make use of the newly aened business components in business intelligence. Then
propagate the exeld object changes. When you import the metadata into the Oracle Business Intelligence repository,
you must do so as the FUSION_APPS_BI_APPID user.

To import exeld changes into the Oracle Business Intelligence repository in Oracle Cloud implementations, run the
Import Oracle Fusion Data Extensions for Transactional Business Intelligence process. For additional information about
import, refer to the Oracle Transactional Business Intelligence Administrator's Guide.

Note: When you import a exeld into the Oracle Business Intelligence repository, you see both <name>_ and
<name>_c aributes for each segment, along with some other optional aributes. The <name>_ aribute contains
the value. The <name>_c aribute contains the code of the value set that the value comes from, and is used for
linking to the value dimension. You must import both aributes.

196
Oracle Applications Cloud Chapter 6
Conguring and Extending Applications Flexelds

Example of a Key Flexelds


A key exeld can capture expense account information.

Scenario
When entering details for each expense, the user species an account to which the expense is charged.

Entering Expense Accounts


A user interface for entering expenses helps the user select an expense account that identies the cost center and other
details needed for processing the expense.

Analysis
The expense account eld is a foreign key reference to a account combination (EXPENSE_LINES.EXPENSE_ACCOUNT =
ACCOUNT.COMBINATION).

Account combinations Table for Entering Accounts and Employees


The account combinations table supports entering account information, such as for expense accounts.

197
Oracle Applications Cloud Chapter 6
Conguring and Extending Applications Flexelds

The following gure shows the origin in the account combinations table of the account specied by the user. The
account combination ID record stores the information of the key exeld segments used to assemble the expense
account based on the key exeld conguration.

Expenses Table
Expense Other Structure Code
Number Columns Instance Combination ID
1001 US 100345
1002 100565

Code Combination Table


Code Structure Segment Segment Segment Segment
Combination ID Instance 1 2 3 4
100345 US USWEST SALES 400 4599
100565

Combination Details
Segment Value Description

Organization USWEST US – West Region


Division SALES Sales
Cost Center 400 Cost Center 400 – US
Project 4599 Marketing Project

Expense Details User Interface

Expense Account USWEST-SALES-400-4599

Expense Number 1001 Amount 312.22


Expense Date 1/1/2011 Currency USD
Expense Type Airfare Structure Instance US
Description SFO-JFK for Client X

The combinations page, which is the maintenance page for the key exeld, is for managing rows in the combinations
table. In this example, managing the combinations means adding or editing account numbers that adhere to the key
exeld metadata rules.

The following gure shows the account combination details for the example expense account reected in the exeld
conguration and the account combinations table.

198
Oracle Applications Cloud Chapter 6
Conguring and Extending Applications Flexelds

Combination Details User Interface


Structure Instance US Organization USWEST
Code Combination ID 100345 Division SALES
Enabled Yes Cost Center 400
Project 4599

Combination Details
Segment Value Description

Organization USWEST US – West Region


Division SALES Sales
Cost Center 400 Cost Center 400 – US
Project 4599 Marketing Project

Code Combination Table


Code Structure Segment Segment Segment Segment
Combination ID Instance 1 2 3 4
100345 US USWEST SALES 400 4599
100565

If dynamic combination creation isn't enabled, then when entering an expense line, the user can only select an account
that already exists in the ACCOUNTS (combinations) table. If they require an account that doesn't exist, they must
consult with the appropriate application administrator who can add the account to the combinations table.

If dynamic combination creation is enabled, then when entering an expense line, the user can either select a preexisting
account, or type in a new account that is created dynamically on the y in the ACCOUNTS (combinations) table. Once
the new combination is created, the same user can refer to it on the expense line.

When managing employee information, the user species the cost center that the employee belongs to. The cost center
eld corresponds to a single, labeled segment of the Account Key Flexeld and has metadata dened such as the
allowable value set for that segment.

In the following gure, instead of specifying a cost center ID reference to an account, only the cost center segment is
used and the value is stored directly on the employee table.

199
Oracle Applications Cloud Chapter 6
Conguring and Extending Applications Flexelds

Combination Details
Segment Value Description

Cost Center 400 Cost Center 400 – US

Employee Details User Interface


Employee Number 10000 Structure US
Employee ID gbrown Cost Center 400
Hire Data 1/1/2011

Related Topics
• Example of One Chart of Accounts Structure with Many Instances

200
Oracle Applications Cloud Chapter 7
Conguring and Extending Applications Conguration of Home Page and Navigation

7 Conguration of Home Page and Navigation

Overview of Conguring Home Page and Navigation


You can congure the Navigator and springboard, as well as dene seings for the home page and springboard using
the Structure work area. To open this work area, from the Navigator menu, select Conguration > Structure. This work
area has 2 tabs: Navigation Conguration and Home Conguration. Use the Navigation Conguration page to congure
the Navigator and springboard. Use the Home Conguration page to congure the home page.

Some of the key conguration tasks that you can do using the Structure work area are:
• Create, edit, and rename the Navigator menu items and springboard icons, which appear on the home page.
• Create a duplicate version of an existing predened page entry and edit the duplicate page entry to meet your
specic requirements.
• Change the visibility seings of the Navigator menu items and springboard icons, and reorder them.
• Change the visibility seings of the icons for infolet pages in the page control, which appear on the home page.
• Rename and reorder the icons for infolet pages in the page control.

Groups and Page Entries


To address needs specic to your organization, you can create or edit groups and page entries for the Navigator and
springboard. For example, you may want to link page entries to web pages or external applications.
Groups and page entries are available on the springboard and navigator menu. A page entry is the navigator link or
springboard icon that opens a page. A page is a single screen to perform related tasks. A few page entries may be
categorized in a group. Depending on the number of page entries that you have access to, the page entries can appear
at the top level (not in any group folder) on the springboard. If you have only one page entry in a group, then that
page entry icon appears at the top level on the springboard. However, such page entry icons appear in their respective
groups on the Navigator menu.

While creating or editing a page entry or group, you can use the Springboard eld to specify whether to display them
on the springboard. So, not all page entries and groups may appear on the springboard. The Navigator menu may
have more page entries and groups than the springboard. If a page entry appears on both the Navigator menu and
springboard, then you can use either of them to open the page. For page entries that don't appear on the springboard,
use the Navigator menu to open those pages.

Navigator and Springboard Conguration


Use the Navigation Conguration page to congure the Navigator and springboard. You can do the following tasks on
groups and page entries:
• Create
• Edit
• Show or hide

201
Oracle Applications Cloud Chapter 7
Conguring and Extending Applications Conguration of Home Page and Navigation

• Duplicate predened page entries


• Reorder

Home Page Conguration


Use the Home Conguration page to congure the icons for infolet pages in the page control on the home page. You
can rename these icons, change their visibility seings, and reorder them.

Related Topics
• Sign In and Get Started
• Set Prole Option Values
• Overview of Sandboxes

Congure Navigation
Create Groups and Page Entries for Navigation
Watch video

Use the Navigation Conguration page to create groups and page entries for conguring the Navigator and
springboard.
You can do either of the following:
• Create a group and then create a page entry in that group.
• Create a page entry in an existing group or at the top level (not in any group).

Before You Start


Following are the prerequisites:
1. From the Navigator menu, select Conguration > Structure.
2. Activate a sandbox. If you're not in an active sandbox, click Edit in the Structure work area. You're prompted to
activate a sandbox.
Tip: If you're already in an active sandbox, then the Edit buon doesn't appear in the Structure
work area.
3. If prompted, select a context layer to determine the scope of users that your changes aect.
After you complete your changes, you can preview and test the changes, and then publish the sandbox to make your
changes available to users.

Create Groups and Page Entries


To create a group or a page entry:
1. On the Navigation Conguration page, click Create, and select Create Group or Create Page Entry.

202
Oracle Applications Cloud Chapter 7
Conguring and Extending Applications Conguration of Home Page and Navigation

2. Enter a name for the group or page entry.


3. Search and select an icon for the group or page entry.
4. If you're creating a page entry, select the group in which you want to place the new page entry.
5. Select Yes, No, or EL Expression in the Show on Navigator eld:
◦ Yes: The group or page entry appears on the Navigator. It can also appear on the springboard, depending
on what you select in step 6.
◦ No: The group or page entry doesn't appear on the Navigator and springboard.
◦EL expression: The evaluation of the EL expression decides whether the group or page entry will appear
on the Navigator and springboard.
6. If you have selected EL Expression for the Show on Navigator eld, click the Edit icon next to the Show on
Navigator list, enter a value or expression, and click Validate to make sure that the validation result is True.
Don't include spaces or double quotes in the EL expression.
7. For a page entry, if you have set the Show on Navigator eld to Yes or EL Expression, set the Show on
Springboard eld. The value of this eld is evaluated to determine if the page entry will actually appear on the
springboard.
◦ Yes: The page entry appears on the springboard.
Suppose you have specied an EL expression in the Show on Navigator eld. Then, even on seing the
Show on Springboard eld to Yes, the page entry may not appear on the springboard. The evaluation of
the EL expression decides whether these items will actually appear on the springboard.
◦ No: The page entry doesn't appear on the springboard.
◦EL expression: The evaluation of the EL expression decides whether the page entry will appear on the
springboard.
8. If you're creating a group, then click Save and Close. If you're creating a page entry, then perform steps 8 to 10
instead of this step.
9. Select Yes or No in the Mobile Enabled eld to specify whether the page entry will be available for mobile
devices when the home page layout is set to News Feed. This seing isn't applicable for the panel or banner
layouts.
10. Select any of the following link types for the page entry:
◦ An application page.
◦A dynamic URL of an external page (outside your application) where the host, port, or context root might
change.
◦ A Static URL of an external page (outside your application) where the host, port, or context root doesn't
change.
11. Based on the link type, specify the required details to congure the link.
12. Click Save and Close.
13. Verify that the new group or page entry that you created appears on the Navigator menu in the sandbox, and
then publish the sandbox to make your changes available to users.

Related Topics
• Conguring the Navigator and Springboard

Congure Links for Page Entries


While creating a page entry or editing a page entry that was already created for the Navigator and springboard, you can
determine what the page entry links to.

203
Oracle Applications Cloud Chapter 7
Conguring and Extending Applications Conguration of Home Page and Navigation

Use the Create Page Entry or Edit Page Entry page to link a page entry to any of the following link types:

• Your application page.


• A dynamic URL of an external page (outside your application) where the host, port, or context root might
change.

You can determine the host and port details, which a dynamic URL starts with, from a lookup based on the
application name.
• A static URL of an external page (outside your application) where the host, port, or context root doesn't change.
Static URLs don't require lookups.
• A secure token URL of a partner application, to which secure tokens are added. Tokens contain identity and
security information about users, and can be used to authenticate them without additional authentication
requirements, for example, user name and password.

Link to Application Pages


To link a page entry to one of your application pages:

1. Select the Application Page link type.


2. Enter the focus view ID of the target page.
3. Select the name of the web application.

You had entered this application name while creating this third party application using the Setup and
Maintenance work area.
4. For secure access to the target application page from the page entry, provide the secured resource
name and the name of the policy store's application stripe. An example of a secured resource name is
oracle.apps.view.pageDefs.CaseList_Form_Attach_UIShellPagePageDef. When a user clicks the link, the
application checks the secured resource and the Lightweight Directory Access Protocol (LDAP) policy store.
Then, the application determines whether the user has the privilege to view the page.

You can get the application stripe from the jps.policystore.applicationid parameter in the application's
weblogic-application.xml le. Examples of application stripes are crm, fscm, and hcm.
5. If the page takes parameters, then you can enter a semicolon-delimited string of name=value pairs (for
example, org=m1;context=s1) in the Page Parameters List eld.

You can use expression language (EL) to specify the parameters. If the EL evaluates to an object, the toString
value of that object is passed as the value of the parameter. An application page may display or act dierently
based on the parameters that are passed in. For example, if you're opening a page from one group on the
springboard or Navigator, the parameter might be set to status=Open. Whereas, if you're opening the page from
another group, the parameter might be set to status=Closed.
Tip: If there is another page entry that links to the same application page, then you can enter the same details
for all elds, except parameters. On the Navigation Conguration page, open the existing page to view the
details, such as Focus View ID, Web Application, and Secured Resource Name. Then, ll in the elds for the
new page entry on the Create Page Entry or Edit Page Entry page.

Link to Dynamic URLs


You can link a page entry to an external website or application that has a frequently changing host, port, or context
root. Instead of updating the link to each application, you can update the details of the web application registration. This
change aects all page entries that contain dynamic links pointing to that web application.

204
Oracle Applications Cloud Chapter 7
Conguring and Extending Applications Conguration of Home Page and Navigation

For example, suppose you want to link to a test version of an application. So, you use the dynamic URL link type.
When you move the application from test to production environment, just change the host and port details of the web
application registration. This change aects all page entries that contain dynamic links pointing to the web application.

As a prerequisite, use the Manage Third-Party Applications task to register the web application. The application
details that you enter using this setup task will be used while conguring dynamic URL links for page entries.

To link a page entry to a dynamic URL:


1. Select the Dynamic URL link type.
2. Specify the name of the web application and the destination for web application.

For example, suppose you want to link to a complete URL: hp://example:9011/myApp/faces/Page1.

Then you can do the following:

◦ From the Web Application list, select myApp. This list displays the application names that were added
using the Manage Third-Party Applications task. Once you select the application name, the full URL
that was added for this application in the setup task (for example, hp://example:9011/myApp/) is
automatically used as the start of the dynamic URL.
◦ Enter the destination for the web application, for example, /faces/Page1. This value is appended to the
full URL.
After linking a page entry to a dynamic URL, when you click the page entry, the target page opens in a new browser
window or tab.

Link to Static URLs


You can link a page entry to an external website or application that has a constant host, port, or context root.

To link a page entry to a static URL:


1. Select the Static URL link type.
2. Enter the URL destination. The URL must start with http:// or https://.

For example, you can use a static URL to link to hp://www.oracle.com.

Link to Static URLs with Secure Destinations


To link a page entry to a secure token URL of a partner application (that is, outside your application):
1. Select the Static URL link type.
2. Select Secure Destination.
3. Select the name of the web application.
4. Enter the destination for the web application. An HTTPS protocol is required to access the application.
5. Enter the name of the secure token. All secure tokens have a predened lifetime, and they expire after that
duration. So, users must refresh the page to regenerate the tokens.
The application validates the secure token and uses it to authenticate web services within the end user context. Using
this mode of modied access, a partner can directly perform an action or display information to the specic user
without any additional authentication.

Related Topics
• Create Pages for Hosting Third Party Applications
• Register a Third-Party Application

205
Oracle Applications Cloud Chapter 7
Conguring and Extending Applications Conguration of Home Page and Navigation

Edit and Reorder Groups and Page Entries for Navigation


Use the Navigation Conguration page to edit and reorder the existing groups and page entries.

Before You Start


Following are the prerequisites:
1. From the Navigator menu, select Conguration > Structure.
2. Activate a sandbox. If you're not in an active sandbox, click Edit in the Structure work area. You're prompted to
activate a sandbox.
Tip: If you're already in an active sandbox, then the Edit buon doesn't appear in the Structure
work area.
3. If prompted, select a context layer to determine the scope of users that your changes aect.
After you complete your changes, you can preview and test the changes, and then publish the sandbox to make your
changes available to users.

Edit Groups and Page Entries


Follow these steps:
1. On the Navigation Conguration page, click the name link for the group or page entry.
Tip: You can use the search panel on the Navigation Conguration page to nd the group or page
entry you want to edit.
2. On the Edit Page Entry page or the Edit Group page, make the required changes.
3. Click Save and Close.
You can make the following changes to a group or page entry:
• Rename a group or page entry.
Note: If a group or page entry was created using a dierent tool, then you can't change its name
using the Navigation Conguration page.

• Change the icon for a group or page entry.


◦ If a page entry was created using a dierent tool, then you can't change its icon using the Navigation
Conguration page.
• For a page entry, change the group in which the page entry is placed.
• Change the Show on Navigator property for the group or page entry.
• Change the Show on Springboard property for the page entry.
• Change the Mobile Enabled property for the page entry.
• For an administrator-dened page entry, change the seings for link conguration.
• Delete page entries that were created using the Navigation Conguration page.
• For a predened page entry, use Create Duplicate on the Edit Page Entry page to create a duplicate page
entry. You can then edit the duplicate page entry as you want, for example, you can place the duplicate page
entry in a dierent group or at the top level.

206
Oracle Applications Cloud Chapter 7
Conguring and Extending Applications Conguration of Home Page and Navigation

• For groups with associated quick actions, use the Quick Actions tab to create more quick actions or make
changes to the existing ones, such as rename, show or hide, and reorder them.

Edit Page Entries with Tabs


Some pages (for example, Security Console) have tabs. Each tab is a task ow. To edit tabs, click the Tabs tab on the
Edit Page Entry page. You can make the following changes:
• Click the tab name to rename it.
• Click the tab icon to search and select another icon for the tab.
• Click the Visible eld for the tab, and change the option to show or hide the tab
• Use the Move Up and Move Down icons to adjust the relative position of the tabs within the page

Edit Page Entries with Panel Tabs


Some pages have panel tabs. To edit panel tabs, click the Panel Tabs tab on the Edit Page Entry page. You can make
the following changes:
• Click the panel tab name to rename it.
• Click the panel tab icon to search and select another icon for the panel tab.
• Click the Visible eld for the panel tab, and change the option to show or hide the tab.
• Use the Move Up and Move Down icons to adjust the relative position of the panel tabs within the page.

Reorder Groups and Page Entries


Use the Move Up and Move Down icons on the Navigation Conguration page to reorder groups and page entries. For
page entries, you can use the Move To icon to move page entries to dierent groups or to the top level.

After completing your changes, verify and test the changes in the sandbox, and then publish the sandbox to make your
changes available to users.

Related Topics
• Conguring the Navigator and Springboard
• Quick Actions
• Congure Quick Actions

Examples of EL Expressions for Conguring Navigation


You can use EL expressions to congure navigation in the application such as, to show or hide the navigator menu
items, and the icons for infolet pages in the page control on the home page. This scenario shows how you might use EL
expressions.

EL Expressions for Conguring the Navigator Menu Items


Use EL expressions to specify whether a group or page entry should appear on the Navigator and springboard. The
evaluation of the EL expression decides whether the menu items are displayed for a user.

This table shows examples of how you can use EL Expressions to show or hide groups and page entries from the
Navigator menu or springboard for specic users.

207
Oracle Applications Cloud Chapter 7
Conguring and Extending Applications Conguration of Home Page and Navigation

Who can see the group or page EL Expression and Example


entry

Only users having any of the specic #{securityContext. userInRole['<RoleName>']}


roles  
  #{securityContext. userInRole['ORAFND APPLICATION_ ADMINISTRATOR_ JOBORA_ PER_
EMPLOYEE_ ABSTRACT']}
 

Only users not having any of the #{!(securityContext. userInRole['<RoleName>']}


specic roles  
  #{!(securityContext. userInRole['ORAFND APPLICATION_ ADMINISTRATOR_ JOBORA_ PER_
EMPLOYEE_ ABSTRACT'])}
 

Only users having all of the specic #{securityContext. userInAllRoles['<RoleName>']}


roles  
  #{securityContext. userInAllRoles['ORAFND APPLICATION_ ADMINISTRATOR_ JOBORA_ PER_
EMPLOYEE_ ABSTRACT']}
 

Only users not having all of the #{!(securityContext. userInAllRoles['<RoleName>']}


specic roles  
  #{!(securityContext. userInAllRoles['ORAFND APPLICATION_ ADMINISTRATOR_ JOBORA_
PER_ EMPLOYEE_ ABSTRACT'])}
 

Only users having access to specic #{securityContext. userGrantedResource['resourceTypeFNDResourceType;resourceName


resources, for example, the Social FNDLaunch Social_ Menu;action= launch']}
work area  
 

Here are a few things to keep in mind when you use EL expressions.

• Use an EL expression that can be evaluated from any page because the Navigator menu is used on all pages.
So, don't use product-specic EL expressions.
• Don't include spaces or double quotes in EL expressions.
• Don't copy EL expressions from a word document and paste directly in the expression editor. Doing so might
introduce hidden characters in your EL expression, causing formaing issues and unexpected action. Instead,
use a text editor or manually type the EL expression in the editor.

Set the Availability Duration of Your Third-Party Application


Let's say you integrate a registered third-party application in your Oracle Cloud Application. You want to secure this
third-party application and make it available for users only for a specic duration. For that, you can set the validity
duration using the Token Relay Validity Duration prole option and secure your application using JSON Web Token
(JWT). Based on the value of this prole option, your third-party application will be available to users for a specic
duration. After this duration, users must refresh the page to view it again. Remember that the minimum availability
duration is six minutes. So for example, even if you set the availability duration as two minutes (120 seconds), your
third-party application will be actually available to users for six minutes.
Before you start, make sure that you have activated a sandbox.

208
Oracle Applications Cloud Chapter 7
Conguring and Extending Applications Conguration of Home Page and Navigation

Set the Validity Duration


1. In the Setup and Maintenance work area, go to the Manage Administrator Prole Values task in the
Application Extensions functional area.
2. Search for the Token Relay Validity Duration (FND_TOKEN_VALIDITY_DURATION) prole option.
3. In the FND_TOKEN_VALIDITY_DURATION: Prole Values section, click the New icon.
4. From the Prole Level list, select Site.
5. In the Prole Value eld, enter the time in seconds.
6. Click Save and Close.

Secure Your Third-Party Application


1. Click Navigator > Conguration > Structure.
2. Select the page entry that links to the third-party application you want to secure.
3. From the Link Type list, select Static URL.
4. Select the Secure Destination check box.
5. Select the name of your application.
6. Enter the destination for the application. An HTTPS protocol is required to access the application.
7. In the Secure Token Name eld, enter the name of the parameter (for example, jwt) that supports using the
secure token.
8. Click Save and Close.

Related Topics
• Manage Pages Hosting Third Party Applications
• Register a Third-Party Application

FAQs for Conguring Navigation


Why can't I edit the Structure page entry or the Tools group?
While conguring the Navigator and springboard, you can't:
• Override the Navigator seing for the Structure page entry and Tools group. The default seing is Yes, so the
Structure page entry and Tools group always appear on the Navigator and springboard.
• Move the Structure page entry to a dierent group or to the top level. The default group is Conguration, so
the Structure page entry always appear in the Conguration group.

How can I display the missing springboard icons and Navigator menu items for the
users?
Try these solutions:
• If the user can see the group or page entry in the Navigator, but not on the springboard, then enable the
oering associated with the group or page entry.
• If the user can't see the group or page entry in both the springboard and the Navigator, then assign the
required security privileges to the user.
• Check whether the group or page entry is hidden from the springboard or Navigator using the Structure work
area. Use this work area to view the visibility seings of the group or page entry, and if it is hidden, change
these seings to display it.

209
Oracle Applications Cloud Chapter 7
Conguring and Extending Applications Conguration of Home Page and Navigation

Related Topics
• Congure Oerings
• Overview of Conguring Oerings

Congure Home Page


Congure Home Page Navigation
Use the Home Conguration page to congure the icons for infolet pages or other congurable pages in the page
control on the home page.

Before You Start


Following are the prerequisites:
1. From the Navigator menu, select Conguration > Structure.
2. Click the Home Conguration tab.
3. Activate a sandbox. If you're not in an active sandbox, click Edit in the Structure work area. You're prompted to
activate a sandbox.

Tip: If you're already in an active sandbox, then the Edit buon doesn't appear in the Structure
work area.

If prompted, select a context layer to determine the scope of users that your changes aect. After you complete your
changes, you can preview and test the changes, and then publish the sandbox to make your changes available to users.

Dene Seings
You can rename icons for infolet pages and other congurable pages in the page control, change their visibility seings,
and reorder them. On the Home Conguration page, you can:
• Click the infolet name or any other congurable page name to rename it.
• Click the Visible eld for an infolet or any other congurable page to change its visibility seing. You can show
or hide the icon for these pages in the page control on the home page. You can select one of the following
options:

◦ Yes: The icon appears in the page control.


◦ No: The icon doesn't appear in the page control.
◦ EL expression: The evaluation of the EL expression decides whether the icon appears in the page
control.
• Click the Default View eld for an available congurable page to specify whether the page should be set as the
default home view. You can select one of the following options:

◦ Yes: The page is set as the default home view.


◦ No: The page isn't set as the default home view.
◦ EL expression: The evaluation of the EL expression decides whether the page is set as the default home
view.

210
Oracle Applications Cloud Chapter 7
Conguring and Extending Applications Conguration of Home Page and Navigation

Note: Only specic congurable pages, such as Quick Actions, are available for you to set as the
default home view. When you click the Default View eld for such pages, you get the options to
select Yes, No, or EL Expression. These options aren't available for other pages that you can't set as
the default home view.

• Use the Move Up and Move Down icons to adjust the relative positions of the icons for the infolet pages or
other congurable pages in the page control on the home page.

You can use prole options to dene seings for the lmstrip, which you can nd above all pages:
• To enable users to use the lmstrip, set the Springboard Strip Enabled prole option (FND_USE_FILMSTRIP)
to Yes.
• If the FND_USE_FILMSTRIP prole option is set to Yes, then you can display the lmstrip as expanded by
default. To do so, set the Springboard Strip Expanded prole option (FND_EXPAND_FILMSTRIP) to Yes. A
user can still collapse or expand the strip on any page, and when done, this prole option is set by default for
subsequent sessions of that user.

Related Topics
• Set Prole Option Values
• Overview of Sandboxes
• Create and Activate Unied Sandboxes

Dene Home Page Appearance


Use the Appearance work area to rst select your home page layout and then dene its display seings. Use the
Themes tab to select your default home page layout as panel, banner, or news feed. And then use the Home Page
Display tab to dene the display seings of your home page. Based on the home page layout you set using the Themes
tab, the options available on the Home Page Display page may vary.
Let's see how to dene the home page appearance. But before you start, activate a sandbox.

Dene Home Page Layout


1. Click Navigator > Conguration > Appearance.
2. Click the Themes tab.
3. From the Themes list, select a predened or saved theme.
4. From the Default Home Page Layout list, select Panel, Banner, or News Feed.
5. Click Apply.
If you selected a predened theme, enter a theme name, and click OK to create another theme with your
changes. If you selected a saved theme, your theme changes are directly applied to your application.

Dene Display Seings for Home Page with Panel or Banner Layout
If you selected the panel or banner layout on the Themes page, follow these steps to congure the display of
information in the various sections of your home page:
1. Click the Home Page Display tab.
2. Select one of these options to display on the home page:

◦ Social: Displays social networking content, such as the number of followers.

211
Oracle Applications Cloud Chapter 7
Conguring and Extending Applications Conguration of Home Page and Navigation

◦ Announcements: Displays employee announcements.


◦ Cover image: Displays the image for the main panel or banner, which you specify on the Themes page.
◦ None
3. Specify whether to display the photo in the main panel or banner of the home page from the social network
prole or from HCM.
4. Click Apply.

Dene Display Seings for Home Page with News Feed Layout
If you selected the news feed layout on the Themes page, follow these steps to congure the display of information in
the various sections of your home page:
1. Click the Home Page Display tab.
2. In the Name column of the table, click any section name to rename it.
3. Click the Visible eld for a section to change its visibility seing. You can show or hide the section on the home
page:

◦ Yes: The section appears on the home page.


◦ No: The section doesn't appear on the home page.
◦EL expression: The evaluation of the EL expression decides whether the section appears on the home
page.
4. In the Order column, use the Move Up and Move Down icons to adjust the relative positions of the sections on
the home page.
5. Click Apply.

Related Topics
• Manage Themes
• Overview of Conguring Themes and Home Page Seings
• Create Themes
• Overview of Sandboxes

Create and Enable an Announcement


You can create, edit, or delete company announcements. After you create an announcement, you can enable it to
display on your home page.

Create an Announcement
1. From the Navigator, select Tools > Announcements.
2. Click Create.
3. Specify the details, such as subject, start date, and end date.
4. Select a category. If you select User-Dened, a text box appears, where you can provide additional details.
5. Select any of these options:

◦ Predened: Select an image from the list.


◦ File: Browse and select a le from your local computer.
◦ URL: Enter a full URL for the image

212
Oracle Applications Cloud Chapter 7
Conguring and Extending Applications Conguration of Home Page and Navigation

Note: Make sure your image size is 776x437 px or larger to avoid image distortion.

6. Add the content in the text box. Add the content in the text box. You can format your text using the formaing
options.
7. Click Save and Close.
Your changes on the Announcements page apply immediately to all users, even if you saved your changes while a
sandbox is active and not yet published.

Edit or Delete an Announcement


1. From the Navigator, select Tools > Announcements.
2. Select the announcement that you want to edit or delete.
3. Edit the announcement details or click Delete.

Enable an Announcement on the Home Page


After you create or edit an announcement, you can determine whether to display the announcement on your home
page.
1. From the Navigator, select Conguration > Appearance.
2. Click the Home Page Display tab.
3. Based on your home page layout, use any of these options:

◦ Panel or Banner: Select Announcements from the home panel options, and then click Apply.
◦ News feed: Select Yes for News and Announcements, and then click Apply.

Your default home page layout also determines how the home page displays the announcement.
• Panel or Banner: The home page displays only the announcement content, not the subject or image.
• News feed: The home page displays the entire announcement along with the subject and image in the News
and Announcements section.

Related Topics
• Overview of Conguring Themes and Home Page Seings
• Why can't I see announcements on the Home page

FAQs for Home Page Conguration


Why can't my users see social networking content on the panel of the Home page?
That could be because of these seings in the Appearance and Structure work areas.
• Home page display seing in the Appearance work area: Make sure you selected Social as the home page
display option.
• Visibility seing in the Structure work area: Make sure you set the Show on Navigator eld for the Social page
entry to Yes or add a valid EL expression. The evaluation of the EL expression determines whether social
content is displayed for a user. To check that, validate the EL expression. If your validation result is True, the
social content will display for your user.

213
Oracle Applications Cloud Chapter 7
Conguring and Extending Applications Conguration of Home Page and Navigation

Deep Links
You can use deep links to open pages without navigating through the menu structure. Deep links come in handy if
you have corporate internal portals and you want to enable direct navigation from the portals into the Oracle Fusion
Applications. For example, you can enable direct navigation to the My Team page. Use the Deep Links work area to view
a complete list of the available deep links.
You can simply copy a URL from the Deep Links page and paste it in your external portals as is. You don't even need to
know the URL format.

Login and Security


Users with the View Administration Link (FND_VIEW_ADMIN_LINK_PRIV) privilege can view the Deep Link menu item in
the Navigator. If you click a deep link URL from an external application and have not yet signed in, you're automatically
redirected to the Sign In page.

214
Oracle Applications Cloud Chapter 8
Conguring and Extending Applications Help Content Management

8 Help Content Management

How You Manage Dierent Types of Help


You can edit the help content that comes with your application, and you can add your own help to the help windows.
For example, you might want to add links to company policies or best practices. Let's look at the dierent types of help
that you can manage.

Help Type How You See This Help How You Edit or Add to It

Fields and other UI elements Help text appears when you hover over or You can edit this text or add your own
  click certain UI elements on the page. text to other UI elements using the Page
  Composer or User Interface Text tool.
 

Help windows Many pages have help icons. Click these


  icons to open help windows that contain You can use the User Interface Text tool
help text, links, or both. to edit the help text. You can add or
  remove links by clicking the Manage Help
Content link in the help window.

In some cases, the same help window


appears on more than one page. So
whatever you do to the help window on
one page applies to the same help window
in other places.

Geing Started work area


  Select Geing Started from the Navigator You can edit or add to this content by
to open this work area and review the clicking the Edit Geing Started link on
videos and other information for new these pages.
users.

What Else You Can Do


Here's what you can do with all the help that you or other people added to help windows and the Geing Started work
area:

• If you add a lot of links in help windows, you might want to manage your help in a central place. You can use
the Manage Help Content task in the Setup and Maintenance work area to view and edit all of the help that
anyone added.
• If you create help in a test environment, you can migrate all added help by exporting and then importing a
conguration package.
• If you want people to search all added help, make sure that the Help search category is enabled for global
search.

215
Oracle Applications Cloud Chapter 8
Conguring and Extending Applications Help Content Management

Related Topics
• Modify Text with User Interface Text Update
• Enable Global Search for Added Help

Manage Help for Fields and Other UI Elements


Help text might appear when you hover over or click certain UI elements on the page. For example, you might see a help
note when you put your cursor in a specic eld, or hover over an icon.

How You Go About It


• Use Page Composer to edit, create, or delete hint text that appears when you hover over or click certain UI
elements, for example buons, icons, elds, and check boxes. Open the properties of the UI element to dene
the help text in the shortDesc eld. Not all types of help on UI elements can be created or changed using Page
Composer.
• Use the User Interface Text tool to edit the text for any type of help for UI elements, including informational text
in help windows. You usually use this tool to make bulk changes, for example to change a phrase wherever it
appears in any UI label, help for UI elements, messages, and so on.

Related Topics
• Modify Pages
• Page Component Properties
• Modify Text with User Interface Text Update

Why can't I see the Manage Help Content or Edit Geing


Started link?
You see the Manage Help Content link in help windows if the Help Content Management feature is enabled for any
oering and if you have the Manage Help Content (ATK_CUSTOMIZE_HELP_TOPICS_PRIV) privilege. You need this
same setup to see the Edit Geing Started link in the Geing Started work area too.

Related Topics
• Set Up Help
• Give People Access to Create and Edit Help

Help Windows
Add Your Content to Help Windows
Watch video

216
Oracle Applications Cloud Chapter 8
Conguring and Extending Applications Help Content Management

The easiest way to add help is to start in the help window where you want the help link to appear. You can add links to
web pages, upload les, or create help pages in a text editor.
1. Go to the page where you want to add help and click the help icon. If you don't see any help icons, click your
user image or name in the global header and select Show Help Icons.
2. In the help window, click the Manage Help Content link.
3. In the Manage Help Content dialog box, click Create.
4. Select a help type:
◦ Text: Use a rich text or HTML editor to enter your help content. You can include images, videos, and links.
◦ File: Upload a le of any type. Your le opens when users click the link in the help window.
◦ URL: Enter the full URL to a website or a le of any type, for example a YouTube video.
5. Select a help security group if you need to restrict access to your help content. Only users with roles in the
security group will be able to see the help. The predened Secured group includes all internal employees and
contingent workers.
6. Set the status as Active if you want people to see your help in the help window. Or, you can inactivate your help
so that it doesn't appear until you activate it later.
7. Enter the title, which is the text of the link in the help window.
8. If your help type is File, enter a description which users might see after they click the link on the help window,
depending on their browser seing.
9. Select another language if your content isn't in American English. In help windows, users see added help in the
language they're using for the application.
10. Select a country if your help is targeted at a specic country. Based on what users set in the Territory eld for
their regional preferences, they see generic added help plus added help tagged for their country. There's no
impact on predened help.
11. If your help type is Text, enter your content in the text editor. Or you can click the Source Code Editing Mode
icon to switch to an HTML editor.
12. Save your work. Be aware that you won't be able to see the new link in the Manage Help Content dialog box or
the help window if you set it up for a language, country, or security group that doesn't apply to you.
13. To check your work, click your link in the help window.
Tip: Help that you add using the Text or File type has a unique URL. So, you can link to it from other help or
web pages. Updates to the application won't aect the URL or your help content.

Related Topics
• Create Groups to Limit Access to Added Help

How can I add YouTube videos to help windows?


Create help using the URL for the YouTube video.
1. Find the video in YouTube.
2. Click Share.
3. Click Embed.
4. Copy the URL within the embed code, for example https://www.youtube.com/embed/<unique ID>.

Note: Make sure that your copied URL starts with https.

217
Oracle Applications Cloud Chapter 8
Conguring and Extending Applications Help Content Management

5. Open the help window and click Manage Help Content.


6. Click Create.
7. Select URL as the help type.
8. Paste your copied URL in the URL eld.
9. Enter other information, and click Save and Close.

Add Existing Help to Another Help Window


You can use the same added help in multiple help windows. Let's say you already created some help content for a
Create page, and now you want to add it to the corresponding Edit page too.
1. Open the Edit page and click the help icon.
2. In the help window, click the Manage Help Content link.
3. Click the Select and Add icon in the Added Help section.
4. Find the help you want to link to and select it in the search results.
5. Click Add.
Note: When you use the same help in multiple windows, be aware that what you do in one window aects the
other windows too. For example, if you change the content or status, the changes apply to all help windows
where you added the help. Similarly, if you delete the help in one window, it's removed from the other
windows too.

Determine Which Links Appear and in What Order


Click the Reorder buon on the Manage Help Content dialog box to set the order for links to the help that you added.
Your links always show up rst in the help window, before any predened help. When you create help or edit the help
that you added, you set the status so that the link is either shown or hidden in the help window.
To show or hide predened help:
1. In the Manage Help Content dialog box, select a title in the Predened Help section.
2. Click the Change Status buon.
3. In the Change Status dialog box, select Active or Inactive.
4. Click Save and Close.
If multiple help windows link to the same predened help, the status you set here aects all those windows.

Geing Started Work Area


Manage Geing Started Content
The Geing Started work area provides pages of information to introduce new users to the application. You can edit the
predened pages or add your own, so that people get content specic to your organization.
1. Click Navigator > Geing Started.
2. Click a link to open the set of pages you want to change.
3. Click the Edit Geing Started link.

218
Oracle Applications Cloud Chapter 8
Conguring and Extending Applications Help Content Management

Here's what you can do:


• Create and edit pages using a rich text or HTML source code editor.
• Reorder the pages.
• Activate or inactivate any page.
Tip: To hide the link to a set of Geing Started pages, inactivate all pages within that set. Users with
access to edit Geing Started pages can still see the link, but everyone else can't. If you inactivate
all sets except one, then users land on the rst page of the active set when they open the Geing
Started work area.

• Delete added pages (not predened ones).

How can I add YouTube videos to Geing Started pages?


Create or edit a page in the Geing Started work area, and include a piece of code from YouTube.
1. Find the video in YouTube.
2. Click the Share buon.
3. Click the Embed buon.
4. Copy everything in the text box.
5. Back in the application, open the Geing Started work area.
6. Open the set of pages you want to add the video to.
7. Click the Edit Geing Started link.
8. Open an existing Geing Started page or create a new one.
9. Click Source Code Editing Mode in the toolbar.
10. Paste in the code you copied from YouTube.
11. Click Save and Close.

Manage All Added Help Content


Use the Manage Help Content task to review all the help that's been added across all help windows and in the Geing
Started work area. You can search, for example, by title, status, or who last updated the content. From the search
results, you can edit the content, delete it, or change its status.
You can also create content on this page. But then you should put the help on a help window so that people can nd it
where they need it most. The easiest way to do that is to go to the page where you want the help to appear, open the
help window, and select and add your new topic. Or, you can search for the help window here using the Page or Section
list, then select and add the new help.

Search for and Manage Help


Here's what you do:
1. In the Setup and Maintenance work area, go to the Manage Help Content task in the Application Extensions
functional area.
2. On the Manage Help Content page, search for added help.
3. Select search results and do what you need, for example, to change status or delete.

219
Oracle Applications Cloud Chapter 8
Conguring and Extending Applications Help Content Management

Select and Add Help to a Help Window


You can put added help on any help window.
1. On the Manage Help Content page, select a value for the Page or Section list in the Search section. The page or
section value represents a help window, in this case, the one where you want to add a link.
2. In the Search Results section, click the Select and Add to Help Location icon.
3. On the Select and Add page, nd the help you want to link to.
4. Select the title and click Add.

Related Topics
• Update Existing Setup Data

Page or Section Values


The page or section value tells you where people can click a help icon to open a help window. Use this value on the
Manage Help Content page to search for help that was added to a specic help window, or to add more help to that
window. Let's see how we can gure out where a help window is, based on its page or section value.

Where You Find Help Windows


First, you need to know where you might nd help windows. In most cases, they're next to page or section titles, but you
might also nd them in other places:
• On tabs, dialog boxes (windows), panel tabs, dashboards, dashboard regions, and even desktop-integrated
Excel workbooks
• In the Setup and Maintenance work area, for example within the table of tasks on the Setup page
• In the Oerings work area, for example within the table on the Edit Features page
• In the Learn More column in the New Features work area

How to Read the Values


The page or section value reects reects how you navigate to the help window. For example, Process Details window,
Output tab doesn't mean that the help window is in two dierent places. It's in the Output tab within the Process Details
dialog box.

For the Setup and Maintenance, Oerings, and New Features work areas, the page or section value tells you the object
that the help window is for. These values end with oering, functional area, feature, task, or task list. So for example, Set
Help Options task refers to the help window that you see for the Set Help Options task, on the Setup page.

When the Same Help Window Is on Multiple Pages


In some cases, a page or section value does represent a single help window that appears on multiple pages. Here are a
couple of examples:
• Create and Edit Message pages means that same help window is on both the Create Message and Edit
Message pages. Note the plural pages.

220
Oracle Applications Cloud Chapter 8
Conguring and Extending Applications Help Content Management

• Process Monitor section means that this help window is in a section that appears on multiple pages. You can
usually tell if you see something like a section or tab name without a page or window name in front of it.

Related Topics
• How Functional Setup Manager Components Work Together
• Guidelines for Using Desktop Integrated Excel Workbooks

Copy Added Help for Migration


If you need to make a copy of all the help that's been added, say for testing, migration, or other purposes, then you're in
luck. In the Setup and Maintenance work area, you can create a conguration package then use the export and import.
Your conguration package must include one of these:

• The Application Extensions functional area


• A source implementation project that contains the Dene Help Conguration task list, with these objects
selected to export:

◦ Help Conguration
◦ Help Topic

Related Topics
• Export Setup Data Using Oering or Functional Area
• Export Setup Data Using Implementation Project

221
Oracle Applications Cloud Chapter 8
Conguring and Extending Applications Help Content Management

222
Oracle Applications Cloud Glossary
Configuring and Extending Applications

Glossary
accounting flexfield
The structure that determines the chart of accounts, including the number and order of the individual segments, as well
as assigning the value sets to the segments.

action
The kind of access, such as view or edit, named in a security policy.

ADF
Application Developer Framework. A set of programming principles and rules for developing software applications.

analysis
A selection of data displayed in one or more views, such as a table or chart, to provide answers to business questions.

analytics
Business intelligence objects such as analyses and dashboards that provide meaningful data to help with decision
making.

business object
A resource in an enterprise database, such as an invoice or purchase order.

chrome
The set of visual elements (for example, header; expand and edit icons) around the perimeter of a component or task
flow that enables users to act directly on the object.

configuration
A change to the predefined artifacts of the application. Configurations impact multiple users.

context
A grouping of flexfield segments to store related information.

context layer
A level that represents the scope of users impacted by configurations. For example, all users or only those who meet
specific criteria.

context segment
The flexfield segment used to store the context value. Each context value can be associated with a different set of
context-sensitive segments.

223
Oracle Applications Cloud Glossary
Configuring and Extending Applications

context-sensitive segment
A flexfield segment that may or may not appear depending upon a context. Context-sensitive segments are attributes
that apply to certain entity rows based on the value of the context segment.

dashboard
A collection of analyses and other content that gives in-depth insight to help with business decisions.

dashboard
A page that gives quick access to key tasks and summary information for a business process or object.

data security
The control of access and action a user can take against which data.

descriptive flexfield
Expandable fields used for capturing additional descriptive information or attributes about an entity, such as a customer
case. You may configure information collection and storage based on the context.

detailed report
A comprehensive report that provides detailed information about the subject matter. When you link a detailed report to
an infolet, users can click anywhere in the infolet area to drill down to that detailed report.

enterprise
An organization having common control over one or more legal entities.

extensible flexfield
Expandable fields that you can use to capture multiple sets of information in a context or in multiple contexts. Some
extensible flexfields let you group contexts into categories.

extension
A new artifact in addition to what's predefined in the application, for example a new business object or page.

feature
Business practices or methods applicable to the functional areas that enable the fine-tuning of business functionality.

filmstrip
The single strip of icons that you can use to open other pages. The strip appears between the global header and the
page title.

flexfield
A flexible data field that you can configure such that it contains one or more segments or stores additional information.
Each segment has a value and a meaning.

224
Oracle Applications Cloud Glossary
Configuring and Extending Applications

flexfield segment
An extensible data field that represents an attribute and captures a value corresponding to a predefined, single
extension column in the database. A segment appears globally or based on a context of other captured information.

global header
The uppermost region in the user interface that remains the same no matter which page you're on.

infolet
A small, interactive widget on the home page that provides key information and actions for a specific area, for example
social networking or your personal profile. Each infolet can have multiple views.

job role
A role, such as an accounts payable manager or application implementation consultant, that usually identifies and
aggregates the duties or responsibilities that make up the job.

key flexfield
Configurable flexfield comprising multiple parts or segments, each of which has a meaning either individually or in
combination with other segments. Examples of key flexfields are part numbers, asset category, and accounts in the
chart of accounts.

key flexfield segment instance


A single occurrence of a key flexfield segment in a key flexfield structure instance.

key flexfield structure


The arrangement of segments in a key flexfield. In some cases, you can define multiple structures for a single key
flexfield.

key flexfield structure instance


An occurrence of a key flexfield structure that shares the same order of segments as other instances of the key flexfield
structure. However, each instance uses different value sets to validate the segments.

mainline metadata
The primary branch of metadata that a sandbox is published to. Once published, changes made in the sandbox become
available to all users.

Navigator
The menu in the global header that you can use to open the work areas and dashboards that you have access to.

offering
A comprehensive grouping of business functions, such as Sales or Product Management, that is delivered as a unit to
support one or more business processes.

225
Oracle Applications Cloud Glossary
Configuring and Extending Applications

panel tab
A tab that provides supplemental information or functionality for the page. Each panel tab is on the right side of the
page, has an icon as the tab label, and slides out when you open the tab.

performance tile
A single, summary measure value displayed prominently with, in some cases, a trend line.

performance tile report


A summary report that shows data in the small infolet format. When you add a performance tile report to an infolet,
users can see summary information about the subject matter.

personalization
A change that users make to control the look or behavior of the application. Personalizations impact only the user
making the change.

privilege
A grant of access to functions and data; a single, real world action on a single business object.

report
An output of select data in a predefined format that's optimized for printing.

role
Controls access to application functions and data.

run time
The type of activities that users perform while they are in a running application.

sandbox
A testing environment that isolates untested code changes from the mainline environment so that these changes don't
affect the mainline metadata or other sandboxes.

scheduled process
A program that you run to process data and, in some cases, generate output as a report.

segment
A segment is a single field within a flexfield and maps to a single table column in your database. When configuring a
flexfield, you define the appearance and meaning of individual segments.

226
Oracle Applications Cloud Glossary
Configuring and Extending Applications

site layer
Application changes made in this layer affect all users.

springboard
The grid of icons on the home page that you can use to open pages.

task flow infolet


An infolet that displays summary information about a task.

tree
Information or data organized into a hierarchy with one or more root nodes connected to branches of nodes. A tree
must have a structure where each node corresponds to data from one or more data sources.

tree structure
A set of guidelines or a framework applied to create a tree, include data, version a tree, or access a tree.

value set
A predefined set to validate the values that a user enters in the application. The set may be hierarchical.

work area
A set of pages containing the tasks, searches, and other content you need to accomplish a business goal.

227
Oracle Applications Cloud Glossary
Configuring and Extending Applications

228

You might also like