View
231
Download
0
Category
Preview:
Citation preview
8/13/2019 Secure Enterprise Search Modeler User's Guide
1/66
Oracle E-Business Suite
Secure Enterprise Search Modeler User's Guide
Release 12
Part No. E12264-01
September 2008
8/13/2019 Secure Enterprise Search Modeler User's Guide
2/66
Oracle E-Business Suite Secure Enterprise Search Modeler User's Guide, Release 12
Part No. E12264-01
Copyright 2008, Oracle and/or its affiliates. All rights reserved.
Primary Author: Melody Yang
Contributing Author: Mamata Challagulla, Rajesh Ghosh, Saritha Merugu, Vikas Soolapani
Oracle is a registered trademark of Oracle Corporation and/or its affiliates. Other names may be trademarksof their respective owners.
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 permitted 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 find any errors, please report them to us in writing.
If this software or related documentation is delivered to the U.S. Government or anyone licensing it on behalf
of the U.S. Government, the following notice is applicable:
U.S. GOVERNMENT RIGHTSPrograms, software, databases, and related documentation and technical data delivered to U.S. Government
customers are "commercial computer software" or "commercial technical data" pursuant to the applicable
Federal Acquisition Regulation and agency-specific supplemental regulations. As such, the use, duplication,
disclosure, modification, and adaptation shall be subject to the restrictions and license terms set forth in the
applicable Government contract, and, to the extent applicable by the terms of the Government contract, the
additional rights set forth in FAR 52.227-19, Commercial Computer Software License (December 2007). Oracle
USA, Inc., 500 Oracle Parkway, Redwood City, CA 94065.
This software 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 which may
create a risk of personal injury. If you use this software in dangerous applications, then you shall be
responsible to take all appropriate fail-safe, backup, redundancy and other measures to ensure the safe use of
this software. Oracle Corporation and its affiliates disclaim any liability for any damages caused by use of this
software in dangerous applications.This software and documentation may provide access to or information on content, products and services
from third parties. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all
warranties of any kind with respect to third party content, products and services. Oracle Corporation and its
affiliates 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.
8/13/2019 Secure Enterprise Search Modeler User's Guide
3/66
iii
Contents
Send Us Your Comments
Preface
1 Search Modeler Overview
Overview................................................................................................................................... 1-1
Search Modeler Related Key Terms and Definitions...............................................................1-2
Architecture Overview.............................................................................................................. 1-3
2 Setting Up Search Modeler
Setup and Dependencies...........................................................................................................2-1Moving Searchable Object Metadata Definitions Between Instances.................................... 2-2
3 Using Metadata-based Search Modeler
Accessing the Search Modeler User Interfaces......................................................................... 3-1
Searching and Viewing Searchable Objects.............................................................................3-2
Creating Searchable Objects..................................................................................................... 3-5
Updating Searchable Objects..................................................................................................3-23
Deleting Searchable Objects................................................................................................... 3-28
Managing Searchable Object Security....................................................................................3-28
Managing Searchable Group Subscriptions....................................................................... 3-29
Adding Security Search Plug-in.........................................................................................3-33
Deploying Searchable Objects................................................................................................3-35
Index
8/13/2019 Secure Enterprise Search Modeler User's Guide
4/66
8/13/2019 Secure Enterprise Search Modeler User's Guide
5/66
v
Send Us Your Comments
Oracle E-Business Suite Secure Enterprise Search Modeler User's Guide, Release 12
Part No. E12264-01
Oracle welcomes customers' comments and suggestions on the quality and usefulness of this document.Your feedback is important, and helps us to best meet your needs as a user of our products. For example:
Are the implementation steps correct and complete?
Did you understand the context of the procedures?
Did you find any errors in the information?
Does the structure of the information help you with your tasks?
Do you need different information or graphics? If so, where, and in what format?
Are the examples correct? Do you need more examples?
If you find any errors or have any other suggestions for improvement, then please tell us your name, the
name of the company who has licensed our products, the title and part number of the documentation andthe chapter, section, and page number (if available).
Note: Before sending us your comments, you might like to check that you have the latest version of the
document and if any concerns are already addressed. To do this, access the new Applications Release
Online Documentation CD available on Oracle MetaLink and www.oracle.com. It contains the most
current Documentation Library plus all documents revised or released recently.
Send your comments to us using the electronic mail address: appsdoc_us@oracle.com
Please give your name, address, electronic mail address, and telephone number (optional).
If you need assistance with Oracle software, then please contact your support representative or Oracle
Support Services.
If you require training or instruction in using Oracle software, then please contact your Oracle local office
and inquire about our Oracle University offerings. A list of Oracle offices is available on our Web site at
www.oracle.com.
8/13/2019 Secure Enterprise Search Modeler User's Guide
6/66
8/13/2019 Secure Enterprise Search Modeler User's Guide
7/66
vii
Preface
Intended Audience
Welcome to Release 12 of the Oracle E-Business Suite Secure Enterprise Search ModelerUser's Guide.
This guide assumes you have a working knowledge of the following:
The principles and customary practices of your business area.
Computer desktop application usage and terminology.
If you have never used Oracle Applications, we suggest you attend one or more of the
Oracle Applications training classes available through Oracle University.
See Related Information Sources on page viiifor more Oracle Applications product
information.
TTY Relay Access to Oracle Support Services
To reach AT&T Customer Assistants, dial 711 or 1.800.855.2880. An AT&T Customer
Assistant will relay information between the customer and Oracle Support Services at
1.800.223.1711. Complete instructions for using the AT&T relay services are available at
http://www.consumer.att.com/relay/tty/standard2.html. After the AT&T Customer
Assistant contacts Oracle Support Services, an Oracle Support Services engineer will
handle technical issues and provide customer support according to the Oracle service
request process.
Documentation Accessibility
Our goal is to make Oracle products, services, and supporting documentation accessible
to all users, including users that are disabled. To that end, our documentation includes
features that make information available to users of assistive technology. This
8/13/2019 Secure Enterprise Search Modeler User's Guide
8/66
viii
documentation is available in HTML format, and contains markup to facilitate access by
the disabled community. Accessibility standards will continue to evolve over time, and
Oracle is actively engaged with other market-leading technology vendors to address
technical obstacles so that our documentation can be accessible to all of our customers.
For more information, visit the Oracle Accessibility Program Web site at
http://www.oracle.com/accessibility/.
Accessibility of Code Examples in Documentation
Screen readers may not always correctly read the code examples in this document. The
conventions for writing code require that closing braces should appear on an otherwise
empty line; however, some screen readers may not always read a line of text that
consists solely of a bracket or brace.
Accessibility of Links to External Web Sites in Documentation
This documentation may contain links to Web sites of other companies or organizations
that Oracle does not own or control. Oracle neither evaluates nor makes any
representations regarding the accessibility of these Web sites.
Structure1 Search Modeler Overview
2 Setting Up Search Modeler
3 Using Metadata-based Search Modeler
Related Information Sources
This book is included on the Oracle Applications Documentation Library, which is
supplied in the Release 12 Media Pack. You can download soft-copy documentation as
PDF files from the Oracle Technology Network at http://otn.oracle.com/documentation,
or you can purchase hard-copy documentation from the Oracle Store at
http://oraclestore.oracle.com. The Oracle Applications Release 12 Documentation
Library contains the latest information, including any documents that have changed
significantly between releases. If substantial changes to this book are necessary, a
revised version will be made available on the "virtual" documentation library on Oracle
MetaLink.
If this guide refers you to other Oracle Applications documentation, use only the latest
Release 12 versions of those guides.
Online Documentation
All Oracle Applications documentation is available online (HTML or PDF).
Online Help- Online help patches (HTML) are available on OracleMetaLink.
PDF Documentation- See the Oracle Applications Documentation Library for
8/13/2019 Secure Enterprise Search Modeler User's Guide
9/66
ix
current PDF documentation for your product with each release. The Oracle
Applications Documentation Library is also available on OracleMetaLinkand is
updated frequently.
Oracle Electronic Technical Reference Manual -The Oracle Electronic Technical
Reference Manual (eTRM) contains database diagrams and a detailed description of
database tables, forms, reports, and programs for each Oracle Applications product.
This information helps you convert data from your existing applications and
integrate Oracle Applications data with non-Oracle applications, and write custom
reports for Oracle Applications products. The Oracle eTRM is available on Oracle
MetaLink.
Related Guides
You should have the following related books on hand. Depending on the requirements
of your particular installation, you may also need additional manuals or guides.
Oracle Applications Concepts
This book is intended for all those planning to deploy Oracle E-Business Suite Release
12, or contemplating significant changes to a configuration. After describing the Oracle
Applications architecture and technology stack, it focuses on strategic topics, giving a
broad outline of the actions needed to achieve a particular goal, plus the installation and
configuration choices that may be available.
Oracle Applications CRM System Administrator's Guide
This manual describes how to implement the CRM Technology Foundation (JTT) and
use its System Administrator Console.
Oracle Applications Developer's Guide
This guide contains the coding standards followed by the Oracle Applicationsdevelopment staff. It describes the Oracle Application Object Library components
needed to implement the Oracle Applications user interface described in the Oracle
Applications User Interface Standards for Forms-Based Products. It provides information to
help you build your custom Oracle Forms Developer forms so that they integrate with
Oracle Applications. In addition, this guide has information for customizations in
features such as concurrent programs, flexfields, messages, and logging.
Oracle Applications System Administrator's Guide Documentation Set
This documentation set provides planning and reference information for the Oracle
Applications System Administrator. Oracle Applications System Administrator's Guide -
Configurationcontains information on system configuration steps, including defining
concurrent programs and managers, enabling Oracle Applications Manager features,
and setting up printers and online help. Oracle Applications System Administrator's Guide
- Maintenanceprovides information for frequent tasks such as monitoring your system
with Oracle Applications Manager, administering Oracle E-Business Suite Secure
Enterprise Search, managing concurrent managers and reports, using diagnostic
utilities including logging, managing profile options, and using alerts. Oracle
8/13/2019 Secure Enterprise Search Modeler User's Guide
10/66
x
Applications System Administrator's Guide - Securitydescribes User Management, data
security, function security, auditing, and security configurations.
Oracle Applications User's Guide
This guide explains how to navigate, enter data, query, and run reports using the user
interface (UI) of Oracle Applications. This guide also includes information on setting
user profiles, as well as running and reviewing concurrent requests.
Oracle Applications User Interface Standards for Forms-Based Products
This guide contains the user interface (UI) standards followed by the Oracle
Applications development staff. It describes the UI for the Oracle Applications products
and how to apply this UI to the design of an application built by using Oracle Forms.
Integration Repository
The Oracle Integration Repository is a compilation of information about the service
endpoints exposed by the Oracle E-Business Suite of applications. It provides a
complete catalog of Oracle E-Business Suite's business service interfaces. The tool letsusers easily discover and deploy the appropriate business service interface for
integration with any system, application, or business partner.
The Oracle Integration Repository is shipped as part of the E-Business Suite. As your
instance is patched, the repository is automatically updated with content appropriate
for the precise revisions of interfaces in your environment.
Do Not Use Database Tools to Modify Oracle Applications Data
Oracle STRONGLY RECOMMENDS that you never use SQL*Plus, Oracle Data
Browser, database triggers, or any other tool to modify Oracle Applications data unlessotherwise instructed.
Oracle provides powerful tools you can use to create, store, change, retrieve, and
maintain information in an Oracle database. But if you use Oracle tools such as
SQL*Plus to modify Oracle Applications data, you risk destroying the integrity of your
data and you lose the ability to audit changes to your data.
Because Oracle Applications tables are interrelated, any change you make using an
Oracle Applications form can update many tables at once. But when you modify Oracle
Applications data using anything other than Oracle Applications, you may change a
row in one table without making corresponding changes in related tables. If your tables
get out of synchronization with each other, you risk retrieving erroneous information
and you risk unpredictable results throughout Oracle Applications.
When you use Oracle Applications to modify your data, Oracle Applications
automatically checks that your changes are valid. Oracle Applications also keeps track
of who changes information. If you enter information into database tables using
database tools, you may store invalid information. You also lose the ability to track who
has changed your information because SQL*Plus and other database tools do not keep a
8/13/2019 Secure Enterprise Search Modeler User's Guide
11/66
xi
record of changes.
8/13/2019 Secure Enterprise Search Modeler User's Guide
12/66
8/13/2019 Secure Enterprise Search Modeler User's Guide
13/66
Search Modeler Overview 1-1
1Search Modeler Overview
This chapter covers the following topics:
Overview
Search Modeler Related Key Terms and Definitions
Architecture Overview
Overview
Searchable objects are the key elements in the crawling mechanism that makes a search
possible and available to users. For example, a purchase order is a searchable object that
can be defined as a set of searchable properties or business attributes along with its
relationship to other searchable objects. Before crawling starts, these searchable
attributes and entities must be designed and implemented as business or view objects.
This usually requires a longer design cycle and implementation process for application
developers to model the design and modify the changes.
To simplify the searchable object design and modeling processes specifically for your
business needs, Oracle E-Business Suite Secure Enterprise Search introduces a
lightweight browser-based tool called Search Modeler which allows data modelers or
developers to easily create and modify searchable objects and metadata without
extensive programming skills or design as required in other development tool.
By leveraging application database object metadata, Search Modeler provides a
browser-based search infrastructure that not only has a user-friendly interface, but also
simplifies the entire searchable object creation, update, and management processes
throughout the object deployment life cycle.
Search Modeler allows easier and faster updates and creation on searchable objects
including selecting tables or views for an object, establishing the relationships between
them, and identifying searchable attributes. It also allows you to add search plug-ins
and deploy searchable objects to an Oracle Secure Enterprise Search (SES) instance.
Major Features
8/13/2019 Secure Enterprise Search Modeler User's Guide
14/66
1-2 Oracle E-Business Suite Secure Enterprise Search Modeler User's Guide
In general, Search Modeler provides the following features:
Provides a lightweight, browser-based architecture and a user-friendly user
interface
Leverages Oracle E-Business Suite metadata about database objects required for the
search infrastructure
Requires low to medium programming skill
Simplifies administrative tasks such as maintaining searchable groups through
group subscriptions
Provides diagnostic capability and loosely coupled architecture
Search Modeler Related Key Terms and Definitions
To better understand Search Modeler, this section provides relevant terminologies andtheir definitions used in Search Modeler of Oracle E-Business Suite Secure Enterprise
Search.
Searchable Objects
Searchable objects are business objects that are made available for text search; they are
used in an abstract way for exposing business data to search engines. For example, a
purchase order as a searchable object would be defined as a set of searchable properties
and its relationship to other searchable objects.
EntitiesEntities are database tables or views stored in the application metadata. With this
metadata-based design framework, Search Modeler allows searchable objects to be
created based on selected entities and the entity relationships that are used to construct
the Whereclause of the SQL statement to fetch data for indexing.
Each entity has to be associated with an alias; each alias has to be unique within a query
group.
Query Groups
Search Modeler uses query groups to organize a set of entities selected for a searchable
object. Query groups can also be used in building master-detail relationships within theset of entities or query groups for complex searchable objects.
Search Attributes
A searchable object can have multiple attributes and these attributes are bound to
business data through the object definition.
8/13/2019 Secure Enterprise Search Modeler User's Guide
15/66
Search Modeler Overview 1-3
Attributes are the table columns to be indexed for search. The text to be indexed is
actually stored in various columns of tables or views in Oracle E-Business Suite. Search
Modeler provides the facility to select columns as attributes of the selected entities for a
searchable object.
Entity RelationshipsAn entity relationship represents the relationship between different entities. It is used to
construct the Whereclause of the SQL statement to fetch data for indexing. Because
Search Modeler leverages Oracle E-Business Suite application metadata, when an entity
is selected and added to a searchable object, the relationships between the selected
entity and existing entities are automatically retrieved from the repository if possible. In
other words, the entity relationship selections are defaulted based on the application
metadata for your searchable object.
Related Actions
Related actions are displayed in URLs as a search result when searching on a searchableobject. Actionable links can be of various types, such as visiting external URLs.
Security Plug-in
Search Modeler uses security plug-in to support custom or user-defined security rules
at the object level.
The security plug-in feature allows a list of permissions contained in an access control
list (ACL) to be attached to an object in specifying who or what is allowed to access the
object and what operations are allowed to be performed.
Architecture OverviewOracle E-Business Suite Secure Enterprise Search development framework uses a
flexible design mechanism which allows searchable objects to be created or modeled
based on application metadata stored in Oracle E-Business Suite database.
Once searchable objects are created at design time and enforced with appropriate
security rules, they will then be used during crawl time to conduct searches and store
data, and used during query time to qualify results.
The following metadata-based architecture diagram illustrates how application
metadata is used in defining searchable objects, and the interaction between Oracle
E-Business Suite Secure Enterprise Search and Oracle SES:
8/13/2019 Secure Enterprise Search Modeler User's Guide
16/66
1-4 Oracle E-Business Suite Secure Enterprise Search Modeler User's Guide
Metadata-based Architecture Diagram
Data modelers or business analysts create or validate searchable objects using Search
Modeler that retrieves pre-populated application metadata contained in Object
Repository, and business objects from Application Object Library dictionary or other
metadata dictionaries. These searchable objects have entity relationships and searchable
attributes established during the object creation and become searchable metadata.Necessary security plug-ins can also be placed while creating the object. An application
developer plugs in a searchable region to an application page if needed.
Oracle E-Business Suite Secure Enterprise Search utilizes SES Document Builder to
construct this searchable metadata or object which may contain complex business
structure into a flattened searchable document. This document is also known as SES
Document.
A search administrator can have an option to create security grants through application
user interfaces to secure searchable objects.
The search administrator or system administrator configures the necessary Oracle SES
proxy parameters and setup tasks both in Oracle E-Business Suite Secure EnterpriseSearch and Oracle SES. This configuration enables Oracle SES to crawl Oracle
E-Business Suite (EBS), and Oracle E-Business Suite to query Oracle SES.
When an application user performs a search through application interfaces, a query is
executed by invoking a search against a preindexed search store in Oracle SES.
8/13/2019 Secure Enterprise Search Modeler User's Guide
17/66
Search Modeler Overview 1-5
Design Time
To simplify the object design and modeling processes, data modelers can use the
lightweight, browser-based Search Modeler to create or model searchable objects based
on database tables or views which are directly derived from application metadata.
A data modeler selects desired tables or views for a searchable object, establishes the
relationship between them, and then adds related table relationships for any selected
tables. In addition, a search administrator can use this lightweight tool to manage
searchable groups and deploy searchable objects to Oracle SES.
This following diagram illustrates the metadata-based interaction flow during the
design time:
Metadata-based Design Time Process Diagram
1. Search browser loads the product family taxonomy information from Integration
Repository and the seeded business object definition from Object Repository.
2. Once a searchable object is created or updated with necessary search attributes,
target UI, group information, or security plug-ins, this new object or updated
information is saved in Object Repository.
3. Search metadata is then stored as business objects or searchable objects.
4. The search administrator can create security grants to grant object access privileges
to appropriate users or user groups.
5. The search administrator deploys the searchable objects to Oracle SES as data
8/13/2019 Secure Enterprise Search Modeler User's Guide
18/66
1-6 Oracle E-Business Suite Secure Enterprise Search Modeler User's Guide
sources.
6. The Oracle SES administrator manages crawling schedules that contain data
sources.
7. The crawler manager picks the data source for crawl based on the schedules.
Crawl Time
After searchable objects are deployed to Oracle SES as data sources contained in
crawling schedules, Oracle SES starts crawling jobs in the Oracle E-Business Suite. A
"crawlable" Oracle E-Business Suite means a secure end point that has been made
crawlable to Oracle SES. This allows application data to be crawled and indexed into an
Oracle SES store.
For metadata-based design approach, searchable objects, stored in Object Repository,
containing selected entities and entity relationships are first uploaded to SQL Generator
to construct the Whereclause of the SQL statement to fetch data for indexing. Searchmetadata along with SQL statements are then uploaded to the Crawlable Factory.
The following diagram illustrate the metadata-based interaction flow of Oracle SES
crawler tasks:
Metadata-based Crawl Time Process Diagram
1. The Oracle SES crawler manager kicks off a scheduled crawling job for a given data
source. The Oracle SES HTTP(s) crawler manager creates a number of crawlers SES
and then Oracle SES starts crawlers.
Note: The Oracle SES crawler is a Java process activated by a set
schedule. When activated, the crawler spawns a configurable
number of processor threads that fetch information from various
8/13/2019 Secure Enterprise Search Modeler User's Guide
19/66
Search Modeler Overview 1-7
sources and index the documents. This index is used for searching
sources.
2. The crawler takes an URL from the URL queue.
3. The crawler makes a request to Oracle E-Business Suite per URL.
4. The Crawlable Factory is responsible for splitting the original application content
large data set into smaller work units through AD Parallel Update package, and
then crawling the units in parallel by using the multi-thread crawling mechanism
provided by Oracle SES.
5. The Crawlable Factory queries on information from application content change log.
6. Content change log provides application changes that are indexed to the Crawlable
Factory.
7. The Crawlable Factory extracts application content with search metadata.
8. Searchable objects, stored in Object Repository, containing selected entities and
entity relationships are uploaded to SQL Generator to construct the Whereclause of
the SQL statement to fetch data for indexing.
9. Search metadata along with SQL statements are uploaded to the Crawlable Factory.
10. The Crawlable Factory constructs (crawlable) XML documents and passes them to
Oracle SES through the E-Business Suite end point URL.
These documents conform to Oracle SES crawlable schema and should havefollowing information:
Metadata
Content to be indexed
Dependent document URLs (such as actionable links, attachments, related
documents or links)
11. Crawlable XML documents get loaded to Oracle SES.
12. On retrieving the document, the crawler parses the document. Other crawlers takethe URL from URL queue and repeat from step 2.
13. The crawler forms an indexable document based on the content in the crawlable
and pass it to Oracle SES indexer. This step might require a number of requests if
there are dependent URLs.
8/13/2019 Secure Enterprise Search Modeler User's Guide
20/66
1-8 Oracle E-Business Suite Secure Enterprise Search Modeler User's Guide
14. Indexed documents are stored in the precrawled index store in Oracle SES.
Query Time
When an application user performs a search from the centralized search user interfaces,
the user actually queries from a preindexed store in Oracle SES.
Searchable group security rule restricts the user access on searchable groups when
performing a user query. Only those who have the group access privileges can find the
group names displayed from the list of values for search selection.
The following diagram illustrates the query time interaction flow:
Metadata-based Process Flow at Query Time
1. The application user issues a search query through a centralized search UI which
invokes the application query engine to retrieve searchable object definition.
2. The query engine generates security keys to searchable objects.
3. Based on security keys, the query engine invokes the Searcher to start the search.
4. The searcher matches search keywords or predicate to documents against the
precrawled index store in Oracle SES.
5. The query engine posts the query with indexed documents which contain search
hits and hit metadata.
6. Security filters are applied to the indexed documents.
7. The query engine applies post-query security rules when appropriate for each hit in
the indexed documents.
8/13/2019 Secure Enterprise Search Modeler User's Guide
21/66
Search Modeler Overview 1-9
8. Actionable links are added to the indexed documents if appropriate for each hit.
9. Related results are added to the indexed documents if appropriate for each hit.
10. The query engine constructs search hits along with actionable links and related
results if appropriate as result documents.
11. Application UI renders the search results to the user.
8/13/2019 Secure Enterprise Search Modeler User's Guide
22/66
8/13/2019 Secure Enterprise Search Modeler User's Guide
23/66
Setting Up Search Modeler 2-1
2Setting Up Search Modeler
Setup and Dependencies
Search Modeler is a browser-based tool that builds on application database andmiddle-tier. It also relies on external components or products to have the function work
properly. Before installing Search Modeler, you must first understand the product
dependencies or interactions between other components.
Product Dependencies
Search Modeler has dependencies on the following products in order to have its
features work properly:
Oracle E-Business Suite Secure Enterprise Search
Search Modeler is a development tool where data modelers or administrators can
create and deploy searchable objects. Once objects are deployed to Oracle SES,
related setup tasks and configuration in order for the deployed objects to be
crawled are performed in the Oracle E-Business Suite Secure Enterprise Search
administrative UI.
Additionally, Search Modeler relies on Oracle E-Business Suite Secure Enterprise
Search for a user query against the preindex store in Oracle SES.
Note: Oracle E-Business Suite Secure Enterprise Search is released
with Oracle E-Business Suite Release 12.0.4 (and onwards) and
Oracle Secure Enterprise Search (Oracle SES) 10.1.8.3.
Oracle SES 10.1.8.3 is certified with Oracle E-Business Suite 12.0.4
and onwards.
Fore more information about how to perform setup and administrative tasks for
Oracle E-Business Suite Secure Enterprise Search, see Administering Oracle
E-Business Suite Secure Enterprise Search, Oracle Applications System Administrator's
Guide - Maintenancefor details.
8/13/2019 Secure Enterprise Search Modeler User's Guide
24/66
2-2 Oracle E-Business Suite Secure Enterprise Search Modeler User's Guide
OC4J 10.1.3.3
Search Modeler can be deployed to a standalone OC4J 10.1.3.3 environment with
some required setup steps.
Oracle ADF 10.1.3.3 Libraries
Prior to deploying Search Modeler to a standalone OC4J 10.1.3.3 environment, you
must first install Oracle ADF 10.1.3.3 libraries into the standalone OC4J Oracle
Home. Therefore, Search Modeler also has dependency on the Oracle ADF 10.1.3.3
libraries.
Java Development Kit (JDK) 1.5
Similar to the Oracle ADF 10.1.3.3 libraries, since you need to install JDK 1.5 on the
same machine where OC4J is installed, Search Modeler also has dependency on the
JDK 1.5 if you want to deploy it to a standalone OC4J 10.1.3.3 environment.
Oracle Application Server 10.1.3.3
In addition to deploying Search Modeler to a standalone OC4J 10.1.3.3
environment, Search Modeler can also be installed on the Oracle Application Server
10.1.3.3 environment.
For Search Modeler installation and deployment steps, refer to Oracle E-Business Suite
Secure Enterprise Search Documentation Update, Release 12, OracleMetaLinkDocument
551247.1 for details.
Moving Searchable Object Metadata Definitions Between Instances
Oracle recommends that you never use Search Modeler with an Oracle E-Bsuiness SuitePRODUCTION environment. The searchable objects can be designed and tested in a
development environment and later be transported into the production environment
through the standard data loader technique.
Once you have searchable objects created, deployed, and tested in a development
instance, and you are satisfied with the content, you can then transfer those object
definitions from the development instance to the production instance where you will
have to deploy searchable objects again and crawl the objects.
Note: Development instance is the environment where you should
perform all the necessary tests including crawling the objects to ensure
that the newly created objects can be properly integrated and searched
in Oracle E-Business Suite. Therefore, both development and
production instances should have their own Oracle SES engines
connected and set up properly for seamless integration with Oracle
SES.
For detailed information on how to perform setup and configuration
8/13/2019 Secure Enterprise Search Modeler User's Guide
25/66
Setting Up Search Modeler 2-3
tasks, as well as how to validate the setups including testing
deployment, crawling schedules, and searches, see Administering
Oracle E-Business Suite Secure Enterprise, Oracle Applications System
Administrator's Guide - Maintenance.
Perform the following steps to move your searchable object definitions from one
instance to another:
1. Use Telnet to have command access to the Oracle E-Business Suite source instance.
2. Source the environment file.
3. Issue the following command to download the object definitions from the source
instance:
FNDLOAD apps/0 Y DOWNLOAD$FND_TOP/patch/115/import/afsearch.lct .ldt OBJECTOBJ_NAME=':'
where ='EBSXXOBJ'
and = Object name used in Search Modeler with
space replaced by '_'. This is case sensitive.
Note: ='EBSOBJ'is for Oracle internal use.
4. Move the .ldt to the target instance.
5. Issue the following command to upload:
FNDLOAD apps/0 Y UPLOAD$FND_TOP/patch/115/import/afsearch.lct .ldt
6. You may optionally have to ship your Java security plug-in class under
$JAVA_TOPofEBS.
8/13/2019 Secure Enterprise Search Modeler User's Guide
26/66
8/13/2019 Secure Enterprise Search Modeler User's Guide
27/66
Using Metadata-based Search Modeler 3-1
3Using Metadata-based Search Modeler
This chapter covers the following topics:
Accessing the Search Modeler User Interfaces
Searching and Viewing Searchable Objects
Creating Searchable Objects
Updating Searchable Objects
Deleting Searchable Objects
Managing Searchable Object Security
Deploying Searchable Objects
Accessing the Search Modeler User Interfaces
When you have Search Modeler set up or installed appropriately, you should find the
Search Modeler login page appears allowing you to log on to the browser-based user
interface.
The Search Modeler login page should have the following URL:
http://:/modeler/faces/Login.jsp
Use a valid Oracle E-Business Suite username and password to log on to the Search
Modeler UI.
8/13/2019 Secure Enterprise Search Modeler User's Guide
28/66
3-2 Oracle E-Business Suite Secure Enterprise Search Modeler User's Guide
Search Modeler Login Page
After logging on to the Search Modeler UIs, the Search Modeler main page appears
where by default all searchable objects are displayed. You can view object details and
create, update, delete, or deploy a searchable object.
To have a better understanding of how to use Search Modeler in assisting searchable
objects creation and modeling, the following topics are discussed in this chapter:
Searching and viewing searchable objects, page 3-2
Creating searchable objects, page 3-5
Updating searchable objects, page 3-23
Deleting searchable objects, page 3-28
Adding security search plug-in, page 3-33
Managing searchable group subscriptions, page 3-29
Deploying searchable objects, page 3-35
Searching and Viewing Searchable Objects
All searchable objects stored in the Search Modeler infrastructure are categorized by
product family and product. This classification allows you to perform searches by
entering appropriate values for product family, product, object name, or display name
as search criteria in the Filter region.
You can enter partial values containing wildcard characters ('%') in the Name and
Display Name fields and click Goto execute the search.All searchable objects that match your search criteria will be displayed in a tabular
format in the Searchable Objects region.
Note: By default, all searchable objects created through Search Modeler
can be retrieved once you log on to the Search Modeler user interface.
8/13/2019 Secure Enterprise Search Modeler User's Guide
29/66
Using Metadata-based Search Modeler 3-3
However, you can filter the result by entering search criteria in the
Filter region to locate the object you desired.
Viewing Searchable Objects
To easier identify and locate your desired searchable objects, Oracle E-Business SuiteSecure Enterprise Search allows you to view the search results displayed based on the
selected value from the View By drop-down list:
Searchable Objects
When 'Searchable Objects' is selected from the View By drop-down list, your search
results are organized by searchable object names. Additional object information
including description, product family, and product is also displayed.
View By Searchable Objects
Product Family
When 'Product Family' is selected from the View By drop-down list, your search
results are displayed as a hierarchical tree structure based on product family. You
can expand or collapse the tree nodes to locate your desired objects.
8/13/2019 Secure Enterprise Search Modeler User's Guide
30/66
3-4 Oracle E-Business Suite Secure Enterprise Search Modeler User's Guide
View By Product Family
Regardless of your selected display method (either view by searchable objects or
product family), you can sort the result display in ascending order for a selected columnname. For example, click on Product column name will sort the result display based on
Product in ascending order; click on Object Description column name will sort the
result display based on Object Description in ascending order.
From the search results, you can perform the following tasks if you have appropriate
privileges:
Create a new searchable object by clicking Create Searchable Object.
See: Creating Searchable Objects, page 3-5.
Update or review a searchable object by clicking the Review and Updateicon
See: Updating Searchable Objects, page 3-23.
Edit basic object information for a selected object by clicking Edit Row. The
Description, Product Name, and Product Family fields become available for your
update. Click Doneto save your changes and these fields returned to a view-only
mode.
8/13/2019 Secure Enterprise Search Modeler User's Guide
31/66
Using Metadata-based Search Modeler 3-5
Deploy a selected searchable object by clicking Deploy.
See: Deploying Searchable Objects, page 3-35.
Delete a selected searchable object by clicking Delete. This allows you to delete an
undeployed searchable object. If the selected object has been deployed to Oracle
SES, you cannot delete the object.
See: Deleting Searchable Objects, page 3-28.
Refresh your current page by clicking Refresh Page.
Manage groups by clicking the Group subscriptionsicon.
See: Managing Searchable Group Subscriptions, page 3-29.
Creating Searchable Objects
A searchable object is the basic element used in defining and enabling searches. Userssearch on application content based on authorized searchable groups that contain
searchable objects. Therefore, searchable objects must be set up first, constructed with
secure context, and indexed into a full text search engine by Oracle SES in order to be
ready for user query.
Based on application metadata, Search Modeler allows searchable objects to be created
in a faster and easier way. To create a searchable object, a data modeler or developer
should model the design with the following logic:
1. Identify the logical model for the object that you want to create.
Determine what business object is going to be searched and what attributes are to
be included. For example, to create a Employee Purchase Requisition searchableobject, you need to include the following information:
Requisition Header Information: This includes requisition date, type, buyer,
and other header information.
Requisition Line Information: This includes item code, item description and
other line information.
2. Select desired entities which are database tables or views from the application
metadata in Search Modeler.
This is to select physical database objects for the logical model. For example,database tables that represent requisition header and line are:
Requisition Header: PO_REQUISITION_HEADERS_ALL (Purchasing) and
PER_ALL_PEOPLE_F (Human Resource)
Requisition Line: PO_REQUISITION_LINES_ALL
8/13/2019 Secure Enterprise Search Modeler User's Guide
32/66
3-6 Oracle E-Business Suite Secure Enterprise Search Modeler User's Guide
3. Establish key relationships between selected tables/views.
For example, determine the keys that can uniquely establish the following
relationships:
The primary-secondary group relationship between Requisition Header and
Requisition Line
The entity relationship between two primary groups,
PO_REQUISITION_HEADERS_ALL (Purchasing) and PER_ALL_PEOPLE_F
(Human Resource)
4. Identify searchable attributes for each selected entity.
Determine whether the object instance of a selected entity can be used for a
particular purpose, including indexing, storing, displaying, and securing.
5. Add additional object details including search related properties, group relations,
related actions, and object relations.Determine related objects that would be helpful for search. This also facilitates the
related search results displayed from a search.
6. Include your searchable object in searchable groups.
To secure the search content at the searchable group level, after the object creation,
you should include the searchable object to a group.
See: Adding Searchable Objects to a Group, page 3-29.
After a searchable object is created, a search administrator can deploy the searchable
object to the Oracle SES instance. For information on how to deploy searchable objects,
see Deploying Searchable Objects, page 3-35.
Understanding the Entities and Entity Relationships
Entities
Entities are database tables or views stored in the application metadata. Each entity has
to be associated with an alias; each alias has to be unique within a query group.
Query groupsare used to organize a set of entities selected for your searchable object to
build a rather complex structure for searchable objects. Search Modeler uses the concept
of query groups to construct and represent relevant entities used within the
master-detail or one-to-many relationships.
For example, a purchase requisition can contain many line items. Users can search and
navigate through the requisition and see the line item details only when needed.
To build master-detail relationships among a set of entities or query groups, Search
Modeler usesprimary groupsand secondary groupsto establish the relationship. In other
words, a primary group or table has primary key(s) and the next detail table or
8/13/2019 Secure Enterprise Search Modeler User's Guide
33/66
Using Metadata-based Search Modeler 3-7
secondary group will have the foreign key(s). If you filter the primary key, then the
detail must be filter out against that foreign key in the table.
The following diagram illustrates the primary-secondary group relationship between
the requisition header and line:
Employee Purchase Requisition Data Model
Primary Group: It is used to represent the master level, such as the purchaserequisition header. A primary group must have a parent-child relationship with the
secondary groups.
A searchable object must have at least one primary group so that the searchable
object can be crawled and indexed.
Secondary Group: It is used to represent the detail level, such as purchase requisition
line items. A searchable object can have up to five secondary groups.
Some distinctions between primary and secondary groups are:
To ensure the uniqueness of the attributes per document, only primary group
attributes, such as table columns or view columns, can be used to form the
document attributes inside an indexable document. None of the secondary group
attributes can participate in the document attribute construction.
The security search plug-in will have access to selected attributes from the primary
group only. The attributes from secondary groups can be indexed and searched, but
8/13/2019 Secure Enterprise Search Modeler User's Guide
34/66
3-8 Oracle E-Business Suite Secure Enterprise Search Modeler User's Guide
not displayed or stored.
Driving Entity
Use the concept of driving entity to distribute and parallelize the data fetch operations
across the crawler threads.
Note: Oracle E-Business Suite Secure Enterprise Search leverages the "
AD Parallel" technique to split the task into multiple threads to
facilitate the crawlable factory in expediting the performance of an
initial crawl which usually involves a large set of data.
A searchable object can have only one driving entity. It must have the following
characteristics:
A driving entity has to a table, not a view.
A driving entity has to be a part of the primary group.
For example, the driving entity of the Employee Purchase Requisition searchable object
should be PO_REQUISITION_HEADERS_ALL.
Entity Relationships
Entity relationship represents the relationship between different entities. It is used to
construct the Whereclause of the SQL statement to fetch data for indexing. It is
required for each query group existed in a searchable object.
Search Modeler leverages Oracle E-Business Suite application metadata; therefore,
when an entity is selected and added to a searchable object, the relationships between
the selected entity and existing entities are automatically retrieved from the repository
if available and displayed here. In other words, the entity relationship selections aredefaulted based on the application metadata for your searchable object.
Take the Employee Purchase Requisition data model as an example, there are two
primary entity groups, PO_REQUISITION_HEADERS_ALL and PER_ALL_PEOPLE_F.
The relationships between these two entities are established through the PREPARER_ID
attribute in PO_REQUISITION_HEADERS_ALL entity (or table) and the PERSON_ID
attribute in PER_ALL_PEOPLE_F entity (or table).
Since one entity can be used more than once in a query group, relationships may not be
clearly laid out when displaying this entity list. This is because Whereclause constructs
using entity aliases. As a result, only one occurrence of each entity is considered when
displaying the default entity relationship list. You can modify the default entityrelationship list for your searchable object.
Searchable Attributes
A searchable object has a number of attributes and these attributes are bound to
business data through the object definition.
8/13/2019 Secure Enterprise Search Modeler User's Guide
35/66
Using Metadata-based Search Modeler 3-9
Attributes are the table columns to be indexed for search. The text to be indexed is
actually stored in various columns of tables or views in Oracle E-Business Suite. Search
Modeler provides the facility to select columns as attributes of the selected entities for a
searchable object. There are certain properties of an attribute, which can be enabled
through Search Modeler.
Search Modeler also allows custom attributesadded to a searchable object. The customattribute feature provides an option for you to add function-based attributes in addition
to the regular attributes. All attributes described in the following table are also available
for custom attributes.
The following table describes each attribute and its usage:
Attribute Name Attribute Description
Searchable* Determines whether the attribute is indexed in
Oracle SES or not.
Stored Determines whether the attribute value is
stored in SES or not.
If an attribute is not stored, it cannot be
displayed in the search result summary.
Displayed Determines whether the attribute value is to
be displayed in search summary or not.
Title Determines whether the attribute is title for
the document or not.
Title contains the link to access the actualdocument. There has to be a title for a
searchable object.
Secured Determines whether the attribute can be used
for securing the document using Search
Plug-in.
8/13/2019 Secure Enterprise Search Modeler User's Guide
36/66
3-10 Oracle E-Business Suite Secure Enterprise Search Modeler User's Guide
Attribute Name Attribute Description
Primary Key Indicates whether it is required for the
uniqueness of each document for the
searchable object. Search Modeler will try to
default it from the Oracle E-Business Suite
metadata.
Primary key is essential to establishing the
uniqueness of a document for indexing
process in Oracle SES. Failure to mark proper
primary keys can result in duplicate
documents and those will get rejected by
Oracle SES.
Language Determines whether the attribute indicates the
language for the document. Oracle E-Business
Suite search infrastructure is multi-lingual.Based on the user preferred language,
appropriate documents will be retrieved.
UI Function parameter Indicates whether the attribute needs to be
passed as URL parameter to the landing page.
If so, this property captures the parameter
name to be passed as token in the form of
'='.
Is attachment Automatically defaults to Yes if the attribute
datatype is CLOB or BLOB. CLOB or BLOB
attributes cannot be stored in Oracle SES.They can only be indexed.
8/13/2019 Secure Enterprise Search Modeler User's Guide
37/66
Using Metadata-based Search Modeler 3-11
Attribute Name Attribute Description
Transformation* The transformation feature allows users to
transform the value of the attribute into more
meaningful text before indexing.
Oracle E-Business Suite uses lots of internal
codes within its tables conforming to RDBMS
principles, but these codes do not convey
much to the end user unless properly
substituted with their intended meanings.
There are two transformation properties:
Transformation Type: Oracle E-BusinessSuite supports four transformation types:
Lookups, Profiles, Valuesets, and Key
Flexfields.
Transformation Value: The syntax for thetransformation value is subjective.
Normally it is "::" , separated plain text.
For example, to specify a Lookups
transformation, user needs to provide the
lookup type and application short code in
the format "FND_YES_NO::FND",
where lookup type is "FND_YES_NO"
and application short code is "FND".
Please note that the transformation value
feature is not implemented in this release.
Visibility Overrides the visibility set at the searchable
object level.
Weight The value ranges from 1 to 6. This is used by
Oracle SES engine to boost a search result.
Note: Properties marked with "*" are the only properties applicable to
attributes coming from secondary query groups.
Search Related Properties
Search related properties are used to support crawling processes. These include target
UI name within Oracle E-Busienss Suite when application users hit the URL link from a
search result, search plug-in name that implements the access control lists to enforce the
8/13/2019 Secure Enterprise Search Modeler User's Guide
38/66
3-12 Oracle E-Business Suite Secure Enterprise Search Modeler User's Guide
security at crawl time and query time, and visibility level.
To support incremental crawls, additional incremental crawl properties are defined in a
searchable object. These include date-based crawl and business event-based crawl.
If you want to use a date-based incremental crawl, you must define appropriate date for
a driving entity to detect changes to the searchable object since the last time it was
crawled. If you want to use a event-based incremental crawl, you must specify
appropriate business event names that trigger the incremental crawl if related events
are raised for your searchable object.
Group Relations, Related Actions, and Object Relations
After specifying searchable attributes for each selected entity, you need to add
additional object details to facilitate the search.
Group Relations
Search Modeler uses group relations to define the relationships between primary and
secondary groups specified in a searchable object.
Each entity could belong to multiple query groups; therefore, you can have a choice to
view the query group relationships by either primary group or secondary group. The
referenced entity alias and associated entity names are retrieved and displayed.
For example, for a secondary group (PO_REQUISITION_LINES_ALL) of the Employee
Purchase Requisition data model, its group relationship between the primary group
PO_REQUISITION_HEADERS_ALL can be established through the referenced
attribute REQUISITION_HEADER_ID in the PO_REQUISITION_LINES_ALL table and
REQUISITION_HEADER_ID attribute in the PO_REQUISITION_HEADERS_ALL table.
Related Actions
Related actions are displayed in URLs as the search result when searching on a
searchable object. Actionable links can be of various types, such as visiting external
URLs.
Object Relations
Search Modeler uses object relations to define the relationships between searchable
objects.
Since document attributes can be formed using primary query group attributes only,
attributes from the primary query group can be used to relate two searchable objects.
This object relationship definition facilitates the related search displayed as the search
result while performing a search through Oracle Applications on an object if its
relationship with other objects exists.
Please note that related search is implemented using Oracle SES attribute search feature.
SQL Statement
The SQL information can be displayed or queried in either one of the following modes:
8/13/2019 Secure Enterprise Search Modeler User's Guide
39/66
Using Metadata-based Search Modeler 3-13
Normal Mode:
As mentioned earlier that entity relationship is used to construct the Whereclause
of the SQL statement to fetch data for indexing, when entity relationships and
attributes are selected for a searchable object, the SQL statement that defines the
metadata for crawler is automatically generated.
Expert Mode:
Search Modeler lets you switch to an expert mode while creating or updating a
searchable object. With expert mode, you can enter SQL query directly in the SQL
Statement region. Additionally, you can modify searchable attributes and populate
them again to reflect the change. You can also update the driving table name.
Please note that you can switch the mode while defining or updating SQL query by
clicking a switch link. Because each mode provides a different method of creating a
searchable object, once you decide to switch, a warning message populates indicating
that this switch action will clear SQL information you defined in the current mode. You
will need to confirm the action before proceed.
Instructions on Creating a Searchable Object
Based on the design logic, Search Modeler lets you create a searchable object in the
similar fashion. First, create basic object information in the searchable object main page.
Next, enter your object details. This includes selecting desired entities (database tables
or views) from the application metadata, establishing the relationship between them,
identifying search attributes for each selected entity, and adding additional object
details.
1. Enter basic object information
While clicking Create Searchable Object, an empty row with text boxes appears in
the Searchable Objects region. This lets you enter basic object information including
Display Name, Description, Product Family, and Product.
8/13/2019 Secure Enterprise Search Modeler User's Guide
40/66
3-14 Oracle E-Business Suite Secure Enterprise Search Modeler User's Guide
Entering Basic Object Information
Once you save the object entry, appropriate icons will be displayed in the Review
and Update, and Group Subscriptions columns.
2. Enter object details
After specifying basic object information, click an icon in the Review and Update
column to specify object entities and details in the following tabs:
Entities tab
This tab contains the following regions:
Entities
Search attributes
Search related properties
Group relations
Related actions
Object relations
SQL tabThe SQL tab contains SQL information for a searchable object. The SQL
statement can be displayed or queried in either of the following two modes:
Normal Mode: This mode displays SQL statement once the entity
relationships and attributes are selected for a searchable object.
8/13/2019 Secure Enterprise Search Modeler User's Guide
41/66
Using Metadata-based Search Modeler 3-15
Expert Mode: This mode lets you enter SQL query directly.
To create a searchable object:
1. Log on to Search Modeler to access the Searchable Objects main page.
2. Click Create Searchable Objectto add an extra empty row in the searchable object
table list.
3. Enter the object name and description information, and select appropriate values
from the Product Family and Product drop-down lists for your new object.
For example, enter the following information for a Purchase Requisition searchable
object:
Object Name: Purchase Requisition
Description: Employee Purchase Requisition
Product Family: Procurement
Product: Purchasing
4. Click Saveto save the new object that you just created.
The newly created searchable object appears in the object list.
5. Click the Review and Updateicon for your newly created object which opens the
Normal Mode of the Review and Update window.
6. In the Normal mode of the Review and Update window, enter appropriateinformation in the Entities Tab for your searchable object.
If you want, you can switch to the Expert mode by clicking the Switch to Expert
Mode link to enter SQL query information directly. See Entering Information in the
SQL Tab, page 3-22.
7. Entering Information in the Entities Tab:
In the Entities region
1. Click Addto open the Search and Add Entities window which allows you to
search and add appropriate database objects or entities (tables or views) to the
new searchable object.
1. Select entities by performing a search. Enter an appropriate product from
the drop-down list, and enter entity name if you know which table you
want to use. Execute your search.
8/13/2019 Secure Enterprise Search Modeler User's Guide
42/66
3-16 Oracle E-Business Suite Secure Enterprise Search Modeler User's Guide
2. From the search result, select appropriate entities (tables or views).
3. Optionally select the Related Entitiesicon for a selected entity if it is a
table, not a view. This displays the related tables for your selected entity.
For example, you select PO_REQUISITION_HEADERS_ALL table from the
entity search result pop-up window. Before submitting your selection, clickthe Related Entitiesicon to select PO_REQUISITION_LINES_ALL from the
related table list.
4. Click Submitto add your selected entities along with the related entities to
the new searchable object.
2. The selected entities are automatically added to the entity list in the Entities
region along with the alias, description, driving table, and query group
information for each selected entity.
3. You can update the Alias field if needed.
4. Use the Query Group drop-down list to identify a primary query group and
secondary query group based on your physical model for your desired entity.
For example, assign PO_REQUISITION_LINES_ALL as the Secondary query
group.
Note: A searchable object must have at least one primary query
group so that a searchable object can be crawled and indexed.
5. Select only one table name in the Entities region and click Set as Driving table
to set the selected entity as a driving entity.
The driving entity is used to split the data fetch task.
Save your work.
Note: A searchable object can only have exact one driving
entity.
6. To remove an entity from the object, select an entity name and click Remove.
7. To list all entity names that related to your selected entity, click the ShowEntity Relationshipslink.
All entity names displayed here are defaulted based on Oracle E-Business Suite
application metadata for your searchable object.
8/13/2019 Secure Enterprise Search Modeler User's Guide
43/66
Using Metadata-based Search Modeler 3-17
Note: One entity can be used more than once in a query group,
relationships cannot be clearly laid out when displaying this
entity list since Whereclause constructs using entity aliases. As
a result, only one occurrence of each entity is considered when
displaying the default entity relationships list.
Click Addto add more entities. For example, enter the following
information from the drop-down list for the
PO_REQUISITION_HEADERS_ALL entity:
Referencing Entity: PO_REQUISITION_HEADERS_ALL
Referencing Attribute: PREPARER_ID
Referenced Entity: PER_ALL_PEOPLE_F
Referenced Attribute: PERSON_ID
Click Doneto save your work.
Specifying Entity Relationships
If you need to remove an existing entity relationship, select an entity and then
click Removeto remove it from the list.
Note:The Additional Propertiesfeature is not implemented inthis release.
8. In the Searchable Attributes region
Use the following steps to enter searchable attributes for a selected entity:
8/13/2019 Secure Enterprise Search Modeler User's Guide
44/66
3-18 Oracle E-Business Suite Secure Enterprise Search Modeler User's Guide
1. Select an entity name and click Modify Attributesin the Entities region to
open the Add/Modify Searchable Attributes window where you can
modify the attributes for a selected entity.
Specifying Searchable Attributes for a Selected Entity
You can use the Filter region to search for desired attribute names. After
entering an attribute name or partial values containing wildcard characters,
click Goto execute the search. The attributes that match your criteria will
be displayed in the attribute table.
Based on business logic, certain attributes of the entity are automatically
marked as searchable in the Attributes region.
2. Select appropriate check boxes in the Add/Modify Searchable Attributes
window to modify the search attributes.
3. Click Submitto display your selected attributes in the Searchable
Attributes region.
8/13/2019 Secure Enterprise Search Modeler User's Guide
45/66
Using Metadata-based Search Modeler 3-19
Displaying Selected Attributes
4. To add more attribute information, click the Showlink for an attributename. This displays additional attribute information.
Adding More Searchable Attributes
Click Editto update the attribute details including primary key, query
group, attachment, language, visibility, weight, UI function parameter, and
transformation type. Click Doneto save your change.
Note: The transformation value feature is not implemented
in this release.
5. If you want to add custom attributes, click Add Custom Attributein the
Searchable Attributes region to add function-based attributes in SQL
statement.
All attributes listed in the Searchable Attributes region are available for
custom attributes.
8/13/2019 Secure Enterprise Search Modeler User's Guide
46/66
3-20 Oracle E-Business Suite Secure Enterprise Search Modeler User's Guide
1. Enter attribute display name, attribute name, type, description, and
specify appropriate attribute information including query group,
visibility, weight, transformation type and value, language, and so on
to further define the attribute.
2. Click Doneto save your work.
6. Click Saveto save your attributes for a selected entity.
7. If needed, select a different entity name in the Entities region and click
Modify Attributesto add more searchable attributes for a different entity.
Save your work.
8. In the Properties region
1. Click Editto enter the following fields:
Target UI: This indicates which UI function within Oracle E-Business Suitewill be launched when application users hits the URL link from a search
result.
For example, select 'POX_POMPV' as the Target UI for your Employee
Requisition searchable object.
Search Plug-in: Enter the Java class name that implements the access control
lists (ACLs) building logics. Oracle SES uses the ACLs to authorize or
revoke access to a search result.
Visibility Level: Select an appropriate level from the Visibility Level
drop-down list.
2. Click the Show All Propertieslink to enter the following property information:
Business Events (Optional): Select the Business Eventcheck box if you
want to raise the business event when changes are made to your searchable
8/13/2019 Secure Enterprise Search Modeler User's Guide
47/66
Using Metadata-based Search Modeler 3-21
object.
Note: Raising a business event will not trigger an
incremental crawl because this feature is not implemented
in this release.
Select Addto add business event name information; select a business event
name and click Removeto remove the event.
Date Fields (Optional): Select the Date Fieldscheck box if you want to use
date-based incremental crawl of a driving entity to detect changes to the
searchable object since the last time it was crawled.
Select appropriate date attribute for your last update date or start date and
then click Addor Removeto add or remove date attributes from the
searchable object.
3. Click Doneto save your work.
9. Click the Show Group Relationslink to define the query group relations.
Click Addto add group relationships. For example, enter the following information
from the drop-down list for the PO_REQUISITION_LINES_ALL entity, the
secondary group:
Referencing Entity: PO_REQUISITION_LINES_ALL
Referencing Attribute: REQUISITION_HEADER_ID
Referenced Entity: PO_REQUISITION_HEADERS_ALL
Referenced Attribute: REQUISITION_HEADER_ID
Click Doneto save your group relationships. To remove a group, select the group
that you want to remove and then click Remove.
Click Saveto save your changes.
10. Click the Show Related Actionslink to define your related actionable links.
Actionable links can be of various types, such as visiting external URLs, or
triggering a transaction when a notification is approved.
Actionable links are displayed in the search result when searching on the searchable
object you defined here.
Click Doneto save your work.
11. Click the Show Object Relationshipslink to define other searchable objects that
8/13/2019 Secure Enterprise Search Modeler User's Guide
48/66
3-22 Oracle E-Business Suite Secure Enterprise Search Modeler User's Guide
have the relationships with this searchable object that you are creating here.
Since document attributes can be formed using primary query group attributes
only, attributes from the primary query group can be used to relate two searchable
objects. Please note that related search is implemented using Oracle SES attribute
search feature.
Click Doneto save your work.
12. Entering Information in the SQL Tab:
Click the SQL tab to display SQL Statements in the Normal mode:
SQL Normal Mode
You can modify the statements by clicking Editto enter Query Hint and Additional
Predicate information. Click Saveto save your work.
If you want to enter SQL query directly, click the Switch to Expert Mode link toswitch the mode. A pop-up window appears indicating that a switch action will
clear all SQL information in the existing mode. You need to confirm the action by
clicking Yesto continue.
In the Expert mode, enter SQL statements directly in the SQL Statement region.
8/13/2019 Secure Enterprise Search Modeler User's Guide
49/66
Using Metadata-based Search Modeler 3-23
SQL Expert Mode
Click Modify Attributesto update the searchable object attributes and click Submit
. The attribute change information will appear in the Searchable Attributes region.
Click Populate Attributesto reflect your attribute change to the SQL statements.
You can also update the driving table name if you want for this searchable object.
13. Click Diagnosticsto run diagnostic reports. You can select either one of the
following options:
SQL Traced and Query Validation
Query Time ACL
Crawl Time ACL
Enter username and password information and click Run Diagnosticto see the
diagnostic result.
14. Click Submitto have your searchable object created with object and entity details.
Updating Searchable Objects
Search Modeler allows you to update an existing searchable object in a quicker way by
simply locating the object that you want to update from the query result, and then
clicking the Review and Updateicon to open the object details in the Normal mode.
After the modification, you need to deploy the object to Oracle SES. However, if your
searchable object has been deployed, you must manually delete the data source of the
same name in Oracle SES first before redeploying it again. For more information, see
8/13/2019 Secure Enterprise Search Modeler User's Guide
50/66
3-24 Oracle E-Business Suite Secure Enterprise Search Modeler User's Guide
Deploying Searchable Objects, page 3-35.
Updating Searchable Objects
If you want to update SQL information by specifying the SQL query directly, click the
Switch to Expert Modelink to switch to the Expert mode. While in the Expert mode,you can also update searchable attributes and populate them again if necessary to
reflect the change in the SQL statements.
To update a searchable object:
1. Log on to Search Modeler to access the Searchable Objects main page.
2. Enter appropriate search criteria to locate the object that you want to update. You
can view the result either by 'searchable object' or by 'product family' to help you
locate the object.
See: Searching and Viewing Searchable Objects, page 3-2.
Click the Review and Updateicon to open object details in the Review and Update
page.
3. Updating Information in the Entities Tab:
In the Entities region, you can modify existing entity information, including update
8/13/2019 Secure Enterprise Search Modeler User's Guide
51/66
Using Metadata-based Search Modeler 3-25
the Alias, Driving Table, and Query Group fields.
1. To modify the driving table, select the new entity name that you want it to be
the driving table and click Set as Driving table. This action removes the
previous driving table selection and the new selected entity is now set as the
driving entity.
Note: A searchable object can only have exact one driving
entity.
2. To add more entities, click Addto add more business entities if you want. This
opens the Search and Add Entities window to allow you search and add
appropriate database objects or entities (tables or views) to the searchable
object.
1. Select appropriate entities (tables or views) from the Search and Add
Entities window.
2. Optionally select the Related Entities icon for a selected entity. This
displays the related tables for your selected entity.
3. Click Submitto add your selected entities along with the related entities to
the new searchable object.
3. Select an entity name and click Modify Attributesto open the Add/Modify
Searchable Attributes window where you can modify the searchable object
attributes for the selected entity.
4.To remove existing entities, select the entity name from the Entities region andclick Removeto remove the entity.
5. To update entity relationships, click the Show Entity Relationshipslink to
modify your entity names that related to your searchable object.
You can add more entities by selecting Addto add them or select an entity and
then click Removeto remove it from the list.
Entity relationships are used to construct the Whereclause of the SQL
statement to fetch data for indexing. It is required for each query group existing
in a searchable object.
All entity names displayed here are defaulted based on Oracle E-Business Suite
application metadata for your searchable object.
Note: One entity can be used more than once in a query group,
relationships cannot be clearly laid out when displaying this
8/13/2019 Secure Enterprise Search Modeler User's Guide
52/66
3-26 Oracle E-Business Suite Secure Enterprise Search Modeler User's Guide
entity list since Whereclause constructs using entity aliases. As
a result, only one occurrence of each entity is considered when
displaying the default entity relationships list.
4. In the Searchable Attributes region, you can modify or add custom attributes:
For detailed attribute information, see Searchable Attributes, page 3-8.
1. Click the Showlink to expand the attribute details for a given attribute.
Click Editto update the attribute details. Click Doneto save your change.
2. Click Add Custom Attributeto add function-based attributes in SQL statement.
All attributes listed in the Searchable Attributes region are available for custom
attributes.
3. Click Doneto save your work.
5. In the Properties region, you can modify the fields if necessary:
1. Target UI: This indicates which UI function within Oracle E-Business Suite will
be launched when application users hits the URL link from a search result.
2. Search Plug-in: Modify the Java class name that implements the access control
lists (ACLs) building logics if needed. Oracle SES uses the ACLs to authorize or
revoke access to a search result.
3. Visibility Level: Select an appropriate level from the Visibility Level drop-down
list.
4. Select the Show All Propertieslink if you want to modify the Business Events
and Date fields.
5. Business Events (Optional): Select the Business Eventcheck box if you want to
raise the business event when changes are made to your searchable object.
Note: Raising a business event will not trigger an incremental
crawl because this feature is not implemented in this release.
Select Addto add business event name information; select a business event
name and click Removeto remove the event.
6. Date Fields (Optional): Select the Date Fieldscheck box if you want to use
date-based incremental crawl of a driving entity to detect changes to the
searchable object since the last time it was crawled.
8/13/2019 Secure Enterprise Search Modeler User's Guide
53/66
Using Metadata-based Search Modeler 3-27
Select appropriate date attribute for your last update date or start date and then
click Addor Removeto add or remove date attributes from the searchable
object.
7. Click Save.
6. Click the Show Group Relationslink if you want to modify the query group
relations.
You can add a group by clicking Add.
To remove a group, select the group that you want to remove and then click
Remove.
Click Saveto save your changes.
7. Click the Show Related Actionslink if you want to modify your related actionable
links.
Actionable links can be of various types, such as visiting external URLs, ortriggering a transaction when a notification is approved.
Actionable links are displayed in the search result when searching on the searchable
object you defined here.
8. Click the Show Object Relationshipslink if you want to modify the object
relationships between searchable objects.
9. Updating Information in the SQL Tab:
Click the SQL tab to update SQL information.
You can modify SQL information in either one of the following ways:
Update SQL statements or a query group in the Normal mode if you like.
Click Saveto save your work after modifications.
If you are in the Normal mode and want to update SQL query directly, click the
Switch to Expert Modelink to switch the mode. A pop-up window appears
indicating that a switch action will clear all SQL information in the existing
mode. You need to confirm the action by clicking Yesto continue.
In the Expert mode, enter or update SQL statements directly in the SQL
Statement region. You can click Modify Attributesto update the searchable
object attributes and click Submit. The attribute change information will appearin the Searchable Attributes region.
Click Populate Attributesto reflect your attribute change to the SQL
statements.
You can also update the driving table name if you want for this searchable
8/13/2019 Secure Enterprise Search Modeler User's Guide
54/66
3-28 Oracle E-Business Suite Secure Enterprise Search Modeler User's Guide
object.
10. Save your work.
Deleting Searchable ObjectsSearch Modeler allows you to delete a searchable object from the search result region if
the selected object has never been deployed to Oracle SES. Once the object is deployed,
it can only be deleted from the Oracle SES instance.
Note: Once a searchable object is deployed to Oracle SES, the associated
data source and default schedule are automatically created in Oracle
SES. Therefore, you cannot delete a deployed searchable object from the
Search Modeler user interface. Otherwise, an error message occurs
indicating that the object that you want to delete has been deployed
and you can only delete it from the Oracle SES instance.
To delete an undeployed searchable object, search for the object first by entering
appropriate criteria in the Filter region, and then select the object that you want to
delete from the search result region. Click Deleteto delete the selected object. A
confirmation message appears if the selected object has been deleted successfully.
To delete a searchable object:
1. Log on to Search Modeler to access the Searchable Objects main page.
2. Enter appropriate search criteria in the Filter region to locate the object that you
want to delete.
3. Select the object from the search result region and click Delete.
4. If the object has never been deployed, a confirmation message appears to indicate
the successful deletion of the object. Otherwise, an error message occurs instead.
Managing Searchable Object Security
An important feature of using Search Modeler is to simplify the process of creating
security rules on searchable objects. With the browser-based UIs, data modelers can
easily add security rules through security plug-in.Security means ways to guard indexed content as well as access authentication. To
ensure that the right person has access to appropriate data at the right time, searchable
objects or metadata must be enforced by security rules before they can be made
available for search within Oracle E-Business Suite.
To manage security at the group level, a data modeler can create a new searchable
8/13/2019 Secure Enterprise Search Modeler User's Guide
55/66
Using Metadata-based Search Modeler 3-29
group or add an existing searchable object to a group directly in the Search Modeler UI.
A system administrator or search administrator can then create security grants, based
on the Role-Based Access Control (RBAC) security model, to enforce appropriate
content access at the group level.
To manage security at an object level, data modelers can add custom or user-defined
security through security plug-in directly at the object level
Recommended