Working with Attachment Properties

This section provides an overview of attachment processing in Elasticsearch and SES and the attachment properties supported by PeopleSoft Search Framework.

All sections in the Working with Attachments topic apply to both Elasticsearch and SES unless specifically mentioned.

In contrast to the SES based search implementation where attachments were processed by SES, in the Elasticsearch based search implementation, PeopleSoft Search Framework downloads any attachment specified in a search definition, and pushes the encoded attachment data in the form of JSON document to the Elasticsearch search engine. Elasticsearch uses the Mapper attachment plug-in to extract the attachment contents. The attachment data is then indexed in Elasticsearch.

Currently, the PeopleSoft Search Framework supports these file attachment storage location options:

  • PeopleSoft database

  • FTP

  • SFTP

Image: PeopleSoft Search Framework architecture including file attachment repository

The following graphic depicts PeopleSoft downloading attachment from database and attachment repository, and then pushing encoded data to Elasticsearch. Elasticsearch uses Mapper attachment plug-in to extract attachment contents for indexing.

Search Framework architecture with attachment repository

Currently, the PeopleSoft Search Framework supports these file attachment storage location options:

  • PeopleSoft database

  • FTP

  • SFTP

During index generation, Oracle SES downloads the URL for the file attachment location, as part of the generated feed. Then the SES crawler accesses the file using the downloaded URL for indexing.

Image: PeopleSoft Search Framework architecture including file attachment repository

The following graphic depicts Oracle SES downloading the attachment URL and then using the URL to access the file attachment from the appropriate storage location for indexing.

Search Framework architecture with attachment repository

Note: The following topics apply to both Elasticsearch and SES.

Access the Attachments page by selecting PeopleTools, Search Framework, Search Designer Activity Guide, Search Definition and selecting the Attachment Properties tab.

You use the Attachments page to select options related to the attachments that will be indexed as part of your search definition.

Image: Attachment Properties page

This example illustrates the fields and controls on the Attachment Properties page. You can find definitions for the fields and controls later on this page.

Attachment Properties page

Field or Control

Definition

Attachments

The Attachments grid contains attachments you specify to be indexed as part of your search definition. These are the types of attachments supported:

  • Attachment URL

  • Static URLID

  • Dynamic URLID

  • Inline Attachment

The options for each attachment type are described later in this topic where each attachment type is discussed.

Edit

Click to edit the properties of a previously entered attachment.

Add Attachment

Click to add a new attachment to the Attachments grid.

Important! If the attachment URL properties or the URL of the attachment storage location changes, the PeopleSoft Search Framework recognizes the changes, and during the next index build or index update, the system will update the deployed search definitions to reflect the updated attachment properties and URL information.

An Attachment URL type of attachment refers to attachments that are linked to the search definition by way of an Attachment URL type of drilling URL, specified on the Expression tab of PeopleSoft Query.

When using the Attachment URL type of attachment, the system uses the call-back credentials, defined for the search engine instance, to access the location of the attachment files. For example, if your attachments are stored in an FTP server, the FTP server needs to have thesearch engine call-back credentials configured as a valid user.

Note: The drilling URLs are different depending on the attachment repository type (database, FTP, and so on), but in all cases the system uses call-back user credentials to access the files.

Access the properties for this type of attachment by clicking the Add Attachment or Edit button on the Attachments page.

Image: Define Attachment Properties: Attachment URL

This example illustrates the fields and controls for setting Attachment URL properties. You can find definitions for the fields and controls later on this page.

Attachment Properties - attachment URL

Field or Control

Definition

Attachment URL

Select if the attachment is linked to the search definition through a drilling URL in the underlying query as specified on the Expression tab in PeopleSoft Query.

Query Name

Select the query in which the Attachment URL drilling URL is defined.

Attachment URL

Select the query field in which the drilling URL query expression exists.

A Static URL ID type of attachment refers to an attachment that is associated with a URL ID that is static, or unlikely to change. You select the URL ID from the URL list defined by the Attachment URL ID List (PeopleTools, Search Framework, Search Administrator, Attachment URL ID List). For a Static URL ID type, the URL is generated from a URL ID (static) and a constant file reference path. This makes the URL always constant, and the file name changes based on the value received from the query field.

Image: Define Attachment Properties - Static URL

This example illustrates the fields and controls for a Static URL. You can find definitions for the fields and controls later on this page.

Attachment Properties - static URL

Field or Control

Definition

URL ID

Select if your attachment is associated with a URL ID, not an Attachment URL expression defined in PeopleSoft Query.

Query Name

Select the query name in which this attachment is referenced.

URL ID Type

If the URL ID is constant and unlikely to change, select Static.

URL Identifier

Select the URL Identifier from the drop-down list. This list is populated by the list defined by the Attachment URL ID List (PeopleTools, Search Framework, Search Admin Activity Guide, Attachment URL ID List). These URLs are a subset of the URLs defined in the PeopleSoft database, and this subset are those URLs identified to be used with the PeopleSoft Search Framework.

File Reference Path

(Optional) Enter a file reference path for mapping a dynamic file path.

File Name Query Field

Select the query field that will contain the name of the attached file.

With a dynamic attachment type, all the components of a URL are generated from the value in query field. With a dynamic attachment type, much of the information related to the attachment is unknown prior to the transaction occurring.

For example, with a static attachment type, it is known beforehand what the URLID will be, so it can be specified when the attachment properties are set. With a dynamic attachment type, the values of the attachment properties are determined at the transaction time, and the property values, such as URLID, file reference path, and attachment file name, are stored in the row of data associated with the attachment. The attachment property values can vary between rows.

Image: Define Attachment Properties - Dynamic URL

This example illustrates the fields and controls for a Dynamic URL. You can find definitions for the fields and controls later on this page.

Attachment Properties - dynamic URL

Field or Control

Definition

Query Name

Select the query name in which this attachment is referenced.

URL Id Type

If the URL ID is not constant and likely to change, select Dynamic.

URLID Query Field

Select the field in the query that will hold the URL ID of the attachment storage location.

File Path Query Field

Select the field in the query that will hold the URL ID of the attachment file reference path.

File Name Query Field

Select the query field that will contain the name of the attached file.

Important! The Inline Attachment option is specific for attachments in a SES based search implementation. This option is not applicable for an Elasticsearch based search implementation. However, PeopleSoft Search Framework supports the Inline Attachment option for Elasticsearch in the event that you use a SES-based search definition that contains attachments specified as inline attachments.

Oracle SES can index only up to 4KB of data for any attribute. If an attribute contains data greater than 4 KB for indexing, Oracle SES truncates the content with a maximum length of 4 KB, so the remainder of the content becomes non searchable. In such cases, you can select Inline Attachments for attributes. During feed generation, contents from attributes marked as an inline attachment are processed differently by the Oracle SES crawler. When attributes are marked as an inline attachment, users can search for contents beyond the 4 KB limit. However, if the same attribute is marked for indexing in the Map Search Attribute field, a search with a filter on this specific attribute can search only up to 4 KB. The additional content is searchable as a general search text and not as a filter on the attribute.

Image: Define Attachment Properties - Inline Attachment

This example illustrates the fields and controls for an Inline Attachment. You can find definitions for the fields and controls later on this page.

Attachment Properties - inline attachment

Field or Control

Definition

Query Name

Select the query name in which this attachment is referenced.

Query Field

Select the query field that will contain the inline attachment.

Content Type

Select the content type for the inline attachment.

The following content types are supported:

  • text/html

  • text/plain