Setting Up the Integration of External Data with PeopleSoft

Target Attribute

Enter an attribute that is available in the external data that you want to include in the index.

Type

Choose a type for each attribute. The selected type is defined in the search engine as part of the index mapping.

Attribute Description

Enter a description for an attribute.

Search Definition

Choose a search definition that has the attribute that you want to map with the external data.

Search Attribute

Choose the attribute that you want to map.

No Security

Select to define no security restriction for a search definition's data. Anyone with access to the application can view the data for a search definition set to No Security. That is, the data is public to all users.

Source Level Security

Select to allow or restrict access to the entire search definition as per the specified user or role. That is, only specified users and roles are able to view data for that search definition.

Specify values for the following fields:

• Type - Select user or role, that is, set the scope of the intended access restriction.

• Name - Choose a role or user name.

• Privilege - Select Deny or Allow, that is, set the restriction or access privilege.

For more information on source level security, see Setting Source Level Security.

Component Level

Select to associate component level security with the external data search definition, that is, users who have access to a component can view the data of the external data search definition.

Specify values for the following fields:

• Market - Select a Market for the component.

• Component Name - Choose a component to associate with the external data search definition.

• Search Criteria - Enter any additional custom search criteria to be added automatically to the search engine search query. The search criteria should take the form ATTRIBUTENAME:VALUE and can use keywords and brackets. For example: PTSF_SBO_NAME:EP_AP_VENDOR & (-STATUS:PND)

For more information on search criteria, refer to Mapping Components to Search Definitions.

Data Source Type

Select a type for the data source.

Valid options for type are:

• File - A CSV file that contains the actual data.

• URL - A REST end point to which a request is made and it provides data as a response.

File Type

The File Type field appears when you select File as data source type.

File Name

The File Name field appears when you select File as data source type.

All external CSV files should be placed in the psftappdata folder under <LOGSTASH_HOME>. Any generated files are also saved to this folder.

Specify the absolute path of the CSV file.

Method

The Method field appears when you select URL as data source type.

Choose the type of HTTP request that needs to be issued.

Valid options for method are:

• GET

• POST

• PUT

URL

The URL field appears when you select URL as data source type.

Specify the path of the external data. The path should not be absolute; it should be relative. Path should be relative to <LOGSTASH_HOME>/psftappdata.

Body

The Body field appears when you select URL as data source type.

This field contains the JSON request for the POST and GET methods.

Proxy

Specify the proxy server details for REST API connection.

Additional Options

Specify any additional connection parameters.

Type

Specify the type of data transformation that you want to achieve.

• External - Select external if a data source is created for intermediate processing, that is, the data source is created to generate data which needs to be processed further before sending to the search engine.

• PeopleSoft - Select PeopleSoft if you’re mapping the data source with an external data index.

Split Fields

You need to specify split fields when you select URL as the data type.

You indicate a field from the data source, which requires a split.

When a request is made to the REST end point specified in the URL type, it returns a response containing JSON documents. These JSON documents can be nested or hierarchical in nature. If the data you require is under a parent node, then you need to use the split fields option to obtain the children under the parent node.

For example, in a product data source, the information related to a product is under a parent node called itemSummaries. To obtain the information of sub-products (children) under the parent node for further mapping, you need to split the field.

Allowlist

Use this field to limit or filter the data from the data source that is passed to the search engine. Enter comma separated values in this field.

If you do not enter any values here, all data from the data source will be passed to the search engine.

Split Fields

You need to specify split fields when you select URL as the data type.

You indicate a field from the data source, which requires a split.

When a request is made to the REST end point specified in the URL type, it returns a response containing JSON documents. These JSON documents can be nested or hierarchical in nature. If the data you require is under a parent node, then you need to use the split fields option to obtain the children under the parent node.

For example, in a product data source, the information related to a product is under a parent node called itemSummaries. To obtain the information of sub-products (children) under the parent node for further mapping, you need to split the field.

Target Attribute and Type

Contains the attributes and its type from the external data search definition that you associated with the data source.

These values cannot be edited here.

Source Attribute

As part of the mapping of the external data search definition with the attributes of data source, if you need to map any nested fields under a split attribute, the mapping can be done using the split field as described in the previous section. For example, to map the field, Title, under itemSummaries, you should enter it as [itemSummaries][title] in the Source field.

Fixed Value

The Fixed Value column enables you to specify a value that meets your requirements. For example, for the City source attribute, you want information only about San Francisco, so you should specify San Francisco in the Fixed Value column.

Suggestions

When you select the suggestions icon, it displays the attributes from the actual data source, which you can choose for the Source Attribute column.

Search Definition

The search definition defined in the PeopleSoft Mapping section of the external data search definition is displayed here.

This field is read-only.

Search Attribute

The search attribute defined in the PeopleSoft Mapping section of the external data search definition is displayed here.

This field is read-only.

Mapping Value

Map a specific value from the data source to the PeopleSoft attribute.

For example, the EP_AP_VENDOR search definition contains the VENDOR_NAME_SHORT attribute. For this attribute for the vendor, XYZ, the value stored in PeopleSoft is XYZ01. You should enter this value, XYZ01, in the Mapping value column. This value is added to all the search engine documents which are indexed and obtained from the XYZ data source.

Suggestions

Displays the values from the selected search attribute, which you can choose for the Mapping Value column.

Output Type

Select an output type based on your requirement.

• Search engine - Save the external data to the search engine.

• File - Select File for data sources created for intermediate processing.

If you select File, the following two fields—Codec and File—are displayed.

Codec

The Codec field corresponds to the codec setting of the Logstash file output plugin.

The external data that is sent as input requires to be transformed in order to ensure that it has all the necessary attributes to be used in PeopleSoft. The following sample code shows the transformed data.

%{[categories][id]},https://api.myproducts.io/newproducts/categories/%{[categories][id]}?api-version=2018-10-18&Subscription-Key=c455d00cb0f64e238a5282d75921f27e

Output gets transformed from:

"id" : "6642",
            "name" : "Prepared Foods",
            "type" : "1",
            "_links" : [
                {
                    "href" : "/newproducts/categories/6642?api-version=2018-10-18",
                    "rel" : "self",
                    "type" : "GET"
                }
            ]
        }

To:

6642,https://api.myproducts.io/newproducts/categories/6642?api-version=2018-10-18&Subscription-Key=c455d00cb0f64e238a5282d75921f27e

For more information on the codec setting, refer to Logstash documentation, which is available on www.opensearch.org.

File

Specifies the location of the file.

Request

Specify a request to test the data source.

Response

Displays the REST end point response.

Submit

When you click Submit, the REST end point request is initiated.

Schedule At

Specify the date and time when you want the index process to commence. The Schedule page provides you the flexibility to specify the exact minute to commence the indexing process.

The time and frequency options are mutually exclusive. When you schedule the date and time for the indexing process, the other two frequency options are not considered and vice versa.

Repeat Hourly

Specify to repeat the indexing process by the number of hours, for example, you can set it to repeat every four hours.

Repeat Weekly

Specify to repeat the indexing process on a specific day of the week and the indexing process repeats every week on the specified day.